diff --git a/.fernignore b/.fernignore new file mode 100644 index 00000000..072c9072 --- /dev/null +++ b/.fernignore @@ -0,0 +1,13 @@ +# Specify files that shouldn't be modified by Fern + +.github/workflows/ci.yml +.github/workflows/legacy.yml +.github/ISSUE_TEMPLATE +.github/labeler.yml +.github/pull_request_template.md +examples +legacy +src/square/core/api_error.py +src/square/utils/webhooks_helper.py +tests/integration +README.md \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..aec841d5 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,73 @@ +name: ci + +on: + push: + paths-ignore: + - 'legacy/**' + tags: + - '*' + - '!legacy*' + branches: + - '**' + +jobs: + compile: + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Set up python + uses: actions/setup-python@v4 + with: + python-version: 3.8 + - name: Bootstrap poetry + run: | + curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 + - name: Install dependencies + run: poetry install + - name: Compile + run: poetry run mypy src + + test: + runs-on: ubuntu-latest + env: + TEST_SQUARE_TOKEN: ${{ secrets.TEST_SQUARE_TOKEN }} + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Set up python + uses: actions/setup-python@v4 + with: + python-version: 3.8 + - name: Bootstrap poetry + run: | + curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 + - name: Install dependencies + run: poetry install + + - name: Test + run: poetry run pytest -rP tests + + publish: + needs: [compile] + if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Set up python + uses: actions/setup-python@v4 + with: + python-version: 3.8 + - name: Bootstrap poetry + run: | + curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 + - name: Install dependencies + run: poetry install + - name: Publish to pypi + run: | + poetry config repositories.remote https://upload.pypi.org/legacy/ + poetry --no-interaction -v publish --build --repository remote --username "$PYPI_USERNAME" --password "$PYPI_PASSWORD" + env: + PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }} + PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} diff --git a/.github/workflows/legacy.yml b/.github/workflows/legacy.yml new file mode 100644 index 00000000..31597168 --- /dev/null +++ b/.github/workflows/legacy.yml @@ -0,0 +1,56 @@ +name: ci + +on: + push: + paths: + - 'legacy/**' + tags: + - 'legacy*' + +jobs: + test: + runs-on: ubuntu-latest + env: + SQUARE_SANDBOX_TOKEN: ${{ secrets.TEST_SQUARE_TOKEN }} + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Set up python + uses: actions/setup-python@v4 + with: + python-version: 3.8 + - name: Bootstrap poetry + run: | + curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 + - name: Install dependencies + working-directory: ./legacy + run: poetry install + + - name: Test + working-directory: ./legacy + run: poetry run pytest -rP tests + + publish: + if: github.event_name == 'push' && contains(github.ref, 'refs/tags/legacy') + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Set up python + uses: actions/setup-python@v4 + with: + python-version: 3.8 + - name: Bootstrap poetry + run: | + curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 + - name: Install dependencies + working-directory: ./legacy + run: poetry install + - name: Publish to pypi + working-directory: ./legacy + run: | + poetry config repositories.remote https://upload.pypi.org/legacy/ + poetry --no-interaction -v publish --build --repository remote --username "$PYPI_USERNAME" --password "$PYPI_PASSWORD" + env: + PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }} + PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml deleted file mode 100644 index ea6646a4..00000000 --- a/.github/workflows/python-package.yml +++ /dev/null @@ -1,55 +0,0 @@ -# This workflow will install Python dependencies, run tests and lint with a variety of Python versions -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions - -name: Python package - -on: - push: - branches: [master] - pull_request: - branches: [master] - -jobs: - build: - env: - SQUARE_ENVIRONMENT: sandbox - SQUARE_SANDBOX_TOKEN: ${{ secrets.SQUARE_SANDBOX_TOKEN }} - - runs-on: ubuntu-latest - strategy: - matrix: - python-version: [3.7] - - steps: - - uses: actions/checkout@v2 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -r requirements.txt - pip install -r test-requirements.txt - - name: Test with pytest - run: | - pytest - - labeler: - needs: build - if: ${{ github.event_name == 'pull_request' }} - runs-on: ubuntu-latest - steps: - - name: automerge-labeler - uses: fuxingloh/multi-labeler@v1 - - automerge: - needs: labeler - if: ${{ github.event_name == 'pull_request' }} - runs-on: ubuntu-latest - steps: - - name: automerge - uses: "pascalgn/automerge-action@v0.14.2" - env: - GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" - MERGE_LABELS: "automerge,automerge-branch,automerge-author" diff --git a/.gitignore b/.gitignore index 998ea462..0da665fe 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -*.pyc -build -dist -*.egg-info \ No newline at end of file +dist/ +.mypy_cache/ +__pycache__/ +poetry.toml +.ruff_cache/ diff --git a/.mock/definition/__package__.yml b/.mock/definition/__package__.yml new file mode 100644 index 00000000..a18da480 --- /dev/null +++ b/.mock/definition/__package__.yml @@ -0,0 +1,27101 @@ +types: + AchDetails: + docs: >- + ACH-specific details about `BANK_ACCOUNT` type payments with the + `transfer_type` of `ACH`. + properties: + routing_number: + type: optional> + docs: The routing number for the bank account. + validation: + maxLength: 50 + account_number_suffix: + type: optional> + docs: The last few digits of the bank account number. + validation: + minLength: 1 + maxLength: 4 + account_type: + type: optional> + docs: >- + The type of the bank account performing the transfer. The account type + can be `CHECKING`, + + `SAVINGS`, or `UNKNOWN`. + validation: + maxLength: 50 + source: + openapi: openapi/openapi.json + AcceptDisputeResponse: + docs: Defines the fields in an `AcceptDispute` response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + dispute: + type: optional + docs: Details about the accepted dispute. + source: + openapi: openapi/openapi.json + AcceptedPaymentMethods: + properties: + apple_pay: + type: optional> + docs: Whether Apple Pay is accepted at checkout. + google_pay: + type: optional> + docs: Whether Google Pay is accepted at checkout. + cash_app_pay: + type: optional> + docs: Whether Cash App Pay is accepted at checkout. + afterpay_clearpay: + type: optional> + docs: Whether Afterpay/Clearpay is accepted at checkout. + source: + openapi: openapi/openapi.json + AccumulateLoyaltyPointsResponse: + docs: >- + Represents an + [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) + response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + event: + type: optional + docs: >- + The resulting loyalty event. Starting in Square version 2022-08-17, + this field is no longer returned. + events: + type: optional> + docs: >- + The resulting loyalty events. If the purchase qualifies for points, + the `ACCUMULATE_POINTS` event + + is always included. When using the Orders API, the + `ACCUMULATE_PROMOTION_POINTS` event is included + + if the purchase also qualifies for a loyalty promotion. + source: + openapi: openapi/openapi.json + ActionCancelReason: + enum: + - BUYER_CANCELED + - SELLER_CANCELED + - TIMED_OUT + source: + openapi: openapi/openapi.json + ActivityType: + enum: + - ADJUSTMENT + - APP_FEE_REFUND + - APP_FEE_REVENUE + - AUTOMATIC_SAVINGS + - AUTOMATIC_SAVINGS_REVERSED + - CHARGE + - DEPOSIT_FEE + - DEPOSIT_FEE_REVERSED + - DISPUTE + - ESCHEATMENT + - FEE + - FREE_PROCESSING + - HOLD_ADJUSTMENT + - INITIAL_BALANCE_CHANGE + - MONEY_TRANSFER + - MONEY_TRANSFER_REVERSAL + - OPEN_DISPUTE + - OTHER + - OTHER_ADJUSTMENT + - PAID_SERVICE_FEE + - PAID_SERVICE_FEE_REFUND + - REDEMPTION_CODE + - REFUND + - RELEASE_ADJUSTMENT + - RESERVE_HOLD + - RESERVE_RELEASE + - RETURNED_PAYOUT + - SQUARE_CAPITAL_PAYMENT + - SQUARE_CAPITAL_REVERSED_PAYMENT + - SUBSCRIPTION_FEE + - SUBSCRIPTION_FEE_PAID_REFUND + - SUBSCRIPTION_FEE_REFUND + - TAX_ON_FEE + - THIRD_PARTY_FEE + - THIRD_PARTY_FEE_REFUND + - PAYOUT + - AUTOMATIC_BITCOIN_CONVERSIONS + - AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED + - CREDIT_CARD_REPAYMENT + - CREDIT_CARD_REPAYMENT_REVERSED + - LOCAL_OFFERS_CASHBACK + - LOCAL_OFFERS_FEE + - PERCENTAGE_PROCESSING_ENROLLMENT + - PERCENTAGE_PROCESSING_DEACTIVATION + - PERCENTAGE_PROCESSING_REPAYMENT + - PERCENTAGE_PROCESSING_REPAYMENT_REVERSED + - PROCESSING_FEE + - PROCESSING_FEE_REFUND + - UNDO_PROCESSING_FEE_REFUND + - GIFT_CARD_LOAD_FEE + - GIFT_CARD_LOAD_FEE_REFUND + - UNDO_GIFT_CARD_LOAD_FEE_REFUND + - BALANCE_FOLDERS_TRANSFER + - BALANCE_FOLDERS_TRANSFER_REVERSED + - GIFT_CARD_POOL_TRANSFER + - GIFT_CARD_POOL_TRANSFER_REVERSED + - SQUARE_PAYROLL_TRANSFER + - SQUARE_PAYROLL_TRANSFER_REVERSED + source: + openapi: openapi/openapi.json + AddGroupToCustomerResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + AdditionalRecipient: + docs: >- + Represents an additional recipient (other than the merchant) receiving a + portion of this tender. + properties: + location_id: + type: string + docs: >- + The location ID for a recipient (other than the merchant) receiving a + portion of this tender. + validation: + minLength: 1 + maxLength: 50 + description: + type: optional> + docs: The description of the additional recipient. + validation: + maxLength: 100 + amount_money: + type: Money + docs: The amount of money distributed to the recipient. + receivable_id: + type: optional> + docs: >- + The unique ID for the RETIRED `AdditionalRecipientReceivable` object. + This field should be empty for any `AdditionalRecipient` objects + created after the retirement. + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + Address: + docs: >- + Represents a postal address in a country. + + For more information, see [Working with + Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + properties: + address_line_1: + type: optional> + docs: >- + The first line of the address. + + + Fields that start with `address_line` provide the address's most + specific + + details, like street number, street name, and building name. They do + *not* + + provide less specific details like city, state/province, or country + (these + + details are provided in other fields). + address_line_2: + type: optional> + docs: The second line of the address, if any. + address_line_3: + type: optional> + docs: The third line of the address, if any. + locality: + type: optional> + docs: >- + The city or town of the address. For a full list of field meanings by + country, see [Working with + Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + sublocality: + type: optional> + docs: A civil region within the address's `locality`, if any. + sublocality_2: + type: optional> + docs: A civil region within the address's `sublocality`, if any. + sublocality_3: + type: optional> + docs: A civil region within the address's `sublocality_2`, if any. + administrative_district_level_1: + type: optional> + docs: >- + A civil entity within the address's country. In the US, this + + is the state. For a full list of field meanings by country, see + [Working with + Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + administrative_district_level_2: + type: optional> + docs: |- + A civil entity within the address's `administrative_district_level_1`. + In the US, this is the county. + administrative_district_level_3: + type: optional> + docs: |- + A civil entity within the address's `administrative_district_level_2`, + if any. + postal_code: + type: optional> + docs: >- + The address's postal code. For a full list of field meanings by + country, see [Working with + Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + country: + type: optional + docs: >- + The address's country, in the two-letter format of ISO 3166. For + example, `US` or `FR`. + + See [Country](#type-country) for possible values + first_name: + type: optional> + docs: Optional first name when it's representing recipient. + last_name: + type: optional> + docs: Optional last name when it's representing recipient. + source: + openapi: openapi/openapi.json + AdjustLoyaltyPointsResponse: + docs: >- + Represents an + [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints) request. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + event: + type: optional + docs: The resulting event data for the adjustment. + source: + openapi: openapi/openapi.json + AfterpayDetails: + docs: Additional details about Afterpay payments. + properties: + email_address: + type: optional> + docs: Email address on the buyer's Afterpay account. + validation: + maxLength: 255 + source: + openapi: openapi/openapi.json + ApplicationDetails: + docs: Details about the application that took the payment. + properties: + square_product: + type: optional + docs: >- + The Square product, such as Square Point of Sale (POS), + + Square Invoices, or Square Virtual Terminal. + + See [ExternalSquareProduct](#type-externalsquareproduct) for possible + values + application_id: + type: optional> + docs: >- + The Square ID assigned to the application used to take the payment. + + Application developers can use this information to identify payments + that + + their application processed. + + For example, if a developer uses a custom application to process + payments, + + this field contains the application ID from the Developer Dashboard. + + If a seller uses a [Square App + Marketplace](https://developer.squareup.com/docs/app-marketplace) + + application to process payments, the field contains the corresponding + application ID. + source: + openapi: openapi/openapi.json + ApplicationDetailsExternalSquareProduct: + enum: + - APPOINTMENTS + - ECOMMERCE_API + - INVOICES + - ONLINE_STORE + - OTHER + - RESTAURANTS + - RETAIL + - SQUARE_POS + - TERMINAL_API + - VIRTUAL_TERMINAL + docs: A list of products to return to external callers. + source: + openapi: openapi/openapi.json + ApplicationType: literal<"TERMINAL_API"> + AppointmentSegment: + docs: Defines an appointment segment of a booking. + properties: + duration_minutes: + type: optional> + docs: The time span in minutes of an appointment segment. + validation: + max: 1500 + service_variation_id: + type: optional> + docs: >- + The ID of the [CatalogItemVariation](entity:CatalogItemVariation) + object representing the service booked in this segment. + validation: + maxLength: 36 + team_member_id: + type: string + docs: >- + The ID of the [TeamMember](entity:TeamMember) object representing the + team member booked in this segment. + validation: + minLength: 1 + maxLength: 32 + service_variation_version: + type: optional> + docs: >- + The current version of the item variation representing the service + booked in this segment. + intermission_minutes: + type: optional + docs: >- + Time between the end of this segment and the beginning of the + subsequent segment. + access: read-only + any_team_member: + type: optional + docs: >- + Whether the customer accepts any team member, instead of a specific + one, to serve this segment. + access: read-only + resource_ids: + type: optional> + docs: >- + The IDs of the seller-accessible resources used for this appointment + segment. + access: read-only + source: + openapi: openapi/openapi.json + ArchivedState: + enum: + - ARCHIVED_STATE_NOT_ARCHIVED + - ARCHIVED_STATE_ARCHIVED + - ARCHIVED_STATE_ALL + docs: |- + Defines the values for the `archived_state` query expression + used in [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + to return the archived, not archived or either type of catalog items. + source: + openapi: openapi/openapi.json + Availability: + docs: >- + Defines an appointment slot that encapsulates the appointment segments, + location and starting time available for booking. + properties: + start_at: + type: optional> + docs: >- + The RFC 3339 timestamp specifying the beginning time of the slot + available for booking. + location_id: + type: optional + docs: The ID of the location available for booking. + validation: + maxLength: 32 + access: read-only + appointment_segments: + type: optional>> + docs: The list of appointment segments available for booking + source: + openapi: openapi/openapi.json + BankAccount: + docs: >- + Represents a bank account. For more information about + + linking a bank account to a Square account, see + + [Bank Accounts + API](https://developer.squareup.com/docs/bank-accounts-api). + properties: + id: + type: string + docs: The unique, Square-issued identifier for the bank account. + validation: + minLength: 1 + maxLength: 30 + account_number_suffix: + type: string + docs: The last few digits of the account number. + validation: + minLength: 1 + country: + type: Country + docs: |- + The ISO 3166 Alpha-2 country code where the bank account is based. + See [Country](#type-country) for possible values + currency: + type: Currency + docs: >- + The 3-character ISO 4217 currency code indicating the operating + + currency of the bank account. For example, the currency code for US + dollars + + is `USD`. + + See [Currency](#type-currency) for possible values + account_type: + type: BankAccountType + docs: |- + The financial purpose of the associated bank account. + See [BankAccountType](#type-bankaccounttype) for possible values + holder_name: + type: string + docs: |- + Name of the account holder. This name must match the name + on the targeted bank account record. + validation: + minLength: 1 + primary_bank_identification_number: + type: string + docs: >- + Primary identifier for the bank. For more information, see + + [Bank Accounts + API](https://developer.squareup.com/docs/bank-accounts-api). + validation: + maxLength: 40 + secondary_bank_identification_number: + type: optional> + docs: >- + Secondary identifier for the bank. For more information, see + + [Bank Accounts + API](https://developer.squareup.com/docs/bank-accounts-api). + validation: + maxLength: 40 + debit_mandate_reference_id: + type: optional> + docs: >- + Reference identifier that will be displayed to UK bank account owners + + when collecting direct debit authorization. Only required for UK bank + accounts. + reference_id: + type: optional> + docs: >- + Client-provided identifier for linking the banking account to an + entity + + in a third-party system (for example, a bank account number or a user + identifier). + location_id: + type: optional> + docs: The location to which the bank account belongs. + status: + type: BankAccountStatus + docs: |- + Read-only. The current verification status of this BankAccount object. + See [BankAccountStatus](#type-bankaccountstatus) for possible values + creditable: + type: boolean + docs: >- + Indicates whether it is possible for Square to send money to this bank + account. + debitable: + type: boolean + docs: |- + Indicates whether it is possible for Square to take money from this + bank account. + fingerprint: + type: optional> + docs: >- + A Square-assigned, unique identifier for the bank account based on the + + account information. The account fingerprint can be used to compare + account + + entries and determine if the they represent the same real-world bank + account. + version: + type: optional + docs: The current version of the `BankAccount`. + bank_name: + type: optional> + docs: |- + Read only. Name of actual financial institution. + For example "Bank of America". + validation: + maxLength: 100 + source: + openapi: openapi/openapi.json + BankAccountPaymentDetails: + docs: Additional details about BANK_ACCOUNT type payments. + properties: + bank_name: + type: optional> + docs: The name of the bank associated with the bank account. + validation: + maxLength: 100 + transfer_type: + type: optional> + docs: The type of the bank transfer. The type can be `ACH` or `UNKNOWN`. + validation: + maxLength: 50 + account_ownership_type: + type: optional> + docs: |- + The ownership type of the bank account performing the transfer. + The type can be `INDIVIDUAL`, `COMPANY`, or `ACCOUNT_TYPE_UNKNOWN`. + validation: + maxLength: 50 + fingerprint: + type: optional> + docs: |- + Uniquely identifies the bank account for this seller and can be used + to determine if payments are from the same bank account. + validation: + maxLength: 255 + country: + type: optional> + docs: >- + The two-letter ISO code representing the country the bank account is + located in. + validation: + minLength: 2 + maxLength: 2 + statement_description: + type: optional> + docs: The statement description as sent to the bank. + validation: + maxLength: 1000 + ach_details: + type: optional + docs: >- + ACH-specific information about the transfer. The information is only + populated + + if the `transfer_type` is `ACH`. + errors: + type: optional>> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + BankAccountStatus: + enum: + - VERIFICATION_IN_PROGRESS + - VERIFIED + - DISABLED + docs: Indicates the current verification status of a `BankAccount` object. + source: + openapi: openapi/openapi.json + BankAccountType: + enum: + - CHECKING + - SAVINGS + - INVESTMENT + - OTHER + - BUSINESS_CHECKING + docs: Indicates the financial purpose of the bank account. + source: + openapi: openapi/openapi.json + BatchChangeInventoryRequest: + properties: + idempotency_key: + type: string + docs: >- + A client-supplied, universally unique identifier (UUID) for the + + request. + + + See + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + in the + + [API Development 101](https://developer.squareup.com/docs/buildbasics) + section for more + + information. + validation: + minLength: 1 + maxLength: 128 + changes: + type: optional>> + docs: >- + The set of physical counts and inventory adjustments to be made. + + Changes are applied based on the client-supplied timestamp and may be + sent + + out of order. + ignore_unchanged_counts: + type: optional> + docs: >- + Indicates whether the current physical count should be ignored if + + the quantity is unchanged since the last physical count. Default: + `true`. + source: + openapi: openapi/openapi.json + BatchChangeInventoryResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + counts: + type: optional> + docs: The current counts for all objects referenced in the request. + changes: + type: optional> + docs: Changes created for the request. + source: + openapi: openapi/openapi.json + BatchDeleteCatalogObjectsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + deleted_object_ids: + type: optional> + docs: The IDs of all CatalogObjects deleted by this request. + deleted_at: + type: optional + docs: >- + The database + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + of this deletion in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". + source: + openapi: openapi/openapi.json + BatchGetCatalogObjectsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + objects: + type: optional> + docs: A list of [CatalogObject](entity:CatalogObject)s returned. + related_objects: + type: optional> + docs: >- + A list of [CatalogObject](entity:CatalogObject)s referenced by the + object in the `objects` field. + source: + openapi: openapi/openapi.json + BatchRetrieveInventoryChangesRequest: + properties: + catalog_object_ids: + type: optional>> + docs: |- + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + location_ids: + type: optional>> + docs: |- + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + types: + type: optional>> + docs: >- + The filter to return results by `InventoryChangeType` values other + than `TRANSFER`. + + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + states: + type: optional>> + docs: |- + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + updated_after: + type: optional> + docs: |- + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + updated_before: + type: optional> + docs: >- + The filter to return results with their `created_at` or + `calculated_at` value + + strictly before the given time as specified in an RFC 3339 timestamp. + + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for the original + query. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + limit: + type: optional> + docs: The number of [records](entity:InventoryChange) to return. + validation: + min: 1 + max: 1000 + source: + openapi: openapi/openapi.json + BatchGetInventoryChangesResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + changes: + type: optional> + docs: |- + The current calculated inventory changes for the requested objects + and locations. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + + this is the final response. + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + source: + openapi: openapi/openapi.json + BatchGetInventoryCountsRequest: + properties: + catalog_object_ids: + type: optional>> + docs: |- + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + location_ids: + type: optional>> + docs: |- + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + updated_after: + type: optional> + docs: |- + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for the original + query. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + states: + type: optional>> + docs: >- + The filter to return results by `InventoryState`. The filter is only + applicable when set. + + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + + The default is null. + limit: + type: optional> + docs: The number of [records](entity:InventoryCount) to return. + validation: + min: 1 + max: 1000 + source: + openapi: openapi/openapi.json + BatchGetInventoryCountsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + counts: + type: optional> + docs: |- + The current calculated inventory counts for the requested objects + and locations. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + + this is the final response. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + source: + openapi: openapi/openapi.json + BatchGetOrdersResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `BatchRetrieveOrders` endpoint. + properties: + orders: + type: optional> + docs: >- + The requested orders. This will omit any requested orders that do not + exist. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BatchUpsertCatalogObjectsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + objects: + type: optional> + docs: The created successfully created CatalogObjects. + updated_at: + type: optional + docs: >- + The database + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + of this update in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". + id_mappings: + type: optional> + docs: The mapping between client and server IDs for this upsert. + source: + openapi: openapi/openapi.json + Booking: + docs: >- + Represents a booking as a time-bound service contract for a seller's staff + member to provide a specified service + + at a given location to a requesting customer in one or more appointment + segments. + properties: + id: + type: optional + docs: A unique ID of this object representing a booking. + validation: + maxLength: 36 + access: read-only + version: + type: optional + docs: The revision number for the booking used for optimistic concurrency. + status: + type: optional + docs: >- + The status of the booking, describing where the booking stands with + respect to the booking state machine. + + See [BookingStatus](#type-bookingstatus) for possible values + created_at: + type: optional + docs: The RFC 3339 timestamp specifying the creation time of this booking. + access: read-only + updated_at: + type: optional + docs: >- + The RFC 3339 timestamp specifying the most recent update time of this + booking. + access: read-only + start_at: + type: optional> + docs: The RFC 3339 timestamp specifying the starting time of this booking. + location_id: + type: optional> + docs: >- + The ID of the [Location](entity:Location) object representing the + location where the booked service is provided. Once set when the + booking is created, its value cannot be changed. + validation: + maxLength: 32 + customer_id: + type: optional> + docs: >- + The ID of the [Customer](entity:Customer) object representing the + customer receiving the booked service. + validation: + maxLength: 192 + customer_note: + type: optional> + docs: >- + The free-text field for the customer to supply notes about the + booking. For example, the note can be preferences that cannot be + expressed by supported attributes of a relevant + [CatalogObject](entity:CatalogObject) instance. + validation: + maxLength: 4096 + seller_note: + type: optional> + docs: >- + The free-text field for the seller to supply notes about the booking. + For example, the note can be preferences that cannot be expressed by + supported attributes of a specific + [CatalogObject](entity:CatalogObject) instance. + + This field should not be visible to customers. + validation: + maxLength: 4096 + appointment_segments: + type: optional>> + docs: A list of appointment segments for this booking. + transition_time_minutes: + type: optional + docs: >- + Additional time at the end of a booking. + + Applications should not make this field visible to customers of a + seller. + access: read-only + all_day: + type: optional + docs: Whether the booking is of a full business day. + access: read-only + location_type: + type: optional + docs: >- + The type of location where the booking is held. + + See + [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) + for possible values + creator_details: + type: optional + docs: Information about the booking creator. + source: + type: optional + docs: >- + The source of the booking. + + Access to this field requires seller-level permissions. + + See [BookingBookingSource](#type-bookingbookingsource) for possible + values + address: + type: optional
+ docs: Stores a customer address if the location type is `CUSTOMER_LOCATION`. + source: + openapi: openapi/openapi.json + BookingBookingSource: + enum: + - FIRST_PARTY_MERCHANT + - FIRST_PARTY_BUYER + - THIRD_PARTY_BUYER + - API + docs: Supported sources a booking was created from. + source: + openapi: openapi/openapi.json + BookingCreatorDetails: + docs: Information about a booking creator. + properties: + creator_type: + type: optional + docs: >- + The seller-accessible type of the creator of the booking. + + See + [BookingCreatorDetailsCreatorType](#type-bookingcreatordetailscreatortype) + for possible values + team_member_id: + type: optional + docs: >- + The ID of the team member who created the booking, when the booking + creator is of the `TEAM_MEMBER` type. + + Access to this field requires seller-level permissions. + validation: + maxLength: 32 + access: read-only + customer_id: + type: optional + docs: >- + The ID of the customer who created the booking, when the booking + creator is of the `CUSTOMER` type. + + Access to this field requires seller-level permissions. + validation: + maxLength: 192 + access: read-only + source: + openapi: openapi/openapi.json + BookingCreatorDetailsCreatorType: + enum: + - TEAM_MEMBER + - CUSTOMER + docs: Supported types of a booking creator. + source: + openapi: openapi/openapi.json + BookingCustomAttributeDeleteRequest: + docs: >- + Represents an individual delete request in a + [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) + + request. An individual request contains a booking ID, the custom attribute + to delete, and an optional idempotency key. + properties: + booking_id: + type: string + docs: The ID of the target [booking](entity:Booking). + validation: + minLength: 1 + maxLength: 36 + key: + type: string + docs: >- + The key of the custom attribute to delete. This key must match the + `key` of a + + custom attribute definition in the Square seller account. If the + requesting application is not + + the definition owner, you must use the qualified key. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + BookingCustomAttributeDeleteResponse: + docs: >- + Represents a response for an individual upsert request in a + [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) + operation. + properties: + booking_id: + type: optional + docs: >- + The ID of the [booking](entity:Booking) associated with the custom + attribute. + errors: + type: optional> + docs: Any errors that occurred while processing the individual request. + source: + openapi: openapi/openapi.json + BookingCustomAttributeUpsertRequest: + docs: >- + Represents an individual upsert request in a + [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) + + request. An individual request contains a booking ID, the custom attribute + to create or update, + + and an optional idempotency key. + properties: + booking_id: + type: string + docs: The ID of the target [booking](entity:Booking). + validation: + minLength: 1 + maxLength: 36 + custom_attribute: + type: CustomAttribute + docs: >- + The custom attribute to create or update, with following fields: + + + - `key`. This key must match the `key` of a custom attribute + definition in the Square seller + + account. If the requesting application is not the definition owner, + you must provide the qualified key. + + + - `value`. This value must conform to the `schema` specified by the + definition. + + For more information, see [Value data + types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control for update operations, include this optional field in the + request and set the + + value to the current version of the custom attribute. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this individual upsert request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + source: + openapi: openapi/openapi.json + BookingCustomAttributeUpsertResponse: + docs: >- + Represents a response for an individual upsert request in a + [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) + operation. + properties: + booking_id: + type: optional + docs: >- + The ID of the [booking](entity:Booking) associated with the custom + attribute. + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred while processing the individual request. + source: + openapi: openapi/openapi.json + BookingStatus: + enum: + - PENDING + - CANCELLED_BY_CUSTOMER + - CANCELLED_BY_SELLER + - DECLINED + - ACCEPTED + - NO_SHOW + docs: Supported booking statuses. + source: + openapi: openapi/openapi.json + Break: + docs: A record of an employee's break during a shift. + properties: + id: + type: optional + docs: The UUID for this object. + start_at: + type: string + docs: >- + RFC 3339; follows the same timezone information as `Shift`. Precision + up to + + the minute is respected; seconds are truncated. + validation: + minLength: 1 + end_at: + type: optional> + docs: >- + RFC 3339; follows the same timezone information as `Shift`. Precision + up to + + the minute is respected; seconds are truncated. + break_type_id: + type: string + docs: The `BreakType` that this `Break` was templated on. + validation: + minLength: 1 + name: + type: string + docs: A human-readable name. + validation: + minLength: 1 + expected_duration: + type: string + docs: |- + Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of + the break. + validation: + minLength: 1 + is_paid: + type: boolean + docs: |- + Whether this break counts towards time worked for compensation + purposes. + source: + openapi: openapi/openapi.json + BreakType: + docs: |- + A defined break template that sets an expectation for possible `Break` + instances on a `Shift`. + properties: + id: + type: optional + docs: The UUID for this object. + validation: + maxLength: 255 + location_id: + type: string + docs: The ID of the business location this type of break applies to. + validation: + minLength: 1 + break_name: + type: string + docs: |- + A human-readable name for this type of break. The name is displayed to + employees in Square products. + validation: + minLength: 1 + expected_duration: + type: string + docs: |- + Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of + this break. Precision less than minutes is truncated. + + Example for break expected duration of 15 minutes: T15M + validation: + minLength: 1 + is_paid: + type: boolean + docs: |- + Whether this break counts towards time worked for compensation + purposes. + version: + type: optional + docs: >- + Used for resolving concurrency issues. The request fails if the + version + + provided does not match the server version at the time of the request. + If a value is not + + provided, Square's servers execute a "blind" write; potentially + + overwriting another writer's data. + created_at: + type: optional + docs: A read-only timestamp in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: A read-only timestamp in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + BulkCreateCustomerData: + docs: >- + Defines the customer data provided in individual create requests for a + + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) + operation. + properties: + given_name: + type: optional> + docs: >- + The given name (that is, the first name) associated with the customer + profile. + validation: + maxLength: 300 + family_name: + type: optional> + docs: >- + The family name (that is, the last name) associated with the customer + profile. + validation: + maxLength: 300 + company_name: + type: optional> + docs: A business name associated with the customer profile. + validation: + maxLength: 500 + nickname: + type: optional> + docs: A nickname for the customer profile. + validation: + maxLength: 100 + email_address: + type: optional> + docs: The email address associated with the customer profile. + validation: + maxLength: 254 + address: + type: optional
+ docs: >- + The physical address associated with the customer profile. For maximum + length constraints, + + see [Customer + addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + + The `first_name` and `last_name` fields are ignored if they are + present in the request. + phone_number: + type: optional> + docs: >- + The phone number associated with the customer profile. The phone + number must be valid + + and can contain 9–16 digits, with an optional `+` prefix and country + code. For more information, + + see [Customer phone + numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + reference_id: + type: optional> + docs: |- + An optional second ID used to associate the customer profile with an + entity in another system. + validation: + maxLength: 100 + note: + type: optional> + docs: A custom note associated with the customer profile. + birthday: + type: optional> + docs: >- + The birthday associated with the customer profile, in `YYYY-MM-DD` or + `MM-DD` format. + + For example, specify `1998-09-21` for September 21, 1998, or `09-21` + for September 21. + + Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the + specified birth year or + + `0000` if a birth year is not specified. + tax_ids: + type: optional + docs: >- + The tax ID associated with the customer profile. This field is + available only for + + customers of sellers in EU countries or the United Kingdom. For more + information, see + + [Customer tax + IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + source: + openapi: openapi/openapi.json + BulkCreateCustomersResponse: + docs: >- + Defines the fields included in the response body from the + + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) + endpoint. + properties: + responses: + type: optional> + docs: >- + A map of responses that correspond to individual create requests, + represented by + + key-value pairs. + + + Each key is the idempotency key that was provided for a create request + and each value + + is the corresponding response. + + If the request succeeds, the value is the new customer profile. + + If the request fails, the value contains any errors that occurred + during the request. + errors: + type: optional> + docs: Any top-level errors that prevented the bulk operation from running. + source: + openapi: openapi/openapi.json + BatchCreateTeamMembersResponse: + docs: >- + Represents a response from a bulk create request containing the created + `TeamMember` objects or error messages. + properties: + team_members: + type: optional> + docs: >- + The successfully created `TeamMember` objects. Each key is the + `idempotency_key` that maps to the `CreateTeamMemberRequest`. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + BatchCreateVendorsResponse: + docs: >- + Represents an output from a call to + [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + responses: + type: optional> + docs: >- + A set of [CreateVendorResponse](entity:CreateVendorResponse) objects + encapsulating successfully created [Vendor](entity:Vendor) + + objects or error responses for failed attempts. The set is represented + by + + a collection of idempotency-key/`Vendor`-object or + idempotency-key/error-object pairs. The idempotency keys correspond to + those specified + + in the input. + source: + openapi: openapi/openapi.json + BulkDeleteBookingCustomAttributesResponse: + docs: >- + Represents a + [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + delete request. + properties: + values: + type: optional> + docs: >- + A map of responses that correspond to individual delete requests. Each + response has the + + same ID as the corresponding request and contains `booking_id` and + `errors` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BulkDeleteCustomersResponse: + docs: >- + Defines the fields included in the response body from the + + [BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) + endpoint. + properties: + responses: + type: optional> + docs: >- + A map of responses that correspond to individual delete requests, + represented by + + key-value pairs. + + + Each key is the customer ID that was specified for a delete request + and each value + + is the corresponding response. + + If the request succeeds, the value is an empty object (`{ }`). + + If the request fails, the value contains any errors that occurred + during the request. + errors: + type: optional> + docs: Any top-level errors that prevented the bulk operation from running. + source: + openapi: openapi/openapi.json + BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest: + docs: >- + Represents an individual delete request in a + [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + + request. An individual request contains an optional ID of the associated + custom attribute definition + + and optional key of the associated custom attribute definition. + properties: + key: + type: optional + docs: >- + The key of the associated custom attribute definition. + + Represented as a qualified key if the requesting app is not the + definition owner. + validation: + pattern: ^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$ + access: read-only + source: + openapi: openapi/openapi.json + BulkDeleteLocationCustomAttributesResponse: + docs: >- + Represents a + [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + delete request. + properties: + values: + type: >- + map + docs: >- + A map of responses that correspond to individual delete requests. Each + response has the + + same key as the corresponding request. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse: + docs: >- + Represents an individual delete response in a + [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + + request. + properties: + location_id: + type: optional + docs: The ID of the location associated with the custom attribute. + errors: + type: optional> + docs: >- + Errors that occurred while processing the individual + LocationCustomAttributeDeleteRequest request + source: + openapi: openapi/openapi.json + BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest: + docs: >- + Represents an individual delete request in a + [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + + request. An individual request contains an optional ID of the associated + custom attribute definition + + and optional key of the associated custom attribute definition. + properties: + key: + type: optional + docs: >- + The key of the associated custom attribute definition. + + Represented as a qualified key if the requesting app is not the + definition owner. + validation: + pattern: ^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$ + access: read-only + source: + openapi: openapi/openapi.json + BulkDeleteMerchantCustomAttributesResponse: + docs: >- + Represents a + [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + delete request. + properties: + values: + type: >- + map + docs: >- + A map of responses that correspond to individual delete requests. Each + response has the + + same key as the corresponding request. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse: + docs: >- + Represents an individual delete response in a + [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + + request. + properties: + errors: + type: optional> + docs: >- + Errors that occurred while processing the individual + MerchantCustomAttributeDeleteRequest request + source: + openapi: openapi/openapi.json + BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute: + docs: Represents one delete within the bulk operation. + properties: + key: + type: optional + docs: >- + The key of the custom attribute to delete. This key must match the + key + + of an existing custom attribute definition. + validation: + pattern: ^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$ + minLength: 1 + access: read-only + order_id: + type: string + docs: The ID of the target [order](entity:Order). + validation: + minLength: 1 + maxLength: 255 + source: + openapi: openapi/openapi.json + BulkDeleteOrderCustomAttributesResponse: + docs: Represents a response from deleting one or more order custom attributes. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + values: + type: map + docs: >2- + A map of responses that correspond to individual delete requests. Each response has the same ID + as the corresponding request and contains either a `custom_attribute` + or an `errors` field. + source: + openapi: openapi/openapi.json + BulkRetrieveBookingsResponse: + docs: Response payload for bulk retrieval of bookings. + properties: + bookings: + type: optional> + docs: >- + Requested bookings returned as a map containing `booking_id` as the + key and `RetrieveBookingResponse` as the value. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + BulkRetrieveCustomersResponse: + docs: >- + Defines the fields included in the response body from the + + [BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) + endpoint. + properties: + responses: + type: optional> + docs: >- + A map of responses that correspond to individual retrieve requests, + represented by + + key-value pairs. + + + Each key is the customer ID that was specified for a retrieve request + and each value + + is the corresponding response. + + If the request succeeds, the value is the requested customer profile. + + If the request fails, the value contains any errors that occurred + during the request. + errors: + type: optional> + docs: Any top-level errors that prevented the bulk operation from running. + source: + openapi: openapi/openapi.json + BulkRetrieveTeamMemberBookingProfilesResponse: + docs: >- + Response payload for the + [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles) + endpoint. + properties: + team_member_booking_profiles: + type: optional> + docs: >- + The returned team members' booking profiles, as a map with + `team_member_id` as the key and + [TeamMemberBookingProfile](entity:TeamMemberBookingProfile) the value. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + BatchGetVendorsResponse: + docs: >- + Represents an output from a call to + [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + responses: + type: optional> + docs: >- + The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse) + objects encapsulating successfully retrieved [Vendor](entity:Vendor) + + objects or error responses for failed attempts. The set is represented + by + + a collection of `Vendor`-ID/`Vendor`-object or + `Vendor`-ID/error-object pairs. + source: + openapi: openapi/openapi.json + BulkSwapPlanResponse: + docs: |- + Defines output parameters in a response of the + [BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + affected_subscriptions: + type: optional + docs: The number of affected subscriptions. + source: + openapi: openapi/openapi.json + BulkUpdateCustomerData: + docs: >- + Defines the customer data provided in individual update requests for a + + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) + operation. + properties: + given_name: + type: optional> + docs: >- + The given name (that is, the first name) associated with the customer + profile. + validation: + maxLength: 300 + family_name: + type: optional> + docs: >- + The family name (that is, the last name) associated with the customer + profile. + validation: + maxLength: 300 + company_name: + type: optional> + docs: A business name associated with the customer profile. + validation: + maxLength: 500 + nickname: + type: optional> + docs: A nickname for the customer profile. + validation: + maxLength: 100 + email_address: + type: optional> + docs: The email address associated with the customer profile. + validation: + maxLength: 254 + address: + type: optional
+ docs: >- + The physical address associated with the customer profile. For maximum + length constraints, + + see [Customer + addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + + The `first_name` and `last_name` fields are ignored if they are + present in the request. + phone_number: + type: optional> + docs: >- + The phone number associated with the customer profile. The phone + number must be valid + + and can contain 9–16 digits, with an optional `+` prefix and country + code. For more information, + + see [Customer phone + numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + reference_id: + type: optional> + docs: |- + An optional second ID used to associate the customer profile with an + entity in another system. + validation: + maxLength: 100 + note: + type: optional> + docs: An custom note associates with the customer profile. + birthday: + type: optional> + docs: >- + The birthday associated with the customer profile, in `YYYY-MM-DD` or + `MM-DD` format. + + For example, specify `1998-09-21` for September 21, 1998, or `09-21` + for September 21. + + Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the + specified birth year or + + `0000` if a birth year is not specified. + tax_ids: + type: optional + docs: >- + The tax ID associated with the customer profile. This field is + available only for + + customers of sellers in EU countries or the United Kingdom. For more + information, see + + [Customer tax + IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + version: + type: optional + docs: >- + The current version of the customer profile. + + + As a best practice, you should include this field to enable + + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control. + source: + openapi: openapi/openapi.json + BulkUpdateCustomersResponse: + docs: >- + Defines the fields included in the response body from the + + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) + endpoint. + properties: + responses: + type: optional> + docs: >- + A map of responses that correspond to individual update requests, + represented by + + key-value pairs. + + + Each key is the customer ID that was specified for an update request + and each value + + is the corresponding response. + + If the request succeeds, the value is the updated customer profile. + + If the request fails, the value contains any errors that occurred + during the request. + errors: + type: optional> + docs: Any top-level errors that prevented the bulk operation from running. + source: + openapi: openapi/openapi.json + BatchUpdateTeamMembersResponse: + docs: >- + Represents a response from a bulk update request containing the updated + `TeamMember` objects or error messages. + properties: + team_members: + type: optional> + docs: >- + The successfully updated `TeamMember` objects. Each key is the + `team_member_id` that maps to the `UpdateTeamMemberRequest`. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + BatchUpdateVendorsResponse: + docs: >- + Represents an output from a call to + [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors). + properties: + errors: + type: optional> + docs: Errors encountered when the request fails. + responses: + type: optional> + docs: >- + A set of [UpdateVendorResponse](entity:UpdateVendorResponse) objects + encapsulating successfully created [Vendor](entity:Vendor) + + objects or error responses for failed attempts. The set is represented + by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or + + `Vendor`-ID/error-object pairs. + source: + openapi: openapi/openapi.json + BulkUpsertBookingCustomAttributesResponse: + docs: >- + Represents a + [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + upsert request. + properties: + values: + type: optional> + docs: >- + A map of responses that correspond to individual upsert requests. Each + response has the + + same ID as the corresponding request and contains either a + `booking_id` and `custom_attribute` or an `errors` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest: + docs: >- + Represents an individual upsert request in a + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + + request. An individual request contains a customer ID, the custom + attribute to create or update, + + and an optional idempotency key. + properties: + customer_id: + type: string + docs: The ID of the target [customer profile](entity:Customer). + validation: + minLength: 1 + custom_attribute: + type: CustomAttribute + docs: >- + The custom attribute to create or update, with following fields: + + + - `key`. This key must match the `key` of a custom attribute + definition in the Square seller + + account. If the requesting application is not the definition owner, + you must provide the qualified key. + + + - `value`. This value must conform to the `schema` specified by the + definition. + + For more information, see [Value data + types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control for update operations, include this optional field in the + request and set the + + value to the current version of the custom attribute. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this individual upsert request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + source: + openapi: openapi/openapi.json + BatchUpsertCustomerCustomAttributesResponse: + docs: >- + Represents a + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + upsert request. + properties: + values: + type: >- + optional> + docs: >- + A map of responses that correspond to individual upsert requests. Each + response has the + + same ID as the corresponding request and contains either a + `customer_id` and `custom_attribute` or an `errors` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse: + docs: >- + Represents a response for an individual upsert request in a + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + operation. + properties: + customer_id: + type: optional + docs: The ID of the customer profile associated with the custom attribute. + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred while processing the individual request. + source: + openapi: openapi/openapi.json + BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest: + docs: >- + Represents an individual upsert request in a + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + + request. An individual request contains a location ID, the custom + attribute to create or update, + + and an optional idempotency key. + properties: + location_id: + type: string + docs: The ID of the target [location](entity:Location). + validation: + minLength: 1 + custom_attribute: + type: CustomAttribute + docs: >- + The custom attribute to create or update, with following fields: + + - `key`. This key must match the `key` of a custom attribute + definition in the Square seller + + account. If the requesting application is not the definition owner, + you must provide the qualified key. + + - `value`. This value must conform to the `schema` specified by the + definition. + + For more information, see [Supported data + types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).. + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, specify the current version of the custom attribute. + + If this is not important for your application, `version` can be set to + -1. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this individual upsert request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + source: + openapi: openapi/openapi.json + BulkUpsertLocationCustomAttributesResponse: + docs: >- + Represents a + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + upsert request. + properties: + values: + type: >- + optional> + docs: >- + A map of responses that correspond to individual upsert requests. Each + response has the + + same ID as the corresponding request and contains either a + `location_id` and `custom_attribute` or an `errors` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse: + docs: >- + Represents a response for an individual upsert request in a + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + operation. + properties: + location_id: + type: optional + docs: The ID of the location associated with the custom attribute. + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred while processing the individual request. + source: + openapi: openapi/openapi.json + BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest: + docs: >- + Represents an individual upsert request in a + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + + request. An individual request contains a merchant ID, the custom + attribute to create or update, + + and an optional idempotency key. + properties: + merchant_id: + type: string + docs: The ID of the target [merchant](entity:Merchant). + validation: + minLength: 1 + custom_attribute: + type: CustomAttribute + docs: >- + The custom attribute to create or update, with following fields: + + - `key`. This key must match the `key` of a custom attribute + definition in the Square seller + + account. If the requesting application is not the definition owner, + you must provide the qualified key. + + - `value`. This value must conform to the `schema` specified by the + definition. + + For more information, see [Supported data + types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + + - The version field must match the current version of the custom + attribute definition to enable + + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + If this is not important for your application, version can be set to + -1. For any other values, the request fails with a BAD_REQUEST error. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this individual upsert request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + source: + openapi: openapi/openapi.json + BulkUpsertMerchantCustomAttributesResponse: + docs: >- + Represents a + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + response, + + which contains a map of responses that each corresponds to an individual + upsert request. + properties: + values: + type: >- + optional> + docs: >- + A map of responses that correspond to individual upsert requests. Each + response has the + + same ID as the corresponding request and contains either a + `merchant_id` and `custom_attribute` or an `errors` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse: + docs: >- + Represents a response for an individual upsert request in a + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + operation. + properties: + merchant_id: + type: optional + docs: The ID of the merchant associated with the custom attribute. + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred while processing the individual request. + source: + openapi: openapi/openapi.json + BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute: + docs: Represents one upsert within the bulk operation. + properties: + custom_attribute: + type: CustomAttribute + docs: >- + The custom attribute to create or update, with the following fields: + + + - `value`. This value must conform to the `schema` specified by the + definition. + + For more information, see [Value data + types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, include this optional field and specify the current version + of the custom attribute. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 45 + order_id: + type: string + docs: The ID of the target [order](entity:Order). + validation: + minLength: 1 + maxLength: 255 + source: + openapi: openapi/openapi.json + BulkUpsertOrderCustomAttributesResponse: + docs: Represents a response from a bulk upsert of order custom attributes. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + values: + type: map + docs: ' A map of responses that correspond to individual upsert operations for custom attributes.' + source: + openapi: openapi/openapi.json + BusinessAppointmentSettings: + docs: >- + The service appointment settings, including where and how the service is + provided. + properties: + location_types: + type: >- + optional>> + docs: >- + Types of the location allowed for bookings. + + See + [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) + for possible values + alignment_time: + type: optional + docs: >- + The time unit of the service duration for bookings. + + See + [BusinessAppointmentSettingsAlignmentTime](#type-businessappointmentsettingsalignmenttime) + for possible values + min_booking_lead_time_seconds: + type: optional> + docs: >- + The minimum lead time in seconds before a service can be booked. A + booking must be created at least this amount of time before its + starting time. + max_booking_lead_time_seconds: + type: optional> + docs: >- + The maximum lead time in seconds before a service can be booked. A + booking must be created at most this amount of time before its + starting time. + any_team_member_booking_enabled: + type: optional> + docs: >- + Indicates whether a customer can choose from all available time slots + and have a staff member assigned + + automatically (`true`) or not (`false`). + multiple_service_booking_enabled: + type: optional> + docs: >- + Indicates whether a customer can book multiple services in a single + online booking. + max_appointments_per_day_limit_type: + type: optional + docs: >- + Indicates whether the daily appointment limit applies to team members + or to + + business locations. + + See + [BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType](#type-businessappointmentsettingsmaxappointmentsperdaylimittype) + for possible values + max_appointments_per_day_limit: + type: optional> + docs: >- + The maximum number of daily appointments per team member or per + location. + cancellation_window_seconds: + type: optional> + docs: >- + The cut-off time in seconds for allowing clients to cancel or + reschedule an appointment. + cancellation_fee_money: + type: optional + docs: The flat-fee amount charged for a no-show booking. + cancellation_policy: + type: optional + docs: >- + The cancellation policy adopted by the seller. + + See + [BusinessAppointmentSettingsCancellationPolicy](#type-businessappointmentsettingscancellationpolicy) + for possible values + cancellation_policy_text: + type: optional> + docs: The free-form text of the seller's cancellation policy. + validation: + maxLength: 65536 + skip_booking_flow_staff_selection: + type: optional> + docs: >- + Indicates whether customers has an assigned staff member (`true`) or + can select s staff member of their choice (`false`). + source: + openapi: openapi/openapi.json + BusinessAppointmentSettingsAlignmentTime: + enum: + - SERVICE_DURATION + - QUARTER_HOURLY + - HALF_HOURLY + - HOURLY + docs: Time units of a service duration for bookings. + source: + openapi: openapi/openapi.json + BusinessAppointmentSettingsBookingLocationType: + enum: + - BUSINESS_LOCATION + - CUSTOMER_LOCATION + - PHONE + docs: Supported types of location where service is provided. + source: + openapi: openapi/openapi.json + BusinessAppointmentSettingsCancellationPolicy: + enum: + - CANCELLATION_TREATED_AS_NO_SHOW + - CUSTOM_POLICY + docs: The category of the seller’s cancellation policy. + source: + openapi: openapi/openapi.json + BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType: + enum: + - PER_TEAM_MEMBER + - PER_LOCATION + docs: Types of daily appointment limits. + source: + openapi: openapi/openapi.json + BusinessBookingProfile: + docs: >- + A seller's business booking profile, including booking policy, appointment + settings, etc. + properties: + seller_id: + type: optional> + docs: The ID of the seller, obtainable using the Merchants API. + validation: + maxLength: 32 + created_at: + type: optional + docs: The RFC 3339 timestamp specifying the booking's creation time. + access: read-only + booking_enabled: + type: optional> + docs: Indicates whether the seller is open for booking. + customer_timezone_choice: + type: optional + docs: >- + The choice of customer's time zone information of a booking. + + The Square online booking site and all notifications to customers uses + either the seller location’s time zone + + or the time zone the customer chooses at booking. + + See + [BusinessBookingProfileCustomerTimezoneChoice](#type-businessbookingprofilecustomertimezonechoice) + for possible values + booking_policy: + type: optional + docs: >- + The policy for the seller to automatically accept booking requests + (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`). + + See + [BusinessBookingProfileBookingPolicy](#type-businessbookingprofilebookingpolicy) + for possible values + allow_user_cancel: + type: optional> + docs: >- + Indicates whether customers can cancel or reschedule their own + bookings (`true`) or not (`false`). + business_appointment_settings: + type: optional + docs: Settings for appointment-type bookings. + support_seller_level_writes: + type: optional> + docs: >- + Indicates whether the seller's subscription to Square Appointments + supports creating, updating or canceling an appointment through the + API (`true`) or not (`false`) using seller permission. + source: + openapi: openapi/openapi.json + BusinessBookingProfileBookingPolicy: + enum: + - ACCEPT_ALL + - REQUIRES_ACCEPTANCE + docs: Policies for accepting bookings. + source: + openapi: openapi/openapi.json + BusinessBookingProfileCustomerTimezoneChoice: + enum: + - BUSINESS_LOCATION_TIMEZONE + - CUSTOMER_CHOICE + docs: Choices of customer-facing time zone used for bookings. + source: + openapi: openapi/openapi.json + BusinessHours: + docs: The hours of operation for a location. + properties: + periods: + type: optional>> + docs: >- + The list of time periods during which the business is open. There can + be at most 10 periods per day. + source: + openapi: openapi/openapi.json + BusinessHoursPeriod: + docs: Represents a period of time during which a business location is open. + properties: + day_of_week: + type: optional + docs: |- + The day of the week for this time period. + See [DayOfWeek](#type-dayofweek) for possible values + start_local_time: + type: optional> + docs: >- + The start time of a business hours period, specified in local time + using partial-time + + RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 + in the morning. + + Note that the seconds value is always :00, but it is appended for + conformance to the RFC. + end_local_time: + type: optional> + docs: >- + The end time of a business hours period, specified in local time using + partial-time + + RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 + in the evening. + + Note that the seconds value is always :00, but it is appended for + conformance to the RFC. + source: + openapi: openapi/openapi.json + BuyNowPayLaterDetails: + docs: Additional details about a Buy Now Pay Later payment type. + properties: + brand: + type: optional> + docs: |- + The brand used for the Buy Now Pay Later payment. + The brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`. + validation: + maxLength: 50 + afterpay_details: + type: optional + docs: >- + Details about an Afterpay payment. These details are only populated if + the `brand` is + + `AFTERPAY`. + clearpay_details: + type: optional + docs: >- + Details about a Clearpay payment. These details are only populated if + the `brand` is + + `CLEARPAY`. + source: + openapi: openapi/openapi.json + CalculateLoyaltyPointsResponse: + docs: >- + Represents a + [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) + response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + points: + type: optional + docs: >- + The number of points that the buyer can earn from the base loyalty + program. + promotion_points: + type: optional + docs: >- + The number of points that the buyer can earn from a loyalty promotion. + To be eligible + + to earn promotion points, the purchase must first qualify for program + points. When `order_id` + + is not provided in the request, this value is always 0. + source: + openapi: openapi/openapi.json + CalculateOrderResponse: + properties: + order: + type: optional + docs: The calculated version of the order provided in the request. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CancelBookingResponse: + properties: + booking: + type: optional + docs: The booking that was cancelled. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + CancelInvoiceResponse: + docs: The response returned by the `CancelInvoice` request. + properties: + invoice: + type: optional + docs: The canceled invoice. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + CancelLoyaltyPromotionResponse: + docs: >- + Represents a + [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion) + response. + + Either `loyalty_promotion` or `errors` is present in the response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_promotion: + type: optional + docs: The canceled loyalty promotion. + source: + openapi: openapi/openapi.json + CancelPaymentByIdempotencyKeyResponse: + docs: >- + Defines the response returned by + + [CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey). + + On success, `errors` is empty. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CancelPaymentResponse: + docs: >- + Defines the response returned by + [CancelPayment](api-endpoint:Payments-CancelPayment). + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + payment: + type: optional + docs: The successfully canceled `Payment` object. + source: + openapi: openapi/openapi.json + CancelSubscriptionResponse: + docs: >- + Defines output parameters in a response from the + + [CancelSubscription](api-endpoint:Subscriptions-CancelSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: >- + The specified subscription scheduled for cancellation according to the + action created by the request. + actions: + type: optional> + docs: A list of a single `CANCEL` action scheduled for the subscription. + source: + openapi: openapi/openapi.json + CancelTerminalActionResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + action: + type: optional + docs: The canceled `TerminalAction` + source: + openapi: openapi/openapi.json + CancelTerminalCheckoutResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + checkout: + type: optional + docs: The canceled `TerminalCheckout`. + source: + openapi: openapi/openapi.json + CancelTerminalRefundResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refund: + type: optional + docs: The updated `TerminalRefund`. + source: + openapi: openapi/openapi.json + CaptureTransactionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) + endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + Card: + docs: |- + Represents the payment details of a card to be used for payments. These + details are determined by the payment token generated by Web Payments SDK. + properties: + id: + type: optional + docs: Unique ID for this card. Generated by Square. + validation: + maxLength: 64 + access: read-only + card_brand: + type: optional + docs: |- + The card's brand. + See [CardBrand](#type-cardbrand) for possible values + last_4: + type: optional + docs: The last 4 digits of the card number. + validation: + maxLength: 4 + access: read-only + exp_month: + type: optional> + docs: >- + The expiration month of the associated card as an integer between 1 + and 12. + exp_year: + type: optional> + docs: The four-digit year of the card's expiration date. + cardholder_name: + type: optional> + docs: The name of the cardholder. + validation: + maxLength: 96 + billing_address: + type: optional
+ docs: >- + The billing address for this card. `US` postal codes can be provided + as a 5-digit zip code + + or 9-digit ZIP+4 (example: `12345-6789`). For a full list of field + meanings by country, see + + [Working with + Addresses](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-addresses). + fingerprint: + type: optional + docs: >- + Intended as a Square-assigned identifier, based + + on the card number, to identify the card across multiple locations + within a + + single application. + validation: + maxLength: 255 + access: read-only + customer_id: + type: optional> + docs: >- + **Required** The ID of a [customer](entity:Customer) to be associated + with the card. + merchant_id: + type: optional + docs: The ID of the merchant associated with the card. + access: read-only + reference_id: + type: optional> + docs: >- + An optional user-defined reference ID that associates this card with + + another entity in an external system. For example, a customer ID from + an + + external customer management system. + validation: + maxLength: 128 + enabled: + type: optional + docs: Indicates whether or not a card can be used for payments. + access: read-only + card_type: + type: optional + docs: >- + The type of the card. + + The Card object includes this field only in response to Payments API + calls. + + See [CardType](#type-cardtype) for possible values + prepaid_type: + type: optional + docs: |- + Indicates whether the card is prepaid or not. + See [CardPrepaidType](#type-cardprepaidtype) for possible values + bin: + type: optional + docs: >- + The first six digits of the card number, known as the Bank + Identification Number (BIN). Only the Payments API + + returns this field. + validation: + maxLength: 6 + access: read-only + version: + type: optional + docs: >- + Current version number of the card. Increments with each card update. + Requests to update an + + existing Card object will be rejected unless the version in the + request matches the current + + version for the Card. + card_co_brand: + type: optional + docs: >- + The card's co-brand if available. For example, an Afterpay virtual + card would have a + + co-brand of AFTERPAY. + + See [CardCoBrand](#type-cardcobrand) for possible values + issuer_alert: + type: optional + docs: >- + An alert from the issuing bank about the card status. Alerts can + indicate whether + + future charges to the card are likely to fail. For more information, + see + + [Manage Card on File + Declines](https://developer.squareup.com/docs/cards-api/manage-card-on-file-declines). + + + This field is present only if there's an active issuer alert. + + See [IssuerAlert](#type-issueralert) for possible values + issuer_alert_at: + type: optional + docs: >- + The timestamp of when the current issuer alert was received and + processed, in + + RFC 3339 format. + + + This field is present only if there's an active issuer alert. + access: read-only + hsa_fsa: + type: optional + docs: >- + Indicates whether the card is linked to a Health Savings Account (HSA) + or Flexible + + Spending Account (FSA), based on the card BIN. + access: read-only + source: + openapi: openapi/openapi.json + CardBrand: + enum: + - OTHER_BRAND + - VISA + - MASTERCARD + - AMERICAN_EXPRESS + - DISCOVER + - DISCOVER_DINERS + - JCB + - CHINA_UNIONPAY + - SQUARE_GIFT_CARD + - SQUARE_CAPITAL_CARD + - INTERAC + - EFTPOS + - FELICA + - EBT + docs: Indicates a card's brand, such as `VISA` or `MASTERCARD`. + source: + openapi: openapi/openapi.json + CardCoBrand: + enum: + - UNKNOWN + - AFTERPAY + - CLEARPAY + docs: Indicates the brand for a co-branded card. + source: + openapi: openapi/openapi.json + CardIssuerAlert: + type: literal<"ISSUER_ALERT_CARD_CLOSED"> + docs: Indicates the type of issuer alert for a [card on file](entity:Card). + CardPaymentDetails: + docs: >- + Reflects the current status of a card payment. Contains only + non-confidential information. + properties: + status: + type: optional> + docs: >- + The card payment's current state. The state can be AUTHORIZED, + CAPTURED, VOIDED, or + + FAILED. + validation: + maxLength: 50 + card: + type: optional + docs: The credit card's non-confidential details. + entry_method: + type: optional> + docs: >- + The method used to enter the card's details for the payment. The + method can be + + `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + validation: + maxLength: 50 + cvv_status: + type: optional> + docs: >- + The status code returned from the Card Verification Value (CVV) check. + The code can be + + `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`. + validation: + maxLength: 50 + avs_status: + type: optional> + docs: >- + The status code returned from the Address Verification System (AVS) + check. The code can be + + `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`. + validation: + maxLength: 50 + auth_result_code: + type: optional> + docs: >- + The status code returned by the card issuer that describes the + payment's + + authorization status. + validation: + maxLength: 10 + application_identifier: + type: optional> + docs: >- + For EMV payments, the application ID identifies the EMV application + used for the payment. + validation: + maxLength: 32 + application_name: + type: optional> + docs: >- + For EMV payments, the human-readable name of the EMV application used + for the payment. + validation: + maxLength: 16 + application_cryptogram: + type: optional> + docs: For EMV payments, the cryptogram generated for the payment. + validation: + maxLength: 16 + verification_method: + type: optional> + docs: >- + For EMV payments, the method used to verify the cardholder's identity. + The method can be + + `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. + validation: + maxLength: 50 + verification_results: + type: optional> + docs: >- + For EMV payments, the results of the cardholder verification. The + result can be + + `SUCCESS`, `FAILURE`, or `UNKNOWN`. + validation: + maxLength: 50 + statement_description: + type: optional> + docs: >- + The statement description sent to the card networks. + + + Note: The actual statement description varies and is likely to be + truncated and appended with + + additional information on a per issuer basis. + validation: + maxLength: 50 + device_details: + type: optional + docs: |- + __Deprecated__: Use `Payment.device_details` instead. + + Details about the device that took the payment. + card_payment_timeline: + type: optional + docs: The timeline for card payments. + refund_requires_card_presence: + type: optional> + docs: |- + Whether the card must be physically present for the payment to + be refunded. If set to `true`, the card must be present. + errors: + type: optional>> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + CardPaymentTimeline: + docs: The timeline for card payments. + properties: + authorized_at: + type: optional> + docs: The timestamp when the payment was authorized, in RFC 3339 format. + captured_at: + type: optional> + docs: The timestamp when the payment was captured, in RFC 3339 format. + voided_at: + type: optional> + docs: The timestamp when the payment was voided, in RFC 3339 format. + source: + openapi: openapi/openapi.json + CardPrepaidType: + enum: + - UNKNOWN_PREPAID_TYPE + - NOT_PREPAID + - PREPAID + docs: Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`. + source: + openapi: openapi/openapi.json + CardType: + enum: + - UNKNOWN_CARD_TYPE + - CREDIT + - DEBIT + docs: Indicates a card's type, such as `CREDIT` or `DEBIT`. + source: + openapi: openapi/openapi.json + CashAppDetails: + docs: >- + Additional details about `WALLET` type payments with the `brand` of + `CASH_APP`. + properties: + buyer_full_name: + type: optional> + docs: The name of the Cash App account holder. + validation: + maxLength: 255 + buyer_country_code: + type: optional> + docs: >- + The country of the Cash App account holder, in ISO 3166-1-alpha-2 + format. + + + For possible values, see [Country](entity:Country). + validation: + minLength: 2 + maxLength: 2 + buyer_cashtag: + type: optional + docs: $Cashtag of the Cash App account holder. + validation: + minLength: 1 + maxLength: 21 + access: read-only + source: + openapi: openapi/openapi.json + CashDrawerDevice: + properties: + id: + type: optional + docs: The device Square-issued ID + name: + type: optional> + docs: The device merchant-specified name. + source: + openapi: openapi/openapi.json + CashDrawerEventType: + enum: + - NO_SALE + - CASH_TENDER_PAYMENT + - OTHER_TENDER_PAYMENT + - CASH_TENDER_CANCELLED_PAYMENT + - OTHER_TENDER_CANCELLED_PAYMENT + - CASH_TENDER_REFUND + - OTHER_TENDER_REFUND + - PAID_IN + - PAID_OUT + docs: |- + The types of events on a CashDrawerShift. + Each event type represents an employee action on the actual cash drawer + represented by a CashDrawerShift. + source: + openapi: openapi/openapi.json + CashDrawerShift: + docs: >- + This model gives the details of a cash drawer shift. + + The cash_payment_money, cash_refund_money, cash_paid_in_money, + + and cash_paid_out_money fields are all computed by summing their + respective + + event types. + properties: + id: + type: optional + docs: The shift unique ID. + state: + type: optional + docs: >- + The shift current state. + + See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible + values + opened_at: + type: optional> + docs: The time when the shift began, in ISO 8601 format. + ended_at: + type: optional> + docs: The time when the shift ended, in ISO 8601 format. + closed_at: + type: optional> + docs: The time when the shift was closed, in ISO 8601 format. + description: + type: optional> + docs: The free-form text description of a cash drawer by an employee. + opened_cash_money: + type: optional + docs: |- + The amount of money in the cash drawer at the start of the shift. + The amount must be greater than or equal to zero. + cash_payment_money: + type: optional + docs: >- + The amount of money added to the cash drawer from cash payments. + + This is computed by summing all events with the types + CASH_TENDER_PAYMENT and + + CASH_TENDER_CANCELED_PAYMENT. The amount is always greater than or + equal to + + zero. + cash_refunds_money: + type: optional + docs: >- + The amount of money removed from the cash drawer from cash refunds. + + It is computed by summing the events of type CASH_TENDER_REFUND. The + amount + + is always greater than or equal to zero. + cash_paid_in_money: + type: optional + docs: >- + The amount of money added to the cash drawer for reasons other than + cash + + payments. It is computed by summing the events of type PAID_IN. The + amount is + + always greater than or equal to zero. + cash_paid_out_money: + type: optional + docs: >- + The amount of money removed from the cash drawer for reasons other + than + + cash refunds. It is computed by summing the events of type PAID_OUT. + The amount + + is always greater than or equal to zero. + expected_cash_money: + type: optional + docs: >- + The amount of money that should be in the cash drawer at the end of + the + + shift, based on the shift's other money amounts. + + This can be negative if employees have not correctly recorded all the + events + + on the cash drawer. + + cash_paid_out_money is a summation of amounts from cash_payment_money + (zero + + or positive), cash_refunds_money (zero or negative), + cash_paid_in_money (zero + + or positive), and cash_paid_out_money (zero or negative) event types. + closed_cash_money: + type: optional + docs: |- + The amount of money found in the cash drawer at the end of the shift + by an auditing employee. The amount should be positive. + device: + type: optional + docs: >- + The device running Square Point of Sale that was connected to the cash + drawer. + created_at: + type: optional + docs: The shift start time in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The shift updated at time in RFC 3339 format. + access: read-only + location_id: + type: optional + docs: The ID of the location the cash drawer shift belongs to. + access: read-only + team_member_ids: + type: optional> + docs: >- + The IDs of all team members that were logged into Square Point of Sale + at any + + point while the cash drawer shift was open. + access: read-only + opening_team_member_id: + type: optional + docs: The ID of the team member that started the cash drawer shift. + access: read-only + ending_team_member_id: + type: optional + docs: The ID of the team member that ended the cash drawer shift. + access: read-only + closing_team_member_id: + type: optional + docs: >- + The ID of the team member that closed the cash drawer shift by + auditing + + the cash drawer contents. + access: read-only + source: + openapi: openapi/openapi.json + CashDrawerShiftEvent: + properties: + id: + type: optional + docs: The unique ID of the event. + event_type: + type: optional + docs: >- + The type of cash drawer shift event. + + See [CashDrawerEventType](#type-cashdrawereventtype) for possible + values + event_money: + type: optional + docs: >- + The amount of money that was added to or removed from the cash drawer + + in the event. The amount can be positive (for added money) + + or zero (for other tender type payments). The addition or removal of + money can be determined by + + by the event type. + created_at: + type: optional + docs: The event time in RFC 3339 format. + access: read-only + description: + type: optional> + docs: |- + An optional description of the event, entered by the employee that + created the event. + team_member_id: + type: optional + docs: The ID of the team member that created the event. + access: read-only + source: + openapi: openapi/openapi.json + CashDrawerShiftState: + enum: + - OPEN + - ENDED + - CLOSED + docs: The current state of a cash drawer shift. + source: + openapi: openapi/openapi.json + CashDrawerShiftSummary: + docs: >- + The summary of a closed cash drawer shift. + + This model contains only the money counted to start a cash drawer shift, + counted + + at the end of the shift, and the amount that should be in the drawer at + shift + + end based on summing all cash drawer shift events. + properties: + id: + type: optional + docs: The shift unique ID. + state: + type: optional + docs: >- + The shift current state. + + See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible + values + opened_at: + type: optional> + docs: The shift start time in ISO 8601 format. + ended_at: + type: optional> + docs: The shift end time in ISO 8601 format. + closed_at: + type: optional> + docs: The shift close time in ISO 8601 format. + description: + type: optional> + docs: An employee free-text description of a cash drawer shift. + opened_cash_money: + type: optional + docs: |- + The amount of money in the cash drawer at the start of the shift. This + must be a positive amount. + expected_cash_money: + type: optional + docs: >- + The amount of money that should be in the cash drawer at the end of + the + + shift, based on the cash drawer events on the shift. + + The amount is correct if all shift employees accurately recorded their + + cash drawer shift events. Unrecorded events and events with the wrong + amount + + result in an incorrect expected_cash_money amount that can be + negative. + closed_cash_money: + type: optional + docs: >- + The amount of money found in the cash drawer at the end of the shift + by + + an auditing employee. The amount must be greater than or equal to + zero. + created_at: + type: optional + docs: The shift start time in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The shift updated at time in RFC 3339 format. + access: read-only + location_id: + type: optional + docs: The ID of the location the cash drawer shift belongs to. + access: read-only + source: + openapi: openapi/openapi.json + CashPaymentDetails: + docs: >- + Stores details about a cash payment. Contains only non-confidential + information. For more information, see + + [Take Cash + Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments). + properties: + buyer_supplied_money: + type: Money + docs: The amount and currency of the money supplied by the buyer. + change_back_money: + type: optional + docs: |- + The amount of change due back to the buyer. + This read-only field is calculated + from the `amount_money` and `buyer_supplied_money` fields. + source: + openapi: openapi/openapi.json + CatalogAvailabilityPeriod: + docs: Represents a time period of availability. + properties: + start_local_time: + type: optional> + docs: >- + The start time of an availability period, specified in local time + using partial-time + + RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 + in the morning. + + Note that the seconds value is always :00, but it is appended for + conformance to the RFC. + end_local_time: + type: optional> + docs: >- + The end time of an availability period, specified in local time using + partial-time + + RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 + in the evening. + + Note that the seconds value is always :00, but it is appended for + conformance to the RFC. + day_of_week: + type: optional + docs: |- + The day of the week for this availability period. + See [DayOfWeek](#type-dayofweek) for possible values + source: + openapi: openapi/openapi.json + CatalogCategory: + docs: A category to which a `CatalogItem` instance belongs. + properties: + name: + type: optional> + docs: >- + The category name. This is a searchable attribute for use in + applicable query filters, and its value length is of Unicode code + points. + validation: + maxLength: 255 + image_ids: + type: optional>> + docs: >- + The IDs of images associated with this `CatalogCategory` instance. + + Currently these images are not displayed by Square, but are free to be + displayed in 3rd party applications. + category_type: + type: optional + docs: >- + The type of the category. + + See [CatalogCategoryType](#type-catalogcategorytype) for possible + values + parent_category: + type: optional + docs: The ID of the parent category of this category instance. + is_top_level: + type: optional> + docs: >- + Indicates whether a category is a top level category, which does not + have any parent_category. + channels: + type: optional>> + docs: >- + A list of IDs representing channels, such as a Square Online site, + where the category can be made visible. + availability_period_ids: + type: optional>> + docs: >- + The IDs of the `CatalogAvailabilityPeriod` objects associated with the + category. + online_visibility: + type: optional> + docs: >- + Indicates whether the category is visible (`true`) or hidden (`false`) + on all of the seller's Square Online sites. + root_category: + type: optional + docs: The top-level category in a category hierarchy. + access: read-only + ecom_seo_data: + type: optional + docs: The SEO data for a seller's Square Online store. + path_to_root: + type: optional>> + docs: >- + The path from the category to its root category. The first node of the + path is the parent of the category + + and the last is the root category. The path is empty if the category + is a root category. + source: + openapi: openapi/openapi.json + CatalogCategoryType: + enum: + - REGULAR_CATEGORY + - MENU_CATEGORY + - KITCHEN_CATEGORY + docs: Indicates the type of a category. + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinition: + docs: >- + Contains information defining a custom attribute. Custom attributes are + + intended to store additional information about a catalog object or to + associate a + + catalog object with an entity in another system. Do not use custom + attributes + + to store any sensitive information (personally identifiable information, + card details, etc.). + + [Read more about custom + attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes) + properties: + type: + type: CatalogCustomAttributeDefinitionType + docs: >- + The type of this custom attribute. Cannot be modified after creation. + + Required. + + See + [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) + for possible values + name: + type: string + docs: >2- + The name of this definition for API and seller-facing UI purposes. + The name must be unique within the (merchant, application) pair. + Required. + + May not be empty and may not exceed 255 characters. Can be modified + after creation. + validation: + minLength: 1 + maxLength: 255 + description: + type: optional> + docs: >- + Seller-oriented description of the meaning of this Custom Attribute, + + any constraints that the seller should observe, etc. May be displayed + as a tooltip in Square UIs. + validation: + maxLength: 255 + source_application: + type: optional + docs: |- + __Read only.__ Contains information about the application that + created this custom attribute definition. + allowed_object_types: + docs: >- + The set of `CatalogObject` types that this custom atttribute may be + applied to. + + Currently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, + and `CATEGORY` are allowed. At least one type must be included. + + See [CatalogObjectType](#type-catalogobjecttype) for possible values + type: list + seller_visibility: + type: optional + docs: >- + The visibility of a custom attribute in seller-facing UIs (including + Square Point + + of Sale applications and Square Dashboard). May be modified. + + See + [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) + for possible values + app_visibility: + type: optional + docs: >- + The visibility of a custom attribute to applications other than the + application + + that created the attribute. + + See + [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) + for possible values + string_config: + type: optional + docs: Optionally, populated when `type` = `STRING`, unset otherwise. + number_config: + type: optional + docs: Optionally, populated when `type` = `NUMBER`, unset otherwise. + selection_config: + type: optional + docs: Populated when `type` is set to `SELECTION`, unset otherwise. + custom_attribute_usage_count: + type: optional + docs: >- + The number of custom attributes that reference this + + custom attribute definition. Set by the server in response to a + ListCatalog + + request with `include_counts` set to `true`. If the actual count is + greater + + than 100, `custom_attribute_usage_count` will be set to `100`. + access: read-only + key: + type: optional> + docs: >- + The name of the desired custom attribute key that can be used to + access + + the custom attribute value on catalog objects. Cannot be modified + after the + + custom attribute definition has been created. + + Must be between 1 and 60 characters, and may only contain the + characters `[a-zA-Z0-9_-]`. + validation: + pattern: ^[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 60 + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionAppVisibility: + enum: + - APP_VISIBILITY_HIDDEN + - APP_VISIBILITY_READ_ONLY + - APP_VISIBILITY_READ_WRITE_VALUES + docs: >- + Defines the visibility of a custom attribute to applications other than + their + + creating application. + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionNumberConfig: + properties: + precision: + type: optional> + docs: |- + An integer between 0 and 5 that represents the maximum number of + positions allowed after the decimal in number custom attribute values + For example: + + - if the precision is 0, the quantity can be 1, 2, 3, etc. + - if the precision is 1, the quantity can be 0.1, 0.2, etc. + - if the precision is 2, the quantity can be 0.01, 0.12, etc. + + Default: 5 + validation: + max: 5 + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionSelectionConfig: + docs: >- + Configuration associated with `SELECTION`-type custom attribute + definitions. + properties: + max_allowed_selections: + type: optional> + docs: >- + The maximum number of selections that can be set. The maximum value + for this + + attribute is 100. The default value is 1. The value can be modified, + but changing the value will not + + affect existing custom attribute values on objects. Clients need to + + handle custom attributes with more selected values than allowed by + this limit. + validation: + max: 100 + allowed_selections: + type: >- + optional>> + docs: >- + The set of valid `CatalogCustomAttributeSelections`. Up to a maximum + of 100 + + selections can be defined. Can be modified. + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection: + docs: A named selection for this `SELECTION`-type custom attribute definition. + properties: + uid: + type: optional> + docs: Unique ID set by Square. + name: + type: string + docs: Selection name, unique within `allowed_selections`. + validation: + minLength: 1 + maxLength: 255 + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionSellerVisibility: + enum: + - SELLER_VISIBILITY_HIDDEN + - SELLER_VISIBILITY_READ_WRITE_VALUES + docs: |- + Defines the visibility of a custom attribute to sellers in Square + client applications, Square APIs or in Square UIs (including Square Point + of Sale applications and Square Dashboard). + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionStringConfig: + docs: >- + Configuration associated with Custom Attribute Definitions of type + `STRING`. + properties: + enforce_uniqueness: + type: optional> + docs: >- + If true, each Custom Attribute instance associated with this Custom + Attribute + + Definition must have a unique value within the seller's catalog. For + + example, this may be used for a value like a SKU that should not be + + duplicated within a seller's catalog. May not be modified after the + + definition has been created. + source: + openapi: openapi/openapi.json + CatalogCustomAttributeDefinitionType: + enum: + - STRING + - BOOLEAN + - NUMBER + - SELECTION + docs: Defines the possible types for a custom attribute. + source: + openapi: openapi/openapi.json + CatalogCustomAttributeValue: + docs: >- + An instance of a custom attribute. Custom attributes can be defined and + + added to `ITEM` and `ITEM_VARIATION` type catalog objects. + + [Read more about custom + attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes). + properties: + name: + type: optional> + docs: The name of the custom attribute. + string_value: + type: optional> + docs: >- + The string value of the custom attribute. Populated if `type` = + `STRING`. + custom_attribute_definition_id: + type: optional + docs: >- + The id of the + [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + this value belongs to. + access: read-only + type: + type: optional + docs: >- + A copy of type from the associated `CatalogCustomAttributeDefinition`. + + See + [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) + for possible values + number_value: + type: optional> + docs: >- + Populated if `type` = `NUMBER`. Contains a string + + representation of a decimal number, using a `.` as the decimal + separator. + boolean_value: + type: optional> + docs: A `true` or `false` value. Populated if `type` = `BOOLEAN`. + selection_uid_values: + type: optional>> + docs: >- + One or more choices from `allowed_selections`. Populated if `type` = + `SELECTION`. + key: + type: optional + docs: >- + If the associated `CatalogCustomAttributeDefinition` object is defined + by another application, this key is prefixed by the defining + application ID. + + For example, if the CatalogCustomAttributeDefinition has a key + attribute of "cocoa_brand" and the defining application ID is + "abcd1234", this key is "abcd1234:cocoa_brand" + + when the application making the request is different from the + application defining the custom attribute definition. Otherwise, the + key is simply "cocoa_brand". + access: read-only + source: + openapi: openapi/openapi.json + CatalogDiscount: + docs: A discount applicable to items. + properties: + name: + type: optional> + docs: >- + The discount name. This is a searchable attribute for use in + applicable query filters, and its value length is of Unicode code + points. + validation: + maxLength: 255 + discount_type: + type: optional + docs: >- + Indicates whether the discount is a fixed amount or percentage, or + entered at the time of sale. + + See [CatalogDiscountType](#type-catalogdiscounttype) for possible + values + percentage: + type: optional> + docs: >- + The percentage of the discount as a string representation of a decimal + number, using a `.` as the decimal + + separator and without a `%` sign. A value of `7.5` corresponds to + `7.5%`. Specify a percentage of `0` if `discount_type` + + is `VARIABLE_PERCENTAGE`. + + + Do not use this field for amount-based or variable discounts. + amount_money: + type: optional + docs: >- + The amount of the discount. Specify an amount of `0` if + `discount_type` is `VARIABLE_AMOUNT`. + + + Do not use this field for percentage-based or variable discounts. + pin_required: + type: optional> + docs: >- + Indicates whether a mobile staff member needs to enter their PIN to + apply the + + discount to a payment in the Square Point of Sale app. + label_color: + type: optional> + docs: >- + The color of the discount display label in the Square Point of Sale + app. This must be a valid hex color code. + modify_tax_basis: + type: optional + docs: >- + Indicates whether this discount should reduce the price used to + calculate tax. + + + Most discounts should use `MODIFY_TAX_BASIS`. However, in some + circumstances taxes must + + be calculated based on an item's price, ignoring a particular + discount. For example, + + in many US jurisdictions, a manufacturer coupon or instant rebate + reduces the price a + + customer pays but does not reduce the sale price used to calculate how + much sales tax is + + due. In this case, the discount representing that manufacturer coupon + should have + + `DO_NOT_MODIFY_TAX_BASIS` for this field. + + + If you are unsure whether you need to use this field, consult your tax + professional. + + See + [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) + for possible values + maximum_amount_money: + type: optional + docs: >- + For a percentage discount, the maximum absolute value of the discount. + For example, if a + + 50% discount has a `maximum_amount_money` of $20, a $100 purchase will + yield a $20 discount, + + not a $50 discount. + source: + openapi: openapi/openapi.json + CatalogDiscountModifyTaxBasis: + enum: + - MODIFY_TAX_BASIS + - DO_NOT_MODIFY_TAX_BASIS + source: + openapi: openapi/openapi.json + CatalogDiscountType: + enum: + - FIXED_PERCENTAGE + - FIXED_AMOUNT + - VARIABLE_PERCENTAGE + - VARIABLE_AMOUNT + docs: How to apply a CatalogDiscount to a CatalogItem. + source: + openapi: openapi/openapi.json + CatalogEcomSeoData: + docs: SEO data for for a seller's Square Online store. + properties: + page_title: + type: optional> + docs: The SEO title used for the Square Online store. + page_description: + type: optional> + docs: The SEO description used for the Square Online store. + permalink: + type: optional> + docs: The SEO permalink used for the Square Online store. + source: + openapi: openapi/openapi.json + CatalogIdMapping: + docs: >- + A mapping between a temporary client-supplied ID and a permanent + server-generated ID. + + + When calling + [UpsertCatalogObject](api-endpoint:Catalog-UpsertCatalogObject) or + + [BatchUpsertCatalogObjects](api-endpoint:Catalog-BatchUpsertCatalogObjects) + to + + create a [CatalogObject](entity:CatalogObject) instance, you can supply + + a temporary ID for the to-be-created object, especially when the object is + to be referenced + + elsewhere in the same request body. This temporary ID can be any string + unique within + + the call, but must be prefixed by "#". + + + After the request is submitted and the object created, a permanent + server-generated ID is assigned + + to the new object. The permanent ID is unique across the Square catalog. + properties: + client_object_id: + type: optional> + docs: >- + The client-supplied temporary `#`-prefixed ID for a new + `CatalogObject`. + object_id: + type: optional> + docs: The permanent ID for the CatalogObject created by the server. + source: + openapi: openapi/openapi.json + CatalogImage: + docs: >- + An image file to use in Square catalogs. It can be associated with + + `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and + `CatalogModifierList` objects. + + Only the images on items and item variations are exposed in Dashboard. + + Only the first image on an item is displayed in Square Point of Sale + (SPOS). + + Images on items and variations are displayed through Square Online Store. + + Images on other object types are for use by 3rd party application + developers. + properties: + name: + type: optional> + docs: >- + The internal name to identify this image in calls to the Square API. + + This is a searchable attribute for use in applicable query filters + + using the + [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + + It is not unique and should not be shown in a buyer facing context. + url: + type: optional> + docs: >- + The URL of this image, generated by Square after an image is uploaded + + using the + [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) + endpoint. + + To modify the image, use the UpdateCatalogImage endpoint. Do not + change the URL field. + caption: + type: optional> + docs: >- + A caption that describes what is shown in the image. Displayed in the + + Square Online Store. This is a searchable attribute for use in + applicable query filters + + using the + [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + photo_studio_order_id: + type: optional> + docs: >- + The immutable order ID for this image object created by the Photo + Studio service in Square Online Store. + source: + openapi: openapi/openapi.json + CatalogInfoResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + limits: + type: optional + docs: Limits that apply to this API. + standard_unit_description_group: + type: optional + docs: Names and abbreviations for standard units. + source: + openapi: openapi/openapi.json + CatalogInfoResponseLimits: + properties: + batch_upsert_max_objects_per_batch: + type: optional> + docs: >- + The maximum number of objects that may appear within a single batch in + a + + `/v2/catalog/batch-upsert` request. + batch_upsert_max_total_objects: + type: optional> + docs: |- + The maximum number of objects that may appear across all batches in a + `/v2/catalog/batch-upsert` request. + batch_retrieve_max_object_ids: + type: optional> + docs: >- + The maximum number of object IDs that may appear in a + `/v2/catalog/batch-retrieve` + + request. + search_max_page_limit: + type: optional> + docs: |- + The maximum number of results that may be returned in a page of a + `/v2/catalog/search` response. + batch_delete_max_object_ids: + type: optional> + docs: |- + The maximum number of object IDs that may be included in a single + `/v2/catalog/batch-delete` request. + update_item_taxes_max_item_ids: + type: optional> + docs: |- + The maximum number of item IDs that may be included in a single + `/v2/catalog/update-item-taxes` request. + update_item_taxes_max_taxes_to_enable: + type: optional> + docs: >- + The maximum number of tax IDs to be enabled that may be included in a + single + + `/v2/catalog/update-item-taxes` request. + update_item_taxes_max_taxes_to_disable: + type: optional> + docs: >- + The maximum number of tax IDs to be disabled that may be included in a + single + + `/v2/catalog/update-item-taxes` request. + update_item_modifier_lists_max_item_ids: + type: optional> + docs: |- + The maximum number of item IDs that may be included in a single + `/v2/catalog/update-item-modifier-lists` request. + update_item_modifier_lists_max_modifier_lists_to_enable: + type: optional> + docs: >- + The maximum number of modifier list IDs to be enabled that may be + included in + + a single `/v2/catalog/update-item-modifier-lists` request. + update_item_modifier_lists_max_modifier_lists_to_disable: + type: optional> + docs: >- + The maximum number of modifier list IDs to be disabled that may be + included in + + a single `/v2/catalog/update-item-modifier-lists` request. + source: + openapi: openapi/openapi.json + CatalogItem: + docs: >- + A [CatalogObject](entity:CatalogObject) instance of the `ITEM` type, also + referred to as an item, in the catalog. + properties: + name: + type: optional> + docs: >- + The item's name. This is a searchable attribute for use in applicable + query filters, its value must not be empty, and the length is of + Unicode code points. + validation: + maxLength: 512 + description: + type: optional> + docs: >- + The item's description. This is a searchable attribute for use in + applicable query filters, and its value length is of Unicode code + points. + + + Deprecated at 2022-07-20, this field is planned to retire in 6 months. + You should migrate to use `description_html` to set the description + + of the [CatalogItem](entity:CatalogItem) instance. The `description` + and `description_html` field values are kept in sync. If you try to + + set the both fields, the `description_html` text value overwrites the + `description` value. Updates in one field are also reflected in the + other, + + except for when you use an early version before Square API 2022-07-20 + and `description_html` is set to blank, setting the `description` + value to null + + does not nullify `description_html`. + validation: + maxLength: 4096 + abbreviation: + type: optional> + docs: >- + The text of the item's display label in the Square Point of Sale app. + Only up to the first five characters of the string are used. + + This attribute is searchable, and its value length is of Unicode code + points. + validation: + maxLength: 24 + label_color: + type: optional> + docs: >- + The color of the item's display label in the Square Point of Sale app. + This must be a valid hex color code. + is_taxable: + type: optional> + docs: >- + Indicates whether the item is taxable (`true`) or non-taxable + (`false`). Default is `true`. + category_id: + type: optional> + docs: >- + The ID of the item's category, if any. Deprecated since 2023-12-13. + Use `CatalogItem.categories`, instead. + tax_ids: + type: optional>> + docs: >- + A set of IDs indicating the taxes enabled for + + this item. When updating an item, any taxes listed here will be added + to the item. + + Taxes may also be added to or deleted from an item using + `UpdateItemTaxes`. + modifier_list_info: + type: optional>> + docs: >- + A set of `CatalogItemModifierListInfo` objects + + representing the modifier lists that apply to this item, along with + the overrides and min + + and max limits that are specific to this item. Modifier lists + + may also be added to or deleted from an item using + `UpdateItemModifierLists`. + variations: + type: optional>> + docs: >- + A list of [CatalogItemVariation](entity:CatalogItemVariation) objects + for this item. An item must have + + at least one variation. + product_type: + type: optional + docs: >- + The product type of the item. Once set, the `product_type` value + cannot be modified. + + + Items of the `LEGACY_SQUARE_ONLINE_SERVICE` and + `LEGACY_SQUARE_ONLINE_MEMBERSHIP` product types can be updated + + but cannot be created using the API. + + See [CatalogItemProductType](#type-catalogitemproducttype) for + possible values + skip_modifier_screen: + type: optional> + docs: >- + If `false`, the Square Point of Sale app will present the + `CatalogItem`'s + + details screen immediately, allowing the merchant to choose + `CatalogModifier`s + + before adding the item to the cart. This is the default behavior. + + + If `true`, the Square Point of Sale app will immediately add the item + to the cart with the pre-selected + + modifiers, and merchants can edit modifiers by drilling down onto the + item's details. + + + Third-party clients are encouraged to implement similar behaviors. + item_options: + type: optional>> + docs: |- + List of item options IDs for this item. Used to manage and group item + variations in a specified order. + + Maximum: 6 item options. + ecom_uri: + type: optional> + docs: >- + Deprecated; see go/ecomUriUseCases. A URI pointing to a published + e-commerce product page for the Item. + ecom_image_uris: + type: optional>> + docs: >- + Deprecated; see go/ecomUriUseCases. A comma-separated list of encoded + URIs pointing to a set of published e-commerce images for the Item. + image_ids: + type: optional>> + docs: |- + The IDs of images associated with this `CatalogItem` instance. + These images will be shown to customers in Square Online Store. + The first image will show up as the icon for this item in POS. + sort_name: + type: optional> + docs: >- + A name to sort the item by. If this name is unspecified, namely, the + `sort_name` field is absent, the regular `name` field is used for + sorting. + + Its value must not be empty. + + + It is currently supported for sellers of the Japanese locale only. + categories: + type: optional>> + docs: The list of categories. + description_html: + type: optional> + docs: >- + The item's description as expressed in valid HTML elements. The length + of this field value, including those of HTML tags, + + is of Unicode points. With application query filters, the text values + of the HTML elements and attributes are searchable. Invalid or + + unsupported HTML elements or attributes are ignored. + + + Supported HTML elements include: + + - `a`: Link. Supports linking to website URLs, email address, and + telephone numbers. + + - `b`, `strong`: Bold text + + - `br`: Line break + + - `code`: Computer code + + - `div`: Section + + - `h1-h6`: Headings + + - `i`, `em`: Italics + + - `li`: List element + + - `ol`: Numbered list + + - `p`: Paragraph + + - `ul`: Bullet list + + - `u`: Underline + + + + Supported HTML attributes include: + + - `align`: Alignment of the text content + + - `href`: Link destination + + - `rel`: Relationship between link's target and source + + - `target`: Place to open the linked document + validation: + maxLength: 65535 + description_plaintext: + type: optional + docs: >- + A server-generated plaintext version of the `description_html` field, + without formatting tags. + validation: + maxLength: 65535 + access: read-only + channels: + type: optional>> + docs: >- + A list of IDs representing channels, such as a Square Online site, + where the item can be made visible or available. + + This field is read only and cannot be edited. + is_archived: + type: optional> + docs: Indicates whether this item is archived (`true`) or not (`false`). + ecom_seo_data: + type: optional + docs: The SEO data for a seller's Square Online store. + food_and_beverage_details: + type: optional + docs: The food and beverage-specific details for the `FOOD_AND_BEV` item. + reporting_category: + type: optional + docs: The item's reporting category. + is_alcoholic: + type: optional> + docs: Indicates whether this item is alcoholic (`true`) or not (`false`). + source: + openapi: openapi/openapi.json + CatalogItemFoodAndBeverageDetails: + docs: The food and beverage-specific details of a `FOOD_AND_BEV` item. + properties: + calorie_count: + type: optional> + docs: >- + The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of + items. + dietary_preferences: + type: >- + optional>> + docs: The dietary preferences for the `FOOD_AND_BEV` item. + ingredients: + type: optional>> + docs: The ingredients for the `FOOD_AND_BEV` type item. + source: + openapi: openapi/openapi.json + CatalogItemFoodAndBeverageDetailsDietaryPreference: + docs: >- + Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its + ingredients. + properties: + type: + type: optional + docs: >- + The dietary preference type. Supported values include `STANDARD` and + `CUSTOM` as specified in + `FoodAndBeverageDetails.DietaryPreferenceType`. + + See [DietaryPreferenceType](#type-dietarypreferencetype) for possible + values + standard_name: + type: >- + optional + docs: >- + The name of the dietary preference from a standard pre-defined list. + This should be null if it's a custom dietary preference. + + See [StandardDietaryPreference](#type-standarddietarypreference) for + possible values + custom_name: + type: optional> + docs: >- + The name of a user-defined custom dietary preference. This should be + null if it's a standard dietary preference. + source: + openapi: openapi/openapi.json + CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference: + enum: + - DAIRY_FREE + - GLUTEN_FREE + - HALAL + - KOSHER + - NUT_FREE + - VEGAN + - VEGETARIAN + docs: >- + Standard dietary preferences for food and beverage items that are + recommended on item creation. + source: + openapi: openapi/openapi.json + CatalogItemFoodAndBeverageDetailsDietaryPreferenceType: + enum: + - STANDARD + - CUSTOM + docs: >- + The type of dietary preference for the `FOOD_AND_BEV` type of items and + integredients. + source: + openapi: openapi/openapi.json + CatalogItemFoodAndBeverageDetailsIngredient: + docs: Describes the ingredient used in a `FOOD_AND_BEV` item. + properties: + type: + type: optional + docs: >- + The dietary preference type of the ingredient. Supported values + include `STANDARD` and `CUSTOM` as specified in + `FoodAndBeverageDetails.DietaryPreferenceType`. + + See [DietaryPreferenceType](#type-dietarypreferencetype) for possible + values + standard_name: + type: >- + optional + docs: >- + The name of the ingredient from a standard pre-defined list. This + should be null if it's a custom dietary preference. + + See [StandardIngredient](#type-standardingredient) for possible values + custom_name: + type: optional> + docs: >- + The name of a custom user-defined ingredient. This should be null if + it's a standard dietary preference. + source: + openapi: openapi/openapi.json + CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient: + enum: + - CELERY + - CRUSTACEANS + - EGGS + - FISH + - GLUTEN + - LUPIN + - MILK + - MOLLUSCS + - MUSTARD + - PEANUTS + - SESAME + - SOY + - SULPHITES + - TREE_NUTS + docs: >- + Standard ingredients for food and beverage items that are recommended on + item creation. + source: + openapi: openapi/openapi.json + CatalogItemModifierListInfo: + docs: >- + References a text-based modifier or a list of non text-based modifiers + applied to a `CatalogItem` instance + + and specifies supported behaviors of the application. + properties: + modifier_list_id: + type: string + docs: >- + The ID of the `CatalogModifierList` controlled by this + `CatalogModifierListInfo`. + validation: + minLength: 1 + modifier_overrides: + type: optional>> + docs: >- + A set of `CatalogModifierOverride` objects that override whether a + given `CatalogModifier` is enabled by default. + min_selected_modifiers: + type: optional> + docs: >- + If 0 or larger, the smallest number of `CatalogModifier`s that must be + selected from this `CatalogModifierList`. + + The default value is `-1`. + + + When `CatalogModifierList.selection_type` is `MULTIPLE`, + `CatalogModifierListInfo.min_selected_modifiers=-1` + + and `CatalogModifierListInfo.max_selected_modifier=-1` means that from + zero to the maximum number of modifiers of + + the `CatalogModifierList` can be selected from the + `CatalogModifierList`. + + + When the `CatalogModifierList.selection_type` is `SINGLE`, + `CatalogModifierListInfo.min_selected_modifiers=-1` + + and `CatalogModifierListInfo.max_selected_modifier=-1` means that + exactly one modifier must be present in + + and can be selected from the `CatalogModifierList` + max_selected_modifiers: + type: optional> + docs: >- + If 0 or larger, the largest number of `CatalogModifier`s that can be + selected from this `CatalogModifierList`. + + The default value is `-1`. + + + When `CatalogModifierList.selection_type` is `MULTIPLE`, + `CatalogModifierListInfo.min_selected_modifiers=-1` + + and `CatalogModifierListInfo.max_selected_modifier=-1` means that from + zero to the maximum number of modifiers of + + the `CatalogModifierList` can be selected from the + `CatalogModifierList`. + + + When the `CatalogModifierList.selection_type` is `SINGLE`, + `CatalogModifierListInfo.min_selected_modifiers=-1` + + and `CatalogModifierListInfo.max_selected_modifier=-1` means that + exactly one modifier must be present in + + and can be selected from the `CatalogModifierList` + enabled: + type: optional> + docs: >- + If `true`, enable this `CatalogModifierList`. The default value is + `true`. + ordinal: + type: optional> + docs: >- + The position of this `CatalogItemModifierListInfo` object within the + `modifier_list_info` list applied + + to a `CatalogItem` instance. + source: + openapi: openapi/openapi.json + CatalogItemOption: + docs: A group of variations for a `CatalogItem`. + properties: + name: + type: optional> + docs: >- + The item option's display name for the seller. Must be unique across + + all item options. This is a searchable attribute for use in applicable + query filters. + display_name: + type: optional> + docs: >- + The item option's display name for the customer. This is a searchable + attribute for use in applicable query filters. + description: + type: optional> + docs: >- + The item option's human-readable description. Displayed in the Square + + Point of Sale app for the seller and in the Online Store or on + receipts for + + the buyer. This is a searchable attribute for use in applicable query + filters. + show_colors: + type: optional> + docs: If true, display colors for entries in `values` when present. + values: + type: optional>> + docs: |- + A list of CatalogObjects containing the + `CatalogItemOptionValue`s for this item. + source: + openapi: openapi/openapi.json + CatalogItemOptionForItem: + docs: |2- + An option that can be assigned to an item. + For example, a t-shirt item may offer a color option or a size option. + properties: + item_option_id: + type: optional> + docs: >- + The unique id of the item option, used to form the dimensions of the + item option matrix in a specified order. + source: + openapi: openapi/openapi.json + CatalogItemOptionValue: + docs: |- + An enumerated value that can link a + `CatalogItemVariation` to an item option as one of + its item option values. + properties: + item_option_id: + type: optional> + docs: Unique ID of the associated item option. + name: + type: optional> + docs: >- + Name of this item option value. This is a searchable attribute for use + in applicable query filters. + description: + type: optional> + docs: >- + A human-readable description for the option value. This is a + searchable attribute for use in applicable query filters. + color: + type: optional> + docs: >- + The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). + + Only displayed if `show_colors` is enabled on the parent `ItemOption`. + When + + left unset, `color` defaults to white ("#ffffff") when `show_colors` + is + + enabled on the parent `ItemOption`. + ordinal: + type: optional> + docs: Determines where this option value appears in a list of option values. + source: + openapi: openapi/openapi.json + CatalogItemOptionValueForItemVariation: + docs: >- + A `CatalogItemOptionValue` links an item variation to an item option as + + an item option value. For example, a t-shirt item may offer a color option + and + + a size option. An item option value would represent each variation of + t-shirt: + + For example, "Color:Red, Size:Small" or "Color:Blue, Size:Medium". + properties: + item_option_id: + type: optional> + docs: The unique id of an item option. + item_option_value_id: + type: optional> + docs: The unique id of the selected value for the item option. + source: + openapi: openapi/openapi.json + CatalogItemProductType: + enum: + - REGULAR + - GIFT_CARD + - APPOINTMENTS_SERVICE + - FOOD_AND_BEV + - EVENT + - DIGITAL + - DONATION + - LEGACY_SQUARE_ONLINE_SERVICE + - LEGACY_SQUARE_ONLINE_MEMBERSHIP + docs: >- + The type of a CatalogItem. Connect V2 only allows the creation of + `REGULAR` or `APPOINTMENTS_SERVICE` items. + source: + openapi: openapi/openapi.json + CatalogItemVariation: + docs: >- + An item variation, representing a product for sale, in the Catalog object + model. Each [item](entity:CatalogItem) must have at least one + + item variation and can have at most 250 item variations. + + + An item variation can be sellable, stockable, or both if it has a unit of + measure for its count for the sold number of the variation, the stocked + + number of the variation, or both. For example, when a variation + representing wine is stocked and sold by the bottle, the variation is both + + stockable and sellable. But when a variation of the wine is sold by the + glass, the sold units cannot be used as a measure of the stocked units. + This by-the-glass + + variation is sellable, but not stockable. To accurately keep track of the + wine's inventory count at any time, the sellable count must be + + converted to stockable count. Typically, the seller defines this unit + conversion. For example, 1 bottle equals 5 glasses. The Square API exposes + + the `stockable_conversion` property on the variation to specify the + conversion. Thus, when two glasses of the wine are sold, the sellable + count + + decreases by 2, and the stockable count automatically decreases by 0.4 + bottle according to the conversion. + properties: + item_id: + type: optional> + docs: The ID of the `CatalogItem` associated with this item variation. + name: + type: optional> + docs: >- + The item variation's name. This is a searchable attribute for use in + applicable query filters. + + + Its value has a maximum length of 255 Unicode code points. However, + when the parent [item](entity:CatalogItem) + + uses [item options](entity:CatalogItemOption), this attribute is + auto-generated, read-only, and can be + + longer than 255 Unicode code points. + sku: + type: optional> + docs: >- + The item variation's SKU, if any. This is a searchable attribute for + use in applicable query filters. + upc: + type: optional> + docs: >- + The universal product code (UPC) of the item variation, if any. This + is a searchable attribute for use in applicable query filters. + + + The value of this attribute should be a number of 12-14 digits long. + This restriction is enforced on the Square Seller Dashboard, + + Square Point of Sale or Retail Point of Sale apps, where this + attribute shows in the GTIN field. If a non-compliant UPC value is + assigned + + to this attribute using the API, the value is not editable on the + Seller Dashboard, Square Point of Sale or Retail Point of Sale apps + + unless it is updated to fit the expected format. + ordinal: + type: optional + docs: >- + The order in which this item variation should be displayed. This value + is read-only. On writes, the ordinal + + for each item variation within a parent `CatalogItem` is set according + to the item variations's + + position. On reads, the value is not guaranteed to be sequential or + unique. + access: read-only + pricing_type: + type: optional + docs: >- + Indicates whether the item variation's price is fixed or determined at + the time + + of sale. + + See [CatalogPricingType](#type-catalogpricingtype) for possible values + price_money: + type: optional + docs: The item variation's price, if fixed pricing is used. + location_overrides: + type: optional>> + docs: Per-location price and inventory overrides. + track_inventory: + type: optional> + docs: If `true`, inventory tracking is active for the variation. + inventory_alert_type: + type: optional + docs: >- + Indicates whether the item variation displays an alert when its + inventory quantity is less than or equal + + to its `inventory_alert_threshold`. + + See [InventoryAlertType](#type-inventoryalerttype) for possible values + inventory_alert_threshold: + type: optional> + docs: >- + If the inventory quantity for the variation is less than or equal to + this value and `inventory_alert_type` + + is `LOW_QUANTITY`, the variation displays an alert in the merchant + dashboard. + + + This value is always an integer. + user_data: + type: optional> + docs: >- + Arbitrary user metadata to associate with the item variation. This + attribute value length is of Unicode code points. + validation: + maxLength: 255 + service_duration: + type: optional> + docs: >- + If the `CatalogItem` that owns this item variation is of type + + `APPOINTMENTS_SERVICE`, then this is the duration of the service in + milliseconds. For + + example, a 30 minute appointment would have the value `1800000`, which + is equal to + + 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per + second). + available_for_booking: + type: optional> + docs: >- + If the `CatalogItem` that owns this item variation is of type + + `APPOINTMENTS_SERVICE`, a bool representing whether this service is + available for booking. + item_option_values: + type: optional>> + docs: |- + List of item option values associated with this item variation. Listed + in the same order as the item options of the parent item. + measurement_unit_id: + type: optional> + docs: >- + ID of the ‘CatalogMeasurementUnit’ that is used to measure the + quantity + + sold of this item variation. If left unset, the item will be sold in + + whole quantities. + sellable: + type: optional> + docs: >- + Whether this variation can be sold. The inventory count of a sellable + variation indicates + + the number of units available for sale. When a variation is both + stockable and sellable, + + its sellable inventory count can be smaller than or equal to its + stockable count. + stockable: + type: optional> + docs: >- + Whether stock is counted directly on this variation (TRUE) or only on + its components (FALSE). + + When a variation is both stockable and sellable, the inventory count + of a stockable variation keeps track of the number of units of this + variation in stock + + and is not an indicator of the number of units of the variation that + can be sold. + image_ids: + type: optional>> + docs: >- + The IDs of images associated with this `CatalogItemVariation` + instance. + + These images will be shown to customers in Square Online Store. + team_member_ids: + type: optional>> + docs: >- + Tokens of employees that can perform the service represented by this + variation. Only valid for + + variations of type `APPOINTMENTS_SERVICE`. + stockable_conversion: + type: optional + docs: >- + The unit conversion rule, as prescribed by the + [CatalogStockConversion](entity:CatalogStockConversion) type, + + that describes how this non-stockable (i.e., sellable/receivable) item + variation is converted + + to/from the stockable item variation sharing the same parent item. + With the stock conversion, + + you can accurately track inventory when an item variation is sold in + one unit, but stocked in + + another unit. + source: + openapi: openapi/openapi.json + CatalogMeasurementUnit: + docs: |- + Represents the unit used to measure a `CatalogItemVariation` and + specifies the precision for decimal quantities. + properties: + measurement_unit: + type: optional + docs: >- + Indicates the unit used to measure the quantity of a catalog item + variation. + precision: + type: optional> + docs: >- + An integer between 0 and 5 that represents the maximum number of + + positions allowed after the decimal in quantities measured with this + unit. + + For example: + + + - if the precision is 0, the quantity can be 1, 2, 3, etc. + + - if the precision is 1, the quantity can be 0.1, 0.2, etc. + + - if the precision is 2, the quantity can be 0.01, 0.12, etc. + + + Default: 3 + source: + openapi: openapi/openapi.json + CatalogModifier: + docs: >- + A modifier applicable to items at the time of sale. An example of a + modifier is a Cheese add-on to a Burger item. + properties: + name: + type: optional> + docs: >- + The modifier name. This is a searchable attribute for use in + applicable query filters, and its value length is of Unicode code + points. + validation: + maxLength: 255 + price_money: + type: optional + docs: The modifier price. + ordinal: + type: optional> + docs: >- + Determines where this `CatalogModifier` appears in the + `CatalogModifierList`. + modifier_list_id: + type: optional> + docs: The ID of the `CatalogModifierList` associated with this modifier. + location_overrides: + type: optional>> + docs: Location-specific price overrides. + image_id: + type: optional> + docs: >- + The ID of the image associated with this `CatalogModifier` instance. + + Currently this image is not displayed by Square, but is free to be + displayed in 3rd party applications. + source: + openapi: openapi/openapi.json + CatalogModifierList: + docs: >- + For a text-based modifier, this encapsulates the modifier's text when its + `modifier_type` is `TEXT`. + + For example, to sell T-shirts with custom prints, a text-based modifier + can be used to capture the buyer-supplied + + text string to be selected for the T-shirt at the time of sale. + + + For non text-based modifiers, this encapsulates a non-empty list of + modifiers applicable to items + + at the time of sale. Each element of the modifier list is a + `CatalogObject` instance of the `MODIFIER` type. + + For example, a "Condiments" modifier list applicable to a "Hot Dog" item + + may contain "Ketchup", "Mustard", and "Relish" modifiers. + + + A non text-based modifier can be applied to the modified item once or + multiple times, if the `selection_type` field + + is set to `SINGLE` or `MULTIPLE`, respectively. On the other hand, a + text-based modifier can be applied to the item + + only once and the `selection_type` field is always set to `SINGLE`. + properties: + name: + type: optional> + docs: >- + The name of the `CatalogModifierList` instance. This is a searchable + attribute for use in applicable query filters, and its value length is + of + + Unicode code points. + validation: + maxLength: 255 + ordinal: + type: optional> + docs: >- + The position of this `CatalogModifierList` within a list of + `CatalogModifierList` instances. + selection_type: + type: optional + docs: >- + Indicates whether a single (`SINGLE`) or multiple (`MULTIPLE`) + modifiers from the list + + can be applied to a single `CatalogItem`. + + + For text-based modifiers, the `selection_type` attribute is always + `SINGLE`. The other value is ignored. + + See + [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) + for possible values + modifiers: + type: optional>> + docs: >- + A non-empty list of `CatalogModifier` objects to be included in the + `CatalogModifierList`, + + for non text-based modifiers when the `modifier_type` attribute is + `LIST`. Each element of this list + + is a `CatalogObject` instance of the `MODIFIER` type, containing the + following attributes: + + ``` + + { + + "id": "{{catalog_modifier_id}}", + + "type": "MODIFIER", + + "modifier_data": {{a CatalogModifier instance>}} + + } + + ``` + image_ids: + type: optional>> + docs: >- + The IDs of images associated with this `CatalogModifierList` instance. + + Currently these images are not displayed on Square products, but may + be displayed in 3rd-party applications. + modifier_type: + type: optional + docs: >- + The type of the modifier. + + + When this `modifier_type` value is `TEXT`, the `CatalogModifierList` + represents a text-based modifier. + + When this `modifier_type` value is `LIST`, the `CatalogModifierList` + contains a list of `CatalogModifier` objects. + + See + [CatalogModifierListModifierType](#type-catalogmodifierlistmodifiertype) + for possible values + max_length: + type: optional> + docs: >- + The maximum length, in Unicode points, of the text string of the + text-based modifier as represented by + + this `CatalogModifierList` object with the `modifier_type` set to + `TEXT`. + text_required: + type: optional> + docs: >- + Whether the text string must be a non-empty string (`true`) or not + (`false`) for a text-based modifier + + as represented by this `CatalogModifierList` object with the + `modifier_type` set to `TEXT`. + internal_name: + type: optional> + docs: >- + A note for internal use by the business. + + + For example, for a text-based modifier applied to a T-shirt item, if + the buyer-supplied text of "Hello, Kitty!" + + is to be printed on the T-shirt, this `internal_name` attribute can be + "Use italic face" as + + an instruction for the business to follow. + + + For non text-based modifiers, this `internal_name` attribute can be + + used to include SKUs, internal codes, or supplemental descriptions for + internal use. + validation: + maxLength: 512 + source: + openapi: openapi/openapi.json + CatalogModifierListModifierType: + enum: + - LIST + - TEXT + docs: Defines the type of `CatalogModifierList`. + source: + openapi: openapi/openapi.json + CatalogModifierListSelectionType: + enum: + - SINGLE + - MULTIPLE + docs: Indicates whether a CatalogModifierList supports multiple selections. + source: + openapi: openapi/openapi.json + CatalogModifierOverride: + docs: >- + Options to control how to override the default behavior of the specified + modifier. + properties: + modifier_id: + type: string + docs: >- + The ID of the `CatalogModifier` whose default behavior is being + overridden. + validation: + minLength: 1 + on_by_default: + type: optional> + docs: >- + If `true`, this `CatalogModifier` should be selected by default for + this `CatalogItem`. + source: + openapi: openapi/openapi.json + CatalogObject: + discriminated: false + docs: >- + The wrapper object for the catalog entries of a given object type. + + + Depending on the `type` attribute value, a `CatalogObject` instance + assumes a type-specific data to yield the corresponding type of catalog + object. + + + For example, if `type=ITEM`, the `CatalogObject` instance must have the + ITEM-specific data set on the `item_data` attribute. The resulting + `CatalogObject` instance is also a `CatalogItem` instance. + + + In general, if `type=`, the `CatalogObject` instance must + have the ``-specific data set on the `_data` + attribute. The resulting `CatalogObject` instance is also a + `Catalog` instance. + + + For a more detailed discussion of the Catalog data model, please see the + + [Design a + Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) + guide. + union: + - CatalogObjectItem + - CatalogObjectImage + - CatalogObjectCategory + - CatalogObjectItemVariation + - CatalogObjectTax + - CatalogObjectDiscount + - CatalogObjectModifierList + - CatalogObjectModifier + - CatalogObjectDiningOption + - CatalogObjectTaxExemption + - CatalogObjectServiceCharge + - CatalogObjectPricingRule + - CatalogObjectProductSet + - CatalogObjectTimePeriod + - CatalogObjectMeasurementUnit + - CatalogObjectSubscriptionPlan + - CatalogObjectItemOption + - CatalogObjectItemOptionValue + - CatalogObjectCustomAttributeDefinition + - CatalogObjectQuickAmountsSettings + - CatalogObjectComponent + - CatalogObjectComposition + - CatalogObjectResource + - CatalogObjectCheckoutLink + - CatalogObjectAddress + - CatalogObjectSubscriptionProduct + - CatalogObjectSubscriptionPlanVariation + - CatalogObjectAvailabilityPeriod + source: + openapi: openapi/openapi.json + CatalogObjectBatch: + docs: A batch of catalog objects. + properties: + objects: + docs: A list of CatalogObjects belonging to this batch. + type: list + source: + openapi: openapi/openapi.json + CatalogObjectCategory: + docs: >- + A category that can be assigned to an item or a parent category that can + be assigned + + to another category. For example, a clothing category can be assigned to a + t-shirt item or + + be made as the parent category to the pants category. + properties: + id: + type: optional + docs: The ID of the object's category. + ordinal: + type: optional> + docs: The order of the object within the context of the category. + category_data: + type: optional + docs: >- + Structured data for a `CatalogCategory`, set for CatalogObjects of + type `CATEGORY`. + type: + type: CatalogObjectType + docs: >- + The type of this object. Each object type has expected + + properties expressed in a structured format within its corresponding + `*_data` field below. + + See [CatalogObjectType](#type-catalogobjecttype) for possible values + updated_at: + type: optional + docs: >- + Last modification + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` + + would indicate the UTC time (denoted by `Z`) of August 15, 2016 at + 23:59:33 and 123 milliseconds. + version: + type: optional + docs: >- + The version of the object. When updating an object, the version + supplied + + must match the version in the database, otherwise the write will be + rejected as conflicting. + is_deleted: + type: optional + docs: >- + If `true`, the object has been deleted from the database. Must be + `false` for new objects + + being inserted. When deleted, the `updated_at` field will equal the + deletion time. + custom_attribute_values: + type: optional> + docs: >- + A map (key-value pairs) of application-defined custom attribute + values. The value of a key-value pair + + is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) + object. The key is the `key` attribute + + value defined in the associated + [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + + object defined by the application making the request. + + + If the `CatalogCustomAttributeDefinition` object is + + defined by another application, the + `CatalogCustomAttributeDefinition`'s key attribute value is prefixed + by + + the defining application ID. For example, if the + `CatalogCustomAttributeDefinition` has a `key` attribute of + + `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the + key in the map is `"abcd1234:cocoa_brand"` + + if the application making the request is different from the + application defining the custom attribute definition. + + Otherwise, the key used in the map is simply `"cocoa_brand"`. + + + Application-defined custom attributes are set at a global + (location-independent) level. + + Custom attribute values are intended to store additional information + about a catalog object + + or associations with an entity in another system. Do not use custom + attributes + + to store any sensitive information (personally identifiable + information, card details, etc.). + catalog_v1_ids: + type: optional> + docs: >- + The Connect v1 IDs for this object at each location where it is + present, where they + + differ from the object's Connect V2 ID. The field will only be present + for objects that + + have been created or modified by legacy APIs. + present_at_all_locations: + type: optional + docs: >- + If `true`, this object is present at all locations (including future + locations), except where specified in + + the `absent_at_location_ids` field. If `false`, this object is not + present at any locations (including future locations), + + except where specified in the `present_at_location_ids` field. If not + specified, defaults to `true`. + present_at_location_ids: + type: optional> + docs: >- + A list of locations where the object is present, even if + `present_at_all_locations` is `false`. + + This can include locations that are deactivated. + absent_at_location_ids: + type: optional> + docs: >- + A list of locations where the object is not present, even if + `present_at_all_locations` is `true`. + + This can include locations that are deactivated. + image_id: + type: optional + docs: Identifies the `CatalogImage` attached to this `CatalogObject`. + source: + openapi: openapi/openapi.json + CatalogObjectReference: + docs: >- + A reference to a Catalog object at a specific version. In general this is + + used as an entry point into a graph of catalog objects, where the objects + exist + + at a specific version. + properties: + object_id: + type: optional> + docs: The ID of the referenced object. + catalog_version: + type: optional> + docs: The version of the object. + source: + openapi: openapi/openapi.json + CatalogObjectType: + enum: + - ITEM + - IMAGE + - CATEGORY + - ITEM_VARIATION + - TAX + - DISCOUNT + - MODIFIER_LIST + - MODIFIER + - PRICING_RULE + - PRODUCT_SET + - TIME_PERIOD + - MEASUREMENT_UNIT + - SUBSCRIPTION_PLAN_VARIATION + - ITEM_OPTION + - ITEM_OPTION_VAL + - CUSTOM_ATTRIBUTE_DEFINITION + - QUICK_AMOUNTS_SETTINGS + - SUBSCRIPTION_PLAN + - AVAILABILITY_PERIOD + docs: >- + Possible types of CatalogObjects returned from the catalog, each + + containing type-specific properties in the `*_data` field corresponding to + the specified object type. + source: + openapi: openapi/openapi.json + CatalogPricingRule: + docs: >- + Defines how discounts are automatically applied to a set of items that + match the pricing rule + + during the active time period. + properties: + name: + type: optional> + docs: |- + User-defined name for the pricing rule. For example, "Buy one get one + free" or "10% off". + time_period_ids: + type: optional>> + docs: >- + A list of unique IDs for the catalog time periods when + + this pricing rule is in effect. If left unset, the pricing rule is + always + + in effect. + discount_id: + type: optional> + docs: |- + Unique ID for the `CatalogDiscount` to take off + the price of all matched items. + match_products_id: + type: optional> + docs: >- + Unique ID for the `CatalogProductSet` that will be matched by this + rule. A match rule + + matches within the entire cart, and can match multiple times. This + field will always be set. + apply_products_id: + type: optional> + docs: >- + __Deprecated__: Please use the `exclude_products_id` field to apply + + an exclude set instead. Exclude sets allow better control over + quantity + + ranges and offer more flexibility for which matched items receive a + discount. + + + `CatalogProductSet` to apply the pricing to. + + An apply rule matches within the subset of the cart that fits the + match rules (the match set). + + An apply rule can only match once in the match set. + + If not supplied, the pricing will be applied to all products in the + match set. + + Other products retain their base price, or a price generated by other + rules. + exclude_products_id: + type: optional> + docs: >- + `CatalogProductSet` to exclude from the pricing rule. + + An exclude rule matches within the subset of the cart that fits the + match rules (the match set). + + An exclude rule can only match once in the match set. + + If not supplied, the pricing will be applied to all products in the + match set. + + Other products retain their base price, or a price generated by other + rules. + valid_from_date: + type: optional> + docs: >- + Represents the date the Pricing Rule is valid from. Represented in RFC + 3339 full-date format (YYYY-MM-DD). + valid_from_local_time: + type: optional> + docs: >- + Represents the local time the pricing rule should be valid from. + Represented in RFC 3339 partial-time format + + (HH:MM:SS). Partial seconds will be truncated. + valid_until_date: + type: optional> + docs: >- + Represents the date the Pricing Rule is valid until. Represented in + RFC 3339 full-date format (YYYY-MM-DD). + valid_until_local_time: + type: optional> + docs: >- + Represents the local time the pricing rule should be valid until. + Represented in RFC 3339 partial-time format + + (HH:MM:SS). Partial seconds will be truncated. + exclude_strategy: + type: optional + docs: >- + If an `exclude_products_id` was given, controls which subset of + matched + + products is excluded from any discounts. + + + Default value: `LEAST_EXPENSIVE` + + See [ExcludeStrategy](#type-excludestrategy) for possible values + minimum_order_subtotal_money: + type: optional + docs: |- + The minimum order subtotal (before discounts or taxes are applied) + that must be met before this rule may be applied. + customer_group_ids_any: + type: optional>> + docs: >- + A list of IDs of customer groups, the members of which are eligible + for discounts specified in this pricing rule. + + Notice that a group ID is generated by the Customers API. + + If this field is not set, the specified discount applies to matched + products sold to anyone whether the buyer + + has a customer profile created or not. If this + `customer_group_ids_any` field is set, the specified discount + + applies only to matched products sold to customers belonging to the + specified customer groups. + source: + openapi: openapi/openapi.json + CatalogPricingType: + enum: + - FIXED_PRICING + - VARIABLE_PRICING + docs: >- + Indicates whether the price of a CatalogItemVariation should be entered + manually at the time of sale. + source: + openapi: openapi/openapi.json + CatalogProductSet: + docs: >- + Represents a collection of catalog objects for the purpose of applying a + + `PricingRule`. Including a catalog object will include all of its + subtypes. + + For example, including a category in a product set will include all of its + + items and associated item variations in the product set. Including an item + in + + a product set will also include its item variations. + properties: + name: + type: optional> + docs: |- + User-defined name for the product set. For example, "Clearance Items" + or "Winter Sale Items". + product_ids_any: + type: optional>> + docs: >2- + Unique IDs for any `CatalogObject` included in this product set. Any + number of these catalog objects can be in an order for a pricing rule + to apply. + + + This can be used with `product_ids_all` in a parent + `CatalogProductSet` to + + match groups of products for a bulk discount, such as a discount for + an + + entree and side combo. + + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` + can be set. + + + Max: 500 catalog object IDs. + product_ids_all: + type: optional>> + docs: >- + Unique IDs for any `CatalogObject` included in this product set. + + All objects in this set must be included in an order for a pricing + rule to apply. + + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` + can be set. + + + Max: 500 catalog object IDs. + quantity_exact: + type: optional> + docs: >- + If set, there must be exactly this many items from `products_any` or + `products_all` + + in the cart for the discount to apply. + + + Cannot be combined with either `quantity_min` or `quantity_max`. + quantity_min: + type: optional> + docs: >- + If set, there must be at least this many items from `products_any` or + `products_all` + + in a cart for the discount to apply. See `quantity_exact`. Defaults to + 0 if + + `quantity_exact`, `quantity_min` and `quantity_max` are all + unspecified. + quantity_max: + type: optional> + docs: >- + If set, the pricing rule will apply to a maximum of this many items + from + + `products_any` or `products_all`. + all_products: + type: optional> + docs: >- + If set to `true`, the product set will include every item in the + catalog. + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` + can be set. + source: + openapi: openapi/openapi.json + CatalogQuery: + docs: >- + A query composed of one or more different types of filters to narrow the + scope of targeted objects when calling the `SearchCatalogObjects` + endpoint. + + + Although a query can have multiple filters, only certain query types can + be combined per call to + [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + + Any combination of the following types may be used together: + + - [exact_query](entity:CatalogQueryExact) + + - [prefix_query](entity:CatalogQueryPrefix) + + - [range_query](entity:CatalogQueryRange) + + - [sorted_attribute_query](entity:CatalogQuerySortedAttribute) + + - [text_query](entity:CatalogQueryText) + + + All other query types cannot be combined with any others. + + + When a query filter is based on an attribute, the attribute must be + searchable. + + Searchable attributes are listed as follows, along their parent types that + can be searched for with applicable query filters. + + + Searchable attribute and objects queryable by searchable attributes: + + - `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, + `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, + `CatalogItemOption`, `CatalogItemOptionValue` + + - `description`: `CatalogItem`, `CatalogItemOptionValue` + + - `abbreviation`: `CatalogItem` + + - `upc`: `CatalogItemVariation` + + - `sku`: `CatalogItemVariation` + + - `caption`: `CatalogImage` + + - `display_name`: `CatalogItemOption` + + + For example, to search for [CatalogItem](entity:CatalogItem) objects by + searchable attributes, you can use + + the `"name"`, `"description"`, or `"abbreviation"` attribute in an + applicable query filter. + properties: + sorted_attribute_query: + type: optional + docs: >- + A query expression to sort returned query result by the given + attribute. + exact_query: + type: optional + docs: >- + An exact query expression to return objects with attribute name and + value + + matching the specified attribute name and value exactly. Value + matching is case insensitive. + set_query: + type: optional + docs: >- + A set query expression to return objects with attribute name and value + + matching the specified attribute name and any of the specified + attribute values exactly. + + Value matching is case insensitive. + prefix_query: + type: optional + docs: >- + A prefix query expression to return objects with attribute values + + that have a prefix matching the specified string value. Value matching + is case insensitive. + range_query: + type: optional + docs: |- + A range query expression to return objects with numeric values + that lie in the specified range. + text_query: + type: optional + docs: >- + A text query expression to return objects whose searchable attributes + contain all of the given + + keywords, irrespective of their order. For example, if a `CatalogItem` + contains custom attribute values of + + `{"name": "t-shirt"}` and `{"description": "Small, Purple"}`, the + query filter of `{"keywords": ["shirt", "sma", "purp"]}` + + returns this item. + items_for_tax_query: + type: optional + docs: >- + A query expression to return items that have any of the specified + taxes (as identified by the corresponding `CatalogTax` object IDs) + enabled. + items_for_modifier_list_query: + type: optional + docs: >- + A query expression to return items that have any of the given modifier + list (as identified by the corresponding `CatalogModifierList`s IDs) + enabled. + items_for_item_options_query: + type: optional + docs: >- + A query expression to return items that contains the specified item + options (as identified the corresponding `CatalogItemOption` IDs). + item_variations_for_item_option_values_query: + type: optional + docs: >- + A query expression to return item variations (of the + [CatalogItemVariation](entity:CatalogItemVariation) type) that + + contain all of the specified `CatalogItemOption` IDs. + source: + openapi: openapi/openapi.json + CatalogQueryExact: + docs: >- + The query filter to return the search result by exact match of the + specified attribute name and value. + properties: + attribute_name: + type: string + docs: >- + The name of the attribute to be searched. Matching of the attribute + name is exact. + validation: + minLength: 1 + attribute_value: + type: string + docs: >- + The desired value of the search attribute. Matching of the attribute + value is case insensitive and can be partial. + + For example, if a specified value of "sma", objects with the named + attribute value of "Small", "small" are both matched. + source: + openapi: openapi/openapi.json + CatalogQueryItemVariationsForItemOptionValues: + docs: >- + The query filter to return the item variations containing the specified + item option value IDs. + properties: + item_option_value_ids: + type: optional>> + docs: >- + A set of `CatalogItemOptionValue` IDs to be used to find associated + + `CatalogItemVariation`s. All ItemVariations that contain all of the + given + + Item Option Values (in any order) will be returned. + source: + openapi: openapi/openapi.json + CatalogQueryItemsForItemOptions: + docs: >- + The query filter to return the items containing the specified item option + IDs. + properties: + item_option_ids: + type: optional>> + docs: >- + A set of `CatalogItemOption` IDs to be used to find associated + + `CatalogItem`s. All Items that contain all of the given Item Options + (in any order) + + will be returned. + source: + openapi: openapi/openapi.json + CatalogQueryItemsForModifierList: + docs: >- + The query filter to return the items containing the specified modifier + list IDs. + properties: + modifier_list_ids: + docs: >- + A set of `CatalogModifierList` IDs to be used to find associated + `CatalogItem`s. + type: list + source: + openapi: openapi/openapi.json + CatalogQueryItemsForTax: + docs: The query filter to return the items containing the specified tax IDs. + properties: + tax_ids: + docs: >- + A set of `CatalogTax` IDs to be used to find associated + `CatalogItem`s. + type: list + source: + openapi: openapi/openapi.json + CatalogQueryPrefix: + docs: >- + The query filter to return the search result whose named attribute values + are prefixed by the specified attribute value. + properties: + attribute_name: + type: string + docs: The name of the attribute to be searched. + validation: + minLength: 1 + attribute_prefix: + type: string + docs: The desired prefix of the search attribute value. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + CatalogQueryRange: + docs: >- + The query filter to return the search result whose named attribute values + fall between the specified range. + properties: + attribute_name: + type: string + docs: The name of the attribute to be searched. + validation: + minLength: 1 + attribute_min_value: + type: optional> + docs: The desired minimum value for the search attribute (inclusive). + attribute_max_value: + type: optional> + docs: The desired maximum value for the search attribute (inclusive). + source: + openapi: openapi/openapi.json + CatalogQuerySet: + docs: >- + The query filter to return the search result(s) by exact match of the + specified `attribute_name` and any of + + the `attribute_values`. + properties: + attribute_name: + type: string + docs: >- + The name of the attribute to be searched. Matching of the attribute + name is exact. + validation: + minLength: 1 + attribute_values: + docs: >- + The desired values of the search attribute. Matching of the attribute + values is exact and case insensitive. + + A maximum of 250 values may be searched in a request. + type: list + source: + openapi: openapi/openapi.json + CatalogQuerySortedAttribute: + docs: The query expression to specify the key to sort search results. + properties: + attribute_name: + type: string + docs: The attribute whose value is used as the sort key. + validation: + minLength: 1 + initial_attribute_value: + type: optional> + docs: >- + The first attribute value to be returned by the query. Ascending sorts + will return only + + objects with this value or greater, while descending sorts will return + only objects with this value + + or less. If unset, start at the beginning (for ascending sorts) or end + (for descending sorts). + sort_order: + type: optional + docs: |- + The desired sort order, `"ASC"` (ascending) or `"DESC"` (descending). + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + CatalogQueryText: + docs: >- + The query filter to return the search result whose searchable attribute + values contain all of the specified keywords or tokens, independent of the + token order or case. + properties: + keywords: + docs: >- + A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 + alphanumeric characters are ignored. + type: list + source: + openapi: openapi/openapi.json + CatalogQuickAmount: + docs: Represents a Quick Amount in the Catalog. + properties: + type: + type: CatalogQuickAmountType + docs: >- + Represents the type of the Quick Amount. + + See [CatalogQuickAmountType](#type-catalogquickamounttype) for + possible values + amount: + type: Money + docs: Represents the actual amount of the Quick Amount with Money type. + score: + type: optional> + docs: >- + Describes the ranking of the Quick Amount provided by machine learning + model, in the range [0, 100]. + + MANUAL type amount will always have score = 100. + ordinal: + type: optional> + docs: The order in which this Quick Amount should be displayed. + source: + openapi: openapi/openapi.json + CatalogQuickAmountType: + enum: + - QUICK_AMOUNT_TYPE_MANUAL + - QUICK_AMOUNT_TYPE_AUTO + docs: Determines the type of a specific Quick Amount. + source: + openapi: openapi/openapi.json + CatalogQuickAmountsSettings: + docs: >- + A parent Catalog Object model represents a set of Quick Amounts and the + settings control the amounts. + properties: + option: + type: CatalogQuickAmountsSettingsOption + docs: >- + Represents the option seller currently uses on Quick Amounts. + + See + [CatalogQuickAmountsSettingsOption](#type-catalogquickamountssettingsoption) + for possible values + eligible_for_auto_amounts: + type: optional> + docs: >- + Represents location's eligibility for auto amounts + + The boolean should be consistent with whether there are AUTO amounts + in the `amounts`. + amounts: + type: optional>> + docs: Represents a set of Quick Amounts at this location. + source: + openapi: openapi/openapi.json + CatalogQuickAmountsSettingsOption: + enum: + - DISABLED + - MANUAL + - AUTO + docs: Determines a seller's option on Quick Amounts feature. + source: + openapi: openapi/openapi.json + CatalogStockConversion: + docs: >- + Represents the rule of conversion between a stockable + [CatalogItemVariation](entity:CatalogItemVariation) + + and a non-stockable sell-by or receive-by `CatalogItemVariation` that + + share the same underlying stock. + properties: + stockable_item_variation_id: + type: string + docs: >- + References to the stockable + [CatalogItemVariation](entity:CatalogItemVariation) + + for this stock conversion. Selling, receiving or recounting the + non-stockable `CatalogItemVariation` + + defined with a stock conversion results in adjustments of this + stockable `CatalogItemVariation`. + + This immutable field must reference a stockable `CatalogItemVariation` + + that shares the parent [CatalogItem](entity:CatalogItem) of the + converted `CatalogItemVariation.` + validation: + minLength: 1 + stockable_quantity: + type: string + docs: >- + The quantity of the stockable item variation (as identified by + `stockable_item_variation_id`) + + equivalent to the non-stockable item variation quantity (as specified + in `nonstockable_quantity`) + + as defined by this stock conversion. It accepts a decimal number in a + string format that can take + + up to 10 digits before the decimal point and up to 5 digits after the + decimal point. + validation: + minLength: 1 + maxLength: 16 + nonstockable_quantity: + type: string + docs: >- + The converted equivalent quantity of the non-stockable + [CatalogItemVariation](entity:CatalogItemVariation) + + in its measurement unit. The `stockable_quantity` value and this + `nonstockable_quantity` value together + + define the conversion ratio between stockable item variation and the + non-stockable item variation. + + It accepts a decimal number in a string format that can take up to 10 + digits before the decimal point + + and up to 5 digits after the decimal point. + validation: + minLength: 1 + maxLength: 16 + source: + openapi: openapi/openapi.json + CatalogSubscriptionPlan: + docs: >- + Describes a subscription plan. A subscription plan represents what you + want to sell in a subscription model, and includes references to each of + the associated subscription plan variations. + + For more information, see [Subscription Plans and + Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + properties: + name: + type: string + docs: The name of the plan. + phases: + type: optional>> + docs: >- + A list of SubscriptionPhase containing the + [SubscriptionPhase](entity:SubscriptionPhase) for this plan. + + This field it required. Not including this field will throw a + REQUIRED_FIELD_MISSING error + subscription_plan_variations: + type: optional>> + docs: The list of subscription plan variations available for this product + eligible_item_ids: + type: optional>> + docs: >- + The list of IDs of `CatalogItems` that are eligible for subscription + by this SubscriptionPlan's variations. + eligible_category_ids: + type: optional>> + docs: >- + The list of IDs of `CatalogCategory` that are eligible for + subscription by this SubscriptionPlan's variations. + all_items: + type: optional> + docs: >- + If true, all items in the merchant's catalog are subscribable by this + SubscriptionPlan. + source: + openapi: openapi/openapi.json + CatalogSubscriptionPlanVariation: + docs: >- + Describes a subscription plan variation. A subscription plan variation + represents how the subscription for a product or service is sold. + + For more information, see [Subscription Plans and + Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + properties: + name: + type: string + docs: The name of the plan variation. + phases: + docs: >- + A list containing each [SubscriptionPhase](entity:SubscriptionPhase) + for this plan variation. + type: list + subscription_plan_id: + type: optional> + docs: The id of the subscription plan, if there is one. + monthly_billing_anchor_date: + type: optional> + docs: The day of the month the billing period starts. + can_prorate: + type: optional> + docs: Whether bills for this plan variation can be split for proration. + successor_plan_variation_id: + type: optional> + docs: >- + The ID of a "successor" plan variation to this one. If the field is + set, and this object is disabled at all + + locations, it indicates that this variation is deprecated and the + object identified by the successor ID be used in + + its stead. + source: + openapi: openapi/openapi.json + CatalogTax: + docs: A tax applicable to an item. + properties: + name: + type: optional> + docs: >- + The tax's name. This is a searchable attribute for use in applicable + query filters, and its value length is of Unicode code points. + validation: + maxLength: 255 + calculation_phase: + type: optional + docs: >- + Whether the tax is calculated based on a payment's subtotal or total. + + See [TaxCalculationPhase](#type-taxcalculationphase) for possible + values + inclusion_type: + type: optional + docs: |- + Whether the tax is `ADDITIVE` or `INCLUSIVE`. + See [TaxInclusionType](#type-taxinclusiontype) for possible values + percentage: + type: optional> + docs: >- + The percentage of the tax in decimal form, using a `'.'` as the + decimal separator and without a `'%'` sign. + + A value of `7.5` corresponds to 7.5%. For a location-specific tax + rate, contact the tax authority of the location or a tax consultant. + applies_to_custom_amounts: + type: optional> + docs: >- + If `true`, the fee applies to custom amounts entered into the Square + Point of Sale + + app that are not associated with a particular `CatalogItem`. + enabled: + type: optional> + docs: >- + A Boolean flag to indicate whether the tax is displayed as enabled + (`true`) in the Square Point of Sale app or not (`false`). + applies_to_product_set_id: + type: optional> + docs: >- + The ID of a `CatalogProductSet` object. If set, the tax is applicable + to all products in the product set. + source: + openapi: openapi/openapi.json + CatalogTimePeriod: + docs: Represents a time period - either a single period or a repeating period. + properties: + event: + type: optional> + docs: >- + An iCalendar (RFC 5545) + [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which + + specifies the name, timing, duration and recurrence of this time + period. + + + Example: + + + ``` + + DTSTART:20190707T180000 + + DURATION:P2H + + RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR + + ``` + + + Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are + supported. + + `DTSTART` must be in local (unzoned) time format. Note that while + `BEGIN:VEVENT` + + and `END:VEVENT` is not required in the request. The response will + always + + include them. + source: + openapi: openapi/openapi.json + CatalogV1Id: + docs: >- + A Square API V1 identifier of an item, including the object ID and its + associated location ID. + properties: + catalog_v1_id: + type: optional> + docs: >- + The ID for an object used in the Square API V1, if the object ID + differs from the Square API V2 object ID. + location_id: + type: optional> + docs: The ID of the `Location` this Connect V1 ID is associated with. + source: + openapi: openapi/openapi.json + CategoryPathToRootNode: + docs: A node in the path from a retrieved category to its root node. + properties: + category_id: + type: optional> + docs: The category's ID. + category_name: + type: optional> + docs: The category's name. + source: + openapi: openapi/openapi.json + ChangeBillingAnchorDateResponse: + docs: >- + Defines output parameters in a request to the + + [ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The specified subscription for updating billing anchor date. + actions: + type: optional> + docs: A list of a single billing anchor date change for the subscription. + source: + openapi: openapi/openapi.json + ChangeTiming: + enum: + - IMMEDIATE + - END_OF_BILLING_CYCLE + docs: >- + Supported timings when a pending change, as an action, takes place to a + subscription. + source: + openapi: openapi/openapi.json + ChargeRequestAdditionalRecipient: + docs: >- + Represents an additional recipient (other than the merchant) entitled to a + portion of the tender. + + Support is currently limited to USD, CAD and GBP currencies + properties: + location_id: + type: string + docs: >- + The location ID for a recipient (other than the merchant) receiving a + portion of the tender. + validation: + minLength: 1 + maxLength: 50 + description: + type: string + docs: The description of the additional recipient. + validation: + minLength: 1 + maxLength: 100 + amount_money: + type: Money + docs: The amount of money distributed to the recipient. + source: + openapi: openapi/openapi.json + Checkout: + docs: |- + Square Checkout lets merchants accept online payments for supported + payment types using a checkout workflow hosted on squareup.com. + properties: + id: + type: optional + docs: ID generated by Square Checkout when a new checkout is requested. + checkout_page_url: + type: optional> + docs: |- + The URL that the buyer's browser should be redirected to after the + checkout is completed. + ask_for_shipping_address: + type: optional> + docs: >- + If `true`, Square Checkout will collect shipping information on your + + behalf and store that information with the transaction information in + your + + Square Dashboard. + + + Default: `false`. + merchant_support_email: + type: optional> + docs: >- + The email address to display on the Square Checkout confirmation page + + and confirmation email that the buyer can use to contact the merchant. + + + If this value is not set, the confirmation page and email will display + the + + primary email address associated with the merchant's Square account. + + + Default: none; only exists if explicitly set. + pre_populate_buyer_email: + type: optional> + docs: |- + If provided, the buyer's email is pre-populated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + pre_populate_shipping_address: + type: optional
+ docs: |- + If provided, the buyer's shipping info is pre-populated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + redirect_url: + type: optional> + docs: >- + The URL to redirect to after checkout is completed with `checkoutId`, + + Square's `orderId`, `transactionId`, and `referenceId` appended as URL + + parameters. For example, if the provided redirect_url is + + `http://www.example.com/order-complete`, a successful transaction + redirects + + the customer to: + + + 
http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
+ + + If you do not provide a redirect URL, Square Checkout will display an + order + + confirmation page on your behalf; however Square strongly recommends + that + + you provide a redirect URL so you can verify the transaction results + and + + finalize the order through your existing/normal confirmation workflow. + order: + type: optional + docs: Order to be checked out. + created_at: + type: optional + docs: The time when the checkout was created, in RFC 3339 format. + access: read-only + additional_recipients: + type: optional>> + docs: >- + Additional recipients (other than the merchant) receiving a portion of + this checkout. + + For example, fees assessed on the purchase by a third party + integration. + source: + openapi: openapi/openapi.json + CheckoutLocationSettings: + properties: + location_id: + type: optional> + docs: The ID of the location that these settings apply to. + customer_notes_enabled: + type: optional> + docs: Indicates whether customers are allowed to leave notes at checkout. + policies: + type: optional>> + docs: |- + Policy information is displayed at the bottom of the checkout pages. + You can set a maximum of two policies. + branding: + type: optional + docs: The branding settings for this location. + tipping: + type: optional + docs: The tip settings for this location. + coupons: + type: optional + docs: The coupon settings for this location. + updated_at: + type: optional + docs: |- + The timestamp when the settings were last updated, in RFC 3339 format. + Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: + UTC: 2020-01-26T02:25:34Z + Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 + access: read-only + source: + openapi: openapi/openapi.json + CheckoutLocationSettingsBranding: + properties: + header_type: + type: optional + docs: |- + Show the location logo on the checkout page. + See [HeaderType](#type-headertype) for possible values + button_color: + type: optional> + docs: >- + The HTML-supported hex color for the button on the checkout page (for + example, "#FFFFFF"). + validation: + minLength: 7 + maxLength: 7 + button_shape: + type: optional + docs: |- + The shape of the button on the checkout page. + See [ButtonShape](#type-buttonshape) for possible values + source: + openapi: openapi/openapi.json + CheckoutLocationSettingsBrandingButtonShape: + enum: + - SQUARED + - ROUNDED + - PILL + source: + openapi: openapi/openapi.json + CheckoutLocationSettingsBrandingHeaderType: + enum: + - BUSINESS_NAME + - FRAMED_LOGO + - FULL_WIDTH_LOGO + source: + openapi: openapi/openapi.json + CheckoutLocationSettingsCoupons: + properties: + enabled: + type: optional> + docs: Indicates whether coupons are enabled for this location. + source: + openapi: openapi/openapi.json + CheckoutLocationSettingsPolicy: + properties: + uid: + type: optional> + docs: >- + A unique ID to identify the policy when making changes. You must set + the UID for policy updates, but it’s optional when setting new + policies. + title: + type: optional> + docs: >- + The title of the policy. This is required when setting the + description, though you can update it in a different request. + validation: + maxLength: 50 + description: + type: optional> + docs: The description of the policy. + validation: + maxLength: 4096 + source: + openapi: openapi/openapi.json + CheckoutLocationSettingsTipping: + properties: + percentages: + type: optional>> + docs: >- + Set three custom percentage amounts that buyers can select at + checkout. If Smart Tip is enabled, this only applies to transactions + totaling $10 or more. + smart_tipping_enabled: + type: optional> + docs: >- + Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping + works as follows: + + If a transaction is less than $10, the available tipping options + include No Tip, $1, $2, or $3. + + If a transaction is $10 or more, the available tipping options include + No Tip, 15%, 20%, or 25%. + + You can set custom percentage amounts with the `percentages` field. + default_percent: + type: optional> + docs: >- + Set the pre-selected percentage amounts that appear at checkout. If + Smart Tip is enabled, this only applies to transactions totaling $10 + or more. + smart_tips: + type: optional>> + docs: Show the Smart Tip Amounts for this location. + default_smart_tip: + type: optional + docs: >- + Set the pre-selected whole amount that appears at checkout when Smart + Tip is enabled and the transaction amount is less than $10. + source: + openapi: openapi/openapi.json + CheckoutMerchantSettings: + properties: + payment_methods: + type: optional + docs: The set of payment methods accepted for the merchant's account. + updated_at: + type: optional + docs: |- + The timestamp when the settings were last updated, in RFC 3339 format. + Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: + UTC: 2020-01-26T02:25:34Z + Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 + access: read-only + source: + openapi: openapi/openapi.json + CheckoutMerchantSettingsPaymentMethods: + properties: + apple_pay: optional + google_pay: optional + cash_app: optional + afterpay_clearpay: optional + source: + openapi: openapi/openapi.json + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay: + docs: The settings allowed for AfterpayClearpay. + properties: + order_eligibility_range: + type: >- + optional + docs: >- + Afterpay is shown as an option for order totals falling within the + configured range. + item_eligibility_range: + type: >- + optional + docs: >- + Afterpay is shown as an option for item totals falling within the + configured range. + enabled: + type: optional + docs: Indicates whether the payment method is enabled for the account. + access: read-only + source: + openapi: openapi/openapi.json + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange: + docs: A range of purchase price that qualifies. + properties: + min: Money + max: Money + source: + openapi: openapi/openapi.json + CheckoutMerchantSettingsPaymentMethodsPaymentMethod: + docs: The settings allowed for a payment method. + properties: + enabled: + type: optional> + docs: Indicates whether the payment method is enabled for the account. + source: + openapi: openapi/openapi.json + CheckoutOptions: + properties: + allow_tipping: + type: optional> + docs: Indicates whether the payment allows tipping. + custom_fields: + type: optional>> + docs: The custom fields requesting information from the buyer. + subscription_plan_id: + type: optional> + docs: >- + The ID of the subscription plan for the buyer to pay and subscribe. + + For more information, see [Subscription Plan + Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout). + validation: + maxLength: 255 + redirect_url: + type: optional> + docs: >- + The confirmation page URL to redirect the buyer to after Square + processes the payment. + validation: + maxLength: 2048 + merchant_support_email: + type: optional> + docs: The email address that buyers can use to contact the seller. + validation: + maxLength: 256 + ask_for_shipping_address: + type: optional> + docs: Indicates whether to include the address fields in the payment form. + accepted_payment_methods: + type: optional + docs: The methods allowed for buyers during checkout. + app_fee_money: + type: optional + docs: >- + The amount of money that the developer is taking as a fee for + facilitating the payment on behalf of the seller. + + + The amount cannot be more than 90% of the total amount of the payment. + + + The amount must be specified in the smallest denomination of the + applicable currency (for example, US dollar amounts are specified in + cents). For more information, see [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-monetary-amounts). + + + The fee currency code must match the currency associated with the + seller that is accepting the payment. The application must be from a + developer account in the same country and using the same currency code + as the seller. For more information about the application fee + scenario, see [Take Payments and Collect + Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth + permission is required. For more information, see + [Permissions](https://developer.squareup.com/docs/payments-api/collect-fees/additional-considerations#permissions). + shipping_fee: + type: optional + docs: >- + The fee associated with shipping to be applied to the `Order` as a + service charge. + enable_coupon: + type: optional> + docs: >- + Indicates whether to include the `Add coupon` section for the buyer to + provide a Square marketing coupon in the payment form. + enable_loyalty: + type: optional> + docs: >- + Indicates whether to include the `REWARDS` section for the buyer to + opt in to loyalty, redeem rewards in the payment form, or both. + source: + openapi: openapi/openapi.json + CheckoutOptionsPaymentType: + enum: + - CARD_PRESENT + - MANUAL_CARD_ENTRY + - FELICA_ID + - FELICA_QUICPAY + - FELICA_TRANSPORTATION_GROUP + - FELICA_ALL + - PAYPAY + - QR_CODE + source: + openapi: openapi/openapi.json + ClearpayDetails: + docs: Additional details about Clearpay payments. + properties: + email_address: + type: optional> + docs: Email address on the buyer's Clearpay account. + validation: + maxLength: 255 + source: + openapi: openapi/openapi.json + CloneOrderResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint. + properties: + order: + type: optional + docs: The cloned order. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CollectedData: + properties: + input_text: + type: optional + docs: The buyer's input text. + access: read-only + source: + openapi: openapi/openapi.json + CompletePaymentResponse: + docs: >- + Defines the response returned + by[CompletePayment](api-endpoint:Payments-CompletePayment). + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + payment: + type: optional + docs: The successfully completed payment. + source: + openapi: openapi/openapi.json + Component: + docs: The wrapper object for the component entries of a given component type. + properties: + type: + type: ComponentComponentType + docs: >- + The type of this component. Each component type has expected + properties expressed + + in a structured format within its corresponding `*_details` field. + + See [ComponentType](#type-componenttype) for possible values + application_details: + type: optional + docs: >- + Structured data for an `Application`, set for Components of type + `APPLICATION`. + card_reader_details: + type: optional + docs: >- + Structured data for a `CardReader`, set for Components of type + `CARD_READER`. + battery_details: + type: optional + docs: Structured data for a `Battery`, set for Components of type `BATTERY`. + wifi_details: + type: optional + docs: >- + Structured data for a `WiFi` interface, set for Components of type + `WIFI`. + ethernet_details: + type: optional + docs: >- + Structured data for an `Ethernet` interface, set for Components of + type `ETHERNET`. + source: + openapi: openapi/openapi.json + ComponentComponentType: + enum: + - APPLICATION + - CARD_READER + - BATTERY + - WIFI + - ETHERNET + - PRINTER + docs: An enum for ComponentType. + source: + openapi: openapi/openapi.json + ConfirmationDecision: + properties: + has_agreed: + type: optional + docs: The buyer's decision to the displayed terms. + access: read-only + source: + openapi: openapi/openapi.json + ConfirmationOptions: + properties: + title: + type: string + docs: >- + The title text to display in the confirmation screen flow on the + Terminal. + validation: + minLength: 1 + maxLength: 250 + body: + type: string + docs: >- + The agreement details to display in the confirmation flow on the + Terminal. + validation: + minLength: 1 + maxLength: 10000 + agree_button_text: + type: string + docs: >- + The button text to display indicating the customer agrees to the + displayed terms. + validation: + minLength: 1 + maxLength: 250 + disagree_button_text: + type: optional> + docs: >- + The button text to display indicating the customer does not agree to + the displayed terms. + validation: + minLength: 1 + maxLength: 250 + decision: + type: optional + docs: >- + The result of the buyer’s actions when presented with the confirmation + screen. + source: + openapi: openapi/openapi.json + Coordinates: + docs: Latitude and longitude coordinates. + properties: + latitude: + type: optional> + docs: The latitude of the coordinate expressed in degrees. + longitude: + type: optional> + docs: The longitude of the coordinate expressed in degrees. + source: + openapi: openapi/openapi.json + Country: + enum: + - ZZ + - AD + - AE + - AF + - AG + - AI + - AL + - AM + - AO + - AQ + - AR + - AS + - AT + - AU + - AW + - AX + - AZ + - BA + - BB + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BL + - BM + - BN + - BO + - BQ + - BR + - BS + - BT + - BV + - BW + - BY + - BZ + - CA + - CC + - CD + - CF + - CG + - CH + - CI + - CK + - CL + - CM + - CN + - CO + - CR + - CU + - CV + - CW + - CX + - CY + - CZ + - DE + - DJ + - DK + - DM + - DO + - DZ + - EC + - EE + - EG + - EH + - ER + - ES + - ET + - FI + - FJ + - FK + - FM + - FO + - FR + - GA + - GB + - GD + - GE + - GF + - GG + - GH + - GI + - GL + - GM + - GN + - GP + - GQ + - GR + - GS + - GT + - GU + - GW + - GY + - HK + - HM + - HN + - HR + - HT + - HU + - ID + - IE + - IL + - IM + - IN + - IO + - IQ + - IR + - IS + - IT + - JE + - JM + - JO + - JP + - KE + - KG + - KH + - KI + - KM + - KN + - KP + - KR + - KW + - KY + - KZ + - LA + - LB + - LC + - LI + - LK + - LR + - LS + - LT + - LU + - LV + - LY + - MA + - MC + - MD + - ME + - MF + - MG + - MH + - MK + - ML + - MM + - MN + - MO + - MP + - MQ + - MR + - MS + - MT + - MU + - MV + - MW + - MX + - MY + - MZ + - NA + - NC + - NE + - NF + - NG + - NI + - NL + - 'NO' + - NP + - NR + - NU + - NZ + - OM + - PA + - PE + - PF + - PG + - PH + - PK + - PL + - PM + - PN + - PR + - PS + - PT + - PW + - PY + - QA + - RE + - RO + - RS + - RU + - RW + - SA + - SB + - SC + - SD + - SE + - SG + - SH + - SI + - SJ + - SK + - SL + - SM + - SN + - SO + - SR + - SS + - ST + - SV + - SX + - SY + - SZ + - TC + - TD + - TF + - TG + - TH + - TJ + - TK + - TL + - TM + - TN + - TO + - TR + - TT + - TV + - TW + - TZ + - UA + - UG + - UM + - US + - UY + - UZ + - VA + - VC + - VE + - VG + - VI + - VN + - VU + - WF + - WS + - YE + - YT + - ZA + - ZM + - ZW + docs: >- + Indicates the country associated with another entity, such as a business. + + Values are in [ISO 3166-1-alpha-2 + format](http://www.iso.org/iso/home/standards/country_codes.htm). + source: + openapi: openapi/openapi.json + CreateBookingCustomAttributeDefinitionResponse: + docs: >- + Represents a + [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The newly created custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateBookingResponse: + properties: + booking: + type: optional + docs: The booking that was created. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateBreakTypeResponse: + docs: >- + The response to the request to create a `BreakType`. The response contains + + the created `BreakType` object and might contain a set of `Error` objects + if + + the request resulted in errors. + properties: + break_type: + type: optional + docs: The `BreakType` that was created by the request. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateCardResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [CreateCard](api-endpoint:Cards-CreateCard) endpoint. + + + Note: if there are errors processing the request, the card field will not + be + + present. + properties: + errors: + type: optional> + docs: Errors resulting from the request. + card: + type: optional + docs: The card created by the request. + source: + openapi: openapi/openapi.json + CreateCatalogImageRequest: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this CreateCatalogImage request. + + Keys can be any valid string but must be unique for every + CreateCatalogImage request. + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 128 + object_id: + type: optional + docs: >- + Unique ID of the `CatalogObject` to attach this `CatalogImage` object + to. Leave this + + field empty to create unattached images, for example if you are + building an integration + + where an image can be attached to catalog items at a later time. + image: + type: CatalogObject + docs: >- + The new `CatalogObject` of the `IMAGE` type, namely, a `CatalogImage` + object, to encapsulate the specified image file. + is_primary: + type: optional + docs: >- + If this is set to `true`, the image created will be the primary, or + first image of the object referenced by `object_id`. + + If the `CatalogObject` already has a primary `CatalogImage`, setting + this field to `true` will replace the primary image. + + If this is set to `false` and you use the Square API version + 2021-12-15 or later, the image id will be appended to the list of + `image_ids` on the object. + + + With Square API version 2021-12-15 or later, the default value is + `false`. Otherwise, the effective default value is `true`. + source: + openapi: openapi/openapi.json + CreateCatalogImageResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + image: + type: optional + docs: |- + The newly created `CatalogImage` including a Square-generated + URL for the encapsulated image file. + source: + openapi: openapi/openapi.json + CreateCheckoutResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `CreateCheckout` endpoint. + properties: + checkout: + type: optional + docs: >- + The newly created `checkout` object associated with the provided + idempotency key. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateCustomerCardResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `CreateCustomerCard` endpoint. + + Either `errors` or `card` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + card: + type: optional + docs: The created card on file. + source: + openapi: openapi/openapi.json + CreateCustomerCustomAttributeDefinitionResponse: + docs: >- + Represents a + [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The new custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateCustomerGroupResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) + endpoint. + + + Either `errors` or `group` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + group: + type: optional + docs: The successfully created customer group. + source: + openapi: openapi/openapi.json + CreateCustomerResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [CreateCustomer](api-endpoint:Customers-CreateCustomer) + or + + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) + endpoint. + + + Either `errors` or `customer` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + customer: + type: optional + docs: The created customer. + source: + openapi: openapi/openapi.json + CreateDeviceCodeResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + device_code: + type: optional + docs: The created DeviceCode object containing the device code string. + source: + openapi: openapi/openapi.json + CreateDisputeEvidenceFileRequest: + docs: Defines the parameters for a `CreateDisputeEvidenceFile` request. + properties: + idempotency_key: + type: string + docs: >- + A unique key identifying the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + minLength: 1 + maxLength: 45 + evidence_type: + type: optional + docs: >- + The type of evidence you are uploading. + + See [DisputeEvidenceType](#type-disputeevidencetype) for possible + values + content_type: + type: optional + docs: >- + The MIME type of the uploaded file. + + The type can be image/heic, image/heif, image/jpeg, application/pdf, + image/png, or image/tiff. + validation: + minLength: 1 + maxLength: 40 + source: + openapi: openapi/openapi.json + CreateDisputeEvidenceFileResponse: + docs: Defines the fields in a `CreateDisputeEvidenceFile` response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + evidence: + type: optional + docs: The metadata of the newly uploaded dispute evidence. + source: + openapi: openapi/openapi.json + CreateDisputeEvidenceTextResponse: + docs: Defines the fields in a `CreateDisputeEvidenceText` response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + evidence: + type: optional + docs: The newly uploaded dispute evidence metadata. + source: + openapi: openapi/openapi.json + CreateGiftCardActivityResponse: + docs: >- + A response that contains a `GiftCardActivity` that was created. + + The response might contain a set of `Error` objects if the request + resulted in errors. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card_activity: + type: optional + docs: The gift card activity that was created. + source: + openapi: openapi/openapi.json + CreateGiftCardResponse: + docs: >- + A response that contains a `GiftCard`. The response might contain a set of + `Error` objects if the request + + resulted in errors. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card: + type: optional + docs: The new gift card. + source: + openapi: openapi/openapi.json + CreateInvoiceAttachmentResponse: + docs: >- + Represents a + [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) + response. + properties: + attachment: + type: optional + docs: Metadata about the attachment that was added to the invoice. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + CreateInvoiceResponse: + docs: The response returned by the `CreateInvoice` request. + properties: + invoice: + type: optional + docs: The newly created invoice. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + CreateJobResponse: + docs: >- + Represents a [CreateJob](api-endpoint:Team-CreateJob) response. Either + `job` or `errors` + + is present in the response. + properties: + job: + type: optional + docs: The new job. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateLocationCustomAttributeDefinitionResponse: + docs: >- + Represents a + [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The new custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateLocationResponse: + docs: >- + The response object returned by the + [CreateLocation](api-endpoint:Locations-CreateLocation) endpoint. + properties: + errors: + type: optional> + docs: >- + Information about + [errors](https://developer.squareup.com/docs/build-basics/handling-errors) + encountered during the request. + location: + type: optional + docs: The newly created `Location` object. + source: + openapi: openapi/openapi.json + CreateLoyaltyAccountResponse: + docs: A response that includes loyalty account created. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_account: + type: optional + docs: The newly created loyalty account. + source: + openapi: openapi/openapi.json + CreateLoyaltyPromotionResponse: + docs: >- + Represents a + [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) + response. + + Either `loyalty_promotion` or `errors` is present in the response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_promotion: + type: optional + docs: The new loyalty promotion. + source: + openapi: openapi/openapi.json + CreateLoyaltyRewardResponse: + docs: A response that includes the loyalty reward created. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + reward: + type: optional + docs: The loyalty reward created. + source: + openapi: openapi/openapi.json + CreateMerchantCustomAttributeDefinitionResponse: + docs: >- + Represents a + [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The new custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateMobileAuthorizationCodeResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `CreateMobileAuthorizationCode` endpoint. + properties: + authorization_code: + type: optional + docs: >- + The generated authorization code that connects a mobile application + instance + + to a Square account. + validation: + maxLength: 191 + expires_at: + type: optional + docs: >- + The timestamp when `authorization_code` expires, in + + [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, + "2016-09-04T23:59:33.123Z"). + validation: + minLength: 20 + maxLength: 48 + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateOrderCustomAttributeDefinitionResponse: + docs: Represents a response from creating an order custom attribute definition. + properties: + custom_attribute_definition: + type: optional + docs: The new custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateOrderRequest: + properties: + order: + type: optional + docs: >- + The order to create. If this field is set, the only other top-level + field that can be + + set is the `idempotency_key`. + idempotency_key: + type: optional + docs: >- + A value you specify that uniquely identifies this + + order among orders you have created. + + + If you are unsure whether a particular order was created successfully, + + you can try it again with the same idempotency key without + + worrying about creating duplicate orders. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + CreateOrderResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `CreateOrder` endpoint. + + Either `errors` or `order` is present in a given response, but never both. + properties: + order: + type: optional + docs: The newly created order. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreatePaymentLinkResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + payment_link: + type: optional + docs: The created payment link. + related_resources: + type: optional + docs: The list of related objects. + source: + openapi: openapi/openapi.json + CreatePaymentResponse: + docs: >- + Defines the response returned by + [CreatePayment](api-endpoint:Payments-CreatePayment). + + + If there are errors processing the request, the `payment` field might not + be + + present, or it might be present with a status of `FAILED`. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + payment: + type: optional + docs: The newly created payment. + source: + openapi: openapi/openapi.json + CreateShiftResponse: + docs: |- + The response to a request to create a `Shift`. The response contains + the created `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + properties: + shift: + type: optional + docs: The `Shift` that was created on the request. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateSubscriptionResponse: + docs: >- + Defines output parameters in a response from the + + [CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: >- + The newly created subscription. + + + For more information, see + + [Subscription + object](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#subscription-object). + source: + openapi: openapi/openapi.json + CreateTeamMemberRequest: + docs: Represents a create request for a `TeamMember` object. + properties: + idempotency_key: + type: optional + docs: >- + A unique string that identifies this `CreateTeamMember` request. + + Keys can be any valid string, but must be unique for every request. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + + The minimum length is 1 and the maximum length is 45. + team_member: + type: optional + docs: >- + **Required** The data used to create the `TeamMember` object. If you + include `wage_setting`, you must provide + + `job_id` for each job assignment. To get job IDs, call + [ListJobs](api-endpoint:Team-ListJobs). + source: + openapi: openapi/openapi.json + CreateTeamMemberResponse: + docs: >- + Represents a response from a create request containing the created + `TeamMember` object or error messages. + properties: + team_member: + type: optional + docs: The successfully created `TeamMember` object. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + CreateTerminalActionResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + action: + type: optional + docs: The created `TerminalAction` + source: + openapi: openapi/openapi.json + CreateTerminalCheckoutResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + checkout: + type: optional + docs: The created `TerminalCheckout`. + source: + openapi: openapi/openapi.json + CreateTerminalRefundResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refund: + type: optional + docs: The created `TerminalRefund`. + source: + openapi: openapi/openapi.json + CreateVendorResponse: + docs: >- + Represents an output from a call to + [CreateVendor](api-endpoint:Vendors-CreateVendor). + properties: + errors: + type: optional> + docs: Errors encountered when the request fails. + vendor: + type: optional + docs: The successfully created [Vendor](entity:Vendor) object. + source: + openapi: openapi/openapi.json + CreateWebhookSubscriptionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) + endpoint. + + + Note: if there are errors processing the request, the + [Subscription](entity:WebhookSubscription) will not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + subscription: + type: optional + docs: The new [Subscription](entity:WebhookSubscription). + source: + openapi: openapi/openapi.json + Currency: + enum: + - UNKNOWN_CURRENCY + - AED + - AFN + - ALL + - AMD + - ANG + - AOA + - ARS + - AUD + - AWG + - AZN + - BAM + - BBD + - BDT + - BGN + - BHD + - BIF + - BMD + - BND + - BOB + - BOV + - BRL + - BSD + - BTN + - BWP + - BYR + - BZD + - CAD + - CDF + - CHE + - CHF + - CHW + - CLF + - CLP + - CNY + - COP + - COU + - CRC + - CUC + - CUP + - CVE + - CZK + - DJF + - DKK + - DOP + - DZD + - EGP + - ERN + - ETB + - EUR + - FJD + - FKP + - GBP + - GEL + - GHS + - GIP + - GMD + - GNF + - GTQ + - GYD + - HKD + - HNL + - HRK + - HTG + - HUF + - IDR + - ILS + - INR + - IQD + - IRR + - ISK + - JMD + - JOD + - JPY + - KES + - KGS + - KHR + - KMF + - KPW + - KRW + - KWD + - KYD + - KZT + - LAK + - LBP + - LKR + - LRD + - LSL + - LTL + - LVL + - LYD + - MAD + - MDL + - MGA + - MKD + - MMK + - MNT + - MOP + - MRO + - MUR + - MVR + - MWK + - MXN + - MXV + - MYR + - MZN + - NAD + - NGN + - NIO + - NOK + - NPR + - NZD + - OMR + - PAB + - PEN + - PGK + - PHP + - PKR + - PLN + - PYG + - QAR + - RON + - RSD + - RUB + - RWF + - SAR + - SBD + - SCR + - SDG + - SEK + - SGD + - SHP + - SLL + - SLE + - SOS + - SRD + - SSP + - STD + - SVC + - SYP + - SZL + - THB + - TJS + - TMT + - TND + - TOP + - TRY + - TTD + - TWD + - TZS + - UAH + - UGX + - USD + - USN + - USS + - UYI + - UYU + - UZS + - VEF + - VND + - VUV + - WST + - XAF + - XAG + - XAU + - XBA + - XBB + - XBC + - XBD + - XCD + - XDR + - XOF + - XPD + - XPF + - XPT + - XTS + - XXX + - YER + - ZAR + - ZMK + - ZMW + - BTC + - XUS + docs: >- + Indicates the associated currency for an amount of money. Values + correspond + + to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). + source: + openapi: openapi/openapi.json + CustomAttribute: + docs: |- + A custom attribute value. Each custom attribute value has a corresponding + `CustomAttributeDefinition` object. + properties: + key: + type: optional> + docs: >- + The identifier + + of the custom attribute definition and its corresponding custom + attributes. This value + + can be a simple key, which is the key that is provided when the custom + attribute definition + + is created, or a qualified key, if the requesting + + application is not the definition owner. The qualified key consists of + the application ID + + of the custom attribute definition owner + + followed by the simple key that was provided when the definition was + created. It has the + + format application_id:simple key. + + + The value for a simple key can contain up to 60 alphanumeric + characters, periods (.), + + underscores (_), and hyphens (-). + validation: + pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$ + minLength: 1 + value: optional + version: + type: optional + docs: >- + Read only. The current version of the custom attribute. This field is + incremented when the custom attribute is changed. + + When updating an existing custom attribute value, you can provide this + field + + and specify the current version of the custom attribute to enable + + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). + + This field can also be used to enforce strong consistency for reads. + For more information about strong consistency for reads, + + see [Custom Attributes + Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + visibility: + type: optional + docs: >- + A copy of the `visibility` field value for the associated custom + attribute definition. + + See + [CustomAttributeDefinitionVisibility](#type-customattributedefinitionvisibility) + for possible values + definition: + type: optional + docs: >- + A copy of the associated custom attribute definition object. This + field is only set when + + the optional field is specified on the request. + updated_at: + type: optional + docs: >- + The timestamp that indicates when the custom attribute was created or + was most recently + + updated, in RFC 3339 format. + access: read-only + created_at: + type: optional + docs: >- + The timestamp that indicates when the custom attribute was created, in + RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + CustomAttributeDefinition: + docs: >- + Represents a definition for custom attribute values. A custom attribute + definition + + specifies the key, visibility, schema, and other properties for a custom + attribute. + properties: + key: + type: optional> + docs: >- + The identifier + + of the custom attribute definition and its corresponding custom + attributes. This value + + can be a simple key, which is the key that is provided when the custom + attribute definition + + is created, or a qualified key, if the requesting + + application is not the definition owner. The qualified key consists of + the application ID + + of the custom attribute definition owner + + followed by the simple key that was provided when the definition was + created. It has the + + format application_id:simple key. + + + The value for a simple key can contain up to 60 alphanumeric + characters, periods (.), + + underscores (_), and hyphens (-). + + + This field can not be changed + + after the custom attribute definition is created. This field is + required when creating + + a definition and must be unique per application, seller, and resource + type. + validation: + pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$ + minLength: 1 + schema: + type: optional>> + docs: >- + The JSON schema for the custom attribute definition, which determines + the data type of the corresponding custom attributes. For more + information, + + see [Custom Attributes + Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + This field is required when creating a definition. + name: + type: optional> + docs: >- + The name of the custom attribute definition for API and seller-facing + UI purposes. The name must + + be unique within the seller and application pair. This field is + required if the + + `visibility` field is `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. + validation: + maxLength: 255 + description: + type: optional> + docs: >- + Seller-oriented description of the custom attribute definition, + including any constraints + + that the seller should observe. May be displayed as a tooltip in + Square UIs. This field is + + required if the `visibility` field is `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. + validation: + maxLength: 255 + visibility: + type: optional + docs: >- + Specifies how the custom attribute definition and its values should be + shared with + + the seller and other applications. If no value is specified, the value + defaults to `VISIBILITY_HIDDEN`. + + See [Visibility](#type-visibility) for possible values + version: + type: optional + docs: >- + Read only. The current version of the custom attribute definition. + + The value is incremented each time the custom attribute definition is + updated. + + When updating a custom attribute definition, you can provide this + field + + and specify the current version of the custom attribute definition to + enable + + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). + + + On writes, this field must be set to the latest version. Stale writes + are rejected. + + + This field can also be used to enforce strong consistency for reads. + For more information about strong consistency for reads, + + see [Custom Attributes + Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + updated_at: + type: optional + docs: >- + The timestamp that indicates when the custom attribute definition was + created or most recently updated, + + in RFC 3339 format. + access: read-only + created_at: + type: optional + docs: >- + The timestamp that indicates when the custom attribute definition was + created, in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + CustomAttributeDefinitionVisibility: + enum: + - VISIBILITY_HIDDEN + - VISIBILITY_READ_ONLY + - VISIBILITY_READ_WRITE_VALUES + docs: >- + The level of permission that a seller or other applications requires to + + view this custom attribute definition. + + The `Visibility` field controls who can read and write the custom + attribute values + + and custom attribute definition. + source: + openapi: openapi/openapi.json + CustomAttributeFilter: + docs: |- + Supported custom attribute query expressions for calling the + [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint to search for items or item variations. + properties: + custom_attribute_definition_id: + type: optional> + docs: >- + A query expression to filter items or item variations by matching + their custom attributes' + + `custom_attribute_definition_id` property value against the the + specified id. + + Exactly one of `custom_attribute_definition_id` or `key` must be + specified. + key: + type: optional> + docs: >- + A query expression to filter items or item variations by matching + their custom attributes' + + `key` property value against the specified key. + + Exactly one of `custom_attribute_definition_id` or `key` must be + specified. + string_filter: + type: optional> + docs: >- + A query expression to filter items or item variations by matching + their custom attributes' + + `string_value` property value against the specified text. + + Exactly one of `string_filter`, `number_filter`, + `selection_uids_filter`, or `bool_filter` must be specified. + number_filter: + type: optional + docs: >- + A query expression to filter items or item variations with their + custom attributes + + containing a number value within the specified range. + + Exactly one of `string_filter`, `number_filter`, + `selection_uids_filter`, or `bool_filter` must be specified. + selection_uids_filter: + type: optional>> + docs: >- + A query expression to filter items or item variations by matching + their custom attributes' + + `selection_uid_values` values against the specified selection uids. + + Exactly one of `string_filter`, `number_filter`, + `selection_uids_filter`, or `bool_filter` must be specified. + bool_filter: + type: optional> + docs: >- + A query expression to filter items or item variations by matching + their custom attributes' + + `boolean_value` property values against the specified Boolean + expression. + + Exactly one of `string_filter`, `number_filter`, + `selection_uids_filter`, or `bool_filter` must be specified. + source: + openapi: openapi/openapi.json + CustomField: + docs: >- + Describes a custom form field to add to the checkout page to collect more + information from buyers during checkout. + + For more information, + + see [Specify checkout + options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1). + properties: + title: + type: string + docs: The title of the custom field. + validation: + minLength: 1 + maxLength: 50 + source: + openapi: openapi/openapi.json + Customer: + docs: >- + Represents a Square customer profile in the Customer Directory of a Square + seller. + properties: + id: + type: optional + docs: >- + A unique Square-assigned ID for the customer profile. + + + If you need this ID for an API request, use the ID returned when you + created the customer profile or call the + [SearchCustomers](api-endpoint:Customers-SearchCustomers) + + or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. + created_at: + type: optional + docs: >- + The timestamp when the customer profile was created, in RFC 3339 + format. + access: read-only + updated_at: + type: optional + docs: >- + The timestamp when the customer profile was last updated, in RFC 3339 + format. + access: read-only + given_name: + type: optional> + docs: >- + The given name (that is, the first name) associated with the customer + profile. + family_name: + type: optional> + docs: >- + The family name (that is, the last name) associated with the customer + profile. + nickname: + type: optional> + docs: A nickname for the customer profile. + company_name: + type: optional> + docs: A business name associated with the customer profile. + email_address: + type: optional> + docs: The email address associated with the customer profile. + address: + type: optional
+ docs: The physical address associated with the customer profile. + phone_number: + type: optional> + docs: The phone number associated with the customer profile. + birthday: + type: optional> + docs: >- + The birthday associated with the customer profile, in `YYYY-MM-DD` + format. For example, `1998-09-21` + + represents September 21, 1998, and `0000-09-21` represents September + 21 (without a birth year). + reference_id: + type: optional> + docs: |- + An optional second ID used to associate the customer profile with an + entity in another system. + note: + type: optional> + docs: A custom note associated with the customer profile. + preferences: + type: optional + docs: Represents general customer preferences. + creation_source: + type: optional + docs: >- + The method used to create the customer profile. + + See [CustomerCreationSource](#type-customercreationsource) for + possible values + group_ids: + type: optional>> + docs: >- + The IDs of [customer groups](entity:CustomerGroup) the customer + belongs to. + segment_ids: + type: optional>> + docs: >- + The IDs of [customer segments](entity:CustomerSegment) the customer + belongs to. + version: + type: optional + docs: >- + The Square-assigned version number of the customer profile. The + version number is incremented each time an update is committed to the + customer profile, except for changes to customer segment membership. + tax_ids: + type: optional + docs: >- + The tax ID associated with the customer profile. This field is present + only for customers of sellers in EU countries or the United Kingdom. + + For more information, see [Customer tax + IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + source: + openapi: openapi/openapi.json + CustomerAddressFilter: + docs: >- + The customer address filter. This filter is used in a + [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) + filter when + + searching by an `Address`-type custom attribute. + properties: + postal_code: + type: optional + docs: The postal code to search for. Only an `exact` match is supported. + country: + type: optional + docs: |- + The country code to search for. + See [Country](#type-country) for possible values + source: + openapi: openapi/openapi.json + CustomerCreationSource: + enum: + - OTHER + - APPOINTMENTS + - COUPON + - DELETION_RECOVERY + - DIRECTORY + - EGIFTING + - EMAIL_COLLECTION + - FEEDBACK + - IMPORT + - INVOICES + - LOYALTY + - MARKETING + - MERGE + - ONLINE_STORE + - INSTANT_PROFILE + - TERMINAL + - THIRD_PARTY + - THIRD_PARTY_IMPORT + - UNMERGE_RECOVERY + docs: Indicates the method used to create the customer profile. + source: + openapi: openapi/openapi.json + CustomerCreationSourceFilter: + docs: >- + The creation source filter. + + + If one or more creation sources are set, customer profiles are included + in, + + or excluded from, the result if they match at least one of the filter + criteria. + properties: + values: + type: optional>> + docs: >- + The list of creation sources used as filtering criteria. + + See [CustomerCreationSource](#type-customercreationsource) for + possible values + rule: + type: optional + docs: >- + Indicates whether a customer profile matching the filter criteria + + should be included in the result or excluded from the result. + + + Default: `INCLUDE`. + + See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for + possible values + source: + openapi: openapi/openapi.json + CustomerCustomAttributeFilter: + docs: >- + The custom attribute filter. Use this filter in a set of [custom attribute + filters](entity:CustomerCustomAttributeFilters) to search + + based on the value or last updated date of a customer-related [custom + attribute](entity:CustomAttribute). + properties: + key: + type: string + docs: >- + The `key` of the [custom attribute](entity:CustomAttribute) to filter + by. The key is the identifier of the custom attribute + + (and the corresponding custom attribute definition) and can be + retrieved using the [Customer Custom Attributes + API](api:CustomerCustomAttributes). + filter: + type: optional + docs: >- + A filter that corresponds to the data type of the target custom + attribute. For example, provide the `phone` filter to + + search based on the value of a `PhoneNumber`-type custom attribute. + The data type is specified by the schema field of the custom attribute + definition, + + which can be retrieved using the [Customer Custom Attributes + API](api:CustomerCustomAttributes). + + + You must provide this `filter` field, the `updated_at` field, or both. + updated_at: + type: optional + docs: >- + The date range for when the custom attribute was last updated. The + date range can include `start_at`, `end_at`, or + + both. Range boundaries are inclusive. Dates are specified as RFC 3339 + timestamps. + + + You must provide this `updated_at` field, the `filter` field, or both. + source: + openapi: openapi/openapi.json + CustomerCustomAttributeFilterValue: + docs: >- + A type-specific filter used in a [custom attribute + filter](entity:CustomerCustomAttributeFilter) to search based on the + value + + of a customer-related [custom attribute](entity:CustomAttribute). + properties: + email: + type: optional + docs: >- + A filter for a query based on the value of an `Email`-type custom + attribute. This filter is case-insensitive and can + + include `exact` or `fuzzy`, but not both. + + + For an `exact` match, provide the complete email address. + + + For a `fuzzy` match, provide a query expression containing one or more + query tokens to match against the email address. Square removes + + any punctuation (including periods (.), underscores (_), and the @ + symbol) and tokenizes the email addresses on spaces. A match is found + + if a tokenized email address contains all the tokens in the search + query, irrespective of the token order. For example, `Steven gmail` + + matches steven.jones@gmail.com and mygmail@stevensbakery.com. + phone: + type: optional + docs: >- + A filter for a query based on the value of a `PhoneNumber`-type custom + attribute. This filter is case-insensitive and + + can include `exact` or `fuzzy`, but not both. + + + For an `exact` match, provide the complete phone number. This is + always an E.164-compliant phone number that starts + + with the + sign followed by the country code and subscriber number. + For example, the format for a US phone number is +12061112222. + + + For a `fuzzy` match, provide a query expression containing one or more + query tokens to match against the phone number. + + Square removes any punctuation and tokenizes the expression on spaces. + A match is found if a tokenized phone number contains + + all the tokens in the search query, irrespective of the token order. + For example, `415 123 45` is tokenized to `415`, `123`, and `45`, + + which matches +14151234567 and +12345674158, but does not match + +1234156780. Similarly, the expression `415` matches + + +14151234567, +12345674158, and +1234156780. + text: + type: optional + docs: >- + A filter for a query based on the value of a `String`-type custom + attribute. This filter is case-insensitive and + + can include `exact` or `fuzzy`, but not both. + + + For an `exact` match, provide the complete string. + + + For a `fuzzy` match, provide a query expression containing one or more + query tokens in any order that contain complete words + + to match against the string. Square tokenizes the expression using a + grammar-based tokenizer. For example, the expressions `quick brown`, + + `brown quick`, and `quick fox` match "The quick brown fox jumps over + the lazy dog". However, `quick foxes` and `qui` do not match. + selection: + type: optional + docs: >- + A filter for a query based on the display name for a `Selection`-type + custom attribute value. This filter is case-sensitive + + and can contain `any`, `all`, or both. The `none` condition is not + supported. + + + Provide the display name of each item that you want to search for. To + find the display names for the selection, use the + + [Customer Custom Attributes API](api:CustomerCustomAttributes) to + retrieve the corresponding custom attribute definition + + and then check the `schema.items.names` field. For more information, + see + + [Search based on + selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection). + + + Note that when a `Selection`-type custom attribute is assigned to a + customer profile, the custom attribute value is a list of one + + or more UUIDs (sourced from the `schema.items.enum` field) that map to + the item names. These UUIDs are unique per seller. + date: + type: optional + docs: >- + A filter for a query based on the value of a `Date`-type custom + attribute. + + + Provide a date range for this filter using `start_at`, `end_at`, or + both. Range boundaries are inclusive. Dates can be specified + + in `YYYY-MM-DD` format or as RFC 3339 timestamps. + number: + type: optional + docs: >- + A filter for a query based on the value of a `Number`-type custom + attribute, which can be an integer or a decimal with up to + + 5 digits of precision. + + + Provide a numerical range for this filter using `start_at`, `end_at`, + or both. Range boundaries are inclusive. Numbers are specified + + as decimals or integers. The absolute value of range boundaries must + not exceed `(2^63-1)/10^5`, or 92233720368547. + boolean: + type: optional> + docs: >- + A filter for a query based on the value of a `Boolean`-type custom + attribute. + address: + type: optional + docs: >- + A filter for a query based on the value of an `Address`-type custom + attribute. The filter can include `postal_code`, `country`, or both. + source: + openapi: openapi/openapi.json + CustomerCustomAttributeFilters: + docs: >- + The custom attribute filters in a set of [customer + filters](entity:CustomerFilter) used in a search query. Use this filter + + to search based on [custom attributes](entity:CustomAttribute) that are + assigned to customer profiles. For more information, see + + [Search by custom + attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). + properties: + filters: + type: optional>> + docs: >- + The custom attribute filters. Each filter must specify `key` and + include the `filter` field with a type-specific filter, + + the `updated_at` field, or both. The provided keys must be unique + within the list of custom attribute filters. + source: + openapi: openapi/openapi.json + CustomerDetails: + docs: Details about the customer making the payment. + properties: + customer_initiated: + type: optional> + docs: Indicates whether the customer initiated the payment. + seller_keyed_in: + type: optional> + docs: >- + Indicates that the seller keyed in payment details on behalf of the + customer. + + This is used to flag a payment as Mail Order / Telephone Order (MOTO). + source: + openapi: openapi/openapi.json + CustomerFilter: + docs: >- + Represents the filtering criteria in a [search + query](entity:CustomerQuery) that defines how to filter + + customer profiles returned in + [SearchCustomers](api-endpoint:Customers-SearchCustomers) results. + properties: + creation_source: + type: optional + docs: A filter to select customers based on their creation source. + created_at: + type: optional + docs: A filter to select customers based on when they were created. + updated_at: + type: optional + docs: A filter to select customers based on when they were last updated. + email_address: + type: optional + docs: >- + A filter to [select customers by their email + address](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-email-address) + + visible to the seller. + + This filter is case-insensitive. + + + For [exact + matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-email-address), + this + + filter causes the search to return customer profiles + + whose `email_address` field value are identical to the email address + provided + + in the query. + + + For [fuzzy + matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-email-address), + + this filter causes the search to return customer profiles + + whose `email_address` field value has a token-wise partial match + against the filtering + + expression in the query. For example, with `Steven gmail` provided in + a search + + query, the search returns customers whose email address is + `steven.johnson@gmail.com` + + or `mygmail@stevensbakery.com`. Square removes any punctuation + (including periods (.), + + underscores (_), and the @ symbol) and tokenizes the email addresses + on spaces. A match is + + found if a tokenized email address contains all the tokens in the + search query, + + irrespective of the token order. + phone_number: + type: optional + docs: >- + A filter to [select customers by their phone + numbers](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-phone-number) + + visible to the seller. + + + For [exact + matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-phone-number), + + this filter returns customers whose phone number matches the specified + query expression. The number in the query must be of an + + E.164-compliant form. In particular, it must include the leading `+` + sign followed by a country code and then a subscriber number. + + For example, the standard E.164 form of a US phone number is + `+12062223333` and an E.164-compliant variation is `+1 (206) + 222-3333`. + + To match the query expression, stored customer phone numbers are + converted to the standard E.164 form. + + + For [fuzzy + matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-phone-number), + + this filter returns customers whose phone number matches the token or + tokens provided in the query expression. For example, with `415` + + provided in a search query, the search returns customers with the + phone numbers `+1-415-212-1200`, `+1-212-415-1234`, and `+1 (551) + 234-1567`. + + Similarly, a search query of `415 123` returns customers with the + phone numbers `+1-212-415-1234` and `+1 (551) 234-1567` but not + + `+1-212-415-1200`. A match is found if a tokenized phone number + contains all the tokens in the search query, irrespective of the token + order. + reference_id: + type: optional + docs: >- + A filter to [select customers by their reference + IDs](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-reference-id). + + This filter is case-insensitive. + + + [Exact + matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-reference-id) + + of a customer's reference ID against a query's reference ID is + evaluated as an + + exact match between two strings, character by character in the given + order. + + + [Fuzzy + matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-reference-id) + + of stored reference IDs against queried reference IDs works + + exactly the same as fuzzy matching on email addresses. + Non-alphanumeric characters + + are replaced by spaces to tokenize stored and queried reference IDs. A + match is found + + if a tokenized stored reference ID contains all tokens specified in + any order in the query. For example, + + a query of `NYC M` matches customer profiles with the `reference_id` + value of `NYC_M_35_JOHNSON` + + and `NYC_27_MURRAY`. + group_ids: + type: optional + docs: >- + A filter to select customers based on the + [groups](entity:CustomerGroup) they belong to. + + Group membership is controlled by sellers and developers. + + + The `group_ids` filter has the following syntax: + + ``` + + "group_ids": { + + "any": ["{group_a_id}", "{group_b_id}", ...], + + "all": ["{group_1_id}", "{group_2_id}", ...], + + "none": ["{group_i_id}", "{group_ii_id}", ...] + + } + + ``` + + + You can use any combination of the `any`, `all`, and `none` fields in + the filter. + + With `any`, the search returns customers in groups `a` or `b` or any + other group specified in the list. + + With `all`, the search returns customers in groups `1` and `2` and all + other groups specified in the list. + + With `none`, the search returns customers not in groups `i` or `ii` or + any other group specified in the list. + + + If any of the search conditions are not met, including when an invalid + or non-existent group ID is provided, + + the result is an empty object (`{}`). + custom_attribute: + type: optional + docs: >- + A filter to select customers based on one or more custom attributes. + + This filter can contain up to 10 custom attribute filters. Each custom + attribute filter specifies filtering criteria for a target custom + + attribute. If multiple custom attribute filters are provided, they are + combined as an `AND` operation. + + + To be valid for a search, the custom attributes must be visible to the + requesting application. For more information, including example + queries, + + see [Search by custom + attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). + + + Square returns matching customer profiles, which do not contain custom + attributes. To retrieve customer-related custom attributes, + + use the [Customer Custom Attributes + API](api:CustomerCustomAttributes). For example, you can call + + [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) + using a customer ID from the result set. + segment_ids: + type: optional + docs: >2- + A filter to select customers based on the [segments](entity:CustomerSegment) they belong to. + Segment membership is dynamic and adjusts automatically based on + whether customers meet the segment criteria. + + + You can provide up to three segment IDs in the filter, using any + combination of the `all`, `any`, and `none` fields. + + For the following example, the results include customers who belong to + both segment A and segment B but do not belong to segment C. + + + ``` + + "segment_ids": { + + "all": ["{segment_A_id}", "{segment_B_id}"], + + "none": ["{segment_C_id}"] + + } + + ``` + + + If an invalid or non-existent segment ID is provided in the filter, + Square stops processing the request + + and returns a `400 BAD_REQUEST` error that includes the segment ID. + source: + openapi: openapi/openapi.json + CustomerGroup: + docs: >- + Represents a group of customer profiles. + + + Customer groups can be created, be modified, and have their membership + defined using + + the Customers API or within the Customer Directory in the Square Seller + Dashboard or Point of Sale. + properties: + id: + type: optional + docs: A unique Square-generated ID for the customer group. + validation: + maxLength: 255 + access: read-only + name: + type: string + docs: The name of the customer group. + created_at: + type: optional + docs: The timestamp when the customer group was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: >- + The timestamp when the customer group was last updated, in RFC 3339 + format. + access: read-only + source: + openapi: openapi/openapi.json + CustomerInclusionExclusion: + enum: + - INCLUDE + - EXCLUDE + docs: |- + Indicates whether customers should be included in, or excluded from, + the result set when they match the filtering criteria. + source: + openapi: openapi/openapi.json + CustomerPreferences: + docs: Represents communication preferences for the customer profile. + properties: + email_unsubscribed: + type: optional> + docs: >- + Indicates whether the customer has unsubscribed from marketing + campaign emails. A value of `true` means that the customer chose to + opt out of email marketing from the current Square seller or from all + Square sellers. This value is read-only from the Customers API. + source: + openapi: openapi/openapi.json + CustomerQuery: + docs: >- + Represents filtering and sorting criteria for a + [SearchCustomers](api-endpoint:Customers-SearchCustomers) request. + properties: + filter: + type: optional + docs: >- + The filtering criteria for the search query. A query can contain + multiple filters in any combination. + + Multiple filters are combined as `AND` statements. + + + __Note:__ Combining multiple filters as `OR` statements is not + supported. Instead, send multiple single-filter + + searches and join the result sets. + sort: + type: optional + docs: |- + Sorting criteria for query results. The default behavior is to sort + customers alphabetically by `given_name` and `family_name`. + source: + openapi: openapi/openapi.json + CustomerSegment: + docs: >- + Represents a group of customer profiles that match one or more predefined + filter criteria. + + + Segments (also known as Smart Groups) are defined and created within the + Customer Directory in the + + Square Seller Dashboard or Point of Sale. + properties: + id: + type: optional + docs: A unique Square-generated ID for the segment. + validation: + maxLength: 255 + access: read-only + name: + type: string + docs: The name of the segment. + access: read-only + created_at: + type: optional + docs: The timestamp when the segment was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp when the segment was last updated, in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + CustomerSort: + docs: >- + Represents the sorting criteria in a [search query](entity:CustomerQuery) + that defines how to sort + + customer profiles returned in + [SearchCustomers](api-endpoint:Customers-SearchCustomers) results. + properties: + field: + type: optional + docs: >- + Indicates the fields to use as the sort key, which is either the + default set of fields or `created_at`. + + + The default value is `DEFAULT`. + + See [CustomerSortField](#type-customersortfield) for possible values + order: + type: optional + docs: >- + Indicates the order in which results should be sorted based on the + + sort field value. Strings use standard alphabetic comparison + + to determine order. Strings representing numbers are sorted as + strings. + + + The default value is `ASC`. + + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + CustomerSortField: + enum: + - DEFAULT + - CREATED_AT + docs: >- + Specifies customer attributes as the sort key to customer profiles + returned from a search. + source: + openapi: openapi/openapi.json + CustomerTaxIds: + docs: >- + Represents the tax ID associated with a [customer + profile](entity:Customer). The corresponding `tax_ids` field is available + only for customers of sellers in EU countries or the United Kingdom. + + For more information, see [Customer tax + IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + properties: + eu_vat: + type: optional> + docs: >- + The EU VAT identification number for the customer. For example, + `IE3426675K`. The ID can contain alphanumeric characters only. + validation: + maxLength: 20 + source: + openapi: openapi/openapi.json + CustomerTextFilter: + docs: >- + A filter to select customers based on exact or fuzzy matching of + + customer attributes against a specified query. Depending on the customer + attributes, + + the filter can be case-sensitive. This filter can be exact or fuzzy, but + it cannot be both. + properties: + exact: + type: optional> + docs: >- + Use the exact filter to select customers whose attributes match + exactly the specified query. + fuzzy: + type: optional> + docs: >- + Use the fuzzy filter to select customers whose attributes match the + specified query + + in a fuzzy manner. When the fuzzy option is used, search queries are + tokenized, and then + + each query token must be matched somewhere in the searched attribute. + For single token queries, + + this is effectively the same behavior as a partial match operation. + source: + openapi: openapi/openapi.json + DataCollectionOptions: + properties: + title: + type: string + docs: The title text to display in the data collection flow on the Terminal. + validation: + minLength: 1 + maxLength: 250 + body: + type: string + docs: >- + The body text to display under the title in the data collection screen + flow on the + + Terminal. + validation: + minLength: 1 + maxLength: 10000 + input_type: + type: DataCollectionOptionsInputType + docs: |- + Represents the type of the input text. + See [InputType](#type-inputtype) for possible values + collected_data: + type: optional + docs: The buyer’s input text from the data collection screen. + source: + openapi: openapi/openapi.json + DataCollectionOptionsInputType: + enum: + - EMAIL + - PHONE_NUMBER + docs: Describes the input type of the data. + source: + openapi: openapi/openapi.json + DateRange: + docs: |- + A range defined by two dates. Used for filtering a query for Connect v2 + objects that have date properties. + properties: + start_date: + type: optional> + docs: >- + A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO + 8601 + + extended format for calendar dates. + + The beginning of a date range (inclusive). + end_date: + type: optional> + docs: >- + A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO + 8601 + + extended format for calendar dates. + + The end of a date range (inclusive). + source: + openapi: openapi/openapi.json + DayOfWeek: + enum: + - SUN + - MON + - TUE + - WED + - THU + - FRI + - SAT + docs: Indicates the specific day of the week. + source: + openapi: openapi/openapi.json + DeleteBookingCustomAttributeDefinitionResponse: + docs: >- + Represents a + [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition) + response + + containing error messages when errors occurred during the request. The + successful response does not contain any payload. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteBookingCustomAttributeResponse: + docs: >- + Represents a + [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) + response. + + Either an empty object `{}` (for a successful deletion) or `errors` is + present in the response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteBreakTypeResponse: + docs: >- + The response to a request to delete a `BreakType`. The response might + contain a set + + of `Error` objects if the request resulted in errors. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteCatalogObjectResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + deleted_object_ids: + type: optional> + docs: >- + The IDs of all catalog objects deleted by this request. + + Multiple IDs may be returned when associated objects are also deleted, + for example + + a catalog item variation will be deleted (and its ID included in this + field) + + when its parent catalog item is deleted. + deleted_at: + type: optional + docs: >- + The database + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + source: + openapi: openapi/openapi.json + DeleteCustomerCardResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `DeleteCustomerCard` endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteCustomerCustomAttributeDefinitionResponse: + docs: >- + Represents a response from a delete request containing error messages if + there are any. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteCustomerCustomAttributeResponse: + docs: >- + Represents a + [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute) + response. + + Either an empty object `{}` (for a successful deletion) or `errors` is + present in the response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteCustomerGroupResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) + endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteCustomerResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `DeleteCustomer` endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteDisputeEvidenceResponse: + docs: Defines the fields in a `DeleteDisputeEvidence` response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + DeleteInvoiceAttachmentResponse: + docs: >- + Represents a + [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) + response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + DeleteInvoiceResponse: + docs: Describes a `DeleteInvoice` response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + DeleteLocationCustomAttributeDefinitionResponse: + docs: >- + Represents a response from a delete request containing error messages if + there are any. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteLocationCustomAttributeResponse: + docs: >- + Represents a + [DeleteLocationCustomAttribute](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttribute) + response. + + Either an empty object `{}` (for a successful deletion) or `errors` is + present in the response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteLoyaltyRewardResponse: + docs: A response returned by the API call. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteMerchantCustomAttributeDefinitionResponse: + docs: >- + Represents a response from a delete request containing error messages if + there are any. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteMerchantCustomAttributeResponse: + docs: >- + Represents a + [DeleteMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttribute) + response. + + Either an empty object `{}` (for a successful deletion) or `errors` is + present in the response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteOrderCustomAttributeDefinitionResponse: + docs: Represents a response from deleting an order custom attribute definition. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteOrderCustomAttributeResponse: + docs: Represents a response from deleting an order custom attribute. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeletePaymentLinkResponse: + properties: + errors: optional> + id: + type: optional + docs: The ID of the link that is deleted. + cancelled_order_id: + type: optional + docs: >- + The ID of the order that is canceled. When a payment link is deleted, + Square updates the + + the `state` (of the order that the checkout link created) to CANCELED. + source: + openapi: openapi/openapi.json + DeleteShiftResponse: + docs: >- + The response to a request to delete a `Shift`. The response might contain + a set of + + `Error` objects if the request resulted in errors. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteSnippetResponse: + docs: Represents a `DeleteSnippet` response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + DeleteSubscriptionActionResponse: + docs: >- + Defines output parameters in a response of the + [DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction) + + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The subscription that has the specified action deleted. + source: + openapi: openapi/openapi.json + DeleteWebhookSubscriptionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [DeleteWebhookSubscription](api-endpoint:WebhookSubscriptions-DeleteWebhookSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + source: + openapi: openapi/openapi.json + Destination: + docs: Information about the destination against which the payout was made. + properties: + type: + type: optional + docs: |- + Type of the destination such as a bank account or debit card. + See [DestinationType](#type-destinationtype) for possible values + id: + type: optional + docs: >- + Square issued unique ID (also known as the instrument ID) associated + with this destination. + source: + openapi: openapi/openapi.json + DestinationDetails: + docs: Details about a refund's destination. + properties: + card_details: + type: optional + docs: >- + Details about a card refund. Only populated if the destination_type is + `CARD`. + cash_details: + type: optional + docs: >- + Details about a cash refund. Only populated if the destination_type is + `CASH`. + external_details: + type: optional + docs: >- + Details about an external refund. Only populated if the + destination_type is `EXTERNAL`. + source: + openapi: openapi/openapi.json + DestinationDetailsCardRefundDetails: + properties: + card: + type: optional + docs: The card's non-confidential details. + entry_method: + type: optional> + docs: >- + The method used to enter the card's details for the refund. The method + can be + + `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + validation: + maxLength: 50 + auth_result_code: + type: optional> + docs: >- + The authorization code provided by the issuer when a refund is + approved. + validation: + maxLength: 10 + source: + openapi: openapi/openapi.json + DestinationDetailsCashRefundDetails: + docs: >- + Stores details about a cash refund. Contains only non-confidential + information. + properties: + seller_supplied_money: + type: Money + docs: The amount and currency of the money supplied by the seller. + change_back_money: + type: optional + docs: |- + The amount of change due back to the seller. + This read-only field is calculated + from the `amount_money` and `seller_supplied_money` fields. + source: + openapi: openapi/openapi.json + DestinationDetailsExternalRefundDetails: + docs: >- + Stores details about an external refund. Contains only non-confidential + information. + properties: + type: + type: string + docs: >- + The type of external refund the seller paid to the buyer. It can be + one of the + + following: + + - CHECK - Refunded using a physical check. + + - BANK_TRANSFER - Refunded using external bank transfer. + + - OTHER\_GIFT\_CARD - Refunded using a non-Square gift card. + + - CRYPTO - Refunded using a crypto currency. + + - SQUARE_CASH - Refunded using Square Cash App. + + - SOCIAL - Refunded using peer-to-peer payment applications. + + - EXTERNAL - A third-party application gathered this refund outside of + Square. + + - EMONEY - Refunded using an E-money provider. + + - CARD - A credit or debit card that Square does not support. + + - STORED_BALANCE - Use for house accounts, store credit, and so forth. + + - FOOD_VOUCHER - Restaurant voucher provided by employers to employees + to pay for meals + + - OTHER - A type not listed here. + validation: + maxLength: 50 + source: + type: string + docs: |- + A description of the external refund source. For example, + "Food Delivery Service". + validation: + maxLength: 255 + source_id: + type: optional> + docs: An ID to associate the refund to its originating source. + validation: + maxLength: 255 + source: + openapi: openapi/openapi.json + DestinationType: + enum: + - BANK_ACCOUNT + - CARD + - SQUARE_BALANCE + - SQUARE_STORED_BALANCE + docs: List of possible destinations against which a payout can be made. + source: + openapi: openapi/openapi.json + Device: + properties: + id: + type: optional + docs: >- + A synthetic identifier for the device. The identifier includes a + standardized prefix and + + is otherwise an opaque id generated from key device fields. + access: read-only + attributes: + type: DeviceAttributes + docs: A collection of DeviceAttributes representing the device. + components: + type: optional>> + docs: A list of components applicable to the device. + status: + type: optional + docs: The current status of the device. + source: + openapi: openapi/openapi.json + DeviceAttributes: + properties: + type: + type: DeviceAttributesDeviceType + docs: |- + The device type. + See [DeviceType](#type-devicetype) for possible values + manufacturer: + type: string + docs: The maker of the device. + model: + type: optional> + docs: The specific model of the device. + name: + type: optional> + docs: A seller-specified name for the device. + manufacturers_id: + type: optional> + docs: >- + The manufacturer-supplied identifier for the device (where available). + In many cases, + + this identifier will be a serial number. + updated_at: + type: optional + docs: >- + The RFC 3339-formatted value of the most recent update to the device + information. + + (Could represent any field update on the device.) + version: + type: optional + docs: The current version of software installed on the device. + merchant_token: + type: optional> + docs: The merchant_token identifying the merchant controlling the device. + source: + openapi: openapi/openapi.json + DeviceAttributesDeviceType: + type: literal<"TERMINAL"> + docs: An enum identifier of the device type. + DeviceCheckoutOptions: + properties: + device_id: + type: string + docs: >- + The unique ID of the device intended for this `TerminalCheckout`. + + A list of `DeviceCode` objects can be retrieved from the + /v2/devices/codes endpoint. + + Match a `DeviceCode.device_id` value with `device_id` to get the + associated device code. + skip_receipt_screen: + type: optional> + docs: Instructs the device to skip the receipt screen. Defaults to false. + collect_signature: + type: optional> + docs: >- + Indicates that signature collection is desired during checkout. + Defaults to false. + tip_settings: + type: optional + docs: Tip-specific settings. + show_itemized_cart: + type: optional> + docs: >- + Show the itemization screen prior to taking a payment. This field is + only meaningful when the + + checkout includes an order ID. Defaults to true. + source: + openapi: openapi/openapi.json + DeviceCode: + properties: + id: + type: optional + docs: The unique id for this device code. + access: read-only + name: + type: optional> + docs: An optional user-defined name for the device code. + validation: + maxLength: 128 + code: + type: optional + docs: The unique code that can be used to login. + access: read-only + device_id: + type: optional + docs: >- + The unique id of the device that used this code. Populated when the + device is paired up. + access: read-only + product_type: + type: ProductType + docs: The targeting product type of the device code. + location_id: + type: optional> + docs: The location assigned to this code. + validation: + maxLength: 50 + status: + type: optional + docs: |- + The pairing status of the device code. + See [DeviceCodeStatus](#type-devicecodestatus) for possible values + pair_by: + type: optional + docs: >- + When this DeviceCode will expire and no longer login. Timestamp in RFC + 3339 format. + access: read-only + created_at: + type: optional + docs: When this DeviceCode was created. Timestamp in RFC 3339 format. + access: read-only + status_changed_at: + type: optional + docs: >- + When this DeviceCode's status was last changed. Timestamp in RFC 3339 + format. + access: read-only + paired_at: + type: optional + docs: When this DeviceCode was paired. Timestamp in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + DeviceCodeStatus: + enum: + - UNKNOWN + - UNPAIRED + - PAIRED + - EXPIRED + docs: DeviceCode.Status enum. + source: + openapi: openapi/openapi.json + DeviceComponentDetailsApplicationDetails: + properties: + application_type: + type: optional + docs: |- + The type of application. + See [ApplicationType](#type-applicationtype) for possible values + version: + type: optional + docs: The version of the application. + session_location: + type: optional> + docs: The location_id of the session for the application. + device_code_id: + type: optional> + docs: The id of the device code that was used to log in to the device. + source: + openapi: openapi/openapi.json + DeviceComponentDetailsBatteryDetails: + properties: + visible_percent: + type: optional> + docs: The battery charge percentage as displayed on the device. + external_power: + type: optional + docs: |- + The status of external_power. + See [ExternalPower](#type-externalpower) for possible values + source: + openapi: openapi/openapi.json + DeviceComponentDetailsCardReaderDetails: + properties: + version: + type: optional + docs: The version of the card reader. + source: + openapi: openapi/openapi.json + DeviceComponentDetailsEthernetDetails: + properties: + active: + type: optional> + docs: >- + A boolean to represent whether the Ethernet interface is currently + active. + ip_address_v4: + type: optional> + docs: The string representation of the device’s IPv4 address. + source: + openapi: openapi/openapi.json + DeviceComponentDetailsExternalPower: + enum: + - AVAILABLE_CHARGING + - AVAILABLE_NOT_IN_USE + - UNAVAILABLE + - AVAILABLE_INSUFFICIENT + docs: An enum for ExternalPower. + source: + openapi: openapi/openapi.json + DeviceComponentDetailsMeasurement: + docs: A value qualified by unit of measure. + properties: + value: optional> + source: + openapi: openapi/openapi.json + DeviceComponentDetailsWiFiDetails: + properties: + active: + type: optional> + docs: A boolean to represent whether the WiFI interface is currently active. + ssid: + type: optional> + docs: The name of the connected WIFI network. + ip_address_v4: + type: optional> + docs: The string representation of the device’s IPv4 address. + secure_connection: + type: optional> + docs: >- + The security protocol for a secure connection (e.g. WPA2). None + provided if the connection + + is unsecured. + signal_strength: + type: optional + docs: A representation of signal strength of the WIFI network connection. + source: + openapi: openapi/openapi.json + DeviceDetails: + docs: Details about the device that took the payment. + properties: + device_id: + type: optional> + docs: The Square-issued ID of the device. + validation: + maxLength: 255 + device_installation_id: + type: optional> + docs: The Square-issued installation ID for the device. + validation: + maxLength: 255 + device_name: + type: optional> + docs: The name of the device set by the seller. + validation: + maxLength: 255 + source: + openapi: openapi/openapi.json + DeviceMetadata: + properties: + battery_percentage: + type: optional> + docs: The Terminal’s remaining battery percentage, between 1-100. + charging_state: + type: optional> + docs: |- + The current charging state of the Terminal. + Options: `CHARGING`, `NOT_CHARGING` + location_id: + type: optional> + docs: >- + The ID of the Square seller business location associated with the + Terminal. + merchant_id: + type: optional> + docs: >- + The ID of the Square merchant account that is currently signed-in to + the Terminal. + network_connection_type: + type: optional> + docs: |- + The Terminal’s current network connection type. + Options: `WIFI`, `ETHERNET` + payment_region: + type: optional> + docs: The country in which the Terminal is authorized to take payments. + serial_number: + type: optional> + docs: >- + The unique identifier assigned to the Terminal, which can be found on + the lower back + + of the device. + os_version: + type: optional> + docs: The current version of the Terminal’s operating system. + app_version: + type: optional> + docs: The current version of the application running on the Terminal. + wifi_network_name: + type: optional> + docs: The name of the Wi-Fi network to which the Terminal is connected. + wifi_network_strength: + type: optional> + docs: |- + The signal strength of the Wi-FI network connection. + Options: `POOR`, `FAIR`, `GOOD`, `EXCELLENT` + ip_address: + type: optional> + docs: The IP address of the Terminal. + source: + openapi: openapi/openapi.json + DeviceStatus: + properties: + category: + type: optional + docs: |- + + See [Category](#type-category) for possible values + source: + openapi: openapi/openapi.json + DeviceStatusCategory: + enum: + - AVAILABLE + - NEEDS_ATTENTION + - OFFLINE + source: + openapi: openapi/openapi.json + DigitalWalletDetails: + docs: >- + Additional details about `WALLET` type payments. Contains only + non-confidential information. + properties: + status: + type: optional> + docs: >- + The status of the `WALLET` payment. The status can be `AUTHORIZED`, + `CAPTURED`, `VOIDED`, or + + `FAILED`. + validation: + maxLength: 50 + brand: + type: optional> + docs: >- + The brand used for the `WALLET` payment. The brand can be `CASH_APP`, + `PAYPAY`, `ALIPAY`, + + `RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or + `UNKNOWN`. + validation: + maxLength: 50 + cash_app_details: + type: optional + docs: Brand-specific details for payments with the `brand` of `CASH_APP`. + source: + openapi: openapi/openapi.json + DisableCardResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [DisableCard](api-endpoint:Cards-DisableCard) endpoint. + + + Note: if there are errors processing the request, the card field will not + be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + card: + type: optional + docs: The retrieved card. + source: + openapi: openapi/openapi.json + DisableEventsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [DisableEvents](api-endpoint:Events-DisableEvents) + endpoint. + + + Note: if there are errors processing the request, the events field will + not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + source: + openapi: openapi/openapi.json + DismissTerminalActionResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + action: + type: optional + docs: Current state of the action to be dismissed. + source: + openapi: openapi/openapi.json + DismissTerminalCheckoutResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + checkout: + type: optional + docs: Current state of the checkout to be dismissed. + source: + openapi: openapi/openapi.json + DismissTerminalRefundResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + refund: + type: optional + docs: Current state of the refund to be dismissed. + source: + openapi: openapi/openapi.json + Dispute: + docs: >- + Represents a + [dispute](https://developer.squareup.com/docs/disputes-api/overview) a + cardholder initiated with their bank. + properties: + dispute_id: + type: optional> + docs: The unique ID for this `Dispute`, generated by Square. + validation: + minLength: 1 + maxLength: 40 + id: + type: optional + docs: The unique ID for this `Dispute`, generated by Square. + validation: + minLength: 1 + maxLength: 40 + amount_money: + type: optional + docs: >- + The disputed amount, which can be less than the total transaction + amount. + + For instance, if multiple items were purchased but the cardholder only + initiates a dispute over some of the items. + reason: + type: optional + docs: |- + The reason why the cardholder initiated the dispute. + See [DisputeReason](#type-disputereason) for possible values + state: + type: optional + docs: |- + The current state of this dispute. + See [DisputeState](#type-disputestate) for possible values + due_at: + type: optional> + docs: >- + The deadline by which the seller must respond to the dispute, in [RFC + 3339 + format](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates). + validation: + minLength: 1 + maxLength: 40 + disputed_payment: + type: optional + docs: The payment challenged in this dispute. + evidence_ids: + type: optional>> + docs: The IDs of the evidence associated with the dispute. + card_brand: + type: optional + docs: |- + The card brand used in the disputed payment. + See [CardBrand](#type-cardbrand) for possible values + created_at: + type: optional + docs: The timestamp when the dispute was created, in RFC 3339 format. + validation: + minLength: 1 + maxLength: 40 + access: read-only + updated_at: + type: optional + docs: The timestamp when the dispute was last updated, in RFC 3339 format. + validation: + minLength: 1 + maxLength: 40 + access: read-only + brand_dispute_id: + type: optional> + docs: >- + The ID of the dispute in the card brand system, generated by the card + brand. + validation: + minLength: 1 + maxLength: 40 + reported_date: + type: optional> + docs: The timestamp when the dispute was reported, in RFC 3339 format. + validation: + minLength: 1 + maxLength: 40 + reported_at: + type: optional> + docs: The timestamp when the dispute was reported, in RFC 3339 format. + validation: + minLength: 1 + maxLength: 40 + version: + type: optional + docs: The current version of the `Dispute`. + location_id: + type: optional> + docs: The ID of the location where the dispute originated. + validation: + minLength: 1 + maxLength: 40 + source: + openapi: openapi/openapi.json + DisputeEvidence: + properties: + evidence_id: + type: optional> + docs: The Square-generated ID of the evidence. + validation: + minLength: 1 + maxLength: 40 + id: + type: optional + docs: The Square-generated ID of the evidence. + validation: + minLength: 1 + maxLength: 40 + dispute_id: + type: optional> + docs: The ID of the dispute the evidence is associated with. + validation: + minLength: 1 + maxLength: 40 + evidence_file: + type: optional + docs: Image, PDF, TXT + evidence_text: + type: optional> + docs: Raw text + validation: + minLength: 1 + maxLength: 500 + uploaded_at: + type: optional> + docs: The time when the evidence was uploaded, in RFC 3339 format. + validation: + minLength: 1 + maxLength: 40 + evidence_type: + type: optional + docs: >- + The type of the evidence. + + See [DisputeEvidenceType](#type-disputeevidencetype) for possible + values + source: + openapi: openapi/openapi.json + DisputeEvidenceFile: + docs: A file to be uploaded as dispute evidence. + properties: + filename: + type: optional> + docs: >- + The file name including the file extension. For example: + "receipt.tiff". + validation: + minLength: 1 + maxLength: 40 + filetype: + type: optional> + docs: >- + Dispute evidence files must be application/pdf, image/heic, + image/heif, image/jpeg, image/png, or image/tiff formats. + validation: + minLength: 1 + maxLength: 40 + source: + openapi: openapi/openapi.json + DisputeEvidenceType: + enum: + - GENERIC_EVIDENCE + - ONLINE_OR_APP_ACCESS_LOG + - AUTHORIZATION_DOCUMENTATION + - CANCELLATION_OR_REFUND_DOCUMENTATION + - CARDHOLDER_COMMUNICATION + - CARDHOLDER_INFORMATION + - PURCHASE_ACKNOWLEDGEMENT + - DUPLICATE_CHARGE_DOCUMENTATION + - PRODUCT_OR_SERVICE_DESCRIPTION + - RECEIPT + - SERVICE_RECEIVED_DOCUMENTATION + - PROOF_OF_DELIVERY_DOCUMENTATION + - RELATED_TRANSACTION_DOCUMENTATION + - REBUTTAL_EXPLANATION + - TRACKING_NUMBER + docs: The type of the dispute evidence. + source: + openapi: openapi/openapi.json + DisputeReason: + enum: + - AMOUNT_DIFFERS + - CANCELLED + - DUPLICATE + - NO_KNOWLEDGE + - NOT_AS_DESCRIBED + - NOT_RECEIVED + - PAID_BY_OTHER_MEANS + - CUSTOMER_REQUESTS_CREDIT + - EMV_LIABILITY_SHIFT + docs: |- + The list of possible reasons why a cardholder might initiate a + dispute with their bank. + source: + openapi: openapi/openapi.json + DisputeState: + enum: + - INQUIRY_EVIDENCE_REQUIRED + - INQUIRY_PROCESSING + - INQUIRY_CLOSED + - EVIDENCE_REQUIRED + - PROCESSING + - WON + - LOST + - ACCEPTED + docs: The list of possible dispute states. + source: + openapi: openapi/openapi.json + DisputedPayment: + docs: The payment the cardholder disputed. + properties: + payment_id: + type: optional> + docs: Square-generated unique ID of the payment being disputed. + validation: + minLength: 1 + maxLength: 192 + source: + openapi: openapi/openapi.json + Employee: + docs: >- + An employee object that is used by the external API. + + + DEPRECATED at version 2020-08-26. Replaced by + [TeamMember](entity:TeamMember). + properties: + id: + type: optional + docs: UUID for this object. + first_name: + type: optional> + docs: The employee's first name. + last_name: + type: optional> + docs: The employee's last name. + email: + type: optional> + docs: The employee's email address + phone_number: + type: optional> + docs: The employee's phone number in E.164 format, i.e. "+12125554250" + location_ids: + type: optional>> + docs: A list of location IDs where this employee has access to. + status: + type: optional + docs: |- + Specifies the status of the employees being fetched. + See [EmployeeStatus](#type-employeestatus) for possible values + is_owner: + type: optional> + docs: |- + Whether this employee is the owner of the merchant. Each merchant + has one owner employee, and that employee has full authority over + the account. + created_at: + type: optional + docs: A read-only timestamp in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: A read-only timestamp in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + EmployeeStatus: + enum: + - ACTIVE + - INACTIVE + docs: >- + The status of the Employee being retrieved. + + + DEPRECATED at version 2020-08-26. Replaced by + [TeamMemberStatus](entity:TeamMemberStatus). + source: + openapi: openapi/openapi.json + EmployeeWage: + docs: >- + The hourly wage rate that an employee earns on a `Shift` for doing the job + specified by the `title` property of this object. Deprecated at version + 2020-08-26. Use [TeamMemberWage](entity:TeamMemberWage). + properties: + id: + type: optional + docs: The UUID for this object. + employee_id: + type: optional> + docs: The `Employee` that this wage is assigned to. + title: + type: optional> + docs: The job title that this wage relates to. + hourly_rate: + type: optional + docs: |- + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + source: + openapi: openapi/openapi.json + EnableEventsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [EnableEvents](api-endpoint:Events-EnableEvents) + endpoint. + + + Note: if there are errors processing the request, the events field will + not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + source: + openapi: openapi/openapi.json + Error: + docs: >- + Represents an error encountered during a request to the Connect API. + + + See [Handling + errors](https://developer.squareup.com/docs/build-basics/handling-errors) + for more information. + properties: + category: + type: ErrorCategory + docs: |- + The high-level category for the error. + See [ErrorCategory](#type-errorcategory) for possible values + code: + type: ErrorCode + docs: |- + The specific code of the error. + See [ErrorCode](#type-errorcode) for possible values + detail: + type: optional + docs: A human-readable description of the error for debugging purposes. + field: + type: optional + docs: |- + The name of the field provided in the original request (if any) that + the error pertains to. + source: + openapi: openapi/openapi.json + ErrorCategory: + enum: + - API_ERROR + - AUTHENTICATION_ERROR + - INVALID_REQUEST_ERROR + - RATE_LIMIT_ERROR + - PAYMENT_METHOD_ERROR + - REFUND_ERROR + - MERCHANT_SUBSCRIPTION_ERROR + - EXTERNAL_VENDOR_ERROR + docs: |- + Indicates which high-level category of error has occurred during a + request to the Connect API. + source: + openapi: openapi/openapi.json + ErrorCode: + enum: + - INTERNAL_SERVER_ERROR + - UNAUTHORIZED + - ACCESS_TOKEN_EXPIRED + - ACCESS_TOKEN_REVOKED + - CLIENT_DISABLED + - FORBIDDEN + - INSUFFICIENT_SCOPES + - APPLICATION_DISABLED + - V1_APPLICATION + - V1_ACCESS_TOKEN + - CARD_PROCESSING_NOT_ENABLED + - MERCHANT_SUBSCRIPTION_NOT_FOUND + - BAD_REQUEST + - MISSING_REQUIRED_PARAMETER + - INCORRECT_TYPE + - INVALID_TIME + - INVALID_TIME_RANGE + - INVALID_VALUE + - INVALID_CURSOR + - UNKNOWN_QUERY_PARAMETER + - CONFLICTING_PARAMETERS + - EXPECTED_JSON_BODY + - INVALID_SORT_ORDER + - VALUE_REGEX_MISMATCH + - VALUE_TOO_SHORT + - VALUE_TOO_LONG + - VALUE_TOO_LOW + - VALUE_TOO_HIGH + - VALUE_EMPTY + - ARRAY_LENGTH_TOO_LONG + - ARRAY_LENGTH_TOO_SHORT + - ARRAY_EMPTY + - EXPECTED_BOOLEAN + - EXPECTED_INTEGER + - EXPECTED_FLOAT + - EXPECTED_STRING + - EXPECTED_OBJECT + - EXPECTED_ARRAY + - EXPECTED_MAP + - EXPECTED_BASE64_ENCODED_BYTE_ARRAY + - INVALID_ARRAY_VALUE + - INVALID_ENUM_VALUE + - INVALID_CONTENT_TYPE + - INVALID_FORM_VALUE + - CUSTOMER_NOT_FOUND + - ONE_INSTRUMENT_EXPECTED + - NO_FIELDS_SET + - TOO_MANY_MAP_ENTRIES + - MAP_KEY_LENGTH_TOO_SHORT + - MAP_KEY_LENGTH_TOO_LONG + - CUSTOMER_MISSING_NAME + - CUSTOMER_MISSING_EMAIL + - INVALID_PAUSE_LENGTH + - INVALID_DATE + - UNSUPPORTED_COUNTRY + - UNSUPPORTED_CURRENCY + - APPLE_TTP_PIN_TOKEN + - CARD_EXPIRED + - INVALID_EXPIRATION + - INVALID_EXPIRATION_YEAR + - INVALID_EXPIRATION_DATE + - UNSUPPORTED_CARD_BRAND + - UNSUPPORTED_ENTRY_METHOD + - INVALID_ENCRYPTED_CARD + - INVALID_CARD + - PAYMENT_AMOUNT_MISMATCH + - GENERIC_DECLINE + - CVV_FAILURE + - ADDRESS_VERIFICATION_FAILURE + - INVALID_ACCOUNT + - CURRENCY_MISMATCH + - INSUFFICIENT_FUNDS + - INSUFFICIENT_PERMISSIONS + - CARDHOLDER_INSUFFICIENT_PERMISSIONS + - INVALID_LOCATION + - TRANSACTION_LIMIT + - VOICE_FAILURE + - PAN_FAILURE + - EXPIRATION_FAILURE + - CARD_NOT_SUPPORTED + - READER_DECLINED + - INVALID_PIN + - MISSING_PIN + - MISSING_ACCOUNT_TYPE + - INVALID_POSTAL_CODE + - INVALID_FEES + - MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED + - PAYMENT_LIMIT_EXCEEDED + - GIFT_CARD_AVAILABLE_AMOUNT + - ACCOUNT_UNUSABLE + - BUYER_REFUSED_PAYMENT + - DELAYED_TRANSACTION_EXPIRED + - DELAYED_TRANSACTION_CANCELED + - DELAYED_TRANSACTION_CAPTURED + - DELAYED_TRANSACTION_FAILED + - CARD_TOKEN_EXPIRED + - CARD_TOKEN_USED + - AMOUNT_TOO_HIGH + - UNSUPPORTED_INSTRUMENT_TYPE + - REFUND_AMOUNT_INVALID + - REFUND_ALREADY_PENDING + - PAYMENT_NOT_REFUNDABLE + - PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE + - REFUND_ERROR_PAYMENT_NEEDS_COMPLETION + - REFUND_DECLINED + - INSUFFICIENT_PERMISSIONS_FOR_REFUND + - INVALID_CARD_DATA + - SOURCE_USED + - SOURCE_EXPIRED + - UNSUPPORTED_LOYALTY_REWARD_TIER + - LOCATION_MISMATCH + - ORDER_UNPAID_NOT_RETURNABLE + - IDEMPOTENCY_KEY_REUSED + - UNEXPECTED_VALUE + - SANDBOX_NOT_SUPPORTED + - INVALID_EMAIL_ADDRESS + - INVALID_PHONE_NUMBER + - CHECKOUT_EXPIRED + - BAD_CERTIFICATE + - INVALID_SQUARE_VERSION_FORMAT + - API_VERSION_INCOMPATIBLE + - CARD_PRESENCE_REQUIRED + - UNSUPPORTED_SOURCE_TYPE + - CARD_MISMATCH + - PLAID_ERROR + - PLAID_ERROR_ITEM_LOGIN_REQUIRED + - PLAID_ERROR_RATE_LIMIT + - CARD_DECLINED + - VERIFY_CVV_FAILURE + - VERIFY_AVS_FAILURE + - CARD_DECLINED_CALL_ISSUER + - CARD_DECLINED_VERIFICATION_REQUIRED + - BAD_EXPIRATION + - CHIP_INSERTION_REQUIRED + - ALLOWABLE_PIN_TRIES_EXCEEDED + - RESERVATION_DECLINED + - UNKNOWN_BODY_PARAMETER + - NOT_FOUND + - APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND + - METHOD_NOT_ALLOWED + - NOT_ACCEPTABLE + - REQUEST_TIMEOUT + - CONFLICT + - GONE + - REQUEST_ENTITY_TOO_LARGE + - UNSUPPORTED_MEDIA_TYPE + - UNPROCESSABLE_ENTITY + - RATE_LIMITED + - NOT_IMPLEMENTED + - BAD_GATEWAY + - SERVICE_UNAVAILABLE + - TEMPORARY_ERROR + - GATEWAY_TIMEOUT + docs: |- + Indicates the specific error that occurred during a request to a + Square API. + source: + openapi: openapi/openapi.json + Event: + properties: + merchant_id: + type: optional> + docs: The ID of the target merchant associated with the event. + location_id: + type: optional> + docs: The ID of the target location associated with the event. + type: + type: optional> + docs: The type of event this represents. + event_id: + type: optional> + docs: A unique ID for the event. + created_at: + type: optional + docs: Timestamp of when the event was created, in RFC 3339 format. + access: read-only + data: + type: optional + docs: The data associated with the event. + source: + openapi: openapi/openapi.json + EventData: + properties: + type: + type: optional> + docs: The name of the affected object’s type. + id: + type: optional + docs: The ID of the affected object. + deleted: + type: optional> + docs: >- + This is true if the affected object has been deleted; otherwise, it's + absent. + object: + type: optional>> + docs: >- + An object containing fields and values relevant to the event. It is + absent if the affected object has been deleted. + source: + openapi: openapi/openapi.json + EventMetadata: + docs: Contains metadata about a particular [Event](entity:Event). + properties: + event_id: + type: optional> + docs: A unique ID for the event. + api_version: + type: optional> + docs: >- + The API version of the event. This corresponds to the default API + version of the developer application at the time when the event was + created. + source: + openapi: openapi/openapi.json + EventTypeMetadata: + docs: Contains the metadata of a webhook event type. + properties: + event_type: + type: optional + docs: The event type. + access: read-only + api_version_introduced: + type: optional + docs: The API version at which the event type was introduced. + access: read-only + release_status: + type: optional + docs: The release status of the event type. + access: read-only + source: + openapi: openapi/openapi.json + ExcludeStrategy: + enum: + - LEAST_EXPENSIVE + - MOST_EXPENSIVE + docs: |- + Indicates which products matched by a CatalogPricingRule + will be excluded if the pricing rule uses an exclude set. + source: + openapi: openapi/openapi.json + ExternalPaymentDetails: + docs: >- + Stores details about an external payment. Contains only non-confidential + information. + + For more information, see + + [Take External + Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments). + properties: + type: + type: string + docs: >- + The type of external payment the seller received. It can be one of the + following: + + - CHECK - Paid using a physical check. + + - BANK_TRANSFER - Paid using external bank transfer. + + - OTHER\_GIFT\_CARD - Paid using a non-Square gift card. + + - CRYPTO - Paid using a crypto currency. + + - SQUARE_CASH - Paid using Square Cash App. + + - SOCIAL - Paid using peer-to-peer payment applications. + + - EXTERNAL - A third-party application gathered this payment outside + of Square. + + - EMONEY - Paid using an E-money provider. + + - CARD - A credit or debit card that Square does not support. + + - STORED_BALANCE - Use for house accounts, store credit, and so forth. + + - FOOD_VOUCHER - Restaurant voucher provided by employers to employees + to pay for meals + + - OTHER - A type not listed here. + validation: + maxLength: 50 + source: + type: string + docs: |- + A description of the external payment source. For example, + "Food Delivery Service". + validation: + maxLength: 255 + source_id: + type: optional> + docs: An ID to associate the payment to its originating source. + validation: + maxLength: 255 + source_fee_money: + type: optional + docs: |- + The fees paid to the source. The `amount_money` minus this field is + the net amount seller receives. + source: + openapi: openapi/openapi.json + FilterValue: + docs: >- + A filter to select resources based on an exact field value. For any given + + value, the value can only be in one property. Depending on the field, + either + + all properties can be set or only a subset will be available. + + + Refer to the documentation of the field. + properties: + all: + type: optional>> + docs: A list of terms that must be present on the field of the resource. + any: + type: optional>> + docs: |- + A list of terms where at least one of them must be present on the + field of the resource. + none: + type: optional>> + docs: A list of terms that must not be present on the field the resource + source: + openapi: openapi/openapi.json + FloatNumberRange: + docs: Specifies a decimal number range. + properties: + start_at: + type: optional> + docs: A decimal value indicating where the range starts. + end_at: + type: optional> + docs: A decimal value indicating where the range ends. + source: + openapi: openapi/openapi.json + Fulfillment: + docs: >- + Contains details about how to fulfill this order. + + Orders can only be created with at most one fulfillment using the API. + + However, orders returned by the Orders API might contain multiple + fulfillments because sellers can create multiple fulfillments using Square + products such as Square Online. + properties: + uid: + type: optional> + docs: A unique ID that identifies the fulfillment only within this order. + validation: + maxLength: 60 + type: + type: optional + docs: |- + The type of the fulfillment. + See [FulfillmentType](#type-fulfillmenttype) for possible values + state: + type: optional + docs: |- + The state of the fulfillment. + See [FulfillmentState](#type-fulfillmentstate) for possible values + line_item_application: + type: optional + docs: >- + Describes what order line items this fulfillment applies to. + + It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment + entries. + + See + [FulfillmentFulfillmentLineItemApplication](#type-fulfillmentfulfillmentlineitemapplication) + for possible values + entries: + type: optional> + docs: >- + A list of entries pertaining to the fulfillment of an order. Each + entry must reference + + a valid `uid` for an order line item in the `line_item_uid` field, as + well as a `quantity` to + + fulfill. + + + Multiple entries can reference the same line item `uid`, as long as + the total quantity among + + all fulfillment entries referencing a single line item does not exceed + the quantity of the + + order's line item itself. + + + An order cannot be marked as `COMPLETED` before all fulfillments are + `COMPLETED`, + + `CANCELED`, or `FAILED`. Fulfillments can be created and completed + independently + + before order completion. + access: read-only + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this fulfillment. Metadata fields + are intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + pickup_details: + type: optional + docs: >- + Contains details for a pickup fulfillment. These details are required + when the fulfillment + + type is `PICKUP`. + shipment_details: + type: optional + docs: >- + Contains details for a shipment fulfillment. These details are + required when the fulfillment type + + is `SHIPMENT`. + + + A shipment fulfillment's relationship to fulfillment `state`: + + `PROPOSED`: A shipment is requested. + + `RESERVED`: Fulfillment in progress. Shipment processing. + + `PREPARED`: Shipment packaged. Shipping label created. + + `COMPLETED`: Package has been shipped. + + `CANCELED`: Shipment has been canceled. + + `FAILED`: Shipment has failed. + delivery_details: + type: optional + docs: Describes delivery details of an order fulfillment. + source: + openapi: openapi/openapi.json + FulfillmentDeliveryDetails: + docs: Describes delivery details of an order fulfillment. + properties: + recipient: + type: optional + docs: The contact information for the person to receive the fulfillment. + schedule_type: + type: >- + optional + docs: >- + Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then + + `deliver_at` is required. If `ASAP`, then `prep_time_duration` is + required. The default is `SCHEDULED`. + + See + [OrderFulfillmentDeliveryDetailsScheduleType](#type-orderfulfillmentdeliverydetailsscheduletype) + for possible values + placed_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was placed. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + + + Must be in RFC 3339 timestamp format, e.g., + "2016-09-04T23:59:33.123Z". + access: read-only + deliver_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + that represents the start of the delivery period. + + When the fulfillment `schedule_type` is `ASAP`, the field is + automatically + + set to the current time plus the `prep_time_duration`. + + Otherwise, the application can set this field while the fulfillment + `state` is + + `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the + + terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`). + + + The timestamp must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + prep_time_duration: + type: optional> + docs: |- + The duration of time it takes to prepare and deliver this fulfillment. + The duration must be in RFC 3339 format (for example, "P1W3D"). + delivery_window_duration: + type: optional> + docs: >- + The time period after `deliver_at` in which to deliver the order. + + Applications can set this field when the fulfillment `state` is + + `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal + state + + such as `COMPLETED`, `CANCELED`, and `FAILED`). + + + The duration must be in RFC 3339 format (for example, "P1W3D"). + note: + type: optional> + docs: >- + Provides additional instructions about the delivery fulfillment. + + It is displayed in the Square Point of Sale application and set by the + API. + validation: + maxLength: 550 + completed_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicates when the seller completed the fulfillment. + + This field is automatically set when fulfillment `state` changes to + `COMPLETED`. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + in_progress_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicates when the seller started processing the fulfillment. + + This field is automatically set when the fulfillment `state` changes + to `RESERVED`. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + access: read-only + rejected_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was rejected. This field is + + automatically set when the fulfillment `state` changes to `FAILED`. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + access: read-only + ready_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the seller marked the fulfillment as ready for + + courier pickup. This field is automatically set when the fulfillment + `state` changes + + to PREPARED. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + access: read-only + delivered_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was delivered to the recipient. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + access: read-only + canceled_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was canceled. This field is + automatically + + set when the fulfillment `state` changes to `CANCELED`. + + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + access: read-only + cancel_reason: + type: optional> + docs: 'The delivery cancellation reason. Max length: 100 characters.' + validation: + maxLength: 100 + courier_pickup_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when an order can be picked up by the courier for delivery. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + courier_pickup_window_duration: + type: optional> + docs: >- + The time period after `courier_pickup_at` in which the courier should + pick up the order. + + The duration must be in RFC 3339 format (for example, "P1W3D"). + is_no_contact_delivery: + type: optional> + docs: Whether the delivery is preferred to be no contact. + dropoff_notes: + type: optional> + docs: >- + A note to provide additional instructions about how to deliver the + order. + validation: + maxLength: 550 + courier_provider_name: + type: optional> + docs: The name of the courier provider. + validation: + maxLength: 255 + courier_support_phone_number: + type: optional> + docs: The support phone number of the courier. + validation: + maxLength: 17 + square_delivery_id: + type: optional> + docs: The identifier for the delivery created by Square. + validation: + maxLength: 50 + external_delivery_id: + type: optional> + docs: >- + The identifier for the delivery created by the third-party courier + service. + validation: + maxLength: 50 + managed_delivery: + type: optional> + docs: >- + The flag to indicate the delivery is managed by a third party (ie + DoorDash), which means + + we may not receive all recipient information for PII purposes. + source: + openapi: openapi/openapi.json + FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType: + enum: + - SCHEDULED + - ASAP + docs: The schedule type of the delivery fulfillment. + source: + openapi: openapi/openapi.json + FulfillmentFulfillmentEntry: + docs: >- + Links an order line item to a fulfillment. Each entry must reference + + a valid `uid` for an order line item in the `line_item_uid` field, as well + as a `quantity` to + + fulfill. + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the fulfillment entry only within this + order. + validation: + maxLength: 60 + line_item_uid: + type: string + docs: The `uid` from the order line item. + validation: + minLength: 1 + quantity: + type: string + docs: >- + The quantity of the line item being fulfilled, formatted as a decimal + number. + + For example, `"3"`. + + + Fulfillments for line items with a `quantity_unit` can have + non-integer quantities. + + For example, `"1.70000"`. + validation: + minLength: 1 + maxLength: 12 + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this fulfillment entry. Metadata + fields are intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + source: + openapi: openapi/openapi.json + FulfillmentFulfillmentLineItemApplication: + enum: + - ALL + - ENTRY_LIST + docs: >- + The `line_item_application` describes what order line items this + fulfillment applies + + to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment + entries. + source: + openapi: openapi/openapi.json + FulfillmentPickupDetails: + docs: Contains details necessary to fulfill a pickup order. + properties: + recipient: + type: optional + docs: >- + Information about the person to pick up this fulfillment from a + physical + + location. + expires_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when this fulfillment expires if it is not marked in + progress. The timestamp must be + + in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The + expiration time can only be set + + up to 7 days in the future. If `expires_at` is not set, any new + payments attached to the order + + are automatically completed. + auto_complete_duration: + type: optional> + docs: >- + The duration of time after which an in progress pickup fulfillment is + automatically moved + + to the `COMPLETED` state. The duration must be in RFC 3339 format (for + example, "P1W3D"). + + + If not set, this pickup fulfillment remains in progress until it is + canceled or completed. + schedule_type: + type: optional + docs: >- + The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. + + See + [FulfillmentPickupDetailsScheduleType](#type-fulfillmentpickupdetailsscheduletype) + for possible values + pickup_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + that represents the start of the pickup window. Must be in RFC 3339 + timestamp format, e.g., + + "2016-09-04T23:59:33.123Z". + + + For fulfillments with the schedule type `ASAP`, this is automatically + set + + to the current time plus the expected duration to prepare the + fulfillment. + pickup_window_duration: + type: optional> + docs: >- + The window of time in which the order should be picked up after the + `pickup_at` timestamp. + + Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an + + informational guideline for merchants. + prep_time_duration: + type: optional> + docs: |- + The duration of time it takes to prepare this fulfillment. + The duration must be in RFC 3339 format (for example, "P1W3D"). + note: + type: optional> + docs: >- + A note to provide additional instructions about the pickup + + fulfillment displayed in the Square Point of Sale application and set + by the API. + validation: + maxLength: 500 + placed_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was placed. The timestamp must be in + RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + accepted_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was marked in progress. The timestamp + must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + rejected_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was rejected. The timestamp must be in + RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + ready_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment is marked as ready for pickup. The + timestamp must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + expired_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment expired. The timestamp must be in RFC + 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + picked_up_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was picked up by the recipient. The + timestamp must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + canceled_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the fulfillment was canceled. The timestamp must be in + RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + cancel_reason: + type: optional> + docs: >- + A description of why the pickup was canceled. The maximum length: 100 + characters. + validation: + maxLength: 100 + is_curbside_pickup: + type: optional> + docs: >- + If set to `true`, indicates that this pickup order is for curbside + pickup, not in-store pickup. + curbside_pickup_details: + type: optional + docs: >- + Specific details for curbside pickup. These details can only be + populated if `is_curbside_pickup` is set to `true`. + source: + openapi: openapi/openapi.json + FulfillmentPickupDetailsCurbsidePickupDetails: + docs: Specific details for curbside pickup. + properties: + curbside_details: + type: optional> + docs: >- + Specific details for curbside pickup, such as parking number and + vehicle model. + validation: + maxLength: 250 + buyer_arrived_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the buyer arrived and is waiting for pickup. The + timestamp must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + source: + openapi: openapi/openapi.json + FulfillmentPickupDetailsScheduleType: + enum: + - SCHEDULED + - ASAP + docs: The schedule type of the pickup fulfillment. + source: + openapi: openapi/openapi.json + FulfillmentRecipient: + docs: Information about the fulfillment recipient. + properties: + customer_id: + type: optional> + docs: >- + The ID of the customer associated with the fulfillment. + + + If `customer_id` is provided, the fulfillment recipient's + `display_name`, + + `email_address`, and `phone_number` are automatically populated from + the + + targeted customer profile. If these fields are set in the request, the + request + + values override the information from the customer profile. If the + + targeted customer profile does not contain the necessary information + and + + these fields are left unset, the request results in an error. + validation: + maxLength: 191 + display_name: + type: optional> + docs: >- + The display name of the fulfillment recipient. This field is required. + + + If provided, the display name overrides the corresponding customer + profile value + + indicated by `customer_id`. + validation: + maxLength: 255 + email_address: + type: optional> + docs: >- + The email address of the fulfillment recipient. + + + If provided, the email address overrides the corresponding customer + profile value + + indicated by `customer_id`. + validation: + maxLength: 255 + phone_number: + type: optional> + docs: >- + The phone number of the fulfillment recipient. This field is required. + + + If provided, the phone number overrides the corresponding customer + profile value + + indicated by `customer_id`. + validation: + maxLength: 17 + address: + type: optional
+ docs: >- + The address of the fulfillment recipient. This field is required. + + + If provided, the address overrides the corresponding customer profile + value + + indicated by `customer_id`. + source: + openapi: openapi/openapi.json + FulfillmentShipmentDetails: + docs: Contains the details necessary to fulfill a shipment order. + properties: + recipient: + type: optional + docs: Information about the person to receive this shipment fulfillment. + carrier: + type: optional> + docs: >- + The shipping carrier being used to ship this fulfillment (such as UPS, + FedEx, or USPS). + validation: + maxLength: 50 + shipping_note: + type: optional> + docs: A note with additional information for the shipping carrier. + validation: + maxLength: 500 + shipping_type: + type: optional> + docs: >- + A description of the type of shipping product purchased from the + carrier + + (such as First Class, Priority, or Express). + validation: + maxLength: 50 + tracking_number: + type: optional> + docs: >- + The reference number provided by the carrier to track the shipment's + progress. + validation: + maxLength: 100 + tracking_url: + type: optional> + docs: A link to the tracking webpage on the carrier's website. + validation: + maxLength: 2000 + placed_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the shipment was requested. The timestamp must be in + RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + in_progress_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when this fulfillment was moved to the `RESERVED` state, + which indicates that preparation + + of this shipment has begun. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + packaged_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when this fulfillment was moved to the `PREPARED` state, + which indicates that the + + fulfillment is packaged. The timestamp must be in RFC 3339 format (for + example, "2016-09-04T23:59:33.123Z"). + access: read-only + expected_shipped_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the shipment is expected to be delivered to the + shipping carrier. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + shipped_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when this fulfillment was moved to the `COMPLETED` state, + which indicates that + + the fulfillment has been given to the shipping carrier. The timestamp + must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + canceled_at: + type: optional> + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating the shipment was canceled. + + The timestamp must be in RFC 3339 format (for example, + "2016-09-04T23:59:33.123Z"). + cancel_reason: + type: optional> + docs: A description of why the shipment was canceled. + validation: + maxLength: 100 + failed_at: + type: optional + docs: >- + The + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + + indicating when the shipment failed to be completed. The timestamp + must be in RFC 3339 format + + (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + failure_reason: + type: optional> + docs: A description of why the shipment failed to be completed. + validation: + maxLength: 100 + source: + openapi: openapi/openapi.json + FulfillmentState: + enum: + - PROPOSED + - RESERVED + - PREPARED + - COMPLETED + - CANCELED + - FAILED + docs: The current state of this fulfillment. + source: + openapi: openapi/openapi.json + FulfillmentType: + enum: + - PICKUP + - SHIPMENT + - DELIVERY + docs: The type of fulfillment. + source: + openapi: openapi/openapi.json + GetBankAccountByV1IdResponse: + docs: Response object returned by GetBankAccountByV1Id. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + bank_account: + type: optional + docs: The requested `BankAccount` object. + source: + openapi: openapi/openapi.json + GetBankAccountResponse: + docs: Response object returned by `GetBankAccount`. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + bank_account: + type: optional + docs: The requested `BankAccount` object. + source: + openapi: openapi/openapi.json + GetBreakTypeResponse: + docs: >- + The response to a request to get a `BreakType`. The response contains + + the requested `BreakType` objects and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + break_type: + type: optional + docs: The response object. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetDeviceCodeResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + device_code: + type: optional + docs: The queried DeviceCode. + source: + openapi: openapi/openapi.json + GetDeviceResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + device: + type: optional + docs: The requested `Device`. + source: + openapi: openapi/openapi.json + GetEmployeeWageResponse: + docs: >- + A response to a request to get an `EmployeeWage`. The response contains + + the requested `EmployeeWage` objects and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + employee_wage: + type: optional + docs: The requested `EmployeeWage` object. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetInvoiceResponse: + docs: Describes a `GetInvoice` response. + properties: + invoice: + type: optional + docs: The invoice requested. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + GetPaymentRefundResponse: + docs: >- + Defines the response returned by + [GetRefund](api-endpoint:Refunds-GetPaymentRefund). + + + Note: If there are errors processing the request, the refund field might + not be + + present or it might be present in a FAILED state. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refund: + type: optional + docs: The requested `PaymentRefund`. + source: + openapi: openapi/openapi.json + GetPaymentResponse: + docs: >- + Defines the response returned by + [GetPayment](api-endpoint:Payments-GetPayment). + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + payment: + type: optional + docs: The requested `Payment`. + source: + openapi: openapi/openapi.json + GetPayoutResponse: + properties: + payout: + type: optional + docs: The requested payout. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + GetShiftResponse: + docs: |- + A response to a request to get a `Shift`. The response contains + the requested `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + properties: + shift: + type: optional + docs: The requested `Shift`. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetTeamMemberWageResponse: + docs: >- + A response to a request to get a `TeamMemberWage`. The response contains + + the requested `TeamMemberWage` objects and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + team_member_wage: + type: optional + docs: The requested `TeamMemberWage` object. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetTerminalActionResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + action: + type: optional + docs: The requested `TerminalAction` + source: + openapi: openapi/openapi.json + GetTerminalCheckoutResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + checkout: + type: optional + docs: The requested `TerminalCheckout`. + source: + openapi: openapi/openapi.json + GetTerminalRefundResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refund: + type: optional + docs: The requested `Refund`. + source: + openapi: openapi/openapi.json + GiftCard: + docs: Represents a Square gift card. + properties: + id: + type: optional + docs: The Square-assigned ID of the gift card. + access: read-only + type: + type: GiftCardType + docs: |- + The gift card type. + See [Type](#type-type) for possible values + gan_source: + type: optional + docs: >- + The source that generated the gift card account number (GAN). The + default value is `SQUARE`. + + See [GANSource](#type-gansource) for possible values + state: + type: optional + docs: |- + The current gift card state. + See [Status](#type-status) for possible values + balance_money: + type: optional + docs: >- + The current gift card balance. This balance is always greater than or + equal to zero. + gan: + type: optional> + docs: >- + The gift card account number (GAN). Buyers can use the GAN to make + purchases or check + + the gift card balance. + created_at: + type: optional + docs: >- + The timestamp when the gift card was created, in RFC 3339 format. + + In the case of a digital gift card, it is the time when you create a + card + + (using the Square Point of Sale application, Seller Dashboard, or Gift + Cards API). + + In the case of a plastic gift card, it is the time when Square + associates the card with the + + seller at the time of activation. + access: read-only + customer_ids: + type: optional> + docs: >- + The IDs of the [customer profiles](entity:Customer) to whom this gift + card is linked. + access: read-only + source: + openapi: openapi/openapi.json + GiftCardActivity: + docs: >- + Represents an action performed on a [gift card](entity:GiftCard) that + affects its state or balance. + + A gift card activity contains information about a specific activity type. + For example, a `REDEEM` activity + + includes a `redeem_activity_details` field that contains information about + the redemption. + properties: + id: + type: optional + docs: The Square-assigned ID of the gift card activity. + access: read-only + type: + type: GiftCardActivityType + docs: |- + The type of gift card activity. + See [Type](#type-type) for possible values + location_id: + type: string + docs: >- + The ID of the [business location](entity:Location) where the activity + occurred. + created_at: + type: optional + docs: >- + The timestamp when the gift card activity was created, in RFC 3339 + format. + access: read-only + gift_card_id: + type: optional> + docs: >- + The gift card ID. When creating a gift card activity, `gift_card_id` + is not required if + + `gift_card_gan` is specified. + gift_card_gan: + type: optional> + docs: >- + The gift card account number (GAN). When creating a gift card + activity, `gift_card_gan` + + is not required if `gift_card_id` is specified. + gift_card_balance_money: + type: optional + docs: The final balance on the gift card after the action is completed. + load_activity_details: + type: optional + docs: >- + Additional details about a `LOAD` activity, which is used to reload + money onto a gift card. + activate_activity_details: + type: optional + docs: >- + Additional details about an `ACTIVATE` activity, which is used to + activate a gift card with + + an initial balance. + redeem_activity_details: + type: optional + docs: >- + Additional details about a `REDEEM` activity, which is used to redeem + a gift card for a purchase. + + + For applications that process payments using the Square Payments API, + Square creates a `REDEEM` activity that + + updates the gift card balance after the corresponding + [CreatePayment](api-endpoint:Payments-CreatePayment) + + request is completed. Applications that use a custom payment + processing system must call + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + to create the `REDEEM` activity. + clear_balance_activity_details: + type: optional + docs: >- + Additional details about a `CLEAR_BALANCE` activity, which is used to + set the balance of a gift card to zero. + deactivate_activity_details: + type: optional + docs: >- + Additional details about a `DEACTIVATE` activity, which is used to + deactivate a gift card. + adjust_increment_activity_details: + type: optional + docs: >- + Additional details about an `ADJUST_INCREMENT` activity, which is used + to add money to a gift card + + outside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow. + adjust_decrement_activity_details: + type: optional + docs: >- + Additional details about an `ADJUST_DECREMENT` activity, which is used + to deduct money from a gift + + card outside of a typical `REDEEM` activity flow. + refund_activity_details: + type: optional + docs: >- + Additional details about a `REFUND` activity, which is used to add + money to a gift card when + + refunding a payment. + + + For applications that refund payments to a gift card using the Square + Refunds API, Square automatically + + creates a `REFUND` activity that updates the gift card balance after a + [RefundPayment](api-endpoint:Refunds-RefundPayment) + + request is completed. Applications that use a custom processing system + must call + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + to create the `REFUND` activity. + unlinked_activity_refund_activity_details: + type: optional + docs: >- + Additional details about an `UNLINKED_ACTIVITY_REFUND` activity. This + activity is used to add money + + to a gift card when refunding a payment that was processed using a + custom payment processing system + + and not linked to the gift card. + import_activity_details: + type: optional + docs: >- + Additional details about an `IMPORT` activity, which Square uses to + import a third-party + + gift card with a balance. + block_activity_details: + type: optional + docs: >- + Additional details about a `BLOCK` activity, which Square uses to + temporarily block a gift card. + unblock_activity_details: + type: optional + docs: >- + Additional details about an `UNBLOCK` activity, which Square uses to + unblock a gift card. + import_reversal_activity_details: + type: optional + docs: >- + Additional details about an `IMPORT_REVERSAL` activity, which Square + uses to reverse the + + import of a third-party gift card. + transfer_balance_to_activity_details: + type: optional + docs: >- + Additional details about a `TRANSFER_BALANCE_TO` activity, which + Square uses to add money to + + a gift card as the result of a transfer from another gift card. + transfer_balance_from_activity_details: + type: optional + docs: >- + Additional details about a `TRANSFER_BALANCE_FROM` activity, which + Square uses to deduct money from + + a gift as the result of a transfer to another gift card. + source: + openapi: openapi/openapi.json + GiftCardActivityActivate: + docs: >- + Represents details about an `ACTIVATE` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: optional + docs: >- + The amount added to the gift card. This value is a positive integer. + + + Applications that use a custom order processing system must specify + this amount in the + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + order_id: + type: optional> + docs: >- + The ID of the [order](entity:Order) that contains the `GIFT_CARD` line + item. + + + Applications that use the Square Orders API to process orders must + specify the order ID + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + line_item_uid: + type: optional> + docs: >- + The UID of the `GIFT_CARD` line item in the order that represents the + gift card purchase. + + + Applications that use the Square Orders API to process orders must + specify the line item UID + + in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + reference_id: + type: optional> + docs: >- + A client-specified ID that associates the gift card activity with an + entity in another system. + + + Applications that use a custom order processing system can use this + field to track information + + related to an order or payment. + buyer_payment_instrument_ids: + type: optional>> + docs: >- + The payment instrument IDs used to process the gift card purchase, + such as a credit card ID + + or bank account ID. + + + Applications that use a custom order processing system must specify + payment instrument IDs in + + the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + + Square uses this information to perform compliance checks. + + + For applications that use the Square Orders API to process payments, + Square has the necessary + + instrument IDs to perform compliance checks. + + + Each buyer payment instrument ID can contain a maximum of 255 + characters. + source: + openapi: openapi/openapi.json + GiftCardActivityAdjustDecrement: + docs: >- + Represents details about an `ADJUST_DECREMENT` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: Money + docs: >- + The amount deducted from the gift card balance. This value is a + positive integer. + reason: + type: GiftCardActivityAdjustDecrementReason + docs: |- + The reason the gift card balance was adjusted. + See [Reason](#type-reason) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityAdjustDecrementReason: + enum: + - SUSPICIOUS_ACTIVITY + - BALANCE_ACCIDENTALLY_INCREASED + - SUPPORT_ISSUE + - PURCHASE_WAS_REFUNDED + docs: >- + Indicates the reason for deducting money from a [gift + card](entity:GiftCard). + source: + openapi: openapi/openapi.json + GiftCardActivityAdjustIncrement: + docs: >- + Represents details about an `ADJUST_INCREMENT` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: Money + docs: >- + The amount added to the gift card balance. This value is a positive + integer. + reason: + type: GiftCardActivityAdjustIncrementReason + docs: |- + The reason the gift card balance was adjusted. + See [Reason](#type-reason) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityAdjustIncrementReason: + enum: + - COMPLIMENTARY + - SUPPORT_ISSUE + - TRANSACTION_VOIDED + docs: Indicates the reason for adding money to a [gift card](entity:GiftCard). + source: + openapi: openapi/openapi.json + GiftCardActivityBlock: + docs: >- + Represents details about a `BLOCK` [gift card activity + type](entity:GiftCardActivityType). + properties: + reason: + type: GiftCardActivityBlockReason + docs: |- + The reason the gift card was blocked. + See [Reason](#type-reason) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityBlockReason: + type: literal<"CHARGEBACK_BLOCK"> + docs: Indicates the reason for blocking a [gift card](entity:GiftCard). + GiftCardActivityClearBalance: + docs: >- + Represents details about a `CLEAR_BALANCE` [gift card activity + type](entity:GiftCardActivityType). + properties: + reason: + type: GiftCardActivityClearBalanceReason + docs: |- + The reason the gift card balance was cleared. + See [Reason](#type-reason) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityClearBalanceReason: + enum: + - SUSPICIOUS_ACTIVITY + - REUSE_GIFTCARD + - UNKNOWN_REASON + docs: >- + Indicates the reason for clearing the balance of a [gift + card](entity:GiftCard). + source: + openapi: openapi/openapi.json + GiftCardActivityDeactivate: + docs: >- + Represents details about a `DEACTIVATE` [gift card activity + type](entity:GiftCardActivityType). + properties: + reason: + type: GiftCardActivityDeactivateReason + docs: |- + The reason the gift card was deactivated. + See [Reason](#type-reason) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityDeactivateReason: + enum: + - SUSPICIOUS_ACTIVITY + - UNKNOWN_REASON + - CHARGEBACK_DEACTIVATE + docs: Indicates the reason for deactivating a [gift card](entity:GiftCard). + source: + openapi: openapi/openapi.json + GiftCardActivityImport: + docs: >- + Represents details about an `IMPORT` [gift card activity + type](entity:GiftCardActivityType). + + This activity type is used when Square imports a third-party gift card, in + which case the + + `gan_source` of the gift card is set to `OTHER`. + properties: + amount_money: + type: Money + docs: The balance amount on the imported gift card. + source: + openapi: openapi/openapi.json + GiftCardActivityImportReversal: + docs: >- + Represents details about an `IMPORT_REVERSAL` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: Money + docs: |- + The amount of money cleared from the third-party gift card when + the import was reversed. + source: + openapi: openapi/openapi.json + GiftCardActivityLoad: + docs: >- + Represents details about a `LOAD` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: optional + docs: >- + The amount added to the gift card. This value is a positive integer. + + + Applications that use a custom order processing system must specify + this amount in the + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + order_id: + type: optional> + docs: >- + The ID of the [order](entity:Order) that contains the `GIFT_CARD` line + item. + + + Applications that use the Square Orders API to process orders must + specify the order ID in the + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + line_item_uid: + type: optional> + docs: >- + The UID of the `GIFT_CARD` line item in the order that represents the + additional funds for the gift card. + + + Applications that use the Square Orders API to process orders must + specify the line item UID + + in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + reference_id: + type: optional> + docs: >- + A client-specified ID that associates the gift card activity with an + entity in another system. + + + Applications that use a custom order processing system can use this + field to track information related to + + an order or payment. + buyer_payment_instrument_ids: + type: optional>> + docs: >- + The payment instrument IDs used to process the order for the + additional funds, such as a credit card ID + + or bank account ID. + + + Applications that use a custom order processing system must specify + payment instrument IDs in + + the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + + Square uses this information to perform compliance checks. + + + For applications that use the Square Orders API to process payments, + Square has the necessary + + instrument IDs to perform compliance checks. + + + Each buyer payment instrument ID can contain a maximum of 255 + characters. + source: + openapi: openapi/openapi.json + GiftCardActivityRedeem: + docs: >- + Represents details about a `REDEEM` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: Money + docs: >- + The amount deducted from the gift card for the redemption. This value + is a positive integer. + + + Applications that use a custom payment processing system must specify + this amount in the + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + request. + payment_id: + type: optional + docs: >- + The ID of the payment that represents the gift card redemption. Square + populates this field + + if the payment was processed by Square. + access: read-only + reference_id: + type: optional> + docs: >- + A client-specified ID that associates the gift card activity with an + entity in another system. + + + Applications that use a custom payment processing system can use this + field to track information + + related to an order or payment. + status: + type: optional + docs: >- + The status of the gift card redemption. Gift cards redeemed from + Square Point of Sale or the + + Square Seller Dashboard use a two-state process: `PENDING` + + to `COMPLETED` or `PENDING` to `CANCELED`. Gift cards redeemed using + the Gift Card Activities API + + always have a `COMPLETED` status. + + See [Status](#type-status) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityRedeemStatus: + enum: + - PENDING + - COMPLETED + - CANCELED + docs: >- + Indicates the status of a [gift card](entity:GiftCard) redemption. This + status is relevant only for + + redemptions made from Square products (such as Square Point of Sale) + because Square products use a + + two-state process. Gift cards redeemed using the Gift Card Activities API + always have a `COMPLETED` status. + source: + openapi: openapi/openapi.json + GiftCardActivityRefund: + docs: >- + Represents details about a `REFUND` [gift card activity + type](entity:GiftCardActivityType). + properties: + redeem_activity_id: + type: optional> + docs: >- + The ID of the refunded `REDEEM` gift card activity. Square populates + this field if the + + `payment_id` in the corresponding + [RefundPayment](api-endpoint:Refunds-RefundPayment) request + + represents a gift card redemption. + + + For applications that use a custom payment processing system, this + field is required when creating + + a `REFUND` activity. The provided `REDEEM` activity ID must be linked + to the same gift card. + amount_money: + type: optional + docs: >- + The amount added to the gift card for the refund. This value is a + positive integer. + + + This field is required when creating a `REFUND` activity. The amount + can represent a full or partial refund. + reference_id: + type: optional> + docs: >- + A client-specified ID that associates the gift card activity with an + entity in another system. + payment_id: + type: optional + docs: >- + The ID of the refunded payment. Square populates this field if the + refund is for a + + payment processed by Square. This field matches the `payment_id` in + the corresponding + + [RefundPayment](api-endpoint:Refunds-RefundPayment) request. + access: read-only + source: + openapi: openapi/openapi.json + GiftCardActivityTransferBalanceFrom: + docs: >- + Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity + type](entity:GiftCardActivityType). + properties: + transfer_to_gift_card_id: + type: string + docs: The ID of the gift card to which the specified amount was transferred. + amount_money: + type: Money + docs: >- + The amount deducted from the gift card for the transfer. This value is + a positive integer. + source: + openapi: openapi/openapi.json + GiftCardActivityTransferBalanceTo: + docs: >- + Represents details about a `TRANSFER_BALANCE_TO` [gift card activity + type](entity:GiftCardActivityType). + properties: + transfer_from_gift_card_id: + type: string + docs: >- + The ID of the gift card from which the specified amount was + transferred. + amount_money: + type: Money + docs: >- + The amount added to the gift card balance for the transfer. This value + is a positive integer. + source: + openapi: openapi/openapi.json + GiftCardActivityType: + enum: + - ACTIVATE + - LOAD + - REDEEM + - CLEAR_BALANCE + - DEACTIVATE + - ADJUST_INCREMENT + - ADJUST_DECREMENT + - REFUND + - UNLINKED_ACTIVITY_REFUND + - IMPORT + - BLOCK + - UNBLOCK + - IMPORT_REVERSAL + - TRANSFER_BALANCE_FROM + - TRANSFER_BALANCE_TO + docs: Indicates the type of [gift card activity](entity:GiftCardActivity). + source: + openapi: openapi/openapi.json + GiftCardActivityUnblock: + docs: >- + Represents details about an `UNBLOCK` [gift card activity + type](entity:GiftCardActivityType). + properties: + reason: + type: GiftCardActivityUnblockReason + docs: |- + The reason the gift card was unblocked. + See [Reason](#type-reason) for possible values + source: + openapi: openapi/openapi.json + GiftCardActivityUnblockReason: + type: literal<"CHARGEBACK_UNBLOCK"> + docs: Indicates the reason for unblocking a [gift card](entity:GiftCard). + GiftCardActivityUnlinkedActivityRefund: + docs: >- + Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity + type](entity:GiftCardActivityType). + properties: + amount_money: + type: Money + docs: >- + The amount added to the gift card for the refund. This value is a + positive integer. + reference_id: + type: optional> + docs: >- + A client-specified ID that associates the gift card activity with an + entity in another system. + payment_id: + type: optional + docs: >- + The ID of the refunded payment. This field is not used starting in + Square version 2022-06-16. + access: read-only + source: + openapi: openapi/openapi.json + GiftCardGanSource: + enum: + - SQUARE + - OTHER + docs: |- + Indicates the source that generated the gift card + account number (GAN). + source: + openapi: openapi/openapi.json + GiftCardStatus: + enum: + - ACTIVE + - DEACTIVATED + - BLOCKED + - PENDING + docs: Indicates the gift card state. + source: + openapi: openapi/openapi.json + GiftCardType: + enum: + - PHYSICAL + - DIGITAL + docs: Indicates the gift card type. + source: + openapi: openapi/openapi.json + InventoryAdjustment: + docs: |- + Represents a change in state or quantity of product inventory at a + particular time and location. + properties: + id: + type: optional + docs: |- + A unique ID generated by Square for the + `InventoryAdjustment`. + validation: + maxLength: 100 + reference_id: + type: optional> + docs: |- + An optional ID provided by the application to tie the + `InventoryAdjustment` to an external + system. + validation: + maxLength: 255 + from_state: + type: optional + docs: |- + The [inventory state](entity:InventoryState) of the related quantity + of items before the adjustment. + See [InventoryState](#type-inventorystate) for possible values + to_state: + type: optional + docs: |- + The [inventory state](entity:InventoryState) of the related quantity + of items after the adjustment. + See [InventoryState](#type-inventorystate) for possible values + location_id: + type: optional> + docs: >- + The Square-generated ID of the [Location](entity:Location) where the + related + + quantity of items is being tracked. + validation: + maxLength: 100 + catalog_object_id: + type: optional> + docs: |- + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + validation: + maxLength: 100 + catalog_object_type: + type: optional> + docs: >- + The [type](entity:CatalogObjectType) of the + [CatalogObject](entity:CatalogObject) being tracked. + + + The Inventory API supports setting and reading the + `"catalog_object_type": "ITEM_VARIATION"` field value. + + In addition, it can also read the `"catalog_object_type": "ITEM"` + field value that is set by the Square Restaurants app. + validation: + maxLength: 14 + quantity: + type: optional> + docs: |- + The number of items affected by the adjustment as a decimal string. + Can support up to 5 digits after the decimal point. + validation: + maxLength: 26 + total_price_money: + type: optional + docs: |- + The total price paid for goods associated with the + adjustment. Present if and only if `to_state` is `SOLD`. Always + non-negative. + occurred_at: + type: optional> + docs: >- + A client-generated RFC 3339-formatted timestamp that indicates when + + the inventory adjustment took place. For inventory adjustment updates, + the `occurred_at` + + timestamp cannot be older than 24 hours or in the future relative to + the + + time of the request. + validation: + maxLength: 34 + created_at: + type: optional + docs: >- + An RFC 3339-formatted timestamp that indicates when the inventory + adjustment is received. + validation: + maxLength: 34 + access: read-only + source: + type: optional + docs: |- + Information about the application that caused the + inventory adjustment. + employee_id: + type: optional> + docs: >- + The Square-generated ID of the [Employee](entity:Employee) responsible + for the + + inventory adjustment. + validation: + maxLength: 100 + team_member_id: + type: optional> + docs: >- + The Square-generated ID of the [Team Member](entity:TeamMember) + responsible for the + + inventory adjustment. + validation: + maxLength: 100 + transaction_id: + type: optional + docs: |- + The Square-generated ID of the [Transaction](entity:Transaction) that + caused the adjustment. Only relevant for payment-related state + transitions. + validation: + maxLength: 255 + access: read-only + refund_id: + type: optional + docs: |- + The Square-generated ID of the [Refund](entity:Refund) that + caused the adjustment. Only relevant for refund-related state + transitions. + validation: + maxLength: 255 + access: read-only + purchase_order_id: + type: optional + docs: >- + The Square-generated ID of the purchase order that caused the + + adjustment. Only relevant for state transitions from the Square for + Retail + + app. + validation: + maxLength: 100 + access: read-only + goods_receipt_id: + type: optional + docs: >- + The Square-generated ID of the goods receipt that caused the + + adjustment. Only relevant for state transitions from the Square for + Retail + + app. + validation: + maxLength: 100 + access: read-only + adjustment_group: + type: optional + docs: >- + An adjustment group bundling the related adjustments of item + variations through stock conversions in a single inventory event. + source: + openapi: openapi/openapi.json + InventoryAdjustmentGroup: + properties: + id: + type: optional + docs: |- + A unique ID generated by Square for the + `InventoryAdjustmentGroup`. + validation: + maxLength: 100 + access: read-only + root_adjustment_id: + type: optional + docs: The inventory adjustment of the composed variation. + validation: + maxLength: 100 + access: read-only + from_state: + type: optional + docs: >- + Representative `from_state` for adjustments within the group. For + example, for a group adjustment from `IN_STOCK` to `SOLD`, + + there can be two component adjustments in the group: one from + `IN_STOCK`to `COMPOSED` and the other one from `COMPOSED` to `SOLD`. + + Here, the representative `from_state` for the + `InventoryAdjustmentGroup` is `IN_STOCK`. + + See [InventoryState](#type-inventorystate) for possible values + to_state: + type: optional + docs: >- + Representative `to_state` for adjustments within group. For example, + for a group adjustment from `IN_STOCK` to `SOLD`, + + the two component adjustments in the group can be from `IN_STOCK` to + `COMPOSED` and from `COMPOSED` to `SOLD`. + + Here, the representative `to_state` of the `InventoryAdjustmentGroup` + is `SOLD`. + + See [InventoryState](#type-inventorystate) for possible values + source: + openapi: openapi/openapi.json + InventoryAlertType: + enum: + - NONE + - LOW_QUANTITY + docs: >- + Indicates whether Square should alert the merchant when the inventory + quantity of a CatalogItemVariation is low. + source: + openapi: openapi/openapi.json + InventoryChange: + docs: |- + Represents a single physical count, inventory, adjustment, or transfer + that is part of the history of inventory changes for a particular + [CatalogObject](entity:CatalogObject) instance. + properties: + type: + type: optional + docs: >- + Indicates how the inventory change is applied. See + + [InventoryChangeType](entity:InventoryChangeType) for all possible + values. + + See [InventoryChangeType](#type-inventorychangetype) for possible + values + physical_count: + type: optional + docs: |- + Contains details about the physical count when `type` is + `PHYSICAL_COUNT`, and is unset for all other change types. + adjustment: + type: optional + docs: |- + Contains details about the inventory adjustment when `type` is + `ADJUSTMENT`, and is unset for all other change types. + transfer: + type: optional + docs: >- + Contains details about the inventory transfer when `type` is + + `TRANSFER`, and is unset for all other change types. + + + _Note:_ An [InventoryTransfer](entity:InventoryTransfer) object can + only be set in the input to the + + [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) + endpoint when the seller has an active Retail Plus subscription. + measurement_unit: + type: optional + docs: >- + The [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object + representing the catalog measurement unit associated with the + inventory change. + measurement_unit_id: + type: optional + docs: >- + The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) + object representing the catalog measurement unit associated with the + inventory change. + access: read-only + source: + openapi: openapi/openapi.json + InventoryChangeType: + enum: + - PHYSICAL_COUNT + - ADJUSTMENT + - TRANSFER + docs: >- + Indicates how the inventory change was applied to a tracked product + quantity. + source: + openapi: openapi/openapi.json + InventoryCount: + docs: >- + Represents Square-estimated quantity of items in a particular state at a + + particular seller location based on the known history of physical counts + and + + inventory adjustments. + properties: + catalog_object_id: + type: optional> + docs: |- + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + validation: + maxLength: 100 + catalog_object_type: + type: optional> + docs: >- + The [type](entity:CatalogObjectType) of the + [CatalogObject](entity:CatalogObject) being tracked. + + + The Inventory API supports setting and reading the + `"catalog_object_type": "ITEM_VARIATION"` field value. + + In addition, it can also read the `"catalog_object_type": "ITEM"` + field value that is set by the Square Restaurants app. + validation: + maxLength: 14 + state: + type: optional + docs: |- + The current [inventory state](entity:InventoryState) for the related + quantity of items. + See [InventoryState](#type-inventorystate) for possible values + location_id: + type: optional> + docs: >- + The Square-generated ID of the [Location](entity:Location) where the + related + + quantity of items is being tracked. + validation: + maxLength: 100 + quantity: + type: optional> + docs: >- + The number of items affected by the estimated count as a decimal + string. + + Can support up to 5 digits after the decimal point. + validation: + maxLength: 26 + calculated_at: + type: optional + docs: >- + An RFC 3339-formatted timestamp that indicates when the most recent + physical count or adjustment affecting + + the estimated count is received. + validation: + maxLength: 34 + access: read-only + is_estimated: + type: optional + docs: >- + Whether the inventory count is for composed variation (TRUE) or not + (FALSE). If true, the inventory count will not be present in the + response of + + any of these endpoints: + [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory), + + [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges), + + [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts), + and + + [RetrieveInventoryChanges](api-endpoint:Inventory-RetrieveInventoryChanges). + access: read-only + source: + openapi: openapi/openapi.json + InventoryPhysicalCount: + docs: >- + Represents the quantity of an item variation that is physically present + + at a specific location, verified by a seller or a seller's employee. For + example, + + a physical count might come from an employee counting the item variations + on + + hand or from syncing with an external system. + properties: + id: + type: optional + docs: |- + A unique Square-generated ID for the + [InventoryPhysicalCount](entity:InventoryPhysicalCount). + validation: + maxLength: 100 + reference_id: + type: optional> + docs: |- + An optional ID provided by the application to tie the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external + system. + validation: + maxLength: 255 + catalog_object_id: + type: optional> + docs: |- + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + validation: + maxLength: 100 + catalog_object_type: + type: optional> + docs: >- + The [type](entity:CatalogObjectType) of the + [CatalogObject](entity:CatalogObject) being tracked. + + + The Inventory API supports setting and reading the + `"catalog_object_type": "ITEM_VARIATION"` field value. + + In addition, it can also read the `"catalog_object_type": "ITEM"` + field value that is set by the Square Restaurants app. + validation: + maxLength: 14 + state: + type: optional + docs: |- + The current [inventory state](entity:InventoryState) for the related + quantity of items. + See [InventoryState](#type-inventorystate) for possible values + location_id: + type: optional> + docs: >- + The Square-generated ID of the [Location](entity:Location) where the + related + + quantity of items is being tracked. + validation: + maxLength: 100 + quantity: + type: optional> + docs: >- + The number of items affected by the physical count as a decimal + string. + + The number can support up to 5 digits after the decimal point. + validation: + maxLength: 26 + source: + type: optional + docs: |- + Information about the application with which the + physical count is submitted. + employee_id: + type: optional> + docs: >- + The Square-generated ID of the [Employee](entity:Employee) responsible + for the + + physical count. + validation: + maxLength: 100 + team_member_id: + type: optional> + docs: >- + The Square-generated ID of the [Team Member](entity:TeamMember) + responsible for the + + physical count. + validation: + maxLength: 100 + occurred_at: + type: optional> + docs: >- + A client-generated RFC 3339-formatted timestamp that indicates when + + the physical count was examined. For physical count updates, the + `occurred_at` + + timestamp cannot be older than 24 hours or in the future relative to + the + + time of the request. + validation: + maxLength: 34 + created_at: + type: optional + docs: >- + An RFC 3339-formatted timestamp that indicates when the physical count + is received. + validation: + maxLength: 34 + access: read-only + source: + openapi: openapi/openapi.json + InventoryState: + enum: + - CUSTOM + - IN_STOCK + - SOLD + - RETURNED_BY_CUSTOMER + - RESERVED_FOR_SALE + - SOLD_ONLINE + - ORDERED_FROM_VENDOR + - RECEIVED_FROM_VENDOR + - IN_TRANSIT_TO + - NONE + - WASTE + - UNLINKED_RETURN + - COMPOSED + - DECOMPOSED + - SUPPORTED_BY_NEWER_VERSION + - IN_TRANSIT + docs: Indicates the state of a tracked item quantity in the lifecycle of goods. + source: + openapi: openapi/openapi.json + InventoryTransfer: + docs: |- + Represents the transfer of a quantity of product inventory at a + particular time from one location to another. + properties: + id: + type: optional + docs: |- + A unique ID generated by Square for the + `InventoryTransfer`. + validation: + maxLength: 100 + reference_id: + type: optional> + docs: |- + An optional ID provided by the application to tie the + `InventoryTransfer` to an external system. + validation: + maxLength: 255 + state: + type: optional + docs: |- + The [inventory state](entity:InventoryState) for the quantity of + items being transferred. + See [InventoryState](#type-inventorystate) for possible values + from_location_id: + type: optional> + docs: >- + The Square-generated ID of the [Location](entity:Location) where the + related + + quantity of items was tracked before the transfer. + validation: + maxLength: 100 + to_location_id: + type: optional> + docs: >- + The Square-generated ID of the [Location](entity:Location) where the + related + + quantity of items was tracked after the transfer. + validation: + maxLength: 100 + catalog_object_id: + type: optional> + docs: |- + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + validation: + maxLength: 100 + catalog_object_type: + type: optional> + docs: >- + The [type](entity:CatalogObjectType) of the + [CatalogObject](entity:CatalogObject) being tracked. + + + The Inventory API supports setting and reading the + `"catalog_object_type": "ITEM_VARIATION"` field value. + + In addition, it can also read the `"catalog_object_type": "ITEM"` + field value that is set by the Square Restaurants app. + validation: + maxLength: 14 + quantity: + type: optional> + docs: |- + The number of items affected by the transfer as a decimal string. + Can support up to 5 digits after the decimal point. + validation: + maxLength: 26 + occurred_at: + type: optional> + docs: >- + A client-generated RFC 3339-formatted timestamp that indicates when + + the transfer took place. For write actions, the `occurred_at` + timestamp + + cannot be older than 24 hours or in the future relative to the time of + the + + request. + validation: + maxLength: 34 + created_at: + type: optional + docs: |- + An RFC 3339-formatted timestamp that indicates when Square + received the transfer request. + validation: + maxLength: 34 + access: read-only + source: + type: optional + docs: |- + Information about the application that initiated the + inventory transfer. + employee_id: + type: optional> + docs: >- + The Square-generated ID of the [Employee](entity:Employee) responsible + for the + + inventory transfer. + validation: + maxLength: 100 + team_member_id: + type: optional> + docs: >- + The Square-generated ID of the [Team Member](entity:TeamMember) + responsible for the + + inventory transfer. + validation: + maxLength: 100 + source: + openapi: openapi/openapi.json + Invoice: + docs: >- + Stores information about an invoice. You use the Invoices API to create + and manage + + invoices. For more information, see [Invoices API + Overview](https://developer.squareup.com/docs/invoices-api/overview). + properties: + id: + type: optional + docs: The Square-assigned ID of the invoice. + access: read-only + version: + type: optional + docs: >- + The Square-assigned version number, which is incremented each time an + update is committed to the invoice. + location_id: + type: optional> + docs: >- + The ID of the location that this invoice is associated with. + + + If specified in a `CreateInvoice` request, the value must match the + `location_id` of the associated order. + validation: + minLength: 1 + maxLength: 255 + order_id: + type: optional> + docs: >- + The ID of the [order](entity:Order) for which the invoice is created. + + This field is required when creating an invoice, and the order must be + in the `OPEN` state. + + + To view the line items and other information for the associated order, + call the + + [RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the + order ID. + validation: + minLength: 1 + maxLength: 255 + primary_recipient: + type: optional + docs: >- + The customer who receives the invoice. This customer data is displayed + on the invoice and used by Square to deliver the invoice. + + + This field is required to publish an invoice, and it must specify the + `customer_id`. + payment_requests: + type: optional>> + docs: >- + The payment schedule for the invoice, represented by one or more + payment requests that + + define payment settings, such as amount due and due date. An invoice + supports the following payment request combinations: + + - One balance + + - One deposit with one balance + + - 2–12 installments + + - One deposit with 2–12 installments + + + This field is required when creating an invoice. It must contain at + least one payment request. + + All payment requests for the invoice must equal the total order + amount. For more information, see + + [Configuring payment + requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + + + Adding `INSTALLMENT` payment requests to an invoice requires an + + [Invoices Plus + subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + delivery_method: + type: optional + docs: >- + The delivery method that Square uses to send the invoice, reminders, + and receipts to + + the customer. After the invoice is published, Square processes the + invoice based on the delivery + + method and payment request settings, either immediately or on the + `scheduled_at` date, if specified. + + For example, Square might send the invoice or receipt for an automatic + payment. For invoices with + + automatic payments, this field must be set to `EMAIL`. + + + One of the following is required when creating an invoice: + + - (Recommended) This `delivery_method` field. To configure an + automatic payment, the + + `automatic_payment_source` field of the payment request is also + required. + + - The deprecated `request_method` field of the payment request. Note + that `invoice` + + objects returned in responses do not include `request_method`. + + See [InvoiceDeliveryMethod](#type-invoicedeliverymethod) for possible + values + invoice_number: + type: optional> + docs: >- + A user-friendly invoice number that is displayed on the invoice. The + value is unique within a location. + + If not provided when creating an invoice, Square assigns a value. + + It increments from 1 and is padded with zeros making it 7 characters + long + + (for example, 0000001 and 0000002). + validation: + minLength: 1 + maxLength: 191 + title: + type: optional> + docs: The title of the invoice, which is displayed on the invoice. + validation: + minLength: 1 + maxLength: 255 + description: + type: optional> + docs: The description of the invoice, which is displayed on the invoice. + validation: + minLength: 1 + maxLength: 65536 + scheduled_at: + type: optional> + docs: >- + The timestamp when the invoice is scheduled for processing, in RFC + 3339 format. + + After the invoice is published, Square processes the invoice on the + specified date, + + according to the delivery method and payment request settings. + + + If the field is not set, Square processes the invoice immediately + after it is published. + public_url: + type: optional + docs: >- + A temporary link to the Square-hosted payment page where the customer + can pay the + + invoice. If the link expires, customers can provide the email address + or phone number + + associated with the invoice and request a new link directly from the + expired payment page. + + + This field is added after the invoice is published and reaches the + scheduled date + + (if one is defined). + access: read-only + next_payment_amount_money: + type: optional + docs: >- + The current amount due for the invoice. In addition to the + + amount due on the next payment request, this includes any overdue + payment amounts. + status: + type: optional + docs: |- + The status of the invoice. + See [InvoiceStatus](#type-invoicestatus) for possible values + timezone: + type: optional + docs: >- + The time zone used to interpret calendar dates on the invoice, such as + `due_date`. + + When an invoice is created, this field is set to the `timezone` + specified for the seller + + location. The value cannot be changed. + + + For example, a payment `due_date` of 2021-03-09 with a `timezone` of + America/Los\_Angeles + + becomes overdue at midnight on March 9 in America/Los\_Angeles (which + equals a UTC timestamp + + of 2021-03-10T08:00:00Z). + access: read-only + created_at: + type: optional + docs: The timestamp when the invoice was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp when the invoice was last updated, in RFC 3339 format. + access: read-only + accepted_payment_methods: + type: optional + docs: >- + The payment methods that customers can use to pay the invoice on the + Square-hosted + + invoice page. This setting is independent of any automatic payment + requests for the invoice. + + + This field is required when creating an invoice and must set at least + one payment method to `true`. + custom_fields: + type: optional>> + docs: >- + Additional seller-defined fields that are displayed on the invoice. + For more information, see + + [Custom + fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). + + + Adding custom fields to an invoice requires an + + [Invoices Plus + subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + + + Max: 2 custom fields + subscription_id: + type: optional + docs: >- + The ID of the [subscription](entity:Subscription) associated with the + invoice. + + This field is present only on subscription billing invoices. + access: read-only + sale_or_service_date: + type: optional> + docs: >- + The date of the sale or the date that the service is rendered, in + `YYYY-MM-DD` format. + + This field can be used to specify a past or future date which is + displayed on the invoice. + payment_conditions: + type: optional> + docs: >- + **France only.** The payment terms and conditions that are displayed + on the invoice. For more information, + + see [Payment + conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions). + + + For countries other than France, Square returns an + `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and + + "Payment conditions are not supported for this location's country" + detail if this field is included in `CreateInvoice` or `UpdateInvoice` + requests. + validation: + minLength: 1 + maxLength: 2000 + store_payment_method_enabled: + type: optional> + docs: >- + Indicates whether to allow a customer to save a credit or debit card + as a card on file or a bank transfer as a + + bank account on file. If `true`, Square displays a __Save my card on + file__ or __Save my bank on file__ checkbox on the + + invoice payment page. Stored payment information can be used for + future automatic payments. The default value is `false`. + attachments: + type: optional> + docs: >- + Metadata about the attachments on the invoice. Invoice attachments are + managed using the + + [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) + and + [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) + endpoints. + access: read-only + creator_team_member_id: + type: optional + docs: >- + The ID of the [team member](entity:TeamMember) who created the + invoice. + + This field is present only on invoices created in the Square Dashboard + or Square Invoices app by a logged-in team member. + access: read-only + source: + openapi: openapi/openapi.json + InvoiceAcceptedPaymentMethods: + docs: >- + The payment methods that customers can use to pay an + [invoice](entity:Invoice) on the Square-hosted invoice payment page. + properties: + card: + type: optional> + docs: >- + Indicates whether credit card or debit card payments are accepted. The + default value is `false`. + square_gift_card: + type: optional> + docs: >- + Indicates whether Square gift card payments are accepted. The default + value is `false`. + bank_account: + type: optional> + docs: >- + Indicates whether ACH bank transfer payments are accepted. The default + value is `false`. + buy_now_pay_later: + type: optional> + docs: >- + Indicates whether Afterpay (also known as Clearpay) payments are + accepted. The default value is `false`. + + + This option is allowed only for invoices that have a single payment + request of the `BALANCE` type. This payment method is + + supported if the seller account accepts Afterpay payments and the + seller location is in a country where Afterpay + + invoice payments are supported. As a best practice, consider enabling + an additional payment method when allowing + + `buy_now_pay_later` payments. For more information, including detailed + requirements and processing limits, see + + [Buy Now Pay Later payments with + Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later). + cash_app_pay: + type: optional> + docs: >- + Indicates whether Cash App payments are accepted. The default value is + `false`. + + + This payment method is supported only for seller + [locations](entity:Location) in the United States. + source: + openapi: openapi/openapi.json + InvoiceAttachment: + docs: Represents a file attached to an [invoice](entity:Invoice). + properties: + id: + type: optional + docs: The Square-assigned ID of the attachment. + access: read-only + filename: + type: optional + docs: The file name of the attachment, which is displayed on the invoice. + access: read-only + description: + type: optional + docs: |- + The description of the attachment, which is displayed on the invoice. + This field maps to the seller-defined **Message** field. + access: read-only + filesize: + type: optional + docs: The file size of the attachment in bytes. + access: read-only + hash: + type: optional + docs: The MD5 hash that was generated from the file contents. + access: read-only + mime_type: + type: optional + docs: >- + The mime type of the attachment. + + The following mime types are supported: + + image/gif, image/jpeg, image/png, image/tiff, image/bmp, + application/pdf. + access: read-only + uploaded_at: + type: optional + docs: The timestamp when the attachment was uploaded, in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + InvoiceAutomaticPaymentSource: + enum: + - NONE + - CARD_ON_FILE + - BANK_ON_FILE + docs: >- + Indicates the automatic payment method for an [invoice payment + request](entity:InvoicePaymentRequest). + source: + openapi: openapi/openapi.json + InvoiceCustomField: + docs: >- + An additional seller-defined and customer-facing field to include on the + invoice. For more information, + + see [Custom + fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). + + + Adding custom fields to an invoice requires an + + [Invoices Plus + subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + properties: + label: + type: optional> + docs: >- + The label or title of the custom field. This field is required for a + custom field. + validation: + maxLength: 30 + value: + type: optional> + docs: The text of the custom field. If omitted, only the label is rendered. + validation: + maxLength: 2000 + placement: + type: optional + docs: >- + The location of the custom field on the invoice. This field is + required for a custom field. + + See [InvoiceCustomFieldPlacement](#type-invoicecustomfieldplacement) + for possible values + source: + openapi: openapi/openapi.json + InvoiceCustomFieldPlacement: + enum: + - ABOVE_LINE_ITEMS + - BELOW_LINE_ITEMS + docs: >- + Indicates where to render a custom field on the Square-hosted invoice page + and in emailed or PDF + + copies of the invoice. + source: + openapi: openapi/openapi.json + InvoiceDeliveryMethod: + enum: + - EMAIL + - SHARE_MANUALLY + - SMS + docs: >- + Indicates how Square delivers the [invoice](entity:Invoice) to the + customer. + source: + openapi: openapi/openapi.json + InvoiceFilter: + docs: Describes query filters to apply. + properties: + location_ids: + docs: |- + Limits the search to the specified locations. A location is required. + In the current implementation, only one location can be specified. + type: list + customer_ids: + type: optional>> + docs: >- + Limits the search to the specified customers, within the specified + locations. + + Specifying a customer is optional. In the current implementation, + + a maximum of one customer can be specified. + source: + openapi: openapi/openapi.json + InvoicePaymentReminder: + docs: >- + Describes a payment request reminder (automatic notification) that Square + sends + + to the customer. You configure a reminder relative to the payment request + + `due_date`. + properties: + uid: + type: optional + docs: |- + A Square-assigned ID that uniquely identifies the reminder within the + `InvoicePaymentRequest`. + access: read-only + relative_scheduled_days: + type: optional> + docs: >- + The number of days before (a negative number) or after (a positive + number) + + the payment request `due_date` when the reminder is sent. For example, + -3 indicates that + + the reminder should be sent 3 days before the payment request + `due_date`. + validation: + min: -32767 + max: 32767 + message: + type: optional> + docs: The reminder message. + validation: + minLength: 1 + maxLength: 1000 + status: + type: optional + docs: >- + The status of the reminder. + + See [InvoicePaymentReminderStatus](#type-invoicepaymentreminderstatus) + for possible values + sent_at: + type: optional + docs: If sent, the timestamp when the reminder was sent, in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + InvoicePaymentReminderStatus: + enum: + - PENDING + - NOT_APPLICABLE + - SENT + docs: The status of a payment request reminder. + source: + openapi: openapi/openapi.json + InvoicePaymentRequest: + docs: >- + Represents a payment request for an [invoice](entity:Invoice). Invoices + can specify a maximum + + of 13 payment requests, with up to 12 `INSTALLMENT` request types. For + more information, + + see [Configuring payment + requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + + + Adding `INSTALLMENT` payment requests to an invoice requires an + + [Invoices Plus + subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + properties: + uid: + type: optional> + docs: >- + The Square-generated ID of the payment request in an + [invoice](entity:Invoice). + validation: + minLength: 1 + maxLength: 255 + request_method: + type: optional + docs: >- + Indicates how Square processes the payment request. DEPRECATED at + version 2021-01-21. Replaced by the + + `Invoice.delivery_method` and + `InvoicePaymentRequest.automatic_payment_source` fields. + + + One of the following is required when creating an invoice: + + - (Recommended) The `delivery_method` field of the invoice. To + configure an automatic payment, the + + `automatic_payment_source` field of the payment request is also + required. + + - This `request_method` field. Note that `invoice` objects returned in + responses do not include `request_method`. + + See [InvoiceRequestMethod](#type-invoicerequestmethod) for possible + values + request_type: + type: optional + docs: >- + Identifies the payment request type. This type defines how the payment + request amount is determined. + + This field is required to create a payment request. + + See [InvoiceRequestType](#type-invoicerequesttype) for possible values + due_date: + type: optional> + docs: >- + The due date (in the invoice's time zone) for the payment request, in + `YYYY-MM-DD` format. This field + + is required to create a payment request. If an + `automatic_payment_source` is defined for the request, Square + + charges the payment source on this date. + + + After this date, the invoice becomes overdue. For example, a payment + `due_date` of 2021-03-09 with a `timezone` + + of America/Los\_Angeles becomes overdue at midnight on March 9 in + America/Los\_Angeles (which equals a UTC + + timestamp of 2021-03-10T08:00:00Z). + fixed_amount_requested_money: + type: optional + docs: >- + If the payment request specifies `DEPOSIT` or `INSTALLMENT` as the + `request_type`, + + this indicates the request amount. + + You cannot specify this when `request_type` is `BALANCE` or when the + + payment request includes the `percentage_requested` field. + percentage_requested: + type: optional> + docs: >- + Specifies the amount for the payment request in percentage: + + + - When the payment `request_type` is `DEPOSIT`, it is the percentage + of the order's total amount. + + - When the payment `request_type` is `INSTALLMENT`, it is the + percentage of the order's total less + + the deposit, if requested. The sum of the `percentage_requested` in + all installment + + payment requests must be equal to 100. + + + You cannot specify this when the payment `request_type` is `BALANCE` + or when the + + payment request specifies the `fixed_amount_requested_money` field. + tipping_enabled: + type: optional> + docs: >- + If set to true, the Square-hosted invoice page (the `public_url` field + of the invoice) + + provides a place for the customer to pay a tip. + + + This field is allowed only on the final payment request + + and the payment `request_type` must be `BALANCE` or `INSTALLMENT`. + automatic_payment_source: + type: optional + docs: >- + The payment method for an automatic payment. + + + The default value is `NONE`. + + See + [InvoiceAutomaticPaymentSource](#type-invoiceautomaticpaymentsource) + for possible values + card_id: + type: optional> + docs: >- + The ID of the credit or debit card on file to charge for the payment + request. To get the cards on file for a customer, + + call [ListCards](api-endpoint:Cards-ListCards) and include the + `customer_id` of the invoice recipient. + validation: + minLength: 1 + maxLength: 255 + reminders: + type: optional>> + docs: A list of one or more reminders to send for the payment request. + computed_amount_money: + type: optional + docs: >- + The amount of the payment request, computed using the order amount and + information from the various payment + + request fields (`request_type`, `fixed_amount_requested_money`, and + `percentage_requested`). + total_completed_amount_money: + type: optional + docs: >- + The amount of money already paid for the specific payment request. + + This amount might include a rounding adjustment if the most recent + invoice payment + + was in cash in a currency that rounds cash payments (such as, `CAD` or + `AUD`). + rounding_adjustment_included_money: + type: optional + docs: >- + If the most recent payment was a cash payment + + in a currency that rounds cash payments (such as, `CAD` or `AUD`) and + the payment + + is rounded from `computed_amount_money` in the payment request, then + this + + field specifies the rounding adjustment applied. This amount + + might be negative. + source: + openapi: openapi/openapi.json + InvoiceQuery: + docs: Describes query criteria for searching invoices. + properties: + filter: + type: InvoiceFilter + docs: >- + Query filters to apply in searching invoices. + + For more information, see [Search for + invoices](https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices#search-invoices). + sort: + type: optional + docs: Describes the sort order for the search result. + source: + openapi: openapi/openapi.json + InvoiceRecipient: + docs: >- + Represents a snapshot of customer data. This object stores customer data + that is displayed on the invoice + + and that Square uses to deliver the invoice. + + + When you provide a customer ID for a draft invoice, Square retrieves the + associated customer profile and populates + + the remaining `InvoiceRecipient` fields. You cannot update these fields + after the invoice is published. + + Square updates the customer ID in response to a merge operation, but does + not update other fields. + properties: + customer_id: + type: optional> + docs: |- + The ID of the customer. This is the customer profile ID that + you provide when creating a draft invoice. + validation: + minLength: 1 + maxLength: 255 + given_name: + type: optional + docs: The recipient's given (that is, first) name. + access: read-only + family_name: + type: optional + docs: The recipient's family (that is, last) name. + access: read-only + email_address: + type: optional + docs: The recipient's email address. + access: read-only + address: + type: optional
+ docs: The recipient's physical address. + phone_number: + type: optional + docs: The recipient's phone number. + access: read-only + company_name: + type: optional + docs: The name of the recipient's company. + access: read-only + tax_ids: + type: optional + docs: >- + The recipient's tax IDs. The country of the seller account determines + whether this field + + is available for the customer. For more information, see [Invoice + recipient tax + IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). + source: + openapi: openapi/openapi.json + InvoiceRecipientTaxIds: + docs: >- + Represents the tax IDs for an invoice recipient. The country of the seller + account determines + + whether the corresponding `tax_ids` field is available for the customer. + For more information, + + see [Invoice recipient tax + IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). + properties: + eu_vat: + type: optional + docs: >- + The EU VAT identification number for the invoice recipient. For + example, `IE3426675K`. + access: read-only + source: + openapi: openapi/openapi.json + InvoiceRequestMethod: + enum: + - EMAIL + - CHARGE_CARD_ON_FILE + - SHARE_MANUALLY + - CHARGE_BANK_ON_FILE + - SMS + - SMS_CHARGE_CARD_ON_FILE + - SMS_CHARGE_BANK_ON_FILE + docs: >- + Specifies the action for Square to take for processing the invoice. For + example, + + email the invoice, charge a customer's card on file, or do nothing. + DEPRECATED at + + version 2021-01-21. The corresponding `request_method` field is replaced + by the + + `Invoice.delivery_method` and + `InvoicePaymentRequest.automatic_payment_source` fields. + source: + openapi: openapi/openapi.json + InvoiceRequestType: + enum: + - BALANCE + - DEPOSIT + - INSTALLMENT + docs: >- + Indicates the type of the payment request. For more information, see + + [Configuring payment + requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + source: + openapi: openapi/openapi.json + InvoiceSort: + docs: Identifies the sort field and sort order. + properties: + field: + type: InvoiceSortField + docs: |- + The field to use for sorting. + See [InvoiceSortField](#type-invoicesortfield) for possible values + order: + type: optional + docs: |- + The order to use for sorting the results. + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + InvoiceSortField: + type: literal<"INVOICE_SORT_DATE"> + docs: The field to use for sorting. + InvoiceStatus: + enum: + - DRAFT + - UNPAID + - SCHEDULED + - PARTIALLY_PAID + - PAID + - PARTIALLY_REFUNDED + - REFUNDED + - CANCELED + - FAILED + - PAYMENT_PENDING + docs: Indicates the status of an [invoice](entity:Invoice). + source: + openapi: openapi/openapi.json + ItemVariationLocationOverrides: + docs: >- + Price and inventory alerting overrides for a `CatalogItemVariation` at a + specific `Location`. + properties: + location_id: + type: optional> + docs: >- + The ID of the `Location`. This can include locations that are + deactivated. + price_money: + type: optional + docs: >- + The price of the `CatalogItemVariation` at the given `Location`, or + blank for variable pricing. + pricing_type: + type: optional + docs: >- + The pricing type (fixed or variable) for the `CatalogItemVariation` at + the given `Location`. + + See [CatalogPricingType](#type-catalogpricingtype) for possible values + track_inventory: + type: optional> + docs: >- + If `true`, inventory tracking is active for the `CatalogItemVariation` + at this `Location`. + inventory_alert_type: + type: optional + docs: >- + Indicates whether the `CatalogItemVariation` displays an alert when + its inventory + + quantity is less than or equal to its `inventory_alert_threshold`. + + See [InventoryAlertType](#type-inventoryalerttype) for possible values + inventory_alert_threshold: + type: optional> + docs: >- + If the inventory quantity for the variation is less than or equal to + this value and `inventory_alert_type` + + is `LOW_QUANTITY`, the variation displays an alert in the merchant + dashboard. + + + This value is always an integer. + sold_out: + type: optional + docs: >- + Indicates whether the overridden item variation is sold out at the + specified location. + + + When inventory tracking is enabled on the item variation either + globally or at the specified location, + + the item variation is automatically marked as sold out when its + inventory count reaches zero. The seller + + can manually set the item variation as sold out even when the + inventory count is greater than zero. + + Attempts by an application to set this attribute are ignored. + Regardless how the sold-out status is set, + + applications should treat its inventory count as zero when this + attribute value is `true`. + access: read-only + sold_out_valid_until: + type: optional + docs: >- + The seller-assigned timestamp, of the RFC 3339 format, to indicate + when this sold-out variation + + becomes available again at the specified location. Attempts by an + application to set this attribute are ignored. + + When the current time is later than this attribute value, the affected + item variation is no longer sold out. + access: read-only + source: + openapi: openapi/openapi.json + Job: + docs: >- + Represents a job that can be assigned to [team + members](entity:TeamMember). This object defines the + + job's title and tip eligibility. Compensation is defined in a [job + assignment](entity:JobAssignment) + + in a team member's wage setting. + properties: + id: + type: optional + docs: >- + **Read only** The unique Square-assigned ID of the job. If you need a + job ID for an API request, + + call [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned + when you created the job. + + You can also get job IDs from a team member's wage setting. + title: + type: optional> + docs: The title of the job. + validation: + maxLength: 150 + is_tip_eligible: + type: optional> + docs: Indicates whether team members can earn tips for the job. + created_at: + type: optional + docs: The timestamp when the job was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp when the job was last updated, in RFC 3339 format. + access: read-only + version: + type: optional + docs: >- + **Read only** The current version of the job. Include this field in + `UpdateJob` requests to enable + + [optimistic + concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) + + control and avoid overwrites from concurrent requests. Requests fail + if the provided version doesn't + + match the server version at the time of the request. + source: + openapi: openapi/openapi.json + JobAssignment: + docs: >- + Represents a job assigned to a [team member](entity:TeamMember), including + the compensation the team + + member earns for the job. Job assignments are listed in the team member's + [wage setting](entity:WageSetting). + properties: + job_title: + type: optional> + docs: The title of the job. + pay_type: + type: JobAssignmentPayType + docs: >- + The current pay type for the job assignment used to + + calculate the pay amount in a pay period. + + See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible + values + hourly_rate: + type: optional + docs: >- + The hourly pay rate of the job. For `SALARY` pay types, Square + calculates the hourly rate based on + + `annual_rate` and `weekly_hours`. + annual_rate: + type: optional + docs: >- + The total pay amount for a 12-month period on the job. Set if the job + `PayType` is `SALARY`. + weekly_hours: + type: optional> + docs: >- + The planned hours per week for the job. Set if the job `PayType` is + `SALARY`. + job_id: + type: optional> + docs: The ID of the [job](entity:Job). + source: + openapi: openapi/openapi.json + JobAssignmentPayType: + enum: + - NONE + - HOURLY + - SALARY + docs: Enumerates the possible pay types that a job can be assigned. + source: + openapi: openapi/openapi.json + LinkCustomerToGiftCardResponse: + docs: >- + A response that contains the linked `GiftCard` object. If the request + resulted in errors, + + the response contains a set of `Error` objects. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card: + type: optional + docs: >- + The gift card with the ID of the linked customer listed in the + `customer_ids` field. + source: + openapi: openapi/openapi.json + ListBankAccountsResponse: + docs: Response object returned by ListBankAccounts. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + bank_accounts: + type: optional> + docs: List of BankAccounts associated with this account. + cursor: + type: optional + docs: >- + When a response is truncated, it includes a cursor that you can + + use in a subsequent request to fetch next set of bank accounts. + + If empty, this is the final response. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + source: + openapi: openapi/openapi.json + ListBookingCustomAttributeDefinitionsResponse: + docs: >- + Represents a + [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions) + response. + + Either `custom_attribute_definitions`, an empty object, or `errors` is + present in the response. + + If additional results are available, the `cursor` field is also present + along with `custom_attribute_definitions`. + properties: + custom_attribute_definitions: + type: optional> + docs: >- + The retrieved custom attribute definitions. If no custom attribute + definitions are found, + + Square returns an empty object (`{}`). + cursor: + type: optional + docs: >- + The cursor to provide in your next call to this endpoint to retrieve + the next page of + + results for your original request. This field is present only if the + request succeeded and + + additional results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListBookingCustomAttributesResponse: + docs: >- + Represents a + [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) + response. + + Either `custom_attributes`, an empty object, or `errors` is present in the + response. If additional + + results are available, the `cursor` field is also present along with + `custom_attributes`. + properties: + custom_attributes: + type: optional> + docs: >- + The retrieved custom attributes. If `with_definitions` was set to + `true` in the request, + + the custom attribute definition is returned in the `definition` field + of each custom attribute. + + + If no custom attributes are found, Square returns an empty object + (`{}`). + cursor: + type: optional + docs: >- + The cursor to use in your next call to this endpoint to retrieve the + next page of results + + for your original request. This field is present only if the request + succeeded and additional + + results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListBookingsResponse: + properties: + bookings: + type: optional> + docs: The list of targeted bookings. + cursor: + type: optional + docs: >- + The pagination cursor to be used in the subsequent request to get the + next page of the results. Stop retrieving the next page of the results + when the cursor is not set. + validation: + maxLength: 65536 + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListBreakTypesResponse: + docs: >- + The response to a request for a set of `BreakType` objects. The response + contains + + the requested `BreakType` objects and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + break_types: + type: optional> + docs: ' A page of `BreakType` results.' + cursor: + type: optional + docs: |- + The value supplied in the subsequent request to fetch the next page + of `BreakType` results. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListCardsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [ListCards](api-endpoint:Cards-ListCards) endpoint. + + + Note: if there are errors processing the request, the card field will not + be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + cards: + type: optional> + docs: The requested list of `Card`s. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + source: + openapi: openapi/openapi.json + ListCashDrawerShiftEventsResponse: + properties: + cursor: + type: optional + docs: |- + Opaque cursor for fetching the next page. Cursor is not present in + the last page of results. + errors: + type: optional> + docs: Any errors that occurred during the request. + cash_drawer_shift_events: + type: optional> + docs: |- + All of the events (payments, refunds, etc.) for a cash drawer during + the shift. + source: + openapi: openapi/openapi.json + ListCashDrawerShiftsResponse: + properties: + cursor: + type: optional + docs: |- + Opaque cursor for fetching the next page of results. Cursor is not + present in the last page of results. + errors: + type: optional> + docs: Any errors that occurred during the request. + cash_drawer_shifts: + type: optional> + docs: |- + A collection of CashDrawerShiftSummary objects for shifts that match + the query. + source: + openapi: openapi/openapi.json + ListCatalogResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + objects: + type: optional> + docs: The CatalogObjects returned. + source: + openapi: openapi/openapi.json + ListCustomerCustomAttributeDefinitionsResponse: + docs: >- + Represents a + [ListCustomerCustomAttributeDefinitions](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributeDefinitions) + response. + + Either `custom_attribute_definitions`, an empty object, or `errors` is + present in the response. + + If additional results are available, the `cursor` field is also present + along with `custom_attribute_definitions`. + properties: + custom_attribute_definitions: + type: optional> + docs: >- + The retrieved custom attribute definitions. If no custom attribute + definitions are found, + + Square returns an empty object (`{}`). + cursor: + type: optional + docs: >- + The cursor to provide in your next call to this endpoint to retrieve + the next page of + + results for your original request. This field is present only if the + request succeeded and + + additional results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListCustomerCustomAttributesResponse: + docs: >- + Represents a + [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes) + response. + + Either `custom_attributes`, an empty object, or `errors` is present in the + response. If additional + + results are available, the `cursor` field is also present along with + `custom_attributes`. + properties: + custom_attributes: + type: optional> + docs: >- + The retrieved custom attributes. If `with_definitions` was set to + `true` in the request, + + the custom attribute definition is returned in the `definition` field + of each custom attribute. + + + If no custom attributes are found, Square returns an empty object + (`{}`). + cursor: + type: optional + docs: >- + The cursor to use in your next call to this endpoint to retrieve the + next page of results + + for your original request. This field is present only if the request + succeeded and additional + + results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListCustomerGroupsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [ListCustomerGroups](api-endpoint:CustomerGroups-ListCustomerGroups) + endpoint. + + + Either `errors` or `groups` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + groups: + type: optional> + docs: A list of customer groups belonging to the current seller. + cursor: + type: optional + docs: >- + A pagination cursor to retrieve the next set of results for your + + original query to the endpoint. This value is present only if the + request + + succeeded and additional results are available. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListCustomerSegmentsResponse: + docs: >- + Defines the fields that are included in the response body for requests to + the `ListCustomerSegments` endpoint. + + + Either `errors` or `segments` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + segments: + type: optional> + docs: >- + The list of customer segments belonging to the associated Square + account. + cursor: + type: optional + docs: >- + A pagination cursor to be used in subsequent calls to + `ListCustomerSegments` + + to retrieve the next set of query results. The cursor is only present + if the request succeeded and + + additional results are available. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListCustomersResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the `ListCustomers` endpoint. + + + Either `errors` or `customers` is present in a given response (never + both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + customers: + type: optional> + docs: >- + The customer profiles associated with the Square account or an empty + object (`{}`) if none are found. + + Only customer profiles with public information (`given_name`, + `family_name`, `company_name`, `email_address`, or + + `phone_number`) are included in the response. + cursor: + type: optional + docs: >- + A pagination cursor to retrieve the next set of results for the + + original query. A cursor is only present if the request succeeded and + additional results + + are available. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + count: + type: optional + docs: >- + The total count of customers associated with the Square account. Only + customer profiles with public information + + (`given_name`, `family_name`, `company_name`, `email_address`, or + `phone_number`) are counted. This field is present + + only if `count` is set to `true` in the request. + source: + openapi: openapi/openapi.json + ListDeviceCodesResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + device_codes: + type: optional> + docs: The queried DeviceCode. + cursor: + type: optional + docs: >- + A pagination cursor to retrieve the next set of results for your + + original query to the endpoint. This value is present only if the + request + + succeeded and additional results are available. + + + See [Paginating + results](https://developer.squareup.com/docs/working-with-apis/pagination) + for more information. + source: + openapi: openapi/openapi.json + ListDevicesResponse: + properties: + errors: + type: optional> + docs: Information about errors that occurred during the request. + devices: + type: optional> + docs: The requested list of `Device` objects. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + source: + openapi: openapi/openapi.json + ListDisputeEvidenceResponse: + docs: Defines the fields in a `ListDisputeEvidence` response. + properties: + evidence: + type: optional> + docs: The list of evidence previously uploaded to the specified dispute. + errors: + type: optional> + docs: Information about errors encountered during the request. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. + + If unset, this is the final response. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListDisputesResponse: + docs: Defines fields in a `ListDisputes` response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + disputes: + type: optional> + docs: The list of disputes. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. + + If unset, this is the final response. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListEmployeeWagesResponse: + docs: >- + The response to a request for a set of `EmployeeWage` objects. The + response contains + + a set of `EmployeeWage` objects. + properties: + employee_wages: + type: optional> + docs: A page of `EmployeeWage` results. + cursor: + type: optional + docs: |- + The value supplied in the subsequent request to fetch the next page + of `EmployeeWage` results. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListEmployeesResponse: + properties: + employees: optional> + cursor: + type: optional + docs: The token to be used to retrieve the next page of results. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListEventTypesResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [ListEventTypes](api-endpoint:Events-ListEventTypes) + endpoint. + + + Note: if there are errors processing the request, the event types field + will not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + event_types: + type: optional> + docs: The list of event types. + metadata: + type: optional> + docs: >- + Contains the metadata of an event type. For more information, see + [EventTypeMetadata](entity:EventTypeMetadata). + source: + openapi: openapi/openapi.json + ListGiftCardActivitiesResponse: + docs: >- + A response that contains a list of `GiftCardActivity` objects. If the + request resulted in errors, + + the response contains a set of `Error` objects. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card_activities: + type: optional> + docs: >- + The requested gift card activities or an empty object if none are + found. + cursor: + type: optional + docs: >- + When a response is truncated, it includes a cursor that you can use in + a + + subsequent request to retrieve the next set of activities. If a cursor + is not present, this is + + the final response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + source: + openapi: openapi/openapi.json + ListGiftCardsResponse: + docs: >- + A response that contains a list of `GiftCard` objects. If the request + resulted in errors, + + the response contains a set of `Error` objects. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_cards: + type: optional> + docs: The requested gift cards or an empty object if none are found. + cursor: + type: optional + docs: >- + When a response is truncated, it includes a cursor that you can use in + a + + subsequent request to retrieve the next set of gift cards. If a cursor + is not present, this is + + the final response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + source: + openapi: openapi/openapi.json + ListInvoicesResponse: + docs: Describes a `ListInvoice` response. + properties: + invoices: + type: optional> + docs: The invoices retrieved. + cursor: + type: optional + docs: >- + When a response is truncated, it includes a cursor that you can use in + a + + subsequent request to retrieve the next set of invoices. If empty, + this is the final + + response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + ListJobsResponse: + docs: >- + Represents a [ListJobs](api-endpoint:Team-ListJobs) response. Either + `jobs` or `errors` + + is present in the response. If additional results are available, the + `cursor` field is also present. + properties: + jobs: + type: optional> + docs: The retrieved jobs. A single paged response contains up to 100 jobs. + cursor: + type: optional + docs: >- + An opaque cursor used to retrieve the next page of results. This field + is present only + + if the request succeeded and additional results are available. For + more information, see + + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListLocationBookingProfilesResponse: + properties: + location_booking_profiles: + type: optional> + docs: The list of a seller's location booking profiles. + cursor: + type: optional + docs: >- + The pagination cursor to be used in the subsequent request to get the + next page of the results. Stop retrieving the next page of the results + when the cursor is not set. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListLocationCustomAttributeDefinitionsResponse: + docs: >- + Represents a + [ListLocationCustomAttributeDefinitions](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributeDefinitions) + response. + + Either `custom_attribute_definitions`, an empty object, or `errors` is + present in the response. + + If additional results are available, the `cursor` field is also present + along with `custom_attribute_definitions`. + properties: + custom_attribute_definitions: + type: optional> + docs: >- + The retrieved custom attribute definitions. If no custom attribute + definitions are found, + + Square returns an empty object (`{}`). + cursor: + type: optional + docs: >- + The cursor to provide in your next call to this endpoint to retrieve + the next page of + + results for your original request. This field is present only if the + request succeeded and + + additional results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListLocationCustomAttributesResponse: + docs: >- + Represents a + [ListLocationCustomAttributes](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributes) + response. + + Either `custom_attributes`, an empty object, or `errors` is present in the + response. If additional + + results are available, the `cursor` field is also present along with + `custom_attributes`. + properties: + custom_attributes: + type: optional> + docs: >- + The retrieved custom attributes. If `with_definitions` was set to + `true` in the request, + + the custom attribute definition is returned in the `definition` field + of each custom attribute. + + If no custom attributes are found, Square returns an empty object + (`{}`). + cursor: + type: optional + docs: >- + The cursor to use in your next call to this endpoint to retrieve the + next page of results + + for your original request. This field is present only if the request + succeeded and additional + + results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListLocationsResponse: + docs: >- + Defines the fields that are included in the response body of a request + + to the [ListLocations](api-endpoint:Locations-ListLocations) endpoint. + + + Either `errors` or `locations` is present in a given response (never + both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + locations: + type: optional> + docs: The business locations. + source: + openapi: openapi/openapi.json + ListLoyaltyProgramsResponse: + docs: A response that contains all loyalty programs. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + programs: + type: optional> + docs: A list of `LoyaltyProgram` for the merchant. + source: + openapi: openapi/openapi.json + ListLoyaltyPromotionsResponse: + docs: >- + Represents a + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) + response. + + One of `loyalty_promotions`, an empty object, or `errors` is present in + the response. + + If additional results are available, the `cursor` field is also present + along with `loyalty_promotions`. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_promotions: + type: optional> + docs: The retrieved loyalty promotions. + cursor: + type: optional + docs: >- + The cursor to use in your next call to this endpoint to retrieve the + next page of results + + for your original request. This field is present only if the request + succeeded and additional + + results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListMerchantCustomAttributeDefinitionsResponse: + docs: >- + Represents a + [ListMerchantCustomAttributeDefinitions](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributeDefinitions) + response. + + Either `custom_attribute_definitions`, an empty object, or `errors` is + present in the response. + + If additional results are available, the `cursor` field is also present + along with `custom_attribute_definitions`. + properties: + custom_attribute_definitions: + type: optional> + docs: >- + The retrieved custom attribute definitions. If no custom attribute + definitions are found, + + Square returns an empty object (`{}`). + cursor: + type: optional + docs: >- + The cursor to provide in your next call to this endpoint to retrieve + the next page of + + results for your original request. This field is present only if the + request succeeded and + + additional results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListMerchantCustomAttributesResponse: + docs: >- + Represents a + [ListMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributes) + response. + + Either `custom_attributes`, an empty object, or `errors` is present in the + response. If additional + + results are available, the `cursor` field is also present along with + `custom_attributes`. + properties: + custom_attributes: + type: optional> + docs: >- + The retrieved custom attributes. If `with_definitions` was set to + `true` in the request, + + the custom attribute definition is returned in the `definition` field + of each custom attribute. + + If no custom attributes are found, Square returns an empty object + (`{}`). + cursor: + type: optional + docs: >- + The cursor to use in your next call to this endpoint to retrieve the + next page of results + + for your original request. This field is present only if the request + succeeded and additional + + results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListMerchantsResponse: + docs: >- + The response object returned by the + [ListMerchant](api-endpoint:Merchants-ListMerchants) endpoint. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + merchant: + type: optional> + docs: The requested `Merchant` entities. + cursor: + type: optional + docs: >- + If the response is truncated, the cursor to use in next request to + fetch next set of objects. + source: + openapi: openapi/openapi.json + ListOrderCustomAttributeDefinitionsResponse: + docs: Represents a response from listing order custom attribute definitions. + properties: + custom_attribute_definitions: + docs: >- + The retrieved custom attribute definitions. If no custom attribute + definitions are found, Square returns an empty object (`{}`). + type: list + cursor: + type: optional + docs: >- + The cursor to provide in your next call to this endpoint to retrieve + the next page of results for your original request. + + This field is present only if the request succeeded and additional + results are available. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + validation: + minLength: 1 + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListOrderCustomAttributesResponse: + docs: Represents a response from listing order custom attributes. + properties: + custom_attributes: + type: optional> + docs: >- + The retrieved custom attributes. If no custom attribute are found, + Square returns an empty object (`{}`). + cursor: + type: optional + docs: >- + The cursor to provide in your next call to this endpoint to retrieve + the next page of results for your original request. + + This field is present only if the request succeeded and additional + results are available. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + validation: + minLength: 1 + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListPaymentLinksResponse: + properties: + errors: + type: optional> + docs: Errors that occurred during the request. + payment_links: + type: optional> + docs: The list of payment links. + cursor: + type: optional + docs: >2- + When a response is truncated, it includes a cursor that you can use in a subsequent request + to retrieve the next set of gift cards. If a cursor is not present, + this is the final response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListPaymentRefundsRequestSortField: + enum: + - CREATED_AT + - UPDATED_AT + source: + openapi: openapi/openapi.json + ListPaymentRefundsResponse: + docs: >- + Defines the response returned by + [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds). + + + Either `errors` or `refunds` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refunds: + type: optional> + docs: The list of requested refunds. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListPaymentsRequestSortField: + enum: + - CREATED_AT + - OFFLINE_CREATED_AT + - UPDATED_AT + source: + openapi: openapi/openapi.json + ListPaymentsResponse: + docs: >- + Defines the response returned by + [ListPayments](api-endpoint:Payments-ListPayments). + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + payments: + type: optional> + docs: The requested list of payments. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListPayoutEntriesResponse: + docs: The response to retrieve payout records entries. + properties: + payout_entries: + type: optional> + docs: >- + The requested list of payout entries, ordered with the given or + default sort order. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + ListPayoutsResponse: + docs: The response to retrieve payout records entries. + properties: + payouts: + type: optional> + docs: The requested list of payouts. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + ListSitesResponse: + docs: >- + Represents a `ListSites` response. The response can include either `sites` + or `errors`. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + sites: + type: optional> + docs: The sites that belong to the seller. + source: + openapi: openapi/openapi.json + ListSubscriptionEventsResponse: + docs: >- + Defines output parameters in a response from the + + [ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents). + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription_events: + type: optional> + docs: The retrieved subscription events. + cursor: + type: optional + docs: >- + When the total number of resulting subscription events exceeds the + limit of a paged response, + + the response includes a cursor for you to use in a subsequent request + to fetch the next set of events. + + If the cursor is unset, the response contains the last page of the + results. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListTeamMemberBookingProfilesResponse: + properties: + team_member_booking_profiles: + type: optional> + docs: >- + The list of team member booking profiles. The results are returned in + the ascending order of the time + + when the team member booking profiles were last updated. Multiple + booking profiles updated at the same time + + are further sorted in the ascending order of their IDs. + cursor: + type: optional + docs: >- + The pagination cursor to be used in the subsequent request to get the + next page of the results. Stop retrieving the next page of the results + when the cursor is not set. + validation: + maxLength: 65536 + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListTeamMemberWagesResponse: + docs: >- + The response to a request for a set of `TeamMemberWage` objects. The + response contains + + a set of `TeamMemberWage` objects. + properties: + team_member_wages: + type: optional> + docs: A page of `TeamMemberWage` results. + cursor: + type: optional + docs: |- + The value supplied in the subsequent request to fetch the next page + of `TeamMemberWage` results. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ListTransactionsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. + + + One of `errors` or `transactions` is present in a given response (never + both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + transactions: + type: optional> + docs: An array of transactions that match your query. + cursor: + type: optional + docs: >- + A pagination cursor for retrieving the next set of results, + + if any remain. Provide this value as the `cursor` parameter in a + subsequent + + request to this endpoint. + + + See [Paginating + results](https://developer.squareup.com/docs/working-with-apis/pagination) + for more information. + source: + openapi: openapi/openapi.json + ListWebhookEventTypesResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [ListWebhookEventTypes](api-endpoint:WebhookSubscriptions-ListWebhookEventTypes) + endpoint. + + + Note: if there are errors processing the request, the event types field + will not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + event_types: + type: optional> + docs: The list of event types. + metadata: + type: optional> + docs: >- + Contains the metadata of a webhook event type. For more information, + see [EventTypeMetadata](entity:EventTypeMetadata). + source: + openapi: openapi/openapi.json + ListWebhookSubscriptionsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [ListWebhookSubscriptions](api-endpoint:WebhookSubscriptions-ListWebhookSubscriptions) + endpoint. + + + Note: if there are errors processing the request, the subscriptions field + will not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + subscriptions: + type: optional> + docs: The requested list of [Subscription](entity:WebhookSubscription)s. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + ListWorkweekConfigsResponse: + docs: >- + The response to a request for a set of `WorkweekConfig` objects. The + response contains + + the requested `WorkweekConfig` objects and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + workweek_configs: + type: optional> + docs: A page of `WorkweekConfig` results. + cursor: + type: optional + docs: |- + The value supplied in the subsequent request to fetch the next page of + `WorkweekConfig` results. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + Location: + docs: >- + Represents one of a business' + [locations](https://developer.squareup.com/docs/locations-api). + properties: + id: + type: optional + docs: >- + A short generated string of letters and numbers that uniquely + identifies this location instance. + validation: + maxLength: 32 + access: read-only + name: + type: optional> + docs: |- + The name of the location. + This information appears in the Seller Dashboard as the nickname. + A location name must be unique within a seller account. + validation: + maxLength: 255 + address: + type: optional
+ docs: The physical address of the location. + timezone: + type: optional> + docs: |- + The [IANA time zone](https://www.iana.org/time-zones) identifier for + the time zone of the location. For example, `America/Los_Angeles`. + validation: + maxLength: 30 + capabilities: + type: optional> + docs: >- + The Square features that are enabled for the location. + + See [LocationCapability](entity:LocationCapability) for possible + values. + + See [LocationCapability](#type-locationcapability) for possible values + access: read-only + status: + type: optional + docs: |- + The status of the location. + See [LocationStatus](#type-locationstatus) for possible values + created_at: + type: optional + docs: >- + The time when the location was created, in RFC 3339 format. + + For more information, see [Working with + Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). + validation: + minLength: 20 + maxLength: 25 + access: read-only + merchant_id: + type: optional + docs: The ID of the merchant that owns the location. + validation: + maxLength: 32 + access: read-only + country: + type: optional + docs: >- + The country of the location, in the two-letter format of ISO 3166. For + example, `US` or `JP`. + + + See [Country](entity:Country) for possible values. + + See [Country](#type-country) for possible values + language_code: + type: optional> + docs: >- + The language associated with the location, in + + [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). + + For more information, see [Language + Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences). + validation: + minLength: 2 + maxLength: 5 + currency: + type: optional + docs: >- + The currency used for all transactions at this location, + + in ISO 4217 format. For example, the currency code for US dollars is + `USD`. + + See [Currency](entity:Currency) for possible values. + + See [Currency](#type-currency) for possible values + phone_number: + type: optional> + docs: The phone number of the location. For example, `+1 855-700-6000`. + validation: + maxLength: 17 + business_name: + type: optional> + docs: >- + The name of the location's overall business. This name is present on + receipts and other customer-facing branding, and can be changed no + more than three times in a twelve-month period. + validation: + maxLength: 255 + type: + type: optional + docs: |- + The type of the location. + See [LocationType](#type-locationtype) for possible values + website_url: + type: optional> + docs: The website URL of the location. For example, `https://squareup.com`. + validation: + maxLength: 255 + business_hours: + type: optional + docs: The hours of operation for the location. + business_email: + type: optional> + docs: >- + The email address of the location. This can be unique to the location + and is not always the email address for the business owner or + administrator. + validation: + maxLength: 255 + description: + type: optional> + docs: The description of the location. For example, `Main Street location`. + validation: + maxLength: 1024 + twitter_username: + type: optional> + docs: >- + The Twitter username of the location without the '@' symbol. For + example, `Square`. + validation: + minLength: 1 + maxLength: 15 + instagram_username: + type: optional> + docs: >- + The Instagram username of the location without the '@' symbol. For + example, `square`. + validation: + minLength: 1 + maxLength: 30 + facebook_url: + type: optional> + docs: >- + The Facebook profile URL of the location. The URL should begin with + 'facebook.com/'. For example, `https://www.facebook.com/square`. + validation: + maxLength: 255 + coordinates: + type: optional + docs: The physical coordinates (latitude and longitude) of the location. + logo_url: + type: optional + docs: >- + The URL of the logo image for the location. When configured in the + Seller + + Dashboard (Receipts section), the logo appears on transactions (such + as receipts and invoices) that Square generates on behalf of the + seller. + + This image should have a roughly square (1:1) aspect ratio and should + be at least 200x200 pixels. + validation: + maxLength: 255 + access: read-only + pos_background_url: + type: optional + docs: The URL of the Point of Sale background image for the location. + validation: + maxLength: 255 + access: read-only + mcc: + type: optional> + docs: >- + A four-digit number that describes the kind of goods or services sold + at the location. + + The [merchant category code + (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) + of the location as standardized by ISO 18245. + + For example, `5045`, for a location that sells computer goods and + software. + validation: + minLength: 4 + maxLength: 4 + full_format_logo_url: + type: optional + docs: >- + The URL of a full-format logo image for the location. When configured + in the Seller + + Dashboard (Receipts section), the logo appears on transactions (such + as receipts and invoices) that Square generates on behalf of the + seller. + + This image can be wider than it is tall and should be at least + 1280x648 pixels. + access: read-only + tax_ids: + type: optional + docs: The tax IDs for this location. + source: + openapi: openapi/openapi.json + LocationBookingProfile: + docs: >- + The booking profile of a seller's location, including the location's ID + and whether the location is enabled for online booking. + properties: + location_id: + type: optional> + docs: The ID of the [location](entity:Location). + booking_site_url: + type: optional> + docs: Url for the online booking site for this location. + online_booking_enabled: + type: optional> + docs: Indicates whether the location is enabled for online booking. + source: + openapi: openapi/openapi.json + LocationCapability: + enum: + - CREDIT_CARD_PROCESSING + - AUTOMATIC_TRANSFERS + - UNLINKED_REFUNDS + docs: The capabilities a location might have. + source: + openapi: openapi/openapi.json + LocationStatus: + enum: + - ACTIVE + - INACTIVE + docs: A location's status. + source: + openapi: openapi/openapi.json + LocationType: + enum: + - PHYSICAL + - MOBILE + docs: A location's type. + source: + openapi: openapi/openapi.json + LoyaltyAccount: + docs: >- + Describes a loyalty account in a [loyalty program](entity:LoyaltyProgram). + For more information, see + + [Create and Retrieve Loyalty + Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts). + properties: + id: + type: optional + docs: The Square-assigned ID of the loyalty account. + validation: + maxLength: 36 + access: read-only + program_id: + type: string + docs: >- + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) + to which the account belongs. + validation: + minLength: 1 + maxLength: 36 + balance: + type: optional + docs: >- + The available point balance in the loyalty account. If points are + scheduled to expire, they are listed in the `expiring_point_deadlines` + field. + + + Your application should be able to handle loyalty accounts that have a + negative point balance (`balance` is less than 0). This might occur if + a seller makes a manual adjustment or as a result of a refund or + exchange. + access: read-only + lifetime_points: + type: optional + docs: The total points accrued during the lifetime of the account. + access: read-only + customer_id: + type: optional> + docs: >- + The Square-assigned ID of the [customer](entity:Customer) that is + associated with the account. + enrolled_at: + type: optional> + docs: >- + The timestamp when the buyer joined the loyalty program, in RFC 3339 + format. This field is used to display the **Enrolled On** or **Member + Since** date in first-party Square products. + + + If this field is not set in a `CreateLoyaltyAccount` request, Square + populates it after the buyer's first action on their account + + (when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). + In first-party flows, Square populates the field when the buyer agrees + to the terms of service in Square Point of Sale. + + + This field is typically specified in a `CreateLoyaltyAccount` request + when creating a loyalty account for a buyer who already interacted + with their account. + + For example, you would set this field when migrating accounts from an + external system. The timestamp in the request can represent a current + or previous date and time, but it cannot be set for the future. + created_at: + type: optional + docs: >- + The timestamp when the loyalty account was created, in RFC 3339 + format. + access: read-only + updated_at: + type: optional + docs: >- + The timestamp when the loyalty account was last updated, in RFC 3339 + format. + access: read-only + mapping: + type: optional + docs: >- + The mapping that associates the loyalty account with a buyer. + Currently, + + a loyalty account can only be mapped to a buyer by phone number. + + + To create a loyalty account, you must specify the `mapping` field, + with the buyer's phone number + + in the `phone_number` field. + expiring_point_deadlines: + type: optional>> + docs: >- + The schedule for when points expire in the loyalty account balance. + This field is present only if the account has points that are + scheduled to expire. + + + The total number of points in this field equals the number of points + in the `balance` field. + source: + openapi: openapi/openapi.json + LoyaltyAccountExpiringPointDeadline: + docs: >- + Represents a set of points for a loyalty account that are scheduled to + expire on a specific date. + properties: + points: + type: integer + docs: >- + The number of points scheduled to expire at the `expires_at` + timestamp. + expires_at: + type: string + docs: >- + The timestamp of when the points are scheduled to expire, in RFC 3339 + format. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyAccountMapping: + docs: >- + Represents the mapping that associates a loyalty account with a buyer. + + + Currently, a loyalty account can only be mapped to a buyer by phone + number. For more information, see + + [Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview). + properties: + id: + type: optional + docs: The Square-assigned ID of the mapping. + validation: + maxLength: 36 + access: read-only + created_at: + type: optional + docs: The timestamp when the mapping was created, in RFC 3339 format. + access: read-only + phone_number: + type: optional> + docs: >- + The phone number of the buyer, in E.164 format. For example, + "+14155551111". + source: + openapi: openapi/openapi.json + LoyaltyEvent: + docs: >- + Provides information about a loyalty event. + + For more information, see [Search for Balance-Changing Loyalty + Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events). + properties: + id: + type: string + docs: The Square-assigned ID of the loyalty event. + validation: + minLength: 1 + access: read-only + type: + type: LoyaltyEventType + docs: |- + The type of the loyalty event. + See [LoyaltyEventType](#type-loyaltyeventtype) for possible values + created_at: + type: string + docs: The timestamp when the event was created, in RFC 3339 format. + validation: + minLength: 1 + access: read-only + accumulate_points: + type: optional + docs: Provides metadata when the event `type` is `ACCUMULATE_POINTS`. + create_reward: + type: optional + docs: Provides metadata when the event `type` is `CREATE_REWARD`. + redeem_reward: + type: optional + docs: Provides metadata when the event `type` is `REDEEM_REWARD`. + delete_reward: + type: optional + docs: Provides metadata when the event `type` is `DELETE_REWARD`. + adjust_points: + type: optional + docs: Provides metadata when the event `type` is `ADJUST_POINTS`. + loyalty_account_id: + type: string + docs: >- + The ID of the [loyalty account](entity:LoyaltyAccount) associated with + the event. + validation: + minLength: 1 + maxLength: 36 + access: read-only + location_id: + type: optional + docs: The ID of the [location](entity:Location) where the event occurred. + access: read-only + source: + type: LoyaltyEventSource + docs: |- + Defines whether the event was generated by the Square Point of Sale. + See [LoyaltyEventSource](#type-loyaltyeventsource) for possible values + expire_points: + type: optional + docs: Provides metadata when the event `type` is `EXPIRE_POINTS`. + other_event: + type: optional + docs: Provides metadata when the event `type` is `OTHER`. + accumulate_promotion_points: + type: optional + docs: >- + Provides metadata when the event `type` is + `ACCUMULATE_PROMOTION_POINTS`. + source: + openapi: openapi/openapi.json + LoyaltyEventAccumulatePoints: + docs: Provides metadata when the event `type` is `ACCUMULATE_POINTS`. + properties: + loyalty_program_id: + type: optional + docs: The ID of the [loyalty program](entity:LoyaltyProgram). + validation: + maxLength: 36 + access: read-only + points: + type: optional> + docs: The number of points accumulated by the event. + validation: + min: 1 + order_id: + type: optional> + docs: >- + The ID of the [order](entity:Order) for which the buyer accumulated + the points. + + This field is returned only if the Orders API is used to process + orders. + source: + openapi: openapi/openapi.json + LoyaltyEventAccumulatePromotionPoints: + docs: Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. + properties: + loyalty_program_id: + type: optional + docs: >- + The Square-assigned ID of the [loyalty + program](entity:LoyaltyProgram). + validation: + maxLength: 36 + access: read-only + loyalty_promotion_id: + type: optional + docs: >- + The Square-assigned ID of the [loyalty + promotion](entity:LoyaltyPromotion). + validation: + minLength: 1 + maxLength: 255 + access: read-only + points: + type: integer + docs: The number of points earned by the event. + access: read-only + order_id: + type: string + docs: >- + The ID of the [order](entity:Order) for which the buyer earned the + promotion points. + + Only applications that use the Orders API to process orders can + trigger this event. + validation: + minLength: 1 + access: read-only + source: + openapi: openapi/openapi.json + LoyaltyEventAdjustPoints: + docs: Provides metadata when the event `type` is `ADJUST_POINTS`. + properties: + loyalty_program_id: + type: optional + docs: >- + The Square-assigned ID of the [loyalty + program](entity:LoyaltyProgram). + validation: + maxLength: 36 + access: read-only + points: + type: integer + docs: The number of points added or removed. + reason: + type: optional> + docs: The reason for the adjustment of points. + validation: + maxLength: 3500 + source: + openapi: openapi/openapi.json + LoyaltyEventCreateReward: + docs: Provides metadata when the event `type` is `CREATE_REWARD`. + properties: + loyalty_program_id: + type: string + docs: The ID of the [loyalty program](entity:LoyaltyProgram). + validation: + minLength: 1 + maxLength: 36 + access: read-only + reward_id: + type: optional + docs: >- + The Square-assigned ID of the created [loyalty + reward](entity:LoyaltyReward). + + This field is returned only if the event source is `LOYALTY_API`. + validation: + maxLength: 36 + access: read-only + points: + type: integer + docs: The loyalty points used to create the reward. + access: read-only + source: + openapi: openapi/openapi.json + LoyaltyEventDateTimeFilter: + docs: Filter events by date time range. + properties: + created_at: + type: TimeRange + docs: The `created_at` date time range used to filter the result. + source: + openapi: openapi/openapi.json + LoyaltyEventDeleteReward: + docs: Provides metadata when the event `type` is `DELETE_REWARD`. + properties: + loyalty_program_id: + type: string + docs: The ID of the [loyalty program](entity:LoyaltyProgram). + validation: + minLength: 1 + maxLength: 36 + access: read-only + reward_id: + type: optional + docs: |- + The ID of the deleted [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + validation: + maxLength: 36 + access: read-only + points: + type: integer + docs: The number of points returned to the loyalty account. + access: read-only + source: + openapi: openapi/openapi.json + LoyaltyEventExpirePoints: + docs: Provides metadata when the event `type` is `EXPIRE_POINTS`. + properties: + loyalty_program_id: + type: string + docs: >- + The Square-assigned ID of the [loyalty + program](entity:LoyaltyProgram). + validation: + minLength: 1 + maxLength: 36 + access: read-only + points: + type: integer + docs: The number of points expired. + source: + openapi: openapi/openapi.json + LoyaltyEventFilter: + docs: |- + The filtering criteria. If the request specifies multiple filters, + the endpoint uses a logical AND to evaluate them. + properties: + loyalty_account_filter: + type: optional + docs: Filter events by loyalty account. + type_filter: + type: optional + docs: Filter events by event type. + date_time_filter: + type: optional + docs: |- + Filter events by date time range. + For each range, the start time is inclusive and the end time + is exclusive. + location_filter: + type: optional + docs: Filter events by location. + order_filter: + type: optional + docs: Filter events by the order associated with the event. + source: + openapi: openapi/openapi.json + LoyaltyEventLocationFilter: + docs: Filter events by location. + properties: + location_ids: + docs: |- + The [location](entity:Location) IDs for loyalty events to query. + If multiple values are specified, the endpoint uses + a logical OR to combine them. + type: list + source: + openapi: openapi/openapi.json + LoyaltyEventLoyaltyAccountFilter: + docs: Filter events by loyalty account. + properties: + loyalty_account_id: + type: string + docs: >- + The ID of the [loyalty account](entity:LoyaltyAccount) associated with + loyalty events. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyEventOrderFilter: + docs: Filter events by the order associated with the event. + properties: + order_id: + type: string + docs: The ID of the [order](entity:Order) associated with the event. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyEventOther: + docs: Provides metadata when the event `type` is `OTHER`. + properties: + loyalty_program_id: + type: string + docs: >- + The Square-assigned ID of the [loyalty + program](entity:LoyaltyProgram). + validation: + minLength: 1 + maxLength: 36 + access: read-only + points: + type: integer + docs: The number of points added or removed. + source: + openapi: openapi/openapi.json + LoyaltyEventQuery: + docs: Represents a query used to search for loyalty events. + properties: + filter: + type: optional + docs: The query filter criteria. + source: + openapi: openapi/openapi.json + LoyaltyEventRedeemReward: + docs: Provides metadata when the event `type` is `REDEEM_REWARD`. + properties: + loyalty_program_id: + type: string + docs: The ID of the [loyalty program](entity:LoyaltyProgram). + validation: + minLength: 1 + maxLength: 36 + access: read-only + reward_id: + type: optional + docs: |- + The ID of the redeemed [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + validation: + maxLength: 36 + access: read-only + order_id: + type: optional + docs: >- + The ID of the [order](entity:Order) that redeemed the reward. + + This field is returned only if the Orders API is used to process + orders. + access: read-only + source: + openapi: openapi/openapi.json + LoyaltyEventSource: + enum: + - SQUARE + - LOYALTY_API + docs: Defines whether the event was generated by the Square Point of Sale. + source: + openapi: openapi/openapi.json + LoyaltyEventType: + enum: + - ACCUMULATE_POINTS + - CREATE_REWARD + - REDEEM_REWARD + - DELETE_REWARD + - ADJUST_POINTS + - EXPIRE_POINTS + - OTHER + - ACCUMULATE_PROMOTION_POINTS + docs: The type of the loyalty event. + source: + openapi: openapi/openapi.json + LoyaltyEventTypeFilter: + docs: Filter events by event type. + properties: + types: + docs: |- + The loyalty event types used to filter the result. + If multiple values are specified, the endpoint uses a + logical OR to combine them. + See [LoyaltyEventType](#type-loyaltyeventtype) for possible values + type: list + source: + openapi: openapi/openapi.json + LoyaltyProgram: + docs: >- + Represents a Square loyalty program. Loyalty programs define how buyers + can earn points and redeem points for rewards. + + Square sellers can have only one loyalty program, which is created and + managed from the Seller Dashboard. + + For more information, see [Loyalty Program + Overview](https://developer.squareup.com/docs/loyalty/overview). + properties: + id: + type: optional + docs: |- + The Square-assigned ID of the loyalty program. Updates to + the loyalty program do not modify the identifier. + validation: + maxLength: 36 + access: read-only + status: + type: optional + docs: >- + Whether the program is currently active. + + See [LoyaltyProgramStatus](#type-loyaltyprogramstatus) for possible + values + reward_tiers: + type: optional>> + docs: The list of rewards for buyers, sorted by ascending points. + expiration_policy: + type: optional + docs: If present, details for how points expire. + terminology: + type: optional + docs: A cosmetic name for the “points” currency. + location_ids: + type: optional>> + docs: The [locations](entity:Location) at which the program is active. + created_at: + type: optional + docs: The timestamp when the program was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp when the reward was last updated, in RFC 3339 format. + access: read-only + accrual_rules: + type: optional>> + docs: >- + Defines how buyers can earn loyalty points from the base loyalty + program. + + To check for associated [loyalty promotions](entity:LoyaltyPromotion) + that enable + + buyers to earn extra points, call + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions). + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRule: + docs: >- + Represents an accrual rule, which defines how buyers can earn points from + the base [loyalty program](entity:LoyaltyProgram). + properties: + accrual_type: + type: LoyaltyProgramAccrualRuleType + docs: >- + The type of the accrual rule that defines how buyers can earn points. + + See + [LoyaltyProgramAccrualRuleType](#type-loyaltyprogramaccrualruletype) + for possible values + points: + type: optional> + docs: |- + The number of points that + buyers earn based on the `accrual_type`. + validation: + min: 1 + visit_data: + type: optional + docs: Additional data for rules with the `VISIT` accrual type. + spend_data: + type: optional + docs: Additional data for rules with the `SPEND` accrual type. + item_variation_data: + type: optional + docs: Additional data for rules with the `ITEM_VARIATION` accrual type. + category_data: + type: optional + docs: Additional data for rules with the `CATEGORY` accrual type. + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRuleCategoryData: + docs: Represents additional data for rules with the `CATEGORY` accrual type. + properties: + category_id: + type: string + docs: >- + The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that + buyers can purchase to earn + + points. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRuleItemVariationData: + docs: >- + Represents additional data for rules with the `ITEM_VARIATION` accrual + type. + properties: + item_variation_id: + type: string + docs: >- + The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) + that buyers can purchase to earn + + points. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRuleSpendData: + docs: Represents additional data for rules with the `SPEND` accrual type. + properties: + amount_money: + type: Money + docs: >- + The amount that buyers must spend to earn points. + + For example, given an "Earn 1 point for every $10 spent" accrual rule, + a buyer who spends $105 earns 10 points. + excluded_category_ids: + type: optional>> + docs: >- + The IDs of any `CATEGORY` catalog objects that are excluded from + points accrual. + + + You can use the + [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) + + endpoint to retrieve information about the excluded categories. + excluded_item_variation_ids: + type: optional>> + docs: >- + The IDs of any `ITEM_VARIATION` catalog objects that are excluded from + points accrual. + + + You can use the + [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) + + endpoint to retrieve information about the excluded item variations. + tax_mode: + type: LoyaltyProgramAccrualRuleTaxMode + docs: >- + Indicates how taxes should be treated when calculating the purchase + amount used for points accrual. + + See + [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) + for possible values + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRuleTaxMode: + enum: + - BEFORE_TAX + - AFTER_TAX + docs: >- + Indicates how taxes should be treated when calculating the purchase amount + used for loyalty points accrual. + + This setting applies only to `SPEND` accrual rules or `VISIT` accrual + rules that have a minimum spend requirement. + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRuleType: + enum: + - VISIT + - SPEND + - ITEM_VARIATION + - CATEGORY + docs: The type of the accrual rule that defines how buyers can earn points. + source: + openapi: openapi/openapi.json + LoyaltyProgramAccrualRuleVisitData: + docs: Represents additional data for rules with the `VISIT` accrual type. + properties: + minimum_amount_money: + type: optional + docs: The minimum purchase required during the visit to quality for points. + tax_mode: + type: LoyaltyProgramAccrualRuleTaxMode + docs: >- + Indicates how taxes should be treated when calculating the purchase + amount to determine whether the visit qualifies for points. + + This setting applies only if `minimum_amount_money` is specified. + + See + [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) + for possible values + source: + openapi: openapi/openapi.json + LoyaltyProgramExpirationPolicy: + docs: Describes when the loyalty program expires. + properties: + expiration_duration: + type: string + docs: >- + The number of months before points expire, in `P[n]M` RFC 3339 + duration format. For example, a value of `P12M` represents a duration + of 12 months. + + Points are valid through the last day of the month in which they are + scheduled to expire. For example, with a `P12M` duration, points + earned on July 6, 2020 expire on August 1, 2021. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyProgramRewardDefinition: + docs: >- + Provides details about the reward tier discount. DEPRECATED at version + 2020-12-16. Discount details + + are now defined using a catalog pricing rule and other catalog objects. + For more information, see + + [Getting discount details for a reward + tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + properties: + scope: + type: LoyaltyProgramRewardDefinitionScope + docs: >- + Indicates the scope of the reward tier. DEPRECATED at version + 2020-12-16. You can find this information in the + + `product_set_data` field of the `PRODUCT_SET` catalog object + referenced by the pricing rule. For `ORDER` scopes, + + `all_products` is true. For `ITEM_VARIATION` or `CATEGORY` scopes, + `product_ids_any` is a list of + + catalog object IDs of the given type. + + See + [LoyaltyProgramRewardDefinitionScope](#type-loyaltyprogramrewarddefinitionscope) + for possible values + discount_type: + type: LoyaltyProgramRewardDefinitionType + docs: >- + The type of discount the reward tier offers. DEPRECATED at version + 2020-12-16. You can find this information + + in the `discount_data.discount_type` field of the `DISCOUNT` catalog + object referenced by the pricing rule. + + See + [LoyaltyProgramRewardDefinitionType](#type-loyaltyprogramrewarddefinitiontype) + for possible values + percentage_discount: + type: optional + docs: >- + The fixed percentage of the discount. Present if `discount_type` is + `FIXED_PERCENTAGE`. + + For example, a 7.25% off discount will be represented as "7.25". + DEPRECATED at version 2020-12-16. You can find this + + information in the `discount_data.percentage` field of the `DISCOUNT` + catalog object referenced by the pricing rule. + access: read-only + catalog_object_ids: + type: optional> + docs: >- + The list of catalog objects to which this reward can be applied. They + are either all item-variation ids or category ids, depending on the + `type` field. + + DEPRECATED at version 2020-12-16. You can find this information in the + `product_set_data.product_ids_any` field + + of the `PRODUCT_SET` catalog object referenced by the pricing rule. + access: read-only + fixed_discount_money: + type: optional + docs: >- + The amount of the discount. Present if `discount_type` is + `FIXED_AMOUNT`. For example, $5 off. + + DEPRECATED at version 2020-12-16. You can find this information in the + `discount_data.amount_money` field of the + + `DISCOUNT` catalog object referenced by the pricing rule. + max_discount_money: + type: optional + docs: >- + When `discount_type` is `FIXED_PERCENTAGE`, the maximum discount + amount that can be applied. + + DEPRECATED at version 2020-12-16. You can find this information in the + `discount_data.maximum_amount_money` field + + of the `DISCOUNT` catalog object referenced by the the pricing rule. + source: + openapi: openapi/openapi.json + LoyaltyProgramRewardDefinitionScope: + enum: + - ORDER + - ITEM_VARIATION + - CATEGORY + docs: >- + Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. + Discount details + + are now defined using a catalog pricing rule and other catalog objects. + For more information, see + + [Getting discount details for a reward + tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + source: + openapi: openapi/openapi.json + LoyaltyProgramRewardDefinitionType: + enum: + - FIXED_AMOUNT + - FIXED_PERCENTAGE + docs: >- + The type of discount the reward tier offers. DEPRECATED at version + 2020-12-16. Discount details + + are now defined using a catalog pricing rule and other catalog objects. + For more information, see + + [Getting discount details for a reward + tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + source: + openapi: openapi/openapi.json + LoyaltyProgramRewardTier: + docs: >- + Represents a reward tier in a loyalty program. A reward tier defines how + buyers can redeem points for a reward, such as the number of points + required and the value and scope of the discount. A loyalty program can + offer multiple reward tiers. + properties: + id: + type: optional + docs: The Square-assigned ID of the reward tier. + validation: + maxLength: 36 + access: read-only + points: + type: integer + docs: The points exchanged for the reward tier. + validation: + min: 1 + name: + type: optional + docs: The name of the reward tier. + access: read-only + definition: + type: optional + docs: >- + Provides details about the reward tier definition. + + DEPRECATED at version 2020-12-16. Replaced by the + `pricing_rule_reference` field. + created_at: + type: optional + docs: The timestamp when the reward tier was created, in RFC 3339 format. + access: read-only + pricing_rule_reference: + type: CatalogObjectReference + docs: >- + A reference to the specific version of a `PRICING_RULE` catalog object + that contains information about the reward tier discount. + + + Use `object_id` and `catalog_version` with the + [RetrieveCatalogObject](api-endpoint:Catalog-RetrieveCatalogObject) + endpoint + + to get discount details. Make sure to set `include_related_objects` to + true in the request to retrieve all catalog objects + + that define the discount. For more information, see [Getting discount + details for a reward + tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + source: + openapi: openapi/openapi.json + LoyaltyProgramStatus: + enum: + - INACTIVE + - ACTIVE + docs: Indicates whether the program is currently active. + source: + openapi: openapi/openapi.json + LoyaltyProgramTerminology: + docs: Represents the naming used for loyalty points. + properties: + one: + type: string + docs: A singular unit for a point (for example, 1 point is called 1 star). + validation: + minLength: 1 + other: + type: string + docs: A plural unit for point (for example, 10 points is called 10 stars). + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + LoyaltyPromotion: + docs: >- + Represents a promotion for a [loyalty program](entity:LoyaltyProgram). + Loyalty promotions enable buyers + + to earn extra points on top of those earned from the base program. + + + A loyalty program can have a maximum of 10 loyalty promotions with an + `ACTIVE` or `SCHEDULED` status. + properties: + id: + type: optional + docs: The Square-assigned ID of the promotion. + validation: + minLength: 1 + maxLength: 255 + access: read-only + name: + type: string + docs: The name of the promotion. + validation: + minLength: 1 + maxLength: 70 + incentive: + type: LoyaltyPromotionIncentive + docs: >- + The points incentive for the promotion. This field defines whether + promotion points + + are earned by multiplying base program points or by adding a specified + number of points. + available_time: + type: LoyaltyPromotionAvailableTimeData + docs: >- + The scheduling information that defines when purchases can qualify to + earn points from an `ACTIVE` promotion. + trigger_limit: + type: optional + docs: >- + The number of times a buyer can earn promotion points during a + specified interval. + + If not specified, buyers can trigger the promotion an unlimited number + of times. + status: + type: optional + docs: >- + The current status of the promotion. + + See [LoyaltyPromotionStatus](#type-loyaltypromotionstatus) for + possible values + created_at: + type: optional + docs: The timestamp of when the promotion was created, in RFC 3339 format. + access: read-only + canceled_at: + type: optional + docs: The timestamp of when the promotion was canceled, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp when the promotion was last updated, in RFC 3339 format. + access: read-only + loyalty_program_id: + type: optional + docs: >- + The ID of the [loyalty program](entity:LoyaltyProgram) associated with + the promotion. + access: read-only + minimum_spend_amount_money: + type: optional + docs: >- + The minimum purchase amount required to earn promotion points. If + specified, this amount is positive. + qualifying_item_variation_ids: + type: optional>> + docs: >- + The IDs of any qualifying `ITEM_VARIATION` [catalog + objects](entity:CatalogObject). If specified, + + the purchase must include at least one of these items to qualify for + the promotion. + + + This option is valid only if the base loyalty program uses a `VISIT` + or `SPEND` accrual rule. + + With `SPEND` accrual rules, make sure that qualifying promotional + items are not excluded. + + + You can specify `qualifying_item_variation_ids` or + `qualifying_category_ids` for a given promotion, but not both. + qualifying_category_ids: + type: optional>> + docs: >- + The IDs of any qualifying `CATEGORY` [catalog + objects](entity:CatalogObject). If specified, + + the purchase must include at least one item from one of these + categories to qualify for the promotion. + + + This option is valid only if the base loyalty program uses a `VISIT` + or `SPEND` accrual rule. + + With `SPEND` accrual rules, make sure that qualifying promotional + items are not excluded. + + + You can specify `qualifying_category_ids` or + `qualifying_item_variation_ids` for a promotion, but not both. + source: + openapi: openapi/openapi.json + LoyaltyPromotionAvailableTimeData: + docs: >- + Represents scheduling information that determines when purchases can + qualify to earn points + + from a [loyalty promotion](entity:LoyaltyPromotion). + properties: + start_date: + type: optional + docs: >- + The date that the promotion starts, in `YYYY-MM-DD` format. Square + populates this field + + based on the provided `time_periods`. + access: read-only + end_date: + type: optional + docs: >- + The date that the promotion ends, in `YYYY-MM-DD` format. Square + populates this field + + based on the provided `time_periods`. If an end date is not specified, + an `ACTIVE` promotion + + remains available until it is canceled. + access: read-only + time_periods: + docs: >- + A list of [iCalendar (RFC 5545) + events](https://tools.ietf.org/html/rfc5545#section-3.6.1) + + (`VEVENT`). Each event represents an available time period per day or + days of the week. + + A day can have a maximum of one available time period. + + + Only `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and + `DURATION` are required and + + timestamps must be in local (unzoned) time format. Include `RRULE` to + specify recurring promotions, + + an end date (using the `UNTIL` keyword), or both. For more + information, see + + [Available + time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time). + + + Note that `BEGIN:VEVENT` and `END:VEVENT` are optional in a + `CreateLoyaltyPromotion` request + + but are always included in the response. + type: list + source: + openapi: openapi/openapi.json + LoyaltyPromotionIncentive: + docs: >- + Represents how points for a [loyalty promotion](entity:LoyaltyPromotion) + are calculated, + + either by multiplying the points earned from the base program or by adding + a specified number + + of points to the points earned from the base program. + properties: + type: + type: LoyaltyPromotionIncentiveType + docs: >- + The type of points incentive. + + See + [LoyaltyPromotionIncentiveType](#type-loyaltypromotionincentivetype) + for possible values + points_multiplier_data: + type: optional + docs: Additional data for a `POINTS_MULTIPLIER` incentive type. + points_addition_data: + type: optional + docs: Additional data for a `POINTS_ADDITION` incentive type. + source: + openapi: openapi/openapi.json + LoyaltyPromotionIncentivePointsAdditionData: + docs: >- + Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion + incentive](entity:LoyaltyPromotionIncentive). + properties: + points_addition: + type: integer + docs: >- + The number of additional points to earn each time the promotion is + triggered. For example, + + suppose a purchase qualifies for 5 points from the base loyalty + program. If the purchase also + + qualifies for a `POINTS_ADDITION` promotion incentive with a + `points_addition` of 3, the buyer + + earns a total of 8 points (5 program points + 3 promotion points = 8 + points). + validation: + min: 1 + source: + openapi: openapi/openapi.json + LoyaltyPromotionIncentivePointsMultiplierData: + docs: >- + Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty + promotion incentive](entity:LoyaltyPromotionIncentive). + properties: + points_multiplier: + type: optional> + docs: >- + The multiplier used to calculate the number of points earned each time + the promotion + + is triggered. For example, suppose a purchase qualifies for 5 points + from the base loyalty program. + + If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion + incentive with a `points_multiplier` + + of 3, the buyer earns a total of 15 points (5 program points x 3 + promotion multiplier = 15 points). + + + DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field. + + + One of the following is required when specifying a points multiplier: + + - (Recommended) The `multiplier` field. + + - This deprecated `points_multiplier` field. If provided in the + request, Square also returns `multiplier` + + with the equivalent value. + validation: + min: 2 + max: 10 + multiplier: + type: optional> + docs: >- + The multiplier used to calculate the number of points earned each time + the promotion is triggered, + + specified as a string representation of a decimal. Square supports + multipliers up to 10x, with three + + point precision for decimal multipliers. For example, suppose a + purchase qualifies for 4 points from the + + base loyalty program. If the purchase also qualifies for a + `POINTS_MULTIPLIER` promotion incentive with a + + `multiplier` of "1.5", the buyer earns a total of 6 points (4 program + points x 1.5 promotion multiplier = 6 points). + + Fractional points are dropped. + + + One of the following is required when specifying a points multiplier: + + - (Recommended) This `multiplier` field. + + - The deprecated `points_multiplier` field. If provided in the + request, Square also returns `multiplier` + + with the equivalent value. + validation: + maxLength: 5 + source: + openapi: openapi/openapi.json + LoyaltyPromotionIncentiveType: + enum: + - POINTS_MULTIPLIER + - POINTS_ADDITION + docs: >- + Indicates the type of points incentive for a [loyalty + promotion](entity:LoyaltyPromotion), + + which is used to determine how buyers can earn points from the promotion. + source: + openapi: openapi/openapi.json + LoyaltyPromotionStatus: + enum: + - ACTIVE + - ENDED + - CANCELED + - SCHEDULED + docs: Indicates the status of a [loyalty promotion](entity:LoyaltyPromotion). + source: + openapi: openapi/openapi.json + LoyaltyPromotionTriggerLimit: + docs: >- + Represents the number of times a buyer can earn points during a [loyalty + promotion](entity:LoyaltyPromotion). + + If this field is not set, buyers can trigger the promotion an unlimited + number of times to earn points during + + the time that the promotion is available. + + + A purchase that is disqualified from earning points because of this limit + might qualify for another active promotion. + properties: + times: + type: integer + docs: >- + The maximum number of times a buyer can trigger the promotion during + the specified `interval`. + validation: + min: 1 + max: 30 + interval: + type: optional + docs: >- + The time period the limit applies to. + + See + [LoyaltyPromotionTriggerLimitInterval](#type-loyaltypromotiontriggerlimitinterval) + for possible values + source: + openapi: openapi/openapi.json + LoyaltyPromotionTriggerLimitInterval: + enum: + - ALL_TIME + - DAY + docs: >- + Indicates the time period that the [trigger + limit](entity:LoyaltyPromotionTriggerLimit) applies to, + + which is used to determine the number of times a buyer can earn points for + a [loyalty promotion](entity:LoyaltyPromotion). + source: + openapi: openapi/openapi.json + LoyaltyReward: + docs: >- + Represents a contract to redeem loyalty points for a [reward + tier](entity:LoyaltyProgramRewardTier) discount. Loyalty rewards can be in + an ISSUED, REDEEMED, or DELETED state. + + For more information, see [Manage loyalty + rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards). + properties: + id: + type: optional + docs: The Square-assigned ID of the loyalty reward. + validation: + maxLength: 36 + access: read-only + status: + type: optional + docs: >- + The status of a loyalty reward. + + See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible + values + loyalty_account_id: + type: string + docs: >- + The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount) + to which the reward belongs. + validation: + minLength: 1 + maxLength: 36 + reward_tier_id: + type: string + docs: >- + The Square-assigned ID of the [reward + tier](entity:LoyaltyProgramRewardTier) used to create the reward. + validation: + minLength: 1 + maxLength: 36 + points: + type: optional + docs: The number of loyalty points used for the reward. + validation: + min: 1 + access: read-only + order_id: + type: optional> + docs: >- + The Square-assigned ID of the [order](entity:Order) to which the + reward is attached. + created_at: + type: optional + docs: The timestamp when the reward was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp when the reward was last updated, in RFC 3339 format. + access: read-only + redeemed_at: + type: optional + docs: The timestamp when the reward was redeemed, in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + LoyaltyRewardStatus: + enum: + - ISSUED + - REDEEMED + - DELETED + docs: The status of the loyalty reward. + source: + openapi: openapi/openapi.json + MeasurementUnit: + docs: >- + Represents a unit of measurement to use with a quantity, such as ounces + + or inches. Exactly one of the following fields are required: + `custom_unit`, + + `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. + properties: + custom_unit: + type: optional + docs: >- + A custom unit of measurement defined by the seller using the Point of + Sale + + app or ad-hoc as an order line item. + area_unit: + type: optional + docs: >- + Represents a standard area unit. + + See [MeasurementUnitArea](#type-measurementunitarea) for possible + values + length_unit: + type: optional + docs: >- + Represents a standard length unit. + + See [MeasurementUnitLength](#type-measurementunitlength) for possible + values + volume_unit: + type: optional + docs: >- + Represents a standard volume unit. + + See [MeasurementUnitVolume](#type-measurementunitvolume) for possible + values + weight_unit: + type: optional + docs: >- + Represents a standard unit of weight or mass. + + See [MeasurementUnitWeight](#type-measurementunitweight) for possible + values + generic_unit: + type: optional + docs: >- + Reserved for API integrations that lack the ability to specify a real + measurement unit + + See [MeasurementUnitGeneric](#type-measurementunitgeneric) for + possible values + time_unit: + type: optional + docs: >- + Represents a standard unit of time. + + See [MeasurementUnitTime](#type-measurementunittime) for possible + values + type: + type: optional + docs: >- + Represents the type of the measurement unit. + + See [MeasurementUnitUnitType](#type-measurementunitunittype) for + possible values + source: + openapi: openapi/openapi.json + MeasurementUnitArea: + enum: + - IMPERIAL_ACRE + - IMPERIAL_SQUARE_INCH + - IMPERIAL_SQUARE_FOOT + - IMPERIAL_SQUARE_YARD + - IMPERIAL_SQUARE_MILE + - METRIC_SQUARE_CENTIMETER + - METRIC_SQUARE_METER + - METRIC_SQUARE_KILOMETER + docs: Unit of area used to measure a quantity. + source: + openapi: openapi/openapi.json + MeasurementUnitCustom: + docs: The information needed to define a custom unit, provided by the seller. + properties: + name: + type: string + docs: The name of the custom unit, for example "bushel". + abbreviation: + type: string + docs: >- + The abbreviation of the custom unit, such as "bsh" (bushel). This + appears + + in the cart for the Point of Sale app, and in reports. + source: + openapi: openapi/openapi.json + MeasurementUnitGeneric: literal<"UNIT"> + MeasurementUnitLength: + enum: + - IMPERIAL_INCH + - IMPERIAL_FOOT + - IMPERIAL_YARD + - IMPERIAL_MILE + - METRIC_MILLIMETER + - METRIC_CENTIMETER + - METRIC_METER + - METRIC_KILOMETER + docs: The unit of length used to measure a quantity. + source: + openapi: openapi/openapi.json + MeasurementUnitTime: + enum: + - GENERIC_MILLISECOND + - GENERIC_SECOND + - GENERIC_MINUTE + - GENERIC_HOUR + - GENERIC_DAY + docs: Unit of time used to measure a quantity (a duration). + source: + openapi: openapi/openapi.json + MeasurementUnitUnitType: + enum: + - TYPE_CUSTOM + - TYPE_AREA + - TYPE_LENGTH + - TYPE_VOLUME + - TYPE_WEIGHT + - TYPE_GENERIC + docs: >- + Describes the type of this unit and indicates which field contains the + unit information. This is an ‘open’ enum. + source: + openapi: openapi/openapi.json + MeasurementUnitVolume: + enum: + - GENERIC_FLUID_OUNCE + - GENERIC_SHOT + - GENERIC_CUP + - GENERIC_PINT + - GENERIC_QUART + - GENERIC_GALLON + - IMPERIAL_CUBIC_INCH + - IMPERIAL_CUBIC_FOOT + - IMPERIAL_CUBIC_YARD + - METRIC_MILLILITER + - METRIC_LITER + docs: The unit of volume used to measure a quantity. + source: + openapi: openapi/openapi.json + MeasurementUnitWeight: + enum: + - IMPERIAL_WEIGHT_OUNCE + - IMPERIAL_POUND + - IMPERIAL_STONE + - METRIC_MILLIGRAM + - METRIC_GRAM + - METRIC_KILOGRAM + docs: Unit of weight used to measure a quantity. + source: + openapi: openapi/openapi.json + Merchant: + docs: Represents a business that sells with Square. + properties: + id: + type: optional + docs: The Square-issued ID of the merchant. + business_name: + type: optional> + docs: The name of the merchant's overall business. + country: + type: Country + docs: >- + The country code associated with the merchant, in the two-letter + format of ISO 3166. For example, `US` or `JP`. + + See [Country](#type-country) for possible values + language_code: + type: optional> + docs: >- + The code indicating the [language + preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences) + of the merchant, in [BCP 47 + format](https://tools.ietf.org/html/bcp47#appendix-A). For example, + `en-US` or `fr-CA`. + currency: + type: optional + docs: >- + The currency associated with the merchant, in ISO 4217 format. For + example, the currency code for US dollars is `USD`. + + See [Currency](#type-currency) for possible values + status: + type: optional + docs: |- + The merchant's status. + See [MerchantStatus](#type-merchantstatus) for possible values + main_location_id: + type: optional> + docs: >- + The ID of the [main + `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-location) + for this merchant. + created_at: + type: optional + docs: |- + The time when the merchant was created, in RFC 3339 format. + For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). + access: read-only + source: + openapi: openapi/openapi.json + MerchantStatus: + enum: + - ACTIVE + - INACTIVE + source: + openapi: openapi/openapi.json + ModifierLocationOverrides: + docs: >- + Location-specific overrides for specified properties of a + `CatalogModifier` object. + properties: + location_id: + type: optional> + docs: >- + The ID of the `Location` object representing the location. This can + include a deactivated location. + price_money: + type: optional + docs: >- + The overridden price at the specified location. If this is + unspecified, the modifier price is not overridden. + + The modifier becomes free of charge at the specified location, when + this `price_money` field is set to 0. + sold_out: + type: optional + docs: >- + Indicates whether the modifier is sold out at the specified location + or not. As an example, for cheese (modifier) burger (item), when the + modifier is sold out, it is the cheese, but not the burger, that is + sold out. + + The seller can manually set this sold out status. Attempts by an + application to set this attribute are ignored. + access: read-only + source: + openapi: openapi/openapi.json + Money: + docs: >- + Represents an amount of money. `Money` fields can be signed or unsigned. + + Fields that do not explicitly define whether they are signed or unsigned + are + + considered unsigned and can only hold positive amounts. For signed fields, + the + + sign of the value indicates the purpose of the money transfer. See + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) + + for more information. + properties: + amount: + type: optional> + docs: >- + The amount of money, in the smallest denomination of the currency + + indicated by `currency`. For example, when `currency` is `USD`, + `amount` is + + in cents. Monetary amounts can be positive or negative. See the + specific + + field description to determine the meaning of the sign in a particular + case. + currency: + type: optional + docs: >- + The type of currency, in __ISO 4217 format__. For example, the + currency + + code for US dollars is `USD`. + + + See [Currency](entity:Currency) for possible values. + + See [Currency](#type-currency) for possible values + source: + openapi: openapi/openapi.json + ObtainTokenResponse: + docs: Represents an [ObtainToken](api-endpoint:OAuth-ObtainToken) response. + properties: + access_token: + type: optional + docs: >- + An OAuth access token used to authorize Square API requests on behalf + of the seller. + + Include this token as a bearer token in the `Authorization` header of + your API requests. + + + OAuth access tokens expire in 30 days (except `short_lived` access + tokens). You should call + + `ObtainToken` and provide the returned `refresh_token` to get a new + access token well before + + the current one expires. For more information, see [OAuth API: + Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough). + validation: + minLength: 2 + maxLength: 1024 + token_type: + type: optional + docs: The type of access token. This value is always `bearer`. + validation: + minLength: 2 + maxLength: 10 + expires_at: + type: optional + docs: >- + The timestamp of when the `access_token` expires, in [ISO + 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. + validation: + minLength: 20 + maxLength: 48 + merchant_id: + type: optional + docs: >- + The ID of the authorizing [merchant](entity:Merchant) (seller), which + represents a business. + validation: + minLength: 8 + maxLength: 191 + subscription_id: + type: optional + docs: >- + __LEGACY__ The ID of merchant's subscription. + + The ID is only present if the merchant signed up for a subscription + plan during authorization. + plan_id: + type: optional + docs: >- + __LEGACY__ The ID of the subscription plan the merchant signed + + up for. The ID is only present if the merchant signed up for a + subscription plan during + + authorization. + id_token: + type: optional + docs: >- + The OpenID token that belongs to this person. This token is only + present if the + + `OPENID` scope is included in the authorization request. + + + Deprecated at version 2021-09-15. Square doesn't support OpenID or + other single sign-on (SSO) + + protocols on top of OAuth. + refresh_token: + type: optional + docs: >- + A refresh token that can be used in an `ObtainToken` request to + generate a new access token. + + + With the code flow: + + - For the `authorization_code` grant type, the refresh token is + multi-use and never expires. + + - For the `refresh_token` grant type, the response returns the same + refresh token. + + + With the PKCE flow: + + - For the `authorization_code` grant type, the refresh token is + single-use and expires in 90 days. + + - For the `refresh_token` grant type, the refresh token is a new + single-use refresh token that expires in 90 days. + + + For more information, see [Refresh, Revoke, and Limit the Scope of + OAuth + Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope). + validation: + minLength: 2 + maxLength: 1024 + short_lived: + type: optional + docs: >- + Indicates whether the access_token is short lived. If `true`, the + access token expires + + in 24 hours. If `false`, the access token expires in 30 days. + errors: + type: optional> + docs: Any errors that occurred during the request. + refresh_token_expires_at: + type: optional + docs: >- + The timestamp of when the `refresh_token` expires, in [ISO + 8601](http://www.iso.org/iso/home/standards/iso8601.htm) + + format. + + + This field is only returned for the PKCE flow. + validation: + minLength: 20 + maxLength: 48 + source: + openapi: openapi/openapi.json + OfflinePaymentDetails: + docs: Details specific to offline payments. + properties: + client_created_at: + type: optional + docs: >- + The client-side timestamp of when the offline payment was created, in + RFC 3339 format. + validation: + maxLength: 32 + access: read-only + source: + openapi: openapi/openapi.json + Order: + docs: >- + Contains all information related to a single order to process with Square, + + including line items that specify the products to purchase. `Order` + objects also + + include information about any associated tenders, refunds, and returns. + + + All Connect V2 Transactions have all been converted to Orders including + all associated + + itemization data. + properties: + id: + type: optional + docs: The order's unique ID. + access: read-only + location_id: + type: string + docs: The ID of the seller location that this order is associated with. + validation: + minLength: 1 + reference_id: + type: optional> + docs: |- + A client-specified ID to associate an entity in another system + with this order. + validation: + maxLength: 40 + source: + type: optional + docs: The origination details of the order. + customer_id: + type: optional> + docs: >- + The ID of the [customer](entity:Customer) associated with the order. + + + You should specify a `customer_id` on the order (or the payment) to + ensure that transactions + + are reliably linked to customers. Omitting this field might result in + the creation of new + + [instant + profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + validation: + maxLength: 191 + line_items: + type: optional>> + docs: The line items included in the order. + taxes: + type: optional>> + docs: >- + The list of all taxes associated with the order. + + + Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with + `LINE_ITEM` scope, an + + `OrderLineItemAppliedTax` must be added to each line item that the tax + applies to. For taxes + + with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` + for every line item. + + + On reads, each tax in the list includes the total amount of that tax + applied to the order. + + + __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, + using the deprecated + + `line_items.taxes` field results in an error. Use + `line_items.applied_taxes` + + instead. + discounts: + type: optional>> + docs: >- + The list of all discounts associated with the order. + + + Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For + discounts scoped to `LINE_ITEM`, + + an `OrderLineItemAppliedDiscount` must be added to each line item that + the discount applies to. + + For discounts with `ORDER` scope, the server generates an + `OrderLineItemAppliedDiscount` + + for every line item. + + + __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this + field, using the deprecated + + `line_items.discounts` field results in an error. Use + `line_items.applied_discounts` + + instead. + service_charges: + type: optional>> + docs: A list of service charges applied to the order. + fulfillments: + type: optional>> + docs: >- + Details about order fulfillment. + + + Orders can only be created with at most one fulfillment. However, + orders returned + + by the API might contain multiple fulfillments. + returns: + type: optional> + docs: >- + A collection of items from sale orders being returned in this one. + Normally part of an + + itemized return or exchange. There is exactly one `Return` object per + sale `Order` being + + referenced. + access: read-only + return_amounts: + type: optional + docs: The rollup of the returned money amounts. + net_amounts: + type: optional + docs: The net money amounts (sale money - return money). + rounding_adjustment: + type: optional + docs: >- + A positive rounding adjustment to the total of the order. This + adjustment is commonly + + used to apply cash rounding when the minimum unit of account is + smaller than the lowest physical + + denomination of the currency. + tenders: + type: optional> + docs: The tenders that were used to pay for the order. + access: read-only + refunds: + type: optional> + docs: The refunds that are part of this order. + access: read-only + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this order. Metadata fields are + intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + created_at: + type: optional + docs: >- + The timestamp for when the order was created, at server side, in RFC + 3339 format (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + updated_at: + type: optional + docs: >- + The timestamp for when the order was last updated, at server side, in + RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + access: read-only + closed_at: + type: optional + docs: >- + The timestamp for when the order reached a terminal + [state](entity:OrderState), in RFC 3339 format (for example + "2016-09-04T23:59:33.123Z"). + access: read-only + state: + type: optional + docs: |- + The current state of the order. + See [OrderState](#type-orderstate) for possible values + version: + type: optional + docs: >- + The version number, which is incremented each time an update is + committed to the order. + + Orders not created through the API do not include a version number and + + therefore cannot be updated. + + + [Read more about working with + versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders). + total_money: + type: optional + docs: The total amount of money to collect for the order. + total_tax_money: + type: optional + docs: The total amount of tax money to collect for the order. + total_discount_money: + type: optional + docs: The total amount of discount money to collect for the order. + total_tip_money: + type: optional + docs: The total amount of tip money to collect for the order. + total_service_charge_money: + type: optional + docs: >- + The total amount of money collected in service charges for the order. + + + Note: `total_service_charge_money` is the sum of `applied_money` + fields for each individual + + service charge. Therefore, `total_service_charge_money` only includes + inclusive tax amounts, + + not additive tax amounts. + ticket_name: + type: optional> + docs: |- + A short-term identifier for the order (such as a customer first name, + table number, or auto-generated order number that resets daily). + validation: + maxLength: 30 + pricing_options: + type: optional + docs: >- + Pricing options for an order. The options affect how the order's price + is calculated. + + They can be used, for example, to apply automatic price adjustments + that are based on + + preconfigured [pricing rules](entity:CatalogPricingRule). + rewards: + type: optional> + docs: A set-like list of Rewards that have been added to the Order. + access: read-only + net_amount_due_money: + type: optional + docs: The net amount of money due on the order. + source: + openapi: openapi/openapi.json + OrderEntry: + docs: >- + A lightweight description of an [order](entity:Order) that is returned + when + + `returned_entries` is `true` on a + [SearchOrdersRequest](api-endpoint:Orders-SearchOrders). + properties: + order_id: + type: optional> + docs: The ID of the order. + version: + type: optional + docs: >- + The version number, which is incremented each time an update is + committed to the order. + + Orders that were not created through the API do not include a version + number and + + therefore cannot be updated. + + + [Read more about working with + versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) + access: read-only + location_id: + type: optional> + docs: The location ID the order belongs to. + source: + openapi: openapi/openapi.json + OrderLineItem: + docs: |- + Represents a line item in an order. Each line item describes a different + product to purchase, with its own quantity and price details. + properties: + uid: + type: optional> + docs: A unique ID that identifies the line item only within this order. + validation: + maxLength: 60 + name: + type: optional> + docs: The name of the line item. + validation: + maxLength: 512 + quantity: + type: string + docs: >- + The count, or measurement, of a line item being purchased: + + + If `quantity` is a whole number, and `quantity_unit` is not specified, + then `quantity` denotes an item count. For example: `3` apples. + + + If `quantity` is a whole or decimal number, and `quantity_unit` is + also specified, then `quantity` denotes a measurement. For example: + `2.25` pounds of broccoli. + + + For more information, see [Specify item quantity and measurement + unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit). + + + Line items with a quantity of `0` are automatically removed + + when paying for or otherwise completing the order. + validation: + minLength: 1 + maxLength: 12 + quantity_unit: + type: optional + docs: >- + The measurement unit and decimal precision that this line item's + quantity is measured in. + note: + type: optional> + docs: An optional note associated with the line item. + validation: + maxLength: 2000 + catalog_object_id: + type: optional> + docs: >- + The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to + this line item. + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this line item references. + variation_name: + type: optional> + docs: The name of the variation applied to this line item. + validation: + maxLength: 400 + item_type: + type: optional + docs: >- + The type of line item: an itemized sale, a non-itemized sale (custom + amount), or the + + activation or reloading of a gift card. + + See [OrderLineItemItemType](#type-orderlineitemitemtype) for possible + values + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this line item. Metadata fields + are intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + modifiers: + type: optional>> + docs: >- + The [CatalogModifier](entity:CatalogModifier)s applied to this line + item. + applied_taxes: + type: optional>> + docs: >- + The list of references to taxes applied to this line item. Each + + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of + a + + top-level `OrderLineItemTax` applied to the line item. On reads, the + + amount applied is populated. + + + An `OrderLineItemAppliedTax` is automatically created on every line + + item for all `ORDER` scoped taxes added to the order. + `OrderLineItemAppliedTax` + + records for `LINE_ITEM` scoped taxes must be added in requests for the + tax + + to apply to any line items. + + + To change the amount of a tax, modify the referenced top-level tax. + applied_discounts: + type: optional>> + docs: >- + The list of references to discounts applied to this line item. Each + + `OrderLineItemAppliedDiscount` has a `discount_uid` that references + the `uid` of a top-level + + `OrderLineItemDiscounts` applied to the line item. On reads, the + amount + + applied is populated. + + + An `OrderLineItemAppliedDiscount` is automatically created on every + line item for all + + `ORDER` scoped discounts that are added to the order. + `OrderLineItemAppliedDiscount` records + + for `LINE_ITEM` scoped discounts must be added in requests for the + discount to apply to any + + line items. + + + To change the amount of a discount, modify the referenced top-level + discount. + applied_service_charges: + type: optional>> + docs: >- + The list of references to service charges applied to this line item. + Each + + `OrderLineItemAppliedServiceCharge` has a `service_charge_id` that + references the `uid` of a + + top-level `OrderServiceCharge` applied to the line item. On reads, the + amount applied is + + populated. + + + To change the amount of a service charge, modify the referenced + top-level service charge. + base_price_money: + type: optional + docs: The base price for a single unit of the line item. + variation_total_price_money: + type: optional + docs: >- + The total price of all item variations sold in this line item. + + The price is calculated as `base_price_money` multiplied by + `quantity`. + + It does not include modifiers. + gross_sales_money: + type: optional + docs: >- + The amount of money made in gross sales for this line item. + + The amount is calculated as the sum of the variation's total price and + each modifier's total price. + + For inclusive tax items in the US, Canada, and Japan, tax is deducted + from `gross_sales_money`. For Europe and + + Australia, inclusive tax remains as part of the gross sale + calculation. + total_tax_money: + type: optional + docs: The total amount of tax money to collect for the line item. + total_discount_money: + type: optional + docs: The total amount of discount money to collect for the line item. + total_money: + type: optional + docs: The total amount of money to collect for this line item. + pricing_blocklists: + type: optional + docs: >- + Describes pricing adjustments that are blocked from automatic + + application to a line item. For more information, see + + [Apply Taxes and + Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). + total_service_charge_money: + type: optional + docs: >- + The total amount of apportioned service charge money to collect for + the line item. + source: + openapi: openapi/openapi.json + OrderLineItemAppliedDiscount: + docs: >- + Represents an applied portion of a discount to a line item in an order. + + + Order scoped discounts have automatically applied discounts present for + each line item. + + Line-item scoped discounts must have applied discounts added manually for + any applicable line + + items. The corresponding applied money is automatically computed based on + participating + + line items. + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the applied discount only within this + order. + validation: + maxLength: 60 + discount_uid: + type: string + docs: >- + The `uid` of the discount that the applied discount represents. It + must + + reference a discount present in the `order.discounts` field. + + + This field is immutable. To change which discounts apply to a line + item, + + you must delete the discount and re-add it as a new + `OrderLineItemAppliedDiscount`. + validation: + minLength: 1 + maxLength: 60 + applied_money: + type: optional + docs: The amount of money applied by the discount to the line item. + source: + openapi: openapi/openapi.json + OrderLineItemAppliedServiceCharge: + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the applied service charge only within + this order. + validation: + maxLength: 60 + service_charge_uid: + type: string + docs: >- + The `uid` of the service charge that the applied service charge + represents. It must + + reference a service charge present in the `order.service_charges` + field. + + + This field is immutable. To change which service charges apply to a + line item, + + delete and add a new `OrderLineItemAppliedServiceCharge`. + validation: + minLength: 1 + maxLength: 60 + applied_money: + type: optional + docs: The amount of money applied by the service charge to the line item. + source: + openapi: openapi/openapi.json + OrderLineItemAppliedTax: + docs: >- + Represents an applied portion of a tax to a line item in an order. + + + Order-scoped taxes automatically include the applied taxes in each line + item. + + Line item taxes must be referenced from any applicable line items. + + The corresponding applied money is automatically computed, based on the + + set of participating line items. + properties: + uid: + type: optional> + docs: A unique ID that identifies the applied tax only within this order. + validation: + maxLength: 60 + tax_uid: + type: string + docs: >- + The `uid` of the tax for which this applied tax represents. It must + reference + + a tax present in the `order.taxes` field. + + + This field is immutable. To change which taxes apply to a line item, + delete and add a new + + `OrderLineItemAppliedTax`. + validation: + minLength: 1 + maxLength: 60 + applied_money: + type: optional + docs: The amount of money applied by the tax to the line item. + source: + openapi: openapi/openapi.json + OrderLineItemDiscount: + docs: >- + Represents a discount that applies to one or more line items in an + + order. + + + Fixed-amount, order-scoped discounts are distributed across all non-zero + line item totals. + + The amount distributed to each line item is relative to the + + amount contributed by the item to the order subtotal. + properties: + uid: + type: optional> + docs: A unique ID that identifies the discount only within this order. + validation: + maxLength: 60 + catalog_object_id: + type: optional> + docs: >- + The catalog object ID referencing + [CatalogDiscount](entity:CatalogDiscount). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this discount references. + name: + type: optional> + docs: The discount's name. + validation: + maxLength: 255 + type: + type: optional + docs: >- + The type of the discount. + + + Discounts that do not reference a catalog object ID must have a type + of + + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + + See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for + possible values + percentage: + type: optional> + docs: >- + The percentage of the discount, as a string representation of a + decimal number. + + A value of `7.25` corresponds to a percentage of 7.25%. + + + `percentage` is not set for amount-based discounts. + validation: + maxLength: 10 + amount_money: + type: optional + docs: |- + The total declared monetary amount of the discount. + + `amount_money` is not set for percentage-based discounts. + applied_money: + type: optional + docs: >- + The amount of discount actually applied to the line item. + + + The amount represents the amount of money applied as a line-item + scoped discount. + + When an amount-based discount is scoped to the entire order, the value + + of `applied_money` is different than `amount_money` because the total + + amount of the discount is distributed across all line items. + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this discount. Metadata fields + are intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + scope: + type: optional + docs: >- + Indicates the level at which the discount applies. For `ORDER` scoped + discounts, + + Square generates references in `applied_discounts` on all order line + items that do + + not have them. For `LINE_ITEM` scoped discounts, the discount only + applies to line items + + with a discount reference in their `applied_discounts` field. + + + This field is immutable. To change the scope of a discount, you must + delete + + the discount and re-add it as a new discount. + + See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for + possible values + reward_ids: + type: optional> + docs: >- + The reward IDs corresponding to this discount. The application and + + specification of discounts that have `reward_ids` are completely + controlled by the backing + + criteria corresponding to the reward tiers of the rewards that are + added to the order + + through the Loyalty API. To manually unapply discounts that are the + result of added rewards, + + the rewards must be removed from the order through the Loyalty API. + access: read-only + pricing_rule_id: + type: optional + docs: >- + The object ID of a [pricing rule](entity:CatalogPricingRule) to be + applied + + automatically to this discount. The specification and application of + the discounts, to + + which a `pricing_rule_id` is assigned, are completely controlled by + the corresponding + + pricing rule. + access: read-only + source: + openapi: openapi/openapi.json + OrderLineItemDiscountScope: + enum: + - OTHER_DISCOUNT_SCOPE + - LINE_ITEM + - ORDER + docs: Indicates whether this is a line-item or order-level discount. + source: + openapi: openapi/openapi.json + OrderLineItemDiscountType: + enum: + - UNKNOWN_DISCOUNT + - FIXED_PERCENTAGE + - FIXED_AMOUNT + - VARIABLE_PERCENTAGE + - VARIABLE_AMOUNT + docs: >- + Indicates how the discount is applied to the associated line item or + order. + source: + openapi: openapi/openapi.json + OrderLineItemItemType: + enum: + - ITEM + - CUSTOM_AMOUNT + - GIFT_CARD + docs: Represents the line item type. + source: + openapi: openapi/openapi.json + OrderLineItemModifier: + docs: A [CatalogModifier](entity:CatalogModifier). + properties: + uid: + type: optional> + docs: A unique ID that identifies the modifier only within this order. + validation: + maxLength: 60 + catalog_object_id: + type: optional> + docs: >- + The catalog object ID referencing + [CatalogModifier](entity:CatalogModifier). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this modifier references. + name: + type: optional> + docs: The name of the item modifier. + validation: + maxLength: 255 + quantity: + type: optional> + docs: >- + The quantity of the line item modifier. The modifier quantity can be 0 + or more. + + For example, suppose a restaurant offers a cheeseburger on the menu. + When a buyer orders + + this item, the restaurant records the purchase by creating an `Order` + object with a line item + + for a burger. The line item includes a line item modifier: the name is + cheese and the quantity + + is 1. The buyer has the option to order extra cheese (or no cheese). + If the buyer chooses + + the extra cheese option, the modifier quantity increases to 2. If the + buyer does not want + + any cheese, the modifier quantity is set to 0. + base_price_money: + type: optional + docs: >- + The base price for the modifier. + + + `base_price_money` is required for ad hoc modifiers. + + If both `catalog_object_id` and `base_price_money` are set, + `base_price_money` will + + override the predefined [CatalogModifier](entity:CatalogModifier) + price. + total_price_money: + type: optional + docs: >- + The total price of the item modifier for its line item. + + This is the modifier's `base_price_money` multiplied by the line + item's quantity. + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this order. Metadata fields are + intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + source: + openapi: openapi/openapi.json + OrderLineItemPricingBlocklists: + docs: >- + Describes pricing adjustments that are blocked from automatic + + application to a line item. For more information, see + + [Apply Taxes and + Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). + properties: + blocked_discounts: + type: >- + optional>> + docs: >- + A list of discounts blocked from applying to the line item. + + Discounts can be blocked by the `discount_uid` (for ad hoc discounts) + or + + the `discount_catalog_object_id` (for catalog discounts). + blocked_taxes: + type: optional>> + docs: |- + A list of taxes blocked from applying to the line item. + Taxes can be blocked by the `tax_uid` (for ad hoc taxes) or + the `tax_catalog_object_id` (for catalog taxes). + source: + openapi: openapi/openapi.json + OrderLineItemPricingBlocklistsBlockedDiscount: + docs: >- + A discount to block from applying to a line item. The discount must be + + identified by either `discount_uid` or `discount_catalog_object_id`, but + not both. + properties: + uid: + type: optional> + docs: A unique ID of the `BlockedDiscount` within the order. + validation: + maxLength: 60 + discount_uid: + type: optional> + docs: >- + The `uid` of the discount that should be blocked. Use this field to + block + + ad hoc discounts. For catalog discounts, use the + `discount_catalog_object_id` field. + validation: + maxLength: 60 + discount_catalog_object_id: + type: optional> + docs: >- + The `catalog_object_id` of the discount that should be blocked. + + Use this field to block catalog discounts. For ad hoc discounts, use + the + + `discount_uid` field. + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + OrderLineItemPricingBlocklistsBlockedTax: + docs: |- + A tax to block from applying to a line item. The tax must be + identified by either `tax_uid` or `tax_catalog_object_id`, but not both. + properties: + uid: + type: optional> + docs: A unique ID of the `BlockedTax` within the order. + validation: + maxLength: 60 + tax_uid: + type: optional> + docs: >- + The `uid` of the tax that should be blocked. Use this field to block + + ad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` + field. + validation: + maxLength: 60 + tax_catalog_object_id: + type: optional> + docs: |- + The `catalog_object_id` of the tax that should be blocked. + Use this field to block catalog taxes. For ad hoc taxes, use the + `tax_uid` field. + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + OrderLineItemTax: + docs: >- + Represents a tax that applies to one or more line item in the order. + + + Fixed-amount, order-scoped taxes are distributed across all non-zero line + item totals. + + The amount distributed to each line item is relative to the amount the + item + + contributes to the order subtotal. + properties: + uid: + type: optional> + docs: A unique ID that identifies the tax only within this order. + validation: + maxLength: 60 + catalog_object_id: + type: optional> + docs: The catalog object ID referencing [CatalogTax](entity:CatalogTax). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this tax references. + name: + type: optional> + docs: The tax's name. + validation: + maxLength: 255 + type: + type: optional + docs: >- + Indicates the calculation method used to apply the tax. + + See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible + values + percentage: + type: optional> + docs: >- + The percentage of the tax, as a string representation of a decimal + + number. For example, a value of `"7.25"` corresponds to a percentage + of + + 7.25%. + validation: + maxLength: 10 + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this tax. Metadata fields are + intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + applied_money: + type: optional + docs: |- + The amount of money applied to the order by the tax. + + - For percentage-based taxes, `applied_money` is the money + calculated using the percentage. + scope: + type: optional + docs: >- + Indicates the level at which the tax applies. For `ORDER` scoped + taxes, + + Square generates references in `applied_taxes` on all order line items + that do + + not have them. For `LINE_ITEM` scoped taxes, the tax only applies to + line items + + with references in their `applied_taxes` field. + + + This field is immutable. To change the scope, you must delete the tax + and + + re-add it as a new tax. + + See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible + values + auto_applied: + type: optional + docs: >- + Determines whether the tax was automatically applied to the order + based on + + the catalog configuration. For an example, see + + [Automatically Apply Taxes to an + Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes). + access: read-only + source: + openapi: openapi/openapi.json + OrderLineItemTaxScope: + enum: + - OTHER_TAX_SCOPE + - LINE_ITEM + - ORDER + docs: Indicates whether this is a line-item or order-level tax. + source: + openapi: openapi/openapi.json + OrderLineItemTaxType: + enum: + - UNKNOWN_TAX + - ADDITIVE + - INCLUSIVE + docs: Indicates how the tax is applied to the associated line item or order. + source: + openapi: openapi/openapi.json + OrderMoneyAmounts: + docs: A collection of various money amounts. + properties: + total_money: + type: optional + docs: The total money. + tax_money: + type: optional + docs: The money associated with taxes. + discount_money: + type: optional + docs: The money associated with discounts. + tip_money: + type: optional + docs: The money associated with tips. + service_charge_money: + type: optional + docs: The money associated with service charges. + source: + openapi: openapi/openapi.json + OrderPricingOptions: + docs: >- + Pricing options for an order. The options affect how the order's price is + calculated. + + They can be used, for example, to apply automatic price adjustments that + are based on preconfigured + + [pricing rules](entity:CatalogPricingRule). + properties: + auto_apply_discounts: + type: optional> + docs: |- + The option to determine whether pricing rule-based + discounts are automatically applied to an order. + auto_apply_taxes: + type: optional> + docs: >- + The option to determine whether rule-based taxes are automatically + + applied to an order when the criteria of the corresponding rules are + met. + source: + openapi: openapi/openapi.json + OrderQuantityUnit: + docs: >- + Contains the measurement unit for a quantity and a precision that + + specifies the number of digits after the decimal point for decimal + quantities. + properties: + measurement_unit: + type: optional + docs: |- + A [MeasurementUnit](entity:MeasurementUnit) that represents the + unit of measure for the quantity. + precision: + type: optional> + docs: >- + For non-integer quantities, represents the number of digits after the + decimal point that are + + recorded for this quantity. + + + For example, a precision of 1 allows quantities such as `"1.0"` and + `"1.1"`, but not `"1.01"`. + + + Min: 0. Max: 5. + catalog_object_id: + type: optional> + docs: |- + The catalog object ID referencing the + [CatalogMeasurementUnit](entity:CatalogMeasurementUnit). + + This field is set when this is a catalog-backed measurement unit. + catalog_version: + type: optional> + docs: >- + The version of the catalog object that this measurement unit + references. + + + This field is set when this is a catalog-backed measurement unit. + source: + openapi: openapi/openapi.json + OrderReturn: + docs: >- + The set of line items, service charges, taxes, discounts, tips, and other + items being returned in an order. + properties: + uid: + type: optional> + docs: A unique ID that identifies the return only within this order. + validation: + maxLength: 60 + source_order_id: + type: optional> + docs: >- + An order that contains the original sale of these return line items. + This is unset + + for unlinked returns. + return_line_items: + type: optional>> + docs: A collection of line items that are being returned. + return_service_charges: + type: optional>> + docs: A collection of service charges that are being returned. + return_taxes: + type: optional> + docs: >- + A collection of references to taxes being returned for an order, + including the total + + applied tax amount to be returned. The taxes must reference a + top-level tax ID from the source + + order. + access: read-only + return_discounts: + type: optional> + docs: >- + A collection of references to discounts being returned for an order, + including the total + + applied discount amount to be returned. The discounts must reference a + top-level discount ID + + from the source order. + access: read-only + return_tips: + type: optional>> + docs: A collection of references to tips being returned for an order. + rounding_adjustment: + type: optional + docs: >- + A positive or negative rounding adjustment to the total value being + returned. Adjustments are commonly + + used to apply cash rounding when the minimum unit of the account is + smaller than the lowest + + physical denomination of the currency. + return_amounts: + type: optional + docs: An aggregate monetary value being returned by this return entry. + source: + openapi: openapi/openapi.json + OrderReturnDiscount: + docs: >- + Represents a discount being returned that applies to one or more return + line items in an + + order. + + + Fixed-amount, order-scoped discounts are distributed across all non-zero + return line item totals. + + The amount distributed to each return line item is relative to that item’s + contribution to the + + order subtotal. + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the returned discount only within this + order. + validation: + maxLength: 60 + source_discount_uid: + type: optional> + docs: >- + The discount `uid` from the order that contains the original + application of this discount. + validation: + maxLength: 60 + catalog_object_id: + type: optional> + docs: >- + The catalog object ID referencing + [CatalogDiscount](entity:CatalogDiscount). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this discount references. + name: + type: optional> + docs: The discount's name. + validation: + maxLength: 255 + type: + type: optional + docs: >- + The type of the discount. If it is created by the API, it is + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + + + Discounts that do not reference a catalog object ID must have a type + of + + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + + See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for + possible values + percentage: + type: optional> + docs: >- + The percentage of the tax, as a string representation of a decimal + number. + + A value of `"7.25"` corresponds to a percentage of 7.25%. + + + `percentage` is not set for amount-based discounts. + validation: + maxLength: 10 + amount_money: + type: optional + docs: |- + The total declared monetary amount of the discount. + + `amount_money` is not set for percentage-based discounts. + applied_money: + type: optional + docs: >- + The amount of discount actually applied to this line item. When an + amount-based + + discount is at the order level, this value is different from + `amount_money` because the discount + + is distributed across the line items. + scope: + type: optional + docs: >- + Indicates the level at which the `OrderReturnDiscount` applies. For + `ORDER` scoped + + discounts, the server generates references in `applied_discounts` on + all + + `OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount + is only applied to + + `OrderReturnLineItem`s with references in their `applied_discounts` + field. + + See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for + possible values + source: + openapi: openapi/openapi.json + OrderReturnLineItem: + docs: The line item being returned in an order. + properties: + uid: + type: optional> + docs: A unique ID for this return line-item entry. + validation: + maxLength: 60 + source_line_item_uid: + type: optional> + docs: The `uid` of the line item in the original sale order. + validation: + maxLength: 60 + name: + type: optional> + docs: The name of the line item. + validation: + maxLength: 512 + quantity: + type: string + docs: |- + The quantity returned, formatted as a decimal number. + For example, `"3"`. + + Line items with a `quantity_unit` can have non-integer quantities. + For example, `"1.70000"`. + validation: + minLength: 1 + maxLength: 12 + quantity_unit: + type: optional + docs: >- + The unit and precision that this return line item's quantity is + measured in. + note: + type: optional> + docs: The note of the return line item. + validation: + maxLength: 2000 + catalog_object_id: + type: optional> + docs: >- + The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to + this return line item. + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this line item references. + variation_name: + type: optional> + docs: The name of the variation applied to this return line item. + validation: + maxLength: 400 + item_type: + type: optional + docs: >- + The type of line item: an itemized return, a non-itemized return + (custom amount), + + or the return of an unactivated gift card sale. + + See [OrderLineItemItemType](#type-orderlineitemitemtype) for possible + values + return_modifiers: + type: optional>> + docs: >- + The [CatalogModifier](entity:CatalogModifier)s applied to this line + item. + applied_taxes: + type: optional>> + docs: >- + The list of references to `OrderReturnTax` entities applied to the + return line item. Each + + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of + a top-level + + `OrderReturnTax` applied to the return line item. On reads, the + applied amount + + is populated. + applied_discounts: + type: optional>> + docs: >- + The list of references to `OrderReturnDiscount` entities applied to + the return line item. Each + + `OrderLineItemAppliedDiscount` has a `discount_uid` that references + the `uid` of a top-level + + `OrderReturnDiscount` applied to the return line item. On reads, the + applied amount + + is populated. + base_price_money: + type: optional + docs: The base price for a single unit of the line item. + variation_total_price_money: + type: optional + docs: >- + The total price of all item variations returned in this line item. + + The price is calculated as `base_price_money` multiplied by `quantity` + and + + does not include modifiers. + gross_return_money: + type: optional + docs: >- + The gross return amount of money calculated as (item base price + + modifiers price) * quantity. + total_tax_money: + type: optional + docs: The total amount of tax money to return for the line item. + total_discount_money: + type: optional + docs: The total amount of discount money to return for the line item. + total_money: + type: optional + docs: The total amount of money to return for this line item. + applied_service_charges: + type: optional>> + docs: >- + The list of references to `OrderReturnServiceCharge` entities applied + to the return + + line item. Each `OrderLineItemAppliedServiceCharge` has a + `service_charge_uid` that + + references the `uid` of a top-level `OrderReturnServiceCharge` applied + to the return line + + item. On reads, the applied amount is populated. + total_service_charge_money: + type: optional + docs: >- + The total amount of apportioned service charge money to return for the + line item. + source: + openapi: openapi/openapi.json + OrderReturnLineItemModifier: + docs: A line item modifier being returned. + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the return modifier only within this + order. + validation: + maxLength: 60 + source_modifier_uid: + type: optional> + docs: |- + The modifier `uid` from the order's line item that contains the + original sale of this line item modifier. + validation: + maxLength: 60 + catalog_object_id: + type: optional> + docs: >- + The catalog object ID referencing + [CatalogModifier](entity:CatalogModifier). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: >- + The version of the catalog object that this line item modifier + references. + name: + type: optional> + docs: The name of the item modifier. + validation: + maxLength: 255 + base_price_money: + type: optional + docs: >- + The base price for the modifier. + + + `base_price_money` is required for ad hoc modifiers. + + If both `catalog_object_id` and `base_price_money` are set, + `base_price_money` overrides the predefined + [CatalogModifier](entity:CatalogModifier) price. + total_price_money: + type: optional + docs: >- + The total price of the item modifier for its line item. + + This is the modifier's `base_price_money` multiplied by the line + item's quantity. + quantity: + type: optional> + docs: >- + The quantity of the line item modifier. The modifier quantity can be 0 + or more. + + For example, suppose a restaurant offers a cheeseburger on the menu. + When a buyer orders + + this item, the restaurant records the purchase by creating an `Order` + object with a line item + + for a burger. The line item includes a line item modifier: the name is + cheese and the quantity + + is 1. The buyer has the option to order extra cheese (or no cheese). + If the buyer chooses + + the extra cheese option, the modifier quantity increases to 2. If the + buyer does not want + + any cheese, the modifier quantity is set to 0. + source: + openapi: openapi/openapi.json + OrderReturnServiceCharge: + docs: Represents the service charge applied to the original order. + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the return service charge only within this + order. + validation: + maxLength: 60 + source_service_charge_uid: + type: optional> + docs: |- + The service charge `uid` from the order containing the original + service charge. `source_service_charge_uid` is `null` for + unlinked returns. + validation: + maxLength: 60 + name: + type: optional> + docs: The name of the service charge. + validation: + maxLength: 255 + catalog_object_id: + type: optional> + docs: >- + The catalog object ID of the associated + [OrderServiceCharge](entity:OrderServiceCharge). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this service charge references. + percentage: + type: optional> + docs: |- + The percentage of the service charge, as a string representation of + a decimal number. For example, a value of `"7.25"` corresponds to a + percentage of 7.25%. + + Either `percentage` or `amount_money` should be set, but not both. + validation: + maxLength: 10 + amount_money: + type: optional + docs: |- + The amount of a non-percentage-based service charge. + + Either `percentage` or `amount_money` should be set, but not both. + applied_money: + type: optional + docs: >- + The amount of money applied to the order by the service charge, + including + + any inclusive tax amounts, as calculated by Square. + + + - For fixed-amount service charges, `applied_money` is equal to + `amount_money`. + + - For percentage-based service charges, `applied_money` is the money + calculated using the percentage. + total_money: + type: optional + docs: >- + The total amount of money to collect for the service charge. + + + __NOTE__: If an inclusive tax is applied to the service charge, + `total_money` + + does not equal `applied_money` plus `total_tax_money` because the + inclusive + + tax amount is already included in both `applied_money` and + `total_tax_money`. + total_tax_money: + type: optional + docs: The total amount of tax money to collect for the service charge. + calculation_phase: + type: optional + docs: >- + The calculation phase after which to apply the service charge. + + See + [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) + for possible values + taxable: + type: optional> + docs: |- + Indicates whether the surcharge can be taxed. Service charges + calculated in the `TOTAL_PHASE` cannot be marked as taxable. + applied_taxes: + type: optional>> + docs: >- + The list of references to `OrderReturnTax` entities applied to the + + `OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a + `tax_uid` + + that references the `uid` of a top-level `OrderReturnTax` that is + being + + applied to the `OrderReturnServiceCharge`. On reads, the applied + amount is + + populated. + treatment_type: + type: optional + docs: >- + The treatment type of the service charge. + + See + [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) + for possible values + scope: + type: optional + docs: >- + Indicates the level at which the apportioned service charge applies. + For `ORDER` + + scoped service charges, Square generates references in + `applied_service_charges` on + + all order line items that do not have them. For `LINE_ITEM` scoped + service charges, + + the service charge only applies to line items with a service charge + reference in their + + `applied_service_charges` field. + + + This field is immutable. To change the scope of an apportioned service + charge, you must delete + + the apportioned service charge and re-add it as a new apportioned + service charge. + + See [OrderServiceChargeScope](#type-orderservicechargescope) for + possible values + source: + openapi: openapi/openapi.json + OrderReturnTax: + docs: >- + Represents a tax being returned that applies to one or more return line + items in an order. + + + Fixed-amount, order-scoped taxes are distributed across all non-zero + return line item totals. + + The amount distributed to each return line item is relative to that item’s + contribution to the + + order subtotal. + properties: + uid: + type: optional> + docs: A unique ID that identifies the returned tax only within this order. + validation: + maxLength: 60 + source_tax_uid: + type: optional> + docs: The tax `uid` from the order that contains the original tax charge. + validation: + maxLength: 60 + catalog_object_id: + type: optional> + docs: The catalog object ID referencing [CatalogTax](entity:CatalogTax). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this tax references. + name: + type: optional> + docs: The tax's name. + validation: + maxLength: 255 + type: + type: optional + docs: >- + Indicates the calculation method used to apply the tax. + + See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible + values + percentage: + type: optional> + docs: >- + The percentage of the tax, as a string representation of a decimal + number. + + For example, a value of `"7.25"` corresponds to a percentage of 7.25%. + validation: + maxLength: 10 + applied_money: + type: optional + docs: The amount of money applied by the tax in an order. + scope: + type: optional + docs: >- + Indicates the level at which the `OrderReturnTax` applies. For `ORDER` + scoped + + taxes, Square generates references in `applied_taxes` on all + + `OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax is only + applied to + + `OrderReturnLineItem`s with references in their `applied_discounts` + field. + + See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible + values + source: + openapi: openapi/openapi.json + OrderReturnTip: + docs: A tip being returned. + properties: + uid: + type: optional> + docs: A unique ID that identifies the tip only within this order. + validation: + maxLength: 60 + applied_money: + type: optional + docs: |- + The amount of tip being returned + -- + source_tender_uid: + type: optional> + docs: >- + The tender `uid` from the order that contains the original application + of this tip. + validation: + maxLength: 192 + source_tender_id: + type: optional> + docs: >- + The tender `id` from the order that contains the original application + of this tip. + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + OrderReward: + docs: |- + Represents a reward that can be applied to an order if the necessary + reward tier criteria are met. Rewards are created through the Loyalty API. + properties: + id: + type: string + docs: The identifier of the reward. + validation: + minLength: 1 + reward_tier_id: + type: string + docs: The identifier of the reward tier corresponding to this reward. + validation: + minLength: 1 + source: + openapi: openapi/openapi.json + OrderRoundingAdjustment: + docs: >- + A rounding adjustment of the money being returned. Commonly used to apply + cash rounding + + when the minimum unit of the account is smaller than the lowest physical + denomination of the currency. + properties: + uid: + type: optional> + docs: >- + A unique ID that identifies the rounding adjustment only within this + order. + validation: + maxLength: 60 + name: + type: optional> + docs: The name of the rounding adjustment from the original sale order. + amount_money: + type: optional + docs: The actual rounding adjustment amount. + source: + openapi: openapi/openapi.json + OrderServiceCharge: + docs: Represents a service charge applied to an order. + properties: + uid: + type: optional> + docs: A unique ID that identifies the service charge only within this order. + validation: + maxLength: 60 + name: + type: optional> + docs: The name of the service charge. + validation: + maxLength: 512 + catalog_object_id: + type: optional> + docs: >- + The catalog object ID referencing the service charge + [CatalogObject](entity:CatalogObject). + validation: + maxLength: 192 + catalog_version: + type: optional> + docs: The version of the catalog object that this service charge references. + percentage: + type: optional> + docs: >- + The service charge percentage as a string representation of a + + decimal number. For example, `"7.25"` indicates a service charge of + 7.25%. + + + Exactly 1 of `percentage` or `amount_money` should be set. + validation: + maxLength: 10 + amount_money: + type: optional + docs: |- + The amount of a non-percentage-based service charge. + + Exactly one of `percentage` or `amount_money` should be set. + applied_money: + type: optional + docs: >- + The amount of money applied to the order by the service charge, + + including any inclusive tax amounts, as calculated by Square. + + + - For fixed-amount service charges, `applied_money` is equal to + `amount_money`. + + - For percentage-based service charges, `applied_money` is the money + + calculated using the percentage. + total_money: + type: optional + docs: |- + The total amount of money to collect for the service charge. + + __Note__: If an inclusive tax is applied to the service charge, + `total_money` does not equal `applied_money` plus `total_tax_money` + because the inclusive tax amount is already included in both + `applied_money` and `total_tax_money`. + total_tax_money: + type: optional + docs: The total amount of tax money to collect for the service charge. + calculation_phase: + type: optional + docs: >- + The calculation phase at which to apply the service charge. + + See + [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) + for possible values + taxable: + type: optional> + docs: >- + Indicates whether the service charge can be taxed. If set to `true`, + + order-level taxes automatically apply to the service charge. Note that + + service charges calculated in the `TOTAL_PHASE` cannot be marked as + taxable. + applied_taxes: + type: optional>> + docs: >- + The list of references to the taxes applied to this service charge. + Each + + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of + a top-level + + `OrderLineItemTax` that is being applied to this service charge. On + reads, the amount applied + + is populated. + + + An `OrderLineItemAppliedTax` is automatically created on every taxable + service charge + + for all `ORDER` scoped taxes that are added to the order. + `OrderLineItemAppliedTax` records + + for `LINE_ITEM` scoped taxes must be added in requests for the tax to + apply to any taxable + + service charge. Taxable service charges have the `taxable` field set + to `true` and calculated + + in the `SUBTOTAL_PHASE`. + + + To change the amount of a tax, modify the referenced top-level tax. + metadata: + type: optional>>>> + docs: >- + Application-defined data attached to this service charge. Metadata + fields are intended + + to store descriptive references or associations with an entity in + another system or store brief + + information about the object. Square does not process this field; it + only stores and returns it + + in relevant API calls. Do not use metadata to store any sensitive + information (such as personally + + identifiable information or card details). + + + Keys written by applications must be 60 characters or less and must be + in the character set + + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by + Square. These keys are prefixed + + with a namespace, separated from the key with a ':' character. + + + Values have a maximum length of 255 characters. + + + An application can have up to 10 entries per metadata field. + + + Entries written by applications are private and can only be read or + modified by the same + + application. + + + For more information, see + [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + type: + type: optional + docs: >- + The type of the service charge. + + See [OrderServiceChargeType](#type-orderservicechargetype) for + possible values + treatment_type: + type: optional + docs: >- + The treatment type of the service charge. + + See + [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) + for possible values + scope: + type: optional + docs: >- + Indicates the level at which the apportioned service charge applies. + For `ORDER` + + scoped service charges, Square generates references in + `applied_service_charges` on + + all order line items that do not have them. For `LINE_ITEM` scoped + service charges, + + the service charge only applies to line items with a service charge + reference in their + + `applied_service_charges` field. + + + This field is immutable. To change the scope of an apportioned service + charge, you must delete + + the apportioned service charge and re-add it as a new apportioned + service charge. + + See [OrderServiceChargeScope](#type-orderservicechargescope) for + possible values + source: + openapi: openapi/openapi.json + OrderServiceChargeCalculationPhase: + enum: + - SUBTOTAL_PHASE + - TOTAL_PHASE + - APPORTIONED_PERCENTAGE_PHASE + - APPORTIONED_AMOUNT_PHASE + docs: >- + Represents a phase in the process of calculating order totals. + + Service charges are applied after the indicated phase. + + + [Read more about how order totals are + calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated) + source: + openapi: openapi/openapi.json + OrderServiceChargeScope: + enum: + - OTHER_SERVICE_CHARGE_SCOPE + - LINE_ITEM + - ORDER + docs: |- + Indicates whether this is a line-item or order-level apportioned + service charge. + source: + openapi: openapi/openapi.json + OrderServiceChargeTreatmentType: + enum: + - LINE_ITEM_TREATMENT + - APPORTIONED_TREATMENT + docs: >- + Indicates whether the service charge will be treated as a value-holding + line item or + + apportioned toward a line item. + source: + openapi: openapi/openapi.json + OrderServiceChargeType: + enum: + - AUTO_GRATUITY + - CUSTOM + source: + openapi: openapi/openapi.json + OrderSource: + docs: Represents the origination details of an order. + properties: + name: + type: optional> + docs: >- + The name used to identify the place (physical or digital) that an + order originates. + + If unset, the name defaults to the name of the application that + created the order. + source: + openapi: openapi/openapi.json + OrderState: + enum: + - OPEN + - COMPLETED + - CANCELED + - DRAFT + docs: The state of the order. + source: + openapi: openapi/openapi.json + PauseSubscriptionResponse: + docs: >- + Defines output parameters in a response from the + + [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The subscription to be paused by the scheduled `PAUSE` action. + actions: + type: optional> + docs: >- + The list of a `PAUSE` action and a possible `RESUME` action created by + the request. + source: + openapi: openapi/openapi.json + PayOrderResponse: + docs: >- + Defines the fields that are included in the response body of a request to + the + + [PayOrder](api-endpoint:Orders-PayOrder) endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + order: + type: optional + docs: The paid, updated [order](entity:Order). + source: + openapi: openapi/openapi.json + Payment: + docs: Represents a payment processed by the Square API. + properties: + id: + type: optional + docs: A unique ID for the payment. + validation: + maxLength: 192 + access: read-only + created_at: + type: optional + docs: The timestamp of when the payment was created, in RFC 3339 format. + validation: + maxLength: 32 + access: read-only + updated_at: + type: optional + docs: >- + The timestamp of when the payment was last updated, in RFC 3339 + format. + validation: + maxLength: 32 + access: read-only + amount_money: + type: optional + docs: >- + The amount processed for this payment, not including `tip_money`. + + + The amount is specified in the smallest denomination of the applicable + currency (for example, + + US dollar amounts are specified in cents). For more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + tip_money: + type: optional + docs: >- + The amount designated as a tip. + + + This amount is specified in the smallest denomination of the + applicable currency (for example, + + US dollar amounts are specified in cents). For more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + total_money: + type: optional + docs: >- + The total amount for the payment, including `amount_money` and + `tip_money`. + + This amount is specified in the smallest denomination of the + applicable currency (for example, + + US dollar amounts are specified in cents). For more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + app_fee_money: + type: optional + docs: >- + The amount the developer is taking as a fee for facilitating the + payment on behalf + + of the seller. This amount is specified in the smallest denomination + of the applicable currency + + (for example, US dollar amounts are specified in cents). For more + information, + + see [Take Payments and Collect + Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + + The amount cannot be more than 90% of the `total_money` value. + + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth + permission is required. + + For more information, see + [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + approved_money: + type: optional + docs: >- + The amount of money approved for this payment. This value may change + if Square chooses to + + obtain reauthorization as part of a call to + [UpdatePayment](api-endpoint:Payments-UpdatePayment). + processing_fee: + type: optional> + docs: >- + The processing fees and fee adjustments assessed by Square for this + payment. + access: read-only + refunded_money: + type: optional + docs: >- + The total amount of the payment refunded to date. + + + This amount is specified in the smallest denomination of the + applicable currency (for example, + + US dollar amounts are specified in cents). + status: + type: optional + docs: >- + Indicates whether the payment is APPROVED, PENDING, COMPLETED, + CANCELED, or FAILED. + validation: + maxLength: 50 + access: read-only + delay_duration: + type: optional + docs: >- + The duration of time after the payment's creation when Square + automatically applies the + + `delay_action` to the payment. This automatic `delay_action` applies + only to payments that + + do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before + the `delay_duration` + + time period. + + + This field is specified as a time duration, in RFC 3339 format. + + + Notes: + + This feature is only supported for card payments. + + + Default: + + + - Card-present payments: "PT36H" (36 hours) from the creation time. + + - Card-not-present payments: "P7D" (7 days) from the creation time. + access: read-only + delay_action: + type: optional> + docs: >- + The action to be applied to the payment when the `delay_duration` has + elapsed. + + + Current values include `CANCEL` and `COMPLETE`. + delayed_until: + type: optional + docs: >- + The read-only timestamp of when the `delay_action` is automatically + applied, + + in RFC 3339 format. + + + Note that this field is calculated by summing the payment's + `delay_duration` and `created_at` + + fields. The `created_at` field is generated by Square and might not + exactly match the + + time on your local machine. + access: read-only + source_type: + type: optional + docs: >- + The source type for this payment. + + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, + `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`, + + `CASH` and `EXTERNAL`. For information about these payment source + types, + + see [Take + Payments](https://developer.squareup.com/docs/payments-api/take-payments). + validation: + maxLength: 50 + access: read-only + card_details: + type: optional + docs: >- + Details about a card payment. These details are only populated if the + source_type is `CARD`. + cash_details: + type: optional + docs: >- + Details about a cash payment. These details are only populated if the + source_type is `CASH`. + bank_account_details: + type: optional + docs: >- + Details about a bank account payment. These details are only populated + if the source_type is `BANK_ACCOUNT`. + external_details: + type: optional + docs: |- + Details about an external payment. The details are only populated + if the `source_type` is `EXTERNAL`. + wallet_details: + type: optional + docs: |- + Details about an wallet payment. The details are only populated + if the `source_type` is `WALLET`. + buy_now_pay_later_details: + type: optional + docs: >- + Details about a Buy Now Pay Later payment. The details are only + populated + + if the `source_type` is `BUY_NOW_PAY_LATER`. For more information, + see + + [Afterpay + Payments](https://developer.squareup.com/docs/payments-api/take-payments/afterpay-payments). + square_account_details: + type: optional + docs: |- + Details about a Square Account payment. The details are only populated + if the `source_type` is `SQUARE_ACCOUNT`. + location_id: + type: optional + docs: The ID of the location associated with the payment. + validation: + maxLength: 50 + access: read-only + order_id: + type: optional + docs: The ID of the order associated with the payment. + validation: + maxLength: 192 + access: read-only + reference_id: + type: optional + docs: |- + An optional ID that associates the payment with an entity in + another system. + validation: + maxLength: 40 + access: read-only + customer_id: + type: optional + docs: >- + The ID of the customer associated with the payment. If the ID is + + not provided in the `CreatePayment` request that was used to create + the `Payment`, + + Square may use information in the request + + (such as the billing and shipping address, email address, and payment + source) + + to identify a matching customer profile in the Customer Directory. + + If found, the profile ID is used. If a profile is not found, the + + API attempts to create an + + [instant + profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + + If the API cannot create an + + instant profile (either because the seller has disabled it or the + + seller's region prevents creating it), this field remains unset. Note + that + + this process is asynchronous and it may take some time before a + + customer ID is added to the payment. + validation: + maxLength: 191 + access: read-only + employee_id: + type: optional + docs: |- + __Deprecated__: Use `Payment.team_member_id` instead. + + An optional ID of the employee associated with taking the payment. + validation: + maxLength: 192 + access: read-only + team_member_id: + type: optional> + docs: >- + An optional ID of the [TeamMember](entity:TeamMember) associated with + taking the payment. + validation: + maxLength: 192 + refund_ids: + type: optional> + docs: A list of `refund_id`s identifying refunds for the payment. + access: read-only + risk_evaluation: + type: optional + docs: >- + Provides information about the risk associated with the payment, as + determined by Square. + + This field is present for payments to sellers that have opted in to + receive risk + + evaluations. + terminal_checkout_id: + type: optional + docs: >- + An optional ID for a Terminal checkout that is associated with the + payment. + access: read-only + buyer_email_address: + type: optional + docs: The buyer's email address. + validation: + maxLength: 255 + access: read-only + billing_address: + type: optional
+ docs: The buyer's billing address. + shipping_address: + type: optional
+ docs: The buyer's shipping address. + note: + type: optional + docs: An optional note to include when creating a payment. + validation: + maxLength: 500 + access: read-only + statement_description_identifier: + type: optional + docs: >- + Additional payment information that gets added to the customer's card + statement + + as part of the statement description. + + + Note that the `statement_description_identifier` might get truncated + on the statement description + + to fit the required information including the Square identifier (SQ *) + and the name of the + + seller taking the payment. + access: read-only + capabilities: + type: optional> + docs: |- + Actions that can be performed on this payment: + - `EDIT_AMOUNT_UP` - The payment amount can be edited up. + - `EDIT_AMOUNT_DOWN` - The payment amount can be edited down. + - `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up. + - `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down. + - `EDIT_DELAY_ACTION` - The delay_action can be edited. + access: read-only + receipt_number: + type: optional + docs: |- + The payment's receipt number. + The field is missing if a payment is canceled. + validation: + maxLength: 4 + access: read-only + receipt_url: + type: optional + docs: |- + The URL for the payment's receipt. + The field is only populated for COMPLETED payments. + validation: + maxLength: 255 + access: read-only + device_details: + type: optional + docs: Details about the device that took the payment. + application_details: + type: optional + docs: Details about the application that took the payment. + is_offline_payment: + type: optional + docs: Whether or not this payment was taken offline. + access: read-only + offline_payment_details: + type: optional + docs: Additional information about the payment if it was taken offline. + version_token: + type: optional> + docs: >- + Used for optimistic concurrency. This opaque token identifies a + specific version of the + + `Payment` object. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityAppFeeRefundDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + refund_id: + type: optional> + docs: The ID of the refund associated with this activity. + location_id: + type: optional> + docs: >- + The ID of the location of the merchant associated with the payment + refund activity + source: + openapi: openapi/openapi.json + PaymentBalanceActivityAppFeeRevenueDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + location_id: + type: optional> + docs: >- + The ID of the location of the merchant associated with the payment + activity + source: + openapi: openapi/openapi.json + PaymentBalanceActivityAutomaticSavingsDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + payout_id: + type: optional> + docs: The ID of the payout associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityAutomaticSavingsReversedDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + payout_id: + type: optional> + docs: The ID of the payout associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityChargeDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityDepositFeeDetail: + properties: + payout_id: + type: optional> + docs: The ID of the payout that triggered this deposit fee activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityDepositFeeReversedDetail: + properties: + payout_id: + type: optional> + docs: The ID of the payout that triggered this deposit fee activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityDisputeDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + dispute_id: + type: optional> + docs: The ID of the dispute associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityFeeDetail: + properties: + payment_id: + type: optional> + docs: >- + The ID of the payment associated with this activity + + This will only be populated when a principal LedgerEntryToken is also + populated. + + If the fee is independent (there is no principal LedgerEntryToken) + then this will likely not + + be populated. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityFreeProcessingDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityHoldAdjustmentDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityOpenDisputeDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + dispute_id: + type: optional> + docs: The ID of the dispute associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityOtherAdjustmentDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityOtherDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityRefundDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + refund_id: + type: optional> + docs: The ID of the refund associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityReleaseAdjustmentDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityReserveHoldDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityReserveReleaseDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivitySquareCapitalPaymentDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivitySquareCapitalReversedPaymentDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivitySquarePayrollTransferDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivitySquarePayrollTransferReversedDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityTaxOnFeeDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + tax_rate_description: + type: optional> + docs: >- + The description of the tax rate being applied. For example: "GST", + "HST". + source: + openapi: openapi/openapi.json + PaymentBalanceActivityThirdPartyFeeDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + source: + openapi: openapi/openapi.json + PaymentBalanceActivityThirdPartyFeeRefundDetail: + properties: + payment_id: + type: optional> + docs: The ID of the payment associated with this activity. + refund_id: + type: optional> + docs: The public refund id associated with this activity. + source: + openapi: openapi/openapi.json + PaymentLink: + properties: + id: + type: optional + docs: The Square-assigned ID of the payment link. + access: read-only + version: + type: integer + docs: >- + The Square-assigned version number, which is incremented each time an + update is committed to the payment link. + validation: + max: 65535 + description: + type: optional> + docs: |- + The optional description of the `payment_link` object. + It is primarily for use by your application and is not used anywhere. + validation: + maxLength: 4096 + order_id: + type: optional + docs: The ID of the order associated with the payment link. + validation: + maxLength: 192 + access: read-only + checkout_options: + type: optional + docs: >- + The checkout options configured for the payment link. + + For more information, see [Optional Checkout + Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + pre_populated_data: + type: optional + docs: |- + Describes buyer data to prepopulate + on the checkout page. + url: + type: optional + docs: The shortened URL of the payment link. + validation: + maxLength: 255 + access: read-only + long_url: + type: optional + docs: The long URL of the payment link. + validation: + maxLength: 255 + access: read-only + created_at: + type: optional + docs: The timestamp when the payment link was created, in RFC 3339 format. + updated_at: + type: optional + docs: >- + The timestamp when the payment link was last updated, in RFC 3339 + format. + payment_note: + type: optional> + docs: >- + An optional note. After Square processes the payment, this note is + added to the + + resulting `Payment`. + validation: + maxLength: 500 + source: + openapi: openapi/openapi.json + PaymentLinkRelatedResources: + properties: + orders: + type: optional>> + docs: The order associated with the payment link. + subscription_plans: + type: optional>> + docs: The subscription plan associated with the payment link. + source: + openapi: openapi/openapi.json + PaymentOptions: + properties: + autocomplete: + type: optional> + docs: >- + Indicates whether the `Payment` objects created from this + `TerminalCheckout` are + + automatically `COMPLETED` or left in an `APPROVED` state for later + modification. + + + Default: true + delay_duration: + type: optional> + docs: >- + The duration of time after the payment's creation when Square + automatically resolves the + + payment. This automatic resolution applies only to payments that do + not reach a terminal state + + (`COMPLETED` or `CANCELED`) before the `delay_duration` time period. + + + This parameter should be specified as a time duration, in RFC 3339 + format, with a minimum value + + of 1 minute and a maximum value of 36 hours. This feature is only + supported for card payments, + + and all payments will be considered card-present. + + + This parameter can only be set for a delayed capture payment + (`autocomplete=false`). For more + + information, see [Delayed + Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + + Default: "PT36H" (36 hours) from the creation time + accept_partial_authorization: + type: optional> + docs: >- + If set to `true` and charging a Square Gift Card, a payment might be + returned with + + `amount_money` equal to less than what was requested. For example, a + request for $20 when charging + + a Square Gift Card with a balance of $5 results in an APPROVED payment + of $5. You might choose + + to prompt the buyer for an additional payment to cover the remainder + or cancel the Gift Card + + payment. + + + This parameter can only be set for a delayed capture payment + (`autocomplete=false`). + + + For more information, see [Take Partial + Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards). + + + Default: false + delay_action: + type: optional + docs: >- + The action to be applied to the `Payment` when the delay_duration has + elapsed. + + The action must be CANCEL or COMPLETE. + + + The action cannot be set to COMPLETE if an `order_id` is present on + the TerminalCheckout. + + + This parameter can only be set for a delayed capture payment + (`autocomplete=false`). For more + + information, see [Delayed + Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + + Default: CANCEL + + See [DelayAction](#type-delayaction) for possible values + source: + openapi: openapi/openapi.json + PaymentOptionsDelayAction: + enum: + - CANCEL + - COMPLETE + docs: >- + Describes the action to be applied to a delayed capture payment when the + delay_duration + + has elapsed. + source: + openapi: openapi/openapi.json + PaymentRefund: + docs: >- + Represents a refund of a payment made using Square. Contains information + about + + the original payment and the amount of money refunded. + properties: + id: + type: string + docs: The unique ID for this refund, generated by Square. + validation: + minLength: 1 + maxLength: 255 + status: + type: optional> + docs: |- + The refund's status: + - `PENDING` - Awaiting approval. + - `COMPLETED` - Successfully completed. + - `REJECTED` - The refund was rejected. + - `FAILED` - An error occurred. + validation: + maxLength: 50 + location_id: + type: optional> + docs: >- + The location ID associated with the payment this refund is attached + to. + validation: + maxLength: 50 + unlinked: + type: optional + docs: >- + Flag indicating whether or not the refund is linked to an existing + payment in Square. + access: read-only + destination_type: + type: optional> + docs: >- + The destination type for this refund. + + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, + `BUY_NOW_PAY_LATER`, `CASH`, + + `EXTERNAL`, and `SQUARE_ACCOUNT`. + validation: + maxLength: 50 + destination_details: + type: optional + docs: >- + Contains information about the refund destination. This field is + populated only if + + `destination_id` is defined in the `RefundPayment` request. + amount_money: + type: Money + docs: >- + The amount of money refunded. This amount is specified in the smallest + denomination + + of the applicable currency (for example, US dollar amounts are + specified in cents). + app_fee_money: + type: optional + docs: >- + The amount of money the application developer contributed to help + cover the refunded amount. + + This amount is specified in the smallest denomination of the + applicable currency (for example, + + US dollar amounts are specified in cents). For more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + processing_fee: + type: optional>> + docs: >- + Processing fees and fee adjustments assessed by Square for this + refund. + payment_id: + type: optional> + docs: The ID of the payment associated with this refund. + validation: + maxLength: 192 + order_id: + type: optional> + docs: The ID of the order associated with the refund. + validation: + maxLength: 192 + reason: + type: optional> + docs: The reason for the refund. + validation: + maxLength: 192 + created_at: + type: optional + docs: The timestamp of when the refund was created, in RFC 3339 format. + validation: + maxLength: 32 + access: read-only + updated_at: + type: optional + docs: The timestamp of when the refund was last updated, in RFC 3339 format. + validation: + maxLength: 32 + access: read-only + team_member_id: + type: optional + docs: An optional ID of the team member associated with taking the payment. + validation: + maxLength: 192 + access: read-only + terminal_refund_id: + type: optional + docs: An optional ID for a Terminal refund. + access: read-only + source: + openapi: openapi/openapi.json + Payout: + docs: >- + An accounting of the amount owed the seller and record of the actual + transfer to their + + external bank account or to the Square balance. + properties: + id: + type: string + docs: A unique ID for the payout. + validation: + minLength: 1 + status: + type: optional + docs: |- + Indicates the payout status. + See [PayoutStatus](#type-payoutstatus) for possible values + location_id: + type: string + docs: The ID of the location associated with the payout. + validation: + minLength: 1 + created_at: + type: optional + docs: >- + The timestamp of when the payout was created and submitted for deposit + to the seller's banking destination, in RFC 3339 format. + updated_at: + type: optional + docs: The timestamp of when the payout was last updated, in RFC 3339 format. + amount_money: + type: optional + docs: >- + The amount of money involved in the payout. A positive amount + indicates a deposit, and a negative amount indicates a withdrawal. + This amount is never zero. + destination: + type: optional + docs: >- + Information about the banking destination (such as a bank account, + Square checking account, or debit card) + + against which the payout was made. + version: + type: optional + docs: >- + The version number, which is incremented each time an update is made + to this payout record. + + The version number helps developers receive event notifications or + feeds out of order. + type: + type: optional + docs: |- + Indicates the payout type. + See [PayoutType](#type-payouttype) for possible values + payout_fee: + type: optional>> + docs: >- + A list of transfer fees and any taxes on the fees assessed by Square + for this payout. + arrival_date: + type: optional> + docs: >- + The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is + due to arrive in the seller’s banking destination. + end_to_end_id: + type: optional> + docs: >- + A unique ID for each `Payout` object that might also appear on the + seller’s bank statement. You can use this ID to automate the process + of reconciling each payout with the corresponding line item on the + bank statement. + source: + openapi: openapi/openapi.json + PayoutEntry: + docs: >- + One or more PayoutEntries that make up a Payout. Each one has a date, + amount, and type of activity. + + The total amount of the payout will equal the sum of the payout entries + for a batch payout + properties: + id: + type: string + docs: A unique ID for the payout entry. + validation: + minLength: 1 + payout_id: + type: string + docs: The ID of the payout entries’ associated payout. + validation: + minLength: 1 + effective_at: + type: optional> + docs: >- + The timestamp of when the payout entry affected the balance, in RFC + 3339 format. + type: + type: optional + docs: |- + The type of activity associated with this payout entry. + See [ActivityType](#type-activitytype) for possible values + gross_amount_money: + type: optional + docs: The amount of money involved in this payout entry. + fee_amount_money: + type: optional + docs: The amount of Square fees associated with this payout entry. + net_amount_money: + type: optional + docs: The net proceeds from this transaction after any fees. + type_app_fee_revenue_details: + type: optional + docs: Details of any developer app fee revenue generated on a payment. + type_app_fee_refund_details: + type: optional + docs: Details of a refund for an app fee on a payment. + type_automatic_savings_details: + type: optional + docs: >- + Details of any automatic transfer from the payment processing balance + to the Square Savings account. These are, generally, proportional to + the merchant's sales. + type_automatic_savings_reversed_details: + type: optional + docs: >- + Details of any automatic transfer from the Square Savings account back + to the processing balance. These are, generally, proportional to the + merchant's refunds. + type_charge_details: + type: optional + docs: Details of credit card payment captures. + type_deposit_fee_details: + type: optional + docs: >- + Details of any fees involved with deposits such as for instant + deposits. + type_deposit_fee_reversed_details: + type: optional + docs: >- + Details of any reversal or refund of fees involved with deposits such + as for instant deposits. + type_dispute_details: + type: optional + docs: Details of any balance change due to a dispute event. + type_fee_details: + type: optional + docs: Details of adjustments due to the Square processing fee. + type_free_processing_details: + type: optional + docs: >- + Square offers Free Payments Processing for a variety of business + scenarios including seller referral or when Square wants to apologize + for a bug, customer service, repricing complication, and so on. This + entry represents details of any credit to the merchant for the + purposes of Free Processing. + type_hold_adjustment_details: + type: optional + docs: >- + Details of any adjustment made by Square related to the holding or + releasing of a payment. + type_open_dispute_details: + type: optional + docs: Details of any open disputes. + type_other_details: + type: optional + docs: >- + Details of any other type that does not belong in the rest of the + types. + type_other_adjustment_details: + type: optional + docs: >- + Details of any other type of adjustments that don't fall under + existing types. + type_refund_details: + type: optional + docs: Details of a refund for an existing card payment. + type_release_adjustment_details: + type: optional + docs: Details of fees released for adjustments. + type_reserve_hold_details: + type: optional + docs: Details of fees paid for funding risk reserve. + type_reserve_release_details: + type: optional + docs: Details of fees released from risk reserve. + type_square_capital_payment_details: + type: optional + docs: >- + Details of capital merchant cash advance (MCA) assessments. These are, + generally, proportional to the merchant's sales but may be issued for + other reasons related to the MCA. + type_square_capital_reversed_payment_details: + type: optional + docs: >- + Details of capital merchant cash advance (MCA) assessment refunds. + These are, generally, proportional to the merchant's refunds but may + be issued for other reasons related to the MCA. + type_tax_on_fee_details: + type: optional + docs: Details of tax paid on fee amounts. + type_third_party_fee_details: + type: optional + docs: Details of fees collected by a 3rd party platform. + type_third_party_fee_refund_details: + type: optional + docs: Details of refunded fees from a 3rd party platform. + type_square_payroll_transfer_details: + type: optional + docs: >- + Details of a payroll payment that was transferred to a team member’s + bank account. + type_square_payroll_transfer_reversed_details: + type: optional + docs: >- + Details of a payroll payment to a team member’s bank account that was + deposited back to the seller’s account by Square. + source: + openapi: openapi/openapi.json + PayoutFee: + docs: Represents a payout fee that can incur as part of a payout. + properties: + amount_money: + type: optional + docs: The money amount of the payout fee. + effective_at: + type: optional> + docs: The timestamp of when the fee takes effect, in RFC 3339 format. + type: + type: optional + docs: |- + The type of fee assessed as part of the payout. + See [PayoutFeeType](#type-payoutfeetype) for possible values + source: + openapi: openapi/openapi.json + PayoutFeeType: + enum: + - TRANSFER_FEE + - TAX_ON_TRANSFER_FEE + docs: Represents the type of payout fee that can incur as part of a payout. + source: + openapi: openapi/openapi.json + PayoutStatus: + enum: + - SENT + - FAILED + - PAID + docs: Payout status types + source: + openapi: openapi/openapi.json + PayoutType: + enum: + - BATCH + - SIMPLE + docs: >- + The type of payout: “BATCH” or “SIMPLE”. + + BATCH payouts include a list of payout entries that can be considered + settled. + + SIMPLE payouts do not have any payout entries associated with them + + and will show up as one of the payout entries in a future BATCH payout. + source: + openapi: openapi/openapi.json + Phase: + docs: >- + Represents a phase, which can override subscription phases as defined by + plan_id + properties: + uid: + type: optional> + docs: id of subscription phase + ordinal: + type: optional> + docs: index of phase in total subscription plan + order_template_id: + type: optional> + docs: id of order to be used in billing + plan_phase_uid: + type: optional> + docs: the uid from the plan's phase in catalog + source: + openapi: openapi/openapi.json + PhaseInput: + docs: Represents the arguments used to construct a new phase. + properties: + ordinal: + type: long + docs: index of phase in total subscription plan + order_template_id: + type: optional> + docs: id of order to be used in billing + source: + openapi: openapi/openapi.json + PrePopulatedData: + docs: >- + Describes buyer data to prepopulate in the payment form. + + For more information, + + see [Optional Checkout + Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + properties: + buyer_email: + type: optional> + docs: The buyer email to prepopulate in the payment form. + validation: + maxLength: 256 + buyer_phone_number: + type: optional> + docs: The buyer phone number to prepopulate in the payment form. + validation: + maxLength: 17 + buyer_address: + type: optional
+ docs: The buyer address to prepopulate in the payment form. + source: + openapi: openapi/openapi.json + ProcessingFee: + docs: Represents the Square processing fee. + properties: + effective_at: + type: optional> + docs: The timestamp of when the fee takes effect, in RFC 3339 format. + type: + type: optional> + docs: >- + The type of fee assessed or adjusted. The fee type can be `INITIAL` or + `ADJUSTMENT`. + amount_money: + type: optional + docs: >- + The fee amount, which might be negative, that is assessed or adjusted + by Square. + + + Positive values represent funds being assessed, while negative values + represent + + funds being returned. + source: + openapi: openapi/openapi.json + Product: + enum: + - SQUARE_POS + - EXTERNAL_API + - BILLING + - APPOINTMENTS + - INVOICES + - ONLINE_STORE + - PAYROLL + - DASHBOARD + - ITEM_LIBRARY_IMPORT + - OTHER + docs: Indicates the Square product used to generate a change. + source: + openapi: openapi/openapi.json + ProductType: literal<"TERMINAL_API"> + PublishInvoiceResponse: + docs: Describes a `PublishInvoice` response. + properties: + invoice: + type: optional + docs: The published invoice. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + QrCodeOptions: + docs: Fields to describe the action that displays QR-Codes. + properties: + title: + type: string + docs: The title text to display in the QR code flow on the Terminal. + validation: + minLength: 1 + maxLength: 250 + body: + type: string + docs: The body text to display in the QR code flow on the Terminal. + validation: + minLength: 1 + maxLength: 10000 + barcode_contents: + type: string + docs: |- + The text representation of the data to show in the QR code + as UTF8-encoded data. + validation: + minLength: 1 + maxLength: 1024 + source: + openapi: openapi/openapi.json + QuickPay: + docs: >- + Describes an ad hoc item and price to generate a quick pay checkout link. + + For more information, + + see [Quick Pay + Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + properties: + name: + type: string + docs: >- + The ad hoc item name. In the resulting `Order`, this name appears as + the line item name. + validation: + minLength: 1 + maxLength: 255 + price_money: + type: Money + docs: The price of the item. + location_id: + type: string + docs: The ID of the business location the checkout is associated with. + source: + openapi: openapi/openapi.json + Range: + docs: The range of a number value between the specified lower and upper bounds. + properties: + min: + type: optional> + docs: >- + The lower bound of the number range. At least one of `min` or `max` + must be specified. + + If unspecified, the results will have no minimum value. + max: + type: optional> + docs: >- + The upper bound of the number range. At least one of `min` or `max` + must be specified. + + If unspecified, the results will have no maximum value. + source: + openapi: openapi/openapi.json + ReceiptOptions: + docs: Describes receipt action fields. + properties: + payment_id: + type: string + docs: The reference to the Square payment ID for the receipt. + print_only: + type: optional> + docs: >- + Instructs the device to print the receipt without displaying the + receipt selection screen. + + Requires `printer_enabled` set to true. + + Defaults to false. + is_duplicate: + type: optional> + docs: |- + Identify the receipt as a reprint rather than an original receipt. + Defaults to false. + source: + openapi: openapi/openapi.json + RedeemLoyaltyRewardResponse: + docs: >- + A response that includes the `LoyaltyEvent` published for redeeming the + reward. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + event: + type: optional + docs: The `LoyaltyEvent` for redeeming the reward. + source: + openapi: openapi/openapi.json + Refund: + docs: Represents a refund processed for a Square transaction. + properties: + id: + type: string + docs: The refund's unique ID. + validation: + maxLength: 255 + location_id: + type: string + docs: The ID of the refund's associated location. + validation: + maxLength: 50 + transaction_id: + type: optional> + docs: The ID of the transaction that the refunded tender is part of. + validation: + maxLength: 192 + tender_id: + type: string + docs: The ID of the refunded tender. + validation: + maxLength: 192 + created_at: + type: optional + docs: The timestamp for when the refund was created, in RFC 3339 format. + validation: + maxLength: 32 + access: read-only + reason: + type: string + docs: The reason for the refund being issued. + validation: + maxLength: 192 + amount_money: + type: Money + docs: The amount of money refunded to the buyer. + status: + type: RefundStatus + docs: |- + The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, + or `FAILED`). + See [RefundStatus](#type-refundstatus) for possible values + processing_fee_money: + type: optional + docs: The amount of Square processing fee money refunded to the *merchant*. + additional_recipients: + type: optional>> + docs: >- + Additional recipients (other than the merchant) receiving a portion of + this refund. + + For example, fees assessed on a refund of a purchase by a third party + integration. + source: + openapi: openapi/openapi.json + RefundPaymentResponse: + docs: >- + Defines the response returned by + + [RefundPayment](api-endpoint:Refunds-RefundPayment). + + + If there are errors processing the request, the `refund` field might not + be + + present, or it might be present with a status of `FAILED`. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refund: + type: optional + docs: The successfully created `PaymentRefund`. + source: + openapi: openapi/openapi.json + RefundStatus: + enum: + - PENDING + - APPROVED + - REJECTED + - FAILED + docs: Indicates a refund's current status. + source: + openapi: openapi/openapi.json + RegisterDomainResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain) + endpoint. + + + Either `errors` or `status` are present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + status: + type: optional + docs: >- + The status of the domain registration. + + + See + [RegisterDomainResponseStatus](entity:RegisterDomainResponseStatus) + for possible values. + + See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) + for possible values + source: + openapi: openapi/openapi.json + RegisterDomainResponseStatus: + enum: + - PENDING + - VERIFIED + docs: The status of the domain registration. + source: + openapi: openapi/openapi.json + RemoveGroupFromCustomerResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer) + + endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + ResumeSubscriptionResponse: + docs: >- + Defines output parameters in a response from the + + [ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The resumed subscription. + actions: + type: optional> + docs: >- + A list of `RESUME` actions created by the request and scheduled for + the subscription. + source: + openapi: openapi/openapi.json + RetrieveBookingCustomAttributeDefinitionResponse: + docs: >- + Represents a + [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The retrieved custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveBookingCustomAttributeResponse: + docs: >- + Represents a + [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: >- + The retrieved custom attribute. If `with_definition` was set to `true` + in the request, + + the custom attribute definition is returned in the `definition` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetBookingResponse: + properties: + booking: + type: optional + docs: The booking that was requested. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetBusinessBookingProfileResponse: + properties: + business_booking_profile: + type: optional + docs: The seller's booking profile. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetCardResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [RetrieveCard](api-endpoint:Cards-RetrieveCard) endpoint. + + + Note: if there are errors processing the request, the card field will not + be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + card: + type: optional + docs: The retrieved card. + source: + openapi: openapi/openapi.json + GetCashDrawerShiftResponse: + properties: + cash_drawer_shift: + type: optional + docs: The cash drawer shift queried for. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetCatalogObjectResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + object: + type: optional + docs: The `CatalogObject`s returned. + related_objects: + type: optional> + docs: >- + A list of `CatalogObject`s referenced by the object in the `object` + field. + source: + openapi: openapi/openapi.json + GetCustomerCustomAttributeDefinitionResponse: + docs: >- + Represents a + [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The retrieved custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetCustomerCustomAttributeResponse: + docs: >- + Represents a + [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: >- + The retrieved custom attribute. If `with_definition` was set to `true` + in the request, + + the custom attribute definition is returned in the `definition` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetCustomerGroupResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [RetrieveCustomerGroup](api-endpoint:CustomerGroups-RetrieveCustomerGroup) + endpoint. + + + Either `errors` or `group` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + group: + type: optional + docs: The retrieved customer group. + source: + openapi: openapi/openapi.json + GetCustomerResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `RetrieveCustomer` endpoint. + + Either `errors` or `customer` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + customer: + type: optional + docs: The requested customer. + source: + openapi: openapi/openapi.json + GetCustomerSegmentResponse: + docs: >- + Defines the fields that are included in the response body for requests to + the `RetrieveCustomerSegment` endpoint. + + + Either `errors` or `segment` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + segment: + type: optional + docs: The retrieved customer segment. + source: + openapi: openapi/openapi.json + GetDisputeEvidenceResponse: + docs: Defines the fields in a `RetrieveDisputeEvidence` response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + evidence: + type: optional + docs: Metadata about the dispute evidence file. + source: + openapi: openapi/openapi.json + GetDisputeResponse: + docs: Defines fields in a `RetrieveDispute` response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + dispute: + type: optional + docs: Details about the requested `Dispute`. + source: + openapi: openapi/openapi.json + GetEmployeeResponse: + properties: + employee: optional + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetGiftCardFromGANResponse: + docs: >- + A response that contains a `GiftCard`. This response might contain a set + of `Error` objects + + if the request resulted in errors. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card: + type: optional + docs: >- + A gift card that was fetched, if present. It returns empty if an error + occurred. + source: + openapi: openapi/openapi.json + GetGiftCardFromNonceResponse: + docs: >- + A response that contains a `GiftCard` object. If the request resulted in + errors, + + the response contains a set of `Error` objects. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card: + type: optional + docs: The retrieved gift card. + source: + openapi: openapi/openapi.json + GetGiftCardResponse: + docs: >- + A response that contains a `GiftCard`. The response might contain a set of + `Error` objects + + if the request resulted in errors. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card: + type: optional + docs: The gift card retrieved. + source: + openapi: openapi/openapi.json + GetInventoryAdjustmentResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + adjustment: + type: optional + docs: The requested [InventoryAdjustment](entity:InventoryAdjustment). + source: + openapi: openapi/openapi.json + GetInventoryChangesResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + changes: + type: optional> + docs: The set of inventory changes for the requested object and locations. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + + this is the final response. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + source: + openapi: openapi/openapi.json + GetInventoryCountResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + counts: + type: optional> + docs: |- + The current calculated inventory counts for the requested object and + locations. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + + this is the final response. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + source: + openapi: openapi/openapi.json + GetInventoryPhysicalCountResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + count: + type: optional + docs: The requested [InventoryPhysicalCount](entity:InventoryPhysicalCount). + source: + openapi: openapi/openapi.json + GetInventoryTransferResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + transfer: + type: optional + docs: The requested [InventoryTransfer](entity:InventoryTransfer). + source: + openapi: openapi/openapi.json + RetrieveJobResponse: + docs: >- + Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) response. Either + `job` or `errors` + + is present in the response. + properties: + job: + type: optional + docs: The retrieved job. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveLocationBookingProfileResponse: + properties: + location_booking_profile: + type: optional + docs: The requested location booking profile. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveLocationCustomAttributeDefinitionResponse: + docs: >- + Represents a + [RetrieveLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The retrieved custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveLocationCustomAttributeResponse: + docs: >- + Represents a + [RetrieveLocationCustomAttribute](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: >- + The retrieved custom attribute. If `with_definition` was set to `true` + in the request, + + the custom attribute definition is returned in the `definition` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetLocationResponse: + docs: >- + Defines the fields that the + [RetrieveLocation](api-endpoint:Locations-RetrieveLocation) + + endpoint returns in a response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + location: + type: optional + docs: The requested location. + source: + openapi: openapi/openapi.json + RetrieveLocationSettingsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + location_settings: + type: optional + docs: The location settings. + source: + openapi: openapi/openapi.json + GetLoyaltyAccountResponse: + docs: A response that includes the loyalty account. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_account: + type: optional + docs: The loyalty account. + source: + openapi: openapi/openapi.json + GetLoyaltyProgramResponse: + docs: A response that contains the loyalty program. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + program: + type: optional + docs: The loyalty program that was requested. + source: + openapi: openapi/openapi.json + GetLoyaltyPromotionResponse: + docs: >- + Represents a + [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion) + response. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_promotion: + type: optional + docs: The retrieved loyalty promotion. + source: + openapi: openapi/openapi.json + GetLoyaltyRewardResponse: + docs: A response that includes the loyalty reward. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + reward: + type: optional + docs: The loyalty reward retrieved. + source: + openapi: openapi/openapi.json + RetrieveMerchantCustomAttributeDefinitionResponse: + docs: >- + Represents a + [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The retrieved custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveMerchantCustomAttributeResponse: + docs: >- + Represents a + [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: >- + The retrieved custom attribute. If `with_definition` was set to `true` + in the request, + + the custom attribute definition is returned in the `definition` field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetMerchantResponse: + docs: >- + The response object returned by the + [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) endpoint. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + merchant: + type: optional + docs: The requested `Merchant` object. + source: + openapi: openapi/openapi.json + RetrieveMerchantSettingsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + merchant_settings: + type: optional + docs: The merchant settings. + source: + openapi: openapi/openapi.json + RetrieveOrderCustomAttributeDefinitionResponse: + docs: Represents a response from getting an order custom attribute definition. + properties: + custom_attribute_definition: + type: optional + docs: The retrieved custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveOrderCustomAttributeResponse: + docs: Represents a response from getting an order custom attribute. + properties: + custom_attribute: + type: optional + docs: >- + The retrieved custom attribute. If `with_definition` was set to `true` + in the request, the custom attribute definition is returned in the + `definition field. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetOrderResponse: + properties: + order: + type: optional + docs: The requested order. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetPaymentLinkResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + payment_link: + type: optional + docs: The payment link that is retrieved. + source: + openapi: openapi/openapi.json + GetSnippetResponse: + docs: >- + Represents a `RetrieveSnippet` response. The response can include either + `snippet` or `errors`. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + snippet: + type: optional + docs: The retrieved snippet. + source: + openapi: openapi/openapi.json + GetSubscriptionResponse: + docs: >- + Defines output parameters in a response from the + + [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The subscription retrieved. + source: + openapi: openapi/openapi.json + GetTeamMemberBookingProfileResponse: + properties: + team_member_booking_profile: + type: optional + docs: The returned team member booking profile. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetTeamMemberResponse: + docs: >- + Represents a response from a retrieve request containing a `TeamMember` + object or error messages. + properties: + team_member: + type: optional + docs: The successfully retrieved `TeamMember` object. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + RetrieveTokenStatusResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the `RetrieveTokenStatus` endpoint. + properties: + scopes: + type: optional> + docs: The list of scopes associated with an access token. + expires_at: + type: optional + docs: "The date and time when the\_`access_token`\_expires, in RFC 3339 format. Empty if the token never expires." + client_id: + type: optional + docs: >- + The Square-issued application ID associated with the access token. + This is the same application ID used to obtain the token. + validation: + maxLength: 191 + merchant_id: + type: optional + docs: The ID of the authorizing merchant's business. + validation: + minLength: 8 + maxLength: 191 + errors: + type: optional> + docs: ' Any errors that occurred during the request.' + source: + openapi: openapi/openapi.json + GetTransactionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) + endpoint. + + + One of `errors` or `transaction` is present in a given response (never + both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + transaction: + type: optional + docs: The requested transaction. + source: + openapi: openapi/openapi.json + GetVendorResponse: + docs: >- + Represents an output from a call to + [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor). + properties: + errors: + type: optional> + docs: Errors encountered when the request fails. + vendor: + type: optional + docs: The successfully retrieved [Vendor](entity:Vendor) object. + source: + openapi: openapi/openapi.json + GetWageSettingResponse: + docs: >- + Represents a response from a retrieve request containing the specified + `WageSetting` object or error messages. + properties: + wage_setting: + type: optional + docs: The successfully retrieved `WageSetting` object. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + GetWebhookSubscriptionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [RetrieveWebhookSubscription](api-endpoint:WebhookSubscriptions-RetrieveWebhookSubscription) + endpoint. + + + Note: if there are errors processing the request, the + [Subscription](entity:WebhookSubscription) will not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + subscription: + type: optional + docs: The requested [Subscription](entity:WebhookSubscription). + source: + openapi: openapi/openapi.json + RevokeTokenResponse: + properties: + success: + type: optional + docs: If the request is successful, this is `true`. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + RiskEvaluation: + docs: >- + Represents fraud risk information for the associated payment. + + + When you take a payment through Square's Payments API (using the + `CreatePayment` + + endpoint), Square evaluates it and assigns a risk level to the payment. + Sellers + + can use this information to determine the course of action (for example, + + provide the goods/services or refund the payment). + properties: + created_at: + type: optional + docs: The timestamp when payment risk was evaluated, in RFC 3339 format. + access: read-only + risk_level: + type: optional + docs: >- + The risk level associated with the payment + + See [RiskEvaluationRiskLevel](#type-riskevaluationrisklevel) for + possible values + source: + openapi: openapi/openapi.json + RiskEvaluationRiskLevel: + enum: + - PENDING + - NORMAL + - MODERATE + - HIGH + source: + openapi: openapi/openapi.json + SaveCardOptions: + docs: Describes save-card action fields. + properties: + customer_id: + type: string + docs: The square-assigned ID of the customer linked to the saved card. + card_id: + type: optional + docs: The id of the created card-on-file. + validation: + maxLength: 64 + access: read-only + reference_id: + type: optional> + docs: >- + An optional user-defined reference ID that can be used to associate + + this `Card` to another entity in an external system. For example, a + customer + + ID generated by a third-party system. + validation: + maxLength: 128 + source: + openapi: openapi/openapi.json + SearchAvailabilityFilter: + docs: A query filter to search for buyer-accessible availabilities by. + properties: + start_at_range: + type: TimeRange + docs: >- + The query expression to search for buy-accessible availabilities with + their starting times falling within the specified time range. + + The time range must be at least 24 hours and at most 32 days long. + + For waitlist availabilities, the time range can be 0 or more up to 367 + days long. + location_id: + type: optional> + docs: >- + The query expression to search for buyer-accessible availabilities + with their location IDs matching the specified location ID. + + This query expression cannot be set if `booking_id` is set. + validation: + maxLength: 32 + segment_filters: + type: optional>> + docs: >- + The query expression to search for buyer-accessible availabilities + matching the specified list of segment filters. + + If the size of the `segment_filters` list is `n`, the search returns + availabilities with `n` segments per availability. + + + This query expression cannot be set if `booking_id` is set. + booking_id: + type: optional> + docs: >- + The query expression to search for buyer-accessible availabilities for + an existing booking by matching the specified `booking_id` value. + + This is commonly used to reschedule an appointment. + + If this expression is set, the `location_id` and `segment_filters` + expressions cannot be set. + validation: + maxLength: 36 + source: + openapi: openapi/openapi.json + SearchAvailabilityQuery: + docs: The query used to search for buyer-accessible availabilities of bookings. + properties: + filter: + type: SearchAvailabilityFilter + docs: >- + The query filter to search for buyer-accessible availabilities of + existing bookings. + source: + openapi: openapi/openapi.json + SearchAvailabilityResponse: + properties: + availabilities: + type: optional> + docs: List of appointment slots available for booking. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + SearchCatalogItemsRequestStockLevel: + enum: + - OUT + - LOW + docs: Defines supported stock levels of the item inventory. + source: + openapi: openapi/openapi.json + SearchCatalogItemsResponse: + docs: >- + Defines the response body returned from the + [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + items: + type: optional> + docs: Returned items matching the specified query expressions. + cursor: + type: optional + docs: >- + Pagination token used in the next request to return more of the search + result. + matched_variation_ids: + type: optional> + docs: >- + Ids of returned item variations matching the specified query + expression. + source: + openapi: openapi/openapi.json + SearchCatalogObjectsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + objects: + type: optional> + docs: The CatalogObjects returned. + related_objects: + type: optional> + docs: >- + A list of CatalogObjects referenced by the objects in the `objects` + field. + latest_time: + type: optional + docs: >- + When the associated product catalog was last updated. Will + + match the value for `end_time` or `cursor` if either field is included + in the `SearchCatalog` request. + source: + openapi: openapi/openapi.json + SearchCustomersResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the `SearchCustomers` endpoint. + + + Either `errors` or `customers` is present in a given response (never + both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + customers: + type: optional> + docs: >- + The customer profiles that match the search query. If any search + condition is not met, the result is an empty object (`{}`). + + Only customer profiles with public information (`given_name`, + `family_name`, `company_name`, `email_address`, or `phone_number`) + + are included in the response. + cursor: + type: optional + docs: >- + A pagination cursor that can be used during subsequent calls + + to `SearchCustomers` to retrieve the next set of results associated + + with the original query. Pagination cursors are only present when + + a request succeeds and additional results are available. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + count: + type: optional + docs: >- + The total count of customers associated with the Square account that + match the search query. Only customer profiles with + + public information (`given_name`, `family_name`, `company_name`, + `email_address`, or `phone_number`) are counted. This field is + + present only if `count` is set to `true` in the request. + source: + openapi: openapi/openapi.json + SearchEventsFilter: + docs: Criteria to filter events by. + properties: + event_types: + type: optional>> + docs: Filter events by event types. + merchant_ids: + type: optional>> + docs: Filter events by merchant. + location_ids: + type: optional>> + docs: Filter events by location. + created_at: + type: optional + docs: Filter events by when they were created. + source: + openapi: openapi/openapi.json + SearchEventsQuery: + docs: Contains query criteria for the search. + properties: + filter: + type: optional + docs: Criteria to filter events by. + sort: + type: optional + docs: Criteria to sort events by. + source: + openapi: openapi/openapi.json + SearchEventsResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [SearchEvents](api-endpoint:Events-SearchEvents) + endpoint. + + + Note: if there are errors processing the request, the events field will + not be + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + events: + type: optional> + docs: The list of [Event](entity:Event)s returned by the search. + metadata: + type: optional> + docs: >- + Contains the metadata of an event. For more information, see + [Event](entity:Event). + cursor: + type: optional + docs: >- + When a response is truncated, it includes a cursor that you can use in + a subsequent request to fetch the next set of events. If empty, this + is the final response. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + SearchEventsSort: + docs: Criteria to sort events by. + properties: + field: + type: optional + docs: >- + Sort events by event types. + + See [SearchEventsSortField](#type-searcheventssortfield) for possible + values + order: + type: optional + docs: |- + The order to use for sorting the events. + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + SearchEventsSortField: + type: literal<"DEFAULT"> + docs: Specifies the sort key for events returned from a search. + SearchInvoicesResponse: + docs: Describes a `SearchInvoices` response. + properties: + invoices: + type: optional> + docs: The list of invoices returned by the search. + cursor: + type: optional + docs: >- + When a response is truncated, it includes a cursor that you can use in + a + + subsequent request to fetch the next set of invoices. If empty, this + is the final + + response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + SearchLoyaltyAccountsRequestLoyaltyAccountQuery: + docs: The search criteria for the loyalty accounts. + properties: + mappings: + type: optional>> + docs: |- + The set of mappings to use in the loyalty account search. + + This cannot be combined with `customer_ids`. + + Max: 30 mappings + customer_ids: + type: optional>> + docs: |- + The set of customer IDs to use in the loyalty account search. + + This cannot be combined with `mappings`. + + Max: 30 customer IDs + source: + openapi: openapi/openapi.json + SearchLoyaltyAccountsResponse: + docs: >- + A response that includes loyalty accounts that satisfy the search + criteria. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + loyalty_accounts: + type: optional> + docs: |- + The loyalty accounts that met the search criteria, + in order of creation date. + cursor: + type: optional + docs: >- + The pagination cursor to use in a subsequent + + request. If empty, this is the final response. + + For more information, + + see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + SearchLoyaltyEventsResponse: + docs: |- + A response that contains loyalty events that satisfy the search + criteria, in order by the `created_at` date. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + events: + type: optional> + docs: The loyalty events that satisfy the search criteria. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent + + request. If empty, this is the final response. + + For more information, + + see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + SearchLoyaltyRewardsRequestLoyaltyRewardQuery: + docs: The set of search requirements. + properties: + loyalty_account_id: + type: string + docs: >- + The ID of the [loyalty account](entity:LoyaltyAccount) to which the + loyalty reward belongs. + validation: + minLength: 1 + status: + type: optional + docs: >- + The status of the loyalty reward. + + See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible + values + source: + openapi: openapi/openapi.json + SearchLoyaltyRewardsResponse: + docs: >- + A response that includes the loyalty rewards satisfying the search + criteria. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + rewards: + type: optional> + docs: |- + The loyalty rewards that satisfy the search criteria. + These are returned in descending order by `updated_at`. + cursor: + type: optional + docs: |- + The pagination cursor to be used in a subsequent + request. If empty, this is the final response. + source: + openapi: openapi/openapi.json + SearchOrdersCustomerFilter: + docs: |- + A filter based on the order `customer_id` and any tender `customer_id` + associated with the order. It does not filter based on the + [FulfillmentRecipient](entity:FulfillmentRecipient) `customer_id`. + properties: + customer_ids: + type: optional>> + docs: |- + A list of customer IDs to filter by. + + Max: 10 customer ids. + source: + openapi: openapi/openapi.json + SearchOrdersDateTimeFilter: + docs: >- + Filter for `Order` objects based on whether their `CREATED_AT`, + + `CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time + range. + + You can specify the time range and which timestamp to filter for. You can + filter + + for only one time range at a time. + + + For each time range, the start time and end time are inclusive. If the end + time + + is absent, it defaults to the time of the first request for the cursor. + + + __Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query, + + you must set the `sort_field` in [OrdersSort](entity:SearchOrdersSort) + + to the same field you filter for. For example, if you set the `CLOSED_AT` + field + + in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` + to + + `CLOSED_AT`. Otherwise, `SearchOrders` throws an error. + + [Learn more about filtering orders by time + range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) + properties: + created_at: + type: optional + docs: >- + The time range for filtering on the `created_at` timestamp. If you use + this + + value, you must set the `sort_field` in the `OrdersSearchSort` object + to + + `CREATED_AT`. + updated_at: + type: optional + docs: >- + The time range for filtering on the `updated_at` timestamp. If you use + this + + value, you must set the `sort_field` in the `OrdersSearchSort` object + to + + `UPDATED_AT`. + closed_at: + type: optional + docs: >- + The time range for filtering on the `closed_at` timestamp. If you use + this + + value, you must set the `sort_field` in the `OrdersSearchSort` object + to + + `CLOSED_AT`. + source: + openapi: openapi/openapi.json + SearchOrdersFilter: + docs: |- + Filtering criteria to use for a `SearchOrders` request. Multiple filters + are ANDed together. + properties: + state_filter: + type: optional + docs: Filter by [OrderState](entity:OrderState). + date_time_filter: + type: optional + docs: >- + Filter for results within a time range. + + + __Important:__ If you filter for orders by time range, you must set + `SearchOrdersSort` + + to sort by the same field. + + [Learn more about filtering orders by time + range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) + fulfillment_filter: + type: optional + docs: Filter by the fulfillment type or state. + source_filter: + type: optional + docs: Filter by the source of the order. + customer_filter: + type: optional + docs: Filter by customers associated with the order. + source: + openapi: openapi/openapi.json + SearchOrdersFulfillmentFilter: + docs: Filter based on [order fulfillment](entity:Fulfillment) information. + properties: + fulfillment_types: + type: optional>> + docs: >- + A list of [fulfillment types](entity:FulfillmentType) to filter + + for. The list returns orders if any of its fulfillments match any of + the fulfillment types + + listed in this field. + + See [FulfillmentType](#type-fulfillmenttype) for possible values + fulfillment_states: + type: optional>> + docs: >- + A list of [fulfillment states](entity:FulfillmentState) to filter + + for. The list returns orders if any of its fulfillments match any of + the + + fulfillment states listed in this field. + + See [FulfillmentState](#type-fulfillmentstate) for possible values + source: + openapi: openapi/openapi.json + SearchOrdersQuery: + docs: Contains query criteria for the search. + properties: + filter: + type: optional + docs: Criteria to filter results by. + sort: + type: optional + docs: Criteria to sort results by. + source: + openapi: openapi/openapi.json + SearchOrdersResponse: + docs: >- + Either the `order_entries` or `orders` field is set, depending on whether + + `return_entries` is set on the + [SearchOrdersRequest](api-endpoint:Orders-SearchOrders). + properties: + order_entries: + type: optional> + docs: >- + A list of [OrderEntries](entity:OrderEntry) that fit the query + + conditions. The list is populated only if `return_entries` is set to + `true` in the request. + orders: + type: optional> + docs: >- + A list of + + [Order](entity:Order) objects that match the query conditions. The + list is populated only if + + `return_entries` is set to `false` in the request. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + + this is the final response. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + errors: + type: optional> + docs: '[Errors](entity:Error) encountered during the search.' + source: + openapi: openapi/openapi.json + SearchOrdersSort: + docs: |- + Sorting criteria for a `SearchOrders` request. Results can only be sorted + by a timestamp field. + properties: + sort_field: + type: SearchOrdersSortField + docs: >- + The field to sort by. + + + __Important:__ When using a + [DateTimeFilter](entity:SearchOrdersFilter), + + `sort_field` must match the timestamp field that the `DateTimeFilter` + uses to + + filter. For example, if you set your `sort_field` to `CLOSED_AT` and + you use a + + `DateTimeFilter`, your `DateTimeFilter` must filter for orders by + their `CLOSED_AT` date. + + If this field does not match the timestamp field in `DateTimeFilter`, + + `SearchOrders` returns an error. + + + Default: `CREATED_AT`. + + See [SearchOrdersSortField](#type-searchorderssortfield) for possible + values + sort_order: + type: optional + docs: >- + The chronological order in which results are returned. Defaults to + `DESC`. + + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + SearchOrdersSortField: + enum: + - CREATED_AT + - UPDATED_AT + - CLOSED_AT + docs: Specifies which timestamp to use to sort `SearchOrder` results. + source: + openapi: openapi/openapi.json + SearchOrdersSourceFilter: + docs: A filter based on order `source` information. + properties: + source_names: + type: optional>> + docs: >- + Filters by the [Source](entity:OrderSource) `name`. The filter returns + any orders + + with a `source.name` that matches any of the listed source names. + + + Max: 10 source names. + source: + openapi: openapi/openapi.json + SearchOrdersStateFilter: + docs: Filter by the current order `state`. + properties: + states: + docs: |- + States to filter for. + See [OrderState](#type-orderstate) for possible values + type: list + source: + openapi: openapi/openapi.json + SearchShiftsResponse: + docs: >- + The response to a request for `Shift` objects. The response contains + + the requested `Shift` objects and might contain a set of `Error` objects + if + + the request resulted in errors. + properties: + shifts: + type: optional> + docs: Shifts. + cursor: + type: optional + docs: An opaque cursor for fetching the next page. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + SearchSubscriptionsFilter: + docs: >- + Represents a set of query expressions (filters) to narrow the scope of + targeted subscriptions returned by + + the [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) + endpoint. + properties: + customer_ids: + type: optional>> + docs: >- + A filter to select subscriptions based on the subscribing customer + IDs. + location_ids: + type: optional>> + docs: A filter to select subscriptions based on the location. + source_names: + type: optional>> + docs: A filter to select subscriptions based on the source application. + source: + openapi: openapi/openapi.json + SearchSubscriptionsQuery: + docs: >- + Represents a query, consisting of specified query expressions, used to + search for subscriptions. + properties: + filter: + type: optional + docs: A list of query expressions. + source: + openapi: openapi/openapi.json + SearchSubscriptionsResponse: + docs: >- + Defines output parameters in a response from the + + [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscriptions: + type: optional> + docs: The subscriptions matching the specified query expressions. + cursor: + type: optional + docs: >- + When the total number of resulting subscription exceeds the limit of a + paged response, + + the response includes a cursor for you to use in a subsequent request + to fetch the next set of results. + + If the cursor is unset, the response contains the last page of the + results. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + source: + openapi: openapi/openapi.json + SearchTeamMembersFilter: + docs: >- + Represents a filter used in a search for `TeamMember` objects. `AND` logic + is applied + + between the individual fields, and `OR` logic is applied within list-based + fields. + + For example, setting this filter value: + + ``` + + filter = (locations_ids = ["A", "B"], status = ACTIVE) + + ``` + + returns only active team members assigned to either location "A" or "B". + properties: + location_ids: + type: optional>> + docs: >- + When present, filters by team members assigned to the specified + locations. + + When empty, includes team members assigned to any location. + status: + type: optional + docs: |- + When present, filters by team members who match the given status. + When empty, includes team members of all statuses. + See [TeamMemberStatus](#type-teammemberstatus) for possible values + is_owner: + type: optional> + docs: >- + When present and set to true, returns the team member who is the owner + of the Square account. + source: + openapi: openapi/openapi.json + SearchTeamMembersQuery: + docs: Represents the parameters in a search for `TeamMember` objects. + properties: + filter: + type: optional + docs: The options to filter by. + source: + openapi: openapi/openapi.json + SearchTeamMembersResponse: + docs: >- + Represents a response from a search request containing a filtered list of + `TeamMember` objects. + properties: + team_members: + type: optional> + docs: The filtered list of `TeamMember` objects. + cursor: + type: optional + docs: >- + The opaque cursor for fetching the next page. For more information, + see + + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + SearchTerminalActionsResponse: + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + action: + type: optional> + docs: The requested search result of `TerminalAction`s. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more + + information. + source: + openapi: openapi/openapi.json + SearchTerminalCheckoutsResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + checkouts: + type: optional> + docs: The requested search result of `TerminalCheckout` objects. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + source: + openapi: openapi/openapi.json + SearchTerminalRefundsResponse: + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + refunds: + type: optional> + docs: The requested search result of `TerminalRefund` objects. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If empty, + + this is the final response. + + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + source: + openapi: openapi/openapi.json + SearchVendorsRequestFilter: + docs: Defines supported query expressions to search for vendors by. + properties: + name: + type: optional>> + docs: The names of the [Vendor](entity:Vendor) objects to retrieve. + status: + type: optional>> + docs: |- + The statuses of the [Vendor](entity:Vendor) objects to retrieve. + See [VendorStatus](#type-vendorstatus) for possible values + source: + openapi: openapi/openapi.json + SearchVendorsRequestSort: + docs: >- + Defines a sorter used to sort results from + [SearchVendors](api-endpoint:Vendors-SearchVendors). + properties: + field: + type: optional + docs: |- + Specifies the sort key to sort the returned vendors. + See [Field](#type-field) for possible values + order: + type: optional + docs: |- + Specifies the sort order for the returned vendors. + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + SearchVendorsRequestSortField: + enum: + - NAME + - CREATED_AT + docs: The field to sort the returned [Vendor](entity:Vendor) objects by. + source: + openapi: openapi/openapi.json + SearchVendorsResponse: + docs: >- + Represents an output from a call to + [SearchVendors](api-endpoint:Vendors-SearchVendors). + properties: + errors: + type: optional> + docs: Errors encountered when the request fails. + vendors: + type: optional> + docs: >- + The [Vendor](entity:Vendor) objects matching the specified search + filter. + cursor: + type: optional + docs: >- + The pagination cursor to be used in a subsequent request. If unset, + + this is the final response. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + source: + openapi: openapi/openapi.json + SegmentFilter: + docs: A query filter to search for buyer-accessible appointment segments by. + properties: + service_variation_id: + type: string + docs: >- + The ID of the [CatalogItemVariation](entity:CatalogItemVariation) + object representing the service booked in this segment. + validation: + minLength: 1 + maxLength: 36 + team_member_id_filter: + type: optional + docs: >- + A query filter to search for buyer-accessible appointment segments + with service-providing team members matching the specified list of + team member IDs. Supported query expressions are + + - `ANY`: return the appointment segments with team members whose IDs + match any member in this list. + + - `NONE`: return the appointment segments with team members whose IDs + are not in this list. + + - `ALL`: not supported. + + + When no expression is specified, any service-providing team member is + eligible to fulfill the Booking. + source: + openapi: openapi/openapi.json + SelectOption: + properties: + reference_id: + type: string + docs: The reference id for the option. + validation: + minLength: 1 + maxLength: 40 + title: + type: string + docs: The title text that displays in the select option button. + validation: + minLength: 1 + maxLength: 250 + source: + openapi: openapi/openapi.json + SelectOptions: + properties: + title: + type: string + docs: The title text to display in the select flow on the Terminal. + validation: + minLength: 1 + maxLength: 250 + body: + type: string + docs: The body text to display in the select flow on the Terminal. + validation: + minLength: 1 + maxLength: 10000 + options: + docs: >- + Represents the buttons/options that should be displayed in the select + flow on the Terminal. + type: list + selected_option: + type: optional + docs: The buyer’s selected option. + source: + openapi: openapi/openapi.json + Shift: + docs: >- + A record of the hourly rate, start, and end times for a single work shift + + for an employee. This might include a record of the start and end times + for breaks + + taken during the shift. + properties: + id: + type: optional + docs: The UUID for this object. + validation: + maxLength: 255 + employee_id: + type: optional> + docs: >- + The ID of the employee this shift belongs to. DEPRECATED at version + 2020-08-26. Use `team_member_id` instead. + location_id: + type: string + docs: >- + The ID of the location this shift occurred at. The location should be + based on + + where the employee clocked in. + validation: + minLength: 1 + timezone: + type: optional> + docs: >- + The read-only convenience value that is calculated from the location + based + + on the `location_id`. Format: the IANA timezone database identifier + for the + + location timezone. + start_at: + type: string + docs: >- + RFC 3339; shifted to the location timezone + offset. Precision up to + the + + minute is respected; seconds are truncated. + validation: + minLength: 1 + end_at: + type: optional> + docs: >- + RFC 3339; shifted to the timezone + offset. Precision up to the minute + is + + respected; seconds are truncated. + wage: + type: optional + docs: >- + Job and pay related information. If the wage is not set on create, it + defaults to a wage + + of zero. If the title is not set on create, it defaults to the name of + the role the employee + + is assigned to, if any. + breaks: + type: optional>> + docs: >- + A list of all the paid or unpaid breaks that were taken during this + shift. + status: + type: optional + docs: |- + Describes the working state of the current `Shift`. + See [ShiftStatus](#type-shiftstatus) for possible values + version: + type: optional + docs: >- + Used for resolving concurrency issues. The request fails if the + version + + provided does not match the server version at the time of the request. + If not provided, + + Square executes a blind write; potentially overwriting data from + another + + write. + created_at: + type: optional + docs: A read-only timestamp in RFC 3339 format; presented in UTC. + access: read-only + updated_at: + type: optional + docs: A read-only timestamp in RFC 3339 format; presented in UTC. + access: read-only + team_member_id: + type: optional> + docs: >- + The ID of the team member this shift belongs to. Replaced + `employee_id` at version "2020-08-26". + declared_cash_tip_money: + type: optional + docs: The tips declared by the team member for the shift. + source: + openapi: openapi/openapi.json + ShiftFilter: + docs: |- + Defines a filter used in a search for `Shift` records. `AND` logic is + used by Square's servers to apply each filter property specified. + properties: + location_ids: + type: optional>> + docs: Fetch shifts for the specified location. + employee_ids: + type: optional>> + docs: >- + Fetch shifts for the specified employees. DEPRECATED at version + 2020-08-26. Use `team_member_ids` instead. + status: + type: optional + docs: |- + Fetch a `Shift` instance by `Shift.status`. + See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values + start: + type: optional + docs: Fetch `Shift` instances that start in the time range - Inclusive. + end: + type: optional + docs: Fetch the `Shift` instances that end in the time range - Inclusive. + workday: + type: optional + docs: Fetch the `Shift` instances based on the workday date range. + team_member_ids: + type: optional>> + docs: >- + Fetch shifts for the specified team members. Replaced `employee_ids` + at version "2020-08-26". + source: + openapi: openapi/openapi.json + ShiftFilterStatus: + enum: + - OPEN + - CLOSED + docs: Specifies the `status` of `Shift` records to be returned. + source: + openapi: openapi/openapi.json + ShiftQuery: + docs: >- + The parameters of a `Shift` search query, which includes filter and sort + options. + properties: + filter: + type: optional + docs: Query filter options. + sort: + type: optional + docs: Sort order details. + source: + openapi: openapi/openapi.json + ShiftSort: + docs: Sets the sort order of search results. + properties: + field: + type: optional + docs: |- + The field to sort on. + See [ShiftSortField](#type-shiftsortfield) for possible values + order: + type: optional + docs: |- + The order in which results are returned. Defaults to DESC. + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + ShiftSortField: + enum: + - START_AT + - END_AT + - CREATED_AT + - UPDATED_AT + docs: Enumerates the `Shift` fields to sort on. + source: + openapi: openapi/openapi.json + ShiftStatus: + enum: + - OPEN + - CLOSED + docs: Enumerates the possible status of a `Shift`. + source: + openapi: openapi/openapi.json + ShiftWage: + docs: The hourly wage rate used to compensate an employee for this shift. + properties: + title: + type: optional> + docs: The name of the job performed during this shift. + hourly_rate: + type: optional + docs: |- + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + job_id: + type: optional + docs: >- + The id of the job performed during this shift. Square + + labor-reporting UIs might group shifts together by id. This cannot be + used to retrieve the job. + access: read-only + tip_eligible: + type: optional> + docs: Whether team members are eligible for tips when working this job. + source: + openapi: openapi/openapi.json + ShiftWorkday: + docs: |- + A `Shift` search query filter parameter that sets a range of days that + a `Shift` must start or end in before passing the filter condition. + properties: + date_range: + type: optional + docs: Dates for fetching the shifts. + match_shifts_by: + type: optional + docs: >- + The strategy on which the dates are applied. + + See [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible + values + default_timezone: + type: optional> + docs: >- + Location-specific timezones convert workdays to datetime filters. + + Every location included in the query must have a timezone or this + field + + must be provided as a fallback. Format: the IANA timezone database + + identifier for the relevant timezone. + source: + openapi: openapi/openapi.json + ShiftWorkdayMatcher: + enum: + - START_AT + - END_AT + - INTERSECTION + docs: Defines the logic used to apply a workday filter. + source: + openapi: openapi/openapi.json + ShippingFee: + properties: + name: + type: optional> + docs: The name for the shipping fee. + charge: + type: Money + docs: The amount and currency for the shipping fee. + source: + openapi: openapi/openapi.json + SignatureImage: + properties: + image_type: + type: optional + docs: |- + The mime/type of the image data. + Use `image/png;base64` for png. + access: read-only + data: + type: optional + docs: The base64 representation of the image. + access: read-only + source: + openapi: openapi/openapi.json + SignatureOptions: + properties: + title: + type: string + docs: >- + The title text to display in the signature capture flow on the + Terminal. + validation: + minLength: 1 + maxLength: 250 + body: + type: string + docs: >- + The body text to display in the signature capture flow on the + Terminal. + validation: + minLength: 1 + maxLength: 10000 + signature: + type: optional> + docs: An image representation of the collected signature. + access: read-only + source: + openapi: openapi/openapi.json + Site: + docs: >- + Represents a Square Online site, which is an online store for a Square + seller. + properties: + id: + type: optional + docs: The Square-assigned ID of the site. + validation: + maxLength: 32 + access: read-only + site_title: + type: optional> + docs: The title of the site. + domain: + type: optional> + docs: >- + The domain of the site (without the protocol). For example, + `mysite1.square.site`. + is_published: + type: optional> + docs: Indicates whether the site is published. + created_at: + type: optional + docs: The timestamp of when the site was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: The timestamp of when the site was last updated, in RFC 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + Snippet: + docs: >- + Represents the snippet that is added to a Square Online site. The snippet + code is injected into the `head` element of all pages on the site, except + for checkout pages. + properties: + id: + type: optional + docs: The Square-assigned ID for the snippet. + validation: + maxLength: 48 + access: read-only + site_id: + type: optional + docs: The ID of the site that contains the snippet. + access: read-only + content: + type: string + docs: The snippet code, which can contain valid HTML, JavaScript, or both. + validation: + minLength: 1 + maxLength: 65535 + created_at: + type: optional + docs: >- + The timestamp of when the snippet was initially added to the site, in + RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: >- + The timestamp of when the snippet was last updated on the site, in RFC + 3339 format. + access: read-only + source: + openapi: openapi/openapi.json + SortOrder: + enum: + - DESC + - ASC + docs: >- + The order (e.g., chronological or alphabetical) in which results from a + request are returned. + source: + openapi: openapi/openapi.json + SourceApplication: + docs: Represents information about the application used to generate a change. + properties: + product: + type: optional + docs: |- + __Read only__ The [product](entity:Product) type of the application. + See [Product](#type-product) for possible values + application_id: + type: optional> + docs: >- + __Read only__ The Square-assigned ID of the application. This field is + used only if the + + [product](entity:Product) type is `EXTERNAL_API`. + name: + type: optional> + docs: >- + __Read only__ The display name of the application + + (for example, `"Custom Application"` or `"Square POS 4.74 for + Android"`). + source: + openapi: openapi/openapi.json + SquareAccountDetails: + docs: Additional details about Square Account payments. + properties: + payment_source_token: + type: optional> + docs: Unique identifier for the payment source used for this payment. + validation: + maxLength: 255 + errors: + type: optional>> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + StandardUnitDescription: + docs: Contains the name and abbreviation for standard measurement unit. + properties: + unit: + type: optional + docs: Identifies the measurement unit being described. + name: + type: optional> + docs: UI display name of the measurement unit. For example, 'Pound'. + abbreviation: + type: optional> + docs: UI display abbreviation for the measurement unit. For example, 'lb'. + source: + openapi: openapi/openapi.json + StandardUnitDescriptionGroup: + docs: Group of standard measurement units. + properties: + standard_unit_descriptions: + type: optional>> + docs: >- + List of standard (non-custom) measurement units in this description + group. + language_code: + type: optional> + docs: IETF language tag. + source: + openapi: openapi/openapi.json + SubmitEvidenceResponse: + docs: Defines the fields in a `SubmitEvidence` response. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + dispute: + type: optional + docs: The `Dispute` for which evidence was submitted. + source: + openapi: openapi/openapi.json + Subscription: + docs: >- + Represents a subscription purchased by a customer. + + + For more information, see + + [Manage + Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). + properties: + id: + type: optional + docs: The Square-assigned ID of the subscription. + validation: + maxLength: 255 + access: read-only + location_id: + type: optional + docs: The ID of the location associated with the subscription. + access: read-only + plan_variation_id: + type: optional + docs: >- + The ID of the subscribed-to [subscription plan + variation](entity:CatalogSubscriptionPlanVariation). + access: read-only + customer_id: + type: optional + docs: The ID of the subscribing [customer](entity:Customer) profile. + access: read-only + start_date: + type: optional + docs: >- + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the + subscription. + access: read-only + canceled_date: + type: optional> + docs: >- + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel + the subscription, + + when the subscription status changes to `CANCELED` and the + subscription billing stops. + + + If this field is not set, the subscription ends according its + subscription plan. + + + This field cannot be updated, other than being cleared. + charged_through_date: + type: optional + docs: >- + The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced + for the + + subscription. + + + After the invoice is sent for a given billing period, + + this date will be the last day of the billing period. + + For example, + + suppose for the month of May a subscriber gets an invoice + + (or charged the card) on May 1. For the monthly billing scenario, + + this date is then set to May 31. + access: read-only + status: + type: optional + docs: |- + The current status of the subscription. + See [SubscriptionStatus](#type-subscriptionstatus) for possible values + tax_percentage: + type: optional> + docs: |- + The tax amount applied when billing the subscription. The + percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of `7.5` + corresponds to 7.5%. + invoice_ids: + type: optional> + docs: |- + The IDs of the [invoices](entity:Invoice) created for the + subscription, listed in order when the invoices were created + (newest invoices appear first). + access: read-only + price_override_money: + type: optional + docs: >- + A custom price which overrides the cost of a subscription plan + variation with `STATIC` pricing. + + This field does not affect itemized subscriptions with `RELATIVE` + pricing. Instead, + + you should edit the Subscription's [order + template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + version: + type: optional + docs: >- + The version of the object. When updating an object, the version + + supplied must match the version in the database, otherwise the write + will + + be rejected as conflicting. + created_at: + type: optional + docs: The timestamp when the subscription was created, in RFC 3339 format. + access: read-only + card_id: + type: optional> + docs: |- + The ID of the [subscriber's](entity:Customer) [card](entity:Card) + used to charge for the subscription. + timezone: + type: optional + docs: >- + Timezone that will be used in date calculations for the subscription. + + Defaults to the timezone of the location based on `location_id`. + + Format: the IANA Timezone Database identifier for the location + timezone (for example, `America/Los_Angeles`). + access: read-only + source: + type: optional + docs: The origination details of the subscription. + actions: + type: optional>> + docs: >- + The list of scheduled actions on this subscription. It is set only in + the response from + + [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) + with the query parameter + + of `include=actions` or from + + [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) + with the input parameter + + of `include:["actions"]`. + monthly_billing_anchor_date: + type: optional + docs: >- + The day of the month on which the subscription will issue invoices and + publish orders. + access: read-only + phases: + type: optional> + docs: array of phases for this subscription + access: read-only + source: + openapi: openapi/openapi.json + SubscriptionAction: + docs: Represents an action as a pending change to a subscription. + properties: + id: + type: optional + docs: The ID of an action scoped to a subscription. + type: + type: optional + docs: >- + The type of the action. + + See [SubscriptionActionType](#type-subscriptionactiontype) for + possible values + effective_date: + type: optional> + docs: >- + The `YYYY-MM-DD`-formatted date when the action occurs on the + subscription. + monthly_billing_anchor_date: + type: optional> + docs: >- + The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` + action. + phases: + type: optional>> + docs: A list of Phases, to pass phase-specific information used in the swap. + new_plan_variation_id: + type: optional> + docs: >- + The target subscription plan variation that a subscription switches + to, for a `SWAP_PLAN` action. + source: + openapi: openapi/openapi.json + SubscriptionActionType: + enum: + - CANCEL + - PAUSE + - RESUME + - SWAP_PLAN + - CHANGE_BILLING_ANCHOR_DATE + docs: Supported types of an action as a pending change to a subscription. + source: + openapi: openapi/openapi.json + SubscriptionCadence: + enum: + - DAILY + - WEEKLY + - EVERY_TWO_WEEKS + - THIRTY_DAYS + - SIXTY_DAYS + - NINETY_DAYS + - MONTHLY + - EVERY_TWO_MONTHS + - QUARTERLY + - EVERY_FOUR_MONTHS + - EVERY_SIX_MONTHS + - ANNUAL + - EVERY_TWO_YEARS + docs: Determines the billing cadence of a [Subscription](entity:Subscription) + source: + openapi: openapi/openapi.json + SubscriptionEvent: + docs: Describes changes to a subscription and the subscription status. + properties: + id: + type: string + docs: The ID of the subscription event. + subscription_event_type: + type: SubscriptionEventSubscriptionEventType + docs: >- + Type of the subscription event. + + See + [SubscriptionEventSubscriptionEventType](#type-subscriptioneventsubscriptioneventtype) + for possible values + effective_date: + type: string + docs: >- + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the + subscription event occurred. + monthly_billing_anchor_date: + type: optional + docs: >- + The day-of-the-month the billing anchor date was changed to, if + applicable. + access: read-only + info: + type: optional + docs: Additional information about the subscription event. + phases: + type: optional>> + docs: A list of Phases, to pass phase-specific information used in the swap. + plan_variation_id: + type: string + docs: >- + The ID of the subscription plan variation associated with the + subscription. + source: + openapi: openapi/openapi.json + SubscriptionEventInfo: + docs: Provides information about the subscription event. + properties: + detail: + type: optional> + docs: A human-readable explanation for the event. + code: + type: optional + docs: |- + An info code indicating the subscription event that occurred. + See [InfoCode](#type-infocode) for possible values + source: + openapi: openapi/openapi.json + SubscriptionEventInfoCode: + enum: + - LOCATION_NOT_ACTIVE + - LOCATION_CANNOT_ACCEPT_PAYMENT + - CUSTOMER_DELETED + - CUSTOMER_NO_EMAIL + - CUSTOMER_NO_NAME + - USER_PROVIDED + docs: Supported info codes of a subscription event. + source: + openapi: openapi/openapi.json + SubscriptionEventSubscriptionEventType: + enum: + - START_SUBSCRIPTION + - PLAN_CHANGE + - STOP_SUBSCRIPTION + - DEACTIVATE_SUBSCRIPTION + - RESUME_SUBSCRIPTION + - PAUSE_SUBSCRIPTION + - BILLING_ANCHOR_DATE_CHANGED + docs: Supported types of an event occurred to a subscription. + source: + openapi: openapi/openapi.json + SubscriptionPhase: + docs: >- + Describes a phase in a subscription plan variation. For more information, + see [Subscription Plans and + Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + properties: + uid: + type: optional> + docs: >- + The Square-assigned ID of the subscription phase. This field cannot be + changed after a `SubscriptionPhase` is created. + cadence: + type: SubscriptionCadence + docs: >- + The billing cadence of the phase. For example, weekly or monthly. This + field cannot be changed after a `SubscriptionPhase` is created. + + See [SubscriptionCadence](#type-subscriptioncadence) for possible + values + periods: + type: optional> + docs: >- + The number of `cadence`s the phase lasts. If not set, the phase never + ends. Only the last phase can be indefinite. This field cannot be + changed after a `SubscriptionPhase` is created. + recurring_price_money: + type: optional + docs: >- + The amount to bill for each `cadence`. Failure to specify this field + results in a `MISSING_REQUIRED_PARAMETER` error at runtime. + ordinal: + type: optional> + docs: >- + The position this phase appears in the sequence of phases defined for + the plan, indexed from 0. This field cannot be changed after a + `SubscriptionPhase` is created. + pricing: + type: optional + docs: The subscription pricing. + source: + openapi: openapi/openapi.json + SubscriptionPricing: + docs: Describes the pricing for the subscription. + properties: + type: + type: optional + docs: >- + RELATIVE or STATIC + + See [SubscriptionPricingType](#type-subscriptionpricingtype) for + possible values + discount_ids: + type: optional>> + docs: The ids of the discount catalog objects + price_money: + type: optional + docs: The price of the subscription, if STATIC + source: + openapi: openapi/openapi.json + SubscriptionPricingType: + enum: + - STATIC + - RELATIVE + docs: Determines the pricing of a [Subscription](entity:Subscription) + source: + openapi: openapi/openapi.json + SubscriptionSource: + docs: The origination details of the subscription. + properties: + name: + type: optional> + docs: |- + The name used to identify the place (physical or digital) that + a subscription originates. If unset, the name defaults to the name + of the application that created the subscription. + validation: + maxLength: 255 + source: + openapi: openapi/openapi.json + SubscriptionStatus: + enum: + - PENDING + - ACTIVE + - CANCELED + - DEACTIVATED + - PAUSED + docs: Supported subscription statuses. + source: + openapi: openapi/openapi.json + SubscriptionTestResult: + docs: >- + Represents the details of a webhook subscription, including notification + URL, + + event types, and signature key. + properties: + id: + type: optional + docs: A Square-generated unique ID for the subscription test result. + validation: + maxLength: 64 + access: read-only + status_code: + type: optional> + docs: The status code returned by the subscription notification URL. + payload: + type: optional> + docs: >- + An object containing the payload of the test event. For example, a + `payment.created` event. + created_at: + type: optional + docs: >- + The timestamp of when the subscription was created, in RFC 3339 + format. + + For example, "2016-09-04T23:59:33.123Z". + access: read-only + updated_at: + type: optional + docs: >- + The timestamp of when the subscription was updated, in RFC 3339 + format. For example, "2016-09-04T23:59:33.123Z". + + Because a subscription test result is unique, this field is the same + as the `created_at` field. + access: read-only + source: + openapi: openapi/openapi.json + SwapPlanResponse: + docs: |- + Defines output parameters in a response of the + [SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The subscription with the updated subscription plan. + actions: + type: optional> + docs: A list of a `SWAP_PLAN` action created by the request. + source: + openapi: openapi/openapi.json + TaxCalculationPhase: + enum: + - TAX_SUBTOTAL_PHASE + - TAX_TOTAL_PHASE + docs: When to calculate the taxes due on a cart. + source: + openapi: openapi/openapi.json + TaxIds: + docs: Identifiers for the location used by various governments for tax purposes. + properties: + eu_vat: + type: optional + docs: |- + The EU VAT number for this location. For example, `IE3426675K`. + If the EU VAT number is present, it is well-formed and has been + validated with VIES, the VAT Information Exchange System. + access: read-only + fr_siret: + type: optional + docs: >- + The SIRET (Système d'Identification du Répertoire des Entreprises et + de leurs Etablissements) + + number is a 14-digit code issued by the French INSEE. For example, + `39922799000021`. + access: read-only + fr_naf: + type: optional + docs: >- + The French government uses the NAF (Nomenclature des Activités + Françaises) to display and + + track economic statistical data. This is also called the APE (Activite + Principale de l’Entreprise) code. + + For example, `6910Z`. + access: read-only + es_nif: + type: optional + docs: >- + The NIF (Numero de Identificacion Fiscal) number is a nine-character + tax identifier used in Spain. + + If it is present, it has been validated. For example, `73628495A`. + access: read-only + jp_qii: + type: optional + docs: >- + The QII (Qualified Invoice Issuer) number is a 14-character tax + identifier used in Japan. + + For example, `T1234567890123`. + access: read-only + source: + openapi: openapi/openapi.json + TaxInclusionType: + enum: + - ADDITIVE + - INCLUSIVE + docs: >- + Whether to the tax amount should be additional to or included in the + CatalogItem price. + source: + openapi: openapi/openapi.json + TeamMember: + docs: A record representing an individual team member for a business. + properties: + id: + type: optional + docs: The unique ID for the team member. + access: read-only + reference_id: + type: optional> + docs: >- + A second ID used to associate the team member with an entity in + another system. + is_owner: + type: optional + docs: Whether the team member is the owner of the Square account. + access: read-only + status: + type: optional + docs: |- + Describes the status of the team member. + See [TeamMemberStatus](#type-teammemberstatus) for possible values + given_name: + type: optional> + docs: >- + The given name (that is, the first name) associated with the team + member. + family_name: + type: optional> + docs: >- + The family name (that is, the last name) associated with the team + member. + email_address: + type: optional> + docs: >- + The email address associated with the team member. After accepting the + invitation + + from Square, only the team member can change this value. + phone_number: + type: optional> + docs: |- + The team member's phone number, in E.164 format. For example: + +14155552671 - the country code is 1 for US + +551155256325 - the country code is 55 for BR + created_at: + type: optional + docs: The timestamp when the team member was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: >- + The timestamp when the team member was last updated, in RFC 3339 + format. + access: read-only + assigned_locations: + type: optional + docs: Describes the team member's assigned locations. + wage_setting: + type: optional + docs: >- + Information about the team member's overtime exemption status, job + assignments, and compensation. + source: + openapi: openapi/openapi.json + TeamMemberAssignedLocations: + docs: An object that represents a team member's assignment to locations. + properties: + assignment_type: + type: optional + docs: >- + The current assignment type of the team member. + + See + [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) + for possible values + location_ids: + type: optional>> + docs: The explicit locations that the team member is assigned to. + source: + openapi: openapi/openapi.json + TeamMemberAssignedLocationsAssignmentType: + enum: + - ALL_CURRENT_AND_FUTURE_LOCATIONS + - EXPLICIT_LOCATIONS + docs: Enumerates the possible assignment types that the team member can have. + source: + openapi: openapi/openapi.json + TeamMemberBookingProfile: + docs: >- + The booking profile of a seller's team member, including the team member's + ID, display name, description and whether the team member can be booked as + a service provider. + properties: + team_member_id: + type: optional + docs: >- + The ID of the [TeamMember](entity:TeamMember) object for the team + member associated with the booking profile. + validation: + maxLength: 32 + access: read-only + description: + type: optional + docs: The description of the team member. + validation: + maxLength: 65536 + access: read-only + display_name: + type: optional + docs: The display name of the team member. + validation: + maxLength: 512 + access: read-only + is_bookable: + type: optional> + docs: >- + Indicates whether the team member can be booked through the Bookings + API or the seller's online booking channel or site (`true`) or not + (`false`). + profile_image_url: + type: optional + docs: The URL of the team member's image for the bookings profile. + validation: + maxLength: 2048 + access: read-only + source: + openapi: openapi/openapi.json + TeamMemberStatus: + enum: + - ACTIVE + - INACTIVE + docs: >- + Enumerates the possible statuses the team member can have within a + business. + source: + openapi: openapi/openapi.json + TeamMemberWage: + docs: >- + The hourly wage rate that a team member earns on a `Shift` for doing the + job + + specified by the `title` property of this object. + properties: + id: + type: optional + docs: The UUID for this object. + team_member_id: + type: optional> + docs: The `TeamMember` that this wage is assigned to. + title: + type: optional> + docs: The job title that this wage relates to. + hourly_rate: + type: optional + docs: |- + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + job_id: + type: optional> + docs: |- + An identifier for the job that this wage relates to. This cannot be + used to retrieve the job. + tip_eligible: + type: optional> + docs: Whether team members are eligible for tips when working this job. + source: + openapi: openapi/openapi.json + Tender: + docs: >- + Represents a tender (i.e., a method of payment) used in a Square + transaction. + properties: + id: + type: optional + docs: The tender's unique ID. It is the associated payment ID. + validation: + maxLength: 192 + location_id: + type: optional> + docs: The ID of the transaction's associated location. + validation: + maxLength: 50 + transaction_id: + type: optional> + docs: The ID of the tender's associated transaction. + validation: + maxLength: 192 + created_at: + type: optional + docs: The timestamp for when the tender was created, in RFC 3339 format. + validation: + maxLength: 32 + access: read-only + note: + type: optional> + docs: An optional note associated with the tender at the time of payment. + validation: + maxLength: 500 + amount_money: + type: optional + docs: >- + The total amount of the tender, including `tip_money`. If the tender + has a `payment_id`, + + the `total_money` of the corresponding [Payment](entity:Payment) will + be equal to the + + `amount_money` of the tender. + tip_money: + type: optional + docs: The tip's amount of the tender. + processing_fee_money: + type: optional + docs: >- + The amount of any Square processing fees applied to the tender. + + + This field is not immediately populated when a new transaction is + created. + + It is usually available after about ten seconds. + customer_id: + type: optional> + docs: >- + If the tender is associated with a customer or represents a customer's + card on file, + + this is the ID of the associated customer. + validation: + maxLength: 191 + type: + type: TenderType + docs: |- + The type of tender, such as `CARD` or `CASH`. + See [TenderType](#type-tendertype) for possible values + card_details: + type: optional + docs: |- + The details of the card tender. + + This value is present only if the value of `type` is `CARD`. + cash_details: + type: optional + docs: |- + The details of the cash tender. + + This value is present only if the value of `type` is `CASH`. + bank_account_details: + type: optional + docs: |- + The details of the bank account tender. + + This value is present only if the value of `type` is `BANK_ACCOUNT`. + buy_now_pay_later_details: + type: optional + docs: >- + The details of a Buy Now Pay Later tender. + + + This value is present only if the value of `type` is + `BUY_NOW_PAY_LATER`. + square_account_details: + type: optional + docs: |- + The details of a Square Account tender. + + This value is present only if the value of `type` is `SQUARE_ACCOUNT`. + additional_recipients: + type: optional>> + docs: >- + Additional recipients (other than the merchant) receiving a portion of + this tender. + + For example, fees assessed on the purchase by a third party + integration. + payment_id: + type: optional> + docs: >- + The ID of the [Payment](entity:Payment) that corresponds to this + tender. + + This value is only present for payments created with the v2 Payments + API. + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + TenderBankAccountDetails: + docs: |- + Represents the details of a tender with `type` `BANK_ACCOUNT`. + + See [BankAccountPaymentDetails](entity:BankAccountPaymentDetails) + for more exposed details of a bank account payment. + properties: + status: + type: optional + docs: >- + The bank account payment's current state. + + + See + [TenderBankAccountPaymentDetailsStatus](entity:TenderBankAccountDetailsStatus) + for possible values. + + See + [TenderBankAccountDetailsStatus](#type-tenderbankaccountdetailsstatus) + for possible values + source: + openapi: openapi/openapi.json + TenderBankAccountDetailsStatus: + enum: + - PENDING + - COMPLETED + - FAILED + docs: Indicates the bank account payment's current status. + source: + openapi: openapi/openapi.json + TenderBuyNowPayLaterDetails: + docs: Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`. + properties: + buy_now_pay_later_brand: + type: optional + docs: |- + The Buy Now Pay Later brand. + See [Brand](#type-brand) for possible values + status: + type: optional + docs: >- + The buy now pay later payment's current state (such as `AUTHORIZED` or + + `CAPTURED`). See + [TenderBuyNowPayLaterDetailsStatus](entity:TenderBuyNowPayLaterDetailsStatus) + + for possible values. + + See [Status](#type-status) for possible values + source: + openapi: openapi/openapi.json + TenderBuyNowPayLaterDetailsBrand: + enum: + - OTHER_BRAND + - AFTERPAY + source: + openapi: openapi/openapi.json + TenderBuyNowPayLaterDetailsStatus: + enum: + - AUTHORIZED + - CAPTURED + - VOIDED + - FAILED + source: + openapi: openapi/openapi.json + TenderCardDetails: + docs: >- + Represents additional details of a tender with `type` `CARD` or + `SQUARE_GIFT_CARD` + properties: + status: + type: optional + docs: >- + The credit card payment's current state (such as `AUTHORIZED` or + + `CAPTURED`). See + [TenderCardDetailsStatus](entity:TenderCardDetailsStatus) + + for possible values. + + See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for + possible values + card: + type: optional + docs: The credit card's non-confidential details. + entry_method: + type: optional + docs: >- + The method used to enter the card's details for the transaction. + + See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) + for possible values + source: + openapi: openapi/openapi.json + TenderCardDetailsEntryMethod: + enum: + - SWIPED + - KEYED + - EMV + - ON_FILE + - CONTACTLESS + docs: Indicates the method used to enter the card's details. + source: + openapi: openapi/openapi.json + TenderCardDetailsStatus: + enum: + - AUTHORIZED + - CAPTURED + - VOIDED + - FAILED + docs: Indicates the card transaction's current status. + source: + openapi: openapi/openapi.json + TenderCashDetails: + docs: Represents the details of a tender with `type` `CASH`. + properties: + buyer_tendered_money: + type: optional + docs: >- + The total amount of cash provided by the buyer, before change is + given. + change_back_money: + type: optional + docs: The amount of change returned to the buyer. + source: + openapi: openapi/openapi.json + TenderSquareAccountDetails: + docs: Represents the details of a tender with `type` `SQUARE_ACCOUNT`. + properties: + status: + type: optional + docs: >- + The Square Account payment's current state (such as `AUTHORIZED` or + + `CAPTURED`). See + [TenderSquareAccountDetailsStatus](entity:TenderSquareAccountDetailsStatus) + + for possible values. + + See [Status](#type-status) for possible values + source: + openapi: openapi/openapi.json + TenderSquareAccountDetailsStatus: + enum: + - AUTHORIZED + - CAPTURED + - VOIDED + - FAILED + source: + openapi: openapi/openapi.json + TenderType: + enum: + - CARD + - CASH + - THIRD_PARTY_CARD + - SQUARE_GIFT_CARD + - NO_SALE + - BANK_ACCOUNT + - WALLET + - BUY_NOW_PAY_LATER + - SQUARE_ACCOUNT + - OTHER + docs: Indicates a tender's type. + source: + openapi: openapi/openapi.json + TerminalAction: + docs: Represents an action processed by the Square Terminal. + properties: + id: + type: optional + docs: A unique ID for this `TerminalAction`. + validation: + minLength: 10 + maxLength: 255 + access: read-only + device_id: + type: optional> + docs: |- + The unique Id of the device intended for this `TerminalAction`. + The Id can be retrieved from /v2/devices api. + deadline_duration: + type: optional> + docs: >- + The duration as an RFC 3339 duration, after which the action will be + automatically canceled. + + TerminalActions that are `PENDING` will be automatically `CANCELED` + and have a cancellation reason + + of `TIMED_OUT` + + + Default: 5 minutes from creation + + + Maximum: 5 minutes + status: + type: optional + docs: >- + The status of the `TerminalAction`. + + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, + `COMPLETED` + access: read-only + cancel_reason: + type: optional + docs: >- + The reason why `TerminalAction` is canceled. Present if the status is + `CANCELED`. + + See [ActionCancelReason](#type-actioncancelreason) for possible values + created_at: + type: optional + docs: >- + The time when the `TerminalAction` was created as an RFC 3339 + timestamp. + access: read-only + updated_at: + type: optional + docs: >- + The time when the `TerminalAction` was last updated as an RFC 3339 + timestamp. + access: read-only + app_id: + type: optional + docs: The ID of the application that created the action. + access: read-only + location_id: + type: optional + docs: The location id the action is attached to, if a link can be made. + validation: + maxLength: 64 + access: read-only + type: + type: optional + docs: |- + Represents the type of the action. + See [ActionType](#type-actiontype) for possible values + qr_code_options: + type: optional + docs: >- + Describes configuration for the QR code action. Requires `QR_CODE` + type. + save_card_options: + type: optional + docs: >- + Describes configuration for the save-card action. Requires `SAVE_CARD` + type. + signature_options: + type: optional + docs: >- + Describes configuration for the signature capture action. Requires + `SIGNATURE` type. + confirmation_options: + type: optional + docs: >- + Describes configuration for the confirmation action. Requires + `CONFIRMATION` type. + receipt_options: + type: optional + docs: >- + Describes configuration for the receipt action. Requires `RECEIPT` + type. + data_collection_options: + type: optional + docs: >- + Describes configuration for the data collection action. Requires + `DATA_COLLECTION` type. + select_options: + type: optional + docs: Describes configuration for the select action. Requires `SELECT` type. + device_metadata: + type: optional + docs: >- + Details about the Terminal that received the action request (such as + battery level, + + operating system version, and network connection settings). + + + Only available for `PING` action type. + await_next_action: + type: optional> + docs: >- + Indicates the action will be linked to another action and requires a + waiting dialog to be + + displayed instead of returning to the idle screen on completion of the + action. + + + Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT + types. + await_next_action_duration: + type: optional> + docs: >- + The timeout duration of the waiting dialog as an RFC 3339 duration, + after which the + + waiting dialog will no longer be displayed and the Terminal will + return to the idle screen. + + + Default: 5 minutes from when the waiting dialog is displayed + + + Maximum: 5 minutes + source: + openapi: openapi/openapi.json + TerminalActionActionType: + enum: + - QR_CODE + - PING + - SAVE_CARD + - SIGNATURE + - CONFIRMATION + - RECEIPT + - DATA_COLLECTION + - SELECT + docs: >- + Describes the type of this unit and indicates which field contains the + unit information. This is an ‘open’ enum. + source: + openapi: openapi/openapi.json + TerminalActionQuery: + properties: + filter: + type: optional + docs: Options for filtering returned `TerminalAction`s + sort: + type: optional + docs: Option for sorting returned `TerminalAction` objects. + source: + openapi: openapi/openapi.json + TerminalActionQueryFilter: + properties: + device_id: + type: optional> + docs: >- + `TerminalAction`s associated with a specific device. If no device is + specified then all + + `TerminalAction`s for the merchant will be displayed. + created_at: + type: optional + docs: |- + Time range for the beginning of the reporting period. Inclusive. + Default value: The current time minus one day. + Note that `TerminalAction`s are available for 30 days after creation. + status: + type: optional> + docs: >- + Filter results with the desired status of the `TerminalAction` + + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, + `COMPLETED` + type: + type: optional + docs: >- + Filter results with the requested ActionType. + + See [TerminalActionActionType](#type-terminalactionactiontype) for + possible values + source: + openapi: openapi/openapi.json + TerminalActionQuerySort: + properties: + sort_order: + type: optional + docs: |- + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + TerminalCheckout: + docs: Represents a checkout processed by the Square Terminal. + properties: + id: + type: optional + docs: A unique ID for this `TerminalCheckout`. + validation: + minLength: 10 + maxLength: 255 + access: read-only + amount_money: + type: Money + docs: >- + The amount of money (including the tax amount) that the Square + Terminal device should try to collect. + reference_id: + type: optional> + docs: >- + An optional user-defined reference ID that can be used to associate + + this `TerminalCheckout` to another entity in an external system. For + example, an order + + ID generated by a third-party shopping cart. The ID is also associated + with any payments + + used to complete the checkout. + validation: + maxLength: 40 + note: + type: optional> + docs: >- + An optional note to associate with the checkout, as well as with any + payments used to complete the checkout. + + Note: maximum 500 characters + validation: + maxLength: 500 + order_id: + type: optional> + docs: The reference to the Square order ID for the checkout request. + payment_options: + type: optional + docs: Payment-specific options for the checkout request. + device_options: + type: DeviceCheckoutOptions + docs: >- + Options to control the display and behavior of the Square Terminal + device. + deadline_duration: + type: optional> + docs: >- + An RFC 3339 duration, after which the checkout is automatically + canceled. + + A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and + has a cancellation reason + + of `TIMED_OUT`. + + + Default: 5 minutes from creation + + + Maximum: 5 minutes + status: + type: optional + docs: >- + The status of the `TerminalCheckout`. + + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, + `COMPLETED` + access: read-only + cancel_reason: + type: optional + docs: >- + The reason why `TerminalCheckout` is canceled. Present if the status + is `CANCELED`. + + See [ActionCancelReason](#type-actioncancelreason) for possible values + payment_ids: + type: optional> + docs: A list of IDs for payments created by this `TerminalCheckout`. + access: read-only + created_at: + type: optional + docs: >- + The time when the `TerminalCheckout` was created, as an RFC 3339 + timestamp. + access: read-only + updated_at: + type: optional + docs: >- + The time when the `TerminalCheckout` was last updated, as an RFC 3339 + timestamp. + access: read-only + app_id: + type: optional + docs: The ID of the application that created the checkout. + access: read-only + location_id: + type: optional + docs: The location of the device where the `TerminalCheckout` was directed. + validation: + maxLength: 64 + access: read-only + payment_type: + type: optional + docs: >- + The type of payment the terminal should attempt to capture from. + Defaults to `CARD_PRESENT`. + + See [CheckoutOptionsPaymentType](#type-checkoutoptionspaymenttype) for + possible values + team_member_id: + type: optional> + docs: >- + An optional ID of the team member associated with creating the + checkout. + customer_id: + type: optional> + docs: An optional ID of the customer associated with the checkout. + app_fee_money: + type: optional + docs: >- + The amount the developer is taking as a fee for facilitating the + payment on behalf + + of the seller. + + + The amount cannot be more than 90% of the total amount of the payment. + + + The amount must be specified in the smallest denomination of the + applicable currency (for example, US dollar amounts are specified in + cents). For more information, see [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + + The fee currency code must match the currency associated with the + seller that is accepting the payment. The application must be from a + developer account in the same country and using the same currency code + as the seller. + + + For more information about the application fee scenario, see [Take + Payments and Collect + Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + + To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth + permission is required. For more information, see + [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + statement_description_identifier: + type: optional> + docs: >- + Optional additional payment information to include on the customer's + card statement as + + part of the statement description. This can be, for example, an + invoice number, ticket number, + + or short description that uniquely identifies the purchase. + validation: + maxLength: 20 + tip_money: + type: optional + docs: >- + The amount designated as a tip, in addition to `amount_money`. This + may only be set for a + + checkout that has tipping disabled (`tip_settings.allow_tipping` is + `false`). + source: + openapi: openapi/openapi.json + TerminalCheckoutQuery: + properties: + filter: + type: optional + docs: Options for filtering returned `TerminalCheckout` objects. + sort: + type: optional + docs: Option for sorting returned `TerminalCheckout` objects. + source: + openapi: openapi/openapi.json + TerminalCheckoutQueryFilter: + properties: + device_id: + type: optional> + docs: >- + The `TerminalCheckout` objects associated with a specific device. If + no device is specified, then all + + `TerminalCheckout` objects for the merchant are displayed. + created_at: + type: optional + docs: >- + The time range for the beginning of the reporting period, which is + inclusive. + + Default value: The current time minus one day. + + Note that `TerminalCheckout`s are available for 30 days after + creation. + status: + type: optional> + docs: >- + Filtered results with the desired status of the `TerminalCheckout`. + + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, + `COMPLETED` + source: + openapi: openapi/openapi.json + TerminalCheckoutQuerySort: + properties: + sort_order: + type: optional + docs: |- + The order in which results are listed. + Default: `DESC` + See [SortOrder](#type-sortorder) for possible values + source: + openapi: openapi/openapi.json + TerminalRefund: + docs: >- + Represents a payment refund processed by the Square Terminal. Only + supports Interac (Canadian debit network) payment refunds. + properties: + id: + type: optional + docs: A unique ID for this `TerminalRefund`. + validation: + minLength: 10 + maxLength: 255 + access: read-only + refund_id: + type: optional + docs: >- + The reference to the payment refund created by completing this + `TerminalRefund`. + access: read-only + payment_id: + type: string + docs: The unique ID of the payment being refunded. + validation: + minLength: 1 + order_id: + type: optional + docs: >- + The reference to the Square order ID for the payment identified by the + `payment_id`. + access: read-only + amount_money: + type: Money + docs: >- + The amount of money, inclusive of `tax_money`, that the + `TerminalRefund` should return. + + This value is limited to the amount taken in the original payment + minus any completed or + + pending refunds. + reason: + type: string + docs: A description of the reason for the refund. + validation: + maxLength: 192 + device_id: + type: string + docs: |- + The unique ID of the device intended for this `TerminalRefund`. + The Id can be retrieved from /v2/devices api. + deadline_duration: + type: optional> + docs: >- + The RFC 3339 duration, after which the refund is automatically + canceled. + + A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and + has a cancellation reason + + of `TIMED_OUT`. + + + Default: 5 minutes from creation. + + + Maximum: 5 minutes + status: + type: optional + docs: >- + The status of the `TerminalRefund`. + + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or + `COMPLETED`. + access: read-only + cancel_reason: + type: optional + docs: |- + Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + created_at: + type: optional + docs: >- + The time when the `TerminalRefund` was created, as an RFC 3339 + timestamp. + access: read-only + updated_at: + type: optional + docs: >- + The time when the `TerminalRefund` was last updated, as an RFC 3339 + timestamp. + access: read-only + app_id: + type: optional + docs: The ID of the application that created the refund. + access: read-only + location_id: + type: optional + docs: The location of the device where the `TerminalRefund` was directed. + validation: + maxLength: 64 + access: read-only + source: + openapi: openapi/openapi.json + TerminalRefundQuery: + properties: + filter: + type: optional + docs: The filter for the Terminal refund query. + sort: + type: optional + docs: The sort order for the Terminal refund query. + source: + openapi: openapi/openapi.json + TerminalRefundQueryFilter: + properties: + device_id: + type: optional> + docs: >- + `TerminalRefund` objects associated with a specific device. If no + device is specified, then all + + `TerminalRefund` objects for the signed-in account are displayed. + created_at: + type: optional + docs: >- + The timestamp for the beginning of the reporting period, in RFC 3339 + format. Inclusive. + + Default value: The current time minus one day. + + Note that `TerminalRefund`s are available for 30 days after creation. + status: + type: optional> + docs: >- + Filtered results with the desired status of the `TerminalRefund`. + + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or + `COMPLETED`. + source: + openapi: openapi/openapi.json + TerminalRefundQuerySort: + properties: + sort_order: + type: optional> + docs: |- + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + source: + openapi: openapi/openapi.json + TestWebhookSubscriptionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) + endpoint. + + + Note: If there are errors processing the request, the + [SubscriptionTestResult](entity:SubscriptionTestResult) field is not + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + subscription_test_result: + type: optional + docs: The [SubscriptionTestResult](entity:SubscriptionTestResult). + source: + openapi: openapi/openapi.json + TimeRange: + docs: |- + Represents a generic time range. The start and end values are + represented in RFC 3339 format. Time ranges are customized to be + inclusive or exclusive based on the needs of a particular endpoint. + Refer to the relevant endpoint-specific documentation to determine + how time ranges are handled. + properties: + start_at: + type: optional> + docs: |- + A datetime value in RFC 3339 format indicating when the time range + starts. + end_at: + type: optional> + docs: |- + A datetime value in RFC 3339 format indicating when the time range + ends. + source: + openapi: openapi/openapi.json + TipSettings: + properties: + allow_tipping: + type: optional> + docs: >- + Indicates whether tipping is enabled for this checkout. Defaults to + false. + separate_tip_screen: + type: optional> + docs: >- + Indicates whether tip options should be presented on the screen before + presenting + + the signature screen during card payment. Defaults to false. + custom_tip_field: + type: optional> + docs: >- + Indicates whether custom tip amounts are allowed during the checkout + flow. Defaults to false. + tip_percentages: + type: optional>> + docs: >- + A list of tip percentages that should be presented during the checkout + flow, specified as + + up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to + 15, 20, and 25. + smart_tipping: + type: optional> + docs: >- + Enables the "Smart Tip Amounts" behavior. + + Exact tipping options depend on the region in which the Square seller + is active. + + + For payments under 10.00, in the Australia, Canada, Ireland, United + Kingdom, and United States, tipping options are presented as no tip, + .50, 1.00 or 2.00. + + + For payment amounts of 10.00 or greater, tipping options are presented + as the following percentages: 0%, 5%, 10%, 15%. + + + If set to true, the `tip_percentages` settings is ignored. + + Defaults to false. + + + To learn more about smart tipping, see [Accept Tips with the Square + App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app). + source: + openapi: openapi/openapi.json + Transaction: + docs: >- + Represents a transaction processed with Square, either with the + + Connect API or with Square Point of Sale. + + + The `tenders` field of this object lists all methods of payment used to + pay in + + the transaction. + properties: + id: + type: optional + docs: The transaction's unique ID, issued by Square payments servers. + validation: + maxLength: 192 + location_id: + type: optional> + docs: The ID of the transaction's associated location. + validation: + maxLength: 50 + created_at: + type: optional + docs: >- + The timestamp for when the transaction was created, in RFC 3339 + format. + validation: + maxLength: 32 + tenders: + type: optional>> + docs: The tenders used to pay in the transaction. + refunds: + type: optional>> + docs: Refunds that have been applied to any tender in the transaction. + reference_id: + type: optional> + docs: >- + If the transaction was created with the + [Charge](api-endpoint:Transactions-Charge) + + endpoint, this value is the same as the value provided for the + `reference_id` + + parameter in the request to that endpoint. Otherwise, it is not set. + validation: + maxLength: 40 + product: + type: optional + docs: |- + The Square product that processed the transaction. + See [TransactionProduct](#type-transactionproduct) for possible values + client_id: + type: optional> + docs: >- + If the transaction was created in the Square Point of Sale app, this + value + + is the ID generated for the transaction by Square Point of Sale. + + + This ID has no relationship to the transaction's canonical `id`, which + is + + generated by Square's backend servers. This value is generated for + bookkeeping + + purposes, in case the transaction cannot immediately be completed (for + example, + + if the transaction is processed in offline mode). + + + It is not currently possible with the Connect API to perform a + transaction + + lookup by this value. + validation: + maxLength: 192 + shipping_address: + type: optional
+ docs: The shipping address provided in the request, if any. + order_id: + type: optional> + docs: >- + The order_id is an identifier for the order associated with this + transaction, if any. + validation: + maxLength: 192 + source: + openapi: openapi/openapi.json + TransactionProduct: + enum: + - REGISTER + - EXTERNAL_API + - BILLING + - APPOINTMENTS + - INVOICES + - ONLINE_STORE + - PAYROLL + - OTHER + docs: Indicates the Square product used to process a transaction. + source: + openapi: openapi/openapi.json + UnlinkCustomerFromGiftCardResponse: + docs: >- + A response that contains the unlinked `GiftCard` object. If the request + resulted in errors, + + the response contains a set of `Error` objects. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + gift_card: + type: optional + docs: >- + The gift card with the ID of the unlinked customer removed from the + `customer_ids` field. + + If no other customers are linked, the `customer_ids` field is also + removed. + source: + openapi: openapi/openapi.json + UpdateBookingCustomAttributeDefinitionResponse: + docs: >- + Represents an + [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The updated custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateBookingResponse: + properties: + booking: + type: optional + docs: The booking that was updated. + errors: + type: optional> + docs: Errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateBreakTypeResponse: + docs: >- + A response to a request to update a `BreakType`. The response contains + + the requested `BreakType` objects and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + break_type: + type: optional + docs: The response object. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateCatalogImageRequest: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this UpdateCatalogImage request. + + Keys can be any valid string but must be unique for every + UpdateCatalogImage request. + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 128 + source: + openapi: openapi/openapi.json + UpdateCatalogImageResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + image: + type: optional + docs: |- + The newly updated `CatalogImage` including a Square-generated + URL for the encapsulated image file. + source: + openapi: openapi/openapi.json + UpdateCustomerCustomAttributeDefinitionResponse: + docs: >- + Represents an + [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The updated custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateCustomerGroupResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [UpdateCustomerGroup](api-endpoint:CustomerGroups-UpdateCustomerGroup) + endpoint. + + + Either `errors` or `group` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + group: + type: optional + docs: The successfully updated customer group. + source: + openapi: openapi/openapi.json + UpdateCustomerResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the [UpdateCustomer](api-endpoint:Customers-UpdateCustomer) + or + + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) + endpoint. + + + Either `errors` or `customer` is present in a given response (never both). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + customer: + type: optional + docs: The updated customer. + source: + openapi: openapi/openapi.json + UpdateInvoiceResponse: + docs: Describes a `UpdateInvoice` response. + properties: + invoice: + type: optional + docs: The updated invoice. + errors: + type: optional> + docs: Information about errors encountered during the request. + source: + openapi: openapi/openapi.json + UpdateItemModifierListsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + updated_at: + type: optional + docs: >- + The database + [timestamp](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates) + of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + source: + openapi: openapi/openapi.json + UpdateItemTaxesResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + updated_at: + type: optional + docs: >- + The database + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + source: + openapi: openapi/openapi.json + UpdateJobResponse: + docs: >- + Represents an [UpdateJob](api-endpoint:Team-UpdateJob) response. Either + `job` or `errors` + + is present in the response. + properties: + job: + type: optional + docs: The updated job. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateLocationCustomAttributeDefinitionResponse: + docs: >- + Represents an + [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The updated custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateLocationResponse: + docs: >- + The response object returned by the + [UpdateLocation](api-endpoint:Locations-UpdateLocation) endpoint. + properties: + errors: + type: optional> + docs: Information about errors encountered during the request. + location: + type: optional + docs: The updated `Location` object. + source: + openapi: openapi/openapi.json + UpdateLocationSettingsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred when updating the location settings. + location_settings: + type: optional + docs: The updated location settings. + source: + openapi: openapi/openapi.json + UpdateMerchantCustomAttributeDefinitionResponse: + docs: >- + Represents an + [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute_definition: + type: optional + docs: The updated custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateMerchantSettingsResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred when updating the merchant settings. + merchant_settings: + type: optional + docs: The updated merchant settings. + source: + openapi: openapi/openapi.json + UpdateOrderCustomAttributeDefinitionResponse: + docs: Represents a response from updating an order custom attribute definition. + properties: + custom_attribute_definition: + type: optional + docs: The updated order custom attribute definition. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateOrderResponse: + docs: |- + Defines the fields that are included in the response body of + a request to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + properties: + order: + type: optional + docs: The updated order. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdatePaymentLinkResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred when updating the payment link. + payment_link: + type: optional + docs: The updated payment link. + source: + openapi: openapi/openapi.json + UpdatePaymentResponse: + docs: |- + Defines the response returned by + [UpdatePayment](api-endpoint:Payments-UpdatePayment). + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + payment: + type: optional + docs: The updated payment. + source: + openapi: openapi/openapi.json + UpdateShiftResponse: + docs: |- + The response to a request to update a `Shift`. The response contains + the updated `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + properties: + shift: + type: optional + docs: The updated `Shift`. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateSubscriptionResponse: + docs: >- + Defines output parameters in a response from the + + [UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) + endpoint. + properties: + errors: + type: optional> + docs: Errors encountered during the request. + subscription: + type: optional + docs: The updated subscription. + source: + openapi: openapi/openapi.json + UpdateTeamMemberRequest: + docs: Represents an update request for a `TeamMember` object. + properties: + team_member: + type: optional + docs: >- + The team member fields to add, change, or clear. Fields can be cleared + using a null value. To update + + `wage_setting.job_assignments`, you must provide the complete list of + job assignments. If needed, call + + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` + values. + source: + openapi: openapi/openapi.json + UpdateTeamMemberResponse: + docs: >- + Represents a response from an update request containing the updated + `TeamMember` object or error messages. + properties: + team_member: + type: optional + docs: The successfully updated `TeamMember` object. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateVendorRequest: + docs: >- + Represents an input to a call to + [UpdateVendor](api-endpoint:Vendors-UpdateVendor). + properties: + idempotency_key: + type: optional> + docs: >- + A client-supplied, universally unique identifier (UUID) for the + + request. + + + See + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + in the + + [API Development 101](https://developer.squareup.com/docs/buildbasics) + section for more + + information. + validation: + maxLength: 128 + vendor: + type: Vendor + docs: The specified [Vendor](entity:Vendor) to be updated. + source: + openapi: openapi/openapi.json + UpdateVendorResponse: + docs: >- + Represents an output from a call to + [UpdateVendor](api-endpoint:Vendors-UpdateVendor). + properties: + errors: + type: optional> + docs: Errors occurred when the request fails. + vendor: + type: optional + docs: The [Vendor](entity:Vendor) that has been updated. + source: + openapi: openapi/openapi.json + UpdateWageSettingResponse: + docs: >- + Represents a response from an update request containing the updated + `WageSetting` object + + or error messages. + properties: + wage_setting: + type: optional + docs: The successfully updated `WageSetting` object. + errors: + type: optional> + docs: The errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpdateWebhookSubscriptionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription) + endpoint. + + + Note: If there are errors processing the request, the + [Subscription](entity:WebhookSubscription) is not + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + subscription: + type: optional + docs: The updated [Subscription](entity:WebhookSubscription). + source: + openapi: openapi/openapi.json + UpdateWebhookSubscriptionSignatureKeyResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) + endpoint. + + + Note: If there are errors processing the request, the + [Subscription](entity:WebhookSubscription) is not + + present. + properties: + errors: + type: optional> + docs: Information on errors encountered during the request. + signature_key: + type: optional + docs: >- + The new Square-generated signature key used to validate the origin of + the webhook event. + access: read-only + source: + openapi: openapi/openapi.json + UpdateWorkweekConfigResponse: + docs: >- + The response to a request to update a `WorkweekConfig` object. The + response contains + + the updated `WorkweekConfig` object and might contain a set of `Error` + objects if + + the request resulted in errors. + properties: + workweek_config: + type: optional + docs: The response object. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpsertBookingCustomAttributeResponse: + docs: >- + Represents an + [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpsertCatalogObjectResponse: + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + catalog_object: + type: optional + docs: The successfully created or updated CatalogObject. + id_mappings: + type: optional> + docs: The mapping between client and server IDs for this upsert. + source: + openapi: openapi/openapi.json + UpsertCustomerCustomAttributeResponse: + docs: >- + Represents an + [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpsertLocationCustomAttributeResponse: + docs: >- + Represents an + [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpsertMerchantCustomAttributeResponse: + docs: >- + Represents an + [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) + response. + + Either `custom_attribute_definition` or `errors` is present in the + response. + properties: + custom_attribute: + type: optional + docs: The new or updated custom attribute. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpsertOrderCustomAttributeResponse: + docs: Represents a response from upserting order custom attribute definitions. + properties: + custom_attribute: + type: optional + docs: The order custom attribute that was created or modified. + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + UpsertSnippetResponse: + docs: >- + Represents an `UpsertSnippet` response. The response can include either + `snippet` or `errors`. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + snippet: + type: optional + docs: The new or updated snippet. + source: + openapi: openapi/openapi.json + V1Money: + properties: + amount: + type: optional> + docs: >- + Amount in the lowest denominated value of this Currency. E.g. in USD + + these are cents, in JPY they are Yen (which do not have a 'cent' + concept). + currency_code: + type: optional + docs: |- + + See [Currency](#type-currency) for possible values + source: + openapi: openapi/openapi.json + V1Order: + docs: V1Order + properties: + errors: + type: optional>> + docs: Any errors that occurred during the request. + id: + type: optional + docs: The order's unique identifier. + buyer_email: + type: optional> + docs: The email address of the order's buyer. + recipient_name: + type: optional> + docs: The name of the order's buyer. + recipient_phone_number: + type: optional> + docs: The phone number to use for the order's delivery. + state: + type: optional + docs: |- + Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. + See [V1OrderState](#type-v1orderstate) for possible values + shipping_address: + type: optional
+ docs: The address to ship the order to. + subtotal_money: + type: optional + docs: >- + The amount of all items purchased in the order, before taxes and + shipping. + total_shipping_money: + type: optional + docs: The shipping cost for the order. + total_tax_money: + type: optional + docs: The total of all taxes applied to the order. + total_price_money: + type: optional + docs: The total cost of the order. + total_discount_money: + type: optional + docs: The total of all discounts applied to the order. + created_at: + type: optional + docs: The time when the order was created, in ISO 8601 format. + updated_at: + type: optional + docs: The time when the order was last modified, in ISO 8601 format. + expires_at: + type: optional> + docs: >- + The time when the order expires if no action is taken, in ISO 8601 + format. + payment_id: + type: optional> + docs: The unique identifier of the payment associated with the order. + buyer_note: + type: optional> + docs: A note provided by the buyer when the order was created, if any. + completed_note: + type: optional> + docs: >- + A note provided by the merchant when the order's state was set to + COMPLETED, if any + refunded_note: + type: optional> + docs: >- + A note provided by the merchant when the order's state was set to + REFUNDED, if any. + canceled_note: + type: optional> + docs: >- + A note provided by the merchant when the order's state was set to + CANCELED, if any. + tender: + type: optional + docs: The tender used to pay for the order. + order_history: + type: optional>> + docs: The history of actions associated with the order. + promo_code: + type: optional> + docs: The promo code provided by the buyer, if any. + btc_receive_address: + type: optional> + docs: For Bitcoin transactions, the address that the buyer sent Bitcoin to. + btc_price_satoshi: + type: optional> + docs: >- + For Bitcoin transactions, the price of the buyer's order in satoshi + (100 million satoshi equals 1 BTC). + source: + openapi: openapi/openapi.json + V1OrderHistoryEntry: + docs: V1OrderHistoryEntry + properties: + action: + type: optional + docs: >- + The type of action performed on the order. + + See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for + possible values + created_at: + type: optional + docs: The time when the action was performed, in ISO 8601 format. + source: + openapi: openapi/openapi.json + V1OrderHistoryEntryAction: + enum: + - ORDER_PLACED + - DECLINED + - PAYMENT_RECEIVED + - CANCELED + - COMPLETED + - REFUNDED + - EXPIRED + source: + openapi: openapi/openapi.json + V1OrderState: + enum: + - PENDING + - OPEN + - COMPLETED + - CANCELED + - REFUNDED + - REJECTED + source: + openapi: openapi/openapi.json + V1Tender: + docs: >- + A tender represents a discrete monetary exchange. Square represents this + + exchange as a money object with a specific currency and amount, where the + + amount is given in the smallest denomination of the given currency. + + + Square POS can accept more than one form of tender for a single payment + (such + + as by splitting a bill between a credit card and a gift card). The + `tender` + + field of the Payment object lists all forms of tender used for the + payment. + + + Split tender payments behave slightly differently from single tender + payments: + + + The receipt_url for a split tender corresponds only to the first tender + listed + + in the tender field. To get the receipt URLs for the remaining tenders, + use + + the receipt_url fields of the corresponding Tender objects. + + + *A note on gift cards**: when a customer purchases a Square gift card from + a + + merchant, the merchant receives the full amount of the gift card in the + + associated payment. + + + When that gift card is used as a tender, the balance of the gift card is + + reduced and the merchant receives no funds. A `Tender` object with a type + of + + `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the + + associated payment. + properties: + id: + type: optional + docs: The tender's unique ID. + type: + type: optional + docs: |- + The type of tender. + See [V1TenderType](#type-v1tendertype) for possible values + name: + type: optional> + docs: A human-readable description of the tender. + employee_id: + type: optional> + docs: The ID of the employee that processed the tender. + receipt_url: + type: optional> + docs: The URL of the receipt for the tender. + card_brand: + type: optional + docs: |- + The brand of credit card provided. + See [V1TenderCardBrand](#type-v1tendercardbrand) for possible values + pan_suffix: + type: optional> + docs: The last four digits of the provided credit card's account number. + entry_method: + type: optional + docs: >- + The tender's unique ID. + + See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible + values + payment_note: + type: optional> + docs: >- + Notes entered by the merchant about the tender at the time of payment, + if any. Typically only present for tender with the type: OTHER. + total_money: + type: optional + docs: The total amount of money provided in this form of tender. + tendered_money: + type: optional + docs: The amount of total_money applied to the payment. + tendered_at: + type: optional> + docs: The time when the tender was created, in ISO 8601 format. + settled_at: + type: optional> + docs: The time when the tender was settled, in ISO 8601 format. + change_back_money: + type: optional + docs: The amount of total_money returned to the buyer as change. + refunded_money: + type: optional + docs: >- + The total of all refunds applied to this tender. This amount is always + negative or zero. + is_exchange: + type: optional> + docs: >- + Indicates whether or not the tender is associated with an exchange. If + is_exchange is true, the tender represents the value of goods returned + in an exchange not the actual money paid. The exchange value reduces + the tender amounts needed to pay for items purchased in the exchange. + source: + openapi: openapi/openapi.json + V1TenderCardBrand: + enum: + - OTHER_BRAND + - VISA + - MASTER_CARD + - AMERICAN_EXPRESS + - DISCOVER + - DISCOVER_DINERS + - JCB + - CHINA_UNIONPAY + - SQUARE_GIFT_CARD + docs: The brand of a credit card. + source: + openapi: openapi/openapi.json + V1TenderEntryMethod: + enum: + - MANUAL + - SCANNED + - SQUARE_CASH + - SQUARE_WALLET + - SWIPED + - WEB_FORM + - OTHER + source: + openapi: openapi/openapi.json + V1TenderType: + enum: + - CREDIT_CARD + - CASH + - THIRD_PARTY_CARD + - NO_SALE + - SQUARE_WALLET + - SQUARE_GIFT_CARD + - UNKNOWN + - OTHER + source: + openapi: openapi/openapi.json + V1UpdateOrderRequestAction: + enum: + - COMPLETE + - CANCEL + - REFUND + source: + openapi: openapi/openapi.json + Vendor: + docs: Represents a supplier to a seller. + properties: + id: + type: optional + docs: >- + A unique Square-generated ID for the [Vendor](entity:Vendor). + + This field is required when attempting to update a + [Vendor](entity:Vendor). + validation: + maxLength: 100 + created_at: + type: optional + docs: |- + An RFC 3339-formatted timestamp that indicates when the + [Vendor](entity:Vendor) was created. + validation: + maxLength: 34 + access: read-only + updated_at: + type: optional + docs: |- + An RFC 3339-formatted timestamp that indicates when the + [Vendor](entity:Vendor) was last updated. + validation: + maxLength: 34 + access: read-only + name: + type: optional> + docs: >- + The name of the [Vendor](entity:Vendor). + + This field is required when attempting to create or update a + [Vendor](entity:Vendor). + validation: + maxLength: 100 + address: + type: optional
+ docs: The address of the [Vendor](entity:Vendor). + contacts: + type: optional>> + docs: The contacts of the [Vendor](entity:Vendor). + account_number: + type: optional> + docs: The account number of the [Vendor](entity:Vendor). + validation: + maxLength: 100 + note: + type: optional> + docs: A note detailing information about the [Vendor](entity:Vendor). + validation: + maxLength: 4096 + version: + type: optional + docs: The version of the [Vendor](entity:Vendor). + status: + type: optional + docs: |- + The status of the [Vendor](entity:Vendor). + See [Status](#type-status) for possible values + source: + openapi: openapi/openapi.json + VendorContact: + docs: Represents a contact of a [Vendor](entity:Vendor). + properties: + id: + type: optional + docs: >- + A unique Square-generated ID for the + [VendorContact](entity:VendorContact). + + This field is required when attempting to update a + [VendorContact](entity:VendorContact). + validation: + maxLength: 100 + name: + type: optional> + docs: >- + The name of the [VendorContact](entity:VendorContact). + + This field is required when attempting to create a + [Vendor](entity:Vendor). + validation: + maxLength: 255 + email_address: + type: optional> + docs: The email address of the [VendorContact](entity:VendorContact). + validation: + maxLength: 255 + phone_number: + type: optional> + docs: The phone number of the [VendorContact](entity:VendorContact). + validation: + maxLength: 255 + removed: + type: optional> + docs: The state of the [VendorContact](entity:VendorContact). + ordinal: + type: integer + docs: The ordinal of the [VendorContact](entity:VendorContact). + source: + openapi: openapi/openapi.json + VendorStatus: + enum: + - ACTIVE + - INACTIVE + docs: |- + The status of the [Vendor](entity:Vendor), + whether a [Vendor](entity:Vendor) is active or inactive. + source: + openapi: openapi/openapi.json + VisibilityFilter: + enum: + - ALL + - READ + - READ_WRITE + docs: >- + Enumeration of visibility-filter values used to set the ability to view + custom attributes or custom attribute definitions. + source: + openapi: openapi/openapi.json + VoidTransactionResponse: + docs: >- + Defines the fields that are included in the response body of + + a request to the + [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint. + properties: + errors: + type: optional> + docs: Any errors that occurred during the request. + source: + openapi: openapi/openapi.json + WageSetting: + docs: >- + Represents information about the overtime exemption status, job + assignments, and compensation + + for a [team member](entity:TeamMember). + properties: + team_member_id: + type: optional> + docs: The ID of the team member associated with the wage setting. + job_assignments: + type: optional>> + docs: >- + **Required** The ordered list of jobs that the team member is assigned + to. + + The first job assignment is considered the team member's primary job. + is_overtime_exempt: + type: optional> + docs: >- + Whether the team member is exempt from the overtime rules of the + seller's country. + version: + type: optional + docs: >- + **Read only** Used for resolving concurrency issues. The request fails + if the version + + provided does not match the server version at the time of the request. + If not provided, + + Square executes a blind write, potentially overwriting data from + another write. For more information, + + see [optimistic + concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency). + created_at: + type: optional + docs: The timestamp when the wage setting was created, in RFC 3339 format. + access: read-only + updated_at: + type: optional + docs: >- + The timestamp when the wage setting was last updated, in RFC 3339 + format. + access: read-only + source: + openapi: openapi/openapi.json + WebhookSubscription: + docs: >- + Represents the details of a webhook subscription, including notification + URL, + + event types, and signature key. + properties: + id: + type: optional + docs: A Square-generated unique ID for the subscription. + validation: + maxLength: 64 + access: read-only + name: + type: optional> + docs: The name of this subscription. + validation: + maxLength: 64 + enabled: + type: optional> + docs: >- + Indicates whether the subscription is enabled (`true`) or not + (`false`). + event_types: + type: optional>> + docs: The event types associated with this subscription. + notification_url: + type: optional> + docs: The URL to which webhooks are sent. + api_version: + type: optional> + docs: |- + The API version of the subscription. + This field is optional for `CreateWebhookSubscription`. + The value defaults to the API version used by the application. + signature_key: + type: optional + docs: >- + The Square-generated signature key used to validate the origin of the + webhook event. + access: read-only + created_at: + type: optional + docs: >- + The timestamp of when the subscription was created, in RFC 3339 + format. For example, "2016-09-04T23:59:33.123Z". + access: read-only + updated_at: + type: optional + docs: >- + The timestamp of when the subscription was last updated, in RFC 3339 + format. + + For example, "2016-09-04T23:59:33.123Z". + access: read-only + source: + openapi: openapi/openapi.json + Weekday: + enum: + - MON + - TUE + - WED + - THU + - FRI + - SAT + - SUN + docs: The days of the week. + source: + openapi: openapi/openapi.json + WorkweekConfig: + docs: |- + Sets the day of the week and hour of the day that a business starts a + workweek. This is used to calculate overtime pay. + properties: + id: + type: optional + docs: The UUID for this object. + start_of_week: + type: Weekday + docs: |- + The day of the week on which a business week starts for + compensation purposes. + See [Weekday](#type-weekday) for possible values + start_of_day_local_time: + type: string + docs: |- + The local time at which a business week starts. Represented as a + string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are + truncated). + validation: + minLength: 1 + version: + type: optional + docs: >- + Used for resolving concurrency issues. The request fails if the + version + + provided does not match the server version at the time of the request. + If not provided, + + Square executes a blind write; potentially overwriting data from + another + + write. + created_at: + type: optional + docs: A read-only timestamp in RFC 3339 format; presented in UTC. + access: read-only + updated_at: + type: optional + docs: A read-only timestamp in RFC 3339 format; presented in UTC. + access: read-only + source: + openapi: openapi/openapi.json + CatalogObjectBase: + properties: + type: + type: CatalogObjectType + docs: >- + The type of this object. Each object type has expected + + properties expressed in a structured format within its corresponding + `*_data` field below. + + See [CatalogObjectType](#type-catalogobjecttype) for possible values + id: + type: string + docs: >- + An identifier to reference this object in the catalog. When a new + `CatalogObject` + + is inserted, the client should set the id to a temporary identifier + starting with + + a "`#`" character. Other objects being inserted or updated within the + same request + + may use this identifier to refer to the new object. + + + When the server receives the new object, it will supply a unique + identifier that + + replaces the temporary identifier for all future references. + validation: + minLength: 1 + updated_at: + type: optional + docs: >- + Last modification + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` + + would indicate the UTC time (denoted by `Z`) of August 15, 2016 at + 23:59:33 and 123 milliseconds. + access: read-only + version: + type: optional + docs: >- + The version of the object. When updating an object, the version + supplied + + must match the version in the database, otherwise the write will be + rejected as conflicting. + is_deleted: + type: optional + docs: >- + If `true`, the object has been deleted from the database. Must be + `false` for new objects + + being inserted. When deleted, the `updated_at` field will equal the + deletion time. + custom_attribute_values: + type: optional> + docs: >- + A map (key-value pairs) of application-defined custom attribute + values. The value of a key-value pair + + is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) + object. The key is the `key` attribute + + value defined in the associated + [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + + object defined by the application making the request. + + + If the `CatalogCustomAttributeDefinition` object is + + defined by another application, the + `CatalogCustomAttributeDefinition`'s key attribute value is prefixed + by + + the defining application ID. For example, if the + `CatalogCustomAttributeDefinition` has a `key` attribute of + + `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the + key in the map is `"abcd1234:cocoa_brand"` + + if the application making the request is different from the + application defining the custom attribute definition. + + Otherwise, the key used in the map is simply `"cocoa_brand"`. + + + Application-defined custom attributes are set at a global + (location-independent) level. + + Custom attribute values are intended to store additional information + about a catalog object + + or associations with an entity in another system. Do not use custom + attributes + + to store any sensitive information (personally identifiable + information, card details, etc.). + catalog_v1_ids: + type: optional> + docs: >- + The Connect v1 IDs for this object at each location where it is + present, where they + + differ from the object's Connect V2 ID. The field will only be present + for objects that + + have been created or modified by legacy APIs. + present_at_all_locations: + type: optional + docs: >- + If `true`, this object is present at all locations (including future + locations), except where specified in + + the `absent_at_location_ids` field. If `false`, this object is not + present at any locations (including future locations), + + except where specified in the `present_at_location_ids` field. If not + specified, defaults to `true`. + present_at_location_ids: + type: optional> + docs: >- + A list of locations where the object is present, even if + `present_at_all_locations` is `false`. + + This can include locations that are deactivated. + absent_at_location_ids: + type: optional> + docs: >- + A list of locations where the object is not present, even if + `present_at_all_locations` is `true`. + + This can include locations that are deactivated. + image_id: + type: optional + docs: Identifies the `CatalogImage` attached to this `CatalogObject`. + source: + openapi: openapi/openapi.json + CatalogObjectItem: + properties: + item_data: + type: optional + docs: >- + Structured data for a `CatalogItem`, set for CatalogObjects of type + `ITEM`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectItemVariation: + properties: + item_variation_data: + type: optional + docs: >- + Structured data for a `CatalogItemVariation`, set for CatalogObjects + of type `ITEM_VARIATION`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectTax: + properties: + tax_data: + type: optional + docs: >- + Structured data for a `CatalogTax`, set for CatalogObjects of type + `TAX`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectDiscount: + properties: + discount_data: + type: optional + docs: >- + Structured data for a `CatalogDiscount`, set for CatalogObjects of + type `DISCOUNT`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectModifierList: + properties: + modifier_list_data: + type: optional + docs: >- + Structured data for a `CatalogModifierList`, set for CatalogObjects of + type `MODIFIER_LIST`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectModifier: + properties: + modifier_data: + type: optional + docs: >- + Structured data for a `CatalogModifier`, set for CatalogObjects of + type `MODIFIER`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectDiningOption: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectTaxExemption: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectServiceCharge: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectTimePeriod: + properties: + time_period_data: + type: optional + docs: >- + Structured data for a `CatalogTimePeriod`, set for CatalogObjects of + type `TIME_PERIOD`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectProductSet: + properties: + product_set_data: + type: optional + docs: >- + Structured data for a `CatalogProductSet`, set for CatalogObjects of + type `PRODUCT_SET`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectPricingRule: + properties: + pricing_rule_data: + type: optional + docs: >- + Structured data for a `CatalogPricingRule`, set for CatalogObjects of + type `PRICING_RULE`. + + A `CatalogPricingRule` object often works with a `CatalogProductSet` + object or a `CatalogTimePeriod` object. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectImage: + properties: + image_data: + type: optional + docs: >- + Structured data for a `CatalogImage`, set for CatalogObjects of type + `IMAGE`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectMeasurementUnit: + properties: + measurement_unit_data: + type: optional + docs: >- + Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects + of type `MEASUREMENT_UNIT`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectSubscriptionPlan: + properties: + subscription_plan_data: + type: optional + docs: >- + Structured data for a `CatalogSubscriptionPlan`, set for + CatalogObjects of type `SUBSCRIPTION_PLAN`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectItemOption: + properties: + item_option_data: + type: optional + docs: >- + Structured data for a `CatalogItemOption`, set for CatalogObjects of + type `ITEM_OPTION`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectItemOptionValue: + properties: + item_option_value_data: + type: optional + docs: >- + Structured data for a `CatalogItemOptionValue`, set for CatalogObjects + of type `ITEM_OPTION_VAL`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectCustomAttributeDefinition: + properties: + custom_attribute_definition_data: + type: optional + docs: >- + Structured data for a `CatalogCustomAttributeDefinition`, set for + CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectQuickAmountsSettings: + properties: + quick_amounts_settings_data: + type: optional + docs: >- + Structured data for a `CatalogQuickAmountsSettings`, set for + CatalogObjects of type `QUICK_AMOUNTS_SETTINGS`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectSubscriptionPlanVariation: + properties: + subscription_plan_variation_data: + type: optional + docs: >- + Structured data for a `CatalogSubscriptionPlanVariation`, set for + CatalogObjects of type `SUBSCRIPTION_PLAN_VARIATION`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectAvailabilityPeriod: + properties: + availability_period_data: + type: optional + docs: >- + Structured data for a `CatalogAvailabilityPeriod`, set for + CatalogObjects of type `AVAILABILITY_PERIOD`. + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectComponent: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectComposition: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectResource: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectCheckoutLink: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectAddress: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json + CatalogObjectSubscriptionProduct: + properties: {} + extends: + - CatalogObjectBase + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/api.yml b/.mock/definition/api.yml new file mode 100644 index 00000000..28aa10da --- /dev/null +++ b/.mock/definition/api.yml @@ -0,0 +1,19 @@ +name: api +error-discrimination: + strategy: status-code +display-name: Square +environments: + Production: https://connect.squareup.com + Sandbox: https://connect.squareupsandbox.com +default-environment: Production +headers: + Square-Version: + name: version + env: VERSION + type: literal<"2025-04-16"> +auth-schemes: + Bearer: + scheme: bearer + token: + env: SQUARE_TOKEN +auth: Bearer diff --git a/.mock/definition/applePay.yml b/.mock/definition/applePay.yml new file mode 100644 index 00000000..9418353c --- /dev/null +++ b/.mock/definition/applePay.yml @@ -0,0 +1,78 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + RegisterDomain: + path: /v2/apple-pay/domains + method: POST + auth: true + docs: >- + Activates a domain for use with Apple Pay on the Web and Square. A + validation + + is performed on this domain by Apple to ensure that it is properly set + up as + + an Apple Pay enabled domain. + + + This endpoint provides an easy way for platform developers to bulk + activate + + Apple Pay on the Web with Square for merchants using their platform. + + + Note: You will need to host a valid domain verification file on your + domain to support Apple Pay. The + + current version of this file is always available at + https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, + + and should be hosted at + `.well_known/apple-developer-merchantid-domain-association` on your + + domain. This file is subject to change; we strongly recommend checking + for updates regularly and avoiding + + long-lived caches that might not keep in sync with the correct file + version. + + + To learn more about the Web Payments SDK and how to add Apple Pay, see + [Take an Apple Pay + Payment](https://developer.squareup.com/docs/web-payments/apple-pay). + source: + openapi: openapi/openapi.json + display-name: RegisterDomain + request: + name: RegisterDomainRequest + body: + properties: + domain_name: + type: string + docs: >- + A domain name as described in RFC-1034 that will be registered + with ApplePay. + validation: + minLength: 1 + maxLength: 255 + content-type: application/json + response: + docs: Success + type: root.RegisterDomainResponse + status-code: 200 + examples: + - request: + domain_name: example.com + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + status: VERIFIED + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/bankAccounts.yml b/.mock/definition/bankAccounts.yml new file mode 100644 index 00000000..0981f46c --- /dev/null +++ b/.mock/definition/bankAccounts.yml @@ -0,0 +1,206 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/bank-accounts + method: GET + auth: true + docs: >- + Returns a list of [BankAccount](entity:BankAccount) objects linked to a + Square account. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.bank_accounts + source: + openapi: openapi/openapi.json + display-name: ListBankAccounts + request: + name: ListBankAccountsRequest + query-parameters: + cursor: + type: optional> + docs: >- + The pagination cursor returned by a previous call to this + endpoint. + + Use it in the next `ListBankAccounts` request to retrieve the next + set + + of results. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + limit: + type: optional> + docs: >- + Upper limit on the number of bank accounts to return in the + response. + + Currently, 1000 is the largest supported limit. You can specify a + limit + + of up to 1000 bank accounts. This is also the default limit. + location_id: + type: optional> + docs: >- + Location ID. You can specify this optional filter + + to retrieve only the linked bank accounts belonging to a specific + location. + response: + docs: Success + type: root.ListBankAccountsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + bank_accounts: + - id: ao6iaQ9vhDiaQD7n3GB + account_number_suffix: '971' + country: US + currency: USD + account_type: CHECKING + holder_name: Jane Doe + primary_bank_identification_number: '112200303' + secondary_bank_identification_number: secondary_bank_identification_number + debit_mandate_reference_id: debit_mandate_reference_id + reference_id: reference_id + location_id: S8GWD5example + status: VERIFICATION_IN_PROGRESS + creditable: false + debitable: false + fingerprint: fingerprint + version: 5 + bank_name: Bank Name + - id: 4x7WXuaxrkQkVlka3GB + account_number_suffix: '972' + country: US + currency: USD + account_type: CHECKING + holder_name: Jane Doe + primary_bank_identification_number: '112200303' + secondary_bank_identification_number: secondary_bank_identification_number + debit_mandate_reference_id: debit_mandate_reference_id + reference_id: reference_id + location_id: S8GWD5example + status: VERIFICATION_IN_PROGRESS + creditable: false + debitable: false + fingerprint: fingerprint + version: 5 + bank_name: Bank Name + cursor: cursor + GetByV1Id: + path: /v2/bank-accounts/by-v1-id/{v1_bank_account_id} + method: GET + auth: true + docs: >- + Returns details of a [BankAccount](entity:BankAccount) identified by V1 + bank account ID. + source: + openapi: openapi/openapi.json + display-name: GetBankAccountByV1Id + request: + name: GetByV1IdBankAccountsRequest + path-parameters: + v1_bank_account_id: + type: string + docs: >- + Connect V1 ID of the desired `BankAccount`. For more information, + see + + [Retrieve a bank account by using an ID issued by V1 Bank Accounts + API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). + response: + docs: Success + type: root.GetBankAccountByV1IdResponse + status-code: 200 + examples: + - path-parameters: + v1_bank_account_id: v1_bank_account_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + bank_account: + id: w3yRgCGYQnwmdl0R3GB + account_number_suffix: '971' + country: US + currency: USD + account_type: CHECKING + holder_name: Jane Doe + primary_bank_identification_number: '112200303' + secondary_bank_identification_number: secondary_bank_identification_number + debit_mandate_reference_id: debit_mandate_reference_id + reference_id: reference_id + location_id: S8GWD5example + status: VERIFICATION_IN_PROGRESS + creditable: false + debitable: false + fingerprint: fingerprint + version: 5 + bank_name: Bank Name + get: + path: /v2/bank-accounts/{bank_account_id} + method: GET + auth: true + docs: |- + Returns details of a [BankAccount](entity:BankAccount) + linked to a Square account. + source: + openapi: openapi/openapi.json + display-name: GetBankAccount + request: + name: GetBankAccountsRequest + path-parameters: + bank_account_id: + type: string + docs: Square-issued ID of the desired `BankAccount`. + response: + docs: Success + type: root.GetBankAccountResponse + status-code: 200 + examples: + - path-parameters: + bank_account_id: bank_account_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + bank_account: + id: w3yRgCGYQnwmdl0R3GB + account_number_suffix: '971' + country: US + currency: USD + account_type: CHECKING + holder_name: Jane Doe + primary_bank_identification_number: '112200303' + secondary_bank_identification_number: secondary_bank_identification_number + debit_mandate_reference_id: debit_mandate_reference_id + reference_id: reference_id + location_id: S8GWD5example + status: VERIFICATION_IN_PROGRESS + creditable: false + debitable: false + fingerprint: fingerprint + version: 5 + bank_name: Bank Name + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/bookings.yml b/.mock/definition/bookings.yml new file mode 100644 index 00000000..a0167d2d --- /dev/null +++ b/.mock/definition/bookings.yml @@ -0,0 +1,861 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/bookings + method: GET + auth: true + docs: >- + Retrieve a collection of bookings. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.bookings + source: + openapi: openapi/openapi.json + display-name: ListBookings + request: + name: ListBookingsRequest + query-parameters: + limit: + type: optional> + docs: >- + The maximum number of results per page to return in a paged + response. + cursor: + type: optional> + docs: >- + The pagination cursor from the preceding response to return the + next page of the results. Do not set this when retrieving the + first page of the results. + customer_id: + type: optional> + docs: >- + The [customer](entity:Customer) for whom to retrieve bookings. If + this is not set, bookings for all customers are retrieved. + team_member_id: + type: optional> + docs: >- + The team member for whom to retrieve bookings. If this is not set, + bookings of all members are retrieved. + location_id: + type: optional> + docs: >- + The location for which to retrieve bookings. If this is not set, + all locations' bookings are retrieved. + start_at_min: + type: optional> + docs: >- + The RFC 3339 timestamp specifying the earliest of the start time. + If this is not set, the current time is used. + start_at_max: + type: optional> + docs: >- + The RFC 3339 timestamp specifying the latest of the start time. If + this is not set, the time of 31 days after `start_at_min` is used. + response: + docs: Success + type: root.ListBookingsResponse + status-code: 200 + examples: + - response: + body: + bookings: + - id: zkras0xv0xwswx + version: 1 + status: ACCEPTED + created_at: '2020-10-28T15:47:41Z' + updated_at: '2020-10-28T15:49:25Z' + start_at: '2020-11-26T13:00:00Z' + location_id: LEQHH0YY8B42M + customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M + customer_note: '' + seller_note: '' + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + transition_time_minutes: 1 + all_day: true + location_type: BUSINESS_LOCATION + source: FIRST_PARTY_MERCHANT + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/bookings + method: POST + auth: true + docs: >- + Creates a booking. + + + The required input must include the following: + + - `Booking.location_id` + + - `Booking.start_at` + + - `Booking.AppointmentSegment.team_member_id` + + - `Booking.AppointmentSegment.service_variation_id` + + - `Booking.AppointmentSegment.service_variation_version` + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: CreateBooking + request: + name: CreateBookingRequest + body: + properties: + idempotency_key: + type: optional + docs: A unique key to make this request an idempotent operation. + validation: + maxLength: 255 + booking: + type: root.Booking + docs: The details of the booking to be created. + content-type: application/json + response: + docs: Success + type: root.CreateBookingResponse + status-code: 200 + examples: + - request: + booking: {} + response: + body: + booking: + id: zkras0xv0xwswx + version: 0 + status: ACCEPTED + created_at: '2020-10-28T15:47:41Z' + updated_at: '2020-10-28T15:47:41Z' + start_at: '2020-11-26T13:00:00Z' + location_id: LEQHH0YY8B42M + customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M + customer_note: '' + seller_note: '' + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + transition_time_minutes: 1 + all_day: true + location_type: BUSINESS_LOCATION + creator_details: + creator_type: TEAM_MEMBER + team_member_id: team_member_id + customer_id: customer_id + source: FIRST_PARTY_MERCHANT + address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + SearchAvailability: + path: /v2/bookings/availability/search + method: POST + auth: true + docs: >- + Searches for availabilities for booking. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + source: + openapi: openapi/openapi.json + display-name: SearchAvailability + request: + name: SearchAvailabilityRequest + body: + properties: + query: + type: root.SearchAvailabilityQuery + docs: >- + Query conditions used to filter buyer-accessible booking + availabilities. + content-type: application/json + response: + docs: Success + type: root.SearchAvailabilityResponse + status-code: 200 + examples: + - request: + query: + filter: + start_at_range: {} + response: + body: + availabilities: + - start_at: '2020-11-26T13:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-26T13:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-26T14:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-26T14:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-26T15:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-26T15:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-26T16:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-27T09:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-27T09:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-27T10:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-27T10:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-27T11:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-27T11:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-27T12:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-27T12:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + - start_at: '2020-11-27T13:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-27T13:30:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + - start_at: '2020-11-27T14:00:00Z' + location_id: LEQHH0YY8B42M + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMaJcbiRqPIGZuS9 + service_variation_version: 1599775456731 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + BulkRetrieveBookings: + path: /v2/bookings/bulk-retrieve + method: POST + auth: true + docs: >- + Bulk-Retrieves a list of bookings by booking IDs. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + source: + openapi: openapi/openapi.json + display-name: BulkRetrieveBookings + request: + name: BulkRetrieveBookingsRequest + body: + properties: + booking_ids: + docs: >- + A non-empty list of [Booking](entity:Booking) IDs specifying + bookings to retrieve. + type: list + content-type: application/json + response: + docs: Success + type: root.BulkRetrieveBookingsResponse + status-code: 200 + examples: + - request: + booking_ids: + - booking_ids + response: + body: + bookings: + sc3p3m7dvctfr1: + booking: + id: sc3p3m7dvctfr1 + version: 0 + status: ACCEPTED + created_at: '2023-04-26T18:19:21Z' + updated_at: '2023-04-26T18:19:21Z' + start_at: '2023-05-01T14:00:00Z' + location_id: LY6WNBPVM6VGV + customer_id: 4TDWKN9E8165X8Z77MRS0VFMJM + appointment_segments: + - duration_minutes: 60 + service_variation_id: VG4FYBKK3UL6UITOEYQ6MFLS + team_member_id: TMjiqI3PxyLMKr4k + service_variation_version: 1641341724039 + any_team_member: false + all_day: false + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + tdegug1dvctdef: + errors: + - category: INVALID_REQUEST_ERROR + code: NOT_FOUND + detail: Specified booking was not found. + field: booking_id + tdegug1fqni3wh: + booking: + id: tdegug1fqni3wh + version: 0 + status: ACCEPTED + created_at: '2023-04-26T18:19:30Z' + updated_at: '2023-04-26T18:19:30Z' + start_at: '2023-05-02T14:00:00Z' + location_id: LY6WNBPVM6VGV + customer_id: 4TDWKN9E8165X8Z77MRS0VFMJM + appointment_segments: + - duration_minutes: 60 + service_variation_id: VG4FYBKK3UL6UITOEYQ6MFLS + team_member_id: TMjiqI3PxyLMKr4k + service_variation_version: 1641341724039 + any_team_member: false + all_day: false + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + getBusinessProfile: + path: /v2/bookings/business-booking-profile + method: GET + auth: true + docs: Retrieves a seller's booking profile. + source: + openapi: openapi/openapi.json + display-name: RetrieveBusinessBookingProfile + response: + docs: Success + type: root.GetBusinessBookingProfileResponse + status-code: 200 + examples: + - response: + body: + business_booking_profile: + seller_id: MLJQYZZRM0D3Y + created_at: '2020-09-10T21:40:38Z' + booking_enabled: true + customer_timezone_choice: CUSTOMER_CHOICE + booking_policy: ACCEPT_ALL + allow_user_cancel: true + business_appointment_settings: + location_types: + - BUSINESS_LOCATION + alignment_time: HALF_HOURLY + min_booking_lead_time_seconds: 0 + max_booking_lead_time_seconds: 31536000 + any_team_member_booking_enabled: true + multiple_service_booking_enabled: true + max_appointments_per_day_limit_type: PER_TEAM_MEMBER + max_appointments_per_day_limit: 1 + cancellation_window_seconds: 1 + cancellation_fee_money: + currency: USD + cancellation_policy: CUSTOM_POLICY + cancellation_policy_text: cancellation_policy_text + skip_booking_flow_staff_selection: false + support_seller_level_writes: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + RetrieveLocationBookingProfile: + path: /v2/bookings/location-booking-profiles/{location_id} + method: GET + auth: true + docs: Retrieves a seller's location booking profile. + source: + openapi: openapi/openapi.json + display-name: RetrieveLocationBookingProfile + request: + name: RetrieveLocationBookingProfileRequest + path-parameters: + location_id: + type: string + docs: The ID of the location to retrieve the booking profile. + response: + docs: Success + type: root.RetrieveLocationBookingProfileResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + response: + body: + location_booking_profile: + location_id: L3HETDGYQ4A2C + booking_site_url: https://square.site/book/L3HETDGYQ4A2C/prod-business + online_booking_enabled: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + BulkRetrieveTeamMemberBookingProfiles: + path: /v2/bookings/team-member-booking-profiles/bulk-retrieve + method: POST + auth: true + docs: Retrieves one or more team members' booking profiles. + source: + openapi: openapi/openapi.json + display-name: BulkRetrieveTeamMemberBookingProfiles + request: + name: BulkRetrieveTeamMemberBookingProfilesRequest + body: + properties: + team_member_ids: + docs: >- + A non-empty list of IDs of team members whose booking profiles + you want to retrieve. + type: list + content-type: application/json + response: + docs: Success + type: root.BulkRetrieveTeamMemberBookingProfilesResponse + status-code: 200 + examples: + - request: + team_member_ids: + - team_member_ids + response: + body: + team_member_booking_profiles: + TMXUrsBWWcHTt79t: + errors: + - category: INVALID_REQUEST_ERROR + code: NOT_FOUND + detail: Resource not found. + TMaJcbiRqPIGZuS9: + team_member_booking_profile: + team_member_id: TMaJcbiRqPIGZuS9 + display_name: Sandbox Staff 1 + is_bookable: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + TMtdegug1fqni3wh: + team_member_booking_profile: + team_member_id: TMtdegug1fqni3wh + display_name: Sandbox Staff 2 + is_bookable: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/bookings/{booking_id} + method: GET + auth: true + docs: >- + Retrieves a booking. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + source: + openapi: openapi/openapi.json + display-name: RetrieveBooking + request: + name: GetBookingsRequest + path-parameters: + booking_id: + type: string + docs: >- + The ID of the [Booking](entity:Booking) object representing the + to-be-retrieved booking. + response: + docs: Success + type: root.GetBookingResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + response: + body: + booking: + id: zkras0xv0xwswx + version: 1 + status: ACCEPTED + created_at: '2020-10-28T15:47:41Z' + updated_at: '2020-10-28T15:49:25Z' + start_at: '2020-11-26T13:00:00Z' + location_id: LEQHH0YY8B42M + customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M + customer_note: '' + seller_note: '' + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + transition_time_minutes: 1 + all_day: true + location_type: BUSINESS_LOCATION + creator_details: + creator_type: TEAM_MEMBER + team_member_id: team_member_id + customer_id: customer_id + source: FIRST_PARTY_MERCHANT + address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/bookings/{booking_id} + method: PUT + auth: true + docs: >- + Updates a booking. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: UpdateBooking + request: + name: UpdateBookingRequest + path-parameters: + booking_id: + type: string + docs: >- + The ID of the [Booking](entity:Booking) object representing the + to-be-updated booking. + body: + properties: + idempotency_key: + type: optional> + docs: A unique key to make this request an idempotent operation. + validation: + maxLength: 255 + booking: + type: root.Booking + docs: >- + The booking to be updated. Individual attributes explicitly + specified here override the corresponding values of the existing + booking. + content-type: application/json + response: + docs: Success + type: root.UpdateBookingResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + request: + booking: {} + response: + body: + booking: + id: zkras0xv0xwswx + version: 2 + status: ACCEPTED + created_at: '2020-10-28T15:47:41Z' + updated_at: '2020-10-28T15:49:25Z' + start_at: '2020-11-26T13:00:00Z' + location_id: LEQHH0YY8B42M + customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M + customer_note: I would like to sit near the window please + seller_note: '' + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + transition_time_minutes: 1 + all_day: true + location_type: CUSTOMER_LOCATION + creator_details: + creator_type: TEAM_MEMBER + team_member_id: team_member_id + customer_id: customer_id + source: FIRST_PARTY_MERCHANT + address: + address_line_1: 1955 Broadway + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: Oakland + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: CA + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '94612' + country: ZZ + first_name: first_name + last_name: last_name + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cancel: + path: /v2/bookings/{booking_id}/cancel + method: POST + auth: true + docs: >- + Cancels an existing booking. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: CancelBooking + request: + name: CancelBookingRequest + path-parameters: + booking_id: + type: string + docs: >- + The ID of the [Booking](entity:Booking) object representing the + to-be-cancelled booking. + body: + properties: + idempotency_key: + type: optional> + docs: A unique key to make this request an idempotent operation. + validation: + maxLength: 255 + booking_version: + type: optional> + docs: >- + The revision number for the booking used for optimistic + concurrency. + content-type: application/json + response: + docs: Success + type: root.CancelBookingResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + request: {} + response: + body: + booking: + id: zkras0xv0xwswx + version: 1 + status: CANCELLED_BY_CUSTOMER + created_at: '2020-10-28T15:47:41Z' + updated_at: '2020-10-28T15:49:25Z' + start_at: '2020-11-26T13:00:00Z' + location_id: LEQHH0YY8B42M + customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M + customer_note: '' + seller_note: '' + appointment_segments: + - duration_minutes: 60 + service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC + team_member_id: TMXUrsBWWcHTt79t + service_variation_version: 1599775456731 + transition_time_minutes: 1 + all_day: true + location_type: BUSINESS_LOCATION + creator_details: + creator_type: TEAM_MEMBER + team_member_id: team_member_id + customer_id: customer_id + source: FIRST_PARTY_MERCHANT + address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/bookings/customAttributeDefinitions.yml b/.mock/definition/bookings/customAttributeDefinitions.yml new file mode 100644 index 00000000..0a5fc3dc --- /dev/null +++ b/.mock/definition/bookings/customAttributeDefinitions.yml @@ -0,0 +1,388 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/bookings/custom-attribute-definitions + method: GET + auth: true + docs: >- + Get all bookings custom attribute definitions. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attribute_definitions + source: + openapi: openapi/openapi.json + display-name: ListBookingCustomAttributeDefinitions + request: + name: ListCustomAttributeDefinitionsRequest + query-parameters: + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListBookingCustomAttributeDefinitionsResponse + status-code: 200 + examples: + - response: + body: + custom_attribute_definitions: + - key: favoriteShampoo + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite shampoo + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + version: 3 + updated_at: '2022-11-16T15:39:38Z' + created_at: '2022-11-16T15:27:30Z' + - key: partySize + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Party size + description: Number of people in the party for dine-in + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: '2022-11-16T15:49:05Z' + created_at: '2022-11-16T15:49:05Z' + cursor: >- + YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/bookings/custom-attribute-definitions + method: POST + auth: true + docs: >- + Creates a bookings custom attribute definition. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: CreateBookingCustomAttributeDefinition + request: + name: CreateBookingCustomAttributeDefinitionRequest + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition to create, with the following + fields: + + + - `key` + + + - `name`. If provided, `name` must be unique (case-sensitive) + across all visible booking-related custom attribute + + definitions for the seller. + + + - `description` + + + - `visibility`. Note that all custom attributes are visible in + exported booking data, including those set to + + `VISIBILITY_HIDDEN`. + + + - `schema`. With the exception of the `Selection` data type, the + `schema` is specified as a + + simple URL to the JSON schema definition hosted on the Square + CDN. For more information, see + + [Specifying the + schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema). + idempotency_key: + type: optional + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CreateBookingCustomAttributeDefinitionResponse + status-code: 200 + examples: + - request: + custom_attribute_definition: {} + response: + body: + custom_attribute_definition: + key: favoriteShampoo + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite Shampoo + description: The favorite shampoo of the customer. + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: '2022-11-16T15:27:30Z' + created_at: '2022-11-16T15:27:30Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/bookings/custom-attribute-definitions/{key} + method: GET + auth: true + docs: >- + Retrieves a bookings custom attribute definition. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + source: + openapi: openapi/openapi.json + display-name: RetrieveBookingCustomAttributeDefinition + request: + name: GetCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: >- + The key of the custom attribute definition to retrieve. If the + requesting application + + is not the definition owner, you must use the qualified key. + query-parameters: + version: + type: optional> + docs: >- + The current version of the custom attribute definition, which is + used for strongly consistent + + reads to guarantee that you receive the most up-to-date data. When + included in the request, + + Square returns the specified version or a higher version if one + exists. If the specified version + + is higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.RetrieveBookingCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + custom_attribute_definition: + key: favoriteShampoo + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite shampoo + description: The favorite shampoo of the customer. + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-11-16T15:27:30Z' + created_at: '2022-11-16T15:27:30Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/bookings/custom-attribute-definitions/{key} + method: PUT + auth: true + docs: >- + Updates a bookings custom attribute definition. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: UpdateBookingCustomAttributeDefinition + request: + name: UpdateBookingCustomAttributeDefinitionRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to update. + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition that contains the fields to + update. Only the following fields can be updated: + + - `name` + + - `description` + + - `visibility` + + - `schema` for a `Selection` data type. Only changes to the + named options or the maximum number of allowed + + selections are supported. + + + For more information, see + + [Updatable definition + fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + + To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, include the optional `version` field and specify the + current version of the custom attribute definition. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdateBookingCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + request: + custom_attribute_definition: {} + response: + body: + custom_attribute_definition: + key: favoriteShampoo + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite shampoo + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + version: 2 + updated_at: '2022-11-16T15:39:38Z' + created_at: '2022-11-16T15:27:30Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/bookings/custom-attribute-definitions/{key} + method: DELETE + auth: true + docs: >- + Deletes a bookings custom attribute definition. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: DeleteBookingCustomAttributeDefinition + request: + name: DeleteCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to delete. + response: + docs: Success + type: root.DeleteBookingCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/bookings/customAttributes.yml b/.mock/definition/bookings/customAttributes.yml new file mode 100644 index 00000000..784d640e --- /dev/null +++ b/.mock/definition/bookings/customAttributes.yml @@ -0,0 +1,534 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + batchDelete: + path: /v2/bookings/custom-attributes/bulk-delete + method: POST + auth: true + docs: >- + Bulk deletes bookings custom attributes. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: BulkDeleteBookingCustomAttributes + request: + name: BulkDeleteBookingCustomAttributesRequest + body: + properties: + values: + type: map + docs: >- + A map containing 1 to 25 individual Delete requests. For each + request, provide an + + arbitrary ID that is unique for this + `BulkDeleteBookingCustomAttributes` request and the + + information needed to delete a custom attribute. + content-type: application/json + response: + docs: Success + type: root.BulkDeleteBookingCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + key: + booking_id: booking_id + key: key + response: + body: + values: + id1: + booking_id: N3NCVYY3WS27HF0HKANA3R9FP8 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + booking_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id3: + booking_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchUpsert: + path: /v2/bookings/custom-attributes/bulk-upsert + method: POST + auth: true + docs: >- + Bulk upserts bookings custom attributes. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: BulkUpsertBookingCustomAttributes + request: + name: BulkUpsertBookingCustomAttributesRequest + body: + properties: + values: + type: map + docs: >- + A map containing 1 to 25 individual upsert requests. For each + request, provide an + + arbitrary ID that is unique for this + `BulkUpsertBookingCustomAttributes` request and the + + information needed to create or update a custom attribute. + content-type: application/json + response: + docs: Success + type: root.BulkUpsertBookingCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + key: + booking_id: booking_id + custom_attribute: {} + response: + body: + values: + id1: + booking_id: N3NCVYY3WS27HF0HKANA3R9FP8 + custom_attribute: + key: favoriteShampoo + value: Spring Fresh + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-16T00:16:23Z' + created_at: '2022-11-16T23:14:47Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + booking_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + custom_attribute: + key: hasShoes + value: false + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-16T00:16:23Z' + created_at: '2022-11-16T00:16:20Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id3: + booking_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + custom_attribute: + key: favoriteShampoo + value: Hydro-Cool + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-16T00:16:23Z' + created_at: '2022-11-16T00:16:20Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id4: + booking_id: N3NCVYY3WS27HF0HKANA3R9FP8 + custom_attribute: + key: partySize + value: 4 + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-16T00:16:23Z' + created_at: '2022-11-16T23:14:47Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id5: + booking_id: 70548QG1HN43B05G0KCZ4MMC1G + custom_attribute: + key: celebrating + value: birthday + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-16T00:16:23Z' + created_at: '2022-11-16T00:16:20Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + list: + path: /v2/bookings/{booking_id}/custom-attributes + method: GET + auth: true + docs: >- + Lists a booking's custom attributes. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attributes + source: + openapi: openapi/openapi.json + display-name: ListBookingCustomAttributes + request: + name: ListCustomAttributesRequest + path-parameters: + booking_id: + type: string + docs: The ID of the target [booking](entity:Booking). + query-parameters: + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. For more + + information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + with_definitions: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of each + + custom attribute. Set this parameter to `true` to get the name and + description of each custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + response: + docs: Success + type: root.ListBookingCustomAttributesResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + response: + body: + custom_attributes: + - key: favoriteShampoo + value: Hydro-Cool + version: 1 + visibility: VISIBILITY_READ_ONLY + updated_at: '2022-11-16T15:50:27Z' + created_at: '2022-11-16T15:50:27Z' + - key: hasShoes + value: false + version: 1 + visibility: VISIBILITY_HIDDEN + updated_at: '2022-11-16T15:51:53Z' + created_at: '2022-11-16T15:51:53Z' + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/bookings/{booking_id}/custom-attributes/{key} + method: GET + auth: true + docs: >- + Retrieves a bookings custom attribute. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_READ` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + source: + openapi: openapi/openapi.json + display-name: RetrieveBookingCustomAttribute + request: + name: GetCustomAttributesRequest + path-parameters: + booking_id: + type: string + docs: The ID of the target [booking](entity:Booking). + key: + type: string + docs: >- + The key of the custom attribute to retrieve. This key must match + the `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + query-parameters: + with_definition: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of + + the custom attribute. Set this parameter to `true` to get the name + and description of the custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + version: + type: optional> + docs: >- + The current version of the custom attribute, which is used for + strongly consistent reads to + + guarantee that you receive the most up-to-date data. When included + in the request, Square + + returns the specified version or a higher version if one exists. + If the specified version is + + higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.RetrieveBookingCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + key: key + response: + body: + custom_attribute: + key: favoriteShampoo + value: Dune + version: 1 + visibility: VISIBILITY_READ_ONLY + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2022-11-16T15:50:27Z' + created_at: '2022-11-16T15:50:27Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + upsert: + path: /v2/bookings/{booking_id}/custom-attributes/{key} + method: PUT + auth: true + docs: >- + Upserts a bookings custom attribute. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: UpsertBookingCustomAttribute + request: + name: UpsertBookingCustomAttributeRequest + path-parameters: + booking_id: + type: string + docs: The ID of the target [booking](entity:Booking). + key: + type: string + docs: >- + The key of the custom attribute to create or update. This key must + match the `key` of a + + custom attribute definition in the Square seller account. If the + requesting application is not + + the definition owner, you must use the qualified key. + body: + properties: + custom_attribute: + type: root.CustomAttribute + docs: >- + The custom attribute to create or update, with the following + fields: + + + - `value`. This value must conform to the `schema` specified by + the definition. + + For more information, see [Value data + types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control for an update operation, include this optional field and + specify the current version + + of the custom attribute. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpsertBookingCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + key: key + request: + custom_attribute: {} + response: + body: + custom_attribute: + key: favoriteShampoo + value: Spring Fresh + version: 1 + visibility: VISIBILITY_READ_ONLY + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2022-11-16T15:50:27Z' + created_at: '2022-11-16T15:50:27Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/bookings/{booking_id}/custom-attributes/{key} + method: DELETE + auth: true + docs: >- + Deletes a bookings custom attribute. + + + To call this endpoint with buyer-level permissions, set + `APPOINTMENTS_WRITE` for the OAuth scope. + + To call this endpoint with seller-level permissions, set + `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + + For calls to this endpoint with seller-level permissions to succeed, the + seller must have subscribed to *Appointments Plus* + + or *Appointments Premium*. + source: + openapi: openapi/openapi.json + display-name: DeleteBookingCustomAttribute + request: + name: DeleteCustomAttributesRequest + path-parameters: + booking_id: + type: string + docs: The ID of the target [booking](entity:Booking). + key: + type: string + docs: >- + The key of the custom attribute to delete. This key must match the + `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + response: + docs: Success + type: root.DeleteBookingCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + booking_id: booking_id + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/bookings/locationProfiles.yml b/.mock/definition/bookings/locationProfiles.yml new file mode 100644 index 00000000..6cb3741f --- /dev/null +++ b/.mock/definition/bookings/locationProfiles.yml @@ -0,0 +1,52 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/bookings/location-booking-profiles + method: GET + auth: true + docs: Lists location booking profiles of a seller. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.location_booking_profiles + source: + openapi: openapi/openapi.json + display-name: ListLocationBookingProfiles + request: + name: ListLocationProfilesRequest + query-parameters: + limit: + type: optional> + docs: The maximum number of results to return in a paged response. + cursor: + type: optional> + docs: >- + The pagination cursor from the preceding response to return the + next page of the results. Do not set this when retrieving the + first page of the results. + response: + docs: Success + type: root.ListLocationBookingProfilesResponse + status-code: 200 + examples: + - response: + body: + location_booking_profiles: + - location_id: LY6WNBPVM6VGV + booking_site_url: https://squareup.com/book/LY6WNBPVM6VGV/testbusiness + online_booking_enabled: true + - location_id: PYTRNBPVMJUPV + booking_site_url: booking_site_url + online_booking_enabled: false + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/bookings/teamMemberProfiles.yml b/.mock/definition/bookings/teamMemberProfiles.yml new file mode 100644 index 00000000..430a3806 --- /dev/null +++ b/.mock/definition/bookings/teamMemberProfiles.yml @@ -0,0 +1,101 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/bookings/team-member-booking-profiles + method: GET + auth: true + docs: Lists booking profiles for team members. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.team_member_booking_profiles + source: + openapi: openapi/openapi.json + display-name: ListTeamMemberBookingProfiles + request: + name: ListTeamMemberProfilesRequest + query-parameters: + bookable_only: + type: optional> + default: false + docs: >- + Indicates whether to include only bookable team members in the + returned result (`true`) or not (`false`). + limit: + type: optional> + docs: The maximum number of results to return in a paged response. + cursor: + type: optional> + docs: >- + The pagination cursor from the preceding response to return the + next page of the results. Do not set this when retrieving the + first page of the results. + location_id: + type: optional> + docs: >- + Indicates whether to include only team members enabled at the + given location in the returned result. + response: + docs: Success + type: root.ListTeamMemberBookingProfilesResponse + status-code: 200 + examples: + - response: + body: + team_member_booking_profiles: + - team_member_id: TMXUrsBWWcHTt79t + description: description + display_name: Sandbox Seller + is_bookable: true + profile_image_url: profile_image_url + - team_member_id: TMaJcbiRqPIGZuS9 + description: description + display_name: Sandbox Staff + is_bookable: true + profile_image_url: profile_image_url + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/bookings/team-member-booking-profiles/{team_member_id} + method: GET + auth: true + docs: Retrieves a team member's booking profile. + source: + openapi: openapi/openapi.json + display-name: RetrieveTeamMemberBookingProfile + request: + name: GetTeamMemberProfilesRequest + path-parameters: + team_member_id: + type: string + docs: The ID of the team member to retrieve. + response: + docs: Success + type: root.GetTeamMemberBookingProfileResponse + status-code: 200 + examples: + - path-parameters: + team_member_id: team_member_id + response: + body: + team_member_booking_profile: + team_member_id: TMaJcbiRqPIGZuS9 + description: description + display_name: Sandbox Staff + is_bookable: true + profile_image_url: profile_image_url + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/cards.yml b/.mock/definition/cards.yml new file mode 100644 index 00000000..ec98df09 --- /dev/null +++ b/.mock/definition/cards.yml @@ -0,0 +1,347 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/cards + method: GET + auth: true + docs: |- + Retrieves a list of cards owned by the account making the request. + A max of 25 cards will be returned. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.cards + source: + openapi: openapi/openapi.json + display-name: ListCards + request: + name: ListCardsRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for your original + query. + + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + customer_id: + type: optional> + docs: |- + Limit results to cards associated with the customer supplied. + By default, all cards owned by the merchant are returned. + include_disabled: + type: optional> + default: false + docs: |- + Includes disabled cards. + By default, all enabled cards owned by the merchant are returned. + reference_id: + type: optional> + docs: Limit results to cards associated with the reference_id supplied. + sort_order: + type: optional> + docs: >- + Sorts the returned list by when the card was created with the + specified order. + + This field defaults to ASC. + response: + docs: Success + type: root.ListCardsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cards: + - id: ccof:uIbfJXhXETSP197M3GB + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + cardholder_name: Amelia Earhart + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + fingerprint: >- + ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q + customer_id: VDKXEEKPJN48QDG3BGGFAK05P8 + merchant_id: 6SSW7HV8K2ST5 + reference_id: user-id-1 + enabled: true + card_type: CREDIT + prepaid_type: NOT_PREPAID + bin: '411111' + version: 1 + card_co_brand: UNKNOWN + issuer_alert: ISSUER_ALERT_CARD_CLOSED + issuer_alert_at: issuer_alert_at + hsa_fsa: false + cursor: cursor + create: + path: /v2/cards + method: POST + auth: true + docs: Adds a card on file to an existing merchant. + source: + openapi: openapi/openapi.json + display-name: CreateCard + request: + name: CreateCardRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this CreateCard request. Keys + can be + + any valid string and must be unique for every request. + + + Max: 45 characters + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + source_id: + type: string + docs: >- + The ID of the source which represents the card information to be + stored. This can be a card nonce or a payment id. + validation: + minLength: 1 + maxLength: 16384 + verification_token: + type: optional + docs: >- + An identifying token generated by + [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + + Verification tokens encapsulate customer device information and + 3-D Secure + + challenge results to indicate that Square has verified the buyer + identity. + + + See the [SCA + Overview](https://developer.squareup.com/docs/sca-overview). + card: + type: root.Card + docs: Payment details associated with the card to be stored. + content-type: application/json + response: + docs: Success + type: root.CreateCardResponse + status-code: 200 + examples: + - request: + idempotency_key: 4935a656-a929-4792-b97c-8848be85c27c + source_id: cnon:uIbfJXhXETSP197M3GB + card: + cardholder_name: Amelia Earhart + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + customer_id: VDKXEEKPJN48QDG3BGGFAK05P8 + reference_id: user-id-1 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + card: + id: ccof:uIbfJXhXETSP197M3GB + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + cardholder_name: Amelia Earhart + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + fingerprint: >- + ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q + customer_id: VDKXEEKPJN48QDG3BGGFAK05P8 + merchant_id: 6SSW7HV8K2ST5 + reference_id: user-id-1 + enabled: true + card_type: CREDIT + prepaid_type: NOT_PREPAID + bin: '411111' + version: 1 + card_co_brand: UNKNOWN + issuer_alert: ISSUER_ALERT_CARD_CLOSED + issuer_alert_at: issuer_alert_at + hsa_fsa: false + get: + path: /v2/cards/{card_id} + method: GET + auth: true + docs: Retrieves details for a specific Card. + source: + openapi: openapi/openapi.json + display-name: RetrieveCard + request: + name: GetCardsRequest + path-parameters: + card_id: + type: string + docs: Unique ID for the desired Card. + response: + docs: Success + type: root.GetCardResponse + status-code: 200 + examples: + - path-parameters: + card_id: card_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + card: + id: ccof:uIbfJXhXETSP197M3GB + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + cardholder_name: Amelia Earhart + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + fingerprint: >- + ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q + customer_id: VDKXEEKPJN48QDG3BGGFAK05P8 + merchant_id: 6SSW7HV8K2ST5 + reference_id: user-id-1 + enabled: true + card_type: CREDIT + prepaid_type: NOT_PREPAID + bin: '411111' + version: 1 + card_co_brand: UNKNOWN + issuer_alert: ISSUER_ALERT_CARD_CLOSED + issuer_alert_at: issuer_alert_at + hsa_fsa: false + disable: + path: /v2/cards/{card_id}/disable + method: POST + auth: true + docs: |- + Disables the card, preventing any further updates or charges. + Disabling an already disabled card is allowed but has no effect. + source: + openapi: openapi/openapi.json + display-name: DisableCard + request: + name: DisableCardsRequest + path-parameters: + card_id: + type: string + docs: Unique ID for the desired Card. + response: + docs: Success + type: root.DisableCardResponse + status-code: 200 + examples: + - path-parameters: + card_id: card_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + card: + id: ccof:uIbfJXhXETSP197M3GB + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + cardholder_name: Amelia Earhart + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + fingerprint: >- + ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q + customer_id: VDKXEEKPJN48QDG3BGGFAK05P8 + merchant_id: 6SSW7HV8K2ST5 + reference_id: user-id-1 + enabled: false + card_type: CREDIT + prepaid_type: NOT_PREPAID + bin: '411111' + version: 2 + card_co_brand: UNKNOWN + issuer_alert: ISSUER_ALERT_CARD_CLOSED + issuer_alert_at: issuer_alert_at + hsa_fsa: false + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/cashDrawers/shifts.yml b/.mock/definition/cashDrawers/shifts.yml new file mode 100644 index 00000000..a692d098 --- /dev/null +++ b/.mock/definition/cashDrawers/shifts.yml @@ -0,0 +1,258 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/cash-drawers/shifts + method: GET + auth: true + docs: |- + Provides the details for all of the cash drawer shifts for a location + in a date range. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.cash_drawer_shifts + source: + openapi: openapi/openapi.json + display-name: ListCashDrawerShifts + request: + name: ListShiftsRequest + query-parameters: + location_id: + type: string + docs: The ID of the location to query for a list of cash drawer shifts. + sort_order: + type: optional> + docs: |- + The order in which cash drawer shifts are listed in the response, + based on their opened_at field. Default value: ASC + begin_time: + type: optional> + docs: >- + The inclusive start time of the query on opened_at, in ISO 8601 + format. + end_time: + type: optional> + docs: >- + The exclusive end date of the query on opened_at, in ISO 8601 + format. + limit: + type: optional> + docs: |- + Number of cash drawer shift events in a page of results (200 by + default, 1000 max). + cursor: + type: optional> + docs: Opaque cursor for fetching the next page of results. + response: + docs: Success + type: root.ListCashDrawerShiftsResponse + status-code: 200 + examples: + - query-parameters: + location_id: location_id + response: + body: + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cash_drawer_shifts: + - id: DCC99978-09A6-4926-849F-300BE9C5793A + state: CLOSED + opened_at: '2019-11-22T00:42:54.000Z' + ended_at: '2019-11-22T00:44:49.000Z' + closed_at: '2019-11-22T00:44:49.000Z' + description: Misplaced some change + opened_cash_money: + amount: 10000 + currency: USD + expected_cash_money: + amount: 10000 + currency: USD + closed_cash_money: + amount: 9970 + currency: USD + created_at: created_at + updated_at: updated_at + location_id: location_id + get: + path: /v2/cash-drawers/shifts/{shift_id} + method: GET + auth: true + docs: >- + Provides the summary details for a single cash drawer shift. See + + [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) + for a list of cash drawer shift events. + source: + openapi: openapi/openapi.json + display-name: RetrieveCashDrawerShift + request: + name: GetShiftsRequest + path-parameters: + shift_id: + type: string + docs: The shift ID. + query-parameters: + location_id: + type: string + docs: The ID of the location to retrieve cash drawer shifts from. + response: + docs: Success + type: root.GetCashDrawerShiftResponse + status-code: 200 + examples: + - path-parameters: + shift_id: shift_id + query-parameters: + location_id: location_id + response: + body: + cash_drawer_shift: + id: DCC99978-09A6-4926-849F-300BE9C5793A + state: CLOSED + opened_at: '2019-11-22T00:42:54.000Z' + ended_at: '2019-11-22T00:44:49.000Z' + closed_at: '2019-11-22T00:44:49.000Z' + description: Misplaced some change + opened_cash_money: + amount: 10000 + currency: USD + cash_payment_money: + amount: 100 + currency: USD + cash_refunds_money: + amount: -100 + currency: USD + cash_paid_in_money: + amount: 10000 + currency: USD + cash_paid_out_money: + amount: -10000 + currency: USD + expected_cash_money: + amount: 10000 + currency: USD + closed_cash_money: + amount: 9970 + currency: USD + device: + id: id + name: My iPad + created_at: created_at + updated_at: updated_at + location_id: location_id + team_member_ids: + - team_member_ids + opening_team_member_id: '' + ending_team_member_id: '' + closing_team_member_id: '' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + listEvents: + path: /v2/cash-drawers/shifts/{shift_id}/events + method: GET + auth: true + docs: Provides a paginated list of events for a single cash drawer shift. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.cash_drawer_shift_events + source: + openapi: openapi/openapi.json + display-name: ListCashDrawerShiftEvents + request: + name: ListEventsShiftsRequest + path-parameters: + shift_id: + type: string + docs: The shift ID. + query-parameters: + location_id: + type: string + docs: The ID of the location to list cash drawer shifts for. + limit: + type: optional> + docs: |- + Number of resources to be returned in a page of results (200 by + default, 1000 max). + cursor: + type: optional> + docs: Opaque cursor for fetching the next page of results. + response: + docs: Success + type: root.ListCashDrawerShiftEventsResponse + status-code: 200 + examples: + - path-parameters: + shift_id: shift_id + query-parameters: + location_id: location_id + response: + body: + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cash_drawer_shift_events: + - id: 9F07DB01-D85A-4B77-88C3-D5C64CEB5155 + event_type: CASH_TENDER_PAYMENT + event_money: + amount: 100 + currency: USD + created_at: '2019-11-22T00:43:02.000Z' + description: '' + team_member_id: '' + - id: B2854CEA-A781-49B3-8F31-C64558231F48 + event_type: CASH_TENDER_PAYMENT + event_money: + amount: 250 + currency: USD + created_at: '2019-11-22T00:43:12.000Z' + description: '' + team_member_id: '' + - id: B5FB7F72-95CD-44A3-974D-26C41064D042 + event_type: CASH_TENDER_CANCELLED_PAYMENT + event_money: + amount: 250 + currency: USD + created_at: '2019-11-22T00:43:23.000Z' + description: '' + team_member_id: '' + - id: 0B425480-8504-40B4-A867-37B23543931B + event_type: CASH_TENDER_REFUND + event_money: + amount: 100 + currency: USD + created_at: '2019-11-22T00:43:46.000Z' + description: '' + team_member_id: '' + - id: 8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE + event_type: PAID_IN + event_money: + amount: 10000 + currency: USD + created_at: '2019-11-22T00:44:18.000Z' + description: Transfer from another drawer + team_member_id: '' + - id: D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F + event_type: PAID_OUT + event_money: + amount: 10000 + currency: USD + created_at: '2019-11-22T00:44:29.000Z' + description: Transfer out to another drawer + team_member_id: '' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/catalog.yml b/.mock/definition/catalog.yml new file mode 100644 index 00000000..4807d267 --- /dev/null +++ b/.mock/definition/catalog.yml @@ -0,0 +1,1294 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + batchDelete: + path: /v2/catalog/batch-delete + method: POST + auth: true + docs: >- + Deletes a set of [CatalogItem](entity:CatalogItem)s based on the + + provided list of target IDs and returns a set of successfully deleted + IDs in + + the response. Deletion is a cascading event such that all children of + the + + targeted object are also deleted. For example, deleting a CatalogItem + will + + also delete all of its + [CatalogItemVariation](entity:CatalogItemVariation) + + children. + + + `BatchDeleteCatalogObjects` succeeds even if only a portion of the + targeted + + IDs can be deleted. The response will only include IDs that were + + actually deleted. + + + To ensure consistency, only one delete request is processed at a time + per seller account. + + While one (batch or non-batch) delete request is being processed, other + (batched and non-batched) + + delete requests are rejected with the `429` error code. + source: + openapi: openapi/openapi.json + display-name: BatchDeleteCatalogObjects + request: + name: BatchDeleteCatalogObjectsRequest + body: + properties: + object_ids: + docs: >- + The IDs of the CatalogObjects to be deleted. When an object is + deleted, other objects + + in the graph that depend on that object will be deleted as well + (for example, deleting a + + CatalogItem will delete its CatalogItemVariation. + type: list + content-type: application/json + response: + docs: Success + type: root.BatchDeleteCatalogObjectsResponse + status-code: 200 + examples: + - request: + object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + - AA27W3M2GGTF3H6AVPNB77CK + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + deleted_object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + - AA27W3M2GGTF3H6AVPNB77CK + deleted_at: '2016-11-16T22:25:24.878Z' + batchGet: + path: /v2/catalog/batch-retrieve + method: POST + auth: true + docs: >- + Returns a set of objects based on the provided ID. + + Each [CatalogItem](entity:CatalogItem) returned in the set includes all + of its + + child information including: all of its + + [CatalogItemVariation](entity:CatalogItemVariation) objects, references + to + + its [CatalogModifierList](entity:CatalogModifierList) objects, and the + ids of + + any [CatalogTax](entity:CatalogTax) objects that apply to it. + source: + openapi: openapi/openapi.json + display-name: BatchRetrieveCatalogObjects + request: + name: BatchGetCatalogObjectsRequest + body: + properties: + object_ids: + docs: The IDs of the CatalogObjects to be retrieved. + type: list + include_related_objects: + type: optional> + docs: >- + If `true`, the response will include additional objects that are + related to the + + requested objects. Related objects are defined as any objects + referenced by ID by the results in the `objects` field + + of the response. These objects are put in the `related_objects` + field. Setting this to `true` is + + helpful when the objects are needed for immediate display to a + user. + + This process only goes one level deep. Objects referenced by the + related objects will not be included. For example, + + + if the `objects` field of the response contains a CatalogItem, + its associated + + CatalogCategory objects, CatalogTax objects, CatalogImage + objects and + + CatalogModifierLists will be returned in the `related_objects` + field of the + + response. If the `objects` field of the response contains a + CatalogItemVariation, + + its parent CatalogItem will be returned in the `related_objects` + field of + + the response. + + + Default value: `false` + catalog_version: + type: optional> + docs: >- + The specific version of the catalog objects to be included in + the response. + + This allows you to retrieve historical versions of objects. The + specified version value is matched against + + the [CatalogObject](entity:CatalogObject)s' `version` attribute. + If not included, results will + + be from the current version of the catalog. + include_deleted_objects: + type: optional> + docs: >- + Indicates whether to include (`true`) or not (`false`) in the + response deleted objects, namely, those with the `is_deleted` + attribute set to `true`. + include_category_path_to_root: + type: optional> + docs: >- + Specifies whether or not to include the `path_to_root` list for + each returned category instance. The `path_to_root` list + consists + + of `CategoryPathToRootNode` objects and specifies the path that + starts with the immediate parent category of the returned + category + + and ends with its root category. If the returned category is a + top-level category, the `path_to_root` list is empty and is not + returned + + in the response payload. + content-type: application/json + response: + docs: Success + type: root.BatchGetCatalogObjectsResponse + status-code: 200 + examples: + - request: + object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + - AA27W3M2GGTF3H6AVPNB77CK + include_related_objects: true + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + objects: + - type: ITEM + id: W62UWFY35CWMYGVWK6TWJDNI + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + - type: ITEM + id: AA27W3M2GGTF3H6AVPNB77CK + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Coffee + description: Hot Bean Juice + tax_ids: + - HURXQOOAIC4IZSI2BEXQRYFY + categories: + - type: ITEM + id: BJNQCF2FJ6S6UIDT65ABHLRX + ordinal: 0 + related_objects: + - type: CATEGORY + id: BJNQCF2FJ6S6UIDT65ABHLRX + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + - type: TAX + id: HURXQOOAIC4IZSI2BEXQRYFY + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + tax_data: + name: Sales Tax + calculation_phase: TAX_SUBTOTAL_PHASE + inclusion_type: ADDITIVE + percentage: '5.0' + enabled: true + batchUpsert: + path: /v2/catalog/batch-upsert + method: POST + auth: true + docs: >- + Creates or updates up to 10,000 target objects based on the provided + + list of objects. The target objects are grouped into batches and each + batch is + + inserted/updated in an all-or-nothing manner. If an object within a + batch is + + malformed in some way, or violates a database constraint, the entire + batch + + containing that item will be disregarded. However, other batches in the + same + + request may still succeed. Each batch may contain up to 1,000 objects, + and + + batches will be processed in order as long as the total object count for + the + + request (items, variations, modifier lists, discounts, and taxes) is no + more + + than 10,000. + + + To ensure consistency, only one update request is processed at a time + per seller account. + + While one (batch or non-batch) update request is being processed, other + (batched and non-batched) + + update requests are rejected with the `429` error code. + source: + openapi: openapi/openapi.json + display-name: BatchUpsertCatalogObjects + request: + name: BatchUpsertCatalogObjectsRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A value you specify that uniquely identifies this + + request among all your requests. A common way to create + + a valid idempotency key is to use a Universally unique + + identifier (UUID). + + + If you're unsure whether a particular request was successful, + + you can reattempt it with the same idempotency key without + + worrying about creating duplicate objects. + + + See + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 128 + batches: + docs: >- + A batch of CatalogObjects to be inserted/updated atomically. + + The objects within a batch will be inserted in an all-or-nothing + fashion, i.e., if an error occurs + + attempting to insert or update an object within a batch, the + entire batch will be rejected. However, an error + + in one batch will not affect other batches within the same + request. + + + For each object, its `updated_at` field is ignored and replaced + with a current + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), + and its + + `is_deleted` field must not be set to `true`. + + + To modify an existing object, supply its ID. To create a new + object, use an ID starting + + with `#`. These IDs may be used to create relationships between + an object and attributes of + + other objects that reference it. For example, you can create a + CatalogItem with + + ID `#ABC` and a CatalogItemVariation with its `item_id` + attribute set to + + `#ABC` in order to associate the CatalogItemVariation with its + parent + + CatalogItem. + + + Any `#`-prefixed IDs are valid only within a single atomic + batch, and will be replaced by server-generated IDs. + + + Each batch may contain up to 1,000 objects. The total number of + objects across all batches for a single request + + may not exceed 10,000. If either of these limits is violated, an + error will be returned and no objects will + + be inserted or updated. + type: list + content-type: application/json + response: + docs: Success + type: root.BatchUpsertCatalogObjectsResponse + status-code: 200 + examples: + - request: + idempotency_key: 789ff020-f723-43a9-b4b5-43b5dc1fa3dc + batches: + - objects: + - type: ITEM + id: '#Tea' + present_at_all_locations: true + - type: ITEM + id: '#Coffee' + present_at_all_locations: true + - type: CATEGORY + id: '#Beverages' + present_at_all_locations: true + - type: TAX + id: '#SalesTax' + present_at_all_locations: true + tax_data: + name: Sales Tax + calculation_phase: TAX_SUBTOTAL_PHASE + inclusion_type: ADDITIVE + percentage: '5.0' + applies_to_custom_amounts: true + enabled: true + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + objects: + - type: ITEM + id: 67GA7XA2FWMRYY2VCONTYZJR + updated_at: '2023-11-30T19:24:35.4Z' + version: 1701372275400 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Tea + description: Hot Leaf Juice + is_taxable: true + tax_ids: + - HP5VNYPKZKTNCKZ2Z5NPUH6A + product_type: REGULAR + categories: + - type: ITEM + id: XCS4SCGN4WQYE2VU4U3TKXEH + ordinal: -2251731094208512 + description_html:

Hot Leaf Juice

+ description_plaintext: Hot Leaf Juice + is_archived: false + - type: ITEM + id: MQ4TZKOG3SR2EQI3TWEK4AH7 + updated_at: '2023-11-30T19:24:35.4Z' + version: 1701372275400 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Coffee + description: Hot Bean Juice + is_taxable: true + tax_ids: + - HP5VNYPKZKTNCKZ2Z5NPUH6A + product_type: REGULAR + categories: + - type: ITEM + id: XCS4SCGN4WQYE2VU4U3TKXEH + ordinal: -2251662374731776 + description_html:

Hot Bean Juice

+ description_plaintext: Hot Bean Juice + is_archived: false + - type: CATEGORY + id: XCS4SCGN4WQYE2VU4U3TKXEH + updated_at: '2023-11-30T19:24:35.4Z' + version: 1701372275400 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + - type: TAX + id: HP5VNYPKZKTNCKZ2Z5NPUH6A + updated_at: '2023-11-30T19:24:35.4Z' + version: 1701372275400 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + tax_data: + name: Sales Tax + calculation_phase: TAX_SUBTOTAL_PHASE + inclusion_type: ADDITIVE + percentage: '5.0' + applies_to_custom_amounts: true + enabled: true + updated_at: updated_at + id_mappings: + - client_object_id: '#Tea' + object_id: 67GA7XA2FWMRYY2VCONTYZJR + - client_object_id: '#Coffee' + object_id: MQ4TZKOG3SR2EQI3TWEK4AH7 + - client_object_id: '#Beverages' + object_id: XCS4SCGN4WQYE2VU4U3TKXEH + - client_object_id: '#SalesTax' + object_id: HP5VNYPKZKTNCKZ2Z5NPUH6A + - client_object_id: '#Tea_Mug' + object_id: CAJBHUIQH7ONTSZI2KTVOUP6 + - client_object_id: '#Coffee_Regular' + object_id: GY2GXJTVVPQAPW43GFRR3NG6 + - client_object_id: '#Coffee_Large' + object_id: JE6VHPSRQL6IWSN26C36CJ7W + info: + path: /v2/catalog/info + method: GET + auth: true + docs: |- + Retrieves information about the Square Catalog API, such as batch size + limits that can be used by the `BatchUpsertCatalogObjects` endpoint. + source: + openapi: openapi/openapi.json + display-name: CatalogInfo + response: + docs: Success + type: root.CatalogInfoResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + limits: + batch_upsert_max_objects_per_batch: 1000 + batch_upsert_max_total_objects: 10000 + batch_retrieve_max_object_ids: 1000 + search_max_page_limit: 1000 + batch_delete_max_object_ids: 200 + update_item_taxes_max_item_ids: 1000 + update_item_taxes_max_taxes_to_enable: 1000 + update_item_taxes_max_taxes_to_disable: 1000 + update_item_modifier_lists_max_item_ids: 1000 + update_item_modifier_lists_max_modifier_lists_to_enable: 1000 + update_item_modifier_lists_max_modifier_lists_to_disable: 1000 + standard_unit_description_group: + standard_unit_descriptions: + - {} + language_code: language_code + list: + path: /v2/catalog/list + method: GET + auth: true + docs: >- + Returns a list of all [CatalogObject](entity:CatalogObject)s of the + specified types in the catalog. + + + The `types` parameter is specified as a comma-separated list of the + [CatalogObjectType](entity:CatalogObjectType) values, + + for example, "`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, + `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`". + + + __Important:__ ListCatalog does not return deleted catalog items. To + retrieve + + deleted catalog items, use + [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + + and set the `include_deleted_objects` attribute value to `true`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.objects + source: + openapi: openapi/openapi.json + display-name: ListCatalog + request: + name: ListCatalogRequest + query-parameters: + cursor: + type: optional> + docs: >- + The pagination cursor returned in the previous response. Leave + unset for an initial request. + + The page size is currently set to be 100. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + types: + type: optional> + docs: >- + An optional case-insensitive, comma-separated list of object types + to retrieve. + + + The valid values are defined in the + [CatalogObjectType](entity:CatalogObjectType) enum, for example, + + `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, + + `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. + + + If this is unspecified, the operation returns objects of all the + top level types at the version + + of the Square API used to make the request. Object types that are + nested onto other object types + + are not included in the defaults. + + + At the current API version the default object types are: + + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, + QUICK_AMOUNT_SETTINGS. + catalog_version: + type: optional> + docs: >- + The specific version of the catalog objects to be included in the + response. + + This allows you to retrieve historical versions of objects. The + specified version value is matched against + + the [CatalogObject](entity:CatalogObject)s' `version` attribute. + If not included, results will be from the + + current version of the catalog. + response: + docs: Success + type: root.ListCatalogResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cursor: cursor + objects: + - type: CATEGORY + id: 5ZYQZZ2IECPVJ2IJ5KQPRDC3 + updated_at: '2017-02-21T14:50:26.495Z' + version: 1487688626495 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + - type: TAX + id: L5R47DGBZOOVKCAFIXC56AEN + updated_at: '2017-02-21T14:50:26.495Z' + version: 1487688626495 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + tax_data: + name: Sales Tax + calculation_phase: TAX_SUBTOTAL_PHASE + inclusion_type: ADDITIVE + percentage: '5.0' + enabled: true + search: + path: /v2/catalog/search + method: POST + auth: true + docs: >- + Searches for [CatalogObject](entity:CatalogObject) of any type by + matching supported search attribute values, + + excluding custom attribute values on items or item variations, against + one or more of the specified query filters. + + + This (`SearchCatalogObjects`) endpoint differs from the + [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + + endpoint in the following aspects: + + + - `SearchCatalogItems` can only search for items or item variations, + whereas `SearchCatalogObjects` can search for any type of catalog + objects. + + - `SearchCatalogItems` supports the custom attribute query filters to + return items or item variations that contain custom attribute values, + where `SearchCatalogObjects` does not. + + - `SearchCatalogItems` does not support the `include_deleted_objects` + filter to search for deleted items or item variations, whereas + `SearchCatalogObjects` does. + + - The both endpoints have different call conventions, including the + query filter formats. + source: + openapi: openapi/openapi.json + display-name: SearchCatalogObjects + request: + name: SearchCatalogObjectsRequest + body: + properties: + cursor: + type: optional + docs: >- + The pagination cursor returned in the previous response. Leave + unset for an initial request. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + object_types: + type: optional> + docs: >- + The desired set of object types to appear in the search results. + + + If this is unspecified, the operation returns objects of all the + top level types at the version + + of the Square API used to make the request. Object types that + are nested onto other object types + + are not included in the defaults. + + + At the current API version the default object types are: + + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, + QUICK_AMOUNT_SETTINGS. + + + Note that if you wish for the query to return objects belonging + to nested types (i.e., COMPONENT, IMAGE, + + ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must + explicitly include all the types of interest + + in this field. + include_deleted_objects: + type: optional + docs: >- + If `true`, deleted objects will be included in the results. + Defaults to `false`. Deleted objects will have their + `is_deleted` field set to `true`. If `include_deleted_objects` + is `true`, then the `include_category_path_to_root` request + parameter must be `false`. Both properties cannot be `true` at + the same time. + include_related_objects: + type: optional + docs: >- + If `true`, the response will include additional objects that are + related to the + + requested objects. Related objects are objects that are + referenced by object ID by the objects + + in the response. This is helpful if the objects are being + fetched for immediate display to a user. + + This process only goes one level deep. Objects referenced by the + related objects will not be included. + + For example: + + + If the `objects` field of the response contains a CatalogItem, + its associated + + CatalogCategory objects, CatalogTax objects, CatalogImage + objects and + + CatalogModifierLists will be returned in the `related_objects` + field of the + + response. If the `objects` field of the response contains a + CatalogItemVariation, + + its parent CatalogItem will be returned in the `related_objects` + field of + + the response. + + + Default value: `false` + begin_time: + type: optional + docs: >- + Return objects modified after this + [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), + in RFC 3339 + + format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is + exclusive - objects with a + + timestamp equal to `begin_time` will not be included in the + response. + query: + type: optional + docs: >- + A query to be used to filter or sort the results. If no query is + specified, the entire catalog will be returned. + limit: + type: optional + docs: >- + A limit on the number of results to be returned in a single + page. The limit is advisory - + + the implementation may return more or fewer results. If the + supplied limit is negative, zero, or + + is higher than the maximum limit of 1,000, it will be ignored. + include_category_path_to_root: + type: optional + docs: >- + Specifies whether or not to include the `path_to_root` list for + each returned category instance. The `path_to_root` list + consists of `CategoryPathToRootNode` objects and specifies the + path that starts with the immediate parent category of the + returned category and ends with its root category. If the + returned category is a top-level category, the `path_to_root` + list is empty and is not returned in the response payload. If + `include_category_path_to_root` is `true`, then the + `include_deleted_objects` request parameter must be `false`. + Both properties cannot be `true` at the same time. + content-type: application/json + response: + docs: Success + type: root.SearchCatalogObjectsResponse + status-code: 200 + examples: + - request: + object_types: + - ITEM + query: + prefix_query: + attribute_name: name + attribute_prefix: tea + limit: 100 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cursor: cursor + objects: + - type: ITEM + id: X5DZ5NWWAQ44CKBLKIFQGOWK + updated_at: '2017-10-26T15:41:32.337Z' + version: 1509032492337 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Tea - Black + description: A delicious blend of black tea. + tax_ids: + - ZXITPM6RWHZ7GZ7EIP3YKECM + product_type: REGULAR + categories: + - type: ITEM + id: E7CLE5RZZ744BHWVQQEAHI2C + ordinal: 0 + - type: ITEM + id: NNNEM3LA656Q46NXLWCNI7S5 + updated_at: '2017-10-26T15:41:23.232Z' + version: 1509032483232 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Tea - Green + description: Relaxing green herbal tea. + tax_ids: + - ZXITPM6RWHZ7GZ7EIP3YKECM + product_type: REGULAR + categories: + - type: ITEM + id: E7CLE5RZZ744BHWVQQEAHI2C + ordinal: 0 + related_objects: + - type: ITEM + id: id + updated_at: updated_at + version: 1000000 + is_deleted: true + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + latest_time: latest_time + SearchItems: + path: /v2/catalog/search-catalog-items + method: POST + auth: true + docs: >- + Searches for catalog items or item variations by matching supported + search attribute values, including + + custom attribute values, against one or more of the specified query + filters. + + + This (`SearchCatalogItems`) endpoint differs from the + [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + + endpoint in the following aspects: + + + - `SearchCatalogItems` can only search for items or item variations, + whereas `SearchCatalogObjects` can search for any type of catalog + objects. + + - `SearchCatalogItems` supports the custom attribute query filters to + return items or item variations that contain custom attribute values, + where `SearchCatalogObjects` does not. + + - `SearchCatalogItems` does not support the `include_deleted_objects` + filter to search for deleted items or item variations, whereas + `SearchCatalogObjects` does. + + - The both endpoints use different call conventions, including the query + filter formats. + source: + openapi: openapi/openapi.json + display-name: SearchCatalogItems + request: + name: SearchCatalogItemsRequest + body: + properties: + text_filter: + type: optional + docs: >- + The text filter expression to return items or item variations + containing specified text in + + the `name`, `description`, or `abbreviation` attribute value of + an item, or in + + the `name`, `sku`, or `upc` attribute value of an item + variation. + category_ids: + type: optional> + docs: >- + The category id query expression to return items containing the + specified category IDs. + stock_levels: + type: optional> + docs: >- + The stock-level query expression to return item variations with + the specified stock levels. + + See + [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) + for possible values + enabled_location_ids: + type: optional> + docs: >- + The enabled-location query expression to return items and item + variations having specified enabled locations. + cursor: + type: optional + docs: >- + The pagination token, returned in the previous response, used to + fetch the next batch of pending results. + limit: + type: optional + docs: >- + The maximum number of results to return per page. The default + value is 100. + validation: + max: 100 + sort_order: + type: optional + docs: >- + The order to sort the results by item names. The default sort + order is ascending (`ASC`). + + See [SortOrder](#type-sortorder) for possible values + product_types: + type: optional> + docs: >- + The product types query expression to return items or item + variations having the specified product types. + custom_attribute_filters: + type: optional> + docs: >- + The customer-attribute filter to return items or item variations + matching the specified + + custom attribute expressions. A maximum number of 10 custom + attribute expressions are supported in + + a single call to the + [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint. + archived_state: + type: optional + docs: >- + The query filter to return not archived + (`ARCHIVED_STATE_NOT_ARCHIVED`), archived + (`ARCHIVED_STATE_ARCHIVED`), or either type + (`ARCHIVED_STATE_ALL`) of items. + content-type: application/json + response: + docs: Success + type: root.SearchCatalogItemsResponse + status-code: 200 + examples: + - request: + text_filter: red + category_ids: + - WINE_CATEGORY_ID + stock_levels: + - OUT + - LOW + enabled_location_ids: + - ATL_LOCATION_ID + limit: 100 + sort_order: ASC + product_types: + - REGULAR + custom_attribute_filters: + - custom_attribute_definition_id: VEGAN_DEFINITION_ID + bool_filter: true + - custom_attribute_definition_id: BRAND_DEFINITION_ID + string_filter: Dark Horse + - key: VINTAGE + number_filter: + min: min + max: max + - custom_attribute_definition_id: VARIETAL_DEFINITION_ID + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + items: + - type: ITEM + id: GPOKJPTV2KDLVKCADJ7I77EZ + updated_at: '2020-06-18T17:55:56.646Z' + version: 1592502956646 + is_deleted: false + custom_attribute_values: + BRAND: + name: Brand + string_value: Dark Horse + custom_attribute_definition_id: BRAND_DEFINITION_ID + type: STRING + key: BRAND + VARIETAL: + name: Varietal + custom_attribute_definition_id: VARIETAL_DEFINITION_ID + type: SELECTION + selection_uid_values: + - MERLOT_SELECTION_ID + - selection_uid_values + key: VARIETAL + VINTAGE: + name: Vintage + custom_attribute_definition_id: EI7IJQDUKYSHULREPIPH6HNU + type: NUMBER + number_value: number_value + key: VINTAGE + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Dark Horse Merlot 2018 + description: A nice red wine + product_type: REGULAR + is_archived: false + cursor: cursor + matched_variation_ids: + - VBJNPHCOKDFECR6VU25WRJUD + UpdateItemModifierLists: + path: /v2/catalog/update-item-modifier-lists + method: POST + auth: true + docs: >- + Updates the [CatalogModifierList](entity:CatalogModifierList) objects + + that apply to the targeted [CatalogItem](entity:CatalogItem) without + having + + to perform an upsert on the entire item. + source: + openapi: openapi/openapi.json + display-name: UpdateItemModifierLists + request: + name: UpdateItemModifierListsRequest + body: + properties: + item_ids: + docs: >- + The IDs of the catalog items associated with the + CatalogModifierList objects being updated. + type: list + modifier_lists_to_enable: + type: optional>> + docs: >- + The IDs of the CatalogModifierList objects to enable for the + CatalogItem. + + At least one of `modifier_lists_to_enable` or + `modifier_lists_to_disable` must be specified. + modifier_lists_to_disable: + type: optional>> + docs: >- + The IDs of the CatalogModifierList objects to disable for the + CatalogItem. + + At least one of `modifier_lists_to_enable` or + `modifier_lists_to_disable` must be specified. + content-type: application/json + response: + docs: Success + type: root.UpdateItemModifierListsResponse + status-code: 200 + examples: + - request: + item_ids: + - H42BRLUJ5KTZTTMPVSLFAACQ + - 2JXOBJIHCWBQ4NZ3RIXQGJA6 + modifier_lists_to_enable: + - H42BRLUJ5KTZTTMPVSLFAACQ + - 2JXOBJIHCWBQ4NZ3RIXQGJA6 + modifier_lists_to_disable: + - 7WRC16CJZDVLSNDQ35PP6YAD + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + updated_at: '2016-11-16T22:25:24.878Z' + UpdateItemTaxes: + path: /v2/catalog/update-item-taxes + method: POST + auth: true + docs: |- + Updates the [CatalogTax](entity:CatalogTax) objects that apply to the + targeted [CatalogItem](entity:CatalogItem) without having to perform an + upsert on the entire item. + source: + openapi: openapi/openapi.json + display-name: UpdateItemTaxes + request: + name: UpdateItemTaxesRequest + body: + properties: + item_ids: + docs: >- + IDs for the CatalogItems associated with the CatalogTax objects + being updated. + + No more than 1,000 IDs may be provided. + type: list + taxes_to_enable: + type: optional>> + docs: >- + IDs of the CatalogTax objects to enable. + + At least one of `taxes_to_enable` or `taxes_to_disable` must be + specified. + taxes_to_disable: + type: optional>> + docs: >- + IDs of the CatalogTax objects to disable. + + At least one of `taxes_to_enable` or `taxes_to_disable` must be + specified. + content-type: application/json + response: + docs: Success + type: root.UpdateItemTaxesResponse + status-code: 200 + examples: + - request: + item_ids: + - H42BRLUJ5KTZTTMPVSLFAACQ + - 2JXOBJIHCWBQ4NZ3RIXQGJA6 + taxes_to_enable: + - 4WRCNHCJZDVLSNDQ35PP6YAD + taxes_to_disable: + - AQCEGCEBBQONINDOHRGZISEX + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + updated_at: '2016-11-16T22:25:24.878Z' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/catalog/images.yml b/.mock/definition/catalog/images.yml new file mode 100644 index 00000000..35626e67 --- /dev/null +++ b/.mock/definition/catalog/images.yml @@ -0,0 +1,144 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/catalog/images + method: POST + auth: true + docs: >- + Uploads an image file to be represented by a + [CatalogImage](entity:CatalogImage) object that can be linked to an + existing + + [CatalogObject](entity:CatalogObject) instance. The resulting + `CatalogImage` is unattached to any `CatalogObject` if the `object_id` + + is not specified. + + + This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data + requests with a JSON part and an image file part in + + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + source: + openapi: openapi/openapi.json + display-name: CreateCatalogImage + request: + name: CreateImagesRequest + body: + properties: + request: + type: optional + content-type: application/json; charset=utf-8 + image_file: + type: optional + content-type: image/jpeg + content-type: multipart/form-data + response: + docs: Success + type: root.CreateCatalogImageResponse + status-code: 200 + examples: + - request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + image: + type: IMAGE + id: KQLFFHA6K6J3YQAQAWDQAL57 + updated_at: updated_at + version: 1000000 + is_deleted: true + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + image_data: + name: name + url: https://... + caption: A picture of a cup of coffee + photo_studio_order_id: photo_studio_order_id + update: + path: /v2/catalog/images/{image_id} + method: PUT + auth: true + docs: >- + Uploads a new image file to replace the existing one in the specified + [CatalogImage](entity:CatalogImage) object. + + + This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data + requests with a JSON part and an image file part in + + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + source: + openapi: openapi/openapi.json + display-name: UpdateCatalogImage + request: + name: UpdateImagesRequest + path-parameters: + image_id: + type: string + docs: >- + The ID of the `CatalogImage` object to update the encapsulated + image file. + body: + properties: + request: + type: optional + content-type: application/json; charset=utf-8 + image_file: + type: optional + content-type: image/jpeg + content-type: multipart/form-data + response: + docs: Success + type: root.UpdateCatalogImageResponse + status-code: 200 + examples: + - path-parameters: + image_id: image_id + request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + image: + type: IMAGE + id: L52QOQN2SW3M5QTF9JOCQKNB + updated_at: updated_at + version: 1000000 + is_deleted: true + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + image_data: + name: Coffee + url: https://... + caption: A picture of a cup of coffee + photo_studio_order_id: photo_studio_order_id + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/catalog/object.yml b/.mock/definition/catalog/object.yml new file mode 100644 index 00000000..9f508687 --- /dev/null +++ b/.mock/definition/catalog/object.yml @@ -0,0 +1,362 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + upsert: + path: /v2/catalog/object + method: POST + auth: true + docs: >- + Creates a new or updates the specified + [CatalogObject](entity:CatalogObject). + + + To ensure consistency, only one update request is processed at a time + per seller account. + + While one (batch or non-batch) update request is being processed, other + (batched and non-batched) + + update requests are rejected with the `429` error code. + source: + openapi: openapi/openapi.json + display-name: UpsertCatalogObject + request: + name: UpsertCatalogObjectRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A value you specify that uniquely identifies this + + request among all your requests. A common way to create + + a valid idempotency key is to use a Universally unique + + identifier (UUID). + + + If you're unsure whether a particular request was successful, + + you can reattempt it with the same idempotency key without + + worrying about creating duplicate objects. + + + See + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 128 + object: + type: root.CatalogObject + docs: >- + A CatalogObject to be created or updated. + + + - For updates, the object must be active (the `is_deleted` field + is not `true`). + + - For creates, the object ID must start with `#`. The provided + ID is replaced with a server-generated ID. + content-type: application/json + response: + docs: Success + type: root.UpsertCatalogObjectResponse + status-code: 200 + examples: + - request: + idempotency_key: af3d1afc-7212-4300-b463-0bfc5314a5ae + object: + type: ITEM + id: '#Cocoa' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + catalog_object: + type: ITEM + id: R2TA2FOBUGCJZNIWJSOSNAI4 + updated_at: '2021-06-14T15:51:39.021Z' + version: 1623685899021 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + item_data: + name: Cocoa + description: Hot Chocolate + abbreviation: Ch + label_color: label_color + is_taxable: true + category_id: category_id + tax_ids: + - tax_ids + modifier_list_info: + - modifier_list_id: modifier_list_id + product_type: REGULAR + skip_modifier_screen: true + item_options: + - {} + ecom_uri: ecom_uri + ecom_image_uris: + - ecom_image_uris + image_ids: + - image_ids + sort_name: sort_name + description_html:

Hot Chocolate

+ description_plaintext: Hot Chocolate + channels: + - channels + is_archived: true + is_alcoholic: true + id_mappings: + - client_object_id: '#Cocoa' + object_id: R2TA2FOBUGCJZNIWJSOSNAI4 + - client_object_id: '#Small' + object_id: QRT53UP4LITLWGOGBZCUWP63 + - client_object_id: '#Large' + object_id: NS77DKEIQ3AEQTCP727DSA7U + get: + path: /v2/catalog/object/{object_id} + method: GET + auth: true + docs: >- + Returns a single [CatalogItem](entity:CatalogItem) as a + + [CatalogObject](entity:CatalogObject) based on the provided ID. The + returned + + object includes all of the relevant [CatalogItem](entity:CatalogItem) + + information including: + [CatalogItemVariation](entity:CatalogItemVariation) + + children, references to its + + [CatalogModifierList](entity:CatalogModifierList) objects, and the ids + of + + any [CatalogTax](entity:CatalogTax) objects that apply to it. + source: + openapi: openapi/openapi.json + display-name: RetrieveCatalogObject + request: + name: GetObjectRequest + path-parameters: + object_id: + type: string + docs: The object ID of any type of catalog objects to be retrieved. + query-parameters: + include_related_objects: + type: optional> + default: false + docs: >- + If `true`, the response will include additional objects that are + related to the + + requested objects. Related objects are defined as any objects + referenced by ID by the results in the `objects` field + + of the response. These objects are put in the `related_objects` + field. Setting this to `true` is + + helpful when the objects are needed for immediate display to a + user. + + This process only goes one level deep. Objects referenced by the + related objects will not be included. For example, + + + if the `objects` field of the response contains a CatalogItem, its + associated + + CatalogCategory objects, CatalogTax objects, CatalogImage objects + and + + CatalogModifierLists will be returned in the `related_objects` + field of the + + response. If the `objects` field of the response contains a + CatalogItemVariation, + + its parent CatalogItem will be returned in the `related_objects` + field of + + the response. + + + Default value: `false` + catalog_version: + type: optional> + docs: >- + Requests objects as of a specific version of the catalog. This + allows you to retrieve historical + + versions of objects. The value to retrieve a specific version of + an object can be found + + in the version field of [CatalogObject](entity:CatalogObject)s. If + not included, results will + + be from the current version of the catalog. + include_category_path_to_root: + type: optional> + default: false + docs: >- + Specifies whether or not to include the `path_to_root` list for + each returned category instance. The `path_to_root` list consists + + of `CategoryPathToRootNode` objects and specifies the path that + starts with the immediate parent category of the returned category + + and ends with its root category. If the returned category is a + top-level category, the `path_to_root` list is empty and is not + returned + + in the response payload. + response: + docs: Success + type: root.GetCatalogObjectResponse + status-code: 200 + examples: + - path-parameters: + object_id: object_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + object: + type: ITEM + id: W62UWFY35CWMYGVWK6TWJDNI + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + related_objects: + - type: CATEGORY + id: BJNQCF2FJ6S6UIDT65ABHLRX + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + - type: TAX + id: HURXQOOAIC4IZSI2BEXQRYFY + updated_at: '2016-11-16T22:25:24.878Z' + version: 1479335124878 + is_deleted: false + custom_attribute_values: + key: {} + catalog_v1_ids: + - {} + present_at_all_locations: true + present_at_location_ids: + - present_at_location_ids + absent_at_location_ids: + - absent_at_location_ids + image_id: image_id + tax_data: + name: Sales Tax + calculation_phase: TAX_SUBTOTAL_PHASE + inclusion_type: ADDITIVE + percentage: '5.0' + enabled: true + delete: + path: /v2/catalog/object/{object_id} + method: DELETE + auth: true + docs: >- + Deletes a single [CatalogObject](entity:CatalogObject) based on the + + provided ID and returns the set of successfully deleted IDs in the + response. + + Deletion is a cascading event such that all children of the targeted + object + + are also deleted. For example, deleting a + [CatalogItem](entity:CatalogItem) + + will also delete all of its + + [CatalogItemVariation](entity:CatalogItemVariation) children. + + + To ensure consistency, only one delete request is processed at a time + per seller account. + + While one (batch or non-batch) delete request is being processed, other + (batched and non-batched) + + delete requests are rejected with the `429` error code. + source: + openapi: openapi/openapi.json + display-name: DeleteCatalogObject + request: + name: DeleteObjectRequest + path-parameters: + object_id: + type: string + docs: >- + The ID of the catalog object to be deleted. When an object is + deleted, other + + objects in the graph that depend on that object will be deleted as + well (for example, deleting a + + catalog item will delete its catalog item variations). + response: + docs: Success + type: root.DeleteCatalogObjectResponse + status-code: 200 + examples: + - path-parameters: + object_id: object_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + deleted_object_ids: + - 7SB3ZQYJ5GDMVFL7JK46JCHT + - KQLFFHA6K6J3YQAQAWDQAL57 + deleted_at: '2016-11-16T22:25:24.878Z' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/checkout.yml b/.mock/definition/checkout.yml new file mode 100644 index 00000000..4bff83e2 --- /dev/null +++ b/.mock/definition/checkout.yml @@ -0,0 +1,221 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + RetrieveLocationSettings: + path: /v2/online-checkout/location-settings/{location_id} + method: GET + auth: true + docs: Retrieves the location-level settings for a Square-hosted checkout page. + source: + openapi: openapi/openapi.json + display-name: RetrieveLocationSettings + request: + name: RetrieveLocationSettingsRequest + path-parameters: + location_id: + type: string + docs: The ID of the location for which to retrieve settings. + response: + docs: Success + type: root.RetrieveLocationSettingsResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + location_settings: + location_id: LOCATION_ID_1 + customer_notes_enabled: true + policies: + - uid: POLICY_ID_1 + title: Return Policy + description: This is my Return Policy + branding: + header_type: FRAMED_LOGO + button_color: '#ffffff' + button_shape: ROUNDED + tipping: + percentages: + - 10 + - 15 + - 20 + smart_tipping_enabled: true + default_percent: 15 + smart_tips: + - {} + coupons: + enabled: true + updated_at: '2022-06-16T22:25:35Z' + UpdateLocationSettings: + path: /v2/online-checkout/location-settings/{location_id} + method: PUT + auth: true + docs: Updates the location-level settings for a Square-hosted checkout page. + source: + openapi: openapi/openapi.json + display-name: UpdateLocationSettings + request: + name: UpdateLocationSettingsRequest + path-parameters: + location_id: + type: string + docs: The ID of the location for which to retrieve settings. + body: + properties: + location_settings: + type: root.CheckoutLocationSettings + docs: >- + Describe your updates using the `location_settings` object. Make + sure it contains only the fields that have changed. + content-type: application/json + response: + docs: Success + type: root.UpdateLocationSettingsResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + request: + location_settings: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + location_settings: + location_id: LOCATION_ID_1 + customer_notes_enabled: false + policies: + - uid: POLICY_ID_1 + title: Return Policy + description: This is my Return Policy + - uid: POLICY_ID_2 + title: Return Policy + description: Items may be returned within 30 days of purchase. + branding: + header_type: FRAMED_LOGO + button_color: '#00b23b' + button_shape: ROUNDED + tipping: + percentages: + - 15 + - 20 + - 25 + smart_tipping_enabled: true + default_percent: 20 + smart_tips: + - {} + coupons: + enabled: true + updated_at: '2022-06-16T22:25:35Z' + RetrieveMerchantSettings: + path: /v2/online-checkout/merchant-settings + method: GET + auth: true + docs: Retrieves the merchant-level settings for a Square-hosted checkout page. + source: + openapi: openapi/openapi.json + display-name: RetrieveMerchantSettings + response: + docs: Success + type: root.RetrieveMerchantSettingsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + merchant_settings: + payment_methods: + apple_pay: + enabled: true + google_pay: + enabled: true + afterpay_clearpay: + order_eligibility_range: + min: + amount: 100 + currency: USD + max: + amount: 10000 + currency: USD + item_eligibility_range: + min: + amount: 100 + currency: USD + max: + amount: 10000 + currency: USD + enabled: true + updated_at: '2022-06-16T22:25:35Z' + UpdateMerchantSettings: + path: /v2/online-checkout/merchant-settings + method: PUT + auth: true + docs: Updates the merchant-level settings for a Square-hosted checkout page. + source: + openapi: openapi/openapi.json + display-name: UpdateMerchantSettings + request: + name: UpdateMerchantSettingsRequest + body: + properties: + merchant_settings: + type: root.CheckoutMerchantSettings + docs: >- + Describe your updates using the `merchant_settings` object. Make + sure it contains only the fields that have changed. + content-type: application/json + response: + docs: Success + type: root.UpdateMerchantSettingsResponse + status-code: 200 + examples: + - request: + merchant_settings: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + merchant_settings: + payment_methods: + apple_pay: + enabled: false + google_pay: + enabled: true + afterpay_clearpay: + order_eligibility_range: + min: + amount: 100 + currency: USD + max: + amount: 10000 + currency: USD + item_eligibility_range: + min: + amount: 100 + currency: USD + max: + amount: 10000 + currency: USD + enabled: true + updated_at: '2022-06-16T22:25:35Z' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/checkout/paymentLinks.yml b/.mock/definition/checkout/paymentLinks.yml new file mode 100644 index 00000000..6d1431a1 --- /dev/null +++ b/.mock/definition/checkout/paymentLinks.yml @@ -0,0 +1,438 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/online-checkout/payment-links + method: GET + auth: true + docs: Lists all payment links. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.payment_links + source: + openapi: openapi/openapi.json + display-name: ListPaymentLinks + request: + name: ListPaymentLinksRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + If a cursor is not provided, the endpoint returns the first page + of the results. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: >- + A limit on the number of results to return per page. The limit is + advisory and + + the implementation might return more or less results. If the + supplied limit is negative, zero, or + + greater than the maximum limit of 1000, it is ignored. + + + Default value: `100` + response: + docs: Success + type: root.ListPaymentLinksResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment_links: + - id: TN4BWEDJ9AI5MBIV + version: 2 + description: description + order_id: Qqc6yppGvxVwc46Cch4zHTaJqc4F + checkout_options: + ask_for_shipping_address: true + url: https://square.link/u/EXAMPLE + long_url: long_url + created_at: '2022-04-26T00:15:15Z' + updated_at: '2022-04-26T00:18:24Z' + payment_note: test + - id: RY5UNCUMPJN5XKCT + version: 1 + description: '' + order_id: EmBmGt3zJD15QeO1dxzBTxMxtwfZY + url: https://square.link/u/EXAMPLE + long_url: long_url + created_at: '2022-04-11T23:14:59Z' + updated_at: updated_at + payment_note: payment_note + cursor: MTY1NQ== + create: + path: /v2/online-checkout/payment-links + method: POST + auth: true + docs: >- + Creates a Square-hosted checkout page. Applications can share the + resulting payment link with their buyer to pay for goods and services. + source: + openapi: openapi/openapi.json + display-name: CreatePaymentLink + request: + name: CreatePaymentLinkRequest + body: + properties: + idempotency_key: + type: optional + docs: >- + A unique string that identifies this `CreatePaymentLinkRequest` + request. + + If you do not provide a unique string (or provide an empty + string as the value), + + the endpoint treats each request as independent. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + maxLength: 192 + description: + type: optional + docs: >- + A description of the payment link. You provide this optional + description that is useful in your + + application context. It is not used anywhere. + validation: + maxLength: 4096 + quick_pay: + type: optional + docs: >- + Describes an ad hoc item and price for which to generate a quick + pay checkout link. + + For more information, + + see [Quick Pay + Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + order: + type: optional + docs: >- + Describes the `Order` for which to create a checkout link. + + For more information, + + see [Square Order + Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). + checkout_options: + type: optional + docs: >- + Describes optional fields to add to the resulting checkout page. + + For more information, + + see [Optional Checkout + Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + pre_populated_data: + type: optional + docs: >- + Describes fields to prepopulate in the resulting checkout page. + + For more information, see [Prepopulate the shipping + address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address). + payment_note: + type: optional + docs: >- + A note for the payment. After processing the payment, Square + adds this note to the resulting `Payment`. + validation: + maxLength: 500 + content-type: application/json + response: + docs: Success + type: root.CreatePaymentLinkResponse + status-code: 200 + examples: + - request: + idempotency_key: cd9e25dc-d9f2-4430-aedb-61605070e95f + quick_pay: + name: Auto Detailing + price_money: + amount: 10000 + currency: USD + location_id: A9Y43N9ABXZBP + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment_link: + id: PKVT6XGJZXYUP3NZ + version: 1 + description: description + order_id: o4b7saqp4HzhNttf5AJxC0Srjd4F + checkout_options: + allow_tipping: true + custom_fields: + - title: title + subscription_plan_id: subscription_plan_id + redirect_url: redirect_url + merchant_support_email: merchant_support_email + ask_for_shipping_address: true + shipping_fee: + charge: {} + enable_coupon: true + enable_loyalty: true + pre_populated_data: + buyer_email: buyer_email + buyer_phone_number: buyer_phone_number + url: https://square.link/u/EXAMPLE + long_url: https://checkout.square.site/EXAMPLE + created_at: '2022-04-25T23:58:01Z' + updated_at: updated_at + payment_note: payment_note + related_resources: + orders: + - id: o4b7saqp4HzhNttf5AJxC0Srjd4F + location_id: '{LOCATION_ID}' + source: + name: Test Online Checkout Application + line_items: + - uid: 8YX13D1U3jO7czP8JVrAR + name: Auto Detailing + quantity: '1' + item_type: ITEM + base_price_money: + amount: 12500 + currency: USD + variation_total_price_money: + amount: 12500 + currency: USD + gross_sales_money: + amount: 12500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_money: + amount: 12500 + currency: USD + fulfillments: + - uid: bBpNrxjdQxGQP16sTmdzi + type: PICKUP + state: PROPOSED + net_amounts: + total_money: + amount: 12500 + currency: USD + tax_money: + amount: 0 + currency: USD + discount_money: + amount: 0 + currency: USD + tip_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + created_at: '2022-03-03T00:53:15.829Z' + updated_at: '2022-03-03T00:53:15.829Z' + state: DRAFT + version: 1 + total_money: + amount: 12500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_tip_money: + amount: 0 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + subscription_plans: + - type: ITEM + id: id + get: + path: /v2/online-checkout/payment-links/{id} + method: GET + auth: true + docs: Retrieves a payment link. + source: + openapi: openapi/openapi.json + display-name: RetrievePaymentLink + request: + name: GetPaymentLinksRequest + path-parameters: + id: + type: string + docs: The ID of link to retrieve. + response: + docs: Success + type: root.GetPaymentLinkResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment_link: + id: LLO5Q3FRCFICDB4B + version: 1 + description: description + order_id: 4uKASDATqSd1QQ9jV86sPhMdVEbSJc4F + checkout_options: + allow_tipping: true + custom_fields: + - title: title + subscription_plan_id: subscription_plan_id + redirect_url: redirect_url + merchant_support_email: merchant_support_email + ask_for_shipping_address: true + shipping_fee: + charge: {} + enable_coupon: true + enable_loyalty: true + pre_populated_data: + buyer_email: buyer_email + buyer_phone_number: buyer_phone_number + url: https://square.link/u/EXAMPLE + long_url: https://checkout.square.site/EXAMPLE + created_at: '2022-04-26T00:10:29Z' + updated_at: updated_at + payment_note: payment_note + update: + path: /v2/online-checkout/payment-links/{id} + method: PUT + auth: true + docs: >- + Updates a payment link. You can update the `payment_link` fields such as + + `description`, `checkout_options`, and `pre_populated_data`. + + You cannot update other fields such as the `order_id`, `version`, `URL`, + or `timestamp` field. + source: + openapi: openapi/openapi.json + display-name: UpdatePaymentLink + request: + name: UpdatePaymentLinkRequest + path-parameters: + id: + type: string + docs: The ID of the payment link to update. + body: + properties: + payment_link: + type: root.PaymentLink + docs: >- + The `payment_link` object describing the updates to apply. + + For more information, see [Update a payment + link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). + content-type: application/json + response: + docs: Success + type: root.UpdatePaymentLinkResponse + status-code: 200 + examples: + - path-parameters: + id: id + request: + payment_link: + version: 1 + checkout_options: + ask_for_shipping_address: true + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment_link: + id: TY4BWEDJ6AI5MBIV + version: 2 + description: description + order_id: Qqc8ypQGvxVwc46Cch4zHTaJqc4F + checkout_options: + allow_tipping: true + custom_fields: + - title: title + subscription_plan_id: subscription_plan_id + redirect_url: redirect_url + merchant_support_email: merchant_support_email + ask_for_shipping_address: true + shipping_fee: + charge: {} + enable_coupon: true + enable_loyalty: true + pre_populated_data: + buyer_email: buyer_email + buyer_phone_number: buyer_phone_number + url: https://square.link/u/EXAMPLE + long_url: https://checkout.square.site/EXAMPLE + created_at: '2022-04-26T00:15:15Z' + updated_at: '2022-04-26T00:18:24Z' + payment_note: test + delete: + path: /v2/online-checkout/payment-links/{id} + method: DELETE + auth: true + docs: Deletes a payment link. + source: + openapi: openapi/openapi.json + display-name: DeletePaymentLink + request: + name: DeletePaymentLinksRequest + path-parameters: + id: + type: string + docs: The ID of the payment link to delete. + response: + docs: Success + type: root.DeletePaymentLinkResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + id: MQASNYL6QB6DFCJ3 + cancelled_order_id: asx8LgZ6MRzD0fObfkJ6obBmSh4F + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/customers.yml b/.mock/definition/customers.yml new file mode 100644 index 00000000..f9644a82 --- /dev/null +++ b/.mock/definition/customers.yml @@ -0,0 +1,1132 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/customers + method: GET + auth: true + docs: >- + Lists customer profiles associated with a Square account. + + + Under normal operating conditions, newly created or updated customer + profiles become available + + for the listing operation in well under 30 seconds. Occasionally, + propagation of the new or updated + + profiles can take closer to one minute or longer, especially during + network incidents and outages. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.customers + source: + openapi: openapi/openapi.json + display-name: ListCustomers + request: + name: ListCustomersRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for your + original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: >- + The maximum number of results to return in a single page. This + limit is advisory. The response might contain more or fewer + results. + + If the specified limit is less than 1 or greater than 100, Square + returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The + default value is 100. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + sort_field: + type: optional> + docs: |- + Indicates how customers should be sorted. + + The default value is `DEFAULT`. + sort_order: + type: optional> + docs: >- + Indicates whether customers should be sorted in ascending (`ASC`) + or + + descending (`DESC`) order. + + + The default value is `ASC`. + count: + type: optional> + default: false + docs: >- + Indicates whether to return the total count of customers in the + `count` field of the response. + + + The default value is `false`. + response: + docs: Success + type: root.ListCustomersResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + customers: + - id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2016-03-23T20:21:54.859Z' + updated_at: '2016-03-23T20:21:55Z' + given_name: Amelia + family_name: Earhart + nickname: nickname + company_name: company_name + email_address: Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-555-4240 + birthday: birthday + reference_id: YOUR_REFERENCE_ID + note: a customer + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + group_ids: + - 545AXB44B4XXWMVQ4W8SBT3HHF + segment_ids: + - 1KB9JE5EGJXCW.REACHABLE + version: 1 + cursor: cursor + count: 1000000 + create: + path: /v2/customers + method: POST + auth: true + docs: >- + Creates a new customer for a business. + + + You must provide at least one of the following values in your request to + this + + endpoint: + + + - `given_name` + + - `family_name` + + - `company_name` + + - `email_address` + + - `phone_number` + source: + openapi: openapi/openapi.json + display-name: CreateCustomer + request: + name: CreateCustomerRequest + body: + properties: + idempotency_key: + type: optional + docs: "The idempotency key for the request.\tFor more information, see\n[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." + given_name: + type: optional + docs: >- + The given name (that is, the first name) associated with the + customer profile. + + + The maximum length for this value is 300 characters. + family_name: + type: optional + docs: >- + The family name (that is, the last name) associated with the + customer profile. + + + The maximum length for this value is 300 characters. + company_name: + type: optional + docs: |- + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + nickname: + type: optional + docs: |- + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + email_address: + type: optional + docs: |- + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + address: + type: optional + docs: >- + The physical address associated with the customer profile. For + maximum length constraints, see + + [Customer + addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + + The `first_name` and `last_name` fields are ignored if they are + present in the request. + phone_number: + type: optional + docs: >- + The phone number associated with the customer profile. The phone + number must be valid and can contain + + 9–16 digits, with an optional `+` prefix and country code. For + more information, see + + [Customer phone + numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + reference_id: + type: optional + docs: >- + An optional second ID used to associate the customer profile + with an + + entity in another system. + + + The maximum length for this value is 100 characters. + note: + type: optional + docs: A custom note associated with the customer profile. + birthday: + type: optional + docs: >- + The birthday associated with the customer profile, in + `YYYY-MM-DD` or `MM-DD` format. For example, + + specify `1998-09-21` for September 21, 1998, or `09-21` for + September 21. Birthdays are returned in `YYYY-MM-DD` + + format, where `YYYY` is the specified birth year or `0000` if a + birth year is not specified. + tax_ids: + type: optional + docs: >- + The tax ID associated with the customer profile. This field is + available only for customers of sellers + + in EU countries or the United Kingdom. For more information, + + see [Customer tax + IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + content-type: application/json + response: + docs: Success + type: root.CreateCustomerResponse + status-code: 200 + examples: + - request: + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-555-4240 + reference_id: YOUR_REFERENCE_ID + note: a customer + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + customer: + id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2016-03-23T20:21:54.859Z' + updated_at: '2016-03-23T20:21:54.859Z' + given_name: Amelia + family_name: Earhart + nickname: nickname + company_name: company_name + email_address: Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + phone_number: +1-212-555-4240 + birthday: birthday + reference_id: YOUR_REFERENCE_ID + note: a customer + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + group_ids: + - group_ids + segment_ids: + - segment_ids + version: 0 + tax_ids: + eu_vat: eu_vat + batchCreate: + path: /v2/customers/bulk-create + method: POST + auth: true + docs: >- + Creates multiple [customer profiles](entity:Customer) for a business. + + + This endpoint takes a map of individual create requests and returns a + map of responses. + + + You must provide at least one of the following values in each create + request: + + + - `given_name` + + - `family_name` + + - `company_name` + + - `email_address` + + - `phone_number` + source: + openapi: openapi/openapi.json + display-name: BulkCreateCustomers + request: + name: BulkCreateCustomersRequest + body: + properties: + customers: + type: map + docs: >- + A map of 1 to 100 individual create requests, represented by + `idempotency key: { customer data }` + + key-value pairs. + + + Each key is an [idempotency + key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + + that uniquely identifies the create request. Each value contains + the customer data used to create the + + customer profile. + content-type: application/json + response: + docs: Success + type: root.BulkCreateCustomersResponse + status-code: 200 + examples: + - request: + customers: + 8bb76c4f-e35d-4c5b-90de-1194cd9179f0: + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-555-4240 + reference_id: YOUR_REFERENCE_ID + note: a customer + d1689f23-b25d-4932-b2f0-aed00f5e2029: + given_name: Marie + family_name: Curie + email_address: Marie.Curie@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 601 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-444-4240 + reference_id: YOUR_REFERENCE_ID + note: another customer + response: + body: + responses: + 8bb76c4f-e35d-4c5b-90de-1194cd9179f4: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + customer: + id: 8DDA5NZVBZFGAX0V3HPF81HHE0 + created_at: '2024-03-23T20:21:54.859Z' + updated_at: '2024-03-23T20:21:54.859Z' + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-555-4240 + reference_id: YOUR_REFERENCE_ID + note: a customer + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + version: 0 + d1689f23-b25d-4932-b2f0-aed00f5e2029: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + customer: + id: N18CPRVXR5214XPBBA6BZQWF3C + created_at: '2024-03-23T20:21:54.859Z' + updated_at: '2024-03-23T20:21:54.859Z' + given_name: Marie + family_name: Curie + email_address: Marie.Curie@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 601 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-444-4240 + reference_id: YOUR_REFERENCE_ID + note: another customer + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + version: 0 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + BulkDeleteCustomers: + path: /v2/customers/bulk-delete + method: POST + auth: true + docs: >- + Deletes multiple customer profiles. + + + The endpoint takes a list of customer IDs and returns a map of + responses. + source: + openapi: openapi/openapi.json + display-name: BulkDeleteCustomers + request: + name: BulkDeleteCustomersRequest + body: + properties: + customer_ids: + docs: The IDs of the [customer profiles](entity:Customer) to delete. + type: list + content-type: application/json + response: + docs: Success + type: root.BulkDeleteCustomersResponse + status-code: 200 + examples: + - request: + customer_ids: + - 8DDA5NZVBZFGAX0V3HPF81HHE0 + - N18CPRVXR5214XPBBA6BZQWF3C + - 2GYD7WNXF7BJZW1PMGNXZ3Y8M8 + response: + body: + responses: + 2GYD7WNXF7BJZW1PMGNXZ3Y8M8: + errors: + - category: INVALID_REQUEST_ERROR + code: NOT_FOUND + detail: Customer with ID `2GYD7WNXF7BJZW1PMGNXZ3Y8M8` not found. + 8DDA5NZVBZFGAX0V3HPF81HHE0: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + N18CPRVXR5214XPBBA6BZQWF3C: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + BulkRetrieveCustomers: + path: /v2/customers/bulk-retrieve + method: POST + auth: true + docs: >- + Retrieves multiple customer profiles. + + + This endpoint takes a list of customer IDs and returns a map of + responses. + source: + openapi: openapi/openapi.json + display-name: BulkRetrieveCustomers + request: + name: BulkRetrieveCustomersRequest + body: + properties: + customer_ids: + docs: The IDs of the [customer profiles](entity:Customer) to retrieve. + type: list + content-type: application/json + response: + docs: Success + type: root.BulkRetrieveCustomersResponse + status-code: 200 + examples: + - request: + customer_ids: + - 8DDA5NZVBZFGAX0V3HPF81HHE0 + - N18CPRVXR5214XPBBA6BZQWF3C + - 2GYD7WNXF7BJZW1PMGNXZ3Y8M8 + response: + body: + responses: + 2GYD7WNXF7BJZW1PMGNXZ3Y8M8: + errors: + - category: INVALID_REQUEST_ERROR + code: NOT_FOUND + detail: Customer with ID `2GYD7WNXF7BJZW1PMGNXZ3Y8M8` not found. + 8DDA5NZVBZFGAX0V3HPF81HHE0: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + customer: + id: 8DDA5NZVBZFGAX0V3HPF81HHE0 + created_at: '2024-01-19T00:27:54.59Z' + updated_at: '2024-01-19T00:38:06Z' + given_name: Amelia + family_name: Earhart + email_address: New.Amelia.Earhart@example.com + birthday: '1897-07-24' + note: updated customer note + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + version: 3 + N18CPRVXR5214XPBBA6BZQWF3C: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + customer: + id: N18CPRVXR5214XPBBA6BZQWF3C + created_at: '2024-01-19T00:27:54.59Z' + updated_at: '2024-01-19T00:38:06Z' + given_name: Marie + family_name: Curie + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + version: 1 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + BulkUpdateCustomers: + path: /v2/customers/bulk-update + method: POST + auth: true + docs: >- + Updates multiple customer profiles. + + + This endpoint takes a map of individual update requests and returns a + map of responses. + source: + openapi: openapi/openapi.json + display-name: BulkUpdateCustomers + request: + name: BulkUpdateCustomersRequest + body: + properties: + customers: + type: map + docs: >- + A map of 1 to 100 individual update requests, represented by + `customer ID: { customer data }` + + key-value pairs. + + + Each key is the ID of the [customer profile](entity:Customer) to + update. To update a customer profile + + that was created by merging existing profiles, provide the ID of + the newly created profile. + + + Each value contains the updated customer data. Only new or + changed fields are required. To add or + + update a field, specify the new value. To remove a field, + specify `null`. + content-type: application/json + response: + docs: Success + type: root.BulkUpdateCustomersResponse + status-code: 200 + examples: + - request: + customers: + 8DDA5NZVBZFGAX0V3HPF81HHE0: + email_address: New.Amelia.Earhart@example.com + note: updated customer note + version: 2 + N18CPRVXR5214XPBBA6BZQWF3C: + given_name: Marie + family_name: Curie + version: 0 + response: + body: + responses: + 8DDA5NZVBZFGAX0V3HPF81HHE0: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + customer: + id: 8DDA5NZVBZFGAX0V3HPF81HHE0 + created_at: '2024-01-19T00:27:54.59Z' + updated_at: '2024-01-19T00:38:06Z' + given_name: Amelia + family_name: Earhart + email_address: New.Amelia.Earhart@example.com + birthday: '1897-07-24' + note: updated customer note + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + version: 3 + N18CPRVXR5214XPBBA6BZQWF3C: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + customer: + id: N18CPRVXR5214XPBBA6BZQWF3C + created_at: '2024-01-19T00:27:54.59Z' + updated_at: '2024-01-19T00:38:06Z' + given_name: Marie + family_name: Curie + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + version: 1 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + search: + path: /v2/customers/search + method: POST + auth: true + docs: >- + Searches the customer profiles associated with a Square account using + one or more supported query filters. + + + Calling `SearchCustomers` without any explicit query filter returns all + + customer profiles ordered alphabetically based on `given_name` and + + `family_name`. + + + Under normal operating conditions, newly created or updated customer + profiles become available + + for the search operation in well under 30 seconds. Occasionally, + propagation of the new or updated + + profiles can take closer to one minute or longer, especially during + network incidents and outages. + source: + openapi: openapi/openapi.json + display-name: SearchCustomers + request: + name: SearchCustomersRequest + body: + properties: + cursor: + type: optional + docs: >- + Include the pagination cursor in subsequent calls to this + endpoint to retrieve + + the next set of results associated with the original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional + docs: >- + The maximum number of results to return in a single page. This + limit is advisory. The response might contain more or fewer + results. + + If the specified limit is invalid, Square returns a `400 + VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value + is 100. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + query: + type: optional + docs: >- + The filtering and sorting criteria for the search request. If a + query is not specified, + + Square returns all customer profiles ordered alphabetically by + `given_name` and `family_name`. + count: + type: optional + docs: >- + Indicates whether to return the total count of matching + customers in the `count` field of the response. + + + The default value is `false`. + content-type: application/json + response: + docs: Success + type: root.SearchCustomersResponse + status-code: 200 + examples: + - request: + limit: 2 + query: + filter: + creation_source: + values: + - THIRD_PARTY + rule: INCLUDE + created_at: + start_at: '2018-01-01T00:00:00-00:00' + end_at: '2018-02-01T00:00:00-00:00' + email_address: + fuzzy: example.com + group_ids: + all: + - 545AXB44B4XXWMVQ4W8SBT3HHF + sort: + field: CREATED_AT + order: ASC + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + customers: + - id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2018-01-23T20:21:54.859Z' + updated_at: '2020-04-20T10:02:43.083Z' + given_name: James + family_name: Bond + nickname: nickname + company_name: company_name + email_address: james.bond@example.com + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-555-4250 + birthday: birthday + reference_id: YOUR_REFERENCE_ID_2 + note: note + preferences: + email_unsubscribed: false + creation_source: DIRECTORY + group_ids: + - 545AXB44B4XXWMVQ4W8SBT3HHF + segment_ids: + - 1KB9JE5EGJXCW.REACHABLE + version: 7 + - id: A9641GZW2H7Z56YYSD41Q12HDW + created_at: '2018-01-30T14:10:54.859Z' + updated_at: '2018-03-08T18:25:21.342Z' + given_name: Amelia + family_name: Earhart + nickname: nickname + company_name: company_name + email_address: amelia.earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + phone_number: +1-212-555-9238 + birthday: birthday + reference_id: YOUR_REFERENCE_ID_1 + note: a customer + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + group_ids: + - 545AXB44B4XXWMVQ4W8SBT3HHF + segment_ids: + - 1KB9JE5EGJXCW.REACHABLE + version: 1 + cursor: 9dpS093Uy12AzeE + count: 1000000 + get: + path: /v2/customers/{customer_id} + method: GET + auth: true + docs: Returns details for a single customer. + source: + openapi: openapi/openapi.json + display-name: RetrieveCustomer + request: + name: GetCustomersRequest + path-parameters: + customer_id: + type: string + docs: The ID of the customer to retrieve. + response: + docs: Success + type: root.GetCustomerResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + customer: + id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2016-03-23T20:21:54.859Z' + updated_at: '2016-03-23T20:21:54.859Z' + given_name: Amelia + family_name: Earhart + nickname: nickname + company_name: company_name + email_address: Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + phone_number: +1-212-555-4240 + birthday: birthday + reference_id: YOUR_REFERENCE_ID + note: a customer + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + group_ids: + - 545AXB44B4XXWMVQ4W8SBT3HHF + segment_ids: + - 1KB9JE5EGJXCW.REACHABLE + version: 1 + tax_ids: + eu_vat: eu_vat + update: + path: /v2/customers/{customer_id} + method: PUT + auth: true + docs: >- + Updates a customer profile. This endpoint supports sparse updates, so + only new or changed fields are required in the request. + + To add or update a field, specify the new value. To remove a field, + specify `null`. + + + To update a customer profile that was created by merging existing + profiles, you must use the ID of the newly created profile. + source: + openapi: openapi/openapi.json + display-name: UpdateCustomer + request: + name: UpdateCustomerRequest + path-parameters: + customer_id: + type: string + docs: The ID of the customer to update. + body: + properties: + given_name: + type: optional> + docs: >- + The given name (that is, the first name) associated with the + customer profile. + + + The maximum length for this value is 300 characters. + family_name: + type: optional> + docs: >- + The family name (that is, the last name) associated with the + customer profile. + + + The maximum length for this value is 300 characters. + company_name: + type: optional> + docs: |- + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + nickname: + type: optional> + docs: |- + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + email_address: + type: optional> + docs: |- + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + address: + type: optional + docs: >- + The physical address associated with the customer profile. Only + new or changed fields are required in the request. + + + For maximum length constraints, see [Customer + addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + + The `first_name` and `last_name` fields are ignored if they are + present in the request. + phone_number: + type: optional> + docs: >- + The phone number associated with the customer profile. The phone + number must be valid and can contain + + 9–16 digits, with an optional `+` prefix and country code. For + more information, see + + [Customer phone + numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + reference_id: + type: optional> + docs: >- + An optional second ID used to associate the customer profile + with an + + entity in another system. + + + The maximum length for this value is 100 characters. + note: + type: optional> + docs: A custom note associated with the customer profile. + birthday: + type: optional> + docs: >- + The birthday associated with the customer profile, in + `YYYY-MM-DD` or `MM-DD` format. For example, + + specify `1998-09-21` for September 21, 1998, or `09-21` for + September 21. Birthdays are returned in `YYYY-MM-DD` + + format, where `YYYY` is the specified birth year or `0000` if a + birth year is not specified. + version: + type: optional + docs: >- + The current version of the customer profile. + + + As a best practice, you should include this field to enable + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control. For more information, see [Update a customer + profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). + tax_ids: + type: optional + docs: >- + The tax ID associated with the customer profile. This field is + available only for customers of sellers + + in EU countries or the United Kingdom. For more information, + + see [Customer tax + IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + content-type: application/json + response: + docs: Success + type: root.UpdateCustomerResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + request: + email_address: New.Amelia.Earhart@example.com + note: updated customer note + version: 2 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + customer: + id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2016-03-23T20:21:54.859Z' + updated_at: '2016-05-15T20:21:55Z' + given_name: Amelia + family_name: Earhart + nickname: nickname + company_name: company_name + email_address: New.Amelia.Earhart@example.com + address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + phone_number: phone_number + birthday: birthday + reference_id: YOUR_REFERENCE_ID + note: updated customer note + preferences: + email_unsubscribed: false + creation_source: THIRD_PARTY + group_ids: + - group_ids + segment_ids: + - segment_ids + version: 3 + tax_ids: + eu_vat: eu_vat + delete: + path: /v2/customers/{customer_id} + method: DELETE + auth: true + docs: >- + Deletes a customer profile from a business. + + + To delete a customer profile that was created by merging existing + profiles, you must use the ID of the newly created profile. + source: + openapi: openapi/openapi.json + display-name: DeleteCustomer + request: + name: DeleteCustomersRequest + path-parameters: + customer_id: + type: string + docs: The ID of the customer to delete. + query-parameters: + version: + type: optional> + docs: >- + The current version of the customer profile. + + + As a best practice, you should include this parameter to enable + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control. For more information, see [Delete a customer + profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). + response: + docs: Success + type: root.DeleteCustomerResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/customers/cards.yml b/.mock/definition/customers/cards.yml new file mode 100644 index 00000000..9d96df61 --- /dev/null +++ b/.mock/definition/customers/cards.yml @@ -0,0 +1,173 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/customers/{customer_id}/cards + method: POST + auth: true + docs: >- + Adds a card on file to an existing customer. + + + As with charges, calls to `CreateCustomerCard` are idempotent. Multiple + + calls with the same card nonce return the same card record that was + created + + with the provided nonce during the _first_ call. + source: + openapi: openapi/openapi.json + display-name: CreateCustomerCard + request: + name: CreateCustomerCardRequest + path-parameters: + customer_id: + type: string + docs: The Square ID of the customer profile the card is linked to. + body: + properties: + card_nonce: + type: string + docs: >- + A card nonce representing the credit card to link to the + customer. + + + Card nonces are generated by the Square payment form when + customers enter + + their card information. For more information, see + + [Walkthrough: Integrate Square Payments in a + Website](https://developer.squareup.com/docs/web-payments/take-card-payment). + + + __NOTE:__ Card nonces generated by digital wallets (such as + Apple Pay) + + cannot be used to create a customer card. + billing_address: + type: optional + docs: >- + Address information for the card on file. + + + __NOTE:__ If a billing address is provided in the request, the + + `CreateCustomerCardRequest.billing_address.postal_code` must + match + + the postal code encoded in the card nonce. + cardholder_name: + type: optional + docs: The full name printed on the credit card. + verification_token: + type: optional + docs: >- + An identifying token generated by + [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + + Verification tokens encapsulate customer device information and + 3-D Secure + + challenge results to indicate that Square has verified the buyer + identity. + content-type: application/json + response: + docs: Success + type: root.CreateCustomerCardResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + customer_id: customer_id + request: + card_nonce: YOUR_CARD_NONCE + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + cardholder_name: Amelia Earhart + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + card: + id: icard-card_id + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2018 + cardholder_name: Amelia Earhart + billing_address: + address_line_1: 500 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + fingerprint: fingerprint + customer_id: customer_id + merchant_id: merchant_id + reference_id: reference_id + enabled: true + card_type: UNKNOWN_CARD_TYPE + prepaid_type: UNKNOWN_PREPAID_TYPE + bin: bin + version: 1000000 + card_co_brand: UNKNOWN + issuer_alert: ISSUER_ALERT_CARD_CLOSED + issuer_alert_at: issuer_alert_at + hsa_fsa: true + delete: + path: /v2/customers/{customer_id}/cards/{card_id} + method: DELETE + auth: true + docs: Removes a card on file from a customer. + source: + openapi: openapi/openapi.json + display-name: DeleteCustomerCard + request: + name: DeleteCardsRequest + path-parameters: + customer_id: + type: string + docs: The ID of the customer that the card on file belongs to. + card_id: + type: string + docs: The ID of the card on file to delete. + response: + docs: Success + type: root.DeleteCustomerCardResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + customer_id: customer_id + card_id: card_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/customers/customAttributeDefinitions.yml b/.mock/definition/customers/customAttributeDefinitions.yml new file mode 100644 index 00000000..fb23e471 --- /dev/null +++ b/.mock/definition/customers/customAttributeDefinitions.yml @@ -0,0 +1,576 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/customers/custom-attribute-definitions + method: GET + auth: true + docs: >- + Lists the customer-related [custom attribute + definitions](entity:CustomAttributeDefinition) that belong to a Square + seller account. + + + When all response pages are retrieved, the results include all custom + attribute definitions + + that are visible to the requesting application, including those that are + created by other + + applications and set to `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. Note that + + seller-defined custom attributes (also known as custom fields) are + always set to `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attribute_definitions + source: + openapi: openapi/openapi.json + display-name: ListCustomerCustomAttributeDefinitions + request: + name: ListCustomAttributeDefinitionsRequest + query-parameters: + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListCustomerCustomAttributeDefinitionsResponse + status-code: 200 + examples: + - response: + body: + custom_attribute_definitions: + - key: favoritemovie + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite Movie + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + version: 3 + updated_at: '2022-04-26T15:39:38Z' + created_at: '2022-04-26T15:27:30Z' + - key: ownsmovie + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean + name: Owns Movie + description: Customer owns movie. + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: '2022-04-26T15:49:05Z' + created_at: '2022-04-26T15:49:05Z' + cursor: >- + YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/customers/custom-attribute-definitions + method: POST + auth: true + docs: >- + Creates a customer-related [custom attribute + definition](entity:CustomAttributeDefinition) for a Square seller + account. + + Use this endpoint to define a custom attribute that can be associated + with customer profiles. + + + A custom attribute definition specifies the `key`, `visibility`, + `schema`, and other properties + + for a custom attribute. After the definition is created, you can call + + [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) + or + + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + + to set the custom attribute for customer profiles in the seller's + Customer Directory. + + + Sellers can view all custom attributes in exported customer data, + including those set to + + `VISIBILITY_HIDDEN`. + source: + openapi: openapi/openapi.json + display-name: CreateCustomerCustomAttributeDefinition + request: + name: CreateCustomerCustomAttributeDefinitionRequest + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition to create. Note the following: + + - With the exception of the `Selection` data type, the `schema` + is specified as a simple URL to the JSON schema + + definition hosted on the Square CDN. For more information, + including supported values and constraints, see + + [Specifying the + schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + + - If provided, `name` must be unique (case-sensitive) across all + visible customer-related custom attribute definitions for the + seller. + + - All custom attributes are visible in exported customer data, + including those set to `VISIBILITY_HIDDEN`. + idempotency_key: + type: optional + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CreateCustomerCustomAttributeDefinitionResponse + status-code: 200 + examples: + - request: + custom_attribute_definition: + key: favoritemovie + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite Movie + description: The favorite movie of the customer. + visibility: VISIBILITY_HIDDEN + response: + body: + custom_attribute_definition: + key: favoritemovie + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite Movie + description: The favorite movie of the customer. + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: '2022-04-26T15:27:30Z' + created_at: '2022-04-26T15:27:30Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/customers/custom-attribute-definitions/{key} + method: GET + auth: true + docs: >- + Retrieves a customer-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + + To retrieve a custom attribute definition created by another + application, the `visibility` + + setting must be `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveCustomerCustomAttributeDefinition + request: + name: GetCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: >- + The key of the custom attribute definition to retrieve. If the + requesting application + + is not the definition owner, you must use the qualified key. + query-parameters: + version: + type: optional> + docs: >- + The current version of the custom attribute definition, which is + used for strongly consistent + + reads to guarantee that you receive the most up-to-date data. When + included in the request, + + Square returns the specified version or a higher version if one + exists. If the specified version + + is higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.GetCustomerCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + custom_attribute_definition: + key: favoritemovie + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite Movie + description: The favorite movie of the customer. + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-04-26T15:27:30Z' + created_at: '2022-04-26T15:27:30Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/customers/custom-attribute-definitions/{key} + method: PUT + auth: true + docs: >- + Updates a customer-related [custom attribute + definition](entity:CustomAttributeDefinition) for a Square seller + account. + + + Use this endpoint to update the following fields: `name`, `description`, + `visibility`, or the + + `schema` for a `Selection` data type. + + + Only the definition owner can update a custom attribute definition. Note + that sellers can view + + all custom attributes in exported customer data, including those set to + `VISIBILITY_HIDDEN`. + source: + openapi: openapi/openapi.json + display-name: UpdateCustomerCustomAttributeDefinition + request: + name: UpdateCustomerCustomAttributeDefinitionRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to update. + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition that contains the fields to + update. This endpoint + + supports sparse updates, so only new or changed fields need to + be included in the request. + + Only the following fields can be updated: + + + - `name` + + - `description` + + - `visibility` + + - `schema` for a `Selection` data type. Only changes to the + named options or the maximum number of allowed + + selections are supported. + + + For more information, see + + [Updatable definition + fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + + To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, include the optional `version` field and specify the + current version of the custom attribute definition. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdateCustomerCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + request: + custom_attribute_definition: + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + response: + body: + custom_attribute_definition: + key: favoritemovie + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Favorite Movie + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + version: 2 + updated_at: '2022-04-26T15:39:38Z' + created_at: '2022-04-26T15:27:30Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/customers/custom-attribute-definitions/{key} + method: DELETE + auth: true + docs: >- + Deletes a customer-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + + Deleting a custom attribute definition also deletes the corresponding + custom attribute from + + all customer profiles in the seller's Customer Directory. + + + Only the definition owner can delete a custom attribute definition. + source: + openapi: openapi/openapi.json + display-name: DeleteCustomerCustomAttributeDefinition + request: + name: DeleteCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to delete. + response: + docs: Success + type: root.DeleteCustomerCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchUpsert: + path: /v2/customers/custom-attributes/bulk-upsert + method: POST + auth: true + docs: >- + Creates or updates [custom attributes](entity:CustomAttribute) for + customer profiles as a bulk operation. + + + Use this endpoint to set the value of one or more custom attributes for + one or more customer profiles. + + A custom attribute is based on a custom attribute definition in a Square + seller account, which is + + created using the + [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) + endpoint. + + + This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to + 25 individual upsert + + requests and returns a map of individual upsert responses. Each upsert + request has a unique ID + + and provides a customer ID and custom attribute. Each upsert response is + returned with the ID + + of the corresponding request. + + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkUpsertCustomerCustomAttributes + request: + name: BatchUpsertCustomerCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + A map containing 1 to 25 individual upsert requests. For each + request, provide an + + arbitrary ID that is unique for this + `BulkUpsertCustomerCustomAttributes` request and the + + information needed to create or update a custom attribute. + content-type: application/json + response: + docs: Success + type: root.BatchUpsertCustomerCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + id1: + customer_id: N3NCVYY3WS27HF0HKANA3R9FP8 + custom_attribute: + key: favoritemovie + value: Dune + id2: + customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + custom_attribute: + key: ownsmovie + value: false + id3: + customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + custom_attribute: + key: favoritemovie + value: Star Wars + id4: + customer_id: N3NCVYY3WS27HF0HKANA3R9FP8 + custom_attribute: + key: square:a0f1505a-2aa1-490d-91a8-8d31ff181808 + value: '10.5' + id5: + customer_id: 70548QG1HN43B05G0KCZ4MMC1G + custom_attribute: + key: sq0ids-0evKIskIGaY45fCyNL66aw:backupemail + value: fake-email@squareup.com + response: + body: + values: + id1: + customer_id: N3NCVYY3WS27HF0HKANA3R9FP8 + custom_attribute: + key: favoritemovie + value: Dune + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2021-12-09T00:16:23Z' + created_at: '2021-12-08T23:14:47Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + custom_attribute: + key: ownsmovie + value: false + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2021-12-09T00:16:23Z' + created_at: '2021-12-09T00:16:20Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id3: + customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM + custom_attribute: + key: favoritemovie + value: Star Wars + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2021-12-09T00:16:23Z' + created_at: '2021-12-09T00:16:20Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id4: + customer_id: N3NCVYY3WS27HF0HKANA3R9FP8 + custom_attribute: + key: square:a0f1505a-2aa1-490d-91a8-8d31ff181808 + value: '10.5' + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2021-12-09T00:16:23Z' + created_at: '2021-12-08T23:14:47Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id5: + customer_id: 70548QG1HN43B05G0KCZ4MMC1G + custom_attribute: + key: sq0ids-0evKIskIGaY45fCyNL66aw:backupemail + value: fake-email@squareup.com + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2021-12-09T00:16:23Z' + created_at: '2021-12-09T00:16:20Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/customers/customAttributes.yml b/.mock/definition/customers/customAttributes.yml new file mode 100644 index 00000000..63602844 --- /dev/null +++ b/.mock/definition/customers/customAttributes.yml @@ -0,0 +1,376 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/customers/{customer_id}/custom-attributes + method: GET + auth: true + docs: >- + Lists the [custom attributes](entity:CustomAttribute) associated with a + customer profile. + + + You can use the `with_definitions` query parameter to also retrieve + custom attribute definitions + + in the same call. + + + When all response pages are retrieved, the results include all custom + attributes that are + + visible to the requesting application, including those that are owned by + other applications + + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attributes + source: + openapi: openapi/openapi.json + display-name: ListCustomerCustomAttributes + request: + name: ListCustomAttributesRequest + path-parameters: + customer_id: + type: string + docs: The ID of the target [customer profile](entity:Customer). + query-parameters: + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. For more + + information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + with_definitions: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of each + + custom attribute. Set this parameter to `true` to get the name and + description of each custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + response: + docs: Success + type: root.ListCustomerCustomAttributesResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + response: + body: + custom_attributes: + - key: favoritemovie + value: Dune + version: 1 + visibility: VISIBILITY_READ_ONLY + updated_at: '2022-04-26T15:50:27Z' + created_at: '2022-04-26T15:50:27Z' + - key: ownsmovie + value: false + version: 1 + visibility: VISIBILITY_HIDDEN + updated_at: '2022-04-26T15:51:53Z' + created_at: '2022-04-26T15:51:53Z' + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/customers/{customer_id}/custom-attributes/{key} + method: GET + auth: true + docs: >- + Retrieves a [custom attribute](entity:CustomAttribute) associated with a + customer profile. + + + You can use the `with_definition` query parameter to also retrieve the + custom attribute definition + + in the same call. + + + To retrieve a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that + seller-defined custom attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveCustomerCustomAttribute + request: + name: GetCustomAttributesRequest + path-parameters: + customer_id: + type: string + docs: The ID of the target [customer profile](entity:Customer). + key: + type: string + docs: >- + The key of the custom attribute to retrieve. This key must match + the `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + query-parameters: + with_definition: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of + + the custom attribute. Set this parameter to `true` to get the name + and description of the custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + version: + type: optional> + docs: >- + The current version of the custom attribute, which is used for + strongly consistent reads to + + guarantee that you receive the most up-to-date data. When included + in the request, Square + + returns the specified version or a higher version if one exists. + If the specified version is + + higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.GetCustomerCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + key: key + response: + body: + custom_attribute: + key: favoritemovie + value: Dune + version: 1 + visibility: VISIBILITY_READ_ONLY + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2022-04-26T15:50:27Z' + created_at: '2022-04-26T15:50:27Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + upsert: + path: /v2/customers/{customer_id}/custom-attributes/{key} + method: POST + auth: true + docs: >- + Creates or updates a [custom attribute](entity:CustomAttribute) for a + customer profile. + + + Use this endpoint to set the value of a custom attribute for a specified + customer profile. + + A custom attribute is based on a custom attribute definition in a Square + seller account, which + + is created using the + [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) + endpoint. + + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: UpsertCustomerCustomAttribute + request: + name: UpsertCustomerCustomAttributeRequest + path-parameters: + customer_id: + type: string + docs: The ID of the target [customer profile](entity:Customer). + key: + type: string + docs: >- + The key of the custom attribute to create or update. This key must + match the `key` of a + + custom attribute definition in the Square seller account. If the + requesting application is not + + the definition owner, you must use the qualified key. + body: + properties: + custom_attribute: + type: root.CustomAttribute + docs: >- + The custom attribute to create or update, with the following + fields: + + + - `value`. This value must conform to the `schema` specified by + the definition. + + For more information, see [Value data + types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control for an update operation, include this optional field and + specify the current version + + of the custom attribute. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpsertCustomerCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + key: key + request: + custom_attribute: + value: Dune + response: + body: + custom_attribute: + key: favoritemovie + value: Dune + version: 1 + visibility: VISIBILITY_READ_ONLY + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2022-04-26T15:50:27Z' + created_at: '2022-04-26T15:50:27Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/customers/{customer_id}/custom-attributes/{key} + method: DELETE + auth: true + docs: >- + Deletes a [custom attribute](entity:CustomAttribute) associated with a + customer profile. + + + To delete a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: DeleteCustomerCustomAttribute + request: + name: DeleteCustomAttributesRequest + path-parameters: + customer_id: + type: string + docs: The ID of the target [customer profile](entity:Customer). + key: + type: string + docs: >- + The key of the custom attribute to delete. This key must match the + `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + response: + docs: Success + type: root.DeleteCustomerCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/customers/groups.yml b/.mock/definition/customers/groups.yml new file mode 100644 index 00000000..122e9592 --- /dev/null +++ b/.mock/definition/customers/groups.yml @@ -0,0 +1,293 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/customers/groups + method: GET + auth: true + docs: Retrieves the list of customer groups of a business. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.groups + source: + openapi: openapi/openapi.json + display-name: ListCustomerGroups + request: + name: ListGroupsRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for your + original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: >- + The maximum number of results to return in a single page. This + limit is advisory. The response might contain more or fewer + results. + + If the limit is less than 1 or greater than 50, Square returns a + `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default + value is 50. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListCustomerGroupsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + groups: + - id: 2TAT3CMH4Q0A9M87XJZED0WMR3 + name: Loyal Customers + created_at: '2020-04-13T21:54:57.863Z' + updated_at: '2020-04-13T21:54:58Z' + - id: 4XMEHESXJBNE9S9JAKZD2FGB14 + name: Super Loyal Customers + created_at: '2020-04-13T21:55:18.795Z' + updated_at: '2020-04-13T21:55:19Z' + cursor: cursor + create: + path: /v2/customers/groups + method: POST + auth: true + docs: |- + Creates a new customer group for a business. + + The request must include the `name` value of the group. + source: + openapi: openapi/openapi.json + display-name: CreateCustomerGroup + request: + name: CreateCustomerGroupRequest + body: + properties: + idempotency_key: + type: optional + docs: >- + The idempotency key for the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + group: + type: root.CustomerGroup + docs: The customer group to create. + content-type: application/json + response: + docs: Success + type: root.CreateCustomerGroupResponse + status-code: 200 + examples: + - request: + group: + name: Loyal Customers + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + group: + id: 2TAT3CMH4Q0A9M87XJZED0WMR3 + name: Loyal Customers + created_at: '2020-04-13T21:54:57.863Z' + updated_at: '2020-04-13T21:54:58Z' + get: + path: /v2/customers/groups/{group_id} + method: GET + auth: true + docs: >- + Retrieves a specific customer group as identified by the `group_id` + value. + source: + openapi: openapi/openapi.json + display-name: RetrieveCustomerGroup + request: + name: GetGroupsRequest + path-parameters: + group_id: + type: string + docs: The ID of the customer group to retrieve. + response: + docs: Success + type: root.GetCustomerGroupResponse + status-code: 200 + examples: + - path-parameters: + group_id: group_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + group: + id: 2TAT3CMH4Q0A9M87XJZED0WMR3 + name: Loyal Customers + created_at: '2020-04-13T21:54:57.863Z' + updated_at: '2020-04-13T21:54:58Z' + update: + path: /v2/customers/groups/{group_id} + method: PUT + auth: true + docs: Updates a customer group as identified by the `group_id` value. + source: + openapi: openapi/openapi.json + display-name: UpdateCustomerGroup + request: + name: UpdateCustomerGroupRequest + path-parameters: + group_id: + type: string + docs: The ID of the customer group to update. + body: + properties: + group: + type: root.CustomerGroup + docs: >- + The `CustomerGroup` object including all the updates you want to + make. + content-type: application/json + response: + docs: Success + type: root.UpdateCustomerGroupResponse + status-code: 200 + examples: + - path-parameters: + group_id: group_id + request: + group: + name: Loyal Customers + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + group: + id: 2TAT3CMH4Q0A9M87XJZED0WMR3 + name: Loyal Customers + created_at: '2020-04-13T21:54:57.863Z' + updated_at: '2020-04-13T21:54:58Z' + delete: + path: /v2/customers/groups/{group_id} + method: DELETE + auth: true + docs: Deletes a customer group as identified by the `group_id` value. + source: + openapi: openapi/openapi.json + display-name: DeleteCustomerGroup + request: + name: DeleteGroupsRequest + path-parameters: + group_id: + type: string + docs: The ID of the customer group to delete. + response: + docs: Success + type: root.DeleteCustomerGroupResponse + status-code: 200 + examples: + - path-parameters: + group_id: group_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + add: + path: /v2/customers/{customer_id}/groups/{group_id} + method: PUT + auth: true + docs: |- + Adds a group membership to a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + source: + openapi: openapi/openapi.json + display-name: AddGroupToCustomer + request: + name: AddGroupsRequest + path-parameters: + customer_id: + type: string + docs: The ID of the customer to add to a group. + group_id: + type: string + docs: The ID of the customer group to add the customer to. + response: + docs: Success + type: root.AddGroupToCustomerResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + group_id: group_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + remove: + path: /v2/customers/{customer_id}/groups/{group_id} + method: DELETE + auth: true + docs: |- + Removes a group membership from a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + source: + openapi: openapi/openapi.json + display-name: RemoveGroupFromCustomer + request: + name: RemoveGroupsRequest + path-parameters: + customer_id: + type: string + docs: The ID of the customer to remove from the group. + group_id: + type: string + docs: The ID of the customer group to remove the customer from. + response: + docs: Success + type: root.RemoveGroupFromCustomerResponse + status-code: 200 + examples: + - path-parameters: + customer_id: customer_id + group_id: group_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/customers/segments.yml b/.mock/definition/customers/segments.yml new file mode 100644 index 00000000..c79477c3 --- /dev/null +++ b/.mock/definition/customers/segments.yml @@ -0,0 +1,113 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/customers/segments + method: GET + auth: true + docs: Retrieves the list of customer segments of a business. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.segments + source: + openapi: openapi/openapi.json + display-name: ListCustomerSegments + request: + name: ListSegmentsRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by previous calls to + `ListCustomerSegments`. + + This cursor is used to retrieve the next set of query results. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: >- + The maximum number of results to return in a single page. This + limit is advisory. The response might contain more or fewer + results. + + If the specified limit is less than 1 or greater than 50, Square + returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The + default value is 50. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListCustomerSegmentsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + segments: + - id: GMNXRZVEXNQDF.CHURN_RISK + name: Lapsed + created_at: '2020-01-09T19:33:24.469Z' + updated_at: '2020-04-13T21:47:04Z' + - id: GMNXRZVEXNQDF.LOYAL + name: Regulars + created_at: '2020-01-09T19:33:24.486Z' + updated_at: '2020-04-13T21:47:04Z' + - id: GMNXRZVEXNQDF.REACHABLE + name: Reachable + created_at: '2020-01-09T19:33:21.813Z' + updated_at: '2020-04-13T21:47:04Z' + - id: gv2:KF92J19VXN5FK30GX2E8HSGQ20 + name: Instant Profile + created_at: '2020-01-09T19:33:25Z' + updated_at: '2020-04-13T23:01:03Z' + cursor: cursor + get: + path: /v2/customers/segments/{segment_id} + method: GET + auth: true + docs: >- + Retrieves a specific customer segment as identified by the `segment_id` + value. + source: + openapi: openapi/openapi.json + display-name: RetrieveCustomerSegment + request: + name: GetSegmentsRequest + path-parameters: + segment_id: + type: string + docs: The Square-issued ID of the customer segment. + response: + docs: Success + type: root.GetCustomerSegmentResponse + status-code: 200 + examples: + - path-parameters: + segment_id: segment_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + segment: + id: GMNXRZVEXNQDF.CHURN_RISK + name: Lapsed + created_at: '2020-01-09T19:33:24.469Z' + updated_at: '2020-04-13T23:01:13Z' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/devices.yml b/.mock/definition/devices.yml new file mode 100644 index 00000000..c84d268c --- /dev/null +++ b/.mock/definition/devices.yml @@ -0,0 +1,199 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/devices + method: GET + auth: true + docs: |- + List devices associated with the merchant. Currently, only Terminal API + devices are supported. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.devices + source: + openapi: openapi/openapi.json + display-name: ListDevices + request: + name: ListDevicesRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + sort_order: + type: optional> + docs: |- + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + limit: + type: optional> + docs: The number of results to return in a single page. + location_id: + type: optional> + docs: If present, only returns devices at the target location. + response: + docs: Success + type: root.ListDevicesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + devices: + - id: device:995CS397A6475287 + attributes: + type: TERMINAL + manufacturer: Square + model: T2 + name: Square Terminal 995 + manufacturers_id: 995CS397A6475287 + updated_at: '2023-09-29T13:04:56.335762883Z' + version: 5.41.0085 + merchant_token: MLCHNZCBWFDZB + components: + - type: APPLICATION + application_details: + application_type: TERMINAL_API + version: '6.25' + session_location: LMN2K7S3RTOU3 + - type: CARD_READER + card_reader_details: + version: 3.53.70 + - type: BATTERY + battery_details: + visible_percent: 5 + external_power: AVAILABLE_CHARGING + - type: WIFI + wifi_details: + active: true + ssid: Staff Network + ip_address_v4: 10.0.0.7 + secure_connection: WPA/WPA2 PSK + signal_strength: + value: 2 + - type: ETHERNET + ethernet_details: + active: false + status: + category: AVAILABLE + - id: device:995CS234B5493559 + attributes: + type: TERMINAL + manufacturer: Square + model: T2 + name: Square Terminal 995 + manufacturers_id: 995CS234B5493559 + updated_at: '2023-09-29T12:39:56.335742073Z' + version: 5.41.0085 + merchant_token: MLCHXZCBWFGDW + components: + - type: APPLICATION + application_details: + application_type: TERMINAL_API + version: '6.25' + session_location: LMN2K7S3RTOU3 + - type: CARD_READER + card_reader_details: + version: 3.53.70 + - type: BATTERY + battery_details: + visible_percent: 24 + external_power: AVAILABLE_CHARGING + - type: WIFI + wifi_details: + active: true + ssid: Staff Network + ip_address_v4: 10.0.0.7 + secure_connection: WPA/WPA2 PSK + signal_strength: + value: 2 + - type: ETHERNET + ethernet_details: + active: false + status: + category: NEEDS_ATTENTION + cursor: GcXjlV2iaizH7R0fMT6wUDbw6l4otigjzx8XOOspUKHo9EPLRByM + get: + path: /v2/devices/{device_id} + method: GET + auth: true + docs: Retrieves Device with the associated `device_id`. + source: + openapi: openapi/openapi.json + display-name: GetDevice + request: + name: GetDevicesRequest + path-parameters: + device_id: + type: string + docs: The unique ID for the desired `Device`. + response: + docs: Success + type: root.GetDeviceResponse + status-code: 200 + examples: + - path-parameters: + device_id: device_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + device: + id: device:995CS397A6475287 + attributes: + type: TERMINAL + manufacturer: Square + model: T2 + name: Square Terminal 995 + manufacturers_id: 995CS397A6475287 + updated_at: '2023-09-29T13:12:22.365049321Z' + version: 5.41.0085 + merchant_token: MLCHXZCBWFGDW + components: + - type: APPLICATION + application_details: + application_type: TERMINAL_API + version: '6.25' + session_location: LMN2K7S3RTOU3 + - type: CARD_READER + card_reader_details: + version: 3.53.70 + - type: BATTERY + battery_details: + visible_percent: 5 + external_power: AVAILABLE_CHARGING + - type: WIFI + wifi_details: + active: true + ssid: Staff Network + ip_address_v4: 10.0.0.7 + secure_connection: WPA/WPA2 PSK + signal_strength: + value: 2 + - type: ETHERNET + ethernet_details: + active: false + status: + category: AVAILABLE + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/devices/codes.yml b/.mock/definition/devices/codes.yml new file mode 100644 index 00000000..a156bb54 --- /dev/null +++ b/.mock/definition/devices/codes.yml @@ -0,0 +1,194 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/devices/codes + method: GET + auth: true + docs: Lists all DeviceCodes associated with the merchant. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.device_codes + source: + openapi: openapi/openapi.json + display-name: ListDeviceCodes + request: + name: ListCodesRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for your original + query. + + + See [Paginating + results](https://developer.squareup.com/docs/working-with-apis/pagination) + for more information. + location_id: + type: optional> + docs: |- + If specified, only returns DeviceCodes of the specified location. + Returns DeviceCodes of all locations if empty. + product_type: + type: optional> + docs: >- + If specified, only returns DeviceCodes targeting the specified + product type. + + Returns DeviceCodes of all product types if empty. + status: + type: optional> + docs: |- + If specified, returns DeviceCodes with the specified statuses. + Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty. + response: + docs: Success + type: root.ListDeviceCodesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + device_codes: + - id: B3Z6NAMYQSMTM + name: Counter 1 + code: EBCARJ + device_id: 907CS13101300122 + product_type: TERMINAL_API + location_id: B5E4484SHHNYH + status: PAIRED + pair_by: '2020-02-06T18:49:33.000Z' + created_at: '2020-02-06T18:44:33.000Z' + status_changed_at: '2020-02-06T18:47:28.000Z' + paired_at: paired_at + - id: YKGMJMYK8H4PQ + name: Unused device code + code: GVXNYN + device_id: device_id + product_type: TERMINAL_API + location_id: A6SYFRSV4WAFW + status: UNPAIRED + pair_by: '2020-02-07T20:00:04.000Z' + created_at: '2020-02-07T19:55:04.000Z' + status_changed_at: '2020-02-07T19:55:04.000Z' + paired_at: paired_at + cursor: cursor + create: + path: /v2/devices/codes + method: POST + auth: true + docs: >- + Creates a DeviceCode that can be used to login to a Square Terminal + device to enter the connected + + terminal mode. + source: + openapi: openapi/openapi.json + display-name: CreateDeviceCode + request: + name: CreateDeviceCodeRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this CreateDeviceCode request. + Keys can + + be any valid string but must be unique for every + CreateDeviceCode request. + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 128 + device_code: + type: root.DeviceCode + docs: The device code to create. + content-type: application/json + response: + docs: Success + type: root.CreateDeviceCodeResponse + status-code: 200 + examples: + - request: + idempotency_key: 01bb00a6-0c86-4770-94ed-f5fca973cd56 + device_code: + name: Counter 1 + product_type: TERMINAL_API + location_id: B5E4484SHHNYH + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + device_code: + id: B3Z6NAMYQSMTM + name: Counter 1 + code: EBCARJ + device_id: device_id + product_type: TERMINAL_API + location_id: B5E4484SHHNYH + status: UNPAIRED + pair_by: '2020-02-06T18:49:33.000Z' + created_at: '2020-02-06T18:44:33.000Z' + status_changed_at: '2020-02-06T18:44:33.000Z' + paired_at: paired_at + get: + path: /v2/devices/codes/{id} + method: GET + auth: true + docs: Retrieves DeviceCode with the associated ID. + source: + openapi: openapi/openapi.json + display-name: GetDeviceCode + request: + name: GetCodesRequest + path-parameters: + id: + type: string + docs: The unique identifier for the device code. + response: + docs: Success + type: root.GetDeviceCodeResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + device_code: + id: B3Z6NAMYQSMTM + name: Counter 1 + code: EBCARJ + device_id: 907CS13101300122 + product_type: TERMINAL_API + location_id: B5E4484SHHNYH + status: PAIRED + pair_by: '2020-02-06T18:49:33.000Z' + created_at: '2020-02-06T18:44:33.000Z' + status_changed_at: '2020-02-06T18:47:28.000Z' + paired_at: paired_at + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/disputes.yml b/.mock/definition/disputes.yml new file mode 100644 index 00000000..99824953 --- /dev/null +++ b/.mock/definition/disputes.yml @@ -0,0 +1,394 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/disputes + method: GET + auth: true + docs: Returns a list of disputes associated with a particular account. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.disputes + source: + openapi: openapi/openapi.json + display-name: ListDisputes + request: + name: ListDisputesRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + states: + type: optional> + docs: >- + The dispute states used to filter the result. If not specified, + the endpoint returns all disputes. + location_id: + type: optional> + docs: >- + The ID of the location for which to return a list of disputes. + + If not specified, the endpoint returns disputes associated with + all locations. + response: + docs: Success + type: root.ListDisputesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + disputes: + - dispute_id: dispute_id + id: XDgyFu7yo1E2S5lQGGpYn + amount_money: + amount: 2500 + currency: USD + reason: NO_KNOWLEDGE + state: ACCEPTED + due_at: '2022-07-13T00:00:00.000Z' + disputed_payment: + payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY + evidence_ids: + - evidence_ids + card_brand: VISA + created_at: '2022-06-29T18:45:22.265Z' + updated_at: '2022-07-07T19:14:42.650Z' + brand_dispute_id: '100000809947' + reported_date: reported_date + reported_at: '2022-06-29T00:00:00.000Z' + version: 2 + location_id: L1HN3ZMQK64X9 + - dispute_id: dispute_id + id: jLGg7aXC7lvKPr9PISt0T + amount_money: + amount: 2209 + currency: USD + reason: NOT_AS_DESCRIBED + state: EVIDENCE_REQUIRED + due_at: '2022-05-13T00:00:00.000Z' + disputed_payment: + payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY + evidence_ids: + - evidence_ids + card_brand: VISA + created_at: '2022-04-29T18:45:22.265Z' + updated_at: '2022-04-29T18:45:22.265Z' + brand_dispute_id: r5Of6YaGT7AdeRaVoAGCJw + reported_date: reported_date + reported_at: '2022-04-29T00:00:00.000Z' + version: 1 + location_id: 18YC4JDH91E1H + cursor: G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG + get: + path: /v2/disputes/{dispute_id} + method: GET + auth: true + docs: Returns details about a specific dispute. + source: + openapi: openapi/openapi.json + display-name: RetrieveDispute + request: + name: GetDisputesRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute you want more details about. + response: + docs: Success + type: root.GetDisputeResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + dispute: + dispute_id: dispute_id + id: XDgyFu7yo1E2S5lQGGpYn + amount_money: + amount: 2500 + currency: USD + reason: NO_KNOWLEDGE + state: ACCEPTED + due_at: '2022-07-13T00:00:00.000Z' + disputed_payment: + payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY + evidence_ids: + - evidence_ids + card_brand: VISA + created_at: '2022-06-29T18:45:22.265Z' + updated_at: '2022-07-07T19:14:42.650Z' + brand_dispute_id: '100000809947' + reported_date: reported_date + reported_at: '2022-06-29T00:00:00.000Z' + version: 2 + location_id: L1HN3ZMQK64X9 + accept: + path: /v2/disputes/{dispute_id}/accept + method: POST + auth: true + docs: >- + Accepts the loss on a dispute. Square returns the disputed amount to the + cardholder and + + updates the dispute state to ACCEPTED. + + + Square debits the disputed amount from the seller’s Square account. If + the Square account + + does not have sufficient funds, Square debits the associated bank + account. + source: + openapi: openapi/openapi.json + display-name: AcceptDispute + request: + name: AcceptDisputesRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute you want to accept. + response: + docs: Success + type: root.AcceptDisputeResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + dispute: + dispute_id: dispute_id + id: XDgyFu7yo1E2S5lQGGpYn + amount_money: + amount: 2500 + currency: USD + reason: NO_KNOWLEDGE + state: ACCEPTED + due_at: '2022-07-13T00:00:00.000Z' + disputed_payment: + payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY + evidence_ids: + - evidence_ids + card_brand: VISA + created_at: '2022-06-29T18:45:22.265Z' + updated_at: '2022-07-07T19:14:42.650Z' + brand_dispute_id: '100000809947' + reported_date: reported_date + reported_at: '2022-06-29T00:00:00.000Z' + version: 2 + location_id: L1HN3ZMQK64X9 + CreateEvidenceFile: + path: /v2/disputes/{dispute_id}/evidence-files + method: POST + auth: true + docs: >- + Uploads a file to use as evidence in a dispute challenge. The endpoint + accepts HTTP + + multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF + formats. + source: + openapi: openapi/openapi.json + display-name: CreateDisputeEvidenceFile + request: + name: CreateEvidenceFileDisputesRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute for which you want to upload evidence. + body: + properties: + request: + type: optional + content-type: application/json; charset=utf-8 + image_file: + type: optional + content-type: image/jpeg + content-type: multipart/form-data + response: + docs: Success + type: root.CreateDisputeEvidenceFileResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + evidence: + evidence_id: evidence_id + id: TOomLInj6iWmP3N8qfCXrB + dispute_id: bVTprrwk0gygTLZ96VX1oB + evidence_file: + filename: customer-interaction.jpg + filetype: image/jpeg + evidence_text: evidence_text + uploaded_at: '2022-05-18T16:01:10.000Z' + evidence_type: GENERIC_EVIDENCE + CreateEvidenceText: + path: /v2/disputes/{dispute_id}/evidence-text + method: POST + auth: true + docs: Uploads text to use as evidence for a dispute challenge. + source: + openapi: openapi/openapi.json + display-name: CreateDisputeEvidenceText + request: + name: CreateDisputeEvidenceTextRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute for which you want to upload evidence. + body: + properties: + idempotency_key: + type: string + docs: >- + A unique key identifying the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + minLength: 1 + maxLength: 45 + evidence_type: + type: optional + docs: >- + The type of evidence you are uploading. + + See [DisputeEvidenceType](#type-disputeevidencetype) for + possible values + evidence_text: + type: string + docs: The evidence string. + validation: + minLength: 1 + maxLength: 500 + content-type: application/json + response: + docs: Success + type: root.CreateDisputeEvidenceTextResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + request: + idempotency_key: ed3ee3933d946f1514d505d173c82648 + evidence_type: TRACKING_NUMBER + evidence_text: 1Z8888888888888888 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + evidence: + evidence_id: evidence_id + id: TOomLInj6iWmP3N8qfCXrB + dispute_id: bVTprrwk0gygTLZ96VX1oB + evidence_file: + filename: filename + filetype: filetype + evidence_text: >- + The customer purchased the item twice, on April 11 and April + 28. + uploaded_at: '2022-05-18T16:01:10.000Z' + evidence_type: REBUTTAL_EXPLANATION + SubmitEvidence: + path: /v2/disputes/{dispute_id}/submit-evidence + method: POST + auth: true + docs: >- + Submits evidence to the cardholder's bank. + + + The evidence submitted by this endpoint includes evidence uploaded + + using the + [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) + and + + [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) + endpoints and + + evidence automatically provided by Square, when available. Evidence + cannot be removed from + + a dispute after submission. + source: + openapi: openapi/openapi.json + display-name: SubmitEvidence + request: + name: SubmitEvidenceDisputesRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute for which you want to submit evidence. + response: + docs: Success + type: root.SubmitEvidenceResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + dispute: + dispute_id: dispute_id + id: EAZoK70gX3fyvibecLwIGB + amount_money: + amount: 4350 + currency: USD + reason: CUSTOMER_REQUESTS_CREDIT + state: PROCESSING + due_at: '2022-06-01T00:00:00.000Z' + disputed_payment: + payment_id: 2yeBUWJzllJTpmnSqtMRAL19taB + evidence_ids: + - evidence_ids + card_brand: VISA + created_at: '2022-05-18T16:02:15.313Z' + updated_at: '2022-05-18T16:02:15.313Z' + brand_dispute_id: '100000399240' + reported_date: reported_date + reported_at: '2022-05-18T00:00:00.000Z' + version: 4 + location_id: LSY8XKGSMMX94 + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/disputes/evidence.yml b/.mock/definition/disputes/evidence.yml new file mode 100644 index 00000000..8b962c77 --- /dev/null +++ b/.mock/definition/disputes/evidence.yml @@ -0,0 +1,154 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/disputes/{dispute_id}/evidence + method: GET + auth: true + docs: Returns a list of evidence associated with a dispute. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.evidence + source: + openapi: openapi/openapi.json + display-name: ListDisputeEvidence + request: + name: ListEvidenceRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute. + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListDisputeEvidenceResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + response: + body: + evidence: + - evidence_id: evidence_id + id: CpfnkwGselCwS8QFvxN6 + dispute_id: bVTprrwk0gygTLZ96VX1oB + evidence_file: + filename: customer-interaction + filetype: JPG + evidence_text: evidence_text + uploaded_at: '2022-05-10T15:57:13.802Z' + evidence_type: CARDHOLDER_COMMUNICATION + - evidence_id: evidence_id + id: TOomLInj6iWmP3N8qfCXrB + dispute_id: bVTprrwk0gygTLZ96VX1oB + evidence_file: + filename: '' + filetype: '' + evidence_text: evidence_text + uploaded_at: '2022-05-18T16:01:10.000Z' + evidence_type: REBUTTAL_EXPLANATION + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cursor: cursor + get: + path: /v2/disputes/{dispute_id}/evidence/{evidence_id} + method: GET + auth: true + docs: >- + Returns the metadata for the evidence specified in the request URL path. + + + You must maintain a copy of any evidence uploaded if you want to + reference it later. Evidence cannot be downloaded after you upload it. + source: + openapi: openapi/openapi.json + display-name: RetrieveDisputeEvidence + request: + name: GetEvidenceRequest + path-parameters: + dispute_id: + type: string + docs: >- + The ID of the dispute from which you want to retrieve evidence + metadata. + evidence_id: + type: string + docs: The ID of the evidence to retrieve. + response: + docs: Success + type: root.GetDisputeEvidenceResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + evidence_id: evidence_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + evidence: + evidence_id: evidence_id + id: TOomLInj6iWmP3N8qfCXrB + dispute_id: bVTprrwk0gygTLZ96VX1oB + evidence_file: + filename: customer-interaction.jpg + filetype: image/jpeg + evidence_text: evidence_text + uploaded_at: '2022-05-18T16:01:10.000Z' + evidence_type: CARDHOLDER_COMMUNICATION + delete: + path: /v2/disputes/{dispute_id}/evidence/{evidence_id} + method: DELETE + auth: true + docs: |- + Removes specified evidence from a dispute. + Square does not send the bank any evidence that is removed. + source: + openapi: openapi/openapi.json + display-name: DeleteDisputeEvidence + request: + name: DeleteEvidenceRequest + path-parameters: + dispute_id: + type: string + docs: The ID of the dispute from which you want to remove evidence. + evidence_id: + type: string + docs: The ID of the evidence you want to remove. + response: + docs: Success + type: root.DeleteDisputeEvidenceResponse + status-code: 200 + examples: + - path-parameters: + dispute_id: dispute_id + evidence_id: evidence_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/employees.yml b/.mock/definition/employees.yml new file mode 100644 index 00000000..9d2768d0 --- /dev/null +++ b/.mock/definition/employees.yml @@ -0,0 +1,102 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/employees + method: GET + auth: true + docs: '' + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.employees + source: + openapi: openapi/openapi.json + display-name: ListEmployees + request: + name: ListEmployeesRequest + query-parameters: + location_id: + type: optional> + docs: '' + status: + type: optional> + docs: Specifies the EmployeeStatus to filter the employee by. + limit: + type: optional> + docs: The number of employees to be returned on each page. + cursor: + type: optional> + docs: The token required to retrieve the specified page of results. + response: + docs: Success + type: root.ListEmployeesResponse + status-code: 200 + availability: deprecated + examples: + - response: + body: + employees: + - id: id + first_name: first_name + last_name: last_name + email: email + phone_number: phone_number + location_ids: + - location_ids + status: ACTIVE + is_owner: true + created_at: created_at + updated_at: updated_at + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/employees/{id} + method: GET + auth: true + docs: '' + source: + openapi: openapi/openapi.json + display-name: RetrieveEmployee + request: + name: GetEmployeesRequest + path-parameters: + id: + type: string + docs: UUID for the employee that was requested. + response: + docs: Success + type: root.GetEmployeeResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + id: id + response: + body: + employee: + id: id + first_name: first_name + last_name: last_name + email: email + phone_number: phone_number + location_ids: + - location_ids + status: ACTIVE + is_owner: true + created_at: created_at + updated_at: updated_at + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/events.yml b/.mock/definition/events.yml new file mode 100644 index 00000000..ffd7fac8 --- /dev/null +++ b/.mock/definition/events.yml @@ -0,0 +1,184 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + SearchEvents: + path: /v2/events + method: POST + auth: true + docs: Search for Square API events that occur within a 28-day timeframe. + source: + openapi: openapi/openapi.json + display-name: SearchEvents + request: + name: SearchEventsRequest + body: + properties: + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. Provide this cursor to retrieve the next set of events + for your original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + validation: + maxLength: 256 + limit: + type: optional + docs: >- + The maximum number of events to return in a single page. The + response might contain fewer events. The default value is 100, + which is also the maximum allowed value. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + + Default: 100 + validation: + min: 1 + max: 100 + query: + type: optional + docs: >- + The filtering and sorting criteria for the search request. To + retrieve additional pages using a cursor, you must use the + original query. + content-type: application/json + response: + docs: Success + type: root.SearchEventsResponse + status-code: 200 + examples: + - request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + events: + - merchant_id: 0HPGX5JYE6EE1 + location_id: VJDQQP3CG14EY + type: dispute.state.updated + event_id: 73ecd468-0aba-424f-b862-583d44efe7c8 + created_at: '2022-04-26T10:08:40.454726' + data: + type: dispute + id: ORSEVtZAJxb37RA1EiGw + object: + dispute: + amount_money: + amount: 8801 + currency: USD + brand_dispute_id: r9rKGSBBQbywBNnWWIiGFg + card_brand: VISA + created_at: '2020-02-19T21:24:53.258Z' + disputed_payment: + payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY + due_at: '2020-03-04T00:00:00.000Z' + id: ORSEVtZAJxb37RA1EiGw + location_id: VJDQQP3CG14EY + reason: AMOUNT_DIFFERS + reported_at: '2020-02-19T00:00:00.000Z' + state: WON + updated_at: '2020-02-19T21:34:41.851Z' + version: 6 + metadata: + - event_id: 73ecd468-0aba-424f-b862-583d44efe7c8 + api_version: '2022-12-13' + cursor: 6b571fc9773647f= + DisableEvents: + path: /v2/events/disable + method: PUT + auth: true + docs: >- + Disables events to prevent them from being searchable. + + All events are disabled by default. You must enable events to make them + searchable. + + Disabling events for a specific time period prevents them from being + searchable, even if you re-enable them later. + source: + openapi: openapi/openapi.json + display-name: DisableEvents + response: + docs: Success + type: root.DisableEventsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + EnableEvents: + path: /v2/events/enable + method: PUT + auth: true + docs: >- + Enables events to make them searchable. Only events that occur while in + the enabled state are searchable. + source: + openapi: openapi/openapi.json + display-name: EnableEvents + response: + docs: Success + type: root.EnableEventsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + ListEventTypes: + path: /v2/events/types + method: GET + auth: true + docs: >- + Lists all event types that you can subscribe to as webhooks or query + using the Events API. + source: + openapi: openapi/openapi.json + display-name: ListEventTypes + request: + name: ListEventTypesRequest + query-parameters: + api_version: + type: optional> + docs: >- + The API version for which to list event types. Setting this field + overrides the default version used by the application. + response: + docs: Success + type: root.ListEventTypesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + event_types: + - inventory.count.updated + metadata: + - event_type: inventory.count.updated + api_version_introduced: '2018-07-12' + release_status: PUBLIC + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/giftCards.yml b/.mock/definition/giftCards.yml new file mode 100644 index 00000000..c2151932 --- /dev/null +++ b/.mock/definition/giftCards.yml @@ -0,0 +1,468 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/gift-cards + method: GET + auth: true + docs: >- + Lists all gift cards. You can specify optional filters to retrieve + + a subset of the gift cards. Results are sorted by `created_at` in + ascending order. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.gift_cards + source: + openapi: openapi/openapi.json + display-name: ListGiftCards + request: + name: ListGiftCardsRequest + query-parameters: + type: + type: optional> + docs: >- + If a [type](entity:GiftCardType) is provided, the endpoint returns + gift cards of the specified type. + + Otherwise, the endpoint returns gift cards of all types. + state: + type: optional> + docs: >- + If a [state](entity:GiftCardStatus) is provided, the endpoint + returns the gift cards in the specified state. + + Otherwise, the endpoint returns the gift cards of all states. + limit: + type: optional> + docs: >- + If a limit is provided, the endpoint returns only the specified + number of results per page. + + The maximum value is 200. The default value is 30. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + If a cursor is not provided, the endpoint returns the first page + of the results. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + customer_id: + type: optional> + docs: >- + If a customer ID is provided, the endpoint returns only the gift + cards linked to the specified customer. + response: + docs: Success + type: root.ListGiftCardsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_cards: + - id: gftc:00113070ba5745f0b2377c1b9570cb03 + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 3900 + currency: USD + gan: '7783320008524605' + created_at: '2021-06-09T22:26:54.000Z' + customer_ids: + - customer_ids + - id: gftc:00128a12725b41e58e0de1d20497a9dd + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 2000 + currency: USD + gan: '7783320002692465' + created_at: '2021-05-20T22:26:54.000Z' + customer_ids: + - customer_ids + cursor: JbFmyvUpaNKsfC1hoLSA4WlqkgkZXTWeKuStajR5BkP7OE0ETAbeWSi6U6u7sH + create: + path: /v2/gift-cards + method: POST + auth: true + docs: >- + Creates a digital gift card or registers a physical (plastic) gift card. + The resulting gift card + + has a `PENDING` state. To activate a gift card so that it can be + redeemed for purchases, call + + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) + and create an `ACTIVATE` + + activity with the initial balance. Alternatively, you can use + [RefundPayment](api-endpoint:Refunds-RefundPayment) + + to refund a payment to the new gift card. + source: + openapi: openapi/openapi.json + display-name: CreateGiftCard + request: + name: CreateGiftCardRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 128 + location_id: + type: string + docs: >- + The ID of the [location](entity:Location) where the gift card + should be registered for + + reporting purposes. Gift cards can be redeemed at any of the + seller's locations. + validation: + minLength: 1 + gift_card: + type: root.GiftCard + docs: >- + The gift card to create. The `type` field is required for this + request. The `gan_source` + + and `gan` fields are included as follows: + + + To direct Square to generate a 16-digit GAN, omit `gan_source` + and `gan`. + + + To provide a custom GAN, include `gan_source` and `gan`. + + - For `gan_source`, specify `OTHER`. + + - For `gan`, provide a custom GAN containing 8 to 20 + alphanumeric characters. The GAN must be + + unique for the seller and cannot start with the same bank + identification number (BIN) as major + + credit cards. Do not use GANs that are easy to guess (such as + 12345678) because they greatly + + increase the risk of fraud. It is the responsibility of the + developer to ensure the security + + of their custom GANs. For more information, see + + [Custom + GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). + + + To register an unused, physical gift card that the seller + previously ordered from Square, + + include `gan` and provide the GAN that is printed on the gift + card. + content-type: application/json + response: + docs: Success + type: root.CreateGiftCardResponse + status-code: 200 + examples: + - request: + idempotency_key: NC9Tm69EjbjtConu + location_id: 81FN9BNFZTKS4 + gift_card: + type: DIGITAL + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card: + id: gftc:6cbacbb64cf54e2ca9f573d619038059 + type: DIGITAL + gan_source: SQUARE + state: PENDING + balance_money: + amount: 0 + currency: USD + gan: '7783320006753271' + created_at: '2021-05-20T22:26:54.000Z' + customer_ids: + - customer_ids + getFromGAN: + path: /v2/gift-cards/from-gan + method: POST + auth: true + docs: Retrieves a gift card using the gift card account number (GAN). + source: + openapi: openapi/openapi.json + display-name: RetrieveGiftCardFromGAN + request: + name: GetGiftCardFromGANRequest + body: + properties: + gan: + type: string + docs: >- + The gift card account number (GAN) of the gift card to retrieve. + + The maximum length of a GAN is 255 digits to account for + third-party GANs that have been imported. + + Square-issued gift cards have 16-digit GANs. + validation: + minLength: 1 + maxLength: 255 + content-type: application/json + response: + docs: Success + type: root.GetGiftCardFromGANResponse + status-code: 200 + examples: + - request: + gan: '7783320001001635' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card: + id: gftc:6944163553804e439d89adb47caf806a + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 5000 + currency: USD + gan: '7783320001001635' + created_at: '2021-05-20T22:26:54.000Z' + customer_ids: + - customer_ids + getFromNonce: + path: /v2/gift-cards/from-nonce + method: POST + auth: true + docs: >- + Retrieves a gift card using a secure payment token that represents the + gift card. + source: + openapi: openapi/openapi.json + display-name: RetrieveGiftCardFromNonce + request: + name: GetGiftCardFromNonceRequest + body: + properties: + nonce: + type: string + docs: >- + The payment token of the gift card to retrieve. Payment tokens + are generated by the + + Web Payments SDK or In-App Payments SDK. + validation: + minLength: 1 + content-type: application/json + response: + docs: Success + type: root.GetGiftCardFromNonceResponse + status-code: 200 + examples: + - request: + nonce: cnon:7783322135245171 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card: + id: gftc:6944163553804e439d89adb47caf806a + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 5000 + currency: USD + gan: '7783320001001635' + created_at: '2021-05-20T22:26:54.000Z' + customer_ids: + - customer_ids + LinkCustomer: + path: /v2/gift-cards/{gift_card_id}/link-customer + method: POST + auth: true + docs: >- + Links a customer to a gift card, which is also referred to as adding a + card on file. + source: + openapi: openapi/openapi.json + display-name: LinkCustomerToGiftCard + request: + name: LinkCustomerToGiftCardRequest + path-parameters: + gift_card_id: + type: string + docs: The ID of the gift card to be linked. + body: + properties: + customer_id: + type: string + docs: The ID of the customer to link to the gift card. + validation: + minLength: 1 + maxLength: 191 + content-type: application/json + response: + docs: Success + type: root.LinkCustomerToGiftCardResponse + status-code: 200 + examples: + - path-parameters: + gift_card_id: gift_card_id + request: + customer_id: GKY0FZ3V717AH8Q2D821PNT2ZW + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card: + id: gftc:71ea002277a34f8a945e284b04822edb + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 2500 + currency: USD + gan: '7783320005440920' + created_at: '2021-03-25T05:13:01Z' + customer_ids: + - GKY0FZ3V717AH8Q2D821PNT2ZW + UnlinkCustomer: + path: /v2/gift-cards/{gift_card_id}/unlink-customer + method: POST + auth: true + docs: >- + Unlinks a customer from a gift card, which is also referred to as + removing a card on file. + source: + openapi: openapi/openapi.json + display-name: UnlinkCustomerFromGiftCard + request: + name: UnlinkCustomerFromGiftCardRequest + path-parameters: + gift_card_id: + type: string + docs: The ID of the gift card to be unlinked. + body: + properties: + customer_id: + type: string + docs: The ID of the customer to unlink from the gift card. + validation: + minLength: 1 + maxLength: 191 + content-type: application/json + response: + docs: Success + type: root.UnlinkCustomerFromGiftCardResponse + status-code: 200 + examples: + - path-parameters: + gift_card_id: gift_card_id + request: + customer_id: GKY0FZ3V717AH8Q2D821PNT2ZW + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card: + id: gftc:71ea002277a34f8a945e284b04822edb + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 2500 + currency: USD + gan: '7783320005440920' + created_at: '2021-03-25T05:13:01Z' + customer_ids: + - customer_ids + get: + path: /v2/gift-cards/{id} + method: GET + auth: true + docs: Retrieves a gift card using the gift card ID. + source: + openapi: openapi/openapi.json + display-name: RetrieveGiftCard + request: + name: GetGiftCardsRequest + path-parameters: + id: + type: string + docs: The ID of the gift card to retrieve. + response: + docs: Success + type: root.GetGiftCardResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card: + id: gftc:00113070ba5745f0b2377c1b9570cb03 + type: DIGITAL + gan_source: SQUARE + state: ACTIVE + balance_money: + amount: 1000 + currency: USD + gan: '7783320001001635' + created_at: '2021-05-20T22:26:54.000Z' + customer_ids: + - customer_ids + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/giftCards/activities.yml b/.mock/definition/giftCards/activities.yml new file mode 100644 index 00000000..eeb6f12c --- /dev/null +++ b/.mock/definition/giftCards/activities.yml @@ -0,0 +1,320 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/gift-cards/activities + method: GET + auth: true + docs: >- + Lists gift card activities. By default, you get gift card activities for + all + + gift cards in the seller's account. You can optionally specify query + parameters to + + filter the list. For example, you can get a list of gift card activities + for a gift card, + + for all gift cards in a specific region, or for activities within a time + window. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.gift_card_activities + source: + openapi: openapi/openapi.json + display-name: ListGiftCardActivities + request: + name: ListActivitiesRequest + query-parameters: + gift_card_id: + type: optional> + docs: >- + If a gift card ID is provided, the endpoint returns activities + related + + to the specified gift card. Otherwise, the endpoint returns all + gift card activities for + + the seller. + type: + type: optional> + docs: >- + If a [type](entity:GiftCardActivityType) is provided, the endpoint + returns gift card activities of the specified type. + + Otherwise, the endpoint returns all types of gift card activities. + location_id: + type: optional> + docs: >- + If a location ID is provided, the endpoint returns gift card + activities for the specified location. + + Otherwise, the endpoint returns gift card activities for all + locations. + begin_time: + type: optional> + docs: >- + The timestamp for the beginning of the reporting period, in RFC + 3339 format. + + This start time is inclusive. The default value is the current + time minus one year. + end_time: + type: optional> + docs: >- + The timestamp for the end of the reporting period, in RFC 3339 + format. + + This end time is inclusive. The default value is the current time. + limit: + type: optional> + docs: >- + If a limit is provided, the endpoint returns the specified number + + of results (or fewer) per page. The maximum value is 100. The + default value is 50. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + If a cursor is not provided, the endpoint returns the first page + of the results. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + sort_order: + type: optional> + docs: >- + The order in which the endpoint returns the activities, based on + `created_at`. + + - `ASC` - Oldest to newest. + + - `DESC` - Newest to oldest (default). + response: + docs: Success + type: root.ListGiftCardActivitiesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card_activities: + - id: gcact_897698f894b44b3db46c6147e26a0e19 + type: REDEEM + location_id: 81FN9BNFZTKS4 + created_at: '2021-06-02T22:26:38.000Z' + gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20 + gift_card_gan: '7783320002929081' + gift_card_balance_money: + amount: 700 + currency: USD + redeem_activity_details: + amount_money: + amount: 300 + currency: USD + clear_balance_activity_details: + reason: SUSPICIOUS_ACTIVITY + deactivate_activity_details: + reason: SUSPICIOUS_ACTIVITY + adjust_increment_activity_details: + amount_money: {} + reason: COMPLIMENTARY + adjust_decrement_activity_details: + amount_money: {} + reason: SUSPICIOUS_ACTIVITY + unlinked_activity_refund_activity_details: + amount_money: {} + import_activity_details: + amount_money: {} + block_activity_details: + reason: CHARGEBACK_BLOCK + unblock_activity_details: + reason: CHARGEBACK_UNBLOCK + import_reversal_activity_details: + amount_money: {} + transfer_balance_to_activity_details: + transfer_from_gift_card_id: transfer_from_gift_card_id + amount_money: {} + transfer_balance_from_activity_details: + transfer_to_gift_card_id: transfer_to_gift_card_id + amount_money: {} + - id: gcact_b968ebfc7d46437b945be7b9e09123b4 + type: ACTIVATE + location_id: 81FN9BNFZTKS4 + created_at: '2021-05-20T22:26:54.000Z' + gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20 + gift_card_gan: '7783320002929081' + gift_card_balance_money: + amount: 1000 + currency: USD + activate_activity_details: + amount_money: + amount: 1000 + currency: USD + order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY + line_item_uid: eIWl7X0nMuO9Ewbh0ChIx + redeem_activity_details: + amount_money: {} + clear_balance_activity_details: + reason: SUSPICIOUS_ACTIVITY + deactivate_activity_details: + reason: SUSPICIOUS_ACTIVITY + adjust_increment_activity_details: + amount_money: {} + reason: COMPLIMENTARY + adjust_decrement_activity_details: + amount_money: {} + reason: SUSPICIOUS_ACTIVITY + unlinked_activity_refund_activity_details: + amount_money: {} + import_activity_details: + amount_money: {} + block_activity_details: + reason: CHARGEBACK_BLOCK + unblock_activity_details: + reason: CHARGEBACK_UNBLOCK + import_reversal_activity_details: + amount_money: {} + transfer_balance_to_activity_details: + transfer_from_gift_card_id: transfer_from_gift_card_id + amount_money: {} + transfer_balance_from_activity_details: + transfer_to_gift_card_id: transfer_to_gift_card_id + amount_money: {} + cursor: cursor + create: + path: /v2/gift-cards/activities + method: POST + auth: true + docs: >- + Creates a gift card activity to manage the balance or state of a [gift + card](entity:GiftCard). + + For example, create an `ACTIVATE` activity to activate a gift card with + an initial balance before first use. + source: + openapi: openapi/openapi.json + display-name: CreateGiftCardActivity + request: + name: CreateGiftCardActivityRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies the `CreateGiftCardActivity` + request. + validation: + minLength: 1 + maxLength: 128 + gift_card_activity: + type: root.GiftCardActivity + docs: >- + The activity to create for the gift card. This activity must + specify `gift_card_id` or `gift_card_gan` for the target + + gift card, the `location_id` where the activity occurred, and + the activity `type` along with the corresponding activity + details. + content-type: application/json + response: + docs: Success + type: root.CreateGiftCardActivityResponse + status-code: 200 + examples: + - request: + idempotency_key: U16kfr-kA70er-q4Rsym-7U7NnY + gift_card_activity: + type: ACTIVATE + location_id: 81FN9BNFZTKS4 + gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20 + activate_activity_details: + order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY + line_item_uid: eIWl7X0nMuO9Ewbh0ChIx + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + gift_card_activity: + id: gcact_c8f8cbf1f24b448d8ecf39ed03f97864 + type: ACTIVATE + location_id: 81FN9BNFZTKS4 + created_at: '2021-05-20T22:26:54.000Z' + gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20 + gift_card_gan: '7783320002929081' + gift_card_balance_money: + amount: 1000 + currency: USD + load_activity_details: + order_id: order_id + line_item_uid: line_item_uid + reference_id: reference_id + buyer_payment_instrument_ids: + - buyer_payment_instrument_ids + activate_activity_details: + amount_money: + amount: 1000 + currency: USD + order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY + line_item_uid: eIWl7X0nMuO9Ewbh0ChIx + reference_id: reference_id + buyer_payment_instrument_ids: + - buyer_payment_instrument_ids + redeem_activity_details: + amount_money: {} + payment_id: payment_id + reference_id: reference_id + status: PENDING + clear_balance_activity_details: + reason: SUSPICIOUS_ACTIVITY + deactivate_activity_details: + reason: SUSPICIOUS_ACTIVITY + adjust_increment_activity_details: + amount_money: {} + reason: COMPLIMENTARY + adjust_decrement_activity_details: + amount_money: {} + reason: SUSPICIOUS_ACTIVITY + refund_activity_details: + redeem_activity_id: redeem_activity_id + reference_id: reference_id + payment_id: payment_id + unlinked_activity_refund_activity_details: + amount_money: {} + reference_id: reference_id + payment_id: payment_id + import_activity_details: + amount_money: {} + block_activity_details: + reason: CHARGEBACK_BLOCK + unblock_activity_details: + reason: CHARGEBACK_UNBLOCK + import_reversal_activity_details: + amount_money: {} + transfer_balance_to_activity_details: + transfer_from_gift_card_id: transfer_from_gift_card_id + amount_money: {} + transfer_balance_from_activity_details: + transfer_to_gift_card_id: transfer_to_gift_card_id + amount_money: {} + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/inventory.yml b/.mock/definition/inventory.yml new file mode 100644 index 00000000..3f7460eb --- /dev/null +++ b/.mock/definition/inventory.yml @@ -0,0 +1,789 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + DeprecatedGetAdjustment: + path: /v2/inventory/adjustment/{adjustment_id} + method: GET + auth: true + docs: >- + Deprecated version of + [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) + after the endpoint URL + + is updated to conform to the standard convention. + source: + openapi: openapi/openapi.json + display-name: DeprecatedRetrieveInventoryAdjustment + request: + name: DeprecatedGetAdjustmentInventoryRequest + path-parameters: + adjustment_id: + type: string + docs: >- + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to + retrieve. + response: + docs: Success + type: root.GetInventoryAdjustmentResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + adjustment_id: adjustment_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + adjustment: + id: UDMOEO78BG6GYWA2XDRYX3KB + reference_id: 4a366069-4096-47a2-99a5-0084ac879509 + from_state: IN_STOCK + to_state: SOLD + location_id: C6W5YS5QM06F5 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + quantity: '7' + total_price_money: + amount: 4550 + currency: USD + occurred_at: '2016-11-16T25:44:22.837Z' + created_at: '2016-11-17T13:02:15.142Z' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + employee_id: employee_id + team_member_id: LRK57NSQ5X7PUD05 + transaction_id: transaction_id + refund_id: refund_id + purchase_order_id: purchase_order_id + goods_receipt_id: goods_receipt_id + adjustment_group: + id: id + root_adjustment_id: root_adjustment_id + from_state: CUSTOM + to_state: CUSTOM + getAdjustment: + path: /v2/inventory/adjustments/{adjustment_id} + method: GET + auth: true + docs: |- + Returns the [InventoryAdjustment](entity:InventoryAdjustment) object + with the provided `adjustment_id`. + source: + openapi: openapi/openapi.json + display-name: RetrieveInventoryAdjustment + request: + name: GetAdjustmentInventoryRequest + path-parameters: + adjustment_id: + type: string + docs: >- + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to + retrieve. + response: + docs: Success + type: root.GetInventoryAdjustmentResponse + status-code: 200 + examples: + - path-parameters: + adjustment_id: adjustment_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + adjustment: + id: UDMOEO78BG6GYWA2XDRYX3KB + reference_id: 4a366069-4096-47a2-99a5-0084ac879509 + from_state: IN_STOCK + to_state: SOLD + location_id: C6W5YS5QM06F5 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + quantity: '7' + total_price_money: + amount: 4550 + currency: USD + occurred_at: '2016-11-16T25:44:22.837Z' + created_at: '2016-11-17T13:02:15.142Z' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + employee_id: employee_id + team_member_id: LRK57NSQ5X7PUD05 + transaction_id: transaction_id + refund_id: refund_id + purchase_order_id: purchase_order_id + goods_receipt_id: goods_receipt_id + adjustment_group: + id: id + root_adjustment_id: root_adjustment_id + from_state: CUSTOM + to_state: CUSTOM + DeprecatedBatchChange: + path: /v2/inventory/batch-change + method: POST + auth: true + docs: >- + Deprecated version of + [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) + after the endpoint URL + + is updated to conform to the standard convention. + source: + openapi: openapi/openapi.json + display-name: DeprecatedBatchChangeInventory + request: + body: root.BatchChangeInventoryRequest + content-type: application/json + response: + docs: Success + type: root.BatchChangeInventoryResponse + status-code: 200 + availability: deprecated + examples: + - request: + idempotency_key: 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe + changes: + - type: PHYSICAL_COUNT + physical_count: + reference_id: 1536bfbf-efed-48bf-b17d-a197141b2a92 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '53' + team_member_id: LRK57NSQ5X7PUD05 + occurred_at: '2016-11-16T22:25:24.878Z' + ignore_unchanged_counts: true + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + counts: + - catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '53' + calculated_at: '2016-11-16T22:28:01.223Z' + is_estimated: true + changes: + - type: PHYSICAL_COUNT + measurement_unit_id: measurement_unit_id + DeprecatedBatchGetChanges: + path: /v2/inventory/batch-retrieve-changes + method: POST + auth: true + docs: >- + Deprecated version of + [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) + after the endpoint URL + + is updated to conform to the standard convention. + source: + openapi: openapi/openapi.json + display-name: DeprecatedBatchRetrieveInventoryChanges + request: + body: root.BatchRetrieveInventoryChangesRequest + content-type: application/json + response: + docs: Success + type: root.BatchGetInventoryChangesResponse + status-code: 200 + availability: deprecated + examples: + - request: + catalog_object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + location_ids: + - C6W5YS5QM06F5 + types: + - PHYSICAL_COUNT + states: + - IN_STOCK + updated_after: '2016-11-01T00:00:00.000Z' + updated_before: '2016-12-01T00:00:00.000Z' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + changes: + - type: PHYSICAL_COUNT + physical_count: + id: 46YDTW253DWGGK9HMAE6XCAO + reference_id: 22c07cf4-5626-4224-89f9-691112019399 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '86' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + team_member_id: LRK57NSQ5X7PUD05 + occurred_at: '2016-11-16T22:24:49.028Z' + created_at: '2016-11-16T22:25:24.878Z' + measurement_unit_id: measurement_unit_id + cursor: cursor + DeprecatedBatchGetCounts: + path: /v2/inventory/batch-retrieve-counts + method: POST + auth: true + docs: >- + Deprecated version of + [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) + after the endpoint URL + + is updated to conform to the standard convention. + source: + openapi: openapi/openapi.json + display-name: DeprecatedBatchRetrieveInventoryCounts + request: + body: root.BatchGetInventoryCountsRequest + content-type: application/json + response: + docs: Success + type: root.BatchGetInventoryCountsResponse + status-code: 200 + availability: deprecated + examples: + - request: + catalog_object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + location_ids: + - 59TNP9SA8VGDA + updated_after: '2016-11-16T00:00:00.000Z' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + counts: + - catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: 59TNP9SA8VGDA + quantity: '79' + calculated_at: '2016-11-16T22:28:01.223Z' + is_estimated: true + cursor: cursor + BatchCreateChanges: + path: /v2/inventory/changes/batch-create + method: POST + auth: true + docs: |- + Applies adjustments and counts to the provided item quantities. + + On success: returns the current calculated counts for all objects + referenced in the request. + On failure: returns a list of related errors. + source: + openapi: openapi/openapi.json + display-name: BatchChangeInventory + request: + body: root.BatchChangeInventoryRequest + content-type: application/json + response: + docs: Success + type: root.BatchChangeInventoryResponse + status-code: 200 + examples: + - request: + idempotency_key: 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe + changes: + - type: PHYSICAL_COUNT + physical_count: + reference_id: 1536bfbf-efed-48bf-b17d-a197141b2a92 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '53' + team_member_id: LRK57NSQ5X7PUD05 + occurred_at: '2016-11-16T22:25:24.878Z' + ignore_unchanged_counts: true + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + counts: + - catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '53' + calculated_at: '2016-11-16T22:28:01.223Z' + is_estimated: true + changes: + - type: PHYSICAL_COUNT + measurement_unit_id: measurement_unit_id + BatchGetChanges: + path: /v2/inventory/changes/batch-retrieve + method: POST + auth: true + docs: |- + Returns historical physical counts and adjustments based on the + provided filter criteria. + + Results are paginated and sorted in ascending order according their + `occurred_at` timestamp (oldest first). + + BatchRetrieveInventoryChanges is a catch-all query endpoint for queries + that cannot be handled by other, simpler endpoints. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.changes + source: + openapi: openapi/openapi.json + display-name: BatchRetrieveInventoryChanges + request: + body: root.BatchRetrieveInventoryChangesRequest + content-type: application/json + response: + docs: Success + type: root.BatchGetInventoryChangesResponse + status-code: 200 + examples: + - request: + catalog_object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + location_ids: + - C6W5YS5QM06F5 + types: + - PHYSICAL_COUNT + states: + - IN_STOCK + updated_after: '2016-11-01T00:00:00.000Z' + updated_before: '2016-12-01T00:00:00.000Z' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + changes: + - type: PHYSICAL_COUNT + physical_count: + id: 46YDTW253DWGGK9HMAE6XCAO + reference_id: 22c07cf4-5626-4224-89f9-691112019399 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '86' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + team_member_id: LRK57NSQ5X7PUD05 + occurred_at: '2016-11-16T22:24:49.028Z' + created_at: '2016-11-16T22:25:24.878Z' + measurement_unit_id: measurement_unit_id + cursor: cursor + BatchGetCounts: + path: /v2/inventory/counts/batch-retrieve + method: POST + auth: true + docs: >- + Returns current counts for the provided + + [CatalogObject](entity:CatalogObject)s at the requested + + [Location](entity:Location)s. + + + Results are paginated and sorted in descending order according to their + + `calculated_at` timestamp (newest first). + + + When `updated_after` is specified, only counts that have changed since + that + + time (based on the server timestamp for the most recent change) are + + returned. This allows clients to perform a "sync" operation, for example + + in response to receiving a Webhook notification. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.counts + source: + openapi: openapi/openapi.json + display-name: BatchRetrieveInventoryCounts + request: + body: root.BatchGetInventoryCountsRequest + content-type: application/json + response: + docs: Success + type: root.BatchGetInventoryCountsResponse + status-code: 200 + examples: + - request: + catalog_object_ids: + - W62UWFY35CWMYGVWK6TWJDNI + location_ids: + - 59TNP9SA8VGDA + updated_after: '2016-11-16T00:00:00.000Z' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + counts: + - catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: 59TNP9SA8VGDA + quantity: '79' + calculated_at: '2016-11-16T22:28:01.223Z' + is_estimated: true + cursor: cursor + deprecatedGetPhysicalCount: + path: /v2/inventory/physical-count/{physical_count_id} + method: GET + auth: true + docs: >- + Deprecated version of + [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) + after the endpoint URL + + is updated to conform to the standard convention. + source: + openapi: openapi/openapi.json + display-name: DeprecatedRetrieveInventoryPhysicalCount + request: + name: DeprecatedGetPhysicalCountInventoryRequest + path-parameters: + physical_count_id: + type: string + docs: >- + ID of the + + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to + retrieve. + response: + docs: Success + type: root.GetInventoryPhysicalCountResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + physical_count_id: physical_count_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + count: + id: ANZADNPLKADOJKJIUANKLMLQ + reference_id: f857ec37-f9a0-4458-8e23-5b5e0bea4e53 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '15' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + employee_id: employee_id + team_member_id: LRK57NSQ5X7PUD05 + occurred_at: '2016-11-16T22:25:24.878Z' + created_at: '2016-11-16T22:25:24.878Z' + getPhysicalCount: + path: /v2/inventory/physical-counts/{physical_count_id} + method: GET + auth: true + docs: |- + Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount) + object with the provided `physical_count_id`. + source: + openapi: openapi/openapi.json + display-name: RetrieveInventoryPhysicalCount + request: + name: GetPhysicalCountInventoryRequest + path-parameters: + physical_count_id: + type: string + docs: >- + ID of the + + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to + retrieve. + response: + docs: Success + type: root.GetInventoryPhysicalCountResponse + status-code: 200 + examples: + - path-parameters: + physical_count_id: physical_count_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + count: + id: ANZADNPLKADOJKJIUANKLMLQ + reference_id: f857ec37-f9a0-4458-8e23-5b5e0bea4e53 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '15' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + employee_id: employee_id + team_member_id: LRK57NSQ5X7PUD05 + occurred_at: '2016-11-16T22:25:24.878Z' + created_at: '2016-11-16T22:25:24.878Z' + getTransfer: + path: /v2/inventory/transfers/{transfer_id} + method: GET + auth: true + docs: |- + Returns the [InventoryTransfer](entity:InventoryTransfer) object + with the provided `transfer_id`. + source: + openapi: openapi/openapi.json + display-name: RetrieveInventoryTransfer + request: + name: GetTransferInventoryRequest + path-parameters: + transfer_id: + type: string + docs: >- + ID of the [InventoryTransfer](entity:InventoryTransfer) to + retrieve. + response: + docs: Success + type: root.GetInventoryTransferResponse + status-code: 200 + examples: + - path-parameters: + transfer_id: transfer_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + transfer: + id: UDMOEO78BG6GYWA2XDRYX3KB + reference_id: 4a366069-4096-47a2-99a5-0084ac879509 + state: IN_STOCK + from_location_id: C6W5YS5QM06F5 + to_location_id: 59TNP9SA8VGDA + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + quantity: '7' + occurred_at: '2016-11-16T25:44:22.837Z' + created_at: '2016-11-17T13:02:15.142Z' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + employee_id: employee_id + team_member_id: LRK57NSQ5X7PUD05 + get: + path: /v2/inventory/{catalog_object_id} + method: GET + auth: true + docs: |- + Retrieves the current calculated stock count for a given + [CatalogObject](entity:CatalogObject) at a given set of + [Location](entity:Location)s. Responses are paginated and unsorted. + For more sophisticated queries, use a batch endpoint. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.counts + source: + openapi: openapi/openapi.json + display-name: RetrieveInventoryCount + request: + name: GetInventoryRequest + path-parameters: + catalog_object_id: + type: string + docs: ID of the [CatalogObject](entity:CatalogObject) to retrieve. + query-parameters: + location_ids: + type: optional> + docs: >- + The [Location](entity:Location) IDs to look up as a + comma-separated + + list. An empty list queries all locations. + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for the original + query. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + response: + docs: Success + type: root.GetInventoryCountResponse + status-code: 200 + examples: + - path-parameters: + catalog_object_id: catalog_object_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + counts: + - catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + state: IN_STOCK + location_id: C6W5YS5QM06F5 + quantity: '22' + calculated_at: '2016-11-16T22:28:01.223Z' + is_estimated: true + cursor: cursor + changes: + path: /v2/inventory/{catalog_object_id}/changes + method: GET + auth: true + docs: >- + Returns a set of physical counts and inventory adjustments for the + + provided [CatalogObject](entity:CatalogObject) at the requested + + [Location](entity:Location)s. + + + You can achieve the same result by calling + [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) + + and having the `catalog_object_ids` list contain a single element of the + `CatalogObject` ID. + + + Results are paginated and sorted in descending order according to their + + `occurred_at` timestamp (newest first). + + + There are no limits on how far back the caller can page. This endpoint + can be + + used to display recent changes for a specific item. For more + + sophisticated queries, use a batch endpoint. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.changes + source: + openapi: openapi/openapi.json + display-name: RetrieveInventoryChanges + request: + name: ChangesInventoryRequest + path-parameters: + catalog_object_id: + type: string + docs: ID of the [CatalogObject](entity:CatalogObject) to retrieve. + query-parameters: + location_ids: + type: optional> + docs: >- + The [Location](entity:Location) IDs to look up as a + comma-separated + + list. An empty list queries all locations. + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for the original + query. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + response: + docs: Success + type: root.GetInventoryChangesResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + catalog_object_id: catalog_object_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + changes: + - type: ADJUSTMENT + adjustment: + id: OJKJIUANKLMLQANZADNPLKAD + reference_id: d8207693-168f-4b44-a2fd-a7ff533ddd26 + from_state: IN_STOCK + to_state: SOLD + location_id: C6W5YS5QM06F5 + catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI + catalog_object_type: ITEM_VARIATION + quantity: '3' + total_price_money: + amount: 5000 + currency: USD + occurred_at: '2016-11-16T22:25:24.878Z' + created_at: '2016-11-16T22:25:24.878Z' + source: + product: SQUARE_POS + application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0 + name: Square Point of Sale 4.37 + team_member_id: AV7YRCGI2H1J5NQ8E1XIZCNA + transaction_id: 5APV6JYK1SNCZD11AND2RX1Z + measurement_unit_id: measurement_unit_id + cursor: cursor + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/invoices.yml b/.mock/definition/invoices.yml new file mode 100644 index 00000000..969d6381 --- /dev/null +++ b/.mock/definition/invoices.yml @@ -0,0 +1,1187 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/invoices + method: GET + auth: true + docs: >- + Returns a list of invoices for a given location. The response + + is paginated. If truncated, the response includes a `cursor` that + you + + use in a subsequent request to retrieve the next set of invoices. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.invoices + source: + openapi: openapi/openapi.json + display-name: ListInvoices + request: + name: ListInvoicesRequest + query-parameters: + location_id: + type: string + docs: The ID of the location for which to list invoices. + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for your + original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: >- + The maximum number of invoices to return (200 is the maximum + `limit`). + + If not provided, the server uses a default limit of 100 invoices. + response: + docs: Success + type: root.ListInvoicesResponse + status-code: 200 + examples: + - query-parameters: + location_id: location_id + response: + body: + invoices: + - id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 1 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - uid: beebd363-e47f-4075-8785-c235aaa7df11 + relative_scheduled_days: -1 + message: Your invoice is due tomorrow + status: PENDING + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: public_url + status: DRAFT + timezone: America/Los_Angeles + created_at: '2030-01-13T17:45:13Z' + updated_at: '2030-01-13T21:24:10Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - id: inva:0-3bB9ZuDHiziThQhuC4fwWt + filename: file.jpg + description: Service contract + filesize: 102705 + hash: 273ee02cb6f5f8a3a8ca23604930dd53 + mime_type: image/jpeg + uploaded_at: '2030-01-13T21:24:10Z' + creator_team_member_id: creator_team_member_id + - id: inv:0-ChC366qAfskpGrBI_1bozs9mEA3 + version: 3 + location_id: ES0RJRZYEC39A + order_id: a65jnS8NXbfprvGJzY9F4fQTuaB + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + payment_requests: + - uid: 66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176 + request_type: DEPOSIT + due_date: '2021-01-23' + percentage_requested: '25' + tipping_enabled: false + automatic_payment_source: CARD_ON_FILE + card_id: ccof:IkWfpLj4tNHMyFii3GB + computed_amount_money: + amount: 1000 + currency: USD + total_completed_amount_money: + amount: 1000 + currency: USD + - uid: 120c5e18-4f80-4f6b-b159-774cb9bf8f99 + request_type: BALANCE + due_date: '2021-06-15' + tipping_enabled: false + automatic_payment_source: CARD_ON_FILE + card_id: ccof:IkWfpLj4tNHMyFii3GB + computed_amount_money: + amount: 3000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-455 + title: title + description: description + scheduled_at: scheduled_at + public_url: >- + https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9 + next_payment_amount_money: + amount: 3000 + currency: USD + status: PARTIALLY_PAID + timezone: America/Los_Angeles + created_at: '2021-01-23T15:29:12Z' + updated_at: '2021-01-23T15:29:56Z' + accepted_payment_methods: + card: true + square_gift_card: true + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - {} + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + cursor: ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/invoices + method: POST + auth: true + docs: >- + Creates a draft [invoice](entity:Invoice) + + for an order created using the Orders API. + + + A draft invoice remains in your account and no action is taken. + + You must publish the invoice before Square can process it (send it to + the customer's email address or charge the customer’s card on file). + source: + openapi: openapi/openapi.json + display-name: CreateInvoice + request: + name: CreateInvoiceRequest + body: + properties: + invoice: + type: root.Invoice + docs: The invoice to create. + idempotency_key: + type: optional + docs: >- + A unique string that identifies the `CreateInvoice` request. If + you do not + + provide `idempotency_key` (or provide an empty string as the + value), the endpoint + + treats each request as independent. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 128 + content-type: application/json + response: + docs: Success + type: root.CreateInvoiceResponse + status-code: 200 + examples: + - request: + invoice: + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + payment_requests: + - request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - relative_scheduled_days: -1 + message: Your invoice is due tomorrow + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + sale_or_service_date: '2030-01-24' + store_payment_method_enabled: false + idempotency_key: ce3748f9-5fc1-4762-aa12-aae5e843f1f4 + response: + body: + invoice: + id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 0 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + company_name: company_name + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - uid: beebd363-e47f-4075-8785-c235aaa7df11 + relative_scheduled_days: -1 + message: Your invoice is due tomorrow + status: PENDING + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: public_url + next_payment_amount_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: DRAFT + timezone: America/Los_Angeles + created_at: '2020-06-18T17:45:13Z' + updated_at: '2020-06-18T17:45:13Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + search: + path: /v2/invoices/search + method: POST + auth: true + docs: >- + Searches for invoices from a location specified in + + the filter. You can optionally specify customers in the filter for whom + to + + retrieve invoices. In the current implementation, you can only specify + one location and + + optionally one customer. + + + The response is paginated. If truncated, the response includes a + `cursor` + + that you use in a subsequent request to retrieve the next set of + invoices. + source: + openapi: openapi/openapi.json + display-name: SearchInvoices + request: + name: SearchInvoicesRequest + body: + properties: + query: + type: root.InvoiceQuery + docs: Describes the query criteria for searching invoices. + limit: + type: optional + docs: >- + The maximum number of invoices to return (200 is the maximum + `limit`). + + If not provided, the server uses a default limit of 100 + invoices. + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this cursor to retrieve the next set of results for your + original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + content-type: application/json + response: + docs: Success + type: root.SearchInvoicesResponse + status-code: 200 + examples: + - request: + query: + filter: + location_ids: + - ES0RJRZYEC39A + customer_ids: + - JDKYHBWT1D4F8MFH63DBMEN8Y4 + sort: + field: INVOICE_SORT_DATE + order: DESC + limit: 100 + response: + body: + invoices: + - id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 0 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - uid: beebd363-e47f-4075-8785-c235aaa7df11 + relative_scheduled_days: -1 + message: Your invoice is due tomorrow + status: PENDING + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: public_url + status: DRAFT + timezone: America/Los_Angeles + created_at: '2020-06-18T17:45:13Z' + updated_at: '2020-06-18T17:45:13Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + - id: inv:0-ChC366qAfskpGrBI_1bozs9mEA3 + version: 3 + location_id: ES0RJRZYEC39A + order_id: a65jnS8NXbfprvGJzY9F4fQTuaB + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + payment_requests: + - uid: 66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176 + request_type: DEPOSIT + due_date: '2021-01-23' + percentage_requested: '25' + tipping_enabled: false + automatic_payment_source: CARD_ON_FILE + card_id: ccof:IkWfpLj4tNHMyFii3GB + computed_amount_money: + amount: 1000 + currency: USD + total_completed_amount_money: + amount: 1000 + currency: USD + - uid: 120c5e18-4f80-4f6b-b159-774cb9bf8f99 + request_type: BALANCE + due_date: '2021-06-15' + tipping_enabled: false + automatic_payment_source: CARD_ON_FILE + card_id: ccof:IkWfpLj4tNHMyFii3GB + computed_amount_money: + amount: 3000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-455 + title: title + description: description + scheduled_at: scheduled_at + public_url: >- + https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9 + next_payment_amount_money: + amount: 3000 + currency: USD + status: PARTIALLY_PAID + timezone: America/Los_Angeles + created_at: '2021-01-23T15:29:12Z' + updated_at: '2021-01-23T15:29:56Z' + accepted_payment_methods: + card: true + square_gift_card: true + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - {} + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + cursor: ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/invoices/{invoice_id} + method: GET + auth: true + docs: Retrieves an invoice by invoice ID. + source: + openapi: openapi/openapi.json + display-name: GetInvoice + request: + name: GetInvoicesRequest + path-parameters: + invoice_id: + type: string + docs: The ID of the invoice to retrieve. + response: + docs: Success + type: root.GetInvoiceResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + response: + body: + invoice: + id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 0 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + company_name: company_name + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - uid: beebd363-e47f-4075-8785-c235aaa7df11 + relative_scheduled_days: -1 + message: Your invoice is due tomorrow + status: PENDING + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: public_url + next_payment_amount_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: DRAFT + timezone: America/Los_Angeles + created_at: '2020-06-18T17:45:13Z' + updated_at: '2020-06-18T17:45:13Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/invoices/{invoice_id} + method: PUT + auth: true + docs: >- + Updates an invoice. This endpoint supports sparse updates, so you only + need + + to specify the fields you want to change along with the required + `version` field. + + Some restrictions apply to updating invoices. For example, you cannot + change the + + `order_id` or `location_id` field. + source: + openapi: openapi/openapi.json + display-name: UpdateInvoice + request: + name: UpdateInvoiceRequest + path-parameters: + invoice_id: + type: string + docs: The ID of the invoice to update. + body: + properties: + invoice: + type: root.Invoice + docs: >- + The invoice fields to add, change, or clear. Fields can be + cleared using + + null values or the `remove` field (for individual payment + requests or reminders). + + The current invoice `version` is also required. For more + information, including requirements, + + limitations, and more examples, see [Update an + Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + idempotency_key: + type: optional> + docs: >- + A unique string that identifies the `UpdateInvoice` request. If + you do not + + provide `idempotency_key` (or provide an empty string as the + value), the endpoint + + treats each request as independent. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 128 + fields_to_clear: + type: optional>> + docs: >- + The list of fields to clear. Although this field is currently + supported, we + + recommend using null values or the `remove` field when possible. + For examples, see + + [Update an + Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + content-type: application/json + response: + docs: Success + type: root.UpdateInvoiceResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + request: + invoice: + version: 1 + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + tipping_enabled: false + idempotency_key: 4ee82288-0910-499e-ab4c-5d0071dad1be + response: + body: + invoice: + id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 2 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + company_name: company_name + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: false + automatic_payment_source: NONE + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: public_url + next_payment_amount_money: + amount: 10000 + currency: USD + status: UNPAID + timezone: America/Los_Angeles + created_at: '2020-06-18T17:45:13Z' + updated_at: '2020-06-18T18:23:11Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/invoices/{invoice_id} + method: DELETE + auth: true + docs: >- + Deletes the specified invoice. When an invoice is deleted, the + + associated order status changes to CANCELED. You can only delete a + draft + + invoice (you cannot delete a published invoice, including one that is + scheduled for processing). + source: + openapi: openapi/openapi.json + display-name: DeleteInvoice + request: + name: DeleteInvoicesRequest + path-parameters: + invoice_id: + type: string + docs: The ID of the invoice to delete. + query-parameters: + version: + type: optional> + docs: >- + The version of the [invoice](entity:Invoice) to delete. + + If you do not know the version, you can call + [GetInvoice](api-endpoint:Invoices-GetInvoice) or + + [ListInvoices](api-endpoint:Invoices-ListInvoices). + response: + docs: Success + type: root.DeleteInvoiceResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + CreateInvoiceAttachment: + path: /v2/invoices/{invoice_id}/attachments + method: POST + auth: true + docs: >- + Uploads a file and attaches it to an invoice. This endpoint accepts HTTP + multipart/form-data file uploads + + with a JSON `request` part and a `file` part. The `file` part must be a + `readable stream` that contains a file + + in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF. + + + Invoices can have up to 10 attachments with a total file size of 25 MB. + Attachments can be added only to invoices + + in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + + __NOTE:__ When testing in the Sandbox environment, the total file size + is limited to 1 KB. + source: + openapi: openapi/openapi.json + display-name: CreateInvoiceAttachment + request: + name: CreateInvoiceAttachmentRequest + path-parameters: + invoice_id: + type: string + docs: The ID of the [invoice](entity:Invoice) to attach the file to. + body: + properties: + request: + type: optional + content-type: application/json; charset=utf-8 + image_file: + type: optional + content-type: image/jpeg + content-type: multipart/form-data + response: + docs: Success + type: root.CreateInvoiceAttachmentResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + request: {} + response: + body: + attachment: + id: inva:0-3bB9ZuDHiziThQhuC4fwWt + filename: file.jpg + description: Service contract + filesize: 102705 + hash: 273ee02cb6f5f8a3a8ca23604930dd53 + mime_type: image/jpeg + uploaded_at: '2023-02-03T20:28:14Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + DeleteInvoiceAttachment: + path: /v2/invoices/{invoice_id}/attachments/{attachment_id} + method: DELETE + auth: true + docs: >- + Removes an attachment from an invoice and permanently deletes the file. + Attachments can be removed only + + from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` + state. + source: + openapi: openapi/openapi.json + display-name: DeleteInvoiceAttachment + request: + name: DeleteInvoiceAttachmentRequest + path-parameters: + invoice_id: + type: string + docs: >- + The ID of the [invoice](entity:Invoice) to delete the attachment + from. + attachment_id: + type: string + docs: The ID of the [attachment](entity:InvoiceAttachment) to delete. + response: + docs: Success + type: root.DeleteInvoiceAttachmentResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + attachment_id: attachment_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + cancel: + path: /v2/invoices/{invoice_id}/cancel + method: POST + auth: true + docs: >- + Cancels an invoice. The seller cannot collect payments for + + the canceled invoice. + + + You cannot cancel an invoice in the `DRAFT` state or in a terminal + state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`. + source: + openapi: openapi/openapi.json + display-name: CancelInvoice + request: + name: CancelInvoiceRequest + path-parameters: + invoice_id: + type: string + docs: The ID of the [invoice](entity:Invoice) to cancel. + body: + properties: + version: + type: integer + docs: >- + The version of the [invoice](entity:Invoice) to cancel. + + If you do not know the version, you can call + + [GetInvoice](api-endpoint:Invoices-GetInvoice) or + [ListInvoices](api-endpoint:Invoices-ListInvoices). + content-type: application/json + response: + docs: Success + type: root.CancelInvoiceResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + request: + version: 0 + response: + body: + invoice: + id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 1 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + company_name: company_name + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - uid: beebd363-e47f-4075-8785-c235aaa7df11 + relative_scheduled_days: -1 + message: Your invoice is due tomorrow + status: PENDING + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: public_url + next_payment_amount_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: CANCELED + timezone: America/Los_Angeles + created_at: '2020-06-18T17:45:13Z' + updated_at: '2020-06-18T18:23:11Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + publish: + path: /v2/invoices/{invoice_id}/publish + method: POST + auth: true + docs: >- + Publishes the specified draft invoice. + + + After an invoice is published, Square + + follows up based on the invoice configuration. For example, Square + + sends the invoice to the customer's email address, charges the + customer's card on file, or does + + nothing. Square also makes the invoice available on a Square-hosted + invoice page. + + + The invoice `status` also changes from `DRAFT` to a status + + based on the invoice configuration. For example, the status changes to + `UNPAID` if + + Square emails the invoice or `PARTIALLY_PAID` if Square charges a card + on file for a portion of the + + invoice amount. + + + In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` + permissions, `CUSTOMERS_READ` + + and `PAYMENTS_WRITE` are required when publishing invoices configured + for card-on-file payments. + source: + openapi: openapi/openapi.json + display-name: PublishInvoice + request: + name: PublishInvoiceRequest + path-parameters: + invoice_id: + type: string + docs: The ID of the invoice to publish. + body: + properties: + version: + type: integer + docs: >- + The version of the [invoice](entity:Invoice) to publish. + + This must match the current version of the invoice; otherwise, + the request is rejected. + idempotency_key: + type: optional> + docs: >- + A unique string that identifies the `PublishInvoice` request. If + you do not + + provide `idempotency_key` (or provide an empty string as the + value), the endpoint + + treats each request as independent. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 128 + content-type: application/json + response: + docs: Success + type: root.PublishInvoiceResponse + status-code: 200 + examples: + - path-parameters: + invoice_id: invoice_id + request: + version: 1 + idempotency_key: 32da42d0-1997-41b0-826b-f09464fc2c2e + response: + body: + invoice: + id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + version: 1 + location_id: ES0RJRZYEC39A + order_id: CAISENgvlJ6jLWAzERDzjyHVybY + primary_recipient: + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + given_name: Amelia + family_name: Earhart + email_address: Amelia.Earhart@example.com + phone_number: 1-212-555-4240 + company_name: company_name + payment_requests: + - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355 + request_type: BALANCE + due_date: '2030-01-24' + tipping_enabled: true + automatic_payment_source: NONE + reminders: + - uid: beebd363-e47f-4075-8785-c235aaa7df11 + relative_scheduled_days: -1 + message: Your invoice is due tomorrow + status: PENDING + computed_amount_money: + amount: 10000 + currency: USD + total_completed_amount_money: + amount: 0 + currency: USD + delivery_method: EMAIL + invoice_number: inv-100 + title: Event Planning Services + description: We appreciate your business! + scheduled_at: '2030-01-13T10:00:00Z' + public_url: >- + https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9 + next_payment_amount_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: SCHEDULED + timezone: America/Los_Angeles + created_at: '2020-06-18T17:45:13Z' + updated_at: '2020-06-18T18:23:11Z' + accepted_payment_methods: + card: true + square_gift_card: false + bank_account: false + buy_now_pay_later: false + cash_app_pay: false + custom_fields: + - label: Event Reference Number + value: 'Ref. #1234' + placement: ABOVE_LINE_ITEMS + - label: Terms of Service + value: The terms of service are... + placement: BELOW_LINE_ITEMS + subscription_id: subscription_id + sale_or_service_date: '2030-01-24' + payment_conditions: payment_conditions + store_payment_method_enabled: false + attachments: + - {} + creator_team_member_id: creator_team_member_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/labor/breakTypes.yml b/.mock/definition/labor/breakTypes.yml new file mode 100644 index 00000000..921558e9 --- /dev/null +++ b/.mock/definition/labor/breakTypes.yml @@ -0,0 +1,265 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/labor/break-types + method: GET + auth: true + docs: Returns a paginated list of `BreakType` instances for a business. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.break_types + source: + openapi: openapi/openapi.json + display-name: ListBreakTypes + request: + name: ListBreakTypesRequest + query-parameters: + location_id: + type: optional> + docs: >- + Filter the returned `BreakType` results to only those that are + associated with the + + specified location. + limit: + type: optional> + docs: >- + The maximum number of `BreakType` results to return per page. The + number can range between 1 + + and 200. The default is 200. + cursor: + type: optional> + docs: A pointer to the next page of `BreakType` results to fetch. + response: + docs: Success + type: root.ListBreakTypesResponse + status-code: 200 + examples: + - response: + body: + break_types: + - id: REGS1EQR1TPZ5 + location_id: PAA1RJZZKXBFG + break_name: Coffee Break + expected_duration: PT5M + is_paid: false + version: 1 + created_at: '2019-01-22T20:47:37Z' + updated_at: '2019-01-22T20:47:37Z' + - id: 92EPDRQKJ5088 + location_id: PAA1RJZZKXBFG + break_name: Lunch Break + expected_duration: PT1H + is_paid: true + version: 3 + created_at: '2019-01-25T19:26:30Z' + updated_at: '2019-01-25T19:26:30Z' + cursor: 2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/labor/break-types + method: POST + auth: true + docs: >- + Creates a new `BreakType`. + + + A `BreakType` is a template for creating `Break` objects. + + You must provide the following values in your request to this + + endpoint: + + + - `location_id` + + - `break_name` + + - `expected_duration` + + - `is_paid` + + + You can only have three `BreakType` instances per location. If you + attempt to add a fourth + + `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit + of 3 breaks per location." + + is returned. + source: + openapi: openapi/openapi.json + display-name: CreateBreakType + request: + name: CreateBreakTypeRequest + body: + properties: + idempotency_key: + type: optional + docs: >- + A unique string value to ensure the idempotency of the + operation. + validation: + maxLength: 128 + break_type: + type: root.BreakType + docs: The `BreakType` to be created. + content-type: application/json + response: + docs: Success + type: root.CreateBreakTypeResponse + status-code: 200 + examples: + - request: + idempotency_key: PAD3NG5KSN2GL + break_type: + location_id: CGJN03P1D08GF + break_name: Lunch Break + expected_duration: PT30M + is_paid: true + response: + body: + break_type: + id: 49SSVDJG76WF3 + location_id: CGJN03P1D08GF + break_name: Lunch Break + expected_duration: PT30M + is_paid: true + version: 1 + created_at: '2019-02-26T22:42:54Z' + updated_at: '2019-02-26T22:42:54Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/labor/break-types/{id} + method: GET + auth: true + docs: Returns a single `BreakType` specified by `id`. + source: + openapi: openapi/openapi.json + display-name: GetBreakType + request: + name: GetBreakTypesRequest + path-parameters: + id: + type: string + docs: The UUID for the `BreakType` being retrieved. + response: + docs: Success + type: root.GetBreakTypeResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + break_type: + id: lA0mj_RSOprNPwMUXdYp + location_id: 059SB0E0WCNWS + break_name: Lunch Break + expected_duration: PT30M + is_paid: true + version: 1 + created_at: '2019-02-21T17:50:00Z' + updated_at: '2019-02-21T17:50:00Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/labor/break-types/{id} + method: PUT + auth: true + docs: Updates an existing `BreakType`. + source: + openapi: openapi/openapi.json + display-name: UpdateBreakType + request: + name: UpdateBreakTypeRequest + path-parameters: + id: + type: string + docs: ' The UUID for the `BreakType` being updated.' + body: + properties: + break_type: + type: root.BreakType + docs: The updated `BreakType`. + content-type: application/json + response: + docs: Success + type: root.UpdateBreakTypeResponse + status-code: 200 + examples: + - path-parameters: + id: id + request: + break_type: + location_id: 26M7H24AZ9N6R + break_name: Lunch + expected_duration: PT50M + is_paid: true + version: 1 + response: + body: + break_type: + id: Q6JSJS6D4DBCH + location_id: 26M7H24AZ9N6R + break_name: Lunch + expected_duration: PT50M + is_paid: true + version: 2 + created_at: '2018-06-12T20:19:12Z' + updated_at: '2019-02-26T23:12:59Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/labor/break-types/{id} + method: DELETE + auth: true + docs: |- + Deletes an existing `BreakType`. + + A `BreakType` can be deleted even if it is referenced from a `Shift`. + source: + openapi: openapi/openapi.json + display-name: DeleteBreakType + request: + name: DeleteBreakTypesRequest + path-parameters: + id: + type: string + docs: The UUID for the `BreakType` being deleted. + response: + docs: Success + type: root.DeleteBreakTypeResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/labor/employeeWages.yml b/.mock/definition/labor/employeeWages.yml new file mode 100644 index 00000000..6d1b740b --- /dev/null +++ b/.mock/definition/labor/employeeWages.yml @@ -0,0 +1,113 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/labor/employee-wages + method: GET + auth: true + docs: Returns a paginated list of `EmployeeWage` instances for a business. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.employee_wages + source: + openapi: openapi/openapi.json + display-name: ListEmployeeWages + request: + name: ListEmployeeWagesRequest + query-parameters: + employee_id: + type: optional> + docs: >- + Filter the returned wages to only those that are associated with + the specified employee. + limit: + type: optional> + docs: >- + The maximum number of `EmployeeWage` results to return per page. + The number can range between + + 1 and 200. The default is 200. + cursor: + type: optional> + docs: A pointer to the next page of `EmployeeWage` results to fetch. + response: + docs: Success + type: root.ListEmployeeWagesResponse + status-code: 200 + availability: deprecated + examples: + - response: + body: + employee_wages: + - id: pXS3qCv7BERPnEGedM4S8mhm + employee_id: 33fJchumvVdJwxV0H6L9 + title: Manager + hourly_rate: + amount: 3250 + currency: USD + - id: rZduCkzYDUVL3ovh1sQgbue6 + employee_id: 33fJchumvVdJwxV0H6L9 + title: Cook + hourly_rate: + amount: 2600 + currency: USD + - id: FxLbs5KpPUHa8wyt5ctjubDX + employee_id: 33fJchumvVdJwxV0H6L9 + title: Barista + hourly_rate: + amount: 1600 + currency: USD + - id: vD1wCgijMDR3cX5TPnu7VXto + employee_id: 33fJchumvVdJwxV0H6L9 + title: Cashier + hourly_rate: + amount: 1700 + currency: USD + cursor: 2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/labor/employee-wages/{id} + method: GET + auth: true + docs: Returns a single `EmployeeWage` specified by `id`. + source: + openapi: openapi/openapi.json + display-name: GetEmployeeWage + request: + name: GetEmployeeWagesRequest + path-parameters: + id: + type: string + docs: The UUID for the `EmployeeWage` being retrieved. + response: + docs: Success + type: root.GetEmployeeWageResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + id: id + response: + body: + employee_wage: + id: pXS3qCv7BERPnEGedM4S8mhm + employee_id: 33fJchumvVdJwxV0H6L9 + title: Manager + hourly_rate: + amount: 2000 + currency: USD + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/labor/shifts.yml b/.mock/definition/labor/shifts.yml new file mode 100644 index 00000000..85647a69 --- /dev/null +++ b/.mock/definition/labor/shifts.yml @@ -0,0 +1,446 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/labor/shifts + method: POST + auth: true + docs: >- + Creates a new `Shift`. + + + A `Shift` represents a complete workday for a single team member. + + You must provide the following values in your request to this + + endpoint: + + + - `location_id` + + - `team_member_id` + + - `start_at` + + + An attempt to create a new `Shift` can result in a `BAD_REQUEST` error + when: + + - The `status` of the new `Shift` is `OPEN` and the team member has + another + + shift with an `OPEN` status. + + - The `start_at` date is in the future. + + - The `start_at` or `end_at` date overlaps another shift for the same + team member. + + - The `Break` instances are set in the request and a break `start_at` + + is before the `Shift.start_at`, a break `end_at` is after + + the `Shift.end_at`, or both. + source: + openapi: openapi/openapi.json + display-name: CreateShift + request: + name: CreateShiftRequest + body: + properties: + idempotency_key: + type: optional + docs: >- + A unique string value to ensure the idempotency of the + operation. + validation: + maxLength: 128 + shift: + type: root.Shift + docs: The `Shift` to be created. + content-type: application/json + response: + docs: Success + type: root.CreateShiftResponse + status-code: 200 + examples: + - request: + idempotency_key: HIDSNG5KS478L + shift: + location_id: PAA1RJZZKXBFG + start_at: '2019-01-25T03:11:00-05:00' + end_at: '2019-01-25T13:11:00-05:00' + wage: + title: Barista + hourly_rate: + amount: 1100 + currency: USD + tip_eligible: true + breaks: + - start_at: '2019-01-25T06:11:00-05:00' + end_at: '2019-01-25T06:16:00-05:00' + break_type_id: REGS1EQR1TPZ5 + name: Tea Break + expected_duration: PT5M + is_paid: true + team_member_id: ormj0jJJZ5OZIzxrZYJI + declared_cash_tip_money: + amount: 500 + currency: USD + response: + body: + shift: + id: K0YH4CV5462JB + employee_id: ormj0jJJZ5OZIzxrZYJI + location_id: PAA1RJZZKXBFG + timezone: America/New_York + start_at: '2019-01-25T03:11:00-05:00' + end_at: '2019-01-25T13:11:00-05:00' + wage: + title: Barista + hourly_rate: + amount: 1100 + currency: USD + job_id: FzbJAtt9qEWncK1BWgVCxQ6M + tip_eligible: true + breaks: + - id: X7GAQYVVRRG6P + start_at: '2019-01-25T06:11:00-05:00' + end_at: '2019-01-25T06:16:00-05:00' + break_type_id: REGS1EQR1TPZ5 + name: Tea Break + expected_duration: PT5M + is_paid: true + status: CLOSED + version: 1 + created_at: '2019-02-28T00:39:02Z' + updated_at: '2019-02-28T00:39:02Z' + team_member_id: ormj0jJJZ5OZIzxrZYJI + declared_cash_tip_money: + amount: 500 + currency: USD + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + search: + path: /v2/labor/shifts/search + method: POST + auth: true + docs: |- + Returns a paginated list of `Shift` records for a business. + The list to be returned can be filtered by: + - Location IDs + - Team member IDs + - Shift status (`OPEN` or `CLOSED`) + - Shift start + - Shift end + - Workday details + + The list can be sorted by: + - `START_AT` + - `END_AT` + - `CREATED_AT` + - `UPDATED_AT` + source: + openapi: openapi/openapi.json + display-name: SearchShifts + request: + name: SearchShiftsRequest + body: + properties: + query: + type: optional + docs: Query filters. + limit: + type: optional + docs: The number of resources in a page (200 by default). + validation: + min: 1 + max: 200 + cursor: + type: optional + docs: An opaque cursor for fetching the next page. + content-type: application/json + response: + docs: Success + type: root.SearchShiftsResponse + status-code: 200 + examples: + - request: + query: + filter: + workday: + date_range: + start_date: '2019-01-20' + end_date: '2019-02-03' + match_shifts_by: START_AT + default_timezone: America/Los_Angeles + limit: 100 + response: + body: + shifts: + - id: X714F3HA6D1PT + employee_id: ormj0jJJZ5OZIzxrZYJI + location_id: PAA1RJZZKXBFG + timezone: America/New_York + start_at: '2019-01-21T03:11:00-05:00' + end_at: '2019-01-21T13:11:00-05:00' + wage: + title: Barista + hourly_rate: + amount: 1100 + currency: USD + job_id: FzbJAtt9qEWncK1BWgVCxQ6M + tip_eligible: true + breaks: + - id: SJW7X6AKEJQ65 + start_at: '2019-01-21T06:11:00-05:00' + end_at: '2019-01-21T06:11:00-05:00' + break_type_id: REGS1EQR1TPZ5 + name: Tea Break + expected_duration: PT10M + is_paid: true + status: CLOSED + version: 6 + created_at: '2019-01-24T01:12:03Z' + updated_at: '2019-02-07T22:21:08Z' + team_member_id: ormj0jJJZ5OZIzxrZYJI + declared_cash_tip_money: + amount: 500 + currency: USD + - id: GDHYBZYWK0P2V + employee_id: 33fJchumvVdJwxV0H6L9 + location_id: PAA1RJZZKXBFG + timezone: America/New_York + start_at: '2019-01-22T12:02:00-05:00' + end_at: '2019-01-22T13:02:00-05:00' + wage: + title: Cook + hourly_rate: + amount: 1600 + currency: USD + job_id: gcbz15vKGnMKmaWJJ152kjim + tip_eligible: true + breaks: + - id: BKS6VR7WR748A + start_at: '2019-01-23T14:30:00-05:00' + end_at: '2019-01-23T14:40:00-05:00' + break_type_id: WQX00VR99F53J + name: Tea Break + expected_duration: PT10M + is_paid: true + - id: BQFEZSHFZSC51 + start_at: '2019-01-22T12:30:00-05:00' + end_at: '2019-01-22T12:44:00-05:00' + break_type_id: P6Q468ZFRN1AC + name: Coffee Break + expected_duration: PT15M + is_paid: false + status: CLOSED + version: 16 + created_at: '2019-01-23T23:32:45Z' + updated_at: '2019-01-24T00:56:25Z' + team_member_id: 33fJchumvVdJwxV0H6L9 + declared_cash_tip_money: + amount: 0 + currency: USD + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/labor/shifts/{id} + method: GET + auth: true + docs: Returns a single `Shift` specified by `id`. + source: + openapi: openapi/openapi.json + display-name: GetShift + request: + name: GetShiftsRequest + path-parameters: + id: + type: string + docs: The UUID for the `Shift` being retrieved. + response: + docs: Success + type: root.GetShiftResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + shift: + id: T35HMQSN89SV4 + employee_id: D71KRMQof6cXGUW0aAv7 + location_id: PAA1RJZZKXBFG + timezone: America/New_York + start_at: '2019-02-23T18:00:00-05:00' + end_at: '2019-02-23T21:00:00-05:00' + wage: + title: Cashier + hourly_rate: + amount: 1457 + currency: USD + job_id: N4YKVLzFj3oGtNocqoYHYpW3 + tip_eligible: true + breaks: + - id: M9BBKEPQAQD2T + start_at: '2019-02-23T19:00:00-05:00' + end_at: '2019-02-23T20:00:00-05:00' + break_type_id: 92EPDRQKJ5088 + name: Lunch Break + expected_duration: PT1H + is_paid: true + status: CLOSED + version: 1 + created_at: '2019-02-27T00:12:12Z' + updated_at: '2019-02-27T00:12:12Z' + team_member_id: D71KRMQof6cXGUW0aAv7 + declared_cash_tip_money: + amount: 500 + currency: USD + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/labor/shifts/{id} + method: PUT + auth: true + docs: >- + Updates an existing `Shift`. + + + When adding a `Break` to a `Shift`, any earlier `Break` instances in the + `Shift` have + + the `end_at` property set to a valid RFC-3339 datetime string. + + + When closing a `Shift`, all `Break` instances in the `Shift` must be + complete with `end_at` + + set on each `Break`. + source: + openapi: openapi/openapi.json + display-name: UpdateShift + request: + name: UpdateShiftRequest + path-parameters: + id: + type: string + docs: The ID of the object being updated. + body: + properties: + shift: + type: root.Shift + docs: The updated `Shift` object. + content-type: application/json + response: + docs: Success + type: root.UpdateShiftResponse + status-code: 200 + examples: + - path-parameters: + id: id + request: + shift: + location_id: PAA1RJZZKXBFG + start_at: '2019-01-25T03:11:00-05:00' + end_at: '2019-01-25T13:11:00-05:00' + wage: + title: Bartender + hourly_rate: + amount: 1500 + currency: USD + tip_eligible: true + breaks: + - id: X7GAQYVVRRG6P + start_at: '2019-01-25T06:11:00-05:00' + end_at: '2019-01-25T06:16:00-05:00' + break_type_id: REGS1EQR1TPZ5 + name: Tea Break + expected_duration: PT5M + is_paid: true + version: 1 + team_member_id: ormj0jJJZ5OZIzxrZYJI + declared_cash_tip_money: + amount: 500 + currency: USD + response: + body: + shift: + id: K0YH4CV5462JB + employee_id: ormj0jJJZ5OZIzxrZYJI + location_id: PAA1RJZZKXBFG + timezone: America/New_York + start_at: '2019-01-25T03:11:00-05:00' + end_at: '2019-01-25T13:11:00-05:00' + wage: + title: Bartender + hourly_rate: + amount: 1500 + currency: USD + job_id: dZtrPh5GSDGugyXGByesVp51 + tip_eligible: true + breaks: + - id: X7GAQYVVRRG6P + start_at: '2019-01-25T06:11:00-05:00' + end_at: '2019-01-25T06:16:00-05:00' + break_type_id: REGS1EQR1TPZ5 + name: Tea Break + expected_duration: PT5M + is_paid: true + status: CLOSED + version: 2 + created_at: '2019-02-28T00:39:02Z' + updated_at: '2019-02-28T00:42:41Z' + team_member_id: ormj0jJJZ5OZIzxrZYJI + declared_cash_tip_money: + amount: 500 + currency: USD + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/labor/shifts/{id} + method: DELETE + auth: true + docs: Deletes a `Shift`. + source: + openapi: openapi/openapi.json + display-name: DeleteShift + request: + name: DeleteShiftsRequest + path-parameters: + id: + type: string + docs: The UUID for the `Shift` being deleted. + response: + docs: Success + type: root.DeleteShiftResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/labor/teamMemberWages.yml b/.mock/definition/labor/teamMemberWages.yml new file mode 100644 index 00000000..8aa34b3a --- /dev/null +++ b/.mock/definition/labor/teamMemberWages.yml @@ -0,0 +1,123 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/labor/team-member-wages + method: GET + auth: true + docs: Returns a paginated list of `TeamMemberWage` instances for a business. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.team_member_wages + source: + openapi: openapi/openapi.json + display-name: ListTeamMemberWages + request: + name: ListTeamMemberWagesRequest + query-parameters: + team_member_id: + type: optional> + docs: >- + Filter the returned wages to only those that are associated with + the + + specified team member. + limit: + type: optional> + docs: >- + The maximum number of `TeamMemberWage` results to return per page. + The number can range between + + 1 and 200. The default is 200. + cursor: + type: optional> + docs: A pointer to the next page of `EmployeeWage` results to fetch. + response: + docs: Success + type: root.ListTeamMemberWagesResponse + status-code: 200 + examples: + - response: + body: + team_member_wages: + - id: pXS3qCv7BERPnEGedM4S8mhm + team_member_id: 33fJchumvVdJwxV0H6L9 + title: Manager + hourly_rate: + amount: 3250 + currency: USD + job_id: jxJNN6eCJsLrhg5UFJrDWDGE + tip_eligible: false + - id: rZduCkzYDUVL3ovh1sQgbue6 + team_member_id: 33fJchumvVdJwxV0H6L9 + title: Cook + hourly_rate: + amount: 2600 + currency: USD + job_id: gcbz15vKGnMKmaWJJ152kjim + tip_eligible: true + - id: FxLbs5KpPUHa8wyt5ctjubDX + team_member_id: 33fJchumvVdJwxV0H6L9 + title: Barista + hourly_rate: + amount: 1600 + currency: USD + job_id: FzbJAtt9qEWncK1BWgVCxQ6M + tip_eligible: true + - id: vD1wCgijMDR3cX5TPnu7VXto + team_member_id: 33fJchumvVdJwxV0H6L9 + title: Cashier + hourly_rate: + amount: 1700 + currency: USD + job_id: N4YKVLzFj3oGtNocqoYHYpW3 + tip_eligible: true + cursor: 2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/labor/team-member-wages/{id} + method: GET + auth: true + docs: Returns a single `TeamMemberWage` specified by `id`. + source: + openapi: openapi/openapi.json + display-name: GetTeamMemberWage + request: + name: GetTeamMemberWagesRequest + path-parameters: + id: + type: string + docs: The UUID for the `TeamMemberWage` being retrieved. + response: + docs: Success + type: root.GetTeamMemberWageResponse + status-code: 200 + examples: + - path-parameters: + id: id + response: + body: + team_member_wage: + id: pXS3qCv7BERPnEGedM4S8mhm + team_member_id: 33fJchumvVdJwxV0H6L9 + title: Manager + hourly_rate: + amount: 2000 + currency: USD + job_id: jxJNN6eCJsLrhg5UFJrDWDGE + tip_eligible: false + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/labor/workweekConfigs.yml b/.mock/definition/labor/workweekConfigs.yml new file mode 100644 index 00000000..8e6e0c12 --- /dev/null +++ b/.mock/definition/labor/workweekConfigs.yml @@ -0,0 +1,97 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/labor/workweek-configs + method: GET + auth: true + docs: Returns a list of `WorkweekConfig` instances for a business. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.workweek_configs + source: + openapi: openapi/openapi.json + display-name: ListWorkweekConfigs + request: + name: ListWorkweekConfigsRequest + query-parameters: + limit: + type: optional> + docs: >- + The maximum number of `WorkweekConfigs` results to return per + page. + cursor: + type: optional> + docs: A pointer to the next page of `WorkweekConfig` results to fetch. + response: + docs: Success + type: root.ListWorkweekConfigsResponse + status-code: 200 + examples: + - response: + body: + workweek_configs: + - id: FY4VCAQN700GM + start_of_week: MON + start_of_day_local_time: '10:00' + version: 11 + created_at: '2016-02-04T00:58:24Z' + updated_at: '2019-02-28T01:04:35Z' + cursor: 2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/labor/workweek-configs/{id} + method: PUT + auth: true + docs: Updates a `WorkweekConfig`. + source: + openapi: openapi/openapi.json + display-name: UpdateWorkweekConfig + request: + name: UpdateWorkweekConfigRequest + path-parameters: + id: + type: string + docs: The UUID for the `WorkweekConfig` object being updated. + body: + properties: + workweek_config: + type: root.WorkweekConfig + docs: The updated `WorkweekConfig` object. + content-type: application/json + response: + docs: Success + type: root.UpdateWorkweekConfigResponse + status-code: 200 + examples: + - path-parameters: + id: id + request: + workweek_config: + start_of_week: MON + start_of_day_local_time: '10:00' + version: 10 + response: + body: + workweek_config: + id: FY4VCAQN700GM + start_of_week: MON + start_of_day_local_time: '10:00' + version: 11 + created_at: '2016-02-04T00:58:24Z' + updated_at: '2019-02-28T01:04:35Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/locations.yml b/.mock/definition/locations.yml new file mode 100644 index 00000000..4c02572d --- /dev/null +++ b/.mock/definition/locations.yml @@ -0,0 +1,787 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/locations + method: GET + auth: true + docs: >- + Provides details about all of the seller's + [locations](https://developer.squareup.com/docs/locations-api), + + including those with an inactive status. Locations are listed + alphabetically by `name`. + source: + openapi: openapi/openapi.json + display-name: ListLocations + response: + docs: Success + type: root.ListLocationsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + locations: + - id: 18YC4JDH91E1H + name: Grant Park + address: + address_line_1: 123 Main St + locality: San Francisco + administrative_district_level_1: CA + postal_code: '94114' + country: US + timezone: America/Los_Angeles + capabilities: + - CREDIT_CARD_PROCESSING + status: ACTIVE + created_at: '2016-09-19T17:33:12Z' + merchant_id: 3MYCJG5GVYQ8Q + country: US + language_code: en-US + currency: USD + phone_number: +1 650-354-7217 + business_name: Jet Fuel Coffee + type: PHYSICAL + website_url: website_url + business_email: business_email + description: description + twitter_username: twitter_username + instagram_username: instagram_username + facebook_url: facebook_url + logo_url: logo_url + pos_background_url: pos_background_url + mcc: mcc + full_format_logo_url: full_format_logo_url + - id: 3Z4V4WHQK64X9 + name: Midtown + address: + address_line_1: 1234 Peachtree St. NE + locality: Atlanta + administrative_district_level_1: GA + postal_code: '30309' + timezone: America/New_York + capabilities: + - CREDIT_CARD_PROCESSING + status: ACTIVE + created_at: '2022-02-19T17:58:25Z' + merchant_id: 3MYCJG5GVYQ8Q + country: US + language_code: en-US + currency: USD + phone_number: phone_number + business_name: Jet Fuel Coffee + type: PHYSICAL + website_url: website_url + business_email: business_email + description: Midtown Atlanta store + twitter_username: twitter_username + instagram_username: instagram_username + facebook_url: facebook_url + coordinates: + latitude: 33.7889 + longitude: -84.3841 + logo_url: logo_url + pos_background_url: pos_background_url + mcc: '7299' + full_format_logo_url: full_format_logo_url + create: + path: /v2/locations + method: POST + auth: true + docs: >- + Creates a [location](https://developer.squareup.com/docs/locations-api). + + Creating new locations allows for separate configuration of receipt + layouts, item prices, + + and sales reports. Developers can use locations to separate sales + activity through applications + + that integrate with Square from sales activity elsewhere in a seller's + account. + + Locations created programmatically with the Locations API last forever + and + + are visible to the seller for their own management. Therefore, ensure + that + + each location has a sensible and unique name. + source: + openapi: openapi/openapi.json + display-name: CreateLocation + request: + name: CreateLocationRequest + body: + properties: + location: + type: optional + docs: >- + The initial values of the location being created. The `name` + field is required and must be unique within a seller account. + + All other fields are optional, but any information you care + about for the location should be included. + + The remaining fields are automatically added based on the data + from the [main + location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + content-type: application/json + response: + docs: Success + type: root.CreateLocationResponse + status-code: 200 + examples: + - request: + location: + name: Midtown + address: + address_line_1: 1234 Peachtree St. NE + locality: Atlanta + administrative_district_level_1: GA + postal_code: '30309' + description: Midtown Atlanta store + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + location: + id: 3Z4V4WHQK64X9 + name: Midtown + address: + address_line_1: 1234 Peachtree St. NE + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: Atlanta + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: GA + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '30309' + country: ZZ + first_name: first_name + last_name: last_name + timezone: America/New_York + capabilities: + - CREDIT_CARD_PROCESSING + status: ACTIVE + created_at: '2022-02-19T17:58:25Z' + merchant_id: 3MYCJG5GVYQ8Q + country: US + language_code: en-US + currency: USD + phone_number: phone_number + business_name: Jet Fuel Coffee + type: PHYSICAL + website_url: website_url + business_hours: + periods: + - {} + business_email: business_email + description: Midtown Atlanta store + twitter_username: twitter_username + instagram_username: instagram_username + facebook_url: facebook_url + coordinates: + latitude: 33.7889 + longitude: -84.3841 + logo_url: logo_url + pos_background_url: pos_background_url + mcc: '7299' + full_format_logo_url: full_format_logo_url + tax_ids: + eu_vat: eu_vat + fr_siret: fr_siret + fr_naf: fr_naf + es_nif: es_nif + jp_qii: jp_qii + get: + path: /v2/locations/{location_id} + method: GET + auth: true + docs: >- + Retrieves details of a single location. Specify "main" + + as the location ID to retrieve details of the [main + location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + source: + openapi: openapi/openapi.json + display-name: RetrieveLocation + request: + name: GetLocationsRequest + path-parameters: + location_id: + type: string + docs: |- + The ID of the location to retrieve. Specify the string + "main" to return the main location. + response: + docs: Success + type: root.GetLocationResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + location: + id: 18YC4JDH91E1H + name: Grant Park + address: + address_line_1: 123 Main St + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: San Francisco + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: CA + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '94114' + country: US + first_name: first_name + last_name: last_name + timezone: America/Los_Angeles + capabilities: + - CREDIT_CARD_PROCESSING + status: ACTIVE + created_at: '2016-09-19T17:33:12Z' + merchant_id: 3MYCJG5GVYQ8Q + country: US + language_code: en-US + currency: USD + phone_number: +1 650-354-7217 + business_name: Jet Fuel Coffee + type: PHYSICAL + website_url: website_url + business_hours: + periods: + - {} + business_email: business_email + description: description + twitter_username: twitter_username + instagram_username: instagram_username + facebook_url: facebook_url + coordinates: + latitude: 1.1 + longitude: 1.1 + logo_url: logo_url + pos_background_url: pos_background_url + mcc: mcc + full_format_logo_url: full_format_logo_url + tax_ids: + eu_vat: eu_vat + fr_siret: fr_siret + fr_naf: fr_naf + es_nif: es_nif + jp_qii: jp_qii + update: + path: /v2/locations/{location_id} + method: PUT + auth: true + docs: Updates a [location](https://developer.squareup.com/docs/locations-api). + source: + openapi: openapi/openapi.json + display-name: UpdateLocation + request: + name: UpdateLocationRequest + path-parameters: + location_id: + type: string + docs: The ID of the location to update. + body: + properties: + location: + type: optional + docs: The `Location` object with only the fields to update. + content-type: application/json + response: + docs: Success + type: root.UpdateLocationResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + request: + location: + business_hours: + periods: + - day_of_week: FRI + start_local_time: '07:00' + end_local_time: '18:00' + - day_of_week: SAT + start_local_time: '07:00' + end_local_time: '18:00' + - day_of_week: SUN + start_local_time: '09:00' + end_local_time: '15:00' + description: Midtown Atlanta store - Open weekends + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + location: + id: 3Z4V4WHQK64X9 + name: Midtown + address: + address_line_1: 1234 Peachtree St. NE + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: Atlanta + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: GA + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '30309' + country: ZZ + first_name: first_name + last_name: last_name + timezone: America/New_York + capabilities: + - CREDIT_CARD_PROCESSING + status: ACTIVE + created_at: '2022-02-19T17:58:25Z' + merchant_id: 3MYCJG5GVYQ8Q + country: US + language_code: en-US + currency: USD + phone_number: phone_number + business_name: Jet Fuel Coffee + type: PHYSICAL + website_url: website_url + business_hours: + periods: + - day_of_week: FRI + start_local_time: '07:00' + end_local_time: '18:00' + - day_of_week: SAT + start_local_time: '07:00' + end_local_time: '18:00' + - day_of_week: SUN + start_local_time: '09:00' + end_local_time: '15:00' + business_email: business_email + description: Midtown Atlanta store - Open weekends + twitter_username: twitter_username + instagram_username: instagram_username + facebook_url: facebook_url + coordinates: + latitude: 33.7889 + longitude: -84.3841 + logo_url: logo_url + pos_background_url: pos_background_url + mcc: '7299' + full_format_logo_url: full_format_logo_url + tax_ids: + eu_vat: eu_vat + fr_siret: fr_siret + fr_naf: fr_naf + es_nif: es_nif + jp_qii: jp_qii + checkouts: + path: /v2/locations/{location_id}/checkouts + method: POST + auth: true + docs: >- + Links a `checkoutId` to a `checkout_page_url` that customers are + + directed to in order to provide their payment information using a + + payment processing workflow hosted on connect.squareup.com. + + + + NOTE: The Checkout API has been updated with new features. + + For more information, see [Checkout API + highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). + source: + openapi: openapi/openapi.json + display-name: CreateCheckout + request: + name: CreateCheckoutRequest + path-parameters: + location_id: + type: string + docs: The ID of the business location to associate the checkout with. + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this checkout among others you + have created. It can be + + any valid string but must be unique for every order sent to + Square Checkout for a given location ID. + + + The idempotency key is used to avoid processing the same order + more than once. If you are + + unsure whether a particular checkout was created successfully, + you can attempt it again with + + the same idempotency key and all the same other parameters + without worrying about creating duplicates. + + + You should use a random number/string generator native to the + language + + you are working in to generate strings for your idempotency + keys. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + minLength: 1 + maxLength: 192 + order: + type: root.CreateOrderRequest + docs: The order including line items to be checked out. + ask_for_shipping_address: + type: optional + docs: >- + If `true`, Square Checkout collects shipping information on your + behalf and stores + + that information with the transaction information in the Square + Seller Dashboard. + + + Default: `false`. + merchant_support_email: + type: optional + docs: >- + The email address to display on the Square Checkout confirmation + page + + and confirmation email that the buyer can use to contact the + seller. + + + If this value is not set, the confirmation page and email + display the + + primary email address associated with the seller's Square + account. + + + Default: none; only exists if explicitly set. + validation: + maxLength: 254 + pre_populate_buyer_email: + type: optional + docs: >- + If provided, the buyer's email is prepopulated on the checkout + page + + as an editable text field. + + + Default: none; only exists if explicitly set. + validation: + maxLength: 254 + pre_populate_shipping_address: + type: optional + docs: >- + If provided, the buyer's shipping information is prepopulated on + the + + checkout page as editable text fields. + + + Default: none; only exists if explicitly set. + redirect_url: + type: optional + docs: >- + The URL to redirect to after the checkout is completed with + `checkoutId`, + + `transactionId`, and `referenceId` appended as URL parameters. + For example, + + if the provided redirect URL is + `http://www.example.com/order-complete`, a + + successful transaction redirects the customer to: + + + `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` + + + If you do not provide a redirect URL, Square Checkout displays + an order + + confirmation page on your behalf; however, it is strongly + recommended that + + you provide a redirect URL so you can verify the transaction + results and + + finalize the order through your existing/normal confirmation + workflow. + + + Default: none; only exists if explicitly set. + validation: + maxLength: 800 + additional_recipients: + type: optional> + docs: >- + The basic primitive of a multi-party transaction. The value is + optional. + + The transaction facilitated by you can be split from here. + + + If you provide this value, the `amount_money` value in your + `additional_recipients` field + + cannot be more than 90% of the `total_money` calculated by + Square for your order. + + The `location_id` must be a valid seller location where the + checkout is occurring. + + + This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth + permission. + + + This field is currently not supported in the Square Sandbox. + note: + type: optional + docs: |- + An optional note to associate with the `checkout` object. + + This value cannot exceed 60 characters. + validation: + maxLength: 60 + content-type: application/json + response: + docs: Success + type: root.CreateCheckoutResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + request: + idempotency_key: 86ae1696-b1e3-4328-af6d-f1e04d947ad6 + order: + order: + location_id: location_id + reference_id: reference_id + customer_id: customer_id + line_items: + - name: Printed T Shirt + quantity: '2' + applied_taxes: + - tax_uid: 38ze1696-z1e3-5628-af6d-f1e04d947fg3 + applied_discounts: + - discount_uid: 56ae1696-z1e3-9328-af6d-f1e04d947gd4 + base_price_money: + amount: 1500 + currency: USD + - name: Slim Jeans + quantity: '1' + base_price_money: + amount: 2500 + currency: USD + - name: Woven Sweater + quantity: '3' + base_price_money: + amount: 3500 + currency: USD + taxes: + - uid: 38ze1696-z1e3-5628-af6d-f1e04d947fg3 + type: INCLUSIVE + percentage: '7.75' + scope: LINE_ITEM + discounts: + - uid: 56ae1696-z1e3-9328-af6d-f1e04d947gd4 + type: FIXED_AMOUNT + amount_money: + amount: 100 + currency: USD + scope: LINE_ITEM + idempotency_key: 12ae1696-z1e3-4328-af6d-f1e04d947gd4 + ask_for_shipping_address: true + merchant_support_email: merchant+support@website.com + pre_populate_buyer_email: example@email.com + pre_populate_shipping_address: + address_line_1: 1455 Market St. + address_line_2: Suite 600 + locality: San Francisco + administrative_district_level_1: CA + postal_code: '94103' + country: US + first_name: Jane + last_name: Doe + redirect_url: https://merchant.website.com/order-confirm + additional_recipients: + - location_id: 057P5VYJ4A5X1 + description: Application fees + amount_money: + amount: 60 + currency: USD + response: + body: + checkout: + id: CAISEHGimXh-C3RIT4og1a6u1qw + checkout_page_url: >- + https://connect.squareup.com/v2/checkout?c=CAISEHGimXh-C3RIT4og1a6u1qw&l=CYTKRM7R7JMV8 + ask_for_shipping_address: true + merchant_support_email: merchant+support@website.com + pre_populate_buyer_email: example@email.com + pre_populate_shipping_address: + address_line_1: 1455 Market St. + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: San Francisco + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: CA + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '94103' + country: US + first_name: Jane + last_name: Doe + redirect_url: https://merchant.website.com/order-confirm + order: + id: id + location_id: location_id + reference_id: reference_id + customer_id: customer_id + line_items: + - name: Printed T Shirt + quantity: '2' + applied_taxes: + - tax_uid: 38ze1696-z1e3-5628-af6d-f1e04d947fg3 + applied_money: + amount: 103 + currency: USD + applied_discounts: + - discount_uid: 56ae1696-z1e3-9328-af6d-f1e04d947gd4 + applied_money: + amount: 100 + currency: USD + base_price_money: + amount: 1500 + currency: USD + total_tax_money: + amount: 103 + currency: USD + total_discount_money: + amount: 100 + currency: USD + total_money: + amount: 1503 + currency: USD + - name: Slim Jeans + quantity: '1' + base_price_money: + amount: 2500 + currency: USD + total_money: + amount: 2500 + currency: USD + - name: Woven Sweater + quantity: '3' + base_price_money: + amount: 3500 + currency: USD + total_money: + amount: 10500 + currency: USD + taxes: + - uid: 38ze1696-z1e3-5628-af6d-f1e04d947fg3 + type: INCLUSIVE + percentage: '7.75' + scope: LINE_ITEM + discounts: + - uid: 56ae1696-z1e3-9328-af6d-f1e04d947gd4 + type: FIXED_AMOUNT + amount_money: + amount: 100 + currency: USD + applied_money: + amount: 100 + currency: USD + scope: LINE_ITEM + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + created_at: created_at + updated_at: updated_at + closed_at: closed_at + state: OPEN + version: 1 + total_money: + amount: 14503 + currency: USD + total_tax_money: + amount: 103 + currency: USD + total_discount_money: + amount: 100 + currency: USD + ticket_name: ticket_name + rewards: + - id: id + reward_tier_id: reward_tier_id + created_at: '2017-06-16T22:25:35Z' + additional_recipients: + - location_id: 057P5VYJ4A5X1 + description: Application fees + amount_money: + amount: 60 + currency: USD + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/locations/customAttributeDefinitions.yml b/.mock/definition/locations/customAttributeDefinitions.yml new file mode 100644 index 00000000..a32d7ff2 --- /dev/null +++ b/.mock/definition/locations/customAttributeDefinitions.yml @@ -0,0 +1,393 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/locations/custom-attribute-definitions + method: GET + auth: true + docs: >- + Lists the location-related [custom attribute + definitions](entity:CustomAttributeDefinition) that belong to a Square + seller account. + + When all response pages are retrieved, the results include all custom + attribute definitions + + that are visible to the requesting application, including those that are + created by other + + applications and set to `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attribute_definitions + source: + openapi: openapi/openapi.json + display-name: ListLocationCustomAttributeDefinitions + request: + name: ListCustomAttributeDefinitionsRequest + query-parameters: + visibility_filter: + type: optional> + docs: >- + Filters the `CustomAttributeDefinition` results by their + `visibility` values. + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListLocationCustomAttributeDefinitionsResponse + status-code: 200 + examples: + - response: + body: + custom_attribute_definitions: + - key: phone-number + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.PhoneNumber + name: phone number + description: Location's phone number + visibility: VISIBILITY_READ_ONLY + version: 1 + updated_at: '2022-12-02T19:50:21.832Z' + created_at: '2022-12-02T19:50:21.832Z' + - key: bestseller + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Bestseller + description: Bestselling item at location + visibility: VISIBILITY_READ_WRITE_VALUES + version: 4 + updated_at: '2022-12-03T10:17:52.341Z' + created_at: '2022-12-02T19:06:36.559Z' + cursor: >- + ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/locations/custom-attribute-definitions + method: POST + auth: true + docs: >- + Creates a location-related [custom attribute + definition](entity:CustomAttributeDefinition) for a Square seller + account. + + Use this endpoint to define a custom attribute that can be associated + with locations. + + A custom attribute definition specifies the `key`, `visibility`, + `schema`, and other properties + + for a custom attribute. After the definition is created, you can call + + [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) + or + + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + + to set the custom attribute for locations. + source: + openapi: openapi/openapi.json + display-name: CreateLocationCustomAttributeDefinition + request: + name: CreateLocationCustomAttributeDefinitionRequest + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition to create. Note the following: + + - With the exception of the `Selection` data type, the `schema` + is specified as a simple URL to the JSON schema + + definition hosted on the Square CDN. For more information, + including supported values and constraints, see + + [Supported data + types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + + - `name` is required unless `visibility` is set to + `VISIBILITY_HIDDEN`. + idempotency_key: + type: optional + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CreateLocationCustomAttributeDefinitionResponse + status-code: 200 + examples: + - request: + custom_attribute_definition: + key: bestseller + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Bestseller + description: Bestselling item at location + visibility: VISIBILITY_READ_WRITE_VALUES + response: + body: + custom_attribute_definition: + key: bestseller + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Bestseller + description: Bestselling item at location + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-12-02T19:06:36.559Z' + created_at: '2022-12-02T19:06:36.559Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/locations/custom-attribute-definitions/{key} + method: GET + auth: true + docs: >- + Retrieves a location-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + To retrieve a custom attribute definition created by another + application, the `visibility` + + setting must be `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveLocationCustomAttributeDefinition + request: + name: GetCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: >- + The key of the custom attribute definition to retrieve. If the + requesting application + + is not the definition owner, you must use the qualified key. + query-parameters: + version: + type: optional> + docs: >- + The current version of the custom attribute definition, which is + used for strongly consistent + + reads to guarantee that you receive the most up-to-date data. When + included in the request, + + Square returns the specified version or a higher version if one + exists. If the specified version + + is higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.RetrieveLocationCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + custom_attribute_definition: + key: bestseller + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Bestseller + description: Bestselling item at location + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-12-02T19:06:36.559Z' + created_at: '2022-12-02T19:06:36.559Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/locations/custom-attribute-definitions/{key} + method: PUT + auth: true + docs: >- + Updates a location-related [custom attribute + definition](entity:CustomAttributeDefinition) for a Square seller + account. + + Use this endpoint to update the following fields: `name`, `description`, + `visibility`, or the + + `schema` for a `Selection` data type. + + Only the definition owner can update a custom attribute definition. + source: + openapi: openapi/openapi.json + display-name: UpdateLocationCustomAttributeDefinition + request: + name: UpdateLocationCustomAttributeDefinitionRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to update. + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition that contains the fields to + update. This endpoint + + supports sparse updates, so only new or changed fields need to + be included in the request. + + Only the following fields can be updated: + + - `name` + + - `description` + + - `visibility` + + - `schema` for a `Selection` data type. Only changes to the + named options or the maximum number of allowed + + selections are supported. + + + For more information, see + + [Update a location custom attribute + definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + + To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, specify the current version of the custom attribute + definition. + + If this is not important for your application, `version` can be + set to -1. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdateLocationCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + request: + custom_attribute_definition: + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + response: + body: + custom_attribute_definition: + key: bestseller + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Bestseller + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + version: 2 + updated_at: '2022-12-02T19:34:10.181Z' + created_at: '2022-12-02T19:06:36.559Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/locations/custom-attribute-definitions/{key} + method: DELETE + auth: true + docs: >- + Deletes a location-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + Deleting a custom attribute definition also deletes the corresponding + custom attribute from + + all locations. + + Only the definition owner can delete a custom attribute definition. + source: + openapi: openapi/openapi.json + display-name: DeleteLocationCustomAttributeDefinition + request: + name: DeleteCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to delete. + response: + docs: Success + type: root.DeleteLocationCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/locations/customAttributes.yml b/.mock/definition/locations/customAttributes.yml new file mode 100644 index 00000000..59525e5d --- /dev/null +++ b/.mock/definition/locations/customAttributes.yml @@ -0,0 +1,545 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + batchDelete: + path: /v2/locations/custom-attributes/bulk-delete + method: POST + auth: true + docs: >- + Deletes [custom attributes](entity:CustomAttribute) for locations as a + bulk operation. + + To delete a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkDeleteLocationCustomAttributes + request: + name: BulkDeleteLocationCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + The data used to update the `CustomAttribute` objects. + + The keys must be unique and are used to map to the corresponding + response. + content-type: application/json + response: + docs: Success + type: root.BulkDeleteLocationCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + id1: + key: bestseller + id2: + key: bestseller + id3: + key: phone-number + response: + body: + values: + id1: + location_id: L0TBCBTB7P8RQ + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + location_id: L9XMD04V3STJX + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id3: + location_id: L0TBCBTB7P8RQ + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchUpsert: + path: /v2/locations/custom-attributes/bulk-upsert + method: POST + auth: true + docs: >- + Creates or updates [custom attributes](entity:CustomAttribute) for + locations as a bulk operation. + + Use this endpoint to set the value of one or more custom attributes for + one or more locations. + + A custom attribute is based on a custom attribute definition in a Square + seller account, which is + + created using the + [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) + endpoint. + + This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to + 25 individual upsert + + requests and returns a map of individual upsert responses. Each upsert + request has a unique ID + + and provides a location ID and custom attribute. Each upsert response is + returned with the ID + + of the corresponding request. + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkUpsertLocationCustomAttributes + request: + name: BulkUpsertLocationCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + A map containing 1 to 25 individual upsert requests. For each + request, provide an + + arbitrary ID that is unique for this + `BulkUpsertLocationCustomAttributes` request and the + + information needed to create or update a custom attribute. + content-type: application/json + response: + docs: Success + type: root.BulkUpsertLocationCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + id1: + location_id: L0TBCBTB7P8RQ + custom_attribute: + key: bestseller + value: hot cocoa + id2: + location_id: L9XMD04V3STJX + custom_attribute: + key: bestseller + value: berry smoothie + id3: + location_id: L0TBCBTB7P8RQ + custom_attribute: + key: phone-number + value: '+12223334444' + response: + body: + values: + id1: + location_id: L0TBCBTB7P8RQ + custom_attribute: + key: bestseller + value: hot cocoa + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2023-01-09T19:21:04.551Z' + created_at: '2023-01-09T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + location_id: L9XMD04V3STJX + custom_attribute: + key: bestseller + value: berry smoothie + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2023-01-09T19:21:04.551Z' + created_at: '2023-01-09T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id3: + location_id: L0TBCBTB7P8RQ + custom_attribute: + key: phone-number + value: '+12239903892' + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2023-01-09T19:21:04.563Z' + created_at: '2023-01-09T19:04:57.985Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + list: + path: /v2/locations/{location_id}/custom-attributes + method: GET + auth: true + docs: >- + Lists the [custom attributes](entity:CustomAttribute) associated with a + location. + + You can use the `with_definitions` query parameter to also retrieve + custom attribute definitions + + in the same call. + + When all response pages are retrieved, the results include all custom + attributes that are + + visible to the requesting application, including those that are owned by + other applications + + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attributes + source: + openapi: openapi/openapi.json + display-name: ListLocationCustomAttributes + request: + name: ListCustomAttributesRequest + path-parameters: + location_id: + type: string + docs: The ID of the target [location](entity:Location). + query-parameters: + visibility_filter: + type: optional> + docs: >- + Filters the `CustomAttributeDefinition` results by their + `visibility` values. + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. For more + + information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + with_definitions: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of each + + custom attribute. Set this parameter to `true` to get the name and + description of each custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + response: + docs: Success + type: root.ListLocationCustomAttributesResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + response: + body: + custom_attributes: + - key: phone-number + value: '+12223334444' + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-12-12T18:13:03.745Z' + created_at: '2022-12-12T18:13:03.745Z' + - key: bestseller + value: hot cocoa + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-12-12T19:27:57.975Z' + created_at: '2022-12-12T19:27:57.975Z' + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/locations/{location_id}/custom-attributes/{key} + method: GET + auth: true + docs: >- + Retrieves a [custom attribute](entity:CustomAttribute) associated with a + location. + + You can use the `with_definition` query parameter to also retrieve the + custom attribute definition + + in the same call. + + To retrieve a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveLocationCustomAttribute + request: + name: GetCustomAttributesRequest + path-parameters: + location_id: + type: string + docs: The ID of the target [location](entity:Location). + key: + type: string + docs: >- + The key of the custom attribute to retrieve. This key must match + the `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + query-parameters: + with_definition: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of + + the custom attribute. Set this parameter to `true` to get the name + and description of the custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + version: + type: optional> + docs: >- + The current version of the custom attribute, which is used for + strongly consistent reads to + + guarantee that you receive the most up-to-date data. When included + in the request, Square + + returns the specified version or a higher version if one exists. + If the specified version is + + higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.RetrieveLocationCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + key: key + response: + body: + custom_attribute: + key: bestseller + value: hot cocoa + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2023-01-09T19:21:04.551Z' + created_at: '2023-01-09T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + upsert: + path: /v2/locations/{location_id}/custom-attributes/{key} + method: POST + auth: true + docs: >- + Creates or updates a [custom attribute](entity:CustomAttribute) for a + location. + + Use this endpoint to set the value of a custom attribute for a specified + location. + + A custom attribute is based on a custom attribute definition in a Square + seller account, which + + is created using the + [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) + endpoint. + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: UpsertLocationCustomAttribute + request: + name: UpsertLocationCustomAttributeRequest + path-parameters: + location_id: + type: string + docs: The ID of the target [location](entity:Location). + key: + type: string + docs: >- + The key of the custom attribute to create or update. This key must + match the `key` of a + + custom attribute definition in the Square seller account. If the + requesting application is not + + the definition owner, you must use the qualified key. + body: + properties: + custom_attribute: + type: root.CustomAttribute + docs: >- + The custom attribute to create or update, with the following + fields: + + - `value`. This value must conform to the `schema` specified by + the definition. + + For more information, see [Supported data + types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control for an update operation, include the current version of + the custom attribute. + + If this is not important for your application, version can be + set to -1. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpsertLocationCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + key: key + request: + custom_attribute: + value: hot cocoa + response: + body: + custom_attribute: + key: bestseller + value: hot cocoa + version: 2 + visibility: VISIBILITY_READ_WRITE_VALUES + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2023-01-09T19:21:04.551Z' + created_at: '2023-01-09T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/locations/{location_id}/custom-attributes/{key} + method: DELETE + auth: true + docs: >- + Deletes a [custom attribute](entity:CustomAttribute) associated with a + location. + + To delete a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: DeleteLocationCustomAttribute + request: + name: DeleteCustomAttributesRequest + path-parameters: + location_id: + type: string + docs: The ID of the target [location](entity:Location). + key: + type: string + docs: >- + The key of the custom attribute to delete. This key must match the + `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + response: + docs: Success + type: root.DeleteLocationCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + location_id: location_id + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/locations/transactions.yml b/.mock/definition/locations/transactions.yml new file mode 100644 index 00000000..1c7846b0 --- /dev/null +++ b/.mock/definition/locations/transactions.yml @@ -0,0 +1,324 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/locations/{location_id}/transactions + method: GET + auth: true + docs: >- + Lists transactions for a particular location. + + + Transactions include payment information from sales and exchanges and + refund + + information from returns and exchanges. + + + Max results per + [page](https://developer.squareup.com/docs/working-with-apis/pagination): + 50 + source: + openapi: openapi/openapi.json + display-name: ListTransactions + request: + name: ListTransactionsRequest + path-parameters: + location_id: + type: string + docs: The ID of the location to list transactions for. + query-parameters: + begin_time: + type: optional> + docs: >- + The beginning of the requested reporting period, in RFC 3339 + format. + + + See [Date + ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) + for details on date inclusivity/exclusivity. + + + Default value: The current time minus one year. + end_time: + type: optional> + docs: >- + The end of the requested reporting period, in RFC 3339 format. + + + See [Date + ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) + for details on date inclusivity/exclusivity. + + + Default value: The current time. + sort_order: + type: optional> + docs: |- + The order in which results are listed in the response (`ASC` for + oldest first, `DESC` for newest first). + + Default value: `DESC` + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for your original + query. + + + See [Paginating + results](https://developer.squareup.com/docs/working-with-apis/pagination) + for more information. + response: + docs: Success + type: root.ListTransactionsResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + transactions: + - id: KnL67ZIwXCPtzOrqj0HrkxMF + location_id: 18YC4JDH91E1H + created_at: '2016-01-20T22:57:56Z' + tenders: + - id: MtZRYYdDrYNQbOvV7nbuBvMF + location_id: 18YC4JDH91E1H + transaction_id: KnL67ZIwXCPtzOrqj0HrkxMF + created_at: '2016-01-20T22:57:56Z' + note: some optional note + amount_money: + amount: 5000 + currency: USD + processing_fee_money: + amount: 138 + currency: USD + type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + entry_method: KEYED + additional_recipients: + - location_id: 057P5VYJ4A5X1 + description: Application fees + amount_money: + amount: 20 + currency: USD + refunds: + - id: 7a5RcVI0CxbOcJ2wMOkE + location_id: 18YC4JDH91E1H + transaction_id: KnL67ZIwXCPtzOrqj0HrkxMF + tender_id: MtZRYYdDrYNQbOvV7nbuBvMF + created_at: '2016-01-20T22:59:20Z' + reason: some reason why + amount_money: + amount: 5000 + currency: USD + status: APPROVED + processing_fee_money: + amount: 138 + currency: USD + additional_recipients: + - location_id: 057P5VYJ4A5X1 + description: Application fees + amount_money: + amount: 100 + currency: USD + reference_id: some optional reference id + product: EXTERNAL_API + client_id: client_id + order_id: order_id + cursor: cursor + get: + path: /v2/locations/{location_id}/transactions/{transaction_id} + method: GET + auth: true + docs: Retrieves details for a single transaction. + source: + openapi: openapi/openapi.json + display-name: RetrieveTransaction + request: + name: GetTransactionsRequest + path-parameters: + location_id: + type: string + docs: The ID of the transaction's associated location. + transaction_id: + type: string + docs: The ID of the transaction to retrieve. + response: + docs: Success + type: root.GetTransactionResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + transaction_id: transaction_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + transaction: + id: KnL67ZIwXCPtzOrqj0HrkxMF + location_id: 18YC4JDH91E1H + created_at: '2016-03-10T22:57:56Z' + tenders: + - id: MtZRYYdDrYNQbOvV7nbuBvMF + location_id: 18YC4JDH91E1H + transaction_id: KnL67ZIwXCPtzOrqj0HrkxMF + created_at: '2016-03-10T22:57:56Z' + note: some optional note + amount_money: + amount: 5000 + currency: USD + processing_fee_money: + amount: 138 + currency: USD + type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + entry_method: KEYED + additional_recipients: + - location_id: 057P5VYJ4A5X1 + description: Application fees + amount_money: + amount: 20 + currency: USD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + reference_id: some optional reference id + product: EXTERNAL_API + client_id: client_id + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + order_id: order_id + capture: + path: /v2/locations/{location_id}/transactions/{transaction_id}/capture + method: POST + auth: true + docs: >- + Captures a transaction that was created with the + [Charge](api-endpoint:Transactions-Charge) + + endpoint with a `delay_capture` value of `true`. + + + + See [Delayed capture + transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + + for more information. + source: + openapi: openapi/openapi.json + display-name: CaptureTransaction + request: + name: CaptureTransactionsRequest + path-parameters: + location_id: + type: string + docs: '' + transaction_id: + type: string + docs: '' + response: + docs: Success + type: root.CaptureTransactionResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + transaction_id: transaction_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + void: + path: /v2/locations/{location_id}/transactions/{transaction_id}/void + method: POST + auth: true + docs: >- + Cancels a transaction that was created with the + [Charge](api-endpoint:Transactions-Charge) + + endpoint with a `delay_capture` value of `true`. + + + + See [Delayed capture + transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + + for more information. + source: + openapi: openapi/openapi.json + display-name: VoidTransaction + request: + name: VoidTransactionsRequest + path-parameters: + location_id: + type: string + docs: '' + transaction_id: + type: string + docs: '' + response: + docs: Success + type: root.VoidTransactionResponse + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + transaction_id: transaction_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/loyalty.yml b/.mock/definition/loyalty.yml new file mode 100644 index 00000000..7c855c96 --- /dev/null +++ b/.mock/definition/loyalty.yml @@ -0,0 +1,169 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + searchEvents: + path: /v2/loyalty/events/search + method: POST + auth: true + docs: >- + Searches for loyalty events. + + + A Square loyalty program maintains a ledger of events that occur during + the lifetime of a + + buyer's loyalty account. Each change in the point balance + + (for example, points earned, points redeemed, and points expired) is + + recorded in the ledger. Using this endpoint, you can search the ledger + for events. + + + Search results are sorted by `created_at` in descending order. + source: + openapi: openapi/openapi.json + display-name: SearchLoyaltyEvents + request: + name: SearchLoyaltyEventsRequest + body: + properties: + query: + type: optional + docs: >- + A set of one or more predefined query filters to apply when + + searching for loyalty events. The endpoint performs a logical + AND to + + evaluate multiple filters and performs a logical OR on arrays + + that specifies multiple field values. + limit: + type: optional + docs: |- + The maximum number of results to include in the response. + The last page might contain fewer events. + The default is 30 events. + validation: + min: 1 + max: 30 + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this to retrieve the next set of results for your + original query. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + content-type: application/json + response: + docs: Success + type: root.SearchLoyaltyEventsResponse + status-code: 200 + examples: + - request: + query: + filter: + order_filter: + order_id: PyATxhYLfsMqpVkcKJITPydgEYfZY + limit: 30 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + events: + - id: c27c8465-806e-36f2-b4b3-71f5887b5ba8 + type: ACCUMULATE_POINTS + created_at: '2020-05-08T22:01:30Z' + accumulate_points: + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + points: 5 + order_id: PyATxhYLfsMqpVkcKJITPydgEYfZY + create_reward: + loyalty_program_id: loyalty_program_id + points: 1 + redeem_reward: + loyalty_program_id: loyalty_program_id + delete_reward: + loyalty_program_id: loyalty_program_id + points: 1 + adjust_points: + points: 1 + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + location_id: P034NEENMD09F + source: LOYALTY_API + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + points: 1 + order_id: order_id + - id: e4a5cbc3-a4d0-3779-98e9-e578885d9430 + type: REDEEM_REWARD + created_at: '2020-05-08T22:01:15Z' + create_reward: + loyalty_program_id: loyalty_program_id + points: 1 + redeem_reward: + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + reward_id: d03f79f4-815f-3500-b851-cc1e68a457f9 + order_id: PyATxhYLfsMqpVkcKJITPydgEYfZY + delete_reward: + loyalty_program_id: loyalty_program_id + points: 1 + adjust_points: + points: 1 + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + location_id: P034NEENMD09F + source: LOYALTY_API + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + points: 1 + order_id: order_id + - id: 5e127479-0b03-3671-ab1e-15faea8b7188 + type: CREATE_REWARD + created_at: '2020-05-08T22:00:44Z' + create_reward: + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + reward_id: d03f79f4-815f-3500-b851-cc1e68a457f9 + points: -10 + redeem_reward: + loyalty_program_id: loyalty_program_id + delete_reward: + loyalty_program_id: loyalty_program_id + points: 1 + adjust_points: + points: 1 + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + location_id: location_id + source: LOYALTY_API + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + points: 1 + order_id: order_id + cursor: cursor + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/loyalty/accounts.yml b/.mock/definition/loyalty/accounts.yml new file mode 100644 index 00000000..83da3351 --- /dev/null +++ b/.mock/definition/loyalty/accounts.yml @@ -0,0 +1,475 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/loyalty/accounts + method: POST + auth: true + docs: >- + Creates a loyalty account. To create a loyalty account, you must provide + the `program_id` and a `mapping` with the `phone_number` of the buyer. + source: + openapi: openapi/openapi.json + display-name: CreateLoyaltyAccount + request: + name: CreateLoyaltyAccountRequest + body: + properties: + loyalty_account: + type: root.LoyaltyAccount + docs: The loyalty account to create. + idempotency_key: + type: string + docs: >- + A unique string that identifies this `CreateLoyaltyAccount` + request. + + Keys can be any valid string, but must be unique for every + request. + validation: + minLength: 1 + maxLength: 128 + content-type: application/json + response: + docs: Success + type: root.CreateLoyaltyAccountResponse + status-code: 200 + examples: + - request: + loyalty_account: + program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + mapping: + phone_number: '+14155551234' + idempotency_key: ec78c477-b1c3-4899-a209-a4e71337c996 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_account: + id: 79b807d2-d786-46a9-933b-918028d7a8c5 + program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + balance: 0 + lifetime_points: 0 + customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC + enrolled_at: enrolled_at + created_at: '2020-05-08T21:44:32Z' + updated_at: '2020-05-08T21:44:32Z' + mapping: + id: 66aaab3f-da99-49ed-8b19-b87f851c844f + created_at: '2020-05-08T21:44:32Z' + phone_number: '+14155551234' + expiring_point_deadlines: + - points: 1 + expires_at: expires_at + search: + path: /v2/loyalty/accounts/search + method: POST + auth: true + docs: >- + Searches for loyalty accounts in a loyalty program. + + + You can search for a loyalty account using the phone number or customer + ID associated with the account. To return all loyalty accounts, specify + an empty `query` object or omit it entirely. + + + Search results are sorted by `created_at` in ascending order. + source: + openapi: openapi/openapi.json + display-name: SearchLoyaltyAccounts + request: + name: SearchLoyaltyAccountsRequest + body: + properties: + query: + type: optional + docs: The search criteria for the request. + limit: + type: optional + docs: >- + The maximum number of results to include in the response. The + default value is 30. + validation: + min: 1 + max: 200 + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to + + this endpoint. Provide this to retrieve the next set of + + results for the original query. + + + For more information, + + see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + content-type: application/json + response: + docs: Success + type: root.SearchLoyaltyAccountsResponse + status-code: 200 + examples: + - request: + query: + mappings: + - phone_number: '+14155551234' + limit: 10 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_accounts: + - id: 79b807d2-d786-46a9-933b-918028d7a8c5 + program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + balance: 10 + lifetime_points: 20 + customer_id: Q8002FAM9V1EZ0ADB2T5609X6NET1H0 + enrolled_at: enrolled_at + created_at: '2020-05-08T21:44:32Z' + updated_at: '2020-05-08T21:44:32Z' + mapping: + id: 66aaab3f-da99-49ed-8b19-b87f851c844f + created_at: '2020-05-08T21:44:32Z' + phone_number: '+14155551234' + expiring_point_deadlines: + - points: 1 + expires_at: expires_at + cursor: cursor + get: + path: /v2/loyalty/accounts/{account_id} + method: GET + auth: true + docs: Retrieves a loyalty account. + source: + openapi: openapi/openapi.json + display-name: RetrieveLoyaltyAccount + request: + name: GetAccountsRequest + path-parameters: + account_id: + type: string + docs: >- + The ID of the [loyalty account](entity:LoyaltyAccount) to + retrieve. + response: + docs: Success + type: root.GetLoyaltyAccountResponse + status-code: 200 + examples: + - path-parameters: + account_id: account_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_account: + id: 79b807d2-d786-46a9-933b-918028d7a8c5 + program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + balance: 10 + lifetime_points: 20 + customer_id: Q8002FAM9V1EZ0ADB2T5609X6NET1H0 + enrolled_at: enrolled_at + created_at: '2020-05-08T21:44:32Z' + updated_at: '2020-05-08T21:44:32Z' + mapping: + id: 66aaab3f-da99-49ed-8b19-b87f851c844f + created_at: '2020-05-08T21:44:32Z' + phone_number: '+14155551234' + expiring_point_deadlines: + - points: 1 + expires_at: expires_at + accumulatePoints: + path: /v2/loyalty/accounts/{account_id}/accumulate + method: POST + auth: true + docs: >- + Adds points earned from a purchase to a [loyalty + account](entity:LoyaltyAccount). + + + - If you are using the Orders API to manage orders, provide the + `order_id`. Square reads the order + + to compute the points earned from both the base loyalty program and an + associated + + [loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify + for multiple accrual + + rules, Square computes points based on the accrual rule that grants the + most points. + + For purchases that qualify for multiple promotions, Square computes + points based on the most + + recently created promotion. A purchase must first qualify for program + points to be eligible for promotion points. + + + - If you are not using the Orders API to manage orders, provide `points` + with the number of points to add. + + You must first perform a client-side computation of the points earned + from the loyalty program and + + loyalty promotion. For spend-based and visit-based programs, you can + call + [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) + + to compute the points earned from the base loyalty program. For + information about computing points earned from a loyalty promotion, see + + [Calculating promotion + points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + source: + openapi: openapi/openapi.json + display-name: AccumulateLoyaltyPoints + request: + name: AccumulateLoyaltyPointsRequest + path-parameters: + account_id: + type: string + docs: The ID of the target [loyalty account](entity:LoyaltyAccount). + body: + properties: + accumulate_points: + type: root.LoyaltyEventAccumulatePoints + docs: >- + The points to add to the account. + + If you are using the Orders API to manage orders, specify the + order ID. + + Otherwise, specify the points to add. + idempotency_key: + type: string + docs: >- + A unique string that identifies the `AccumulateLoyaltyPoints` + request. + + Keys can be any valid string but must be unique for every + request. + validation: + minLength: 1 + maxLength: 128 + location_id: + type: string + docs: The [location](entity:Location) where the purchase was made. + content-type: application/json + response: + docs: Success + type: root.AccumulateLoyaltyPointsResponse + status-code: 200 + examples: + - path-parameters: + account_id: account_id + request: + accumulate_points: + order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY + idempotency_key: 58b90739-c3e8-4b11-85f7-e636d48d72cb + location_id: P034NEENMD09F + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + event: + id: id + type: ACCUMULATE_POINTS + created_at: created_at + accumulate_points: + loyalty_program_id: loyalty_program_id + points: 1 + order_id: order_id + create_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + points: 1 + redeem_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + order_id: order_id + delete_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + points: 1 + adjust_points: + loyalty_program_id: loyalty_program_id + points: 1 + reason: reason + loyalty_account_id: loyalty_account_id + location_id: location_id + source: SQUARE + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + loyalty_program_id: loyalty_program_id + loyalty_promotion_id: loyalty_promotion_id + points: 1 + order_id: order_id + events: + - id: ee46aafd-1af6-3695-a385-276e2ef0be26 + type: ACCUMULATE_POINTS + created_at: '2020-05-08T21:41:12Z' + accumulate_points: + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + points: 6 + order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY + create_reward: + loyalty_program_id: loyalty_program_id + points: 1 + redeem_reward: + loyalty_program_id: loyalty_program_id + delete_reward: + loyalty_program_id: loyalty_program_id + points: 1 + adjust_points: + points: 1 + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + location_id: P034NEENMD09F + source: LOYALTY_API + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + points: 1 + order_id: order_id + adjust: + path: /v2/loyalty/accounts/{account_id}/adjust + method: POST + auth: true + docs: >- + Adds points to or subtracts points from a buyer's account. + + + Use this endpoint only when you need to manually adjust points. + Otherwise, in your application flow, you call + + [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) + + to add points when a buyer pays for the purchase. + source: + openapi: openapi/openapi.json + display-name: AdjustLoyaltyPoints + request: + name: AdjustLoyaltyPointsRequest + path-parameters: + account_id: + type: string + docs: The ID of the target [loyalty account](entity:LoyaltyAccount). + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this `AdjustLoyaltyPoints` + request. + + Keys can be any valid string, but must be unique for every + request. + validation: + minLength: 1 + maxLength: 128 + adjust_points: + type: root.LoyaltyEventAdjustPoints + docs: >- + The points to add or subtract and the reason for the adjustment. + To add points, specify a positive integer. + + To subtract points, specify a negative integer. + allow_negative_balance: + type: optional> + docs: >- + Indicates whether to allow a negative adjustment to result in a + negative balance. If `true`, a negative + + balance is allowed when subtracting points. If `false`, Square + returns a `BAD_REQUEST` error when subtracting + + the specified number of points would result in a negative + balance. The default value is `false`. + content-type: application/json + response: + docs: Success + type: root.AdjustLoyaltyPointsResponse + status-code: 200 + examples: + - path-parameters: + account_id: account_id + request: + idempotency_key: bc29a517-3dc9-450e-aa76-fae39ee849d1 + adjust_points: + points: 10 + reason: Complimentary points + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + event: + id: 613a6fca-8d67-39d0-bad2-3b4bc45c8637 + type: ADJUST_POINTS + created_at: '2020-05-08T21:42:32Z' + accumulate_points: + loyalty_program_id: loyalty_program_id + points: 1 + order_id: order_id + create_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + points: 1 + redeem_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + order_id: order_id + delete_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + points: 1 + adjust_points: + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + points: 10 + reason: Complimentary points + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + location_id: location_id + source: LOYALTY_API + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + loyalty_program_id: loyalty_program_id + loyalty_promotion_id: loyalty_promotion_id + points: 1 + order_id: order_id + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/loyalty/programs.yml b/.mock/definition/loyalty/programs.yml new file mode 100644 index 00000000..0ac689c7 --- /dev/null +++ b/.mock/definition/loyalty/programs.yml @@ -0,0 +1,276 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/loyalty/programs + method: GET + auth: true + docs: >- + Returns a list of loyalty programs in the seller's account. + + Loyalty programs define how buyers can earn points and redeem points for + rewards. Square sellers can have only one loyalty program, which is + created and managed from the Seller Dashboard. For more information, see + [Loyalty Program + Overview](https://developer.squareup.com/docs/loyalty/overview). + + + + Replaced with + [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + when used with the keyword `main`. + source: + openapi: openapi/openapi.json + display-name: ListLoyaltyPrograms + response: + docs: Success + type: root.ListLoyaltyProgramsResponse + status-code: 200 + availability: deprecated + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + programs: + - id: d619f755-2d17-41f3-990d-c04ecedd64dd + status: ACTIVE + reward_tiers: + - id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + name: 10% off entire sale + definition: + scope: ORDER + discount_type: FIXED_PERCENTAGE + percentage_discount: '10' + created_at: '2020-04-20T16:55:11Z' + pricing_rule_reference: + object_id: 74C4JSHESNLTB2A7ITO5HO6F + catalog_version: 1000000 + expiration_policy: + expiration_duration: expiration_duration + terminology: + one: Point + other: Points + location_ids: + - P034NEENMD09F + created_at: '2020-04-20T16:55:11Z' + updated_at: '2020-05-01T02:00:02Z' + accrual_rules: + - accrual_type: SPEND + points: 1 + spend_data: + amount_money: + amount: 100 + currency: USD + excluded_category_ids: + - 7ZERJKO5PVYXCVUHV2JCZ2UG + - FQKAOJE5C4FIMF5A2URMLW6V + excluded_item_variation_ids: + - CBZXBUVVTYUBZGQO44RHMR6B + - EDILT24Z2NISEXDKGY6HP7XV + tax_mode: BEFORE_TAX + get: + path: /v2/loyalty/programs/{program_id} + method: GET + auth: true + docs: >- + Retrieves the loyalty program in a seller's account, specified by the + program ID or the keyword `main`. + + + Loyalty programs define how buyers can earn points and redeem points for + rewards. Square sellers can have only one loyalty program, which is + created and managed from the Seller Dashboard. For more information, see + [Loyalty Program + Overview](https://developer.squareup.com/docs/loyalty/overview). + source: + openapi: openapi/openapi.json + display-name: RetrieveLoyaltyProgram + request: + name: GetProgramsRequest + path-parameters: + program_id: + type: string + docs: >- + The ID of the loyalty program or the keyword `main`. Either value + can be used to retrieve the single loyalty program that belongs to + the seller. + response: + docs: Success + type: root.GetLoyaltyProgramResponse + status-code: 200 + examples: + - path-parameters: + program_id: program_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + program: + id: d619f755-2d17-41f3-990d-c04ecedd64dd + status: ACTIVE + reward_tiers: + - id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + name: 10% off entire sale + definition: + scope: ORDER + discount_type: FIXED_PERCENTAGE + percentage_discount: '10' + created_at: '2020-04-20T16:55:11Z' + pricing_rule_reference: + object_id: 74C4JSHESNLTB2A7ITO5HO6F + catalog_version: 1000000 + expiration_policy: + expiration_duration: expiration_duration + terminology: + one: Point + other: Points + location_ids: + - P034NEENMD09F + created_at: '2020-04-20T16:55:11Z' + updated_at: '2020-05-01T02:00:02Z' + accrual_rules: + - accrual_type: SPEND + points: 1 + spend_data: + amount_money: + amount: 100 + currency: USD + excluded_category_ids: + - 7ZERJKO5PVYXCVUHV2JCZ2UG + - FQKAOJE5C4FIMF5A2URMLW6V + excluded_item_variation_ids: + - CBZXBUVVTYUBZGQO44RHMR6B + - EDILT24Z2NISEXDKGY6HP7XV + tax_mode: BEFORE_TAX + calculate: + path: /v2/loyalty/programs/{program_id}/calculate + method: POST + auth: true + docs: >- + Calculates the number of points a buyer can earn from a purchase. + Applications might call this endpoint + + to display the points to the buyer. + + + - If you are using the Orders API to manage orders, provide the + `order_id` and (optional) `loyalty_account_id`. + + Square reads the order to compute the points earned from the base + loyalty program and an associated + + [loyalty promotion](entity:LoyaltyPromotion). + + + - If you are not using the Orders API to manage orders, provide + `transaction_amount_money` with the + + purchase amount. Square uses this amount to calculate the points earned + from the base loyalty program, + + but not points earned from a loyalty promotion. For spend-based and + visit-based programs, the `tax_mode` + + setting of the accrual rule indicates how taxes should be treated for + loyalty points accrual. + + If the purchase qualifies for program points, call + + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and + perform a client-side computation + + to calculate whether the purchase also qualifies for promotion points. + For more information, see + + [Calculating promotion + points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + source: + openapi: openapi/openapi.json + display-name: CalculateLoyaltyPoints + request: + name: CalculateLoyaltyPointsRequest + path-parameters: + program_id: + type: string + docs: >- + The ID of the [loyalty program](entity:LoyaltyProgram), which + defines the rules for accruing points. + body: + properties: + order_id: + type: optional> + docs: >- + The [order](entity:Order) ID for which to calculate the points. + + Specify this field if your application uses the Orders API to + process orders. + + Otherwise, specify the `transaction_amount_money`. + transaction_amount_money: + type: optional + docs: >- + The purchase amount for which to calculate the points. + + Specify this field if your application does not use the Orders + API to process orders. + + Otherwise, specify the `order_id`. + loyalty_account_id: + type: optional> + docs: >- + The ID of the target [loyalty account](entity:LoyaltyAccount). + Optionally specify this field + + if your application uses the Orders API to process orders. + + + If specified, the `promotion_points` field in the response shows + the number of points the buyer would + + earn from the purchase. In this case, Square uses the account ID + to determine whether the promotion's + + `trigger_limit` (the maximum number of times that a buyer can + trigger the promotion) has been reached. + + If not specified, the `promotion_points` field shows the number + of points the purchase qualifies + + for regardless of the trigger limit. + validation: + minLength: 1 + maxLength: 36 + content-type: application/json + response: + docs: Success + type: root.CalculateLoyaltyPointsResponse + status-code: 200 + examples: + - path-parameters: + program_id: program_id + request: + order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY + loyalty_account_id: 79b807d2-d786-46a9-933b-918028d7a8c5 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + points: 6 + promotion_points: 12 + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/loyalty/programs/promotions.yml b/.mock/definition/loyalty/programs/promotions.yml new file mode 100644 index 00000000..329b5180 --- /dev/null +++ b/.mock/definition/loyalty/programs/promotions.yml @@ -0,0 +1,456 @@ +imports: + root: ../../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/loyalty/programs/{program_id}/promotions + method: GET + auth: true + docs: >- + Lists the loyalty promotions associated with a [loyalty + program](entity:LoyaltyProgram). + + Results are sorted by the `created_at` date in descending order (newest + to oldest). + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.loyalty_promotions + source: + openapi: openapi/openapi.json + display-name: ListLoyaltyPromotions + request: + name: ListPromotionsRequest + path-parameters: + program_id: + type: string + docs: >- + The ID of the base [loyalty program](entity:LoyaltyProgram). To + get the program ID, + + call + [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + using the `main` keyword. + query-parameters: + status: + type: optional> + docs: >- + The status to filter the results by. If a status is provided, only + loyalty promotions + + with the specified status are returned. Otherwise, all loyalty + promotions associated with + + the loyalty program are returned. + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. + + The minimum value is 1 and the maximum value is 30. The default + value is 30. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListLoyaltyPromotionsResponse + status-code: 200 + examples: + - path-parameters: + program_id: program_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_promotions: + - id: loypromo_f0f9b849-725e-378d-b810-511237e07b67 + name: Tuesday Happy Hour Promo + incentive: + type: POINTS_MULTIPLIER + points_multiplier_data: + points_multiplier: 3 + multiplier: '3.000' + available_time: + start_date: '2022-08-16' + time_periods: + - |- + BEGIN:VEVENT + DTSTART:20220816T160000 + DURATION:PT2H + RRULE:FREQ=WEEKLY;BYDAY=TU + END:VEVENT + trigger_limit: + times: 1 + interval: DAY + status: ACTIVE + created_at: '2022-08-16T08:38:54Z' + canceled_at: canceled_at + updated_at: '2022-08-16T08:38:54Z' + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + qualifying_item_variation_ids: + - CJ3RYL56ITAKMD4VRCM7XERS + - AT3RYLR3TUA9C34VRCB7X5RR + qualifying_category_ids: + - qualifying_category_ids + - id: loypromo_e696f057-2286-35ff-8108-132241328106 + name: July Special + incentive: + type: POINTS_MULTIPLIER + points_multiplier_data: + points_multiplier: 2 + multiplier: '2.000' + available_time: + start_date: '2022-07-01' + end_date: '2022-08-01' + time_periods: + - |- + BEGIN:VEVENT + DTSTART:20220704T090000 + DURATION:PT8H + RRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=MO + END:VEVENT + - |- + BEGIN:VEVENT + DTSTART:20220705T090000 + DURATION:PT8H + RRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TU + END:VEVENT + - |- + BEGIN:VEVENT + DTSTART:20220706T090000 + DURATION:PT8H + RRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=WE + END:VEVENT + - |- + BEGIN:VEVENT + DTSTART:20220707T090000 + DURATION:PT8H + RRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TH + END:VEVENT + - |- + BEGIN:VEVENT + DTSTART:20220701T090000 + DURATION:PT8H + RRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=FR + END:VEVENT + trigger_limit: + times: 5 + interval: ALL_TIME + status: ENDED + created_at: '2022-06-27T15:37:38Z' + canceled_at: canceled_at + updated_at: '2022-06-27T15:37:38Z' + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + minimum_spend_amount_money: + amount: 2000 + currency: USD + qualifying_item_variation_ids: + - qualifying_item_variation_ids + qualifying_category_ids: + - XTQPYLR3IIU9C44VRCB3XD12 + cursor: cursor + create: + path: /v2/loyalty/programs/{program_id}/promotions + method: POST + auth: true + docs: >- + Creates a loyalty promotion for a [loyalty + program](entity:LoyaltyProgram). A loyalty promotion + + enables buyers to earn points in addition to those earned from the base + loyalty program. + + + This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` + status, depending on the + + `available_time` setting. A loyalty program can have a maximum of 10 + loyalty promotions with an + + `ACTIVE` or `SCHEDULED` status. + source: + openapi: openapi/openapi.json + display-name: CreateLoyaltyPromotion + request: + name: CreateLoyaltyPromotionRequest + path-parameters: + program_id: + type: string + docs: >- + The ID of the [loyalty program](entity:LoyaltyProgram) to + associate with the promotion. + + To get the program ID, call + [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + + using the `main` keyword. + body: + properties: + loyalty_promotion: + type: root.LoyaltyPromotion + docs: The loyalty promotion to create. + idempotency_key: + type: string + docs: >- + A unique identifier for this request, which is used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 128 + content-type: application/json + response: + docs: Success + type: root.CreateLoyaltyPromotionResponse + status-code: 200 + examples: + - path-parameters: + program_id: program_id + request: + loyalty_promotion: + name: Tuesday Happy Hour Promo + incentive: + type: POINTS_MULTIPLIER + points_multiplier_data: + multiplier: '3.0' + available_time: + time_periods: + - |- + BEGIN:VEVENT + DTSTART:20220816T160000 + DURATION:PT2H + RRULE:FREQ=WEEKLY;BYDAY=TU + END:VEVENT + trigger_limit: + times: 1 + interval: DAY + minimum_spend_amount_money: + amount: 2000 + currency: USD + qualifying_category_ids: + - XTQPYLR3IIU9C44VRCB3XD12 + idempotency_key: ec78c477-b1c3-4899-a209-a4e71337c996 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_promotion: + id: loypromo_f0f9b849-725e-378d-b810-511237e07b67 + name: Tuesday Happy Hour Promo + incentive: + type: POINTS_MULTIPLIER + points_multiplier_data: + points_multiplier: 3 + multiplier: '3.000' + points_addition_data: + points_addition: 1 + available_time: + start_date: '2022-08-16' + end_date: end_date + time_periods: + - |- + BEGIN:VEVENT + DTSTART:20220816T160000 + DURATION:PT2H + RRULE:FREQ=WEEKLY;BYDAY=TU + END:VEVENT + trigger_limit: + times: 1 + interval: DAY + status: ACTIVE + created_at: '2022-08-16T08:38:54Z' + canceled_at: canceled_at + updated_at: '2022-08-16T08:38:54Z' + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + minimum_spend_amount_money: + amount: 2000 + currency: USD + qualifying_item_variation_ids: + - qualifying_item_variation_ids + qualifying_category_ids: + - XTQPYLR3IIU9C44VRCB3XD12 + get: + path: /v2/loyalty/programs/{program_id}/promotions/{promotion_id} + method: GET + auth: true + docs: Retrieves a loyalty promotion. + source: + openapi: openapi/openapi.json + display-name: RetrieveLoyaltyPromotion + request: + name: GetPromotionsRequest + path-parameters: + promotion_id: + type: string + docs: >- + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to + retrieve. + program_id: + type: string + docs: >- + The ID of the base [loyalty program](entity:LoyaltyProgram). To + get the program ID, + + call + [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + using the `main` keyword. + response: + docs: Success + type: root.GetLoyaltyPromotionResponse + status-code: 200 + examples: + - path-parameters: + promotion_id: promotion_id + program_id: program_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_promotion: + id: loypromo_f0f9b849-725e-378d-b810-511237e07b67 + name: Tuesday Happy Hour Promo + incentive: + type: POINTS_MULTIPLIER + points_multiplier_data: + points_multiplier: 3 + multiplier: '3.000' + points_addition_data: + points_addition: 1 + available_time: + start_date: '2022-08-16' + end_date: end_date + time_periods: + - |- + BEGIN:VEVENT + DTSTART:20220816T160000 + DURATION:PT2H + RRULE:FREQ=WEEKLY;BYDAY=TU + END:VEVENT + trigger_limit: + times: 1 + interval: DAY + status: ACTIVE + created_at: '2022-08-16T08:38:54Z' + canceled_at: canceled_at + updated_at: '2022-08-16T08:38:54Z' + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + minimum_spend_amount_money: + amount: 2000 + currency: USD + qualifying_item_variation_ids: + - CJ3RYL56ITAKMD4VRCM7XERS + - AT3RYLR3TUA9C34VRCB7X5RR + qualifying_category_ids: + - qualifying_category_ids + cancel: + path: /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel + method: POST + auth: true + docs: >- + Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` + promotion earlier than the + + end date, cancel an `ACTIVE` promotion when an end date is not + specified, or cancel a `SCHEDULED` promotion. + + Because updating a promotion is not supported, you can also use this + endpoint to cancel a promotion before + + you create a new one. + + + This endpoint sets the loyalty promotion to the `CANCELED` state + source: + openapi: openapi/openapi.json + display-name: CancelLoyaltyPromotion + request: + name: CancelPromotionsRequest + path-parameters: + promotion_id: + type: string + docs: >- + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to + cancel. You can cancel a + + promotion that has an `ACTIVE` or `SCHEDULED` status. + program_id: + type: string + docs: The ID of the base [loyalty program](entity:LoyaltyProgram). + response: + docs: Success + type: root.CancelLoyaltyPromotionResponse + status-code: 200 + examples: + - path-parameters: + promotion_id: promotion_id + program_id: program_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + loyalty_promotion: + id: loypromo_f0f9b849-725e-378d-b810-511237e07b67 + name: Tuesday Happy Hour Promo + incentive: + type: POINTS_MULTIPLIER + points_multiplier_data: + points_multiplier: 3 + multiplier: '3.000' + points_addition_data: + points_addition: 1 + available_time: + start_date: '2022-08-16' + end_date: end_date + time_periods: + - |- + BEGIN:VEVENT + DTSTART:20220816T160000 + DURATION:PT2H + RRULE:FREQ=WEEKLY;BYDAY=TU + END:VEVENT + trigger_limit: + times: 1 + interval: DAY + status: CANCELED + created_at: '2022-08-16T08:38:54Z' + canceled_at: '2022-08-17T12:42:49Z' + updated_at: '2022-08-17T12:42:49Z' + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + minimum_spend_amount_money: + amount: 2000 + currency: USD + qualifying_item_variation_ids: + - qualifying_item_variation_ids + qualifying_category_ids: + - XTQPYLR3IIU9C44VRCB3XD12 + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/loyalty/rewards.yml b/.mock/definition/loyalty/rewards.yml new file mode 100644 index 00000000..47fdb4a8 --- /dev/null +++ b/.mock/definition/loyalty/rewards.yml @@ -0,0 +1,370 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/loyalty/rewards + method: POST + auth: true + docs: >- + Creates a loyalty reward. In the process, the endpoint does following: + + + - Uses the `reward_tier_id` in the request to determine the number of + points + + to lock for this reward. + + - If the request includes `order_id`, it adds the reward and related + discount to the order. + + + After a reward is created, the points are locked and + + not available for the buyer to redeem another reward. + source: + openapi: openapi/openapi.json + display-name: CreateLoyaltyReward + request: + name: CreateLoyaltyRewardRequest + body: + properties: + reward: + type: root.LoyaltyReward + docs: The reward to create. + idempotency_key: + type: string + docs: >- + A unique string that identifies this `CreateLoyaltyReward` + request. + + Keys can be any valid string, but must be unique for every + request. + validation: + minLength: 1 + maxLength: 128 + content-type: application/json + response: + docs: Success + type: root.CreateLoyaltyRewardResponse + status-code: 200 + examples: + - request: + reward: + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY + idempotency_key: 18c2e5ea-a620-4b1f-ad60-7b167285e451 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + reward: + id: a8f43ebe-2ad6-3001-bdd5-7d7c2da08943 + status: ISSUED + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY + created_at: '2020-05-01T21:49:54Z' + updated_at: '2020-05-01T21:49:54Z' + redeemed_at: redeemed_at + search: + path: /v2/loyalty/rewards/search + method: POST + auth: true + docs: >- + Searches for loyalty rewards. This endpoint accepts a request with no + query filters and returns results for all loyalty accounts. + + If you include a `query` object, `loyalty_account_id` is required and + `status` is optional. + + + If you know a reward ID, use the + + [RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) + endpoint. + + + Search results are sorted by `updated_at` in descending order. + source: + openapi: openapi/openapi.json + display-name: SearchLoyaltyRewards + request: + name: SearchLoyaltyRewardsRequest + body: + properties: + query: + type: optional + docs: >- + The search criteria for the request. + + If empty, the endpoint retrieves all loyalty rewards in the + loyalty program. + limit: + type: optional + docs: >- + The maximum number of results to return in the response. The + default value is 30. + validation: + min: 1 + max: 30 + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to + + this endpoint. Provide this to retrieve the next set of + + results for the original query. + + For more information, + + see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + content-type: application/json + response: + docs: Success + type: root.SearchLoyaltyRewardsResponse + status-code: 200 + examples: + - request: + query: + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + limit: 10 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + rewards: + - id: d03f79f4-815f-3500-b851-cc1e68a457f9 + status: REDEEMED + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + order_id: PyATxhYLfsMqpVkcKJITPydgEYfZY + created_at: '2020-05-08T22:00:44Z' + updated_at: '2020-05-08T22:01:17Z' + redeemed_at: '2020-05-08T22:01:17Z' + - id: 9f18ac21-233a-31c3-be77-b45840f5a810 + status: REDEEMED + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + order_id: order_id + created_at: '2020-05-08T21:55:42Z' + updated_at: '2020-05-08T21:56:00Z' + redeemed_at: '2020-05-08T21:56:00Z' + - id: a8f43ebe-2ad6-3001-bdd5-7d7c2da08943 + status: DELETED + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + order_id: 5NB69ZNh3FbsOs1ox43bh1xrli6YY + created_at: '2020-05-01T21:49:54Z' + updated_at: '2020-05-08T21:55:10Z' + redeemed_at: redeemed_at + - id: a051254c-f840-3b45-8cf1-50bcd38ff92a + status: ISSUED + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + order_id: LQQ16znvi2VIUKPVhUfJefzr1eEZY + created_at: '2020-05-01T20:20:37Z' + updated_at: '2020-05-01T20:20:40Z' + redeemed_at: redeemed_at + cursor: cursor + get: + path: /v2/loyalty/rewards/{reward_id} + method: GET + auth: true + docs: Retrieves a loyalty reward. + source: + openapi: openapi/openapi.json + display-name: RetrieveLoyaltyReward + request: + name: GetRewardsRequest + path-parameters: + reward_id: + type: string + docs: The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. + response: + docs: Success + type: root.GetLoyaltyRewardResponse + status-code: 200 + examples: + - path-parameters: + reward_id: reward_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + reward: + id: 9f18ac21-233a-31c3-be77-b45840f5a810 + status: REDEEMED + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + reward_tier_id: e1b39225-9da5-43d1-a5db-782cdd8ad94f + points: 10 + order_id: order_id + created_at: '2020-05-08T21:55:42Z' + updated_at: '2020-05-08T21:56:00Z' + redeemed_at: '2020-05-08T21:56:00Z' + delete: + path: /v2/loyalty/rewards/{reward_id} + method: DELETE + auth: true + docs: >- + Deletes a loyalty reward by doing the following: + + + - Returns the loyalty points back to the loyalty account. + + - If an order ID was specified when the reward was created + + (see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)), + + it updates the order by removing the reward and related + + discounts. + + + You cannot delete a reward that has reached the terminal state + (REDEEMED). + source: + openapi: openapi/openapi.json + display-name: DeleteLoyaltyReward + request: + name: DeleteRewardsRequest + path-parameters: + reward_id: + type: string + docs: The ID of the [loyalty reward](entity:LoyaltyReward) to delete. + response: + docs: Success + type: root.DeleteLoyaltyRewardResponse + status-code: 200 + examples: + - path-parameters: + reward_id: reward_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + redeem: + path: /v2/loyalty/rewards/{reward_id}/redeem + method: POST + auth: true + docs: |- + Redeems a loyalty reward. + + The endpoint sets the reward to the `REDEEMED` terminal state. + + If you are using your own order processing system (not using the + Orders API), you call this endpoint after the buyer paid for the + purchase. + + After the reward reaches the terminal state, it cannot be deleted. + In other words, points used for the reward cannot be returned + to the account. + source: + openapi: openapi/openapi.json + display-name: RedeemLoyaltyReward + request: + name: RedeemLoyaltyRewardRequest + path-parameters: + reward_id: + type: string + docs: The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this `RedeemLoyaltyReward` + request. + + Keys can be any valid string, but must be unique for every + request. + validation: + minLength: 1 + maxLength: 128 + location_id: + type: string + docs: >- + The ID of the [location](entity:Location) where the reward is + redeemed. + validation: + minLength: 1 + content-type: application/json + response: + docs: Success + type: root.RedeemLoyaltyRewardResponse + status-code: 200 + examples: + - path-parameters: + reward_id: reward_id + request: + idempotency_key: 98adc7f7-6963-473b-b29c-f3c9cdd7d994 + location_id: P034NEENMD09F + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + event: + id: 67377a6e-dbdc-369d-aa16-2e7ed422e71f + type: REDEEM_REWARD + created_at: '2020-05-08T21:56:00Z' + accumulate_points: + loyalty_program_id: loyalty_program_id + points: 1 + order_id: order_id + create_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + points: 1 + redeem_reward: + loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd + reward_id: 9f18ac21-233a-31c3-be77-b45840f5a810 + order_id: order_id + delete_reward: + loyalty_program_id: loyalty_program_id + reward_id: reward_id + points: 1 + adjust_points: + loyalty_program_id: loyalty_program_id + points: 1 + reason: reason + loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd + location_id: P034NEENMD09F + source: LOYALTY_API + expire_points: + loyalty_program_id: loyalty_program_id + points: 1 + other_event: + loyalty_program_id: loyalty_program_id + points: 1 + accumulate_promotion_points: + loyalty_program_id: loyalty_program_id + loyalty_promotion_id: loyalty_promotion_id + points: 1 + order_id: order_id + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/merchants.yml b/.mock/definition/merchants.yml new file mode 100644 index 00000000..29e187f1 --- /dev/null +++ b/.mock/definition/merchants.yml @@ -0,0 +1,112 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/merchants + method: GET + auth: true + docs: >- + Provides details about the merchant associated with a given access + token. + + + The access token used to connect your application to a Square seller is + associated + + with a single merchant. That means that `ListMerchants` returns a list + + with a single `Merchant` object. You can specify your personal access + token + + to get your own merchant information or specify an OAuth token to get + the + + information for the merchant that granted your application access. + + + If you know the merchant ID, you can also use the + [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) + + endpoint to retrieve the merchant information. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.merchant + source: + openapi: openapi/openapi.json + display-name: ListMerchants + request: + name: ListMerchantsRequest + query-parameters: + cursor: + type: optional> + docs: The cursor generated by the previous response. + response: + docs: Success + type: root.ListMerchantsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + merchant: + - id: DM7VKY8Q63GNP + business_name: Apple A Day + country: US + language_code: en-US + currency: USD + status: ACTIVE + main_location_id: 9A65CGC72ZQG1 + created_at: '2021-12-10T19:25:52.484Z' + cursor: 1 + get: + path: /v2/merchants/{merchant_id} + method: GET + auth: true + docs: Retrieves the `Merchant` object for the given `merchant_id`. + source: + openapi: openapi/openapi.json + display-name: RetrieveMerchant + request: + name: GetMerchantsRequest + path-parameters: + merchant_id: + type: string + docs: >- + The ID of the merchant to retrieve. If the string "me" is supplied + as the ID, + + then retrieve the merchant that is currently accessible to this + call. + response: + docs: Success + type: root.GetMerchantResponse + status-code: 200 + examples: + - path-parameters: + merchant_id: merchant_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + merchant: + id: DM7VKY8Q63GNP + business_name: Apple A Day + country: US + language_code: en-US + currency: USD + status: ACTIVE + main_location_id: 9A65CGC72ZQG1 + created_at: '2021-12-10T19:25:52.484Z' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/merchants/customAttributeDefinitions.yml b/.mock/definition/merchants/customAttributeDefinitions.yml new file mode 100644 index 00000000..d9e7162b --- /dev/null +++ b/.mock/definition/merchants/customAttributeDefinitions.yml @@ -0,0 +1,395 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/merchants/custom-attribute-definitions + method: GET + auth: true + docs: >- + Lists the merchant-related [custom attribute + definitions](entity:CustomAttributeDefinition) that belong to a Square + seller account. + + When all response pages are retrieved, the results include all custom + attribute definitions + + that are visible to the requesting application, including those that are + created by other + + applications and set to `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attribute_definitions + source: + openapi: openapi/openapi.json + display-name: ListMerchantCustomAttributeDefinitions + request: + name: ListCustomAttributeDefinitionsRequest + query-parameters: + visibility_filter: + type: optional> + docs: >- + Filters the `CustomAttributeDefinition` results by their + `visibility` values. + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListMerchantCustomAttributeDefinitionsResponse + status-code: 200 + examples: + - response: + body: + custom_attribute_definitions: + - key: has_seen_tutorial + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean + name: NAME + description: >- + Whether the merchant has seen the tutorial screen for using + the app. + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2023-05-05T16:50:21.832Z' + created_at: '2023-05-05T16:50:21.832Z' + - key: alternative_seller_name + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Alternative Merchant Name + description: This is the other name this merchant goes by. + visibility: VISIBILITY_READ_ONLY + version: 4 + updated_at: '2023-05-05T10:17:52.341Z' + created_at: '2023-05-05T19:06:36.559Z' + cursor: >- + ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/merchants/custom-attribute-definitions + method: POST + auth: true + docs: >- + Creates a merchant-related [custom attribute + definition](entity:CustomAttributeDefinition) for a Square seller + account. + + Use this endpoint to define a custom attribute that can be associated + with a merchant connecting to your application. + + A custom attribute definition specifies the `key`, `visibility`, + `schema`, and other properties + + for a custom attribute. After the definition is created, you can call + + [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) + or + + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + + to set the custom attribute for a merchant. + source: + openapi: openapi/openapi.json + display-name: CreateMerchantCustomAttributeDefinition + request: + name: CreateMerchantCustomAttributeDefinitionRequest + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition to create. Note the following: + + - With the exception of the `Selection` data type, the `schema` + is specified as a simple URL to the JSON schema + + definition hosted on the Square CDN. For more information, + including supported values and constraints, see + + [Supported data + types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + + - `name` is required unless `visibility` is set to + `VISIBILITY_HIDDEN`. + idempotency_key: + type: optional + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CreateMerchantCustomAttributeDefinitionResponse + status-code: 200 + examples: + - request: + custom_attribute_definition: + key: alternative_seller_name + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Alternative Merchant Name + description: This is the other name this merchant goes by. + visibility: VISIBILITY_READ_ONLY + response: + body: + custom_attribute_definition: + key: alternative_seller_name + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Alternative Merchant Name + description: This is the other name this merchant goes by. + visibility: VISIBILITY_READ_ONLY + version: 1 + updated_at: '2023-05-05T19:06:36.559Z' + created_at: '2023-05-05T19:06:36.559Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/merchants/custom-attribute-definitions/{key} + method: GET + auth: true + docs: >- + Retrieves a merchant-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + To retrieve a custom attribute definition created by another + application, the `visibility` + + setting must be `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveMerchantCustomAttributeDefinition + request: + name: GetCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: >- + The key of the custom attribute definition to retrieve. If the + requesting application + + is not the definition owner, you must use the qualified key. + query-parameters: + version: + type: optional> + docs: >- + The current version of the custom attribute definition, which is + used for strongly consistent + + reads to guarantee that you receive the most up-to-date data. When + included in the request, + + Square returns the specified version or a higher version if one + exists. If the specified version + + is higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.RetrieveMerchantCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + custom_attribute_definition: + key: alternative_seller_name + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Alternative Merchant Name + description: This is the other name this merchant goes by. + visibility: VISIBILITY_READ_ONLY + version: 1 + updated_at: '2023-05-05T19:06:36.559Z' + created_at: '2023-05-05T19:06:36.559Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/merchants/custom-attribute-definitions/{key} + method: PUT + auth: true + docs: >- + Updates a merchant-related [custom attribute + definition](entity:CustomAttributeDefinition) for a Square seller + account. + + Use this endpoint to update the following fields: `name`, `description`, + `visibility`, or the + + `schema` for a `Selection` data type. + + Only the definition owner can update a custom attribute definition. + source: + openapi: openapi/openapi.json + display-name: UpdateMerchantCustomAttributeDefinition + request: + name: UpdateMerchantCustomAttributeDefinitionRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to update. + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition that contains the fields to + update. This endpoint + + supports sparse updates, so only new or changed fields need to + be included in the request. + + Only the following fields can be updated: + + - `name` + + - `description` + + - `visibility` + + - `schema` for a `Selection` data type. Only changes to the + named options or the maximum number of allowed + + selections are supported. + + For more information, see + + [Update a merchant custom attribute + definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + + The version field must match the current version of the custom + attribute definition to enable + + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + If this is not important for your application, version can be + set to -1. For any other values, the request fails with a + BAD_REQUEST error. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdateMerchantCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + request: + custom_attribute_definition: + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + response: + body: + custom_attribute_definition: + key: alternative_seller_name + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String + name: Alternative Merchant Name + description: Update the description as desired. + visibility: VISIBILITY_READ_ONLY + version: 2 + updated_at: '2023-05-05T19:34:10.181Z' + created_at: '2023-05-05T19:06:36.559Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/merchants/custom-attribute-definitions/{key} + method: DELETE + auth: true + docs: >- + Deletes a merchant-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + Deleting a custom attribute definition also deletes the corresponding + custom attribute from + + the merchant. + + Only the definition owner can delete a custom attribute definition. + source: + openapi: openapi/openapi.json + display-name: DeleteMerchantCustomAttributeDefinition + request: + name: DeleteCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to delete. + response: + docs: Success + type: root.DeleteMerchantCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/merchants/customAttributes.yml b/.mock/definition/merchants/customAttributes.yml new file mode 100644 index 00000000..f3079e5d --- /dev/null +++ b/.mock/definition/merchants/customAttributes.yml @@ -0,0 +1,520 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + batchDelete: + path: /v2/merchants/custom-attributes/bulk-delete + method: POST + auth: true + docs: >- + Deletes [custom attributes](entity:CustomAttribute) for a merchant as a + bulk operation. + + To delete a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkDeleteMerchantCustomAttributes + request: + name: BulkDeleteMerchantCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + The data used to update the `CustomAttribute` objects. + + The keys must be unique and are used to map to the corresponding + response. + content-type: application/json + response: + docs: Success + type: root.BulkDeleteMerchantCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + id1: + key: alternative_seller_name + id2: + key: has_seen_tutorial + response: + body: + values: + id1: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchUpsert: + path: /v2/merchants/custom-attributes/bulk-upsert + method: POST + auth: true + docs: >- + Creates or updates [custom attributes](entity:CustomAttribute) for a + merchant as a bulk operation. + + Use this endpoint to set the value of one or more custom attributes for + a merchant. + + A custom attribute is based on a custom attribute definition in a Square + seller account, which is + + created using the + [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) + endpoint. + + This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to + 25 individual upsert + + requests and returns a map of individual upsert responses. Each upsert + request has a unique ID + + and provides a merchant ID and custom attribute. Each upsert response is + returned with the ID + + of the corresponding request. + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkUpsertMerchantCustomAttributes + request: + name: BulkUpsertMerchantCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + A map containing 1 to 25 individual upsert requests. For each + request, provide an + + arbitrary ID that is unique for this + `BulkUpsertMerchantCustomAttributes` request and the + + information needed to create or update a custom attribute. + content-type: application/json + response: + docs: Success + type: root.BulkUpsertMerchantCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + id1: + merchant_id: DM7VKY8Q63GNP + custom_attribute: + key: alternative_seller_name + value: Ultimate Sneaker Store + id2: + merchant_id: DM7VKY8Q63GNP + custom_attribute: + key: has_seen_tutorial + value: true + response: + body: + values: + id1: + merchant_id: DM7VKY8Q63GNP + custom_attribute: + key: alternative_seller_name + value: Ultimate Sneaker Store + version: 2 + visibility: VISIBILITY_READ_ONLY + updated_at: '2023-05-06T19:21:04.551Z' + created_at: '2023-05-06T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id2: + merchant_id: DM7VKY8Q63GNP + custom_attribute: + key: has_seen_tutorial + value: true + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2023-05-06T19:21:04.551Z' + created_at: '2023-05-06T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + list: + path: /v2/merchants/{merchant_id}/custom-attributes + method: GET + auth: true + docs: >- + Lists the [custom attributes](entity:CustomAttribute) associated with a + merchant. + + You can use the `with_definitions` query parameter to also retrieve + custom attribute definitions + + in the same call. + + When all response pages are retrieved, the results include all custom + attributes that are + + visible to the requesting application, including those that are owned by + other applications + + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attributes + source: + openapi: openapi/openapi.json + display-name: ListMerchantCustomAttributes + request: + name: ListCustomAttributesRequest + path-parameters: + merchant_id: + type: string + docs: The ID of the target [merchant](entity:Merchant). + query-parameters: + visibility_filter: + type: optional> + docs: >- + Filters the `CustomAttributeDefinition` results by their + `visibility` values. + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. For more + + information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + with_definitions: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of each + + custom attribute. Set this parameter to `true` to get the name and + description of each custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + response: + docs: Success + type: root.ListMerchantCustomAttributesResponse + status-code: 200 + examples: + - path-parameters: + merchant_id: merchant_id + response: + body: + custom_attributes: + - key: has_seen_tutorial + value: true + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2023-05-05T18:13:03.745Z' + created_at: '2023-05-05T18:13:03.745Z' + - key: alternative_seller_name + value: Ultimate Sneaker Store + version: 1 + visibility: VISIBILITY_READ_ONLY + updated_at: '2023-05-05T19:27:57.975Z' + created_at: '2023-05-05T19:27:57.975Z' + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/merchants/{merchant_id}/custom-attributes/{key} + method: GET + auth: true + docs: >- + Retrieves a [custom attribute](entity:CustomAttribute) associated with a + merchant. + + You can use the `with_definition` query parameter to also retrieve the + custom attribute definition + + in the same call. + + To retrieve a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveMerchantCustomAttribute + request: + name: GetCustomAttributesRequest + path-parameters: + merchant_id: + type: string + docs: The ID of the target [merchant](entity:Merchant). + key: + type: string + docs: >- + The key of the custom attribute to retrieve. This key must match + the `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + query-parameters: + with_definition: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of + + the custom attribute. Set this parameter to `true` to get the name + and description of the custom + + attribute, information about the data type, or other definition + details. The default value is `false`. + version: + type: optional> + docs: >- + The current version of the custom attribute, which is used for + strongly consistent reads to + + guarantee that you receive the most up-to-date data. When included + in the request, Square + + returns the specified version or a higher version if one exists. + If the specified version is + + higher than the current version, Square returns a `BAD_REQUEST` + error. + response: + docs: Success + type: root.RetrieveMerchantCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + merchant_id: merchant_id + key: key + response: + body: + custom_attribute: + key: alternative_seller_name + value: Ultimate Sneaker Store + version: 2 + visibility: VISIBILITY_READ_ONLY + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2023-05-06T19:21:04.551Z' + created_at: '2023-05-06T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + upsert: + path: /v2/merchants/{merchant_id}/custom-attributes/{key} + method: POST + auth: true + docs: >- + Creates or updates a [custom attribute](entity:CustomAttribute) for a + merchant. + + Use this endpoint to set the value of a custom attribute for a specified + merchant. + + A custom attribute is based on a custom attribute definition in a Square + seller account, which + + is created using the + [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) + endpoint. + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: UpsertMerchantCustomAttribute + request: + name: UpsertMerchantCustomAttributeRequest + path-parameters: + merchant_id: + type: string + docs: The ID of the target [merchant](entity:Merchant). + key: + type: string + docs: >- + The key of the custom attribute to create or update. This key must + match the `key` of a + + custom attribute definition in the Square seller account. If the + requesting application is not + + the definition owner, you must use the qualified key. + body: + properties: + custom_attribute: + type: root.CustomAttribute + docs: >- + The custom attribute to create or update, with the following + fields: + + - `value`. This value must conform to the `schema` specified by + the definition. + + For more information, see [Supported data + types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + + - The version field must match the current version of the custom + attribute definition to enable + + [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + If this is not important for your application, version can be + set to -1. For any other values, the request fails with a + BAD_REQUEST error. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. For more information, + + see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpsertMerchantCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + merchant_id: merchant_id + key: key + request: + custom_attribute: + value: Ultimate Sneaker Store + response: + body: + custom_attribute: + key: alternative_seller_name + value: Ultimate Sneaker Store + version: 2 + visibility: VISIBILITY_READ_ONLY + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2023-05-06T19:21:04.551Z' + created_at: '2023-05-06T19:02:58.647Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/merchants/{merchant_id}/custom-attributes/{key} + method: DELETE + auth: true + docs: >- + Deletes a [custom attribute](entity:CustomAttribute) associated with a + merchant. + + To delete a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: DeleteMerchantCustomAttribute + request: + name: DeleteCustomAttributesRequest + path-parameters: + merchant_id: + type: string + docs: The ID of the target [merchant](entity:Merchant). + key: + type: string + docs: >- + The key of the custom attribute to delete. This key must match the + `key` of a custom + + attribute definition in the Square seller account. If the + requesting application is not the + + definition owner, you must use the qualified key. + response: + docs: Success + type: root.DeleteMerchantCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + merchant_id: merchant_id + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/mobile.yml b/.mock/definition/mobile.yml new file mode 100644 index 00000000..847e85be --- /dev/null +++ b/.mock/definition/mobile.yml @@ -0,0 +1,76 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + authorizationCode: + path: /mobile/authorization-code + method: POST + auth: true + docs: >- + __Note:__ This endpoint is used by the deprecated Reader SDK. + + Developers should update their integration to use the [Mobile Payments + SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which + includes its own authorization methods. + + + Generates code to authorize a mobile application to connect to a Square + card reader. + + + Authorization codes are one-time-use codes and expire 60 minutes after + being issued. + + + The `Authorization` header you provide to this endpoint must have the + following format: + + + ``` + + Authorization: Bearer ACCESS_TOKEN + + ``` + + + Replace `ACCESS_TOKEN` with a + + [valid production authorization + credential](https://developer.squareup.com/docs/build-basics/access-tokens). + source: + openapi: openapi/openapi.json + display-name: CreateMobileAuthorizationCode + request: + name: CreateMobileAuthorizationCodeRequest + body: + properties: + location_id: + type: optional + docs: >- + The Square location ID that the authorization code should be + tied to. + validation: + minLength: 1 + maxLength: 191 + content-type: application/json + response: + docs: Success + type: root.CreateMobileAuthorizationCodeResponse + status-code: 200 + availability: deprecated + examples: + - request: + location_id: YOUR_LOCATION_ID + response: + body: + authorization_code: YOUR_MOBILE_AUTHORIZATION_CODE + expires_at: '2019-01-10T19:42:08Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/oAuth.yml b/.mock/definition/oAuth.yml new file mode 100644 index 00000000..35bba044 --- /dev/null +++ b/.mock/definition/oAuth.yml @@ -0,0 +1,369 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + revokeToken: + path: /oauth2/revoke + method: POST + auth: true + docs: >- + Revokes an access token generated with the OAuth flow. + + + If an account has more than one OAuth access token for your application, + this + + endpoint revokes all of them, regardless of which token you specify. + + + __Important:__ The `Authorization` header for this endpoint must have + the + + following format: + + + ``` + + Authorization: Client APPLICATION_SECRET + + ``` + + + Replace `APPLICATION_SECRET` with the application secret on the + **OAuth** + + page for your application in the Developer Dashboard. + source: + openapi: openapi/openapi.json + display-name: RevokeToken + request: + name: RevokeTokenRequest + body: + properties: + client_id: + type: optional> + docs: >- + The Square-issued ID for your application, which is available on + the **OAuth** page in the + + [Developer Dashboard](https://developer.squareup.com/apps). + validation: + maxLength: 191 + access_token: + type: optional> + docs: >- + The access token of the merchant whose token you want to revoke. + + Do not provide a value for `merchant_id` if you provide this + parameter. + validation: + minLength: 2 + maxLength: 1024 + merchant_id: + type: optional> + docs: >- + The ID of the merchant whose token you want to revoke. + + Do not provide a value for `access_token` if you provide this + parameter. + revoke_only_access_token: + type: optional> + docs: |- + If `true`, terminate the given single access token, but do not + terminate the entire authorization. + Default: `false` + content-type: application/json + response: + docs: Success + type: root.RevokeTokenResponse + status-code: 200 + examples: + - request: + client_id: CLIENT_ID + access_token: ACCESS_TOKEN + response: + body: + success: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + obtainToken: + path: /oauth2/token + method: POST + auth: false + docs: >- + Returns an OAuth access token and refresh token using the + `authorization_code` + + or `refresh_token` grant type. + + + When `grant_type` is `authorization_code`: + + - With the [code + flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow), + + provide `code`, `client_id`, and `client_secret`. + + - With the [PKCE + flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow), + + provide `code`, `client_id`, and `code_verifier`. + + + When `grant_type` is `refresh_token`: + + - With the code flow, provide `refresh_token`, `client_id`, and + `client_secret`. + + The response returns the same refresh token provided in the request. + + - With the PKCE flow, provide `refresh_token` and `client_id`. The + response returns + + a new refresh token. + + + You can use the `scopes` parameter to limit the set of permissions + authorized by the + + access token. You can use the `short_lived` parameter to create an + access token that + + expires in 24 hours. + + + __Important:__ OAuth tokens should be encrypted and stored on a secure + server. + + Application clients should never interact directly with OAuth tokens. + source: + openapi: openapi/openapi.json + display-name: ObtainToken + request: + name: ObtainTokenRequest + body: + properties: + client_id: + type: string + docs: >- + The Square-issued ID of your application, which is available as + the **Application ID** + + on the **OAuth** page in the [Developer + Console](https://developer.squareup.com/apps). + + + Required for the code flow and PKCE flow for any grant type. + validation: + maxLength: 191 + client_secret: + type: optional> + docs: >- + The secret key for your application, which is available as the + **Application secret** + + on the **OAuth** page in the [Developer + Console](https://developer.squareup.com/apps). + + + Required for the code flow for any grant type. Don't confuse + your client secret with your + + personal access token. + validation: + minLength: 2 + maxLength: 1024 + code: + type: optional> + docs: >- + The authorization code to exchange for an OAuth access token. + This is the `code` + + value that Square sent to your redirect URL in the authorization + response. + + + Required for the code flow and PKCE flow if `grant_type` is + `authorization_code`. + validation: + maxLength: 191 + redirect_uri: + type: optional> + docs: >- + The redirect URL for your application, which you registered as + the **Redirect URL** + + on the **OAuth** page in the [Developer + Console](https://developer.squareup.com/apps). + + + Required for the code flow and PKCE flow if `grant_type` is + `authorization_code` and + + you provided the `redirect_uri` parameter in your authorization + URL. + validation: + maxLength: 2048 + grant_type: + type: string + docs: >- + The method used to obtain an OAuth access token. The request + must include the + + credential that corresponds to the specified grant type. Valid + values are: + + - `authorization_code` - Requires the `code` field. + + - `refresh_token` - Requires the `refresh_token` field. + + - `migration_token` - LEGACY for access tokens obtained using a + Square API version prior + + to 2019-03-13. Requires the `migration_token` field. + validation: + minLength: 10 + maxLength: 20 + refresh_token: + type: optional> + docs: >- + A valid refresh token used to generate a new OAuth access token. + This is a + + refresh token that was returned in a previous `ObtainToken` + response. + + + Required for the code flow and PKCE flow if `grant_type` is + `refresh_token`. + validation: + minLength: 2 + maxLength: 1024 + migration_token: + type: optional> + docs: >- + __LEGACY__ A valid access token (obtained using a Square API + version prior to 2019-03-13) + + used to generate a new OAuth access token. + + + Required if `grant_type` is `migration_token`. For more + information, see + + [Migrate to Using Refresh + Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). + validation: + minLength: 2 + maxLength: 1024 + scopes: + type: optional>> + docs: >- + The list of permissions that are explicitly requested for the + access token. + + For example, + ["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]. + + + The returned access token is limited to the permissions that are + the intersection + + of these requested permissions and those authorized by the + provided `refresh_token`. + + + Optional for the code flow and PKCE flow if `grant_type` is + `refresh_token`. + short_lived: + type: optional> + docs: >- + Indicates whether the returned access token should expire in 24 + hours. + + + Optional for the code flow and PKCE flow for any grant type. The + default value is `false`. + code_verifier: + type: optional> + docs: >- + The secret your application generated for the authorization + request used to + + obtain the authorization code. This is the source of the + `code_challenge` hash you + + provided in your authorization URL. + + + Required for the PKCE flow if `grant_type` is + `authorization_code`. + content-type: application/json + response: + docs: Success + type: root.ObtainTokenResponse + status-code: 200 + examples: + - request: + client_id: sq0idp-uaPHILoPzWZk3tlJqlML0g + client_secret: sq0csp-30a-4C_tVOnTh14Piza2BfTPBXyLafLPWSzY1qAjeBfM + code: sq0cgb-l0SBqxs4uwxErTVyYOdemg + grant_type: authorization_code + response: + body: + access_token: EAAl3ikZIe18J-2-cHlV2bL4-EaZHGoJUhtEBT7QA6-7AgwIHw8Xe1IoUvGsNxA + token_type: bearer + expires_at: '2025-04-03T18:31:06Z' + merchant_id: MLQW2MYBY81PZ + subscription_id: subscription_id + plan_id: plan_id + id_token: id_token + refresh_token: EQAAl0OcByu3IYJYScGGg-8E5YNf0r0b6jCTCMy5nOcRZ4ok0wbWAL8vY3tZWNcc + short_lived: false + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refresh_token_expires_at: refresh_token_expires_at + RetrieveTokenStatus: + path: /oauth2/token/status + method: POST + auth: true + docs: "Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token)\_or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).\n\nAdd the access token to the Authorization header of the request.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nwhere `ACCESS_TOKEN` is a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).\n\nIf the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error." + source: + openapi: openapi/openapi.json + display-name: RetrieveTokenStatus + response: + docs: Success + type: root.RetrieveTokenStatusResponse + status-code: 200 + examples: + - response: + body: + scopes: + - PAYMENTS_READ + - PAYMENTS_WRITE + expires_at: '2022-10-14T14:44:00Z' + client_id: CLIENT_ID + merchant_id: MERCHANT_ID + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + authorize: + path: /oauth2/authorize + method: GET + auth: false + source: + openapi: openapi/openapi.json + examples: + - {} + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/orders.yml b/.mock/definition/orders.yml new file mode 100644 index 00000000..eda03149 --- /dev/null +++ b/.mock/definition/orders.yml @@ -0,0 +1,1710 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/orders + method: POST + auth: true + docs: >- + Creates a new [order](entity:Order) that can include information about + products for + + purchase and settings to apply to the purchase. + + + To pay for a created order, see + + [Pay for + Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + + You can modify open orders using the + [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + source: + openapi: openapi/openapi.json + display-name: CreateOrder + request: + body: root.CreateOrderRequest + content-type: application/json + response: + docs: Success + type: root.CreateOrderResponse + status-code: 200 + examples: + - request: + order: + location_id: 057P5VYJ4A5X1 + reference_id: my-order-001 + line_items: + - name: New York Strip Steak + quantity: '1' + base_price_money: + amount: 1599 + currency: USD + - quantity: '2' + catalog_object_id: BEMYCSMIJL46OCDV4KYIKXIB + modifiers: + - catalog_object_id: CHQX7Y4KY6N5KINJKZCFURPZ + applied_discounts: + - discount_uid: one-dollar-off + taxes: + - uid: state-sales-tax + name: State Sales Tax + percentage: '9' + scope: ORDER + discounts: + - uid: labor-day-sale + name: Labor Day Sale + percentage: '5' + scope: ORDER + - uid: membership-discount + catalog_object_id: DB7L55ZH2BGWI4H23ULIWOQ7 + scope: ORDER + - uid: one-dollar-off + name: Sale - $1.00 off + amount_money: + amount: 100 + currency: USD + scope: LINE_ITEM + idempotency_key: 8193148c-9586-11e6-99f9-28cfe92138cf + response: + body: + order: + id: CAISENgvlJ6jLWAzERDzjyHVybY + location_id: 057P5VYJ4A5X1 + reference_id: my-order-001 + source: + name: My App + customer_id: customer_id + line_items: + - uid: 8uSwfzvUImn3IRrvciqlXC + name: New York Strip Steak + quantity: '1' + applied_taxes: + - uid: aKG87ArnDpvMLSZJHxWUl + tax_uid: state-sales-tax + applied_money: + amount: 136 + currency: USD + applied_discounts: + - uid: jWdgP1TpHPFBuVrz81mXVC + discount_uid: membership-discount + applied_money: + amount: 8 + currency: USD + - uid: jnZOjjVY57eRcQAVgEwFuC + discount_uid: labor-day-sale + applied_money: + amount: 79 + currency: USD + base_price_money: + amount: 1599 + currency: USD + variation_total_price_money: + amount: 1599 + currency: USD + gross_sales_money: + amount: 1599 + currency: USD + total_tax_money: + amount: 136 + currency: USD + total_discount_money: + amount: 87 + currency: USD + total_money: + amount: 1648 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + - uid: v8ZuEXpOJpb0bazLuvrLDB + name: New York Steak + quantity: '2' + catalog_object_id: BEMYCSMIJL46OCDV4KYIKXIB + variation_name: Larger + modifiers: + - uid: Lo3qMMckDluu9Qsb58d4CC + catalog_object_id: CHQX7Y4KY6N5KINJKZCFURPZ + name: Well + base_price_money: + amount: 50 + currency: USD + total_price_money: + amount: 100 + currency: USD + applied_taxes: + - uid: v1dAgrfUVUPTnVTf9sRPz + tax_uid: state-sales-tax + applied_money: + amount: 374 + currency: USD + applied_discounts: + - uid: nUXvdsIItfKko0dbYtY58C + discount_uid: membership-discount + applied_money: + amount: 22 + currency: USD + - uid: qSdkOOOernlVQqsJ94SPjB + discount_uid: labor-day-sale + applied_money: + amount: 224 + currency: USD + - uid: y7bVl4njrWAnfDwmz19izB + discount_uid: one-dollar-off + applied_money: + amount: 100 + currency: USD + base_price_money: + amount: 2200 + currency: USD + variation_total_price_money: + amount: 4400 + currency: USD + gross_sales_money: + amount: 4500 + currency: USD + total_tax_money: + amount: 374 + currency: USD + total_discount_money: + amount: 346 + currency: USD + total_money: + amount: 4528 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + taxes: + - uid: state-sales-tax + name: State Sales Tax + type: ADDITIVE + percentage: '9' + applied_money: + amount: 510 + currency: USD + scope: ORDER + discounts: + - uid: membership-discount + catalog_object_id: DB7L55ZH2BGWI4H23ULIWOQ7 + name: Membership Discount + type: FIXED_PERCENTAGE + percentage: '0.5' + applied_money: + amount: 30 + currency: USD + scope: ORDER + - uid: labor-day-sale + name: Labor Day Sale + type: FIXED_PERCENTAGE + percentage: '5' + applied_money: + amount: 303 + currency: USD + scope: ORDER + - uid: one-dollar-off + name: Sale - $1.00 off + type: FIXED_AMOUNT + amount_money: + amount: 100 + currency: USD + applied_money: + amount: 100 + currency: USD + scope: LINE_ITEM + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + net_amounts: + total_money: + amount: 6176 + currency: USD + tax_money: + amount: 510 + currency: USD + discount_money: + amount: 433 + currency: USD + tip_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + rounding_adjustment: + uid: uid + name: name + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + metadata: + key: value + created_at: '2020-01-17T20:47:53.293Z' + updated_at: '2020-01-17T20:47:53.293Z' + closed_at: closed_at + state: OPEN + version: 1 + total_money: + amount: 6176 + currency: USD + total_tax_money: + amount: 510 + currency: USD + total_discount_money: + amount: 433 + currency: USD + total_tip_money: + amount: 0 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + ticket_name: ticket_name + pricing_options: + auto_apply_discounts: true + auto_apply_taxes: true + rewards: + - id: id + reward_tier_id: reward_tier_id + net_amount_due_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchGet: + path: /v2/orders/batch-retrieve + method: POST + auth: true + docs: >- + Retrieves a set of [orders](entity:Order) by their IDs. + + + If a given order ID does not exist, the ID is ignored instead of + generating an error. + source: + openapi: openapi/openapi.json + display-name: BatchRetrieveOrders + request: + name: BatchGetOrdersRequest + body: + properties: + location_id: + type: optional> + docs: >- + The ID of the location for these orders. This field is optional: + omit it to retrieve + + orders within the scope of the current authorization's merchant + ID. + order_ids: + docs: >- + The IDs of the orders to retrieve. A maximum of 100 orders can + be retrieved per request. + type: list + content-type: application/json + response: + docs: Success + type: root.BatchGetOrdersResponse + status-code: 200 + examples: + - request: + location_id: 057P5VYJ4A5X1 + order_ids: + - CAISEM82RcpmcFBM0TfOyiHV3es + - CAISENgvlJ6jLWAzERDzjyHVybY + response: + body: + orders: + - id: CAISEM82RcpmcFBM0TfOyiHV3es + location_id: 057P5VYJ4A5X1 + reference_id: my-order-001 + customer_id: customer_id + line_items: + - uid: 945986d1-9586-11e6-ad5a-28cfe92138cf + name: Awesome product + quantity: '1' + base_price_money: + amount: 1599 + currency: USD + total_money: + amount: 1599 + currency: USD + - uid: a8f4168c-9586-11e6-bdf0-28cfe92138cf + name: Another awesome product + quantity: '3' + base_price_money: + amount: 2000 + currency: USD + total_money: + amount: 6000 + currency: USD + taxes: + - {} + discounts: + - {} + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + created_at: created_at + updated_at: updated_at + closed_at: closed_at + state: OPEN + version: 1 + total_money: + amount: 7599 + currency: USD + ticket_name: ticket_name + rewards: + - id: id + reward_tier_id: reward_tier_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + calculate: + path: /v2/orders/calculate + method: POST + auth: true + docs: Enables applications to preview order pricing without creating an order. + source: + openapi: openapi/openapi.json + display-name: CalculateOrder + request: + name: CalculateOrderRequest + body: + properties: + order: + type: root.Order + docs: >- + The order to be calculated. Expects the entire order, not a + sparse update. + proposed_rewards: + type: optional>> + docs: >- + Identifies one or more loyalty reward tiers to apply during the + order calculation. + + The discounts defined by the reward tiers are added to the order + only to preview the + + effect of applying the specified rewards. The rewards do not + correspond to actual + + redemptions; that is, no `reward`s are created. Therefore, the + reward `id`s are + + random strings used only to reference the reward tier. + content-type: application/json + response: + docs: Success + type: root.CalculateOrderResponse + status-code: 200 + examples: + - request: + order: + location_id: D7AVYMEAPJ3A3 + line_items: + - name: Item 1 + quantity: '1' + base_price_money: + amount: 500 + currency: USD + - name: Item 2 + quantity: '2' + base_price_money: + amount: 300 + currency: USD + discounts: + - name: 50% Off + percentage: '50' + scope: ORDER + response: + body: + order: + id: id + location_id: D7AVYMEAPJ3A3 + reference_id: reference_id + source: + name: name + customer_id: customer_id + line_items: + - uid: ULkg0tQTRK2bkU9fNv3IJD + name: Item 1 + quantity: '1' + applied_discounts: + - uid: 9zr9S4dxvPAixvn0lpa1VC + discount_uid: zGsRZP69aqSSR9lq9euSPB + applied_money: + amount: 250 + currency: USD + base_price_money: + amount: 500 + currency: USD + variation_total_price_money: + amount: 500 + currency: USD + gross_sales_money: + amount: 500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 250 + currency: USD + total_money: + amount: 250 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + - uid: mumY8Nun4BC5aKe2yyx5a + name: Item 2 + quantity: '2' + applied_discounts: + - uid: qa8LwwZK82FgSEkQc2HYVC + discount_uid: zGsRZP69aqSSR9lq9euSPB + applied_money: + amount: 300 + currency: USD + base_price_money: + amount: 300 + currency: USD + variation_total_price_money: + amount: 600 + currency: USD + gross_sales_money: + amount: 600 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 300 + currency: USD + total_money: + amount: 300 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + taxes: + - {} + discounts: + - uid: zGsRZP69aqSSR9lq9euSPB + name: 50% Off + type: FIXED_PERCENTAGE + percentage: '50' + applied_money: + amount: 550 + currency: USD + scope: ORDER + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + net_amounts: + total_money: + amount: 550 + currency: USD + tax_money: + amount: 0 + currency: USD + discount_money: + amount: 550 + currency: USD + tip_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + rounding_adjustment: + uid: uid + name: name + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + metadata: + key: value + created_at: '2020-05-18T16:30:49.614Z' + updated_at: '2020-05-18T16:30:49.614Z' + closed_at: closed_at + state: OPEN + version: 1 + total_money: + amount: 550 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 550 + currency: USD + total_tip_money: + amount: 0 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + ticket_name: ticket_name + pricing_options: + auto_apply_discounts: true + auto_apply_taxes: true + rewards: + - id: id + reward_tier_id: reward_tier_id + net_amount_due_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + clone: + path: /v2/orders/clone + method: POST + auth: true + docs: >- + Creates a new order, in the `DRAFT` state, by duplicating an existing + order. The newly created order has + + only the core fields (such as line items, taxes, and discounts) copied + from the original order. + source: + openapi: openapi/openapi.json + display-name: CloneOrder + request: + name: CloneOrderRequest + body: + properties: + order_id: + type: string + docs: The ID of the order to clone. + version: + type: optional + docs: >- + An optional order version for concurrency protection. + + + If a version is provided, it must match the latest stored + version of the order to clone. + + If a version is not provided, the API clones the latest version. + idempotency_key: + type: optional> + docs: >- + A value you specify that uniquely identifies this clone request. + + + If you are unsure whether a particular order was cloned + successfully, + + you can reattempt the call with the same idempotency key without + + worrying about creating duplicate cloned orders. + + The originally cloned order is returned. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + content-type: application/json + response: + docs: Success + type: root.CloneOrderResponse + status-code: 200 + examples: + - request: + order_id: ZAISEM52YcpmcWAzERDOyiWS123 + version: 3 + idempotency_key: UNIQUE_STRING + response: + body: + order: + id: CAISENgvlJ6jLWAzERDzjyHVybY + location_id: 057P5VYJ4A5X1 + reference_id: my-order-001 + source: + name: My App + customer_id: customer_id + line_items: + - uid: 8uSwfzvUImn3IRrvciqlXC + name: New York Strip Steak + quantity: '1' + applied_taxes: + - uid: aKG87ArnDpvMLSZJHxWUl + tax_uid: state-sales-tax + applied_money: + amount: 136 + currency: USD + applied_discounts: + - uid: jWdgP1TpHPFBuVrz81mXVC + discount_uid: membership-discount + applied_money: + amount: 8 + currency: USD + - uid: jnZOjjVY57eRcQAVgEwFuC + discount_uid: labor-day-sale + applied_money: + amount: 79 + currency: USD + base_price_money: + amount: 1599 + currency: USD + variation_total_price_money: + amount: 1599 + currency: USD + gross_sales_money: + amount: 1599 + currency: USD + total_tax_money: + amount: 136 + currency: USD + total_discount_money: + amount: 87 + currency: USD + total_money: + amount: 1648 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + - uid: v8ZuEXpOJpb0bazLuvrLDB + name: New York Steak + quantity: '2' + catalog_object_id: BEMYCSMIJL46OCDV4KYIKXIB + variation_name: Larger + modifiers: + - uid: Lo3qMMckDluu9Qsb58d4CC + catalog_object_id: CHQX7Y4KY6N5KINJKZCFURPZ + name: Well + base_price_money: + amount: 50 + currency: USD + total_price_money: + amount: 100 + currency: USD + applied_taxes: + - uid: v1dAgrfUVUPTnVTf9sRPz + tax_uid: state-sales-tax + applied_money: + amount: 374 + currency: USD + applied_discounts: + - uid: nUXvdsIItfKko0dbYtY58C + discount_uid: membership-discount + applied_money: + amount: 22 + currency: USD + - uid: qSdkOOOernlVQqsJ94SPjB + discount_uid: labor-day-sale + applied_money: + amount: 224 + currency: USD + - uid: y7bVl4njrWAnfDwmz19izB + discount_uid: one-dollar-off + applied_money: + amount: 100 + currency: USD + base_price_money: + amount: 2200 + currency: USD + variation_total_price_money: + amount: 4400 + currency: USD + gross_sales_money: + amount: 4500 + currency: USD + total_tax_money: + amount: 374 + currency: USD + total_discount_money: + amount: 346 + currency: USD + total_money: + amount: 4528 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + taxes: + - uid: state-sales-tax + name: State Sales Tax + type: ADDITIVE + percentage: '9' + applied_money: + amount: 510 + currency: USD + scope: ORDER + discounts: + - uid: membership-discount + catalog_object_id: DB7L55ZH2BGWI4H23ULIWOQ7 + name: Membership Discount + type: FIXED_PERCENTAGE + percentage: '0.5' + applied_money: + amount: 30 + currency: USD + scope: ORDER + - uid: labor-day-sale + name: Labor Day Sale + type: FIXED_PERCENTAGE + percentage: '5' + applied_money: + amount: 303 + currency: USD + scope: ORDER + - uid: one-dollar-off + name: Sale - $1.00 off + type: FIXED_AMOUNT + amount_money: + amount: 100 + currency: USD + applied_money: + amount: 100 + currency: USD + scope: LINE_ITEM + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + net_amounts: + total_money: + amount: 6176 + currency: USD + tax_money: + amount: 510 + currency: USD + discount_money: + amount: 433 + currency: USD + tip_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + rounding_adjustment: + uid: uid + name: name + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + metadata: + key: value + created_at: '2020-01-17T20:47:53.293Z' + updated_at: '2020-01-17T20:47:53.293Z' + closed_at: closed_at + state: DRAFT + version: 1 + total_money: + amount: 6176 + currency: USD + total_tax_money: + amount: 510 + currency: USD + total_discount_money: + amount: 433 + currency: USD + total_tip_money: + amount: 0 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + ticket_name: ticket_name + pricing_options: + auto_apply_discounts: true + auto_apply_taxes: true + rewards: + - id: id + reward_tier_id: reward_tier_id + net_amount_due_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + search: + path: /v2/orders/search + method: POST + auth: true + docs: >- + Search all orders for one or more locations. Orders include all sales, + + returns, and exchanges regardless of how or when they entered the Square + + ecosystem (such as Point of Sale, Invoices, and Connect APIs). + + + `SearchOrders` requests need to specify which locations to search and + define a + + [SearchOrdersQuery](entity:SearchOrdersQuery) object that controls + + how to sort or filter the results. Your `SearchOrdersQuery` can: + + Set filter criteria. + Set the sort order. + Determine whether to return results as complete `Order` objects or as + [OrderEntry](entity:OrderEntry) objects. + + + Note that details for orders processed with Square Point of Sale while + in + + offline mode might not be transmitted to Square for up to 72 hours. + Offline + + orders have a `created_at` value that reflects the time the order was + created, + + not the time it was subsequently transmitted to Square. + source: + openapi: openapi/openapi.json + display-name: SearchOrders + request: + name: SearchOrdersRequest + body: + properties: + location_ids: + type: optional> + docs: >- + The location IDs for the orders to query. All locations must + belong to + + the same merchant. + + + Max: 10 location IDs. + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this cursor to retrieve the next set of results for your + original query. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + query: + type: optional + docs: >- + Query conditions used to filter or sort the results. Note that + when + + retrieving additional pages using a cursor, you must use the + original query. + limit: + type: optional + docs: |- + The maximum number of results to be returned in a single page. + + Default: `500` + Max: `1000` + return_entries: + type: optional + docs: >- + A Boolean that controls the format of the search results. If + `true`, + + `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. + If `false`, `SearchOrders` + + returns complete order objects. + + + Default: `false`. + content-type: application/json + response: + docs: Success + type: root.SearchOrdersResponse + status-code: 200 + examples: + - request: + location_ids: + - 057P5VYJ4A5X1 + - 18YC4JDH91E1H + query: + filter: + state_filter: + states: + - COMPLETED + date_time_filter: + closed_at: + start_at: '2018-03-03T20:00:00+00:00' + end_at: '2019-03-04T21:54:45+00:00' + sort: + sort_field: CLOSED_AT + sort_order: DESC + limit: 3 + return_entries: true + response: + body: + order_entries: + - order_id: CAISEM82RcpmcFBM0TfOyiHV3es + version: 1 + location_id: 057P5VYJ4A5X1 + - order_id: CAISENgvlJ6jLWAzERDzjyHVybY + version: 1 + location_id: 18YC4JDH91E1H + - order_id: CAISEM52YcpmcWAzERDOyiWS3ty + version: 1 + location_id: 057P5VYJ4A5X1 + orders: + - id: id + location_id: location_id + reference_id: reference_id + customer_id: customer_id + line_items: + - quantity: quantity + taxes: + - {} + discounts: + - {} + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + created_at: created_at + updated_at: updated_at + closed_at: closed_at + state: OPEN + version: 1 + ticket_name: ticket_name + rewards: + - id: id + reward_tier_id: reward_tier_id + cursor: '123' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/orders/{order_id} + method: GET + auth: true + docs: Retrieves an [Order](entity:Order) by ID. + source: + openapi: openapi/openapi.json + display-name: RetrieveOrder + request: + name: GetOrdersRequest + path-parameters: + order_id: + type: string + docs: The ID of the order to retrieve. + response: + docs: Success + type: root.GetOrderResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + response: + body: + order: + id: CAISENgvlJ6jLWAzERDzjyHVybY + location_id: D7AVYMEAPJ3A3 + reference_id: reference_id + source: + name: name + customer_id: customer_id + line_items: + - uid: ULkg0tQTRK2bkU9fNv3IJD + name: Item 1 + quantity: '1' + applied_discounts: + - uid: 9zr9S4dxvPAixvn0lpa1VC + discount_uid: zGsRZP69aqSSR9lq9euSPB + applied_money: + amount: 250 + currency: USD + base_price_money: + amount: 500 + currency: USD + variation_total_price_money: + amount: 500 + currency: USD + gross_sales_money: + amount: 500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 250 + currency: USD + total_money: + amount: 250 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + - uid: mumY8Nun4BC5aKe2yyx5a + name: Item 2 + quantity: '2' + applied_discounts: + - uid: qa8LwwZK82FgSEkQc2HYVC + discount_uid: zGsRZP69aqSSR9lq9euSPB + applied_money: + amount: 300 + currency: USD + base_price_money: + amount: 300 + currency: USD + variation_total_price_money: + amount: 600 + currency: USD + gross_sales_money: + amount: 600 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 300 + currency: USD + total_money: + amount: 300 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + taxes: + - {} + discounts: + - uid: zGsRZP69aqSSR9lq9euSPB + name: 50% Off + type: FIXED_PERCENTAGE + percentage: '50' + applied_money: + amount: 550 + currency: USD + scope: ORDER + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + net_amounts: + total_money: + amount: 550 + currency: USD + tax_money: + amount: 0 + currency: USD + discount_money: + amount: 550 + currency: USD + tip_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + rounding_adjustment: + uid: uid + name: name + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + metadata: + key: value + created_at: '2020-05-18T16:30:49.614Z' + updated_at: '2020-05-18T16:30:49.614Z' + closed_at: closed_at + state: OPEN + version: 1 + total_money: + amount: 550 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 550 + currency: USD + total_tip_money: + amount: 0 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + ticket_name: ticket_name + pricing_options: + auto_apply_discounts: true + auto_apply_taxes: true + rewards: + - id: id + reward_tier_id: reward_tier_id + net_amount_due_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/orders/{order_id} + method: PUT + auth: true + docs: >- + Updates an open [order](entity:Order) by adding, replacing, or deleting + + fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. + + + An `UpdateOrder` request requires the following: + + + - The `order_id` in the endpoint path, identifying the order to update. + + - The latest `version` of the order to update. + + - The [sparse + order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + + containing only the fields to update and the version to which the update + is + + being applied. + + - If deleting fields, the [dot notation + paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + + identifying the fields to clear. + + + To pay for an order, see + + [Pay for + Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + source: + openapi: openapi/openapi.json + display-name: UpdateOrder + request: + name: UpdateOrderRequest + path-parameters: + order_id: + type: string + docs: The ID of the order to update. + body: + properties: + order: + type: optional + docs: >- + The [sparse + order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + + containing only the fields to update and the version to which + the update is + + being applied. + fields_to_clear: + type: optional>> + docs: >- + The [dot notation + paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + + fields to clear. For example, `line_items[uid].note`. + + For more information, see [Deleting + fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). + idempotency_key: + type: optional> + docs: >- + A value you specify that uniquely identifies this update + request. + + + If you are unsure whether a particular update was applied to an + order successfully, + + you can reattempt it with the same idempotency key without + + worrying about creating duplicate updates to the order. + + The latest order version is returned. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + maxLength: 192 + content-type: application/json + response: + docs: Success + type: root.UpdateOrderResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + request: + order: + location_id: location_id + line_items: + - uid: cookie_uid + name: COOKIE + quantity: '2' + base_price_money: + amount: 200 + currency: USD + version: 1 + fields_to_clear: + - discounts + idempotency_key: UNIQUE_STRING + response: + body: + order: + id: DREk7wJcyXNHqULq8JJ2iPAsluJZY + location_id: MXVQSVNDGN3C8 + reference_id: reference_id + source: + name: Cookies + customer_id: customer_id + line_items: + - uid: EuYkakhmu3ksHIds5Hiot + name: Small Coffee + quantity: '1' + base_price_money: + amount: 500 + currency: USD + variation_total_price_money: + amount: 500 + currency: USD + gross_sales_money: + amount: 500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_money: + amount: 500 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + - uid: cookie_uid + name: COOKIE + quantity: '2' + base_price_money: + amount: 200 + currency: USD + variation_total_price_money: + amount: 400 + currency: USD + gross_sales_money: + amount: 400 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_money: + amount: 400 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + taxes: + - {} + discounts: + - {} + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + net_amounts: + total_money: + amount: 900 + currency: USD + tax_money: + amount: 0 + currency: USD + discount_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + rounding_adjustment: + uid: uid + name: name + tenders: + - type: CARD + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + metadata: + key: value + created_at: '2019-08-23T18:26:18.243Z' + updated_at: '2019-08-23T18:33:47.523Z' + closed_at: closed_at + state: OPEN + version: 2 + total_money: + amount: 900 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + total_service_charge_money: + amount: 0 + currency: USD + ticket_name: ticket_name + pricing_options: + auto_apply_discounts: true + auto_apply_taxes: true + rewards: + - id: id + reward_tier_id: reward_tier_id + net_amount_due_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + pay: + path: /v2/orders/{order_id}/pay + method: POST + auth: true + docs: >- + Pay for an [order](entity:Order) using one or more approved + [payments](entity:Payment) + + or settle an order with a total of `0`. + + + The total of the `payment_ids` listed in the request must be equal to + the order + + total. Orders with a total amount of `0` can be marked as paid by + specifying an empty + + array of `payment_ids` in the request. + + + To be used with `PayOrder`, a payment must: + + + - Reference the order by specifying the `order_id` when [creating the + payment](api-endpoint:Payments-CreatePayment). + + Any approved payments that reference the same `order_id` not specified + in the + + `payment_ids` is canceled. + + - Be approved with [delayed + capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). + + Using a delayed capture payment with `PayOrder` completes the approved + payment. + source: + openapi: openapi/openapi.json + display-name: PayOrder + request: + name: PayOrderRequest + path-parameters: + order_id: + type: string + docs: The ID of the order being paid. + body: + properties: + idempotency_key: + type: string + docs: >- + A value you specify that uniquely identifies this request among + requests you have sent. If + + you are unsure whether a particular payment request was + completed successfully, you can reattempt + + it with the same idempotency key without worrying about + duplicate payments. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + minLength: 1 + maxLength: 192 + order_version: + type: optional> + docs: >- + The version of the order being paid. If not supplied, the latest + version will be paid. + payment_ids: + type: optional>> + docs: |- + The IDs of the [payments](entity:Payment) to collect. + The payment total must match the order total. + content-type: application/json + response: + docs: Success + type: root.PayOrderResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + request: + idempotency_key: c043a359-7ad9-4136-82a9-c3f1d66dcbff + payment_ids: + - EnZdNAlWCmfh6Mt5FMNST1o7taB + - 0LRiVlbXVwe8ozu4KbZxd12mvaB + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + order: + id: lgwOlEityYPJtcuvKTVKT1pA986YY + location_id: P3CCK6HSNDAS7 + reference_id: reference_id + source: + name: Source Name + customer_id: customer_id + line_items: + - uid: QW6kofLHJK7JEKMjlSVP5C + name: Item 1 + quantity: '1' + base_price_money: + amount: 500 + currency: USD + gross_sales_money: + amount: 500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_money: + amount: 500 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + - uid: zhw8MNfRGdFQMI2WE1UBJD + name: Item 2 + quantity: '2' + base_price_money: + amount: 750 + currency: USD + gross_sales_money: + amount: 1500 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_money: + amount: 1500 + currency: USD + total_service_charge_money: + amount: 0 + currency: USD + taxes: + - {} + discounts: + - {} + service_charges: + - {} + fulfillments: + - {} + returns: + - {} + net_amounts: + total_money: + amount: 2000 + currency: USD + tax_money: + amount: 0 + currency: USD + discount_money: + amount: 0 + currency: USD + tip_money: + amount: 0 + currency: USD + service_charge_money: + amount: 0 + currency: USD + rounding_adjustment: + uid: uid + name: name + tenders: + - id: EnZdNAlWCmfh6Mt5FMNST1o7taB + location_id: P3CCK6HSNDAS7 + transaction_id: lgwOlEityYPJtcuvKTVKT1pA986YY + created_at: '2019-08-06T02:47:36.293Z' + amount_money: + amount: 1000 + currency: USD + type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + exp_month: 2 + exp_year: 2022 + fingerprint: >- + sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ + entry_method: KEYED + payment_id: EnZdNAlWCmfh6Mt5FMNST1o7taB + - id: 0LRiVlbXVwe8ozu4KbZxd12mvaB + location_id: P3CCK6HSNDAS7 + transaction_id: lgwOlEityYPJtcuvKTVKT1pA986YY + created_at: '2019-08-06T02:47:36.809Z' + amount_money: + amount: 1000 + currency: USD + type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + exp_month: 2 + exp_year: 2022 + fingerprint: >- + sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ + entry_method: KEYED + payment_id: 0LRiVlbXVwe8ozu4KbZxd12mvaB + refunds: + - id: id + location_id: location_id + tender_id: tender_id + reason: reason + amount_money: {} + status: PENDING + metadata: + key: value + created_at: '2019-08-06T02:47:35.693Z' + updated_at: '2019-08-06T02:47:37.140Z' + closed_at: '2019-08-06T02:47:37.140Z' + state: COMPLETED + version: 4 + total_money: + amount: 2000 + currency: USD + total_tax_money: + amount: 0 + currency: USD + total_discount_money: + amount: 0 + currency: USD + total_tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + total_service_charge_money: + amount: 0 + currency: USD + ticket_name: ticket_name + pricing_options: + auto_apply_discounts: true + auto_apply_taxes: true + rewards: + - id: id + reward_tier_id: reward_tier_id + net_amount_due_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/orders/customAttributeDefinitions.yml b/.mock/definition/orders/customAttributeDefinitions.yml new file mode 100644 index 00000000..f6b8bd52 --- /dev/null +++ b/.mock/definition/orders/customAttributeDefinitions.yml @@ -0,0 +1,378 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/orders/custom-attribute-definitions + method: GET + auth: true + docs: >- + Lists the order-related [custom attribute + definitions](entity:CustomAttributeDefinition) that belong to a Square + seller account. + + + When all response pages are retrieved, the results include all custom + attribute definitions + + that are visible to the requesting application, including those that are + created by other + + applications and set to `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. Note that + + seller-defined custom attributes (also known as custom fields) are + always set to `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attribute_definitions + source: + openapi: openapi/openapi.json + display-name: ListOrderCustomAttributeDefinitions + request: + name: ListCustomAttributeDefinitionsRequest + query-parameters: + visibility_filter: + type: optional> + docs: >- + Requests that all of the custom attributes be returned, or only + those that are read-only or read-write. + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + response: + docs: Success + type: root.ListOrderCustomAttributeDefinitionsResponse + status-code: 200 + examples: + - response: + body: + custom_attribute_definitions: + - key: cover-count + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Cover count + description: The number of people seated at a table + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-11-16T18:03:44.051Z' + created_at: '2022-11-16T18:03:44.051Z' + - key: seat-number + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Seat number + description: The identifier for a particular seat + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-11-16T18:04:32.059Z' + created_at: '2022-11-16T18:04:32.059Z' + - key: table-number + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Table number + description: The identifier for a particular table + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-11-16T18:04:21.912Z' + created_at: '2022-11-16T18:04:21.912Z' + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + create: + path: /v2/orders/custom-attribute-definitions + method: POST + auth: true + docs: >- + Creates an order-related custom attribute definition. Use this endpoint + to + + define a custom attribute that can be associated with orders. + + + After creating a custom attribute definition, you can set the custom + attribute for orders + + in the Square seller account. + source: + openapi: openapi/openapi.json + display-name: CreateOrderCustomAttributeDefinition + request: + name: CreateOrderCustomAttributeDefinitionRequest + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition to create. Note the following: + + - With the exception of the `Selection` data type, the `schema` + is specified as a simple URL to the JSON schema + + definition hosted on the Square CDN. For more information, + including supported values and constraints, see + + [Specifying the + schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + + - If provided, `name` must be unique (case-sensitive) across all + visible customer-related custom attribute definitions for the + seller. + + - All custom attributes are visible in exported customer data, + including those set to `VISIBILITY_HIDDEN`. + idempotency_key: + type: optional + docs: >- + A unique identifier for this request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CreateOrderCustomAttributeDefinitionResponse + status-code: 200 + examples: + - request: + custom_attribute_definition: + key: cover-count + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Cover count + description: The number of people seated at a table + visibility: VISIBILITY_READ_WRITE_VALUES + idempotency_key: IDEMPOTENCY_KEY + response: + body: + custom_attribute_definition: + key: cover-count + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Cover count + description: The number of people seated at a table + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-10-06T16:53:23.141Z' + created_at: '2022-10-06T16:53:23.141Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/orders/custom-attribute-definitions/{key} + method: GET + auth: true + docs: >- + Retrieves an order-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + + To retrieve a custom attribute definition created by another + application, the `visibility` + + setting must be `VISIBILITY_READ_ONLY` or + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveOrderCustomAttributeDefinition + request: + name: GetCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to retrieve. + query-parameters: + version: + type: optional> + docs: >- + To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, include this optional field and specify the current + version of the custom attribute. + response: + docs: Success + type: root.RetrieveOrderCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + custom_attribute_definition: + key: cover-count + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Cover count + description: The number of people seated at a table + visibility: VISIBILITY_READ_WRITE_VALUES + version: 1 + updated_at: '2022-10-06T16:53:23.141Z' + created_at: '2022-10-06T16:53:23.141Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/orders/custom-attribute-definitions/{key} + method: PUT + auth: true + docs: >- + Updates an order-related custom attribute definition for a Square seller + account. + + + Only the definition owner can update a custom attribute definition. Note + that sellers can view all custom attributes in exported customer data, + including those set to `VISIBILITY_HIDDEN`. + source: + openapi: openapi/openapi.json + display-name: UpdateOrderCustomAttributeDefinition + request: + name: UpdateOrderCustomAttributeDefinitionRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to update. + body: + properties: + custom_attribute_definition: + type: root.CustomAttributeDefinition + docs: >- + The custom attribute definition that contains the fields to + update. This endpoint supports sparse updates, + + so only new or changed fields need to be included in the + request. For more information, see + + [Updatable definition + fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + + To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the + current version of the custom attribute definition. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdateOrderCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + request: + custom_attribute_definition: + key: cover-count + visibility: VISIBILITY_READ_ONLY + version: 1 + idempotency_key: IDEMPOTENCY_KEY + response: + body: + custom_attribute_definition: + key: cover-count + schema: + ref: >- + https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number + name: Cover count + description: The number of people seated at a table + visibility: VISIBILITY_READ_ONLY + version: 2 + updated_at: '2022-11-16T17:44:11.436Z' + created_at: '2022-11-16T16:53:23.141Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/orders/custom-attribute-definitions/{key} + method: DELETE + auth: true + docs: >- + Deletes an order-related [custom attribute + definition](entity:CustomAttributeDefinition) from a Square seller + account. + + + Only the definition owner can delete a custom attribute definition. + source: + openapi: openapi/openapi.json + display-name: DeleteOrderCustomAttributeDefinition + request: + name: DeleteCustomAttributeDefinitionsRequest + path-parameters: + key: + type: string + docs: The key of the custom attribute definition to delete. + response: + docs: Success + type: root.DeleteOrderCustomAttributeDefinitionResponse + status-code: 200 + examples: + - path-parameters: + key: key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/orders/customAttributes.yml b/.mock/definition/orders/customAttributes.yml new file mode 100644 index 00000000..b096cf25 --- /dev/null +++ b/.mock/definition/orders/customAttributes.yml @@ -0,0 +1,549 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + batchDelete: + path: /v2/orders/custom-attributes/bulk-delete + method: POST + auth: true + docs: >- + Deletes order [custom attributes](entity:CustomAttribute) as a bulk + operation. + + + Use this endpoint to delete one or more custom attributes from one or + more orders. + + A custom attribute is based on a custom attribute definition in a Square + seller account. (To create a + + custom attribute definition, use the + [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) + endpoint.) + + + This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 + individual delete + + requests and returns a map of individual delete responses. Each delete + request has a unique ID + + and provides an order ID and custom attribute. Each delete response is + returned with the ID + + of the corresponding request. + + + To delete a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkDeleteOrderCustomAttributes + request: + name: BulkDeleteOrderCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + A map of requests that correspond to individual delete + operations for custom attributes. + content-type: application/json + response: + docs: Success + type: root.BulkDeleteOrderCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + cover-count: + key: cover-count + order_id: 7BbXGEIWNldxAzrtGf9GPVZTwZ4F + table-number: + key: table-number + order_id: 7BbXGEIWNldxAzrtGf9GPVZTwZ4F + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + values: + cover-count: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + table-number: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + batchUpsert: + path: /v2/orders/custom-attributes/bulk-upsert + method: POST + auth: true + docs: >- + Creates or updates order [custom attributes](entity:CustomAttribute) as + a bulk operation. + + + Use this endpoint to delete one or more custom attributes from one or + more orders. + + A custom attribute is based on a custom attribute definition in a Square + seller account. (To create a + + custom attribute definition, use the + [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) + endpoint.) + + + This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 + individual upsert + + requests and returns a map of individual upsert responses. Each upsert + request has a unique ID + + and provides an order ID and custom attribute. Each upsert response is + returned with the ID + + of the corresponding request. + + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: BulkUpsertOrderCustomAttributes + request: + name: BulkUpsertOrderCustomAttributesRequest + body: + properties: + values: + type: >- + map + docs: >- + A map of requests that correspond to individual upsert + operations for custom attributes. + content-type: application/json + response: + docs: Success + type: root.BulkUpsertOrderCustomAttributesResponse + status-code: 200 + examples: + - request: + values: + cover-count: + custom_attribute: + key: cover-count + value: '6' + version: 2 + order_id: 7BbXGEIWNldxAzrtGf9GPVZTwZ4F + table-number: + custom_attribute: + key: table-number + value: '11' + version: 4 + order_id: 7BbXGEIWNldxAzrtGf9GPVZTwZ4F + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + values: + cover-count: + custom_attribute: + key: cover-count + value: '6' + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-22T21:28:35.721Z' + created_at: '2022-11-22T21:27:33.429Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + table-number: + custom_attribute: + key: table-number + value: '11' + visibility: VISIBILITY_HIDDEN + updated_at: '2022-11-22T21:28:35.726Z' + created_at: '2022-11-22T21:24:57.823Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + list: + path: /v2/orders/{order_id}/custom-attributes + method: GET + auth: true + docs: >- + Lists the [custom attributes](entity:CustomAttribute) associated with an + order. + + + You can use the `with_definitions` query parameter to also retrieve + custom attribute definitions + + in the same call. + + + When all response pages are retrieved, the results include all custom + attributes that are + + visible to the requesting application, including those that are owned by + other applications + + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.custom_attributes + source: + openapi: openapi/openapi.json + display-name: ListOrderCustomAttributes + request: + name: ListCustomAttributesRequest + path-parameters: + order_id: + type: string + docs: The ID of the target [order](entity:Order). + query-parameters: + visibility_filter: + type: optional> + docs: >- + Requests that all of the custom attributes be returned, or only + those that are read-only or read-write. + cursor: + type: optional> + docs: >- + The cursor returned in the paged response from the previous call + to this endpoint. + + Provide this cursor to retrieve the next page of results for your + original request. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + limit: + type: optional> + docs: >- + The maximum number of results to return in a single paged + response. This limit is advisory. + + The response might contain more or fewer results. The minimum + value is 1 and the maximum value is 100. + + The default value is 20. + + For more information, see + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + with_definitions: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of each + + custom attribute. Set this parameter to `true` to get the name and + description of each custom attribute, + + information about the data type, or other definition details. The + default value is `false`. + response: + docs: Success + type: root.ListOrderCustomAttributesResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + response: + body: + custom_attributes: + - key: wayne-test-15 + value: TEST + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + updated_at: '2022-11-10T17:31:36.111Z' + created_at: '2022-11-10T17:31:36.111Z' + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} + method: GET + auth: true + docs: >- + Retrieves a [custom attribute](entity:CustomAttribute) associated with + an order. + + + You can use the `with_definition` query parameter to also retrieve the + custom attribute definition + + in the same call. + + + To retrieve a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that + seller-defined custom attributes + + also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: RetrieveOrderCustomAttribute + request: + name: GetCustomAttributesRequest + path-parameters: + order_id: + type: string + docs: The ID of the target [order](entity:Order). + custom_attribute_key: + type: string + docs: >- + The key of the custom attribute to retrieve. This key must match + the key of an + + existing custom attribute definition. + query-parameters: + version: + type: optional> + docs: >- + To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, include this optional field and specify the current + version of the custom attribute. + with_definition: + type: optional> + default: false + docs: >- + Indicates whether to return the [custom attribute + definition](entity:CustomAttributeDefinition) in the `definition` + field of each + + custom attribute. Set this parameter to `true` to get the name and + description of each custom attribute, + + information about the data type, or other definition details. The + default value is `false`. + response: + docs: Success + type: root.RetrieveOrderCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + custom_attribute_key: custom_attribute_key + response: + body: + custom_attribute: + key: cover-count + value: '6' + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2022-11-22T21:28:35.721Z' + created_at: '2022-11-22T21:27:33.429Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + upsert: + path: /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} + method: POST + auth: true + docs: >- + Creates or updates a [custom attribute](entity:CustomAttribute) for an + order. + + + Use this endpoint to set the value of a custom attribute for a specific + order. + + A custom attribute is based on a custom attribute definition in a Square + seller account. (To create a + + custom attribute definition, use the + [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) + endpoint.) + + + To create or update a custom attribute owned by another application, the + `visibility` setting + + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: UpsertOrderCustomAttribute + request: + name: UpsertOrderCustomAttributeRequest + path-parameters: + order_id: + type: string + docs: The ID of the target [order](entity:Order). + custom_attribute_key: + type: string + docs: >- + The key of the custom attribute to create or update. This key + must match the key + + of an existing custom attribute definition. + body: + properties: + custom_attribute: + type: root.CustomAttribute + docs: >- + The custom attribute to create or update, with the following + fields: + + + - `value`. This value must conform to the `schema` specified by + the definition. + + For more information, see [Value data + types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + + - `version`. To enable [optimistic + concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + + control, include this optional field and specify the current + version of the custom attribute. + idempotency_key: + type: optional> + docs: >- + A unique identifier for this request, used to ensure + idempotency. + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpsertOrderCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + custom_attribute_key: custom_attribute_key + request: + custom_attribute: + key: table-number + value: '42' + version: 1 + response: + body: + custom_attribute: + key: table-number + value: '42' + version: 1 + visibility: VISIBILITY_READ_WRITE_VALUES + definition: + key: key + schema: + key: value + name: name + description: description + visibility: VISIBILITY_HIDDEN + version: 1 + updated_at: updated_at + created_at: created_at + updated_at: '2022-10-06T20:41:22.673Z' + created_at: '2022-10-06T20:41:22.673Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + delete: + path: /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} + method: DELETE + auth: true + docs: >- + Deletes a [custom attribute](entity:CustomAttribute) associated with a + customer profile. + + + To delete a custom attribute owned by another application, the + `visibility` setting must be + + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom + attributes + + (also known as custom fields) are always set to + `VISIBILITY_READ_WRITE_VALUES`. + source: + openapi: openapi/openapi.json + display-name: DeleteOrderCustomAttribute + request: + name: DeleteCustomAttributesRequest + path-parameters: + order_id: + type: string + docs: The ID of the target [order](entity:Order). + custom_attribute_key: + type: string + docs: >- + The key of the custom attribute to delete. This key must match + the key of an + + existing custom attribute definition. + response: + docs: Success + type: root.DeleteOrderCustomAttributeResponse + status-code: 200 + examples: + - path-parameters: + order_id: order_id + custom_attribute_key: custom_attribute_key + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/payments.yml b/.mock/definition/payments.yml new file mode 100644 index 00000000..793511f6 --- /dev/null +++ b/.mock/definition/payments.yml @@ -0,0 +1,1604 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/payments + method: GET + auth: true + docs: >- + Retrieves a list of payments taken by the account making the request. + + + Results are eventually consistent, and new payments or changes to + payments might take several + + seconds to appear. + + + The maximum results per page is 100. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.payments + source: + openapi: openapi/openapi.json + display-name: ListPayments + request: + name: ListPaymentsRequest + query-parameters: + begin_time: + type: optional> + docs: >- + Indicates the start of the time range to retrieve payments for, in + RFC 3339 format. + + The range is determined using the `created_at` field for each + Payment. + + Inclusive. Default: The current time minus one year. + end_time: + type: optional> + docs: >- + Indicates the end of the time range to retrieve payments for, in + RFC 3339 format. The + + range is determined using the `created_at` field for each Payment. + + + Default: The current time. + sort_order: + type: optional> + docs: >- + The order in which results are listed by + `ListPaymentsRequest.sort_field`: + + - `ASC` - Oldest to newest. + + - `DESC` - Newest to oldest (default). + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + location_id: + type: optional> + docs: >- + Limit results to the location supplied. By default, results are + returned + + for the default (main) location associated with the seller. + total: + type: optional> + docs: The exact amount in the `total_money` for a payment. + last_4: + type: optional> + docs: The last four digits of a payment card. + card_brand: + type: optional> + docs: The brand of the payment card (for example, VISA). + limit: + type: optional> + docs: >- + The maximum number of results to be returned in a single page. + + It is possible to receive fewer results than the specified limit + on a given page. + + + The default value of 100 is also the maximum allowed value. If the + provided value is + + greater than 100, it is ignored and the default value is used + instead. + + + Default: `100` + is_offline_payment: + type: optional> + default: false + docs: Whether the payment was taken offline or not. + offline_begin_time: + type: optional> + docs: >- + Indicates the start of the time range for which to retrieve + offline payments, in RFC 3339 + + format for timestamps. The range is determined using the + + `offline_payment_details.client_created_at` field for each + Payment. If set, payments without a + + value set in `offline_payment_details.client_created_at` will not + be returned. + + + Default: The current time. + offline_end_time: + type: optional> + docs: >- + Indicates the end of the time range for which to retrieve offline + payments, in RFC 3339 + + format for timestamps. The range is determined using the + + `offline_payment_details.client_created_at` field for each + Payment. If set, payments without a + + value set in `offline_payment_details.client_created_at` will not + be returned. + + + Default: The current time. + updated_at_begin_time: + type: optional> + docs: >- + Indicates the start of the time range to retrieve payments for, in + RFC 3339 format. The + + range is determined using the `updated_at` field for each Payment. + updated_at_end_time: + type: optional> + docs: >- + Indicates the end of the time range to retrieve payments for, in + RFC 3339 format. The + + range is determined using the `updated_at` field for each Payment. + sort_field: + type: optional> + docs: The field used to sort results by. The default is `CREATED_AT`. + response: + docs: Success + type: root.ListPaymentsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payments: + - id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + created_at: '2021-10-13T19:34:33.524Z' + updated_at: '2021-10-13T19:34:37.261Z' + amount_money: + amount: 555 + currency: USD + total_money: + amount: 555 + currency: USD + approved_money: + amount: 555 + currency: USD + processing_fee: + - effective_at: '2021-10-13T21:34:35.000Z' + type: INITIAL + amount_money: + amount: 34 + currency: USD + status: COMPLETED + delay_duration: PT168H + delay_action: CANCEL + delayed_until: '2021-10-20T19:34:33.524Z' + source_type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + fingerprint: >- + sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ + card_type: DEBIT + prepaid_type: NOT_PREPAID + bin: '411111' + entry_method: KEYED + cvv_status: CVV_ACCEPTED + avs_status: AVS_ACCEPTED + auth_result_code: 2Nkw7q + statement_description: SQ *EXAMPLE TEST GOSQ.C + card_payment_timeline: + authorized_at: '2021-10-13T19:34:33.680Z' + captured_at: '2021-10-13T19:34:34.340Z' + cash_details: + buyer_supplied_money: {} + external_details: + type: type + source: source + location_id: L88917AVBK2S5 + order_id: d7eKah653Z579f3gVtjlxpSlmUcZY + reference_id: reference_id + customer_id: customer_id + employee_id: TMoK_ogh6rH1o4dV + team_member_id: TMoK_ogh6rH1o4dV + refund_ids: + - refund_ids + terminal_checkout_id: terminal_checkout_id + buyer_email_address: buyer_email_address + note: Test Note + statement_description_identifier: statement_description_identifier + capabilities: + - capabilities + receipt_number: bP9m + receipt_url: >- + https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + application_details: + square_product: VIRTUAL_TERMINAL + application_id: sq0ids-Pw67AZAlLVB7hsRmwlJPuA + is_offline_payment: true + version_token: vguW2km0KpVCdAXZcNTZ438qg5LlVPTP4HO5OpiHNfa6o + cursor: cursor + create: + path: /v2/payments + method: POST + auth: true + docs: >- + Creates a payment using the provided source. You can use this endpoint + + to charge a card (credit/debit card or + + Square gift card) or record a payment that the seller received outside + of Square + + (cash payment from a buyer or a payment that an external entity + + processed on behalf of the seller). + + + The endpoint creates a + + `Payment` object and returns it in the response. + source: + openapi: openapi/openapi.json + display-name: CreatePayment + request: + name: CreatePaymentRequest + body: + properties: + source_id: + type: string + docs: >- + The ID for the source of funds for this payment. + + This could be a payment token generated by the Web Payments SDK + for any of its + + [supported + methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), + + including cards, bank transfers, Afterpay or Cash App Pay. If + recording a payment + + that the seller received outside of Square, specify either + "CASH" or "EXTERNAL". + + For more information, see + + [Take + Payments](https://developer.squareup.com/docs/payments-api/take-payments). + validation: + minLength: 1 + idempotency_key: + type: string + docs: >- + A unique string that identifies this `CreatePayment` request. + Keys can be any valid string + + but must be unique for every `CreatePayment` request. + + + Note: The number of allowed characters might be less than the + stated maximum, if multi-byte + + characters are used. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + minLength: 1 + maxLength: 45 + amount_money: + type: optional + docs: >- + The amount of money to accept for this payment, not including + `tip_money`. + + + The amount must be specified in the smallest denomination of the + applicable currency + + (for example, US dollar amounts are specified in cents). For + more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + + The currency code must match the currency associated with the + business + + that is accepting the payment. + tip_money: + type: optional + docs: >- + The amount designated as a tip, in addition to `amount_money`. + + + The amount must be specified in the smallest denomination of the + applicable currency + + (for example, US dollar amounts are specified in cents). For + more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + + The currency code must match the currency associated with the + business + + that is accepting the payment. + app_fee_money: + type: optional + docs: >- + The amount of money that the developer is taking as a fee + + for facilitating the payment on behalf of the seller. + + + The amount cannot be more than 90% of the total amount of the + payment. + + + The amount must be specified in the smallest denomination of the + applicable currency + + (for example, US dollar amounts are specified in cents). For + more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + + The fee currency code must match the currency associated with + the seller + + that is accepting the payment. The application must be from a + developer + + account in the same country and using the same currency code as + the seller. + + + For more information about the application fee scenario, see + + [Take Payments and Collect + Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth + permission is required. + + For more information, see + [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + delay_duration: + type: optional + docs: >- + The duration of time after the payment's creation when Square + automatically + + either completes or cancels the payment depending on the + `delay_action` field value. + + For more information, see + + [Time + threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + + This parameter should be specified as a time duration, in RFC + 3339 format. + + + Note: This feature is only supported for card payments. This + parameter can only be set for a delayed + + capture payment (`autocomplete=false`). + + + Default: + + + - Card-present payments: "PT36H" (36 hours) from the creation + time. + + - Card-not-present payments: "P7D" (7 days) from the creation + time. + delay_action: + type: optional + docs: >- + The action to be applied to the payment when the + `delay_duration` has elapsed. The action must be + + CANCEL or COMPLETE. For more information, see + + [Time + Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + + Default: CANCEL + autocomplete: + type: optional + docs: >- + If set to `true`, this payment will be completed when possible. + If + + set to `false`, this payment is held in an approved state until + either + + explicitly completed (captured) or canceled (voided). For more + information, see + + [Delayed + capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). + + + Default: true + order_id: + type: optional + docs: Associates a previously created order with this payment. + customer_id: + type: optional + docs: >- + The [Customer](entity:Customer) ID of the customer associated + with the payment. + + + This is required if the `source_id` refers to a card on file + created using the Cards API. + location_id: + type: optional + docs: >- + The location ID to associate with the payment. If not specified, + the [main + location](https://developer.squareup.com/docs/locations-api#about-the-main-location) + is + + used. + team_member_id: + type: optional + docs: >- + An optional [TeamMember](entity:TeamMember) ID to associate + with + + this payment. + reference_id: + type: optional + docs: >- + A user-defined ID to associate with the payment. + + + You can use this field to associate the payment to an entity in + an external system + + (for example, you might specify an order ID that is generated by + a third-party shopping cart). + validation: + maxLength: 40 + verification_token: + type: optional + docs: >- + An identifying token generated by + [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + + Verification tokens encapsulate customer device information and + 3-D Secure + + challenge results to indicate that Square has verified the buyer + identity. + + + For more information, see [SCA + Overview](https://developer.squareup.com/docs/sca-overview). + accept_partial_authorization: + type: optional + docs: >- + If set to `true` and charging a Square Gift Card, a payment + might be returned with + + `amount_money` equal to less than what was requested. For + example, a request for $20 when charging + + a Square Gift Card with a balance of $5 results in an APPROVED + payment of $5. You might choose + + to prompt the buyer for an additional payment to cover the + remainder or cancel the Gift Card + + payment. This field cannot be `true` when `autocomplete = true`. + + + For more information, see + + [Partial amount with Square Gift + Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). + + + Default: false + buyer_email_address: + type: optional + docs: The buyer's email address. + validation: + maxLength: 255 + buyer_phone_number: + type: optional + docs: >- + The buyer's phone number. + + Must follow the following format: + + 1. A leading + symbol (followed by a country code) + + 2. The phone number can contain spaces and the special + characters `(` , `)` , `-` , and `.`. + + Alphabetical characters aren't allowed. + + 3. The phone number must contain between 9 and 16 digits. + billing_address: + type: optional + docs: The buyer's billing address. + shipping_address: + type: optional + docs: The buyer's shipping address. + note: + type: optional + docs: >- + An optional note to be entered by the developer when creating a + payment. + validation: + maxLength: 500 + statement_description_identifier: + type: optional + docs: >- + Optional additional payment information to include on the + customer's card statement + + as part of the statement description. This can be, for example, + an invoice number, ticket number, + + or short description that uniquely identifies the purchase. + + + Note that the `statement_description_identifier` might get + truncated on the statement description + + to fit the required information including the Square identifier + (SQ *) and name of the + + seller taking the payment. + validation: + maxLength: 20 + cash_details: + type: optional + docs: >- + Additional details required when recording a cash payment + (`source_id` is CASH). + external_details: + type: optional + docs: >- + Additional details required when recording an external payment + (`source_id` is EXTERNAL). + customer_details: + type: optional + docs: Details about the customer making the payment. + offline_payment_details: + type: optional + docs: >- + An optional field for specifying the offline payment details. + This is intended for + + internal 1st-party callers only. + content-type: application/json + response: + docs: Success + type: root.CreatePaymentResponse + status-code: 200 + examples: + - request: + source_id: ccof:GaJGNaZa8x4OgDJn4GB + idempotency_key: 7b0f3ec5-086a-4871-8f13-3c81b3875218 + amount_money: + amount: 1000 + currency: USD + app_fee_money: + amount: 10 + currency: USD + autocomplete: true + customer_id: W92WH6P11H4Z77CTET0RNTGFW8 + location_id: L88917AVBK2S5 + reference_id: '123456' + note: Brief description + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment: + id: R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY + created_at: '2021-10-13T21:14:29.577Z' + updated_at: '2021-10-13T21:14:30.504Z' + amount_money: + amount: 1000 + currency: USD + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + total_money: + amount: 1000 + currency: USD + app_fee_money: + amount: 10 + currency: USD + approved_money: + amount: 1000 + currency: USD + processing_fee: + - {} + refunded_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: COMPLETED + delay_duration: PT168H + delay_action: CANCEL + delayed_until: '2021-10-20T21:14:29.577Z' + source_type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + fingerprint: >- + sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ + card_type: DEBIT + prepaid_type: NOT_PREPAID + bin: '411111' + entry_method: ON_FILE + cvv_status: CVV_ACCEPTED + avs_status: AVS_ACCEPTED + auth_result_code: vNEn2f + application_identifier: application_identifier + application_name: application_name + application_cryptogram: application_cryptogram + verification_method: verification_method + verification_results: verification_results + statement_description: SQ *EXAMPLE TEST GOSQ.C + card_payment_timeline: + authorized_at: '2021-10-13T21:14:29.732Z' + captured_at: '2021-10-13T21:14:30.504Z' + refund_requires_card_presence: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + cash_details: + buyer_supplied_money: {} + bank_account_details: + bank_name: bank_name + transfer_type: transfer_type + account_ownership_type: account_ownership_type + fingerprint: fingerprint + country: country + statement_description: statement_description + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + external_details: + type: type + source: source + source_id: source_id + wallet_details: + status: status + brand: brand + buy_now_pay_later_details: + brand: brand + square_account_details: + payment_source_token: payment_source_token + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + location_id: L88917AVBK2S5 + order_id: pRsjRTgFWATl7so6DxdKBJa7ssbZY + reference_id: '123456' + customer_id: W92WH6P11H4Z77CTET0RNTGFW8 + employee_id: employee_id + team_member_id: team_member_id + refund_ids: + - refund_ids + risk_evaluation: + created_at: '2021-10-13T21:14:30.423Z' + risk_level: NORMAL + terminal_checkout_id: terminal_checkout_id + buyer_email_address: buyer_email_address + billing_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + note: Brief Description + statement_description_identifier: statement_description_identifier + capabilities: + - capabilities + receipt_number: R2B3 + receipt_url: https://squareup.com/receipt/preview/EXAMPLE_RECEIPT_ID + device_details: + device_id: device_id + device_installation_id: device_installation_id + device_name: device_name + application_details: + square_product: ECOMMERCE_API + application_id: sq0ids-TcgftTEtKxJTRF1lCFJ9TA + is_offline_payment: true + offline_payment_details: + client_created_at: client_created_at + version_token: TPtNEOBOa6Qq6E3C3IjckSVOM6b3hMbfhjvTxHBQUsB6o + cancelByIdempotencyKey: + path: /v2/payments/cancel + method: POST + auth: true + docs: >- + Cancels (voids) a payment identified by the idempotency key that is + specified in the + + request. + + + Use this method when the status of a `CreatePayment` request is unknown + (for example, after you send a + + `CreatePayment` request, a network error occurs and you do not get a + response). In this case, you can + + direct Square to cancel the payment using this endpoint. In the request, + you provide the same + + idempotency key that you provided in your `CreatePayment` request that + you want to cancel. After + + canceling the payment, you can submit your `CreatePayment` request + again. + + + Note that if no payment with the specified idempotency key is found, no + action is taken and the endpoint + + returns successfully. + source: + openapi: openapi/openapi.json + display-name: CancelPaymentByIdempotencyKey + request: + name: CancelPaymentByIdempotencyKeyRequest + body: + properties: + idempotency_key: + type: string + docs: The `idempotency_key` identifying the payment to be canceled. + validation: + minLength: 1 + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CancelPaymentByIdempotencyKeyResponse + status-code: 200 + examples: + - request: + idempotency_key: a7e36d40-d24b-11e8-b568-0800200c9a66 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/payments/{payment_id} + method: GET + auth: true + docs: Retrieves details for a specific payment. + source: + openapi: openapi/openapi.json + display-name: GetPayment + request: + name: GetPaymentsRequest + path-parameters: + payment_id: + type: string + docs: A unique ID for the desired payment. + response: + docs: Success + type: root.GetPaymentResponse + status-code: 200 + examples: + - path-parameters: + payment_id: payment_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment: + id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + created_at: '2021-10-13T19:34:33.524Z' + updated_at: '2021-10-13T19:34:34.339Z' + amount_money: + amount: 555 + currency: USD + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + total_money: + amount: 555 + currency: USD + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + approved_money: + amount: 555 + currency: USD + processing_fee: + - effective_at: '2021-10-13T21:34:35.000Z' + type: INITIAL + amount_money: + amount: 34 + currency: USD + refunded_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: COMPLETED + delay_duration: PT168H + delay_action: CANCEL + delayed_until: '2021-10-20T19:34:33.524Z' + source_type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + fingerprint: >- + sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ + card_type: DEBIT + prepaid_type: NOT_PREPAID + bin: '411111' + entry_method: KEYED + cvv_status: CVV_ACCEPTED + avs_status: AVS_ACCEPTED + auth_result_code: 2Nkw7q + application_identifier: application_identifier + application_name: application_name + application_cryptogram: application_cryptogram + verification_method: verification_method + verification_results: verification_results + statement_description: SQ *EXAMPLE TEST GOSQ.C + card_payment_timeline: + authorized_at: '2021-10-13T19:34:33.680Z' + captured_at: '2021-10-13T19:34:34.340Z' + refund_requires_card_presence: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + cash_details: + buyer_supplied_money: {} + bank_account_details: + bank_name: bank_name + transfer_type: transfer_type + account_ownership_type: account_ownership_type + fingerprint: fingerprint + country: country + statement_description: statement_description + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + external_details: + type: type + source: source + source_id: source_id + wallet_details: + status: status + brand: brand + buy_now_pay_later_details: + brand: brand + square_account_details: + payment_source_token: payment_source_token + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + location_id: L88917AVBK2S5 + order_id: d7eKah653Z579f3gVtjlxpSlmUcZY + reference_id: reference_id + customer_id: customer_id + employee_id: TMoK_ogh6rH1o4dV + team_member_id: TMoK_ogh6rH1o4dV + refund_ids: + - refund_ids + risk_evaluation: + created_at: created_at + risk_level: PENDING + terminal_checkout_id: terminal_checkout_id + buyer_email_address: buyer_email_address + billing_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + note: Test Note + statement_description_identifier: statement_description_identifier + capabilities: + - capabilities + receipt_number: bP9m + receipt_url: >- + https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + device_details: + device_id: device_id + device_installation_id: device_installation_id + device_name: device_name + application_details: + square_product: VIRTUAL_TERMINAL + application_id: sq0ids-Pw67AZAlLVB7hsRmwlJPuA + is_offline_payment: true + offline_payment_details: + client_created_at: client_created_at + version_token: 56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o + update: + path: /v2/payments/{payment_id} + method: PUT + auth: true + docs: |- + Updates a payment with the APPROVED status. + You can update the `amount_money` and `tip_money` using this endpoint. + source: + openapi: openapi/openapi.json + display-name: UpdatePayment + request: + name: UpdatePaymentRequest + path-parameters: + payment_id: + type: string + docs: The ID of the payment to update. + body: + properties: + payment: + type: optional + docs: The updated `Payment` object. + idempotency_key: + type: string + docs: >- + A unique string that identifies this `UpdatePayment` request. + Keys can be any valid string + + but must be unique for every `UpdatePayment` request. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdatePaymentResponse + status-code: 200 + examples: + - path-parameters: + payment_id: payment_id + request: + payment: + amount_money: + amount: 1000 + currency: USD + tip_money: + amount: 100 + currency: USD + version_token: ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o + idempotency_key: 956f8b13-e4ec-45d6-85e8-d1d95ef0c5de + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment: + id: 1QjqpBVyrI9S4H9sTGDWU9JeiWdZY + created_at: '2021-10-13T20:26:44.191Z' + updated_at: '2021-10-13T20:26:44.364Z' + amount_money: + amount: 1000 + currency: USD + tip_money: + amount: 100 + currency: USD + total_money: + amount: 1100 + currency: USD + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + approved_money: + amount: 1000 + currency: USD + processing_fee: + - {} + refunded_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: APPROVED + delay_duration: PT168H + delay_action: CANCEL + delayed_until: '2021-10-20T20:26:44.191Z' + source_type: CARD + card_details: + status: AUTHORIZED + card: + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + fingerprint: >- + sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ + card_type: DEBIT + prepaid_type: NOT_PREPAID + bin: '411111' + entry_method: ON_FILE + cvv_status: CVV_ACCEPTED + avs_status: AVS_ACCEPTED + auth_result_code: 68aLBM + application_identifier: application_identifier + application_name: application_name + application_cryptogram: application_cryptogram + verification_method: verification_method + verification_results: verification_results + statement_description: SQ *EXAMPLE TEST GOSQ.C + card_payment_timeline: + authorized_at: '2021-10-13T20:26:44.364Z' + refund_requires_card_presence: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + cash_details: + buyer_supplied_money: {} + bank_account_details: + bank_name: bank_name + transfer_type: transfer_type + account_ownership_type: account_ownership_type + fingerprint: fingerprint + country: country + statement_description: statement_description + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + external_details: + type: type + source: source + source_id: source_id + wallet_details: + status: status + brand: brand + buy_now_pay_later_details: + brand: brand + square_account_details: + payment_source_token: payment_source_token + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + location_id: L88917AVBK2S5 + order_id: nUSN9TdxpiK3SrQg3wzmf6r8LP9YY + reference_id: reference_id + customer_id: W92WH6P11H4Z77CTET0RNTGFW8 + employee_id: employee_id + team_member_id: team_member_id + refund_ids: + - refund_ids + risk_evaluation: + created_at: '2021-10-13T20:26:45.271Z' + risk_level: NORMAL + terminal_checkout_id: terminal_checkout_id + buyer_email_address: buyer_email_address + billing_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + note: Example Note + statement_description_identifier: statement_description_identifier + capabilities: + - EDIT_AMOUNT_UP + - EDIT_AMOUNT_DOWN + - EDIT_TIP_AMOUNT_UP + - EDIT_TIP_AMOUNT_DOWN + receipt_number: 1Qjq + receipt_url: receipt_url + device_details: + device_id: device_id + device_installation_id: device_installation_id + device_name: device_name + application_details: + square_product: ECOMMERCE_API + application_id: sq0ids-TcgftTEtKxJTRF1lCFJ9TA + is_offline_payment: true + offline_payment_details: + client_created_at: client_created_at + version_token: rDrXnqiS7fJgexccgdpzmwqTiXui1aIKCp9EchZ7trE6o + cancel: + path: /v2/payments/{payment_id}/cancel + method: POST + auth: true + docs: >- + Cancels (voids) a payment. You can use this endpoint to cancel a payment + with + + the APPROVED `status`. + source: + openapi: openapi/openapi.json + display-name: CancelPayment + request: + name: CancelPaymentsRequest + path-parameters: + payment_id: + type: string + docs: The ID of the payment to cancel. + response: + docs: Success + type: root.CancelPaymentResponse + status-code: 200 + examples: + - path-parameters: + payment_id: payment_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment: + id: 1QjqpBVyrI9S4H9sTGDWU9JeiWdZY + created_at: '2021-10-13T20:26:44.191Z' + updated_at: '2021-10-13T20:31:21.597Z' + amount_money: + amount: 1000 + currency: USD + tip_money: + amount: 100 + currency: USD + total_money: + amount: 1100 + currency: USD + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + approved_money: + amount: 1000 + currency: USD + processing_fee: + - {} + refunded_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: CANCELED + delay_duration: PT168H + delay_action: CANCEL + delayed_until: '2021-10-20T20:26:44.191Z' + source_type: CARD + card_details: + status: VOIDED + card: + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + fingerprint: >- + sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ + card_type: DEBIT + prepaid_type: NOT_PREPAID + bin: '411111' + entry_method: ON_FILE + cvv_status: CVV_ACCEPTED + avs_status: AVS_ACCEPTED + auth_result_code: 68aLBM + application_identifier: application_identifier + application_name: application_name + application_cryptogram: application_cryptogram + verification_method: verification_method + verification_results: verification_results + statement_description: SQ *EXAMPLE TEST GOSQ.C + card_payment_timeline: + authorized_at: '2021-10-13T20:26:44.364Z' + voided_at: '2021-10-13T20:31:21.597Z' + refund_requires_card_presence: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + cash_details: + buyer_supplied_money: {} + bank_account_details: + bank_name: bank_name + transfer_type: transfer_type + account_ownership_type: account_ownership_type + fingerprint: fingerprint + country: country + statement_description: statement_description + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + external_details: + type: type + source: source + source_id: source_id + wallet_details: + status: status + brand: brand + buy_now_pay_later_details: + brand: brand + square_account_details: + payment_source_token: payment_source_token + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + location_id: L88917AVBK2S5 + order_id: nUSN9TdxpiK3SrQg3wzmf6r8LP9YY + reference_id: reference_id + customer_id: W92WH6P11H4Z77CTET0RNTGFW8 + employee_id: employee_id + team_member_id: team_member_id + refund_ids: + - refund_ids + risk_evaluation: + created_at: '2021-10-13T20:26:45.271Z' + risk_level: NORMAL + terminal_checkout_id: terminal_checkout_id + buyer_email_address: buyer_email_address + billing_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + note: Example Note + statement_description_identifier: statement_description_identifier + capabilities: + - capabilities + receipt_number: receipt_number + receipt_url: receipt_url + device_details: + device_id: device_id + device_installation_id: device_installation_id + device_name: device_name + application_details: + square_product: ECOMMERCE_API + application_id: sq0ids-TcgftTEtKxJTRF1lCFJ9TA + is_offline_payment: true + offline_payment_details: + client_created_at: client_created_at + version_token: N8AGYgEjCiY9Q57Jw7aVHEpBq8bzGCDCQMRX8Vs56N06o + complete: + path: /v2/payments/{payment_id}/complete + method: POST + auth: true + docs: >- + Completes (captures) a payment. + + By default, payments are set to complete immediately after they are + created. + + + You can use this endpoint to complete a payment with the APPROVED + `status`. + source: + openapi: openapi/openapi.json + display-name: CompletePayment + request: + name: CompletePaymentRequest + path-parameters: + payment_id: + type: string + docs: The unique ID identifying the payment to be completed. + body: + properties: + version_token: + type: optional> + docs: >- + Used for optimistic concurrency. This opaque token identifies + the current `Payment` + + version that the caller expects. If the server has a different + version of the Payment, + + the update fails and a response with a VERSION_MISMATCH error is + returned. + content-type: application/json + response: + docs: Success + type: root.CompletePaymentResponse + status-code: 200 + examples: + - path-parameters: + payment_id: payment_id + request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + payment: + id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + created_at: '2021-10-13T19:34:33.524Z' + updated_at: '2021-10-13T19:34:34.339Z' + amount_money: + amount: 555 + currency: USD + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + total_money: + amount: 555 + currency: USD + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + approved_money: + amount: 555 + currency: USD + processing_fee: + - effective_at: '2021-10-13T21:34:35.000Z' + type: INITIAL + amount_money: + amount: 34 + currency: USD + refunded_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + status: COMPLETED + delay_duration: PT168H + delay_action: CANCEL + delayed_until: '2021-10-20T19:34:33.524Z' + source_type: CARD + card_details: + status: CAPTURED + card: + card_brand: VISA + last_4: '1111' + exp_month: 11 + exp_year: 2022 + fingerprint: >- + sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ + card_type: DEBIT + prepaid_type: NOT_PREPAID + bin: '411111' + entry_method: KEYED + cvv_status: CVV_ACCEPTED + avs_status: AVS_ACCEPTED + auth_result_code: 2Nkw7q + application_identifier: application_identifier + application_name: application_name + application_cryptogram: application_cryptogram + verification_method: verification_method + verification_results: verification_results + statement_description: SQ *EXAMPLE TEST GOSQ.C + card_payment_timeline: + authorized_at: '2021-10-13T19:34:33.680Z' + captured_at: '2021-10-13T19:34:34.340Z' + refund_requires_card_presence: true + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + cash_details: + buyer_supplied_money: {} + bank_account_details: + bank_name: bank_name + transfer_type: transfer_type + account_ownership_type: account_ownership_type + fingerprint: fingerprint + country: country + statement_description: statement_description + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + external_details: + type: type + source: source + source_id: source_id + wallet_details: + status: status + brand: brand + buy_now_pay_later_details: + brand: brand + square_account_details: + payment_source_token: payment_source_token + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + location_id: L88917AVBK2S5 + order_id: d7eKah653Z579f3gVtjlxpSlmUcZY + reference_id: reference_id + customer_id: customer_id + employee_id: TMoK_ogh6rH1o4dV + team_member_id: TMoK_ogh6rH1o4dV + refund_ids: + - refund_ids + risk_evaluation: + created_at: created_at + risk_level: PENDING + terminal_checkout_id: terminal_checkout_id + buyer_email_address: buyer_email_address + billing_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + note: Test Note + statement_description_identifier: statement_description_identifier + capabilities: + - capabilities + receipt_number: bP9m + receipt_url: >- + https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + device_details: + device_id: device_id + device_installation_id: device_installation_id + device_name: device_name + application_details: + square_product: VIRTUAL_TERMINAL + application_id: sq0ids-Pw67AZAlLVB7hsRmwlJPuA + is_offline_payment: true + offline_payment_details: + client_created_at: client_created_at + version_token: 56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/payouts.yml b/.mock/definition/payouts.yml new file mode 100644 index 00000000..efd249d7 --- /dev/null +++ b/.mock/definition/payouts.yml @@ -0,0 +1,276 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/payouts + method: GET + auth: true + docs: >- + Retrieves a list of all payouts for the default location. + + You can filter payouts by location ID, status, time range, and order + them in ascending or descending order. + + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.payouts + source: + openapi: openapi/openapi.json + display-name: ListPayouts + request: + name: ListPayoutsRequest + query-parameters: + location_id: + type: optional> + docs: >- + The ID of the location for which to list the payouts. + + By default, payouts are returned for the default (main) location + associated with the seller. + status: + type: optional> + docs: If provided, only payouts with the given status are returned. + begin_time: + type: optional> + docs: >- + The timestamp for the beginning of the payout creation time, in + RFC 3339 format. + + Inclusive. Default: The current time minus one year. + end_time: + type: optional> + docs: >- + The timestamp for the end of the payout creation time, in RFC 3339 + format. + + Default: The current time. + sort_order: + type: optional> + docs: The order in which payouts are listed. + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + If request parameters change between requests, subsequent results + may contain duplicates or missing records. + limit: + type: optional> + docs: >- + The maximum number of results to be returned in a single page. + + It is possible to receive fewer results than the specified limit + on a given page. + + The default value of 100 is also the maximum allowed value. If the + provided value is + + greater than 100, it is ignored and the default value is used + instead. + + Default: `100` + response: + docs: Success + type: root.ListPayoutsResponse + status-code: 200 + examples: + - response: + body: + payouts: + - id: po_b345d2c7-90b3-4f0b-a2aa-df1def7f8afc + status: PAID + location_id: L88917AVBK2S5 + created_at: '2022-03-29T16:12:31Z' + updated_at: '2022-03-30T01:07:22.875Z' + amount_money: + amount: 6259 + destination: + type: CARD + id: ccof:ZPp3oedR3AeEUNd3z7 + version: 2 + type: BATCH + payout_fee: + - amount_money: + amount: 95 + effective_at: '2022-03-29T16:12:31Z' + type: TRANSFER_FEE + arrival_date: '2022-03-29' + end_to_end_id: L2100000005 + - id: po_f3c0fb38-a5ce-427d-b858-52b925b72e45 + status: PAID + location_id: L88917AVBK2S5 + created_at: '2022-03-24T03:07:09Z' + updated_at: '2022-03-24T03:07:09Z' + amount_money: + amount: -103 + destination: + type: BANK_ACCOUNT + id: bact:ZPp3oedR3AeEUNd3z7 + version: 1 + type: BATCH + payout_fee: + - {} + arrival_date: '2022-03-24' + end_to_end_id: L2100000006 + cursor: >- + EMPCyStibo64hS8wLayZPp3oedR3AeEUNd3z7u6zphi72LQZFIEMbkKVvot9eefpU + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/payouts/{payout_id} + method: GET + auth: true + docs: |- + Retrieves details of a specific payout identified by a payout ID. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + source: + openapi: openapi/openapi.json + display-name: GetPayout + request: + name: GetPayoutsRequest + path-parameters: + payout_id: + type: string + docs: The ID of the payout to retrieve the information for. + response: + docs: Success + type: root.GetPayoutResponse + status-code: 200 + examples: + - path-parameters: + payout_id: payout_id + response: + body: + payout: + id: po_f3c0fb38-a5ce-427d-b858-52b925b72e45 + status: PAID + location_id: L88917AVBK2S5 + created_at: '2022-03-24T03:07:09Z' + updated_at: '2022-03-24T03:07:09Z' + amount_money: + amount: -103 + currency: UNKNOWN_CURRENCY + destination: + type: BANK_ACCOUNT + id: bact:ZPp3oedR3AeEUNd3z7 + version: 1 + type: BATCH + payout_fee: + - {} + arrival_date: '2022-03-24' + end_to_end_id: end_to_end_id + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + ListEntries: + path: /v2/payouts/{payout_id}/payout-entries + method: GET + auth: true + docs: |- + Retrieves a list of all payout entries for a specific payout. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.payout_entries + source: + openapi: openapi/openapi.json + display-name: ListPayoutEntries + request: + name: ListEntriesPayoutsRequest + path-parameters: + payout_id: + type: string + docs: The ID of the payout to retrieve the information for. + query-parameters: + sort_order: + type: optional> + docs: The order in which payout entries are listed. + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + If request parameters change between requests, subsequent results + may contain duplicates or missing records. + limit: + type: optional> + docs: >- + The maximum number of results to be returned in a single page. + + It is possible to receive fewer results than the specified limit + on a given page. + + The default value of 100 is also the maximum allowed value. If the + provided value is + + greater than 100, it is ignored and the default value is used + instead. + + Default: `100` + response: + docs: Success + type: root.ListPayoutEntriesResponse + status-code: 200 + examples: + - path-parameters: + payout_id: payout_id + response: + body: + payout_entries: + - id: poe_ZQWcw41d0SGJS6IWd4cSi8mKHk + payout_id: po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6 + effective_at: '2021-12-14T23:31:49Z' + type: REFUND + gross_amount_money: + amount: -50 + fee_amount_money: + amount: -2 + net_amount_money: + amount: -48 + type_refund_details: + payment_id: HVdG62HeMlti8YYf94oxrN + refund_id: HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY + - id: poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk + payout_id: po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6 + effective_at: '2021-12-14T23:31:49Z' + type: CHARGE + gross_amount_money: + amount: 100 + fee_amount_money: + amount: 19 + net_amount_money: + amount: 81 + type_charge_details: + payment_id: HVdG62H5K3291d0SGJS6IWd4cSi8YY + cursor: >- + TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/refunds.yml b/.mock/definition/refunds.yml new file mode 100644 index 00000000..f94a598d --- /dev/null +++ b/.mock/definition/refunds.yml @@ -0,0 +1,483 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/refunds + method: GET + auth: true + docs: >- + Retrieves a list of refunds for the account making the request. + + + Results are eventually consistent, and new refunds or changes to refunds + might take several + + seconds to appear. + + + The maximum results per page is 100. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.refunds + source: + openapi: openapi/openapi.json + display-name: ListPaymentRefunds + request: + name: ListRefundsRequest + query-parameters: + begin_time: + type: optional> + docs: >- + Indicates the start of the time range to retrieve each + `PaymentRefund` for, in RFC 3339 + + format. The range is determined using the `created_at` field for + each `PaymentRefund`. + + + Default: The current time minus one year. + end_time: + type: optional> + docs: >- + Indicates the end of the time range to retrieve each + `PaymentRefund` for, in RFC 3339 + + format. The range is determined using the `created_at` field for + each `PaymentRefund`. + + + Default: The current time. + sort_order: + type: optional> + docs: >- + The order in which results are listed by + `PaymentRefund.created_at`: + + - `ASC` - Oldest to newest. + + - `DESC` - Newest to oldest (default). + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + location_id: + type: optional> + docs: >- + Limit results to the location supplied. By default, results are + returned + + for all locations associated with the seller. + status: + type: optional> + docs: >- + If provided, only refunds with the given status are returned. + + For a list of refund status values, see + [PaymentRefund](entity:PaymentRefund). + + + Default: If omitted, refunds are returned regardless of their + status. + source_type: + type: optional> + docs: >- + If provided, only returns refunds whose payments have the + indicated source type. + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, + and `EXTERNAL`. + + For information about these payment source types, see + + [Take + Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + + Default: If omitted, refunds are returned regardless of the source + type. + limit: + type: optional> + docs: >- + The maximum number of results to be returned in a single page. + + + It is possible to receive fewer results than the specified limit + on a given page. + + + If the supplied value is greater than 100, no more than 100 + results are returned. + + + Default: 100 + updated_at_begin_time: + type: optional> + docs: >- + Indicates the start of the time range to retrieve each + `PaymentRefund` for, in RFC 3339 + + format. The range is determined using the `updated_at` field for + each `PaymentRefund`. + + + Default: If omitted, the time range starts at `begin_time`. + updated_at_end_time: + type: optional> + docs: >- + Indicates the end of the time range to retrieve each + `PaymentRefund` for, in RFC 3339 + + format. The range is determined using the `updated_at` field for + each `PaymentRefund`. + + + Default: The current time. + sort_field: + type: optional> + docs: The field used to sort results by. The default is `CREATED_AT`. + response: + docs: Success + type: root.ListPaymentRefundsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refunds: + - id: >- + bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd + status: COMPLETED + location_id: L88917AVBK2S5 + unlinked: true + destination_type: destination_type + amount_money: + amount: 555 + currency: USD + processing_fee: + - effective_at: '2021-10-13T21:34:35.000Z' + type: INITIAL + amount_money: + amount: -34 + currency: USD + payment_id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + order_id: 9ltv0bx5PuvGXUYHYHxYSKEqC3IZY + reason: Example Refund + created_at: '2021-10-13T19:59:05.342Z' + updated_at: '2021-10-13T20:00:03.497Z' + team_member_id: team_member_id + terminal_refund_id: terminal_refund_id + cursor: >- + 5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb + RefundPayment: + path: /v2/refunds + method: POST + auth: true + docs: >- + Refunds a payment. You can refund the entire payment amount or a + + portion of it. You can use this endpoint to refund a card payment or + record a + + refund of a cash or external payment. For more information, see + + [Refund + Payment](https://developer.squareup.com/docs/payments-api/refund-payments). + source: + openapi: openapi/openapi.json + display-name: RefundPayment + request: + name: RefundPaymentRequest + body: + properties: + idempotency_key: + type: string + docs: >2- + A unique string that identifies this `RefundPayment` request. The key can be any valid string + but must be unique for every `RefundPayment` request. + + + Keys are limited to a max of 45 characters - however, the number + of allowed characters might be + + less than 45, if multi-byte characters are used. + + + For more information, see + [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + validation: + minLength: 1 + amount_money: + type: root.Money + docs: >- + The amount of money to refund. + + + This amount cannot be more than the `total_money` value of the + payment minus the total + + amount of all previously completed refunds for this payment. + + + This amount must be specified in the smallest denomination of + the applicable currency + + (for example, US dollar amounts are specified in cents). For + more information, see + + [Working with Monetary + Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + + The currency code must match the currency associated with the + business + + that is charging the card. + app_fee_money: + type: optional + docs: >- + The amount of money the developer contributes to help cover the + refunded amount. + + This amount is specified in the smallest denomination of the + applicable currency (for example, + + US dollar amounts are specified in cents). + + + The value cannot be more than the `amount_money`. + + + You can specify this parameter in a refund request only if the + same parameter was also included + + when taking the payment. This is part of the application fee + scenario the API supports. For more + + information, see [Take Payments and Collect + Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth + permission is required. + + For more information, see + [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + payment_id: + type: optional> + docs: |- + The unique ID of the payment being refunded. + Required when unlinked=false, otherwise must not be set. + destination_id: + type: optional> + docs: >- + The ID indicating where funds will be refunded to. Required for + unlinked refunds. For more + + information, see [Process an Unlinked + Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds). + + + For refunds linked to Square payments, `destination_id` is + usually omitted; in this case, funds + + will be returned to the original payment source. The field may + be specified in order to request + + a cross-method refund to a gift card. For more information, + + see [Cross-method refunds to gift + cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). + unlinked: + type: optional> + docs: >- + Indicates that the refund is not linked to a Square payment. + + If set to true, `destination_id` and `location_id` must be + supplied while `payment_id` must not + + be provided. + location_id: + type: optional> + docs: >- + The location ID associated with the unlinked refund. + + Required for requests specifying `unlinked=true`. + + Otherwise, if included when `unlinked=false`, will throw an + error. + validation: + maxLength: 50 + customer_id: + type: optional> + docs: >- + The [Customer](entity:Customer) ID of the customer associated + with the refund. + + This is required if the `destination_id` refers to a card on + file created using the Cards + + API. Only allowed when `unlinked=true`. + reason: + type: optional> + docs: A description of the reason for the refund. + validation: + maxLength: 192 + payment_version_token: + type: optional> + docs: >2- + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different + version of the Payment, + + the update fails and a response with a VERSION_MISMATCH error is + returned. + + If the versions match, or the field is not provided, the refund + proceeds as normal. + team_member_id: + type: optional> + docs: >- + An optional [TeamMember](entity:TeamMember) ID to associate with + this refund. + validation: + maxLength: 192 + cash_details: + type: optional + docs: >- + Additional details required when recording an unlinked cash + refund (`destination_id` is CASH). + external_details: + type: optional + docs: >- + Additional details required when recording an unlinked external + refund + + (`destination_id` is EXTERNAL). + content-type: application/json + response: + docs: Success + type: root.RefundPaymentResponse + status-code: 200 + examples: + - request: + idempotency_key: 9b7f2dcf-49da-4411-b23e-a2d6af21333a + amount_money: + amount: 1000 + currency: USD + app_fee_money: + amount: 10 + currency: USD + payment_id: R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY + reason: Example + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refund: + id: >- + R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY_KlWP8IC1557ddwc9QWTKrCVU6m0JXDz15R2Qym5eQfR + status: PENDING + location_id: L88917AVBK2S5 + unlinked: true + destination_type: destination_type + destination_details: + cash_details: + seller_supplied_money: {} + external_details: + type: type + source: source + amount_money: + amount: 1000 + currency: USD + app_fee_money: + amount: 10 + currency: USD + processing_fee: + - {} + payment_id: R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY + order_id: 1JLEUZeEooAIX8HMqm9kvWd69aQZY + reason: Example + created_at: '2021-10-13T21:23:19.116Z' + updated_at: '2021-10-13T21:23:19.508Z' + team_member_id: team_member_id + terminal_refund_id: terminal_refund_id + get: + path: /v2/refunds/{refund_id} + method: GET + auth: true + docs: Retrieves a specific refund using the `refund_id`. + source: + openapi: openapi/openapi.json + display-name: GetPaymentRefund + request: + name: GetRefundsRequest + path-parameters: + refund_id: + type: string + docs: The unique ID for the desired `PaymentRefund`. + response: + docs: Success + type: root.GetPaymentRefundResponse + status-code: 200 + examples: + - path-parameters: + refund_id: refund_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refund: + id: >- + bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd + status: COMPLETED + location_id: L88917AVBK2S5 + unlinked: true + destination_type: destination_type + destination_details: + cash_details: + seller_supplied_money: {} + external_details: + type: type + source: source + amount_money: + amount: 555 + currency: USD + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + processing_fee: + - effective_at: '2021-10-13T21:34:35.000Z' + type: INITIAL + amount_money: + amount: -34 + currency: USD + payment_id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY + order_id: 9ltv0bx5PuvGXUYHYHxYSKEqC3IZY + reason: Example Refund + created_at: '2021-10-13T19:59:05.073Z' + updated_at: '2021-10-13T20:00:02.442Z' + team_member_id: team_member_id + terminal_refund_id: terminal_refund_id + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/sites.yml b/.mock/definition/sites.yml new file mode 100644 index 00000000..a17d1c73 --- /dev/null +++ b/.mock/definition/sites.yml @@ -0,0 +1,50 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/sites + method: GET + auth: true + docs: >- + Lists the Square Online sites that belong to a seller. Sites are listed + in descending order by the `created_at` date. + + + + __Note:__ Square Online APIs are publicly available as part of an early + access program. For more information, see [Early access program for + Square Online + APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + source: + openapi: openapi/openapi.json + display-name: ListSites + response: + docs: Success + type: root.ListSitesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + sites: + - id: site_278075276488921835 + site_title: My Second Site + domain: mysite2.square.site + is_published: false + created_at: '2020-10-28T13:22:51.000000Z' + updated_at: '2020-10-28T13:22:51.000000Z' + - id: site_102725345836253849 + site_title: My First Site + domain: mysite1.square.site + is_published: true + created_at: '2020-06-18T17:45:13.000000Z' + updated_at: '2020-11-23T02:19:10.000000Z' + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/snippets.yml b/.mock/definition/snippets.yml new file mode 100644 index 00000000..0bec7630 --- /dev/null +++ b/.mock/definition/snippets.yml @@ -0,0 +1,156 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + get: + path: /v2/sites/{site_id}/snippet + method: GET + auth: true + docs: >- + Retrieves your snippet from a Square Online site. A site can contain + snippets from multiple snippet applications, but you can retrieve only + the snippet that was added by your application. + + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of + the sites that belong to a seller. + + + + __Note:__ Square Online APIs are publicly available as part of an early + access program. For more information, see [Early access program for + Square Online + APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + source: + openapi: openapi/openapi.json + display-name: RetrieveSnippet + request: + name: GetSnippetsRequest + path-parameters: + site_id: + type: string + docs: The ID of the site that contains the snippet. + response: + docs: Success + type: root.GetSnippetResponse + status-code: 200 + examples: + - path-parameters: + site_id: site_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + snippet: + id: snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7 + site_id: site_278075276488921835 + content: + created_at: '2021-03-11T25:40:09.000000Z' + updated_at: '2021-03-11T25:40:09.000000Z' + upsert: + path: /v2/sites/{site_id}/snippet + method: POST + auth: true + docs: >- + Adds a snippet to a Square Online site or updates the existing snippet + on the site. + + The snippet code is appended to the end of the `head` element on every + page of the site, except checkout pages. A snippet application can add + one snippet to a given site. + + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of + the sites that belong to a seller. + + + + __Note:__ Square Online APIs are publicly available as part of an early + access program. For more information, see [Early access program for + Square Online + APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + source: + openapi: openapi/openapi.json + display-name: UpsertSnippet + request: + name: UpsertSnippetRequest + path-parameters: + site_id: + type: string + docs: The ID of the site where you want to add or update the snippet. + body: + properties: + snippet: + type: root.Snippet + docs: The snippet for the site. + content-type: application/json + response: + docs: Success + type: root.UpsertSnippetResponse + status-code: 200 + examples: + - path-parameters: + site_id: site_id + request: + snippet: + content: + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + snippet: + id: snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7 + site_id: site_278075276488921835 + content: + created_at: '2021-03-11T25:40:09.000000Z' + updated_at: '2021-03-11T25:40:09.000000Z' + delete: + path: /v2/sites/{site_id}/snippet + method: DELETE + auth: true + docs: >- + Removes your snippet from a Square Online site. + + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of + the sites that belong to a seller. + + + + __Note:__ Square Online APIs are publicly available as part of an early + access program. For more information, see [Early access program for + Square Online + APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + source: + openapi: openapi/openapi.json + display-name: DeleteSnippet + request: + name: DeleteSnippetsRequest + path-parameters: + site_id: + type: string + docs: The ID of the site that contains the snippet. + response: + docs: Success + type: root.DeleteSnippetResponse + status-code: 200 + examples: + - path-parameters: + site_id: site_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/subscriptions.yml b/.mock/definition/subscriptions.yml new file mode 100644 index 00000000..d8005f17 --- /dev/null +++ b/.mock/definition/subscriptions.yml @@ -0,0 +1,1215 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/subscriptions + method: POST + auth: true + docs: >- + Enrolls a customer in a subscription. + + + If you provide a card on file in the request, Square charges the card + for + + the subscription. Otherwise, Square sends an invoice to the customer's + email + + address. The subscription starts immediately, unless the request + includes + + the optional `start_date`. Each individual subscription is associated + with a particular location. + + + For more information, see [Create a + subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription). + source: + openapi: openapi/openapi.json + display-name: CreateSubscription + request: + name: CreateSubscriptionRequest + body: + properties: + idempotency_key: + type: optional + docs: >- + A unique string that identifies this `CreateSubscription` + request. + + If you do not provide a unique string (or provide an empty + string as the value), + + the endpoint treats each request as independent. + + + For more information, see [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + location_id: + type: string + docs: The ID of the location the subscription is associated with. + validation: + minLength: 1 + plan_variation_id: + type: optional + docs: >- + The ID of the [subscription plan + variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) + created using the Catalog API. + customer_id: + type: string + docs: >- + The ID of the [customer](entity:Customer) subscribing to the + subscription plan variation. + validation: + minLength: 1 + start_date: + type: optional + docs: |- + The `YYYY-MM-DD`-formatted date to start the subscription. + If it is unspecified, the subscription starts immediately. + canceled_date: + type: optional + docs: >- + The `YYYY-MM-DD`-formatted date when the newly created + subscription is scheduled for cancellation. + + + This date overrides the cancellation date set in the plan + variation configuration. + + If the cancellation date is earlier than the end date of a + subscription cycle, the subscription stops + + at the canceled date and the subscriber is sent a prorated + invoice at the beginning of the canceled cycle. + + + When the subscription plan of the newly created subscription has + a fixed number of cycles and the `canceled_date` + + occurs before the subscription plan expires, the specified + `canceled_date` sets the date when the subscription + + stops through the end of the last cycle. + tax_percentage: + type: optional + docs: >- + The tax to add when billing the subscription. + + The percentage is expressed in decimal form, using a `'.'` as + the decimal + + separator and without a `'%'` sign. For example, a value of 7.5 + + corresponds to 7.5%. + validation: + maxLength: 10 + price_override_money: + type: optional + docs: >- + A custom price which overrides the cost of a subscription plan + variation with `STATIC` pricing. + + This field does not affect itemized subscriptions with + `RELATIVE` pricing. Instead, + + you should edit the Subscription's [order + template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + card_id: + type: optional + docs: >- + The ID of the [subscriber's](entity:Customer) + [card](entity:Card) to charge. + + If it is not specified, the subscriber receives an invoice via + email with a link to pay for their subscription. + timezone: + type: optional + docs: >- + The timezone that is used in date calculations for the + subscription. If unset, defaults to + + the location timezone. If a timezone is not configured for the + location, defaults to "America/New_York". + + Format: the IANA Timezone Database identifier for the location + timezone. For + + a list of time zones, see [List of tz database time + zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + source: + type: optional + docs: The origination details of the subscription. + monthly_billing_anchor_date: + type: optional + docs: The day-of-the-month to change the billing date to. + validation: + min: 1 + max: 31 + phases: + type: optional> + docs: array of phases for this subscription + content-type: application/json + response: + docs: Success + type: root.CreateSubscriptionResponse + status-code: 200 + examples: + - request: + idempotency_key: 8193148c-9586-11e6-99f9-28cfe92138cf + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2023-06-20' + card_id: ccof:qy5x8hHGYsgLrp4Q4GB + timezone: America/Los_Angeles + source: + name: My Application + phases: + - ordinal: 0 + order_template_id: U2NaowWxzXwpsZU697x7ZHOAnCNZY + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 56214fb2-cc85-47a1-93bc-44f3766bb56f + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2023-06-20' + canceled_date: canceled_date + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + price_override_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + version: 1 + created_at: '2023-06-20T21:53:10Z' + card_id: ccof:qy5x8hHGYsgLrp4Q4GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - uid: 873451e0-745b-4e87-ab0b-c574933fe616 + ordinal: 0 + order_template_id: U2NaowWxzXwpsZU697x7ZHOAnCNZY + plan_phase_uid: X2Q2AONPB3RB64Y27S25QCZP + BulkSwapPlan: + path: /v2/subscriptions/bulk-swap-plan + method: POST + auth: true + docs: >- + Schedules a plan variation change for all active subscriptions under a + given plan + + variation. For more information, see [Swap Subscription Plan + Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + source: + openapi: openapi/openapi.json + display-name: BulkSwapPlan + request: + name: BulkSwapPlanRequest + body: + properties: + new_plan_variation_id: + type: string + docs: |- + The ID of the new subscription plan variation. + + This field is required. + validation: + minLength: 1 + old_plan_variation_id: + type: string + docs: >- + The ID of the plan variation whose subscriptions should be + swapped. Active subscriptions + + using this plan variation will be subscribed to the new plan + variation on their next billing + + day. + validation: + minLength: 1 + location_id: + type: string + docs: >- + The ID of the location to associate with the swapped + subscriptions. + validation: + minLength: 1 + content-type: application/json + response: + docs: Success + type: root.BulkSwapPlanResponse + status-code: 200 + examples: + - request: + new_plan_variation_id: FQ7CDXXWSLUJRPM3GFJSJGZ7 + old_plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + location_id: S8GWD5R9QB376 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + affected_subscriptions: 12 + search: + path: /v2/subscriptions/search + method: POST + auth: true + docs: >- + Searches for subscriptions. + + + Results are ordered chronologically by subscription creation date. If + + the request specifies more than one location ID, + + the endpoint orders the result + + by location ID, and then by creation date within each location. If no + locations are given + + in the query, all locations are searched. + + + You can also optionally specify `customer_ids` to search by customer. + + If left unset, all customers + + associated with the specified locations are returned. + + If the request specifies customer IDs, the endpoint orders results + + first by location, within location by customer ID, and within + + customer by subscription creation date. + source: + openapi: openapi/openapi.json + display-name: SearchSubscriptions + request: + name: SearchSubscriptionsRequest + body: + properties: + cursor: + type: optional + docs: >- + When the total number of resulting subscriptions exceeds the + limit of a paged response, + + specify the cursor returned from a preceding response here to + fetch the next set of results. + + If the cursor is unset, the response contains the last page of + the results. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional + docs: |- + The upper limit on the number of subscriptions to return + in a paged response. + validation: + min: 1 + query: + type: optional + docs: >- + A subscription query consisting of specified filtering + conditions. + + + If this `query` field is unspecified, the `SearchSubscriptions` + call will return all subscriptions. + include: + type: optional> + docs: >- + An option to include related information in the response. + + + The supported values are: + + + - `actions`: to include scheduled actions on the targeted + subscriptions. + content-type: application/json + response: + docs: Success + type: root.SearchSubscriptionsResponse + status-code: 200 + examples: + - request: + query: + filter: + customer_ids: + - CHFGVKYY8RSV93M5KCYTG4PN0G + location_ids: + - S8GWD5R9QB376 + source_names: + - My App + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscriptions: + - id: de86fc96-8664-474b-af1a-abbe59cacf0e + location_id: S8GWD5R9QB376 + plan_variation_id: L3TJVDHVBEQEGQDEZL2JJM7R + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2021-10-20' + canceled_date: '2021-10-30' + charged_through_date: '2021-11-20' + status: CANCELED + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + version: 1000000 + created_at: '2021-10-20T21:53:10Z' + card_id: ccof:mueUsvgajChmjEbp4GB + timezone: UTC + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - {} + - id: 56214fb2-cc85-47a1-93bc-44f3766bb56f + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2022-01-19' + canceled_date: canceled_date + charged_through_date: '2022-08-19' + status: PAUSED + tax_percentage: '5' + invoice_ids: + - grebK0Q_l8H4fqoMMVvt-Q + - rcX_i3sNmHTGKhI4W2mceA + price_override_money: + amount: 1000 + currency: USD + version: 2 + created_at: '2022-01-19T21:53:10Z' + card_id: card_id + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - {} + - id: 56214fb2-cc85-47a1-93bc-44f3766bb56f + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2023-06-20' + canceled_date: canceled_date + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + version: 1 + created_at: '2023-06-20T21:53:10Z' + card_id: ccof:qy5x8hHGYsgLrp4Q4GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - uid: 873451e0-745b-4e87-ab0b-c574933fe616 + ordinal: 0 + order_template_id: U2NaowWxzXwpsZU697x7ZHOAnCNZY + plan_phase_uid: X2Q2AONPB3RB64Y27S25QCZP + cursor: cursor + get: + path: /v2/subscriptions/{subscription_id} + method: GET + auth: true + docs: Retrieves a specific subscription. + source: + openapi: openapi/openapi.json + display-name: RetrieveSubscription + request: + name: GetSubscriptionsRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to retrieve. + query-parameters: + include: + type: optional> + docs: >- + A query parameter to specify related information to be included in + the response. + + + The supported query parameter values are: + + + - `actions`: to include scheduled actions on the targeted + subscription. + response: + docs: Success + type: root.GetSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 8151fc89-da15-4eb9-a685-1a70883cebfc + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + start_date: '2022-07-27' + canceled_date: canceled_date + charged_through_date: '2023-11-20' + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + - inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA + price_override_money: + amount: 25000 + currency: USD + version: 1000000 + created_at: '2022-07-27T21:53:10Z' + card_id: ccof:IkWfpLj4tNHMyFii3GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - {} + update: + path: /v2/subscriptions/{subscription_id} + method: PUT + auth: true + docs: >- + Updates a subscription by modifying or clearing `subscription` field + values. + + To clear a field, set its value to `null`. + source: + openapi: openapi/openapi.json + display-name: UpdateSubscription + request: + name: UpdateSubscriptionRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to update. + body: + properties: + subscription: + type: optional + docs: >- + The subscription object containing the current version, and + fields to update. + + Unset fields will be left at their current server values, and + JSON `null` values will + + be treated as a request to clear the relevant data. + content-type: application/json + response: + docs: Success + type: root.UpdateSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: + subscription: + card_id: '{NEW CARD ID}' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 7217d8ca-1fee-4446-a9e5-8540b5d8c9bb + location_id: LPJKHYR7WFDKN + plan_variation_id: XOUNEKCE6NSXQW5NTSQ73MMX + customer_id: AM69AB81FT4479YH9HGWS1HZY8 + start_date: '2023-01-30' + canceled_date: canceled_date + charged_through_date: '2023-03-13' + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - inv:0-ChAPSfVYvNewckgf3x4iigN_ENMM + - inv:0-ChBQaCCLfjcm9WEUBGxvuydJENMM + price_override_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + version: 3 + created_at: '2023-01-30T19:27:32Z' + card_id: '{NEW CARD ID}' + timezone: UTC + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - {} + DeleteAction: + path: /v2/subscriptions/{subscription_id}/actions/{action_id} + method: DELETE + auth: true + docs: Deletes a scheduled action for a subscription. + source: + openapi: openapi/openapi.json + display-name: DeleteSubscriptionAction + request: + name: DeleteActionSubscriptionsRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription the targeted action is to act upon. + action_id: + type: string + docs: The ID of the targeted action to be deleted. + response: + docs: Success + type: root.DeleteSubscriptionActionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + action_id: action_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 8151fc89-da15-4eb9-a685-1a70883cebfc + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4 + start_date: '2022-07-27' + canceled_date: canceled_date + charged_through_date: '2023-11-20' + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + - inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA + price_override_money: + amount: 25000 + currency: USD + version: 1000000 + created_at: '2022-07-27T21:53:10Z' + card_id: ccof:IkWfpLj4tNHMyFii3GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - {} + ChangeBillingAnchorDate: + path: /v2/subscriptions/{subscription_id}/billing-anchor + method: POST + auth: true + docs: >- + Changes the [billing anchor + date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) + + for a subscription. + source: + openapi: openapi/openapi.json + display-name: ChangeBillingAnchorDate + request: + name: ChangeBillingAnchorDateRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to update the billing anchor date. + body: + properties: + monthly_billing_anchor_date: + type: optional> + docs: The anchor day for the billing cycle. + validation: + min: 1 + max: 31 + effective_date: + type: optional> + docs: >- + The `YYYY-MM-DD`-formatted date when the scheduled + `BILLING_ANCHOR_CHANGE` action takes + + place on the subscription. + + + When this date is unspecified or falls within the current + billing cycle, the billing anchor date + + is changed immediately. + content-type: application/json + response: + docs: Success + type: root.ChangeBillingAnchorDateResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: + monthly_billing_anchor_date: 1 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 9ba40961-995a-4a3d-8c53-048c40cafc13 + location_id: S8GWD5R9QB376 + plan_variation_id: FQ7CDXXWSLUJRPM3GFJSJGZ7 + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: start_date + canceled_date: canceled_date + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + price_override_money: + amount: 2000 + currency: USD + version: 3 + created_at: '2023-06-20T21:53:10Z' + card_id: card_id + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 20 + phases: + - uid: 98d6f53b-40e1-4714-8827-032fd923be25 + ordinal: 0 + order_template_id: E6oBY5WfQ2eN4pkYZwq4ka6n7KeZY + plan_phase_uid: C66BKH3ASTDYGJJCEZXQQSS7 + actions: + - id: f0a1dfdc-675b-3a14-a640-99f7ac1cee83 + type: CHANGE_BILLING_ANCHOR_DATE + effective_date: '2023-11-01' + monthly_billing_anchor_date: 1 + phases: + - {} + new_plan_variation_id: new_plan_variation_id + cancel: + path: /v2/subscriptions/{subscription_id}/cancel + method: POST + auth: true + docs: >- + Schedules a `CANCEL` action to cancel an active subscription. This + + sets the `canceled_date` field to the end of the active billing period. + After this date, + + the subscription status changes from ACTIVE to CANCELED. + source: + openapi: openapi/openapi.json + display-name: CancelSubscription + request: + name: CancelSubscriptionsRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to cancel. + response: + docs: Success + type: root.CancelSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 910afd30-464a-4e00-a8d8-2296e + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2022-01-19' + canceled_date: '2023-06-05' + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - inv:0-ChCHu2mZEabLeeHahQnXDjZQECY + - inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA + price_override_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + version: 3 + created_at: '2022-01-19T21:53:10Z' + card_id: ccof:qy5x8hHGYsgLrp4Q4GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - {} + actions: + - id: id + type: CANCEL + effective_date: effective_date + monthly_billing_anchor_date: 1 + phases: + - {} + new_plan_variation_id: new_plan_variation_id + listEvents: + path: /v2/subscriptions/{subscription_id}/events + method: GET + auth: true + docs: >- + Lists all + [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) + for a specific subscription. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.subscription_events + source: + openapi: openapi/openapi.json + display-name: ListSubscriptionEvents + request: + name: ListEventsSubscriptionsRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to retrieve the events for. + query-parameters: + cursor: + type: optional> + docs: >- + When the total number of resulting subscription events exceeds the + limit of a paged response, + + specify the cursor returned from a preceding response here to + fetch the next set of results. + + If the cursor is unset, the response contains the last page of the + results. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + limit: + type: optional> + docs: |- + The upper limit on the number of subscription events to return + in a paged response. + response: + docs: Success + type: root.ListSubscriptionEventsResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription_events: + - id: 06809161-3867-4598-8269-8aea5be4f9de + subscription_event_type: START_SUBSCRIPTION + effective_date: '2020-04-24' + monthly_billing_anchor_date: 1 + phases: + - {} + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + - id: f2736603-cd2e-47ec-8675-f815fff54f88 + subscription_event_type: DEACTIVATE_SUBSCRIPTION + effective_date: '2020-05-01' + monthly_billing_anchor_date: 1 + info: + detail: >- + The customer with ID `V74BMG0GPS2KNCWJE1BTYJ37Y0` does not + have a name on record. + code: CUSTOMER_NO_NAME + phases: + - {} + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + - id: b426fc85-6859-450b-b0d0-fe3a5d1b565f + subscription_event_type: RESUME_SUBSCRIPTION + effective_date: '2022-05-01' + monthly_billing_anchor_date: 1 + phases: + - {} + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + - id: 09f14de1-2f53-4dae-9091-49aa53f83d01 + subscription_event_type: PAUSE_SUBSCRIPTION + effective_date: '2022-09-01' + monthly_billing_anchor_date: 1 + phases: + - {} + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + - id: f28a73ac-1a1b-4b0f-8eeb-709a72945776 + subscription_event_type: RESUME_SUBSCRIPTION + effective_date: '2022-12-01' + monthly_billing_anchor_date: 1 + phases: + - {} + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + - id: 1eee8790-472d-4efe-8c69-8ad84e9cefe0 + subscription_event_type: PLAN_CHANGE + effective_date: '2023-04-01' + monthly_billing_anchor_date: 1 + phases: + - {} + plan_variation_id: 02CD53CFA4d1498AFAD42 + - id: a0c08083-5db0-4800-85c7-d398de4fbb6e + subscription_event_type: STOP_SUBSCRIPTION + effective_date: '2023-06-21' + monthly_billing_anchor_date: 1 + phases: + - {} + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + cursor: cursor + pause: + path: /v2/subscriptions/{subscription_id}/pause + method: POST + auth: true + docs: Schedules a `PAUSE` action to pause an active subscription. + source: + openapi: openapi/openapi.json + display-name: PauseSubscription + request: + name: PauseSubscriptionRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to pause. + body: + properties: + pause_effective_date: + type: optional> + docs: >- + The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` + action takes place on the subscription. + + + When this date is unspecified or falls within the current + billing cycle, the subscription is paused + + on the starting date of the next billing cycle. + pause_cycle_duration: + type: optional> + docs: >- + The number of billing cycles the subscription will be paused + before it is reactivated. + + + When this is set, a `RESUME` action is also scheduled to take + place on the subscription at + + the end of the specified pause cycle duration. In this case, + neither `resume_effective_date` + + nor `resume_change_timing` may be specified. + resume_effective_date: + type: optional> + docs: >- + The date when the subscription is reactivated by a scheduled + `RESUME` action. + + This date must be at least one billing cycle ahead of + `pause_effective_date`. + resume_change_timing: + type: optional + docs: >- + The timing whether the subscription is reactivated immediately + or at the end of the billing cycle, relative to + + `resume_effective_date`. + + See [ChangeTiming](#type-changetiming) for possible values + pause_reason: + type: optional> + docs: The user-provided reason to pause the subscription. + validation: + maxLength: 255 + content-type: application/json + response: + docs: Success + type: root.PauseSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 56214fb2-cc85-47a1-93bc-44f3766bb56f + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2023-06-20' + canceled_date: canceled_date + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + price_override_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + version: 1 + created_at: '2023-06-20T21:53:10Z' + card_id: ccof:qy5x8hHGYsgLrp4Q4GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - uid: 873451e0-745b-4e87-ab0b-c574933fe616 + ordinal: 0 + order_template_id: U2NaowWxzXwpsZU697x7ZHOAnCNZY + plan_phase_uid: X2Q2AONPB3RB64Y27S25QCZP + actions: + - id: 99b2439e-63f7-3ad5-95f7-ab2447a80673 + type: PAUSE + effective_date: '2023-11-17' + monthly_billing_anchor_date: 1 + phases: + - {} + new_plan_variation_id: new_plan_variation_id + resume: + path: /v2/subscriptions/{subscription_id}/resume + method: POST + auth: true + docs: >- + Schedules a `RESUME` action to resume a paused or a deactivated + subscription. + source: + openapi: openapi/openapi.json + display-name: ResumeSubscription + request: + name: ResumeSubscriptionRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to resume. + body: + properties: + resume_effective_date: + type: optional> + docs: >- + The `YYYY-MM-DD`-formatted date when the subscription + reactivated. + resume_change_timing: + type: optional + docs: |- + The timing to resume a subscription, relative to the specified + `resume_effective_date` attribute value. + See [ChangeTiming](#type-changetiming) for possible values + content-type: application/json + response: + docs: Success + type: root.ResumeSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 56214fb2-cc85-47a1-93bc-44f3766bb56f + location_id: S8GWD5R9QB376 + plan_variation_id: 6JHXF3B2CW3YKHDV4XEM674H + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: '2023-06-20' + canceled_date: canceled_date + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + price_override_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + version: 1 + created_at: '2023-06-20T21:53:10Z' + card_id: ccof:qy5x8hHGYsgLrp4Q4GB + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - uid: 873451e0-745b-4e87-ab0b-c574933fe616 + ordinal: 0 + order_template_id: U2NaowWxzXwpsZU697x7ZHOAnCNZY + plan_phase_uid: X2Q2AONPB3RB64Y27S25QCZP + actions: + - id: 18ff74f4-3da4-30c5-929f-7d6fca84f115 + type: RESUME + effective_date: '2023-09-01' + monthly_billing_anchor_date: 1 + phases: + - {} + new_plan_variation_id: new_plan_variation_id + SwapPlan: + path: /v2/subscriptions/{subscription_id}/swap-plan + method: POST + auth: true + docs: >- + Schedules a `SWAP_PLAN` action to swap a subscription plan variation in + an existing subscription. + + For more information, see [Swap Subscription Plan + Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + source: + openapi: openapi/openapi.json + display-name: SwapPlan + request: + name: SwapPlanRequest + path-parameters: + subscription_id: + type: string + docs: The ID of the subscription to swap the subscription plan for. + body: + properties: + new_plan_variation_id: + type: optional> + docs: |- + The ID of the new subscription plan variation. + + This field is required. + phases: + type: optional>> + docs: >- + A list of PhaseInputs, to pass phase-specific information used + in the swap. + content-type: application/json + response: + docs: Success + type: root.SwapPlanResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: + new_plan_variation_id: FQ7CDXXWSLUJRPM3GFJSJGZ7 + phases: + - ordinal: 0 + order_template_id: uhhnjH9osVv3shUADwaC0b3hNxQZY + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: 9ba40961-995a-4a3d-8c53-048c40cafc13 + location_id: S8GWD5R9QB376 + plan_variation_id: FQ7CDXXWSLUJRPM3GFJSJGZ7 + customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G + start_date: start_date + canceled_date: canceled_date + charged_through_date: charged_through_date + status: ACTIVE + tax_percentage: tax_percentage + invoice_ids: + - invoice_ids + price_override_money: + amount: 2000 + currency: USD + version: 3 + created_at: '2023-06-20T21:53:10Z' + card_id: card_id + timezone: America/Los_Angeles + source: + name: My Application + actions: + - {} + monthly_billing_anchor_date: 1 + phases: + - uid: 98d6f53b-40e1-4714-8827-032fd923be25 + ordinal: 0 + order_template_id: E6oBY5WfQ2eN4pkYZwq4ka6n7KeZY + plan_phase_uid: C66BKH3ASTDYGJJCEZXQQSS7 + actions: + - id: f0a1dfdc-675b-3a14-a640-99f7ac1cee83 + type: SWAP_PLAN + effective_date: '2023-11-17' + monthly_billing_anchor_date: 1 + phases: + - ordinal: 0 + order_template_id: uhhnjH9osVv3shUADwaC0b3hNxQZY + new_plan_variation_id: FQ7CDXXWSLUJRPM3GFJSJGZ7 + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/team.yml b/.mock/definition/team.yml new file mode 100644 index 00000000..3d207bab --- /dev/null +++ b/.mock/definition/team.yml @@ -0,0 +1,210 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + ListJobs: + path: /v2/team-members/jobs + method: GET + auth: true + docs: >- + Lists jobs in a seller account. Results are sorted by title in ascending + order. + source: + openapi: openapi/openapi.json + display-name: ListJobs + request: + name: ListJobsRequest + query-parameters: + cursor: + type: optional> + docs: >- + The pagination cursor returned by the previous call to this + endpoint. Provide this + + cursor to retrieve the next page of results for your original + request. For more information, + + see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + response: + docs: Success + type: root.ListJobsResponse + status-code: 200 + examples: + - response: + body: + jobs: + - id: VDNpRv8da51NU8qZFC5zDWpF + title: Cashier + is_tip_eligible: true + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + version: 2 + - id: FjS8x95cqHiMenw4f1NAUH4P + title: Chef + is_tip_eligible: false + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + version: 1 + cursor: cursor + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + CreateJob: + path: /v2/team-members/jobs + method: POST + auth: true + docs: >- + Creates a job in a seller account. A job defines a title and tip + eligibility. Note that + + compensation is defined in a [job assignment](entity:JobAssignment) in a + team member's wage setting. + source: + openapi: openapi/openapi.json + display-name: CreateJob + request: + name: CreateJobRequest + body: + properties: + job: + type: root.Job + docs: >- + The job to create. The `title` field is required and + `is_tip_eligible` defaults to true. + idempotency_key: + type: string + docs: >- + A unique identifier for the `CreateJob` request. Keys can be any + valid string, + + but must be unique for each request. For more information, see + + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + validation: + minLength: 1 + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.CreateJobResponse + status-code: 200 + examples: + - request: + job: + title: Cashier + is_tip_eligible: true + idempotency_key: idempotency-key-0 + response: + body: + job: + id: 1yJlHapkseYnNPETIU1B + title: Cashier + is_tip_eligible: true + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + version: 1 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + RetrieveJob: + path: /v2/team-members/jobs/{job_id} + method: GET + auth: true + docs: Retrieves a specified job. + source: + openapi: openapi/openapi.json + display-name: RetrieveJob + request: + name: RetrieveJobRequest + path-parameters: + job_id: + type: string + docs: The ID of the job to retrieve. + response: + docs: Success + type: root.RetrieveJobResponse + status-code: 200 + examples: + - path-parameters: + job_id: job_id + response: + body: + job: + id: 1yJlHapkseYnNPETIU1B + title: Cashier 1 + is_tip_eligible: true + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + version: 2 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + UpdateJob: + path: /v2/team-members/jobs/{job_id} + method: PUT + auth: true + docs: >- + Updates the title or tip eligibility of a job. Changes to the title + propagate to all + + `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference + the job ID. Changes to + + tip eligibility propagate to all `TeamMemberWage` objects that reference + the job ID. + source: + openapi: openapi/openapi.json + display-name: UpdateJob + request: + name: UpdateJobRequest + path-parameters: + job_id: + type: string + docs: The ID of the job to update. + body: + properties: + job: + type: root.Job + docs: >- + The job with the updated fields, either `title`, + `is_tip_eligible`, or both. Only changed fields need + + to be included in the request. Optionally include `version` to + enable optimistic concurrency control. + content-type: application/json + response: + docs: Success + type: root.UpdateJobResponse + status-code: 200 + examples: + - path-parameters: + job_id: job_id + request: + job: + title: Cashier 1 + is_tip_eligible: true + response: + body: + job: + id: 1yJlHapkseYnNPETIU1B + title: Cashier 1 + is_tip_eligible: true + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-13T12:55:45Z' + version: 2 + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/teamMembers.yml b/.mock/definition/teamMembers.yml new file mode 100644 index 00000000..d562a1cf --- /dev/null +++ b/.mock/definition/teamMembers.yml @@ -0,0 +1,765 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/team-members + method: POST + auth: true + docs: >- + Creates a single `TeamMember` object. The `TeamMember` object is + returned on successful creates. + + You must provide the following values in your request to this endpoint: + + - `given_name` + + - `family_name` + + + Learn about [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#createteammember). + source: + openapi: openapi/openapi.json + display-name: CreateTeamMember + request: + body: root.CreateTeamMemberRequest + content-type: application/json + response: + docs: Success + type: root.CreateTeamMemberResponse + status-code: 200 + examples: + - request: + idempotency_key: idempotency-key-0 + team_member: + reference_id: reference_id_1 + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@gmail.com + phone_number: '+14159283333' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - YSGH2WBKG94QZ + - GA2Y9HSJ8KRYT + wage_setting: + job_assignments: + - pay_type: SALARY + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + job_id: FjS8x95cqHiMenw4f1NAUH4P + - pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + response: + body: + team_member: + id: 1yJlHapkseYnNPETIU1B + reference_id: reference_id_1 + is_owner: false + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@example.com + phone_number: '+14159283333' + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - GA2Y9HSJ8KRYT + - YSGH2WBKG94QZ + wage_setting: + team_member_id: 1yJlHapkseYnNPETIU1B + job_assignments: + - job_title: Manager + pay_type: SALARY + hourly_rate: + amount: 1443 + currency: USD + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + job_id: FjS8x95cqHiMenw4f1NAUH4P + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchCreate: + path: /v2/team-members/bulk-create + method: POST + auth: true + docs: >- + Creates multiple `TeamMember` objects. The created `TeamMember` objects + are returned on successful creates. + + This process is non-transactional and processes as much of the request + as possible. If one of the creates in + + the request cannot be successfully processed, the request is not marked + as failed, but the body of the response + + contains explicit error information for the failed create. + + + Learn about [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members). + source: + openapi: openapi/openapi.json + display-name: BulkCreateTeamMembers + request: + name: BatchCreateTeamMembersRequest + body: + properties: + team_members: + type: map + docs: >- + The data used to create the `TeamMember` objects. Each key is + the `idempotency_key` that maps to the + `CreateTeamMemberRequest`. + + The maximum number of create objects is 25. + + + If you include a team member's `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, + + call [ListJobs](api-endpoint:Team-ListJobs). + content-type: application/json + response: + docs: Success + type: root.BatchCreateTeamMembersResponse + status-code: 200 + examples: + - request: + team_members: + idempotency-key-1: + team_member: + reference_id: reference_id_1 + given_name: Joe + family_name: Doe + email_address: joe_doe@gmail.com + phone_number: '+14159283333' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - YSGH2WBKG94QZ + - GA2Y9HSJ8KRYT + idempotency-key-2: + team_member: + reference_id: reference_id_2 + given_name: Jane + family_name: Smith + email_address: jane_smith@gmail.com + phone_number: '+14159223334' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + response: + body: + team_members: + idempotency-key-1: + team_member: + id: ywhG1qfIOoqsHfVRubFV + reference_id: reference_id_1 + is_owner: false + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@gmail.com + phone_number: '+14159283333' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - GA2Y9HSJ8KRYT + - YSGH2WBKG94QZ + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + idempotency-key-2: + team_member: + id: IF_Ncrg7fHhCqxVI9T6R + reference_id: reference_id_2 + is_owner: false + status: ACTIVE + given_name: Jane + family_name: Smith + email_address: jane_smith@gmail.com + phone_number: '+14159223334' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + batchUpdate: + path: /v2/team-members/bulk-update + method: POST + auth: true + docs: >- + Updates multiple `TeamMember` objects. The updated `TeamMember` objects + are returned on successful updates. + + This process is non-transactional and processes as much of the request + as possible. If one of the updates in + + the request cannot be successfully processed, the request is not marked + as failed, but the body of the response + + contains explicit error information for the failed update. + + Learn about [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members). + source: + openapi: openapi/openapi.json + display-name: BulkUpdateTeamMembers + request: + name: BatchUpdateTeamMembersRequest + body: + properties: + team_members: + type: map + docs: >- + The data used to update the `TeamMember` objects. Each key is + the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + + The maximum number of update objects is 25. + + + For each team member, include the fields to add, change, or + clear. Fields can be cleared using a null value. + + To update `wage_setting.job_assignments`, you must provide the + complete list of job assignments. If needed, + + call [ListJobs](api-endpoint:Team-ListJobs) to get the required + `job_id` values. + content-type: application/json + response: + docs: Success + type: root.BatchUpdateTeamMembersResponse + status-code: 200 + examples: + - request: + team_members: + AFMwA08kR-MIF-3Vs0OE: + team_member: + reference_id: reference_id_2 + is_owner: false + status: ACTIVE + given_name: Jane + family_name: Smith + email_address: jane_smith@gmail.com + phone_number: '+14159223334' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + fpgteZNMaf0qOK-a4t6P: + team_member: + reference_id: reference_id_1 + is_owner: false + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@gmail.com + phone_number: '+14159283333' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - YSGH2WBKG94QZ + - GA2Y9HSJ8KRYT + response: + body: + team_members: + AFMwA08kR-MIF-3Vs0OE: + team_member: + id: AFMwA08kR-MIF-3Vs0OE + reference_id: reference_id_2 + is_owner: false + status: ACTIVE + given_name: Jane + family_name: Smith + email_address: jane_smith@example.com + phone_number: '+14159223334' + created_at: '2020-03-24T18:14:00Z' + updated_at: '2020-03-24T18:18:00Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + fpgteZNMaf0qOK-a4t6P: + team_member: + id: fpgteZNMaf0qOK-a4t6P + reference_id: reference_id_1 + is_owner: false + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@example.com + phone_number: '+14159283333' + created_at: '2020-03-24T18:14:00Z' + updated_at: '2020-03-24T18:18:00Z' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - GA2Y9HSJ8KRYT + - YSGH2WBKG94QZ + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + search: + path: /v2/team-members/search + method: POST + auth: true + docs: >- + Returns a paginated list of `TeamMember` objects for a business. + + The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, + or whether + + the team member is the Square account owner. + source: + openapi: openapi/openapi.json + display-name: SearchTeamMembers + request: + name: SearchTeamMembersRequest + body: + properties: + query: + type: optional + docs: The query parameters. + limit: + type: optional + docs: >- + The maximum number of `TeamMember` objects in a page (100 by + default). + validation: + min: 1 + max: 200 + cursor: + type: optional + docs: >- + The opaque cursor for fetching the next page. For more + information, see + + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + content-type: application/json + response: + docs: Success + type: root.SearchTeamMembersResponse + status-code: 200 + examples: + - request: + query: + filter: + location_ids: + - 0G5P3VGACMMQZ + status: ACTIVE + limit: 10 + response: + body: + team_members: + - id: '-3oZQKPKVk6gUXU_V5Qa' + reference_id: '12345678' + is_owner: false + status: ACTIVE + given_name: Johnny + family_name: Cash + email_address: johnny_cash@squareup.com + phone_number: phone_number + created_at: '2019-07-10T17:26:48Z' + updated_at: '2020-04-28T21:49:28Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + wage_setting: + team_member_id: '-3oZQKPKVk6gUXU_V5Qa' + job_assignments: + - job_title: Manager + pay_type: SALARY + hourly_rate: + amount: 1443 + currency: USD + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + job_id: FjS8x95cqHiMenw4f1NAUH4P + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + - id: 1AVJj0DjkzbmbJw5r4KK + reference_id: abcded + is_owner: false + status: ACTIVE + given_name: Lombard + family_name: Smith + email_address: email_address + phone_number: '+14155552671' + created_at: '2020-03-24T18:14:01Z' + updated_at: '2020-06-09T17:38:05Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + wage_setting: + team_member_id: 1AVJj0DjkzbmbJw5r4KK + job_assignments: + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2400 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 2 + created_at: '2020-03-24T18:14:01Z' + updated_at: '2020-06-09T17:38:05Z' + - id: 2JCmiJol_KKFs9z2Evim + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Monica + family_name: Sway + email_address: email_address + phone_number: phone_number + created_at: '2020-03-24T01:09:25Z' + updated_at: '2020-03-24T01:11:25Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + wage_setting: + team_member_id: 2JCmiJol_KKFs9z2Evim + job_assignments: + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2400 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2020-03-24T01:09:25Z' + updated_at: '2020-03-24T01:09:25Z' + - id: 4uXcJQSLtbk3F0UQHFNQ + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Elton + family_name: Ipsum + email_address: email_address + phone_number: phone_number + created_at: '2020-03-24T01:09:23Z' + updated_at: '2020-03-24T01:15:23Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + - id: 5CoUpyrw1YwGWcRd-eDL + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Steven + family_name: Lo + email_address: email_address + phone_number: phone_number + created_at: '2020-03-24T01:09:23Z' + updated_at: '2020-03-24T01:19:23Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + - id: 5MRPTTp8MMBLVSmzrGha + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Patrick + family_name: Steward + email_address: email_address + phone_number: '+14155552671' + created_at: '2020-03-24T18:14:03Z' + updated_at: '2020-03-24T18:18:03Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + wage_setting: + team_member_id: 5MRPTTp8MMBLVSmzrGha + job_assignments: + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2020-03-24T18:14:03Z' + updated_at: '2020-03-24T18:14:03Z' + - id: 7F5ZxsfRnkexhu1PTbfh + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Ivy + family_name: Manny + email_address: email_address + phone_number: phone_number + created_at: '2020-03-24T01:09:25Z' + updated_at: '2020-03-24T01:09:25Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + - id: 808X9HR72yKvVaigQXf4 + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: John + family_name: Smith + email_address: john_smith@example.com + phone_number: '+14155552671' + created_at: '2020-03-24T18:14:02Z' + updated_at: '2020-03-24T18:14:02Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + - id: 9MVDVoY4hazkWKGo_OuZ + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Robert + family_name: Wen + email_address: r_wen@example.com + phone_number: '+14155552671' + created_at: '2020-03-24T18:14:00Z' + updated_at: '2020-03-24T18:14:00Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + - id: 9UglUjOXQ13-hMFypCft + reference_id: reference_id + is_owner: false + status: ACTIVE + given_name: Ashley + family_name: Simpson + email_address: asimpson@example.com + phone_number: '+14155552671' + created_at: '2020-03-24T18:14:00Z' + updated_at: '2020-03-24T18:18:00Z' + assigned_locations: + assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS + wage_setting: + team_member_id: 9UglUjOXQ13-hMFypCft + job_assignments: + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2020-03-24T18:14:00Z' + updated_at: '2020-03-24T18:14:03Z' + cursor: N:9UglUjOXQ13-hMFypCft + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + get: + path: /v2/team-members/{team_member_id} + method: GET + auth: true + docs: >- + Retrieves a `TeamMember` object for the given `TeamMember.id`. + + Learn about [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member). + source: + openapi: openapi/openapi.json + display-name: RetrieveTeamMember + request: + name: GetTeamMembersRequest + path-parameters: + team_member_id: + type: string + docs: The ID of the team member to retrieve. + response: + docs: Success + type: root.GetTeamMemberResponse + status-code: 200 + examples: + - path-parameters: + team_member_id: team_member_id + response: + body: + team_member: + id: 1yJlHapkseYnNPETIU1B + reference_id: reference_id_1 + is_owner: false + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@example.com + phone_number: '+14159283333' + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-15T17:38:05Z' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - GA2Y9HSJ8KRYT + - YSGH2WBKG94QZ + wage_setting: + team_member_id: 1yJlHapkseYnNPETIU1B + job_assignments: + - job_title: Manager + pay_type: SALARY + hourly_rate: + amount: 1443 + currency: USD + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + job_id: FjS8x95cqHiMenw4f1NAUH4P + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/team-members/{team_member_id} + method: PUT + auth: true + docs: >- + Updates a single `TeamMember` object. The `TeamMember` object is + returned on successful updates. + + Learn about [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member). + source: + openapi: openapi/openapi.json + display-name: UpdateTeamMember + request: + body: root.UpdateTeamMemberRequest + path-parameters: + team_member_id: + type: string + docs: The ID of the team member to update. + name: UpdateTeamMembersRequest + content-type: application/json + response: + docs: Success + type: root.UpdateTeamMemberResponse + status-code: 200 + examples: + - path-parameters: + team_member_id: team_member_id + request: + team_member: + reference_id: reference_id_1 + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@gmail.com + phone_number: '+14159283333' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - YSGH2WBKG94QZ + - GA2Y9HSJ8KRYT + wage_setting: + job_assignments: + - pay_type: SALARY + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + job_id: FjS8x95cqHiMenw4f1NAUH4P + - pay_type: HOURLY + hourly_rate: + amount: 1200 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + response: + body: + team_member: + id: 1yJlHapkseYnNPETIU1B + reference_id: reference_id_1 + is_owner: false + status: ACTIVE + given_name: Joe + family_name: Doe + email_address: joe_doe@example.com + phone_number: '+14159283333' + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-15T17:38:05Z' + assigned_locations: + assignment_type: EXPLICIT_LOCATIONS + location_ids: + - GA2Y9HSJ8KRYT + - YSGH2WBKG94QZ + wage_setting: + team_member_id: 1yJlHapkseYnNPETIU1B + job_assignments: + - job_title: Manager + pay_type: SALARY + hourly_rate: + amount: 1443 + currency: USD + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + job_id: FjS8x95cqHiMenw4f1NAUH4P + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 1200 + currency: USD + job_id: VDNpRv8da51NU8qZFC5zDWpF + is_overtime_exempt: true + version: 1 + created_at: '2021-06-11T22:55:45Z' + updated_at: '2021-06-11T22:55:45Z' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/teamMembers/wageSetting.yml b/.mock/definition/teamMembers/wageSetting.yml new file mode 100644 index 00000000..3b9ca3c6 --- /dev/null +++ b/.mock/definition/teamMembers/wageSetting.yml @@ -0,0 +1,170 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + get: + path: /v2/team-members/{team_member_id}/wage-setting + method: GET + auth: true + docs: >- + Retrieves a `WageSetting` object for a team member specified + + by `TeamMember.id`. For more information, see + + [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). + + + Square recommends using + [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or + [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) + + to get this information directly from the `TeamMember.wage_setting` + field. + source: + openapi: openapi/openapi.json + display-name: RetrieveWageSetting + request: + name: GetWageSettingRequest + path-parameters: + team_member_id: + type: string + docs: The ID of the team member for which to retrieve the wage setting. + response: + docs: Success + type: root.GetWageSettingResponse + status-code: 200 + examples: + - path-parameters: + team_member_id: team_member_id + response: + body: + wage_setting: + team_member_id: 1yJlHapkseYnNPETIU1B + job_assignments: + - job_title: Manager + pay_type: SALARY + hourly_rate: + amount: 2164 + currency: USD + annual_rate: + amount: 4500000 + currency: USD + weekly_hours: 40 + is_overtime_exempt: false + version: 1 + created_at: '2020-06-11T23:01:21+00:00' + updated_at: '2020-06-11T23:01:21+00:00' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + update: + path: /v2/team-members/{team_member_id}/wage-setting + method: PUT + auth: true + docs: >- + Creates or updates a `WageSetting` object. The object is created if a + + `WageSetting` with the specified `team_member_id` doesn't exist. + Otherwise, + + it fully replaces the `WageSetting` object for the team member. + + The `WageSetting` is returned on a successful update. For more + information, see + + [Troubleshooting the Team + API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting). + + + Square recommends using + [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or + [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember) + + to manage the `TeamMember.wage_setting` field directly. + source: + openapi: openapi/openapi.json + display-name: UpdateWageSetting + request: + name: UpdateWageSettingRequest + path-parameters: + team_member_id: + type: string + docs: >- + The ID of the team member for which to update the `WageSetting` + object. + body: + properties: + wage_setting: + type: root.WageSetting + docs: >- + The complete `WageSetting` object. For all job assignments, + specify one of the following: + + - `job_id` (recommended) - If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get a list of all + jobs. + + Requires Square API version 2024-12-18 or later. + + - `job_title` - Use the exact, case-sensitive spelling of an + existing title unless you want to create a new job. + + This value is ignored if `job_id` is also provided. + content-type: application/json + response: + docs: Success + type: root.UpdateWageSettingResponse + status-code: 200 + examples: + - path-parameters: + team_member_id: team_member_id + request: + wage_setting: + job_assignments: + - job_title: Manager + pay_type: SALARY + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + is_overtime_exempt: true + response: + body: + wage_setting: + team_member_id: '-3oZQKPKVk6gUXU_V5Qa' + job_assignments: + - job_title: Manager + pay_type: SALARY + hourly_rate: + amount: 1443 + currency: USD + annual_rate: + amount: 3000000 + currency: USD + weekly_hours: 40 + - job_title: Cashier + pay_type: HOURLY + hourly_rate: + amount: 2000 + currency: USD + is_overtime_exempt: true + version: 1 + created_at: '2019-07-10T17:26:48+00:00' + updated_at: '2020-06-11T23:12:04+00:00' + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/terminal.yml b/.mock/definition/terminal.yml new file mode 100644 index 00000000..06947665 --- /dev/null +++ b/.mock/definition/terminal.yml @@ -0,0 +1,232 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + DismissTerminalAction: + path: /v2/terminals/actions/{action_id}/dismiss + method: POST + auth: true + docs: >- + Dismisses a Terminal action request if the status and type of the + request permits it. + + + See [Link and Dismiss + Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) + for more details. + source: + openapi: openapi/openapi.json + display-name: DismissTerminalAction + request: + name: DismissTerminalActionRequest + path-parameters: + action_id: + type: string + docs: >- + Unique ID for the `TerminalAction` associated with the action to + be dismissed. + response: + docs: Success + type: root.DismissTerminalActionResponse + status-code: 200 + examples: + - path-parameters: + action_id: action_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + action: + id: termapia:abcdefg1234567 + device_id: DEVICE_ID + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + created_at: '2021-07-28T23:22:07.476Z' + updated_at: '2021-07-28T23:22:29.511Z' + app_id: APP_ID + location_id: location_id + type: CONFIRMATION + qr_code_options: + title: title + body: body + barcode_contents: barcode_contents + save_card_options: + customer_id: customer_id + card_id: card_id + reference_id: reference_id + signature_options: + title: title + body: body + signature: + - {} + confirmation_options: + title: Marketing communications + body: >- + I agree to receive promotional emails about future events + and activities. + agree_button_text: Agree + disagree_button_text: Decline + decision: + has_agreed: true + receipt_options: + payment_id: payment_id + print_only: true + is_duplicate: true + data_collection_options: + title: title + body: body + input_type: EMAIL + select_options: + title: title + body: body + options: + - reference_id: reference_id + title: title + selected_option: + reference_id: reference_id + title: title + device_metadata: + battery_percentage: battery_percentage + charging_state: charging_state + location_id: location_id + merchant_id: merchant_id + network_connection_type: network_connection_type + payment_region: payment_region + serial_number: serial_number + os_version: os_version + app_version: app_version + wifi_network_name: wifi_network_name + wifi_network_strength: wifi_network_strength + ip_address: ip_address + await_next_action: true + await_next_action_duration: PT5M + DismissTerminalCheckout: + path: /v2/terminals/checkouts/{checkout_id}/dismiss + method: POST + auth: true + docs: >- + Dismisses a Terminal checkout request if the status and type of the + request permits it. + source: + openapi: openapi/openapi.json + display-name: DismissTerminalCheckout + request: + name: DismissTerminalCheckoutRequest + path-parameters: + checkout_id: + type: string + docs: >- + Unique ID for the `TerminalCheckout` associated with the checkout + to be dismissed. + response: + docs: Success + type: root.DismissTerminalCheckoutResponse + status-code: 200 + examples: + - path-parameters: + checkout_id: checkout_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + checkout: + id: LmZEKbo3SBfqO + amount_money: + amount: 2610 + currency: USD + reference_id: reference_id + note: note + order_id: order_id + payment_options: + autocomplete: true + delay_duration: delay_duration + accept_partial_authorization: true + delay_action: CANCEL + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + skip_receipt_screen: false + collect_signature: true + tip_settings: + allow_tipping: true + separate_tip_screen: true + custom_tip_field: false + show_itemized_cart: true + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + payment_ids: + - D7vLJqMkvSoAlX4yyFzUitOy4EPZY + created_at: '2023-11-29T14:59:50.682Z' + updated_at: '2023-11-29T15:00:18.936Z' + app_id: APP_ID + location_id: LOCATION_ID + payment_type: CARD_PRESENT + team_member_id: team_member_id + customer_id: customer_id + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + statement_description_identifier: statement_description_identifier + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + DismissTerminalRefund: + path: /v2/terminals/refunds/{terminal_refund_id}/dismiss + method: POST + auth: true + docs: >- + Dismisses a Terminal refund request if the status and type of the + request permits it. + source: + openapi: openapi/openapi.json + display-name: DismissTerminalRefund + request: + name: DismissTerminalRefundRequest + path-parameters: + terminal_refund_id: + type: string + docs: >- + Unique ID for the `TerminalRefund` associated with the refund to + be dismissed. + response: + docs: Success + type: root.DismissTerminalRefundResponse + status-code: 200 + examples: + - path-parameters: + terminal_refund_id: terminal_refund_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refund: + id: vjkNb2HD-xq5kiWWiJ7RhwrQnkxIn2N0l1nPZY + refund_id: refund_id + payment_id: xq5kiWWiJ7RhwrQnkxIn2N0l1nPZY + order_id: s8OMhQcpEp1b61YywlccSHWqUaQZY + amount_money: + amount: 111 + currency: CAD + reason: Returning item + device_id: 47776348fd8b32b9 + deadline_duration: PT5M + status: IN_PROGRESS + cancel_reason: BUYER_CANCELED + created_at: '2023-11-30T16:16:39.299Z' + updated_at: '2023-11-30T16:16:57.863Z' + app_id: APP_ID + location_id: location_id + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/terminal/actions.yml b/.mock/definition/terminal/actions.yml new file mode 100644 index 00000000..b3b9fea5 --- /dev/null +++ b/.mock/definition/terminal/actions.yml @@ -0,0 +1,448 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/terminals/actions + method: POST + auth: true + docs: Creates a Terminal action request and sends it to the specified device. + source: + openapi: openapi/openapi.json + display-name: CreateTerminalAction + request: + name: CreateTerminalActionRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this `CreateAction` request. + Keys can be any valid string + + but must be unique for every `CreateAction` request. + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more + + information. + validation: + minLength: 1 + maxLength: 64 + action: + type: root.TerminalAction + docs: The Action to create. + content-type: application/json + response: + docs: Success + type: root.CreateTerminalActionResponse + status-code: 200 + examples: + - request: + idempotency_key: thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e + action: + device_id: '{{DEVICE_ID}}' + deadline_duration: PT5M + type: SAVE_CARD + save_card_options: + customer_id: '{{CUSTOMER_ID}}' + reference_id: user-id-1 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + action: + id: termapia:jveJIAkkAjILHkdCE + device_id: DEVICE_ID + deadline_duration: PT5M + status: PENDING + cancel_reason: BUYER_CANCELED + created_at: '2021-07-28T23:22:07.476Z' + updated_at: '2021-07-28T23:22:07.476Z' + app_id: APP_ID + location_id: LOCATION_ID + type: SAVE_CARD + qr_code_options: + title: title + body: body + barcode_contents: barcode_contents + save_card_options: + customer_id: CUSTOMER_ID + card_id: card_id + reference_id: user-id-1 + signature_options: + title: title + body: body + signature: + - {} + confirmation_options: + title: title + body: body + agree_button_text: agree_button_text + disagree_button_text: disagree_button_text + receipt_options: + payment_id: payment_id + print_only: true + is_duplicate: true + data_collection_options: + title: title + body: body + input_type: EMAIL + select_options: + title: title + body: body + options: + - reference_id: reference_id + title: title + selected_option: + reference_id: reference_id + title: title + device_metadata: + battery_percentage: battery_percentage + charging_state: charging_state + location_id: location_id + merchant_id: merchant_id + network_connection_type: network_connection_type + payment_region: payment_region + serial_number: serial_number + os_version: os_version + app_version: app_version + wifi_network_name: wifi_network_name + wifi_network_strength: wifi_network_strength + ip_address: ip_address + await_next_action: true + await_next_action_duration: await_next_action_duration + search: + path: /v2/terminals/actions/search + method: POST + auth: true + docs: >- + Retrieves a filtered list of Terminal action requests created by the + account making the request. Terminal action requests are available for + 30 days. + source: + openapi: openapi/openapi.json + display-name: SearchTerminalActions + request: + name: SearchTerminalActionsRequest + body: + properties: + query: + type: optional + docs: >- + Queries terminal actions based on given conditions and sort + order. + + Leaving this unset will return all actions with the default sort + order. + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this to retrieve the next set of results for the + original query. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more + + information. + limit: + type: optional + docs: Limit the number of results returned for a single request. + validation: + min: 1 + max: 100 + content-type: application/json + response: + docs: Success + type: root.SearchTerminalActionsResponse + status-code: 200 + examples: + - request: + query: + filter: + created_at: + start_at: '2022-04-01T00:00:00.000Z' + sort: + sort_order: DESC + limit: 2 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + action: + - id: termapia:oBGWlAats8xWCiCE + device_id: DEVICE_ID + deadline_duration: PT5M + status: IN_PROGRESS + cancel_reason: BUYER_CANCELED + created_at: '2022-04-08T15:14:04.895Z' + updated_at: '2022-04-08T15:14:05.446Z' + app_id: APP_ID + location_id: LOCATION_ID + type: SAVE_CARD + qr_code_options: + title: title + body: body + barcode_contents: barcode_contents + save_card_options: + customer_id: CUSTOMER_ID + reference_id: user-id-1 + signature_options: + title: title + body: body + confirmation_options: + title: title + body: body + agree_button_text: agree_button_text + receipt_options: + payment_id: payment_id + data_collection_options: + title: title + body: body + input_type: EMAIL + select_options: + title: title + body: body + options: + - reference_id: reference_id + title: title + await_next_action: true + await_next_action_duration: await_next_action_duration + - id: termapia:K2NY2YSSml3lTiCE + device_id: DEVICE_ID + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + created_at: '2022-04-08T15:14:01.210Z' + updated_at: '2022-04-08T15:14:09.861Z' + app_id: APP_ID + location_id: LOCATION_ID + type: SAVE_CARD + qr_code_options: + title: title + body: body + barcode_contents: barcode_contents + save_card_options: + customer_id: CUSTOMER_ID + card_id: ccof:CARD_ID + reference_id: user-id-1 + signature_options: + title: title + body: body + confirmation_options: + title: title + body: body + agree_button_text: agree_button_text + receipt_options: + payment_id: payment_id + data_collection_options: + title: title + body: body + input_type: EMAIL + select_options: + title: title + body: body + options: + - reference_id: reference_id + title: title + await_next_action: true + await_next_action_duration: await_next_action_duration + cursor: CURSOR + get: + path: /v2/terminals/actions/{action_id} + method: GET + auth: true + docs: >- + Retrieves a Terminal action request by `action_id`. Terminal action + requests are available for 30 days. + source: + openapi: openapi/openapi.json + display-name: GetTerminalAction + request: + name: GetActionsRequest + path-parameters: + action_id: + type: string + docs: Unique ID for the desired `TerminalAction`. + response: + docs: Success + type: root.GetTerminalActionResponse + status-code: 200 + examples: + - path-parameters: + action_id: action_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + action: + id: termapia:jveJIAkkAjILHkdCE + device_id: DEVICE_ID + deadline_duration: PT5M + status: IN_PROGRESS + cancel_reason: BUYER_CANCELED + created_at: '2021-07-28T23:22:07.476Z' + updated_at: '2021-07-28T23:22:08.301Z' + app_id: APP_ID + location_id: LOCATION_ID + type: SAVE_CARD + qr_code_options: + title: title + body: body + barcode_contents: barcode_contents + save_card_options: + customer_id: CUSTOMER_ID + card_id: card_id + reference_id: user-id-1 + signature_options: + title: title + body: body + signature: + - {} + confirmation_options: + title: title + body: body + agree_button_text: agree_button_text + disagree_button_text: disagree_button_text + receipt_options: + payment_id: payment_id + print_only: true + is_duplicate: true + data_collection_options: + title: title + body: body + input_type: EMAIL + select_options: + title: title + body: body + options: + - reference_id: reference_id + title: title + selected_option: + reference_id: reference_id + title: title + device_metadata: + battery_percentage: battery_percentage + charging_state: charging_state + location_id: location_id + merchant_id: merchant_id + network_connection_type: network_connection_type + payment_region: payment_region + serial_number: serial_number + os_version: os_version + app_version: app_version + wifi_network_name: wifi_network_name + wifi_network_strength: wifi_network_strength + ip_address: ip_address + await_next_action: true + await_next_action_duration: await_next_action_duration + cancel: + path: /v2/terminals/actions/{action_id}/cancel + method: POST + auth: true + docs: >- + Cancels a Terminal action request if the status of the request permits + it. + source: + openapi: openapi/openapi.json + display-name: CancelTerminalAction + request: + name: CancelActionsRequest + path-parameters: + action_id: + type: string + docs: Unique ID for the desired `TerminalAction`. + response: + docs: Success + type: root.CancelTerminalActionResponse + status-code: 200 + examples: + - path-parameters: + action_id: action_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + action: + id: termapia:jveJIAkkAjILHkdCE + device_id: DEVICE_ID + deadline_duration: PT5M + status: CANCELED + cancel_reason: SELLER_CANCELED + created_at: '2021-07-28T23:22:07.476Z' + updated_at: '2021-07-28T23:22:29.511Z' + app_id: APP_ID + location_id: LOCATION_ID + type: SAVE_CARD + qr_code_options: + title: title + body: body + barcode_contents: barcode_contents + save_card_options: + customer_id: CUSTOMER_ID + card_id: card_id + reference_id: user-id-1 + signature_options: + title: title + body: body + signature: + - {} + confirmation_options: + title: title + body: body + agree_button_text: agree_button_text + disagree_button_text: disagree_button_text + receipt_options: + payment_id: payment_id + print_only: true + is_duplicate: true + data_collection_options: + title: title + body: body + input_type: EMAIL + select_options: + title: title + body: body + options: + - reference_id: reference_id + title: title + selected_option: + reference_id: reference_id + title: title + device_metadata: + battery_percentage: battery_percentage + charging_state: charging_state + location_id: location_id + merchant_id: merchant_id + network_connection_type: network_connection_type + payment_region: payment_region + serial_number: serial_number + os_version: os_version + app_version: app_version + wifi_network_name: wifi_network_name + wifi_network_strength: wifi_network_strength + ip_address: ip_address + await_next_action: true + await_next_action_duration: await_next_action_duration + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/terminal/checkouts.yml b/.mock/definition/terminal/checkouts.yml new file mode 100644 index 00000000..59ff4afe --- /dev/null +++ b/.mock/definition/terminal/checkouts.yml @@ -0,0 +1,354 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/terminals/checkouts + method: POST + auth: true + docs: >- + Creates a Terminal checkout request and sends it to the specified device + to take a payment + + for the requested amount. + source: + openapi: openapi/openapi.json + display-name: CreateTerminalCheckout + request: + name: CreateTerminalCheckoutRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this `CreateCheckout` request. + Keys can be any valid string but + + must be unique for every `CreateCheckout` request. + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 64 + checkout: + type: root.TerminalCheckout + docs: The checkout to create. + content-type: application/json + response: + docs: Success + type: root.CreateTerminalCheckoutResponse + status-code: 200 + examples: + - request: + idempotency_key: 28a0c3bc-7839-11ea-bc55-0242ac130003 + checkout: + amount_money: + amount: 2610 + currency: USD + reference_id: id11572 + note: A brief note + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + checkout: + id: 08YceKh7B3ZqO + amount_money: + amount: 2610 + currency: USD + reference_id: id11572 + note: A brief note + order_id: order_id + payment_options: + autocomplete: true + delay_duration: delay_duration + accept_partial_authorization: true + delay_action: CANCEL + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + skip_receipt_screen: false + collect_signature: true + tip_settings: + allow_tipping: false + show_itemized_cart: true + deadline_duration: PT5M + status: PENDING + cancel_reason: BUYER_CANCELED + payment_ids: + - payment_ids + created_at: '2020-04-06T16:39:32.545Z' + updated_at: '2020-04-06T16:39:32.545Z' + app_id: APP_ID + location_id: LOCATION_ID + payment_type: CARD_PRESENT + team_member_id: team_member_id + customer_id: customer_id + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + statement_description_identifier: statement_description_identifier + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + search: + path: /v2/terminals/checkouts/search + method: POST + auth: true + docs: >- + Returns a filtered list of Terminal checkout requests created by the + application making the request. Only Terminal checkout requests created + for the merchant scoped to the OAuth token are returned. Terminal + checkout requests are available for 30 days. + source: + openapi: openapi/openapi.json + display-name: SearchTerminalCheckouts + request: + name: SearchTerminalCheckoutsRequest + body: + properties: + query: + type: optional + docs: >- + Queries Terminal checkouts based on given conditions and the + sort order. + + Leaving these unset returns all checkouts with the default sort + order. + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + + See + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) + for more information. + limit: + type: optional + docs: Limits the number of results returned for a single request. + validation: + min: 1 + max: 100 + content-type: application/json + response: + docs: Success + type: root.SearchTerminalCheckoutsResponse + status-code: 200 + examples: + - request: + query: + filter: + status: COMPLETED + limit: 2 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + checkouts: + - id: tsQPvzwBpMqqO + amount_money: + amount: 2610 + currency: USD + reference_id: id14467 + note: A brief note + order_id: order_id + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + skip_receipt_screen: false + tip_settings: + allow_tipping: false + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + payment_ids: + - rXnhZzywrEk4vR6pw76fPZfgvaB + created_at: '2020-03-31T18:13:15.921Z' + updated_at: '2020-03-31T18:13:52.725Z' + app_id: APP_ID + location_id: location_id + payment_type: CARD_PRESENT + team_member_id: team_member_id + customer_id: customer_id + statement_description_identifier: statement_description_identifier + - id: XlOPTgcEhrbqO + amount_money: + amount: 2610 + currency: USD + reference_id: id41623 + note: A brief note + order_id: order_id + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + skip_receipt_screen: true + tip_settings: + allow_tipping: false + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + payment_ids: + - VYBF861PaoKPP7Pih0TlbZiNvaB + created_at: '2020-03-31T18:08:31.882Z' + updated_at: '2020-03-31T18:08:41.635Z' + app_id: APP_ID + location_id: location_id + payment_type: CARD_PRESENT + team_member_id: team_member_id + customer_id: customer_id + statement_description_identifier: statement_description_identifier + cursor: RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH + get: + path: /v2/terminals/checkouts/{checkout_id} + method: GET + auth: true + docs: >- + Retrieves a Terminal checkout request by `checkout_id`. Terminal + checkout requests are available for 30 days. + source: + openapi: openapi/openapi.json + display-name: GetTerminalCheckout + request: + name: GetCheckoutsRequest + path-parameters: + checkout_id: + type: string + docs: The unique ID for the desired `TerminalCheckout`. + response: + docs: Success + type: root.GetTerminalCheckoutResponse + status-code: 200 + examples: + - path-parameters: + checkout_id: checkout_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + checkout: + id: 08YceKh7B3ZqO + amount_money: + amount: 2610 + currency: USD + reference_id: id11572 + note: A brief note + order_id: order_id + payment_options: + autocomplete: true + delay_duration: delay_duration + accept_partial_authorization: true + delay_action: CANCEL + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + skip_receipt_screen: false + collect_signature: true + tip_settings: + allow_tipping: false + show_itemized_cart: true + deadline_duration: PT5M + status: IN_PROGRESS + cancel_reason: BUYER_CANCELED + payment_ids: + - payment_ids + created_at: '2020-04-06T16:39:32.545Z' + updated_at: 2020-04-06T16:39:323.001Z + app_id: APP_ID + location_id: LOCATION_ID + payment_type: CARD_PRESENT + team_member_id: team_member_id + customer_id: customer_id + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + statement_description_identifier: statement_description_identifier + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + cancel: + path: /v2/terminals/checkouts/{checkout_id}/cancel + method: POST + auth: true + docs: >- + Cancels a Terminal checkout request if the status of the request permits + it. + source: + openapi: openapi/openapi.json + display-name: CancelTerminalCheckout + request: + name: CancelCheckoutsRequest + path-parameters: + checkout_id: + type: string + docs: The unique ID for the desired `TerminalCheckout`. + response: + docs: Success + type: root.CancelTerminalCheckoutResponse + status-code: 200 + examples: + - path-parameters: + checkout_id: checkout_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + checkout: + id: S1yDlPQx7slqO + amount_money: + amount: 123 + currency: USD + reference_id: id36815 + note: note + order_id: order_id + payment_options: + autocomplete: true + delay_duration: delay_duration + accept_partial_authorization: true + delay_action: CANCEL + device_options: + device_id: dbb5d83a-7838-11ea-bc55-0242ac130003 + skip_receipt_screen: true + collect_signature: true + tip_settings: + allow_tipping: true + show_itemized_cart: true + deadline_duration: PT5M + status: CANCELED + cancel_reason: SELLER_CANCELED + payment_ids: + - payment_ids + created_at: '2020-03-16T15:31:19.934Z' + updated_at: '2020-03-16T15:31:45.787Z' + app_id: APP_ID + location_id: LOCATION_ID + payment_type: CARD_PRESENT + team_member_id: team_member_id + customer_id: customer_id + app_fee_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + statement_description_identifier: statement_description_identifier + tip_money: + amount: 1000000 + currency: UNKNOWN_CURRENCY + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/terminal/refunds.yml b/.mock/definition/terminal/refunds.yml new file mode 100644 index 00000000..628b34ce --- /dev/null +++ b/.mock/definition/terminal/refunds.yml @@ -0,0 +1,253 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + create: + path: /v2/terminals/refunds + method: POST + auth: true + docs: >- + Creates a request to refund an Interac payment completed on a Square + Terminal. Refunds for Interac payments on a Square Terminal are + supported only for Interac debit cards in Canada. Other refunds for + Terminal payments should use the Refunds API. For more information, see + [Refunds API](api:Refunds). + source: + openapi: openapi/openapi.json + display-name: CreateTerminalRefund + request: + name: CreateTerminalRefundRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A unique string that identifies this `CreateRefund` request. + Keys can be any valid string but + + must be unique for every `CreateRefund` request. + + + See [Idempotency + keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + for more information. + validation: + minLength: 1 + maxLength: 64 + refund: + type: optional + docs: The refund to create. + content-type: application/json + response: + docs: Success + type: root.CreateTerminalRefundResponse + status-code: 200 + examples: + - request: + idempotency_key: 402a640b-b26f-401f-b406-46f839590c04 + refund: + payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY + amount_money: + amount: 111 + currency: CAD + reason: Returning items + device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refund: + id: 009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY + refund_id: refund_id + payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY + order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY + amount_money: + amount: 111 + currency: CAD + reason: Returning items + device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291 + deadline_duration: PT5M + status: PENDING + cancel_reason: BUYER_CANCELED + created_at: '2020-09-29T15:21:46.771Z' + updated_at: '2020-09-29T15:21:46.771Z' + app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ + location_id: 76C9W6K8CNNQ5 + search: + path: /v2/terminals/refunds/search + method: POST + auth: true + docs: >- + Retrieves a filtered list of Interac Terminal refund requests created by + the seller making the request. Terminal refund requests are available + for 30 days. + source: + openapi: openapi/openapi.json + display-name: SearchTerminalRefunds + request: + name: SearchTerminalRefundsRequest + body: + properties: + query: + type: optional + docs: >- + Queries the Terminal refunds based on given conditions and the + sort order. Calling + + `SearchTerminalRefunds` without an explicit query parameter + returns all available + + refunds with the default sort order. + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this cursor to retrieve the next set of results for the + original query. + limit: + type: optional + docs: Limits the number of results returned for a single request. + validation: + min: 1 + max: 100 + content-type: application/json + response: + docs: Success + type: root.SearchTerminalRefundsResponse + status-code: 200 + examples: + - request: + query: + filter: + status: COMPLETED + limit: 1 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refunds: + - id: 009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY + refund_id: >- + 5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb + payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY + order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY + amount_money: + amount: 111 + currency: CAD + reason: Returning item + device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291 + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + created_at: '2020-09-29T15:21:46.771Z' + updated_at: '2020-09-29T15:21:48.675Z' + app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ + location_id: 76C9W6K8CNNQ5 + cursor: cursor + get: + path: /v2/terminals/refunds/{terminal_refund_id} + method: GET + auth: true + docs: >- + Retrieves an Interac Terminal refund object by ID. Terminal refund + objects are available for 30 days. + source: + openapi: openapi/openapi.json + display-name: GetTerminalRefund + request: + name: GetRefundsRequest + path-parameters: + terminal_refund_id: + type: string + docs: The unique ID for the desired `TerminalRefund`. + response: + docs: Success + type: root.GetTerminalRefundResponse + status-code: 200 + examples: + - path-parameters: + terminal_refund_id: terminal_refund_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refund: + id: 009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY + refund_id: >- + 5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb + payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY + order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY + amount_money: + amount: 111 + currency: CAD + reason: Returning item + device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291 + deadline_duration: PT5M + status: COMPLETED + cancel_reason: BUYER_CANCELED + created_at: '2020-09-29T15:21:46.771Z' + updated_at: '2020-09-29T15:21:48.675Z' + app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ + location_id: 76C9W6K8CNNQ5 + cancel: + path: /v2/terminals/refunds/{terminal_refund_id}/cancel + method: POST + auth: true + docs: >- + Cancels an Interac Terminal refund request by refund request ID if the + status of the request permits it. + source: + openapi: openapi/openapi.json + display-name: CancelTerminalRefund + request: + name: CancelRefundsRequest + path-parameters: + terminal_refund_id: + type: string + docs: The unique ID for the desired `TerminalRefund`. + response: + docs: Success + type: root.CancelTerminalRefundResponse + status-code: 200 + examples: + - path-parameters: + terminal_refund_id: terminal_refund_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + refund: + id: g6ycb6HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY + refund_id: refund_id + payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY + order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY + amount_money: + amount: 100 + currency: CAD + reason: reason + device_id: 42690809-faa2-4701-a24b-19d3d34c9aaa + deadline_duration: PT5M + status: CANCELED + cancel_reason: SELLER_CANCELED + created_at: '2020-10-21T22:47:23.241Z' + updated_at: '2020-10-21T22:47:30.096Z' + app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ + location_id: 76C9W6K8CNNQ5 + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/v1Transactions.yml b/.mock/definition/v1Transactions.yml new file mode 100644 index 00000000..f6b8232c --- /dev/null +++ b/.mock/definition/v1Transactions.yml @@ -0,0 +1,366 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + V1ListOrders: + path: /v1/{location_id}/orders + method: GET + auth: true + docs: Provides summary information for a merchant's online store orders. + source: + openapi: openapi/openapi.json + display-name: V1ListOrders + request: + name: V1ListOrdersRequest + path-parameters: + location_id: + type: string + docs: The ID of the location to list online store orders for. + query-parameters: + order: + type: optional> + docs: The order in which payments are listed in the response. + limit: + type: optional> + docs: >- + The maximum number of payments to return in a single response. + This value cannot exceed 200. + batch_token: + type: optional> + docs: |- + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. + response: + docs: Success + type: list + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + response: + body: + - errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + id: id + buyer_email: buyer_email + recipient_name: recipient_name + recipient_phone_number: recipient_phone_number + state: PENDING + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + subtotal_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_shipping_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_tax_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_price_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_discount_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + created_at: created_at + updated_at: updated_at + expires_at: expires_at + payment_id: payment_id + buyer_note: buyer_note + completed_note: completed_note + refunded_note: refunded_note + canceled_note: canceled_note + tender: + id: id + type: CREDIT_CARD + name: name + employee_id: employee_id + receipt_url: receipt_url + card_brand: OTHER_BRAND + pan_suffix: pan_suffix + entry_method: MANUAL + payment_note: payment_note + tendered_at: tendered_at + settled_at: settled_at + is_exchange: true + order_history: + - {} + promo_code: promo_code + btc_receive_address: btc_receive_address + btc_price_satoshi: 1.1 + V1RetrieveOrder: + path: /v1/{location_id}/orders/{order_id} + method: GET + auth: true + docs: >- + Provides comprehensive information for a single online store order, + including the order's history. + source: + openapi: openapi/openapi.json + display-name: V1RetrieveOrder + request: + name: V1RetrieveOrderRequest + path-parameters: + location_id: + type: string + docs: The ID of the order's associated location. + order_id: + type: string + docs: >- + The order's Square-issued ID. You obtain this value from Order + objects returned by the List Orders endpoint + response: + docs: Success + type: root.V1Order + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + order_id: order_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + id: id + buyer_email: buyer_email + recipient_name: recipient_name + recipient_phone_number: recipient_phone_number + state: PENDING + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + subtotal_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_shipping_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_tax_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_price_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_discount_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + created_at: created_at + updated_at: updated_at + expires_at: expires_at + payment_id: payment_id + buyer_note: buyer_note + completed_note: completed_note + refunded_note: refunded_note + canceled_note: canceled_note + tender: + id: id + type: CREDIT_CARD + name: name + employee_id: employee_id + receipt_url: receipt_url + card_brand: OTHER_BRAND + pan_suffix: pan_suffix + entry_method: MANUAL + payment_note: payment_note + total_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + tendered_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + tendered_at: tendered_at + settled_at: settled_at + change_back_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + refunded_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + is_exchange: true + order_history: + - action: ORDER_PLACED + created_at: created_at + promo_code: promo_code + btc_receive_address: btc_receive_address + btc_price_satoshi: 1.1 + V1UpdateOrder: + path: /v1/{location_id}/orders/{order_id} + method: PUT + auth: true + docs: >- + Updates the details of an online store order. Every update you perform + on an order corresponds to one of three actions: + source: + openapi: openapi/openapi.json + display-name: V1UpdateOrder + request: + name: V1UpdateOrderRequest + path-parameters: + location_id: + type: string + docs: The ID of the order's associated location. + order_id: + type: string + docs: >- + The order's Square-issued ID. You obtain this value from Order + objects returned by the List Orders endpoint + body: + properties: + action: + type: root.V1UpdateOrderRequestAction + docs: >- + The action to perform on the order (COMPLETE, CANCEL, or + REFUND). + + See + [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) + for possible values + shipped_tracking_number: + type: optional> + docs: >- + The tracking number of the shipment associated with the order. + Only valid if action is COMPLETE. + completed_note: + type: optional> + docs: >- + A merchant-specified note about the completion of the order. + Only valid if action is COMPLETE. + refunded_note: + type: optional> + docs: >- + A merchant-specified note about the refunding of the order. Only + valid if action is REFUND. + canceled_note: + type: optional> + docs: >- + A merchant-specified note about the canceling of the order. Only + valid if action is CANCEL. + content-type: application/json + response: + docs: Success + type: root.V1Order + status-code: 200 + availability: deprecated + examples: + - path-parameters: + location_id: location_id + order_id: order_id + request: + action: COMPLETE + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + id: id + buyer_email: buyer_email + recipient_name: recipient_name + recipient_phone_number: recipient_phone_number + state: PENDING + shipping_address: + address_line_1: address_line_1 + address_line_2: address_line_2 + address_line_3: address_line_3 + locality: locality + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: administrative_district_level_1 + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: postal_code + country: ZZ + first_name: first_name + last_name: last_name + subtotal_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_shipping_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_tax_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_price_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + total_discount_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + created_at: created_at + updated_at: updated_at + expires_at: expires_at + payment_id: payment_id + buyer_note: buyer_note + completed_note: completed_note + refunded_note: refunded_note + canceled_note: canceled_note + tender: + id: id + type: CREDIT_CARD + name: name + employee_id: employee_id + receipt_url: receipt_url + card_brand: OTHER_BRAND + pan_suffix: pan_suffix + entry_method: MANUAL + payment_note: payment_note + total_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + tendered_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + tendered_at: tendered_at + settled_at: settled_at + change_back_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + refunded_money: + amount: 1 + currency_code: UNKNOWN_CURRENCY + is_exchange: true + order_history: + - action: ORDER_PLACED + created_at: created_at + promo_code: promo_code + btc_receive_address: btc_receive_address + btc_price_satoshi: 1.1 + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/vendors.yml b/.mock/definition/vendors.yml new file mode 100644 index 00000000..037c1a82 --- /dev/null +++ b/.mock/definition/vendors.yml @@ -0,0 +1,530 @@ +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + batchCreate: + path: /v2/vendors/bulk-create + method: POST + auth: true + docs: >- + Creates one or more [Vendor](entity:Vendor) objects to represent + suppliers to a seller. + source: + openapi: openapi/openapi.json + display-name: BulkCreateVendors + request: + name: BatchCreateVendorsRequest + body: + properties: + vendors: + type: map + docs: >- + Specifies a set of new [Vendor](entity:Vendor) objects as + represented by a collection of idempotency-key/`Vendor`-object + pairs. + content-type: application/json + response: + docs: Success + type: root.BatchCreateVendorsResponse + status-code: 200 + examples: + - request: + vendors: + 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe: + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + contacts: + - name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + responses: + 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T10:21:54.859Z' + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + version: 0 + status: ACTIVE + batchGet: + path: /v2/vendors/bulk-retrieve + method: POST + auth: true + docs: Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs. + source: + openapi: openapi/openapi.json + display-name: BulkRetrieveVendors + request: + name: BatchGetVendorsRequest + body: + properties: + vendor_ids: + type: optional>> + docs: IDs of the [Vendor](entity:Vendor) objects to retrieve. + content-type: application/json + response: + docs: Success + type: root.BatchGetVendorsResponse + status-code: 200 + examples: + - request: + vendor_ids: + - INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + responses: + INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T10:21:54.859Z' + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + version: 1 + status: ACTIVE + batchUpdate: + path: /v2/vendors/bulk-update + method: PUT + auth: true + docs: >- + Updates one or more of existing [Vendor](entity:Vendor) objects as + suppliers to a seller. + source: + openapi: openapi/openapi.json + display-name: BulkUpdateVendors + request: + name: BatchUpdateVendorsRequest + body: + properties: + vendors: + type: map + docs: >- + A set of [UpdateVendorRequest](entity:UpdateVendorRequest) + objects encapsulating to-be-updated [Vendor](entity:Vendor) + + objects. The set is represented by a collection of + `Vendor`-ID/`UpdateVendorRequest`-object pairs. + content-type: application/json + response: + docs: Success + type: root.BatchUpdateVendorsResponse + status-code: 200 + examples: + - request: + vendors: + FMCYHBWT1TPL8MFH52PBMEN92A: + vendor: {} + INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4: + vendor: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + responses: + INV_V_FMCYHBWT1TPL8MFH52PBMEN92A: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + vendor: + id: INV_V_FMCYHBWT1TPL8MFH52PBMEN92A + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T20:21:54.859Z' + name: Annie’s Hot Sauce + address: + address_line_1: 202 Mill St + locality: Moorestown + administrative_district_level_1: NJ + postal_code: '08057' + country: US + contacts: + - id: INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4 + name: Annie Thomas + email_address: annie@annieshotsauce.com + phone_number: 1-212-555-4250 + ordinal: 0 + version: 11 + status: ACTIVE + INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:10:54.859Z' + updated_at: '2022-03-16T20:21:54.859Z' + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 0 + account_number: '4025391' + note: favorite vendor + version: 31 + status: ACTIVE + create: + path: /v2/vendors/create + method: POST + auth: true + docs: >- + Creates a single [Vendor](entity:Vendor) object to represent a supplier + to a seller. + source: + openapi: openapi/openapi.json + display-name: CreateVendor + request: + name: CreateVendorRequest + body: + properties: + idempotency_key: + type: string + docs: >- + A client-supplied, universally unique identifier (UUID) to make + this [CreateVendor](api-endpoint:Vendors-CreateVendor) call + idempotent. + + + See + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + in the + + [API Development + 101](https://developer.squareup.com/docs/buildbasics) section + for more + + information. + validation: + minLength: 1 + maxLength: 128 + vendor: + type: optional + docs: The requested [Vendor](entity:Vendor) to be created. + content-type: application/json + response: + docs: Success + type: root.CreateVendorResponse + status-code: 200 + examples: + - request: + idempotency_key: 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe + vendor: + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + contacts: + - name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T10:21:54.859Z' + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + version: 1 + status: ACTIVE + search: + path: /v2/vendors/search + method: POST + auth: true + docs: >- + Searches for vendors using a filter against supported + [Vendor](entity:Vendor) properties and a supported sorter. + source: + openapi: openapi/openapi.json + display-name: SearchVendors + request: + name: SearchVendorsRequest + body: + properties: + filter: + type: optional + docs: Specifies a filter used to search for vendors. + sort: + type: optional + docs: Specifies a sorter used to sort the returned vendors. + cursor: + type: optional + docs: >- + A pagination cursor returned by a previous call to this + endpoint. + + Provide this to retrieve the next set of results for the + original query. + + + See the + [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) + guide for more information. + content-type: application/json + response: + docs: Success + type: root.SearchVendorsResponse + status-code: 200 + examples: + - request: {} + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + vendors: + - id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T10:21:54.859Z' + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + locality: New York + administrative_district_level_1: NY + postal_code: '10003' + country: US + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + version: 1 + status: ACTIVE + cursor: cursor + get: + path: /v2/vendors/{vendor_id} + method: GET + auth: true + docs: Retrieves the vendor of a specified [Vendor](entity:Vendor) ID. + source: + openapi: openapi/openapi.json + display-name: RetrieveVendor + request: + name: GetVendorsRequest + path-parameters: + vendor_id: + type: string + docs: ID of the [Vendor](entity:Vendor) to retrieve. + response: + docs: Success + type: root.GetVendorResponse + status-code: 200 + examples: + - path-parameters: + vendor_id: vendor_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T10:21:54.859Z' + name: Joe's Fresh Seafood + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 1 + account_number: '4025391' + note: a vendor + version: 1 + status: ACTIVE + update: + path: /v2/vendors/{vendor_id} + method: PUT + auth: true + docs: >- + Updates an existing [Vendor](entity:Vendor) object as a supplier to a + seller. + source: + openapi: openapi/openapi.json + display-name: UpdateVendor + request: + body: root.UpdateVendorRequest + path-parameters: + vendor_id: + type: string + docs: ID of the [Vendor](entity:Vendor) to retrieve. + name: UpdateVendorsRequest + content-type: application/json + response: + docs: Success + type: root.UpdateVendorResponse + status-code: 200 + examples: + - path-parameters: + vendor_id: vendor_id + request: + idempotency_key: 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + name: Jack's Chicken Shack + version: 1 + status: ACTIVE + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + vendor: + id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 + created_at: '2022-03-16T10:21:54.859Z' + updated_at: '2022-03-16T20:21:54.859Z' + name: Jack's Chicken Shack + address: + address_line_1: 505 Electric Ave + address_line_2: Suite 600 + address_line_3: address_line_3 + locality: New York + sublocality: sublocality + sublocality_2: sublocality_2 + sublocality_3: sublocality_3 + administrative_district_level_1: NY + administrative_district_level_2: administrative_district_level_2 + administrative_district_level_3: administrative_district_level_3 + postal_code: '10003' + country: US + first_name: first_name + last_name: last_name + contacts: + - id: INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A + name: Joe Burrow + email_address: joe@joesfreshseafood.com + phone_number: 1-212-555-4250 + ordinal: 0 + account_number: '4025391' + note: note + version: 2 + status: ACTIVE + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/webhooks/eventTypes.yml b/.mock/definition/webhooks/eventTypes.yml new file mode 100644 index 00000000..13b091ac --- /dev/null +++ b/.mock/definition/webhooks/eventTypes.yml @@ -0,0 +1,42 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/webhooks/event-types + method: GET + auth: true + docs: Lists all webhook event types that can be subscribed to. + source: + openapi: openapi/openapi.json + display-name: ListWebhookEventTypes + request: + name: ListEventTypesRequest + query-parameters: + api_version: + type: optional> + docs: >- + The API version for which to list event types. Setting this field + overrides the default version used by the application. + response: + docs: Success + type: root.ListWebhookEventTypesResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + event_types: + - inventory.count.updated + metadata: + - event_type: inventory.count.updated + api_version_introduced: '2018-07-12' + release_status: PUBLIC + source: + openapi: openapi/openapi.json diff --git a/.mock/definition/webhooks/subscriptions.yml b/.mock/definition/webhooks/subscriptions.yml new file mode 100644 index 00000000..f5f89d18 --- /dev/null +++ b/.mock/definition/webhooks/subscriptions.yml @@ -0,0 +1,369 @@ +imports: + root: ../__package__.yml +service: + auth: false + base-path: '' + endpoints: + list: + path: /v2/webhooks/subscriptions + method: GET + auth: true + docs: Lists all webhook subscriptions owned by your application. + pagination: + cursor: $request.cursor + next_cursor: $response.cursor + results: $response.subscriptions + source: + openapi: openapi/openapi.json + display-name: ListWebhookSubscriptions + request: + name: ListSubscriptionsRequest + query-parameters: + cursor: + type: optional> + docs: >- + A pagination cursor returned by a previous call to this endpoint. + + Provide this to retrieve the next set of results for your original + query. + + + For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + include_disabled: + type: optional> + default: false + docs: >- + Includes disabled [Subscription](entity:WebhookSubscription)s. + + By default, all enabled + [Subscription](entity:WebhookSubscription)s are returned. + sort_order: + type: optional> + docs: >- + Sorts the returned list by when the + [Subscription](entity:WebhookSubscription) was created with the + specified order. + + This field defaults to ASC. + limit: + type: optional> + docs: >- + The maximum number of results to be returned in a single page. + + It is possible to receive fewer results than the specified limit + on a given page. + + The default value of 100 is also the maximum allowed value. + + + Default: 100 + response: + docs: Success + type: root.ListWebhookSubscriptionsResponse + status-code: 200 + examples: + - response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscriptions: + - id: wbhk_b35f6b3145074cf9ad513610786c19d5 + name: Example Webhook Subscription + enabled: true + event_types: + - payment.created + - payment.updated + notification_url: https://example-webhook-url.com + api_version: '2021-12-15' + signature_key: signature_key + created_at: 2022-01-10 23:29:48 +0000 UTC + updated_at: 2022-01-10 23:29:48 +0000 UTC + cursor: cursor + create: + path: /v2/webhooks/subscriptions + method: POST + auth: true + docs: Creates a webhook subscription. + source: + openapi: openapi/openapi.json + display-name: CreateWebhookSubscription + request: + name: CreateWebhookSubscriptionRequest + body: + properties: + idempotency_key: + type: optional + docs: >- + A unique string that identifies the + [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) + request. + validation: + maxLength: 45 + subscription: + type: root.WebhookSubscription + docs: The [Subscription](entity:WebhookSubscription) to create. + content-type: application/json + response: + docs: Success + type: root.CreateWebhookSubscriptionResponse + status-code: 200 + examples: + - request: + idempotency_key: 63f84c6c-2200-4c99-846c-2670a1311fbf + subscription: + name: Example Webhook Subscription + event_types: + - payment.created + - payment.updated + notification_url: https://example-webhook-url.com + api_version: '2021-12-15' + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: wbhk_b35f6b3145074cf9ad513610786c19d5 + name: Example Webhook Subscription + enabled: true + event_types: + - payment.created + - payment.updated + notification_url: https://example-webhook-url.com + api_version: '2021-12-15' + signature_key: 1k9bIJKCeTmSQwyagtNRLg + created_at: 2022-01-10 23:29:48 +0000 UTC + updated_at: 2022-01-10 23:29:48 +0000 UTC + get: + path: /v2/webhooks/subscriptions/{subscription_id} + method: GET + auth: true + docs: Retrieves a webhook subscription identified by its ID. + source: + openapi: openapi/openapi.json + display-name: RetrieveWebhookSubscription + request: + name: GetSubscriptionsRequest + path-parameters: + subscription_id: + type: string + docs: >- + [REQUIRED] The ID of the + [Subscription](entity:WebhookSubscription) to retrieve. + response: + docs: Success + type: root.GetWebhookSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: wbhk_b35f6b3145074cf9ad513610786c19d5 + name: Example Webhook Subscription + enabled: true + event_types: + - payment.created + - payment.updated + notification_url: https://example-webhook-url.com + api_version: '2021-12-15' + signature_key: 1k9bIJKCeTmSQwyagtNRLg + created_at: 2022-01-10 23:29:48 +0000 UTC + updated_at: 2022-01-10 23:29:48 +0000 UTC + update: + path: /v2/webhooks/subscriptions/{subscription_id} + method: PUT + auth: true + docs: Updates a webhook subscription. + source: + openapi: openapi/openapi.json + display-name: UpdateWebhookSubscription + request: + name: UpdateWebhookSubscriptionRequest + path-parameters: + subscription_id: + type: string + docs: >- + [REQUIRED] The ID of the + [Subscription](entity:WebhookSubscription) to update. + body: + properties: + subscription: + type: optional + docs: The [Subscription](entity:WebhookSubscription) to update. + content-type: application/json + response: + docs: Success + type: root.UpdateWebhookSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: + subscription: + name: Updated Example Webhook Subscription + enabled: false + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription: + id: wbhk_b35f6b3145074cf9ad513610786c19d5 + name: Updated Example Webhook Subscription + enabled: false + event_types: + - payment.created + - payment.updated + notification_url: https://example-webhook-url.com + api_version: '2021-12-15' + signature_key: signature_key + created_at: 2022-01-10 23:29:48 +0000 UTC + updated_at: 2022-01-10 23:45:51 +0000 UTC + delete: + path: /v2/webhooks/subscriptions/{subscription_id} + method: DELETE + auth: true + docs: Deletes a webhook subscription. + source: + openapi: openapi/openapi.json + display-name: DeleteWebhookSubscription + request: + name: DeleteSubscriptionsRequest + path-parameters: + subscription_id: + type: string + docs: >- + [REQUIRED] The ID of the + [Subscription](entity:WebhookSubscription) to delete. + response: + docs: Success + type: root.DeleteWebhookSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + updateSignatureKey: + path: /v2/webhooks/subscriptions/{subscription_id}/signature-key + method: POST + auth: true + docs: >- + Updates a webhook subscription by replacing the existing signature key + with a new one. + source: + openapi: openapi/openapi.json + display-name: UpdateWebhookSubscriptionSignatureKey + request: + name: UpdateWebhookSubscriptionSignatureKeyRequest + path-parameters: + subscription_id: + type: string + docs: >- + [REQUIRED] The ID of the + [Subscription](entity:WebhookSubscription) to update. + body: + properties: + idempotency_key: + type: optional> + docs: >- + A unique string that identifies the + [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) + request. + validation: + maxLength: 45 + content-type: application/json + response: + docs: Success + type: root.UpdateWebhookSubscriptionSignatureKeyResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: + idempotency_key: ed80ae6b-0654-473b-bbab-a39aee89a60d + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + signature_key: 1k9bIJKCeTmSQwyagtNRLg + test: + path: /v2/webhooks/subscriptions/{subscription_id}/test + method: POST + auth: true + docs: >- + Tests a webhook subscription by sending a test event to the notification + URL. + source: + openapi: openapi/openapi.json + display-name: TestWebhookSubscription + request: + name: TestWebhookSubscriptionRequest + path-parameters: + subscription_id: + type: string + docs: >- + [REQUIRED] The ID of the + [Subscription](entity:WebhookSubscription) to test. + body: + properties: + event_type: + type: optional> + docs: >- + The event type that will be used to test the + [Subscription](entity:WebhookSubscription). The event type must + be + + contained in the list of event types in the + [Subscription](entity:WebhookSubscription). + content-type: application/json + response: + docs: Success + type: root.TestWebhookSubscriptionResponse + status-code: 200 + examples: + - path-parameters: + subscription_id: subscription_id + request: + event_type: payment.created + response: + body: + errors: + - category: API_ERROR + code: INTERNAL_SERVER_ERROR + detail: detail + field: field + subscription_test_result: + id: 23eed5a9-2b12-403e-b212-7e2889aea0f6 + status_code: 404 + payload: >- + {"merchant_id":"1ZYMKZY1YFGBW","type":"payment.created","event_id":"23eed5a9-2b12-403e-b212-7e2889aea0f6","created_at":"2022-01-11T00:06:48.322945116Z","data":{"type":"payment","id":"KkAkhdMsgzn59SM8A89WgKwekxLZY","object":{"payment":{"amount_money":{"amount":100,"currency":"USD"},"approved_money":{"amount":100,"currency":"USD"},"capabilities":["EDIT_TIP_AMOUNT","EDIT_TIP_AMOUNT_UP","EDIT_TIP_AMOUNT_DOWN"],"card_details":{"avs_status":"AVS_ACCEPTED","card":{"bin":"540988","card_brand":"MASTERCARD","card_type":"CREDIT","exp_month":11,"exp_year":2022,"fingerprint":"sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg","last_4":"9029","prepaid_type":"NOT_PREPAID"},"card_payment_timeline":{"authorized_at":"2020-11-22T21:16:51.198Z"},"cvv_status":"CVV_ACCEPTED","entry_method":"KEYED","statement_description":"SQ + *DEFAULT TEST + ACCOUNT","status":"AUTHORIZED"},"created_at":"2020-11-22T21:16:51.086Z","delay_action":"CANCEL","delay_duration":"PT168H","delayed_until":"2020-11-29T21:16:51.086Z","id":"hYy9pRFVxpDsO1FB05SunFWUe9JZY","location_id":"S8GWD5R9QB376","order_id":"03O3USaPaAaFnI6kkwB1JxGgBsUZY","receipt_number":"hYy9","risk_evaluation":{"created_at":"2020-11-22T21:16:51.198Z","risk_level":"NORMAL"},"source_type":"CARD","status":"APPROVED","total_money":{"amount":100,"currency":"USD"},"updated_at":"2020-11-22T21:16:51.198Z","version_token":"FfQhQJf9r3VSQIgyWBk1oqhIwiznLwVwJbVVA0bdyEv6o"}}}} + created_at: 2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746 + updated_at: 2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746 + source: + openapi: openapi/openapi.json diff --git a/.mock/fern.config.json b/.mock/fern.config.json new file mode 100644 index 00000000..2414e804 --- /dev/null +++ b/.mock/fern.config.json @@ -0,0 +1,4 @@ +{ + "organization" : "square", + "version" : "0.57.17" +} \ No newline at end of file diff --git a/.mock/openapi/openapi.json b/.mock/openapi/openapi.json new file mode 100644 index 00000000..cbb5c9be --- /dev/null +++ b/.mock/openapi/openapi.json @@ -0,0 +1,64783 @@ +{ + "openapi": "3.0.0", + "info": { + "version": "2.0", + "title": "Square", + "description": "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.", + "termsOfService": "https://connect.squareup.com/tos", + "contact": { + "name": "Square Developer Platform", + "email": "developers@squareup.com", + "url": "https://squareup.com/developers" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "externalDocs": { + "description": "Read the official documentation here:", + "url": "https://docs.connect.squareup.com/" + }, + "x-server-configuration": { + "default-environment": "production", + "default-server": "default", + "environments": [ + { + "name": "production", + "servers": [ + { + "name": "default", + "url": "https://connect.squareup.com" + } + ] + }, + { + "name": "sandbox", + "servers": [ + { + "name": "default", + "url": "https://connect.squareupsandbox.com" + } + ] + }, + { + "name": "custom", + "servers": [ + { + "name": "default", + "url": "{custom_url}" + } + ] + } + ], + "parameters": [ + { + "name": "custom_url", + "description": "Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`", + "type": "string", + "example": "https://connect.squareup.com" + } + ] + }, + "x-square-generic-error-codes": [ + "ACCESS_TOKEN_EXPIRED", + "ACCESS_TOKEN_REVOKED", + "API_VERSION_INCOMPATIBLE", + "APPLICATION_DISABLED", + "ARRAY_EMPTY", + "ARRAY_LENGTH_TOO_LONG", + "ARRAY_LENGTH_TOO_SHORT", + "BAD_CERTIFICATE", + "BAD_GATEWAY", + "BAD_REQUEST", + "CONFLICT", + "CONFLICTING_PARAMETERS", + "CURRENCY_MISMATCH", + "EXPECTED_ARRAY", + "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "EXPECTED_BOOLEAN", + "EXPECTED_FLOAT", + "EXPECTED_INTEGER", + "EXPECTED_JSON_BODY", + "EXPECTED_MAP", + "EXPECTED_OBJECT", + "EXPECTED_STRING", + "FORBIDDEN", + "GATEWAY_TIMEOUT", + "GONE", + "IDEMPOTENCY_KEY_REUSED", + "INCORRECT_TYPE", + "INSUFFICIENT_SCOPES", + "INTERNAL_SERVER_ERROR", + "INVALID_ARRAY_VALUE", + "INVALID_CONTENT_TYPE", + "INVALID_CURSOR", + "INVALID_ENUM_VALUE", + "INVALID_FORM_VALUE", + "INVALID_SORT_ORDER", + "INVALID_SQUARE_VERSION_FORMAT", + "INVALID_TIME", + "INVALID_TIME_RANGE", + "INVALID_VALUE", + "LOCATION_MISMATCH", + "MAP_KEY_LENGTH_TOO_LONG", + "MAP_KEY_LENGTH_TOO_SHORT", + "MERCHANT_SUBSCRIPTION_NOT_FOUND", + "METHOD_NOT_ALLOWED", + "MISSING_REQUIRED_PARAMETER", + "NOT_ACCEPTABLE", + "NOT_FOUND", + "NOT_IMPLEMENTED", + "NO_FIELDS_SET", + "RATE_LIMITED", + "REQUEST_ENTITY_TOO_LARGE", + "REQUEST_TIMEOUT", + "SANDBOX_NOT_SUPPORTED", + "SERVICE_UNAVAILABLE", + "TOO_MANY_MAP_ENTRIES", + "UNAUTHORIZED", + "UNEXPECTED_VALUE", + "UNKNOWN_BODY_PARAMETER", + "UNKNOWN_QUERY_PARAMETER", + "UNPROCESSABLE_ENTITY", + "UNSUPPORTED_MEDIA_TYPE", + "V1_ACCESS_TOKEN", + "V1_APPLICATION", + "VALUE_EMPTY", + "VALUE_REGEX_MISMATCH", + "VALUE_TOO_HIGH", + "VALUE_TOO_LONG", + "VALUE_TOO_LOW", + "VALUE_TOO_SHORT" + ] + }, + "servers": [ + { + "url": "https://connect.squareup.com", + "variables": {} + } + ], + "components": { + "securitySchemes": { + "oauth2": { + "type": "oauth2", + "x-additional-headers": [ + { + "name": "Square-Version", + "description": "Square Connect API versions", + "schema": { + "default": "2025-04-16" + } + } + ], + "flows": { + "authorizationCode": { + "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", + "tokenUrl": "https://connect.squareup.com/oauth2/token", + "scopes": { + "ADDON_CONFIGURATIONS_READ": "__HTTP Method__: `GET`\n\nGrants write access for third-party Add-ons to read configurations of their Add-ons, for example, when calling `RetrieveConfiguration` endpoint.", + "ADDON_CONFIGURATIONS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access for third-party Add-ons to store configurations of their Add-ons, for example, when calling `CreateConfiguration` endpoint.", + "APPOINTMENTS_ALL_READ": "__HTTP Method__: `GET`, `POST`\n\nGrants read access to all of a seller's booking information, calendar, and business details.\nThis permission must be accompanied by the `APPOINTMENTS_READ` permission.", + "APPOINTMENTS_ALL_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to all booking details, including double-booking a seller.\nThis permission must be accompanied by the `APPOINTMENTS_WRITE` permission.", + "APPOINTMENTS_BUSINESS_SETTINGS_READ": "__HTTP Method__: `GET`\n\nGrants read access to booking business settings. For example, to call the\nListTeamMemberBookingProfiles endpoint.", + "APPOINTMENTS_READ": "__HTTP Method__: `GET`, `POST`\n\nGrants read access to booking information. For example, to call the\nRetrieveBooking endpoint.", + "APPOINTMENTS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to booking information. For example, to call the CreateBooking endpoint.", + "BANK_ACCOUNTS_READ": "__HTTP Method__: `GET`\n\nGrants read access to bank account information associated with the targeted\nSquare account. For example, to call the Connect v1 ListBankAccounts endpoint.", + "CASH_DRAWER_READ": "__HTTP Method__: `GET`\n\nGrants read access to cash drawer shift information. For example, to call the\nListCashDrawerShifts endpoint.", + "CHANNELS_CREATE": "__HTTP Method__: `POST`\n\nGrants write access to create channels, for example, when calling the\n`CreateChannel` endpoint.", + "CHANNELS_READ": "__HTTP Method__: `GET`\n\nGrants read access to view channels, for example, when calling the\n`RetrieveChannel` endpoint.", + "CHANNELS_UPDATE": "__HTTP Method__: `PUT`\n\nGrants write access to update channels, for example, when calling the\n`UpdateChannel` endpoint.", + "CUSTOMERS_READ": "__HTTP Method__: `GET`\n\nGrants read access to customer information. For example, to call the\nListCustomers endpoint.", + "CUSTOMERS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to customer information. For example, to create and update\ncustomer profiles.", + "DEVICES_READ": "__HTTP Method__: `GET`\n\nGrants read access to device information. For example, to\ncall the `GetDevice` and `ListDevices` endpoints.", + "DEVICE_CREDENTIAL_MANAGEMENT": "__HTTP Method__: `POST`, `GET`\n\nGrants read/write access to device credentials information. For example, to\ncall the CreateDeviceCode endpoint.", + "DISCOUNT_CODES_READ": "__HTTP Method__: `GET`\n\nGrants read access to Discount Codes API. For example, to call the `RetrieveDiscountCode` and `RetrieveRedemption` endpoints.", + "DISCOUNT_CODES_WRITE": "__HTTP Method__: `POST`\n\nGrants write access to Discount Codes API.", + "DISPUTES_READ": "__HTTP Method__: `GET`\n\nGrants read access to dispute information. For example, to call the RetrieveDispute\nendpoint.", + "DISPUTES_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to dispute information. For example, to call the SubmitEvidence\nendpoint.", + "EMPLOYEES_READ": "__HTTP Method__: `GET`\n\nGrants read access to employee profile information. For example, to call the\nConnect v1 Employees API.", + "EMPLOYEES_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to employee profile information. For example, to create\nand modify employee profiles.", + "GIFTCARDS_READ": "__HTTP Method__: `GET`, `POST`\n\nGrants read access to gift card information. For example, to call the RetrieveGiftCard\nendpoint.", + "GIFTCARDS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to gift card information. For example, to call the CreateGiftCard\nendpoint.", + "INVENTORY_READ": "__HTTP Method__: `GET`\n\nGrants read access to inventory information. For example, to call the\nRetrieveInventoryCount endpoint.", + "INVENTORY_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to inventory information. For example, to call the\nBatchChangeInventory endpoint.", + "INVOICES_READ": "__HTTP Method__: `GET`, `POST`\n\nGrants read access to invoice information. For example, to call the ListInvoices endpoint.", + "INVOICES_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to invoice information. For example, to call the CreateInvoice endpoint.", + "ITEMS_READ": "__HTTP Method__: `GET`\n\nGrants read access to product catalog information. For example, to obtain objects in a product catalog.", + "ITEMS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to product catalog information. For example, to modify or\nadd to a product catalog.", + "LOYALTY_READ": "__HTTP Method__: `GET`\n\nGrants read access to loyalty information. For example, to call the\nListLoyaltyPrograms endpoint.", + "LOYALTY_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to loyalty information. For example, to call the\nCreateLoyaltyAccount endpoint.", + "MERCHANT_PROFILE_READ": "__HTTP Method__: `GET`\n\nGrants read access to business and location information. For example, to\nobtain a location ID for subsequent activity.", + "MERCHANT_PROFILE_WRITE": "__HTTP Method__: `POST`, `PUT`\n\nGrants write access to business and location information. For example, to create a new location or\nupdate the business hours at an existing location.", + "ONLINE_STORE_SITE_READ": "__HTTP Method__: `GET`, `POST`\n\nRead access to ECOM online store site details.", + "ONLINE_STORE_SNIPPETS_READ": "__HTTP Method__: `GET`, `POST`\n\nRead access to ECOM online store snippets on published websites.", + "ONLINE_STORE_SNIPPETS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nWrite access to ECOM online store snippets on published websites.", + "ORDERS_READ": "__HTTP Method__: `GET`\n\nGrants read access to order information. For example, to call the\nBatchRetrieveOrders endpoint.", + "ORDERS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to order information. For example, to call the\nCreateCheckout endpoint.", + "PAYMENTS_READ": "__HTTP Method__: `GET`\n\nGrants read access to transaction and refund information. For example, to call\nthe RetrieveTransaction endpoint.", + "PAYMENTS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to transaction and refunds information. For example, to\nprocess payments with the Payments or Checkout API.", + "PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nAllow third party applications to deduct a portion of each transaction amount.\n__Required__ to use multiparty transaction functionality with the Payments\nAPI.", + "PAYMENTS_WRITE_IN_PERSON": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to payments and refunds information. For example, to\nprocess in-person payments.", + "PAYMENTS_WRITE_SHARED_ONFILE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nAllows the developer to process payments on behalf of a seller using a shared on file payment method.", + "PAYOUTS_READ": "__HTTP Method__: `GET`\n\nGrants read access to payouts and payout entries information. For example,\nto call the Connect v2 `ListPayouts` endpoint.", + "PERMISSION_SETS_READ": "__HTTP Method__: `GET`\n\nGrants read access to Permission Sets. For example, to\ncall the `ListPermissionSets` and `RetrievePermissionSet` endpoints.", + "PERMISSION_SETS_WRITE": "__HTTP Method__: `PUT`\n\nGrants write access to Permission Sets.", + "RESERVATIONS_READ": "__HTTP Method__: `GET`\n\nGrants read access to reservation information, for example, when calling the\n`RetrieveReservation` endpoint.", + "RESERVATIONS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to reservation information, for example, when calling the\n`CreateReservation` endpoint.", + "RESTAURANT_CHECKS_READ": "__HTTP Method__: `GET`\n\nGrants read access to check information, for example, when calling the\n`RetrieveCheck` endpoint.", + "SETTLEMENTS_READ": "__HTTP Method__: `GET`\n\nGrants read access to settlement (deposit) information. For example, to call\nthe Connect v1 ListSettlements endpoint.", + "SUBSCRIPTIONS_READ": "__HTTP Method__: `GET`, `POST`\n\nGrants read access to subscription information. For example, to call the RetrieveSubscription\nendpoint.", + "SUBSCRIPTIONS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to subscription information. For example, to call the CreateSubscription\nendpoint.", + "TIMECARDS_READ": "__HTTP Method__: `GET`\n\nGrants read access to employee timecard information. For example, to call the\nConnect v2 SearchShifts endpoint.", + "TIMECARDS_SETTINGS_READ": "__HTTP Method__: `GET`\n\nGrants read access to employee timecard settings information. For example, to\ncall the GetBreakType endpoint.", + "TIMECARDS_SETTINGS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to employee timecard settings information. For example, to\ncall the UpdateBreakType endpoint.", + "TIMECARDS_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to employee shift information. For example, to create\nand modify employee shifts.", + "VENDOR_READ": "__HTTP Method__: `GET`, `POST`\n\nGrants read access to vendor information, for example, when calling the\n`RetrieveVendor` endpoint.", + "VENDOR_WRITE": "__HTTP Method__: `POST`, `PUT`, `DELETE`\n\nGrants write access to vendor information, for example, when calling the\n`BulkUpdateVendors` endpoint." + } + } + } + }, + "oauth2ClientSecret": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "schemas": { + "ACHDetails": { + "type": "object", + "description": "ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`.", + "x-release-status": "PUBLIC", + "properties": { + "routing_number": { + "type": "string", + "description": "The routing number for the bank account.", + "maxLength": 50, + "nullable": true + }, + "account_number_suffix": { + "type": "string", + "description": "The last few digits of the bank account number.", + "minLength": 1, + "maxLength": 4, + "nullable": true + }, + "account_type": { + "type": "string", + "description": "The type of the bank account performing the transfer. The account type can be `CHECKING`,\n`SAVINGS`, or `UNKNOWN`.", + "maxLength": 50, + "nullable": true + } + } + }, + "AcceptDisputeRequest": { + "type": "object", + "description": "Defines the request parameters for the `AcceptDispute` endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "AcceptDisputeResponse": { + "type": "object", + "description": "Defines the fields in an `AcceptDispute` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "dispute": { + "$ref": "#/components/schemas/Dispute", + "description": "Details about the accepted dispute." + } + }, + "example": { + "dispute": { + "amount_money": { + "amount": 2500, + "currency": "USD" + }, + "brand_dispute_id": "100000809947", + "card_brand": "VISA", + "created_at": "2022-06-29T18:45:22.265Z", + "disputed_payment": { + "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY" + }, + "due_at": "2022-07-13T00:00:00.000Z", + "id": "XDgyFu7yo1E2S5lQGGpYn", + "location_id": "L1HN3ZMQK64X9", + "reason": "NO_KNOWLEDGE", + "reported_at": "2022-06-29T00:00:00.000Z", + "state": "ACCEPTED", + "updated_at": "2022-07-07T19:14:42.650Z", + "version": 2 + } + } + }, + "AcceptedPaymentMethods": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "apple_pay": { + "type": "boolean", + "description": "Whether Apple Pay is accepted at checkout.", + "nullable": true + }, + "google_pay": { + "type": "boolean", + "description": "Whether Google Pay is accepted at checkout.", + "nullable": true + }, + "cash_app_pay": { + "type": "boolean", + "description": "Whether Cash App Pay is accepted at checkout.", + "nullable": true + }, + "afterpay_clearpay": { + "type": "boolean", + "description": "Whether Afterpay/Clearpay is accepted at checkout.", + "nullable": true + } + } + }, + "AccumulateLoyaltyPointsRequest": { + "type": "object", + "description": "Represents an [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?account_id=5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "required": [ + "accumulate_points", + "idempotency_key", + "location_id" + ], + "properties": { + "accumulate_points": { + "$ref": "#/components/schemas/LoyaltyEventAccumulatePoints", + "description": "The points to add to the account. \nIf you are using the Orders API to manage orders, specify the order ID.\nOtherwise, specify the points to add." + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the `AccumulateLoyaltyPoints` request. \nKeys can be any valid string but must be unique for every request.", + "minLength": 1, + "maxLength": 128 + }, + "location_id": { + "type": "string", + "description": "The [location](entity:Location) where the purchase was made." + } + }, + "example": { + "accumulate_points": { + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY" + }, + "idempotency_key": "58b90739-c3e8-4b11-85f7-e636d48d72cb", + "location_id": "P034NEENMD09F" + } + }, + "AccumulateLoyaltyPointsResponse": { + "type": "object", + "description": "Represents an [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "event": { + "$ref": "#/components/schemas/LoyaltyEvent", + "description": "The resulting loyalty event. Starting in Square version 2022-08-17, this field is no longer returned.", + "x-release-status": "DEPRECATED" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyEvent" + }, + "description": "The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event\nis always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included\nif the purchase also qualifies for a loyalty promotion." + } + }, + "example": { + "events": [ + { + "accumulate_points": { + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + "points": 6 + }, + "created_at": "2020-05-08T21:41:12Z", + "id": "ee46aafd-1af6-3695-a385-276e2ef0be26", + "location_id": "P034NEENMD09F", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "source": "LOYALTY_API", + "type": "ACCUMULATE_POINTS" + } + ] + } + }, + "ActionCancelReason": { + "type": "string", + "enum": [ + "BUYER_CANCELED", + "SELLER_CANCELED", + "TIMED_OUT" + ], + "x-enum-elements": [ + { + "name": "BUYER_CANCELED", + "description": "A person canceled the `TerminalCheckout` from a Square device." + }, + { + "name": "SELLER_CANCELED", + "description": "A client canceled the `TerminalCheckout` using the API." + }, + { + "name": "TIMED_OUT", + "description": "The `TerminalCheckout` timed out (see `deadline_duration` on the `TerminalCheckout`)." + } + ], + "x-release-status": "PUBLIC" + }, + "ActivityType": { + "type": "string", + "enum": [ + "ADJUSTMENT", + "APP_FEE_REFUND", + "APP_FEE_REVENUE", + "AUTOMATIC_SAVINGS", + "AUTOMATIC_SAVINGS_REVERSED", + "CHARGE", + "DEPOSIT_FEE", + "DEPOSIT_FEE_REVERSED", + "DISPUTE", + "ESCHEATMENT", + "FEE", + "FREE_PROCESSING", + "HOLD_ADJUSTMENT", + "INITIAL_BALANCE_CHANGE", + "MONEY_TRANSFER", + "MONEY_TRANSFER_REVERSAL", + "OPEN_DISPUTE", + "OTHER", + "OTHER_ADJUSTMENT", + "PAID_SERVICE_FEE", + "PAID_SERVICE_FEE_REFUND", + "REDEMPTION_CODE", + "REFUND", + "RELEASE_ADJUSTMENT", + "RESERVE_HOLD", + "RESERVE_RELEASE", + "RETURNED_PAYOUT", + "SQUARE_CAPITAL_PAYMENT", + "SQUARE_CAPITAL_REVERSED_PAYMENT", + "SUBSCRIPTION_FEE", + "SUBSCRIPTION_FEE_PAID_REFUND", + "SUBSCRIPTION_FEE_REFUND", + "TAX_ON_FEE", + "THIRD_PARTY_FEE", + "THIRD_PARTY_FEE_REFUND", + "PAYOUT", + "AUTOMATIC_BITCOIN_CONVERSIONS", + "AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED", + "CREDIT_CARD_REPAYMENT", + "CREDIT_CARD_REPAYMENT_REVERSED", + "LOCAL_OFFERS_CASHBACK", + "LOCAL_OFFERS_FEE", + "PERCENTAGE_PROCESSING_ENROLLMENT", + "PERCENTAGE_PROCESSING_DEACTIVATION", + "PERCENTAGE_PROCESSING_REPAYMENT", + "PERCENTAGE_PROCESSING_REPAYMENT_REVERSED", + "PROCESSING_FEE", + "PROCESSING_FEE_REFUND", + "UNDO_PROCESSING_FEE_REFUND", + "GIFT_CARD_LOAD_FEE", + "GIFT_CARD_LOAD_FEE_REFUND", + "UNDO_GIFT_CARD_LOAD_FEE_REFUND", + "BALANCE_FOLDERS_TRANSFER", + "BALANCE_FOLDERS_TRANSFER_REVERSED", + "GIFT_CARD_POOL_TRANSFER", + "GIFT_CARD_POOL_TRANSFER_REVERSED", + "SQUARE_PAYROLL_TRANSFER", + "SQUARE_PAYROLL_TRANSFER_REVERSED" + ], + "x-enum-elements": [ + { + "name": "ADJUSTMENT", + "description": "A manual adjustment applied to the seller's account by Square." + }, + { + "name": "APP_FEE_REFUND", + "description": "A refund for an application fee on a payment." + }, + { + "name": "APP_FEE_REVENUE", + "description": "Revenue generated from an application fee on a payment." + }, + { + "name": "AUTOMATIC_SAVINGS", + "description": "An automatic transfer from the payment processing balance to the Square Savings account. These are generally proportional to the seller's sales." + }, + { + "name": "AUTOMATIC_SAVINGS_REVERSED", + "description": "An automatic transfer from the Square Savings account back to the processing balance. These are generally proportional to the seller's refunds." + }, + { + "name": "CHARGE", + "description": "A credit card payment capture." + }, + { + "name": "DEPOSIT_FEE", + "description": "A fee assessed because of a deposit, such as an instant deposit." + }, + { + "name": "DEPOSIT_FEE_REVERSED", + "description": "Indicates that Square returned a fee that was previously assessed because of a deposit, such as an instant deposit, back to the seller's account." + }, + { + "name": "DISPUTE", + "description": "The balance change due to a dispute event." + }, + { + "name": "ESCHEATMENT", + "description": "An escheatment entry for remittance." + }, + { + "name": "FEE", + "description": "The cost plus adjustment fee." + }, + { + "name": "FREE_PROCESSING", + "description": "Square offers free payments processing for a variety of business scenarios, including seller\nreferrals or when Square wants to apologize (for example, for a bug, customer service, or repricing complication).\nThis entry represents a credit to the seller for the purposes of free processing." + }, + { + "name": "HOLD_ADJUSTMENT", + "description": "An adjustment made by Square related to holding a payment." + }, + { + "name": "INITIAL_BALANCE_CHANGE", + "description": "An external change to a seller's balance (initial, in the sense that it causes the creation of the other activity types, such as a hold and refund)." + }, + { + "name": "MONEY_TRANSFER", + "description": "The balance change from a money transfer." + }, + { + "name": "MONEY_TRANSFER_REVERSAL", + "description": "The reversal of a money transfer." + }, + { + "name": "OPEN_DISPUTE", + "description": "The balance change for a chargeback that's been filed." + }, + { + "name": "OTHER", + "description": "Any other type that doesn't belong in the rest of the types." + }, + { + "name": "OTHER_ADJUSTMENT", + "description": "Any other type of adjustment that doesn't fall under existing types." + }, + { + "name": "PAID_SERVICE_FEE", + "description": "A fee paid to a third-party seller." + }, + { + "name": "PAID_SERVICE_FEE_REFUND", + "description": "A fee refunded to a third-party seller." + }, + { + "name": "REDEMPTION_CODE", + "description": "Repayment for a redemption code." + }, + { + "name": "REFUND", + "description": "A refund for an existing card payment." + }, + { + "name": "RELEASE_ADJUSTMENT", + "description": "An adjustment made by Square related to releasing a payment." + }, + { + "name": "RESERVE_HOLD", + "description": "Fees paid for a funding risk reserve." + }, + { + "name": "RESERVE_RELEASE", + "description": "Fees released from a risk reserve." + }, + { + "name": "RETURNED_PAYOUT", + "description": "An entry created when Square receives a response for the ACH file that Square sent indicating that the\nsettlement of the original entry failed." + }, + { + "name": "SQUARE_CAPITAL_PAYMENT", + "description": "A capital merchant cash advance (MCA) assessment. These are generally proportional to the merchant's sales but can be issued for other reasons related to the MCA." + }, + { + "name": "SQUARE_CAPITAL_REVERSED_PAYMENT", + "description": "A capital merchant cash advance (MCA) assessment refund. These are generally proportional to the merchant's refunds but can be issued for other reasons related to the MCA." + }, + { + "name": "SUBSCRIPTION_FEE", + "description": "A fee charged for subscription to a Square product." + }, + { + "name": "SUBSCRIPTION_FEE_PAID_REFUND", + "description": "A Square subscription fee that's been refunded." + }, + { + "name": "SUBSCRIPTION_FEE_REFUND", + "description": "The refund of a previously charged Square product subscription fee." + }, + { + "name": "TAX_ON_FEE", + "description": "The tax paid on fee amounts." + }, + { + "name": "THIRD_PARTY_FEE", + "description": "Fees collected by a third-party platform." + }, + { + "name": "THIRD_PARTY_FEE_REFUND", + "description": "Refunded fees from a third-party platform." + }, + { + "name": "PAYOUT", + "description": "The balance change due to a money transfer. Note that this type is never returned by the Payouts API." + }, + { + "name": "AUTOMATIC_BITCOIN_CONVERSIONS", + "description": "Indicates that the portion of each payment withheld by Square was automatically converted into bitcoin using Cash App. The seller manages their bitcoin in their Cash App account." + }, + { + "name": "AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED", + "description": "Indicates that a withheld payment, which was scheduled to be converted into bitcoin using Cash App, was deposited back to the Square payments balance." + }, + { + "name": "CREDIT_CARD_REPAYMENT", + "description": "Indicates that a repayment toward the outstanding balance on the seller's Square credit card was made." + }, + { + "name": "CREDIT_CARD_REPAYMENT_REVERSED", + "description": "Indicates that a repayment toward the outstanding balance on the seller's Square credit card was reversed." + }, + { + "name": "LOCAL_OFFERS_CASHBACK", + "description": "Cashback amount given by a Square Local Offers seller to their customer for a purchase." + }, + { + "name": "LOCAL_OFFERS_FEE", + "description": "A commission fee paid by a Square Local Offers seller to Square for a purchase discovered through Square Local Offers." + }, + { + "name": "PERCENTAGE_PROCESSING_ENROLLMENT", + "description": "When activating Percentage Processing, a credit is applied to the seller’s account to offset any negative balance caused by a dispute." + }, + { + "name": "PERCENTAGE_PROCESSING_DEACTIVATION", + "description": "Deducting the outstanding Percentage Processing balance from the seller’s account. It's the final installment in repaying the dispute-induced negative balance through percentage processing." + }, + { + "name": "PERCENTAGE_PROCESSING_REPAYMENT", + "description": "Withheld funds from a payment to cover a negative balance. It's an installment to repay the amount from a dispute that had been offset during Percentage Processing enrollment." + }, + { + "name": "PERCENTAGE_PROCESSING_REPAYMENT_REVERSED", + "description": "The reversal of a percentage processing repayment that happens for example when a refund is issued for a payment." + }, + { + "name": "PROCESSING_FEE", + "description": "The processing fee for a payment. If sellers opt for Gross Settlement, i.e., direct bank withdrawal instead of deducting fees from daily sales, the processing fee is recorded separately as a new payout entry, not part of the CHARGE payout entry." + }, + { + "name": "PROCESSING_FEE_REFUND", + "description": "The processing fee for a payment refund issued by sellers enrolled in Gross Settlement. The refunded processing fee is recorded separately as a new payout entry, not part of the REFUND payout entry." + }, + { + "name": "UNDO_PROCESSING_FEE_REFUND", + "description": "When undoing a processing fee refund in a Gross Settlement payment, this payout entry type is used." + }, + { + "name": "GIFT_CARD_LOAD_FEE", + "description": "Fee collected during the sale or reload of a gift card. This fee, which is a portion of the amount loaded on the gift card, is deducted from the merchant's payment balance." + }, + { + "name": "GIFT_CARD_LOAD_FEE_REFUND", + "description": "Refund for fee charged during the sale or reload of a gift card." + }, + { + "name": "UNDO_GIFT_CARD_LOAD_FEE_REFUND", + "description": "The undo of a refund for a fee charged during the sale or reload of a gift card." + }, + { + "name": "BALANCE_FOLDERS_TRANSFER", + "description": "A transfer of funds to a banking folder. In the United States, the folder name is 'Checking Folder'; in Canada, it's 'Balance Folder.'" + }, + { + "name": "BALANCE_FOLDERS_TRANSFER_REVERSED", + "description": "A reversal of transfer of funds from a banking folder. In the United States, the folder name is 'Checking Folder'; in Canada, it's 'Balance Folder.'" + }, + { + "name": "GIFT_CARD_POOL_TRANSFER", + "description": "A transfer of gift card funds to a central gift card pool account. In franchises, when gift cards are loaded or reloaded at any location, the money transfers to the franchisor's account." + }, + { + "name": "GIFT_CARD_POOL_TRANSFER_REVERSED", + "description": "A reversal of transfer of gift card funds from a central gift card pool account. In franchises, when gift cards are loaded or reloaded at any location, the money transfers to the franchisor's account." + }, + { + "name": "SQUARE_PAYROLL_TRANSFER", + "description": "A payroll payment that was transferred to a team member’s bank account." + }, + { + "name": "SQUARE_PAYROLL_TRANSFER_REVERSED", + "description": "A payroll payment to a team member’s bank account that was deposited back to the seller’s account by Square." + } + ], + "x-release-status": "PUBLIC" + }, + "AddGroupToCustomerRequest": { + "type": "object", + "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "AddGroupToCustomerResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "AdditionalRecipient": { + "type": "object", + "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", + "x-release-status": "DEPRECATED", + "required": [ + "location_id", + "amount_money" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the additional recipient.", + "maxLength": 100, + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money distributed to the recipient." + }, + "receivable_id": { + "type": "string", + "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", + "maxLength": 192, + "nullable": true + } + } + }, + "Address": { + "type": "object", + "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", + "x-release-status": "PUBLIC", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", + "nullable": true + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, if any.", + "nullable": true + }, + "address_line_3": { + "type": "string", + "description": "The third line of the address, if any.", + "nullable": true + }, + "locality": { + "type": "string", + "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", + "nullable": true + }, + "sublocality": { + "type": "string", + "description": "A civil region within the address's `locality`, if any.", + "nullable": true + }, + "sublocality_2": { + "type": "string", + "description": "A civil region within the address's `sublocality`, if any.", + "nullable": true + }, + "sublocality_3": { + "type": "string", + "description": "A civil region within the address's `sublocality_2`, if any.", + "nullable": true + }, + "administrative_district_level_1": { + "type": "string", + "description": "A civil entity within the address's country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", + "nullable": true + }, + "administrative_district_level_2": { + "type": "string", + "description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county.", + "nullable": true + }, + "administrative_district_level_3": { + "type": "string", + "description": "A civil entity within the address's `administrative_district_level_2`,\nif any.", + "nullable": true + }, + "postal_code": { + "type": "string", + "description": "The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", + "nullable": true + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`.\nSee [Country](#type-country) for possible values", + "nullable": true + }, + "first_name": { + "type": "string", + "description": "Optional first name when it's representing recipient.", + "nullable": true + }, + "last_name": { + "type": "string", + "description": "Optional last name when it's representing recipient.", + "nullable": true + } + } + }, + "AdjustLoyaltyPointsRequest": { + "type": "object", + "description": "Represents an [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?account_id=5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "required": [ + "idempotency_key", + "adjust_points" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `AdjustLoyaltyPoints` request. \nKeys can be any valid string, but must be unique for every request.", + "minLength": 1, + "maxLength": 128 + }, + "adjust_points": { + "$ref": "#/components/schemas/LoyaltyEventAdjustPoints", + "description": "The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer.\nTo subtract points, specify a negative integer." + }, + "allow_negative_balance": { + "type": "boolean", + "description": "Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative\nbalance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting\nthe specified number of points would result in a negative balance. The default value is `false`.", + "nullable": true + } + }, + "example": { + "adjust_points": { + "points": 10, + "reason": "Complimentary points" + }, + "idempotency_key": "bc29a517-3dc9-450e-aa76-fae39ee849d1" + } + }, + "AdjustLoyaltyPointsResponse": { + "type": "object", + "description": "Represents an [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints) request.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "event": { + "$ref": "#/components/schemas/LoyaltyEvent", + "description": "The resulting event data for the adjustment." + } + }, + "example": { + "event": { + "adjust_points": { + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "points": 10, + "reason": "Complimentary points" + }, + "created_at": "2020-05-08T21:42:32Z", + "id": "613a6fca-8d67-39d0-bad2-3b4bc45c8637", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "source": "LOYALTY_API", + "type": "ADJUST_POINTS" + } + } + }, + "AfterpayDetails": { + "type": "object", + "description": "Additional details about Afterpay payments.", + "x-release-status": "PUBLIC", + "properties": { + "email_address": { + "type": "string", + "description": "Email address on the buyer's Afterpay account.", + "maxLength": 255, + "nullable": true + } + } + }, + "ApplicationDetails": { + "type": "object", + "description": "Details about the application that took the payment.", + "x-release-status": "PUBLIC", + "properties": { + "square_product": { + "$ref": "#/components/schemas/ApplicationDetailsExternalSquareProduct", + "description": "The Square product, such as Square Point of Sale (POS), \nSquare Invoices, or Square Virtual Terminal.\nSee [ExternalSquareProduct](#type-externalsquareproduct) for possible values", + "nullable": true + }, + "application_id": { + "type": "string", + "description": "The Square ID assigned to the application used to take the payment. \nApplication developers can use this information to identify payments that \ntheir application processed. \nFor example, if a developer uses a custom application to process payments, \nthis field contains the application ID from the Developer Dashboard. \nIf a seller uses a [Square App Marketplace](https://developer.squareup.com/docs/app-marketplace) \napplication to process payments, the field contains the corresponding application ID.", + "nullable": true + } + } + }, + "ApplicationDetailsExternalSquareProduct": { + "type": "string", + "enum": [ + "APPOINTMENTS", + "ECOMMERCE_API", + "INVOICES", + "ONLINE_STORE", + "OTHER", + "RESTAURANTS", + "RETAIL", + "SQUARE_POS", + "TERMINAL_API", + "VIRTUAL_TERMINAL" + ], + "x-enum-elements": [ + { + "name": "APPOINTMENTS", + "description": "" + }, + { + "name": "ECOMMERCE_API", + "description": "" + }, + { + "name": "INVOICES", + "description": "" + }, + { + "name": "ONLINE_STORE", + "description": "" + }, + { + "name": "OTHER", + "description": "" + }, + { + "name": "RESTAURANTS", + "description": "" + }, + { + "name": "RETAIL", + "description": "" + }, + { + "name": "SQUARE_POS", + "description": "" + }, + { + "name": "TERMINAL_API", + "description": "" + }, + { + "name": "VIRTUAL_TERMINAL", + "description": "" + } + ], + "description": "A list of products to return to external callers.", + "x-release-status": "PUBLIC" + }, + "ApplicationType": { + "type": "string", + "enum": [ + "TERMINAL_API" + ], + "x-enum-elements": [ + { + "name": "TERMINAL_API", + "description": "" + } + ], + "x-release-status": "BETA" + }, + "AppointmentSegment": { + "type": "object", + "description": "Defines an appointment segment of a booking.", + "x-release-status": "PUBLIC", + "required": [ + "team_member_id" + ], + "properties": { + "duration_minutes": { + "type": "integer", + "description": "The time span in minutes of an appointment segment.", + "maximum": 1500, + "nullable": true + }, + "service_variation_id": { + "type": "string", + "description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.", + "maxLength": 36, + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment.", + "minLength": 1, + "maxLength": 32 + }, + "service_variation_version": { + "type": "integer", + "description": "The current version of the item variation representing the service booked in this segment.", + "format": "int64", + "nullable": true + }, + "intermission_minutes": { + "type": "integer", + "description": "Time between the end of this segment and the beginning of the subsequent segment.", + "readOnly": true + }, + "any_team_member": { + "type": "boolean", + "description": "Whether the customer accepts any team member, instead of a specific one, to serve this segment.", + "readOnly": true + }, + "resource_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the seller-accessible resources used for this appointment segment.", + "readOnly": true + } + } + }, + "ArchivedState": { + "type": "string", + "enum": [ + "ARCHIVED_STATE_NOT_ARCHIVED", + "ARCHIVED_STATE_ARCHIVED", + "ARCHIVED_STATE_ALL" + ], + "x-enum-elements": [ + { + "name": "ARCHIVED_STATE_NOT_ARCHIVED", + "description": "Requested items are not archived with the `is_archived` attribute set to `false`." + }, + { + "name": "ARCHIVED_STATE_ARCHIVED", + "description": "Requested items are archived with the `is_archived` attribute set to `true`." + }, + { + "name": "ARCHIVED_STATE_ALL", + "description": "Requested items can be archived or not archived." + } + ], + "description": "Defines the values for the `archived_state` query expression \nused in [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) \nto return the archived, not archived or either type of catalog items.", + "x-release-status": "PUBLIC" + }, + "Availability": { + "type": "object", + "description": "Defines an appointment slot that encapsulates the appointment segments, location and starting time available for booking.", + "x-release-status": "PUBLIC", + "properties": { + "start_at": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the beginning time of the slot available for booking.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location available for booking.", + "maxLength": 32, + "readOnly": true + }, + "appointment_segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppointmentSegment" + }, + "description": "The list of appointment segments available for booking", + "nullable": true + } + } + }, + "BankAccount": { + "type": "object", + "description": "Represents a bank account. For more information about \nlinking a bank account to a Square account, see \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).", + "x-release-status": "PUBLIC", + "required": [ + "id", + "account_number_suffix", + "country", + "currency", + "account_type", + "holder_name", + "primary_bank_identification_number", + "status", + "creditable", + "debitable" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique, Square-issued identifier for the bank account.", + "minLength": 1, + "maxLength": 30 + }, + "account_number_suffix": { + "type": "string", + "description": "The last few digits of the account number.", + "minLength": 1 + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "The ISO 3166 Alpha-2 country code where the bank account is based.\nSee [Country](#type-country) for possible values" + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "The 3-character ISO 4217 currency code indicating the operating\ncurrency of the bank account. For example, the currency code for US dollars\nis `USD`.\nSee [Currency](#type-currency) for possible values" + }, + "account_type": { + "$ref": "#/components/schemas/BankAccountType", + "description": "The financial purpose of the associated bank account.\nSee [BankAccountType](#type-bankaccounttype) for possible values" + }, + "holder_name": { + "type": "string", + "description": "Name of the account holder. This name must match the name \non the targeted bank account record.", + "minLength": 1 + }, + "primary_bank_identification_number": { + "type": "string", + "description": "Primary identifier for the bank. For more information, see \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).", + "maxLength": 40 + }, + "secondary_bank_identification_number": { + "type": "string", + "description": "Secondary identifier for the bank. For more information, see \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).", + "maxLength": 40, + "nullable": true + }, + "debit_mandate_reference_id": { + "type": "string", + "description": "Reference identifier that will be displayed to UK bank account owners\nwhen collecting direct debit authorization. Only required for UK bank accounts.", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "Client-provided identifier for linking the banking account to an entity\nin a third-party system (for example, a bank account number or a user identifier).", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The location to which the bank account belongs.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/BankAccountStatus", + "description": "Read-only. The current verification status of this BankAccount object.\nSee [BankAccountStatus](#type-bankaccountstatus) for possible values" + }, + "creditable": { + "type": "boolean", + "description": "Indicates whether it is possible for Square to send money to this bank account." + }, + "debitable": { + "type": "boolean", + "description": "Indicates whether it is possible for Square to take money from this \nbank account." + }, + "fingerprint": { + "type": "string", + "description": "A Square-assigned, unique identifier for the bank account based on the\naccount information. The account fingerprint can be used to compare account\nentries and determine if the they represent the same real-world bank account.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the `BankAccount`." + }, + "bank_name": { + "type": "string", + "description": "Read only. Name of actual financial institution. \nFor example \"Bank of America\".", + "maxLength": 100, + "nullable": true + } + } + }, + "BankAccountPaymentDetails": { + "type": "object", + "description": "Additional details about BANK_ACCOUNT type payments.", + "x-release-status": "PUBLIC", + "properties": { + "bank_name": { + "type": "string", + "description": "The name of the bank associated with the bank account.", + "maxLength": 100, + "nullable": true + }, + "transfer_type": { + "type": "string", + "description": "The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.", + "maxLength": 50, + "nullable": true + }, + "account_ownership_type": { + "type": "string", + "description": "The ownership type of the bank account performing the transfer.\nThe type can be `INDIVIDUAL`, `COMPANY`, or `ACCOUNT_TYPE_UNKNOWN`.", + "maxLength": 50, + "nullable": true + }, + "fingerprint": { + "type": "string", + "description": "Uniquely identifies the bank account for this seller and can be used\nto determine if payments are from the same bank account.", + "maxLength": 255, + "nullable": true + }, + "country": { + "type": "string", + "description": "The two-letter ISO code representing the country the bank account is located in.", + "minLength": 2, + "maxLength": 2, + "nullable": true + }, + "statement_description": { + "type": "string", + "description": "The statement description as sent to the bank.", + "maxLength": 1000, + "nullable": true + }, + "ach_details": { + "$ref": "#/components/schemas/ACHDetails", + "description": "ACH-specific information about the transfer. The information is only populated\nif the `transfer_type` is `ACH`.", + "nullable": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request.", + "nullable": true + } + } + }, + "BankAccountStatus": { + "type": "string", + "enum": [ + "VERIFICATION_IN_PROGRESS", + "VERIFIED", + "DISABLED" + ], + "x-enum-elements": [ + { + "name": "VERIFICATION_IN_PROGRESS", + "description": "Indicates that the verification process has started. Some features\n(for example, creditable or debitable) may be provisionally enabled on the bank\naccount." + }, + { + "name": "VERIFIED", + "description": "Indicates that the bank account was successfully verified." + }, + { + "name": "DISABLED", + "description": "Indicates that the bank account is disabled and is permanently unusable\nfor funds transfer. A bank account can be disabled because of a failed verification\nattempt or a failed deposit attempt." + } + ], + "description": "Indicates the current verification status of a `BankAccount` object.", + "x-release-status": "PUBLIC" + }, + "BankAccountType": { + "type": "string", + "enum": [ + "CHECKING", + "SAVINGS", + "INVESTMENT", + "OTHER", + "BUSINESS_CHECKING" + ], + "x-enum-elements": [ + { + "name": "CHECKING", + "description": "An account at a financial institution against which checks can be\ndrawn by the account depositor." + }, + { + "name": "SAVINGS", + "description": "An account at a financial institution that pays interest but cannot be\nused directly as money in the narrow sense of a medium of exchange." + }, + { + "name": "INVESTMENT", + "description": "An account at a financial institution that contains a deposit of funds\nand/or securities." + }, + { + "name": "OTHER", + "description": "An account at a financial institution which cannot be described by the\nother types." + }, + { + "name": "BUSINESS_CHECKING", + "description": "An account at a financial institution against which checks can be\ndrawn specifically for business purposes (non-personal use)." + } + ], + "description": "Indicates the financial purpose of the bank account.", + "x-release-status": "PUBLIC" + }, + "BatchChangeInventoryRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A client-supplied, universally unique identifier (UUID) for the\nrequest.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", + "minLength": 1, + "maxLength": 128 + }, + "changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryChange" + }, + "description": "The set of physical counts and inventory adjustments to be made.\nChanges are applied based on the client-supplied timestamp and may be sent\nout of order.", + "nullable": true + }, + "ignore_unchanged_counts": { + "type": "boolean", + "description": "Indicates whether the current physical count should be ignored if\nthe quantity is unchanged since the last physical count. Default: `true`.", + "nullable": true + } + }, + "example": { + "changes": [ + { + "physical_count": { + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "location_id": "C6W5YS5QM06F5", + "occurred_at": "2016-11-16T22:25:24.878Z", + "quantity": "53", + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "state": "IN_STOCK", + "team_member_id": "LRK57NSQ5X7PUD05" + }, + "type": "PHYSICAL_COUNT" + } + ], + "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + "ignore_unchanged_counts": true + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.csharp", + "java": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.java", + "javascript": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.javascript", + "php": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.php", + "python": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.python", + "ruby": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.ruby" + } + }, + "BatchChangeInventoryResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "counts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryCount" + }, + "description": "The current counts for all objects referenced in the request." + }, + "changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryChange" + }, + "description": "Changes created for the request.", + "x-release-status": "BETA" + } + }, + "example": { + "counts": [ + { + "calculated_at": "2016-11-16T22:28:01.223Z", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "state": "IN_STOCK" + } + ], + "errors": [] + } + }, + "BatchDeleteCatalogObjectsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "object_ids" + ], + "properties": { + "object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects\nin the graph that depend on that object will be deleted as well (for example, deleting a\nCatalogItem will delete its CatalogItemVariation." + } + }, + "example": { + "object_ids": [ + "W62UWFY35CWMYGVWK6TWJDNI", + "AA27W3M2GGTF3H6AVPNB77CK" + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.csharp", + "java": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.java", + "javascript": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.javascript", + "php": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.php", + "python": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.python", + "ruby": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.ruby" + } + }, + "BatchDeleteCatalogObjectsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "deleted_object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of all CatalogObjects deleted by this request." + }, + "deleted_at": { + "type": "string", + "description": "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\"." + } + }, + "example": { + "deleted_at": "2016-11-16T22:25:24.878Z", + "deleted_object_ids": [ + "W62UWFY35CWMYGVWK6TWJDNI", + "AA27W3M2GGTF3H6AVPNB77CK" + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.csharp", + "java": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.java", + "javascript": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.javascript", + "php": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.php", + "python": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.python", + "ruby": "/sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.ruby" + } + }, + "BatchRetrieveCatalogObjectsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "object_ids" + ], + "properties": { + "object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the CatalogObjects to be retrieved." + }, + "include_related_objects": { + "type": "boolean", + "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field\nof the response. These objects are put in the `related_objects` field. Setting this to `true` is\nhelpful when the objects are needed for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included. For example,\n\nif the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`", + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will\nbe from the current version of the catalog.", + "format": "int64", + "x-release-status": "BETA", + "nullable": true + }, + "include_deleted_objects": { + "type": "boolean", + "description": "Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`.", + "nullable": true + }, + "include_category_path_to_root": { + "type": "boolean", + "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists\nof `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category\nand ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned\nin the response payload.", + "nullable": true + } + }, + "example": { + "include_related_objects": true, + "object_ids": [ + "W62UWFY35CWMYGVWK6TWJDNI", + "AA27W3M2GGTF3H6AVPNB77CK" + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.csharp", + "java": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.java", + "javascript": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.javascript", + "php": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.php", + "python": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.python", + "ruby": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.ruby" + } + }, + "BatchRetrieveCatalogObjectsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of [CatalogObject](entity:CatalogObject)s returned." + }, + "related_objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of [CatalogObject](entity:CatalogObject)s referenced by the object in the `objects` field." + } + }, + "example": { + "objects": [ + { + "id": "W62UWFY35CWMYGVWK6TWJDNI", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "BJNQCF2FJ6S6UIDT65ABHLRX", + "ordinal": 0 + } + ], + "description": "Hot Leaf Juice", + "name": "Tea", + "tax_ids": [ + "HURXQOOAIC4IZSI2BEXQRYFY" + ], + "variations": [ + { + "id": "2TZFAOHWGG7PAK2QEXWYPZSP", + "is_deleted": false, + "item_variation_data": { + "item_id": "W62UWFY35CWMYGVWK6TWJDNI", + "name": "Mug", + "ordinal": 0, + "price_money": { + "amount": 150, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + }, + { + "id": "AA27W3M2GGTF3H6AVPNB77CK", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "BJNQCF2FJ6S6UIDT65ABHLRX", + "ordinal": 0 + } + ], + "description": "Hot Bean Juice", + "name": "Coffee", + "tax_ids": [ + "HURXQOOAIC4IZSI2BEXQRYFY" + ], + "variations": [ + { + "id": "LBTYIHNHU52WOIHWT7SNRIYH", + "is_deleted": false, + "item_variation_data": { + "item_id": "AA27W3M2GGTF3H6AVPNB77CK", + "name": "Regular", + "ordinal": 0, + "price_money": { + "amount": 250, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + }, + { + "id": "PKYIC7HGGKW5CYVSCVDEIMHY", + "is_deleted": false, + "item_variation_data": { + "item_id": "AA27W3M2GGTF3H6AVPNB77CK", + "name": "Large", + "ordinal": 1, + "price_money": { + "amount": 350, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + } + ], + "related_objects": [ + { + "category_data": { + "name": "Beverages" + }, + "id": "BJNQCF2FJ6S6UIDT65ABHLRX", + "is_deleted": false, + "present_at_all_locations": true, + "type": "CATEGORY", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + }, + { + "id": "HURXQOOAIC4IZSI2BEXQRYFY", + "is_deleted": false, + "present_at_all_locations": true, + "tax_data": { + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "enabled": true, + "inclusion_type": "ADDITIVE", + "name": "Sales Tax", + "percentage": "5.0" + }, + "type": "TAX", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.csharp", + "java": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.java", + "javascript": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.javascript", + "php": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.php", + "python": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.python", + "ruby": "/sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.ruby" + } + }, + "BatchRetrieveInventoryChangesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "catalog_object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The filter to return results by `CatalogObject` ID.\nThe filter is only applicable when set. The default value is null.", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The filter to return results by `Location` ID.\nThe filter is only applicable when set. The default value is null.", + "nullable": true + }, + "types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryChangeType" + }, + "description": "The filter to return results by `InventoryChangeType` values other than `TRANSFER`.\nThe default value is `[PHYSICAL_COUNT, ADJUSTMENT]`.", + "nullable": true + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryState" + }, + "description": "The filter to return `ADJUSTMENT` query results by\n`InventoryState`. This filter is only applied when set.\nThe default value is null.", + "nullable": true + }, + "updated_after": { + "type": "string", + "description": "The filter to return results with their `calculated_at` value\nafter the given time as specified in an RFC 3339 timestamp.\nThe default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).", + "nullable": true + }, + "updated_before": { + "type": "string", + "description": "The filter to return results with their `created_at` or `calculated_at` value\nstrictly before the given time as specified in an RFC 3339 timestamp.\nThe default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The number of [records](entity:InventoryChange) to return.", + "minimum": 1, + "maximum": 1000, + "nullable": true + } + }, + "example": { + "catalog_object_ids": [ + "W62UWFY35CWMYGVWK6TWJDNI" + ], + "location_ids": [ + "C6W5YS5QM06F5" + ], + "states": [ + "IN_STOCK" + ], + "types": [ + "PHYSICAL_COUNT" + ], + "updated_after": "2016-11-01T00:00:00.000Z", + "updated_before": "2016-12-01T00:00:00.000Z" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.csharp", + "java": "/sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.java", + "javascript": "/sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.javascript", + "php": "/sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.php", + "python": "/sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.python", + "ruby": "/sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.ruby" + } + }, + "BatchRetrieveInventoryChangesResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryChange" + }, + "description": "The current calculated inventory changes for the requested objects\nand locations." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." + } + }, + "example": { + "changes": [ + { + "physical_count": { + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "created_at": "2016-11-16T22:25:24.878Z", + "id": "46YDTW253DWGGK9HMAE6XCAO", + "location_id": "C6W5YS5QM06F5", + "occurred_at": "2016-11-16T22:24:49.028Z", + "quantity": "86", + "reference_id": "22c07cf4-5626-4224-89f9-691112019399", + "source": { + "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0", + "name": "Square Point of Sale 4.37", + "product": "SQUARE_POS" + }, + "state": "IN_STOCK", + "team_member_id": "LRK57NSQ5X7PUD05" + }, + "type": "PHYSICAL_COUNT" + } + ], + "errors": [] + } + }, + "BatchRetrieveInventoryCountsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "catalog_object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The filter to return results by `CatalogObject` ID.\nThe filter is applicable only when set. The default is null.", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The filter to return results by `Location` ID.\nThis filter is applicable only when set. The default is null.", + "nullable": true + }, + "updated_after": { + "type": "string", + "description": "The filter to return results with their `calculated_at` value\nafter the given time as specified in an RFC 3339 timestamp.\nThe default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "nullable": true + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryState" + }, + "description": "The filter to return results by `InventoryState`. The filter is only applicable when set.\nIgnored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`.\nThe default is null.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The number of [records](entity:InventoryCount) to return.", + "minimum": 1, + "maximum": 1000, + "nullable": true + } + }, + "example": { + "catalog_object_ids": [ + "W62UWFY35CWMYGVWK6TWJDNI" + ], + "location_ids": [ + "59TNP9SA8VGDA" + ], + "updated_after": "2016-11-16T00:00:00.000Z" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.csharp", + "java": "/sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.java", + "javascript": "/sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.javascript", + "php": "/sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.php", + "python": "/sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.python", + "ruby": "/sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.ruby" + } + }, + "BatchRetrieveInventoryCountsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "counts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryCount" + }, + "description": "The current calculated inventory counts for the requested objects\nand locations." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." + } + }, + "example": { + "counts": [ + { + "calculated_at": "2016-11-16T22:28:01.223Z", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "location_id": "59TNP9SA8VGDA", + "quantity": "79", + "state": "IN_STOCK" + } + ], + "errors": [] + } + }, + "BatchRetrieveOrdersRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the\n`BatchRetrieveOrders` endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "order_ids" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location for these orders. This field is optional: omit it to retrieve\norders within the scope of the current authorization's merchant ID.", + "nullable": true + }, + "order_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request." + } + }, + "example": { + "location_id": "057P5VYJ4A5X1", + "order_ids": [ + "CAISEM82RcpmcFBM0TfOyiHV3es", + "CAISENgvlJ6jLWAzERDzjyHVybY" + ] + } + }, + "BatchRetrieveOrdersResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `BatchRetrieveOrders` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "description": "The requested orders. This will omit any requested orders that do not exist." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "orders": [ + { + "id": "CAISEM82RcpmcFBM0TfOyiHV3es", + "line_items": [ + { + "base_price_money": { + "amount": 1599, + "currency": "USD" + }, + "name": "Awesome product", + "quantity": "1", + "total_money": { + "amount": 1599, + "currency": "USD" + }, + "uid": "945986d1-9586-11e6-ad5a-28cfe92138cf" + }, + { + "base_price_money": { + "amount": 2000, + "currency": "USD" + }, + "name": "Another awesome product", + "quantity": "3", + "total_money": { + "amount": 6000, + "currency": "USD" + }, + "uid": "a8f4168c-9586-11e6-bdf0-28cfe92138cf" + } + ], + "location_id": "057P5VYJ4A5X1", + "reference_id": "my-order-001", + "total_money": { + "amount": 7599, + "currency": "USD" + } + } + ] + } + }, + "BatchUpsertCatalogObjectsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "batches" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this\nrequest among all your requests. A common way to create\na valid idempotency key is to use a Universally unique\nidentifier (UUID).\n\nIf you're unsure whether a particular request was successful,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate objects.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 128 + }, + "batches": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObjectBatch" + }, + "description": "A batch of CatalogObjects to be inserted/updated atomically.\nThe objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs\nattempting to insert or update an object within a batch, the entire batch will be rejected. However, an error\nin one batch will not affect other batches within the same request.\n\nFor each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its\n`is_deleted` field must not be set to `true`.\n\nTo modify an existing object, supply its ID. To create a new object, use an ID starting\nwith `#`. These IDs may be used to create relationships between an object and attributes of\nother objects that reference it. For example, you can create a CatalogItem with\nID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to\n`#ABC` in order to associate the CatalogItemVariation with its parent\nCatalogItem.\n\nAny `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.\n\nEach batch may contain up to 1,000 objects. The total number of objects across all batches for a single request\nmay not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will\nbe inserted or updated." + } + }, + "example": { + "batches": [ + { + "objects": [ + { + "id": "#Tea", + "item_data": { + "categories": [ + { + "id": "#Beverages" + } + ], + "description_html": "\u003cp\u003e\u003cstrong\u003eHot\u003c/strong\u003e Leaf Juice\u003c/p\u003e", + "name": "Tea", + "tax_ids": [ + "#SalesTax" + ], + "variations": [ + { + "id": "#Tea_Mug", + "item_variation_data": { + "item_id": "#Tea", + "name": "Mug", + "price_money": { + "amount": 150, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION" + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM" + }, + { + "id": "#Coffee", + "item_data": { + "categories": [ + { + "id": "#Beverages" + } + ], + "description_html": "\u003cp\u003eHot \u003cem\u003eBean Juice\u003c/em\u003e\u003c/p\u003e", + "name": "Coffee", + "tax_ids": [ + "#SalesTax" + ], + "variations": [ + { + "id": "#Coffee_Regular", + "item_variation_data": { + "item_id": "#Coffee", + "name": "Regular", + "price_money": { + "amount": 250, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION" + }, + { + "id": "#Coffee_Large", + "item_variation_data": { + "item_id": "#Coffee", + "name": "Large", + "price_money": { + "amount": 350, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION" + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM" + }, + { + "category_data": { + "name": "Beverages" + }, + "id": "#Beverages", + "present_at_all_locations": true, + "type": "CATEGORY" + }, + { + "id": "#SalesTax", + "present_at_all_locations": true, + "tax_data": { + "applies_to_custom_amounts": true, + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "enabled": true, + "inclusion_type": "ADDITIVE", + "name": "Sales Tax", + "percentage": "5.0" + }, + "type": "TAX" + } + ] + } + ], + "idempotency_key": "789ff020-f723-43a9-b4b5-43b5dc1fa3dc" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.csharp", + "java": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.java", + "javascript": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.javascript", + "php": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.php", + "python": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.python", + "ruby": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.ruby" + } + }, + "BatchUpsertCatalogObjectsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "The created successfully created CatalogObjects." + }, + "updated_at": { + "type": "string", + "description": "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\"." + }, + "id_mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogIdMapping" + }, + "description": "The mapping between client and server IDs for this upsert." + } + }, + "example": { + "id_mappings": [ + { + "client_object_id": "#Tea", + "object_id": "67GA7XA2FWMRYY2VCONTYZJR" + }, + { + "client_object_id": "#Coffee", + "object_id": "MQ4TZKOG3SR2EQI3TWEK4AH7" + }, + { + "client_object_id": "#Beverages", + "object_id": "XCS4SCGN4WQYE2VU4U3TKXEH" + }, + { + "client_object_id": "#SalesTax", + "object_id": "HP5VNYPKZKTNCKZ2Z5NPUH6A" + }, + { + "client_object_id": "#Tea_Mug", + "object_id": "CAJBHUIQH7ONTSZI2KTVOUP6" + }, + { + "client_object_id": "#Coffee_Regular", + "object_id": "GY2GXJTVVPQAPW43GFRR3NG6" + }, + { + "client_object_id": "#Coffee_Large", + "object_id": "JE6VHPSRQL6IWSN26C36CJ7W" + } + ], + "objects": [ + { + "created_at": "2023-11-30T19:24:35.4Z", + "id": "67GA7XA2FWMRYY2VCONTYZJR", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "XCS4SCGN4WQYE2VU4U3TKXEH", + "ordinal": -2251731094208512 + } + ], + "description": "Hot Leaf Juice", + "description_html": "\u003cp\u003e\u003cstrong\u003eHot\u003c/strong\u003e Leaf Juice\u003c/p\u003e", + "description_plaintext": "Hot Leaf Juice", + "is_archived": false, + "is_taxable": true, + "name": "Tea", + "product_type": "REGULAR", + "tax_ids": [ + "HP5VNYPKZKTNCKZ2Z5NPUH6A" + ], + "variations": [ + { + "created_at": "2023-11-30T19:24:35.4Z", + "id": "CAJBHUIQH7ONTSZI2KTVOUP6", + "is_deleted": false, + "item_variation_data": { + "item_id": "67GA7XA2FWMRYY2VCONTYZJR", + "name": "Mug", + "ordinal": 0, + "price_money": { + "amount": 150, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING", + "sellable": true, + "stockable": true + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + }, + { + "created_at": "2023-11-30T19:24:35.4Z", + "id": "MQ4TZKOG3SR2EQI3TWEK4AH7", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "XCS4SCGN4WQYE2VU4U3TKXEH", + "ordinal": -2251662374731776 + } + ], + "description": "Hot Bean Juice", + "description_html": "\u003cp\u003eHot \u003cem\u003eBean Juice\u003c/em\u003e\u003c/p\u003e", + "description_plaintext": "Hot Bean Juice", + "is_archived": false, + "is_taxable": true, + "name": "Coffee", + "product_type": "REGULAR", + "tax_ids": [ + "HP5VNYPKZKTNCKZ2Z5NPUH6A" + ], + "variations": [ + { + "created_at": "2023-11-30T19:24:35.4Z", + "id": "GY2GXJTVVPQAPW43GFRR3NG6", + "is_deleted": false, + "item_variation_data": { + "item_id": "MQ4TZKOG3SR2EQI3TWEK4AH7", + "name": "Regular", + "ordinal": 0, + "price_money": { + "amount": 250, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING", + "sellable": true, + "stockable": true + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + }, + { + "created_at": "2023-11-30T19:24:35.4Z", + "id": "JE6VHPSRQL6IWSN26C36CJ7W", + "is_deleted": false, + "item_variation_data": { + "item_id": "MQ4TZKOG3SR2EQI3TWEK4AH7", + "name": "Large", + "ordinal": 1, + "price_money": { + "amount": 350, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING", + "sellable": true, + "stockable": true + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + }, + { + "category_data": { + "category_type": "REGULAR_CATEGORY", + "is_top_level": true, + "name": "Beverages", + "online_visibility": true, + "parent_category": { + "ordinal": -2250837741010944 + } + }, + "created_at": "2023-11-30T19:24:35.4Z", + "id": "XCS4SCGN4WQYE2VU4U3TKXEH", + "is_deleted": false, + "present_at_all_locations": true, + "type": "CATEGORY", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + }, + { + "created_at": "2023-11-30T19:24:35.4Z", + "id": "HP5VNYPKZKTNCKZ2Z5NPUH6A", + "is_deleted": false, + "present_at_all_locations": true, + "tax_data": { + "applies_to_custom_amounts": true, + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "enabled": true, + "inclusion_type": "ADDITIVE", + "name": "Sales Tax", + "percentage": "5.0" + }, + "type": "TAX", + "updated_at": "2023-11-30T19:24:35.4Z", + "version": 1701372275400 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.csharp", + "java": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.java", + "javascript": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.javascript", + "php": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.php", + "python": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.python", + "ruby": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.ruby" + } + }, + "Booking": { + "type": "object", + "description": "Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A unique ID of this object representing a booking.", + "maxLength": 36, + "readOnly": true + }, + "version": { + "type": "integer", + "description": "The revision number for the booking used for optimistic concurrency." + }, + "status": { + "$ref": "#/components/schemas/BookingStatus", + "description": "The status of the booking, describing where the booking stands with respect to the booking state machine.\nSee [BookingStatus](#type-bookingstatus) for possible values", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the creation time of this booking.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the most recent update time of this booking.", + "readOnly": true + }, + "start_at": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the starting time of this booking.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.", + "maxLength": 32, + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.", + "maxLength": 192, + "nullable": true + }, + "customer_note": { + "type": "string", + "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.", + "maxLength": 4096, + "nullable": true + }, + "seller_note": { + "type": "string", + "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.\nThis field should not be visible to customers.", + "maxLength": 4096, + "nullable": true + }, + "appointment_segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppointmentSegment" + }, + "description": "A list of appointment segments for this booking.", + "nullable": true + }, + "transition_time_minutes": { + "type": "integer", + "description": "Additional time at the end of a booking.\nApplications should not make this field visible to customers of a seller.", + "readOnly": true + }, + "all_day": { + "type": "boolean", + "description": "Whether the booking is of a full business day.", + "readOnly": true + }, + "location_type": { + "$ref": "#/components/schemas/BusinessAppointmentSettingsBookingLocationType", + "description": "The type of location where the booking is held.\nSee [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values", + "nullable": true + }, + "creator_details": { + "$ref": "#/components/schemas/BookingCreatorDetails", + "description": "Information about the booking creator.", + "readOnly": true + }, + "source": { + "$ref": "#/components/schemas/BookingBookingSource", + "description": "The source of the booking.\nAccess to this field requires seller-level permissions.\nSee [BookingBookingSource](#type-bookingbookingsource) for possible values", + "readOnly": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "Stores a customer address if the location type is `CUSTOMER_LOCATION`.", + "nullable": true + } + } + }, + "BookingBookingSource": { + "type": "string", + "enum": [ + "FIRST_PARTY_MERCHANT", + "FIRST_PARTY_BUYER", + "THIRD_PARTY_BUYER", + "API" + ], + "x-enum-elements": [ + { + "name": "FIRST_PARTY_MERCHANT", + "description": "The booking was created by a seller from a Square Appointments application, such as the Square Appointments Dashboard or a Square Appointments mobile app." + }, + { + "name": "FIRST_PARTY_BUYER", + "description": "The booking was created by a buyer from a Square Appointments application, such as Square Online Booking Site." + }, + { + "name": "THIRD_PARTY_BUYER", + "description": "The booking was created by a buyer created from a third-party application." + }, + { + "name": "API", + "description": "The booking was created by a seller or a buyer from the Square Bookings API." + } + ], + "description": "Supported sources a booking was created from.", + "x-release-status": "PUBLIC" + }, + "BookingCreatorDetails": { + "type": "object", + "description": "Information about a booking creator.", + "x-release-status": "PUBLIC", + "properties": { + "creator_type": { + "$ref": "#/components/schemas/BookingCreatorDetailsCreatorType", + "description": "The seller-accessible type of the creator of the booking.\nSee [BookingCreatorDetailsCreatorType](#type-bookingcreatordetailscreatortype) for possible values", + "readOnly": true + }, + "team_member_id": { + "type": "string", + "description": "The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type.\nAccess to this field requires seller-level permissions.", + "maxLength": 32, + "readOnly": true + }, + "customer_id": { + "type": "string", + "description": "The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type.\nAccess to this field requires seller-level permissions.", + "maxLength": 192, + "readOnly": true + } + } + }, + "BookingCreatorDetailsCreatorType": { + "type": "string", + "enum": [ + "TEAM_MEMBER", + "CUSTOMER" + ], + "x-enum-elements": [ + { + "name": "TEAM_MEMBER", + "description": "The creator is of the seller type." + }, + { + "name": "CUSTOMER", + "description": "The creator is of the buyer type." + } + ], + "description": "Supported types of a booking creator.", + "x-release-status": "PUBLIC" + }, + "BookingCustomAttributeDeleteRequest": { + "type": "object", + "description": "Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes)\nrequest. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.", + "x-release-status": "PUBLIC", + "required": [ + "booking_id", + "key" + ], + "properties": { + "booking_id": { + "type": "string", + "description": "The ID of the target [booking](entity:Booking).", + "minLength": 1, + "maxLength": 36 + }, + "key": { + "type": "string", + "description": "The key of the custom attribute to delete. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key.", + "minLength": 1 + } + } + }, + "BookingCustomAttributeDeleteResponse": { + "type": "object", + "description": "Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) operation.", + "x-release-status": "PUBLIC", + "properties": { + "booking_id": { + "type": "string", + "description": "The ID of the [booking](entity:Booking) associated with the custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred while processing the individual request." + } + }, + "example": { + "booking_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "errors": [] + } + }, + "BookingCustomAttributeUpsertRequest": { + "type": "object", + "description": "Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes)\nrequest. An individual request contains a booking ID, the custom attribute to create or update,\nand an optional idempotency key.", + "x-release-status": "PUBLIC", + "required": [ + "booking_id", + "custom_attribute" + ], + "properties": { + "booking_id": { + "type": "string", + "description": "The ID of the target [booking](entity:Booking).", + "minLength": 1, + "maxLength": 36 + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with following fields:\n\n- `key`. This key must match the `key` of a custom attribute definition in the Square seller\naccount. If the requesting application is not the definition owner, you must provide the qualified key.\n\n- `value`. This value must conform to the `schema` specified by the definition.\nFor more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types).\n\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol for update operations, include this optional field in the request and set the\nvalue to the current version of the custom attribute." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + } + }, + "BookingCustomAttributeUpsertResponse": { + "type": "object", + "description": "Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) operation.", + "x-release-status": "PUBLIC", + "properties": { + "booking_id": { + "type": "string", + "description": "The ID of the [booking](entity:Booking) associated with the custom attribute." + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred while processing the individual request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-11-16T00:14:47Z", + "key": "favoriteShampoo", + "updated_at": "2022-11-16T00:16:23Z", + "value": "Spring Fresh", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + } + }, + "BookingStatus": { + "type": "string", + "enum": [ + "PENDING", + "CANCELLED_BY_CUSTOMER", + "CANCELLED_BY_SELLER", + "DECLINED", + "ACCEPTED", + "NO_SHOW" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "An unaccepted booking. It is visible to both sellers and customers." + }, + { + "name": "CANCELLED_BY_CUSTOMER", + "description": "A customer-cancelled booking. It is visible to both the seller and the customer." + }, + { + "name": "CANCELLED_BY_SELLER", + "description": "A seller-cancelled booking. It is visible to both the seller and the customer." + }, + { + "name": "DECLINED", + "description": "A declined booking. It had once been pending, but was then declined by the seller." + }, + { + "name": "ACCEPTED", + "description": "An accepted booking agreed to or accepted by the seller." + }, + { + "name": "NO_SHOW", + "description": "A no-show booking. The booking was accepted at one time, but have now been marked as a no-show by\nthe seller because the client either missed the booking or cancelled it without enough notice." + } + ], + "description": "Supported booking statuses.", + "x-release-status": "PUBLIC" + }, + "Break": { + "type": "object", + "description": "A record of an employee's break during a shift.", + "x-release-status": "PUBLIC", + "required": [ + "start_at", + "break_type_id", + "name", + "expected_duration", + "is_paid" + ], + "properties": { + "id": { + "type": "string", + "description": "The UUID for this object." + }, + "start_at": { + "type": "string", + "description": "RFC 3339; follows the same timezone information as `Shift`. Precision up to\nthe minute is respected; seconds are truncated.", + "minLength": 1 + }, + "end_at": { + "type": "string", + "description": "RFC 3339; follows the same timezone information as `Shift`. Precision up to\nthe minute is respected; seconds are truncated.", + "nullable": true + }, + "break_type_id": { + "type": "string", + "description": "The `BreakType` that this `Break` was templated on.", + "minLength": 1 + }, + "name": { + "type": "string", + "description": "A human-readable name.", + "minLength": 1 + }, + "expected_duration": { + "type": "string", + "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthe break.", + "minLength": 1 + }, + "is_paid": { + "type": "boolean", + "description": "Whether this break counts towards time worked for compensation\npurposes." + } + } + }, + "BreakType": { + "type": "object", + "description": "A defined break template that sets an expectation for possible `Break`\ninstances on a `Shift`.", + "x-release-status": "PUBLIC", + "required": [ + "location_id", + "break_name", + "expected_duration", + "is_paid" + ], + "properties": { + "id": { + "type": "string", + "description": "The UUID for this object.", + "maxLength": 255 + }, + "location_id": { + "type": "string", + "description": "The ID of the business location this type of break applies to.", + "minLength": 1 + }, + "break_name": { + "type": "string", + "description": "A human-readable name for this type of break. The name is displayed to\nemployees in Square products.", + "minLength": 1 + }, + "expected_duration": { + "type": "string", + "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthis break. Precision less than minutes is truncated.\n\nExample for break expected duration of 15 minutes: T15M", + "minLength": 1 + }, + "is_paid": { + "type": "boolean", + "description": "Whether this break counts towards time worked for compensation\npurposes." + }, + "version": { + "type": "integer", + "description": "Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If a value is not\nprovided, Square's servers execute a \"blind\" write; potentially\noverwriting another writer's data." + }, + "created_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format.", + "readOnly": true + } + } + }, + "BulkCreateCustomerData": { + "type": "object", + "description": "Defines the customer data provided in individual create requests for a\n[BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) operation.", + "x-release-status": "PUBLIC", + "properties": { + "given_name": { + "type": "string", + "description": "The given name (that is, the first name) associated with the customer profile.", + "maxLength": 300, + "nullable": true + }, + "family_name": { + "type": "string", + "description": "The family name (that is, the last name) associated with the customer profile.", + "maxLength": 300, + "nullable": true + }, + "company_name": { + "type": "string", + "description": "A business name associated with the customer profile.", + "maxLength": 500, + "nullable": true + }, + "nickname": { + "type": "string", + "description": "A nickname for the customer profile.", + "maxLength": 100, + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address associated with the customer profile.", + "maxLength": 254, + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The physical address associated with the customer profile. For maximum length constraints,\nsee [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address).\nThe `first_name` and `last_name` fields are ignored if they are present in the request.", + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number associated with the customer profile. The phone number must be valid\nand can contain 9–16 digits, with an optional `+` prefix and country code. For more information,\nsee [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "An optional second ID used to associate the customer profile with an\nentity in another system.", + "maxLength": 100, + "nullable": true + }, + "note": { + "type": "string", + "description": "A custom note associated with the customer profile.", + "nullable": true + }, + "birthday": { + "type": "string", + "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format.\nFor example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21.\nBirthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or\n`0000` if a birth year is not specified.", + "nullable": true + }, + "tax_ids": { + "$ref": "#/components/schemas/CustomerTaxIds", + "description": "The tax ID associated with the customer profile. This field is available only for\ncustomers of sellers in EU countries or the United Kingdom. For more information, see\n[Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "nullable": true + } + } + }, + "BulkCreateCustomersRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in requests to the\n[BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "customers" + ], + "properties": { + "customers": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkCreateCustomerData" + }, + "description": "A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }`\nkey-value pairs.\n\nEach key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)\nthat uniquely identifies the create request. Each value contains the customer data used to create the\ncustomer profile." + } + }, + "example": { + "customers": { + "8bb76c4f-e35d-4c5b-90de-1194cd9179f0": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "note": "a customer", + "phone_number": "+1-212-555-4240", + "reference_id": "YOUR_REFERENCE_ID" + }, + "d1689f23-b25d-4932-b2f0-aed00f5e2029": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 601", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "email_address": "Marie.Curie@example.com", + "family_name": "Curie", + "given_name": "Marie", + "note": "another customer", + "phone_number": "+1-212-444-4240", + "reference_id": "YOUR_REFERENCE_ID" + } + } + } + }, + "BulkCreateCustomersResponse": { + "type": "object", + "description": "Defines the fields included in the response body from the\n[BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CreateCustomerResponse" + }, + "description": "A map of responses that correspond to individual create requests, represented by\nkey-value pairs.\n\nEach key is the idempotency key that was provided for a create request and each value\nis the corresponding response.\nIf the request succeeds, the value is the new customer profile.\nIf the request fails, the value contains any errors that occurred during the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any top-level errors that prevented the bulk operation from running." + } + }, + "example": { + "responses": { + "8bb76c4f-e35d-4c5b-90de-1194cd9179f4": { + "customer": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2024-03-23T20:21:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "id": "8DDA5NZVBZFGAX0V3HPF81HHE0", + "note": "a customer", + "phone_number": "+1-212-555-4240", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID", + "updated_at": "2024-03-23T20:21:54.859Z", + "version": 0 + } + }, + "d1689f23-b25d-4932-b2f0-aed00f5e2029": { + "customer": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 601", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2024-03-23T20:21:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "Marie.Curie@example.com", + "family_name": "Curie", + "given_name": "Marie", + "id": "N18CPRVXR5214XPBBA6BZQWF3C", + "note": "another customer", + "phone_number": "+1-212-444-4240", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID", + "updated_at": "2024-03-23T20:21:54.859Z", + "version": 0 + } + } + } + } + }, + "BulkCreateTeamMembersRequest": { + "type": "object", + "description": "Represents a bulk create request for `TeamMember` objects.", + "x-release-status": "PUBLIC", + "required": [ + "team_members" + ], + "properties": { + "team_members": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CreateTeamMemberRequest" + }, + "description": "The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`.\nThe maximum number of create objects is 25.\n\nIf you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs,\ncall [ListJobs](api-endpoint:Team-ListJobs)." + } + }, + "example": { + "team_members": { + "idempotency-key-1": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "YSGH2WBKG94QZ", + "GA2Y9HSJ8KRYT" + ] + }, + "email_address": "joe_doe@gmail.com", + "family_name": "Doe", + "given_name": "Joe", + "phone_number": "+14159283333", + "reference_id": "reference_id_1" + } + }, + "idempotency-key-2": { + "team_member": { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "email_address": "jane_smith@gmail.com", + "family_name": "Smith", + "given_name": "Jane", + "phone_number": "+14159223334", + "reference_id": "reference_id_2" + } + } + } + } + }, + "BulkCreateTeamMembersResponse": { + "type": "object", + "description": "Represents a response from a bulk create request containing the created `TeamMember` objects or error messages.", + "x-release-status": "PUBLIC", + "properties": { + "team_members": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CreateTeamMemberResponse" + }, + "description": "The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "team_members": { + "idempotency-key-1": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "GA2Y9HSJ8KRYT", + "YSGH2WBKG94QZ" + ] + }, + "email_address": "joe_doe@gmail.com", + "family_name": "Doe", + "given_name": "Joe", + "id": "ywhG1qfIOoqsHfVRubFV", + "is_owner": false, + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE" + } + }, + "idempotency-key-2": { + "team_member": { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "email_address": "jane_smith@gmail.com", + "family_name": "Smith", + "given_name": "Jane", + "id": "IF_Ncrg7fHhCqxVI9T6R", + "is_owner": false, + "phone_number": "+14159223334", + "reference_id": "reference_id_2", + "status": "ACTIVE" + } + } + } + } + }, + "BulkCreateVendorsRequest": { + "type": "object", + "description": "Represents an input to a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).", + "x-release-status": "BETA", + "required": [ + "vendors" + ], + "properties": { + "vendors": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Vendor" + }, + "description": "Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." + } + }, + "example": { + "47bb76a8-c9fb-4f33-9df8-25ce02ca4505": { + "contacts": [ + { + "email_address": "annie@annieshotsauce.com", + "name": "Annie Thomas", + "phone_number": "1-212-555-4250" + } + ], + "name": "Annie’s Hot Sauce" + }, + "vendors": { + "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "name": "Joe's Fresh Seafood", + "note": "a vendor" + } + } + } + }, + "BulkCreateVendorsResponse": { + "type": "object", + "description": "Represents an output from a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CreateVendorResponse" + }, + "description": "A set of [CreateVendorResponse](entity:CreateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." + } + }, + "example": { + "47bb76a8-c9fb-4f33-9df8-25ce02ca4505": { + "vendor": { + "contacts": [ + { + "email_address": "annie@annieshotsauce.com", + "id": "INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4", + "name": "Annie Thomas", + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Annie’s Hot Sauce", + "status": "ACTIVE", + "updated_at": "2022-03-16T10:21:54.859Z", + "version": 1 + } + }, + "responses": { + "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": { + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Joe's Fresh Seafood", + "note": "a vendor", + "status": "ACTIVE", + "updated_at": "2022-03-16T10:21:54.859Z", + "version": 0 + } + } + } + } + }, + "BulkDeleteBookingCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) request.", + "x-release-status": "PUBLIC", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BookingCustomAttributeDeleteRequest" + }, + "description": "A map containing 1 to 25 individual Delete requests. For each request, provide an\narbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the\ninformation needed to delete a custom attribute." + } + } + }, + "BulkDeleteBookingCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "x-release-status": "PUBLIC", + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BookingCustomAttributeDeleteResponse" + }, + "description": "A map of responses that correspond to individual delete requests. Each response has the\nsame ID as the corresponding request and contains `booking_id` and `errors` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "errors": [], + "values": { + "id1": { + "booking_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "errors": [] + }, + "id2": { + "booking_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "errors": [] + }, + "id3": { + "booking_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "errors": [] + } + } + } + }, + "BulkDeleteCustomersRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in requests to the\n[BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "customer_ids" + ], + "properties": { + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the [customer profiles](entity:Customer) to delete." + } + }, + "example": { + "customer_ids": [ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8" + ] + } + }, + "BulkDeleteCustomersResponse": { + "type": "object", + "description": "Defines the fields included in the response body from the\n[BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/DeleteCustomerResponse" + }, + "description": "A map of responses that correspond to individual delete requests, represented by\nkey-value pairs.\n\nEach key is the customer ID that was specified for a delete request and each value\nis the corresponding response.\nIf the request succeeds, the value is an empty object (`{ }`).\nIf the request fails, the value contains any errors that occurred during the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any top-level errors that prevented the bulk operation from running." + } + }, + "example": { + "responses": { + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8": { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "NOT_FOUND", + "detail": "Customer with ID `2GYD7WNXF7BJZW1PMGNXZ3Y8M8` not found." + } + ] + }, + "8DDA5NZVBZFGAX0V3HPF81HHE0": {}, + "N18CPRVXR5214XPBBA6BZQWF3C": {} + } + } + }, + "BulkDeleteLocationCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) request.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest" + }, + "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." + } + }, + "example": { + "values": { + "id1": { + "key": "bestseller", + "location_id": "L0TBCBTB7P8RQ" + }, + "id2": { + "key": "bestseller", + "location_id": "L9XMD04V3STJX" + }, + "id3": { + "key": "phone-number", + "location_id": "L0TBCBTB7P8RQ" + } + } + } + }, + "BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest": { + "type": "object", + "description": "Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "key": { + "type": "string", + "description": "The key of the associated custom attribute definition.\nRepresented as a qualified key if the requesting app is not the definition owner.", + "pattern": "^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$", + "readOnly": true + } + } + }, + "BulkDeleteLocationCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse" + }, + "description": "A map of responses that correspond to individual delete requests. Each response has the\nsame key as the corresponding request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "values": { + "id1": { + "errors": [], + "location_id": "L0TBCBTB7P8RQ" + }, + "id2": { + "errors": [], + "location_id": "L9XMD04V3STJX" + }, + "id3": { + "errors": [], + "location_id": "L0TBCBTB7P8RQ" + } + } + } + }, + "BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse": { + "type": "object", + "description": "Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes)\nrequest.", + "x-release-status": "BETA", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location associated with the custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request" + } + }, + "example": { + "errors": [], + "location_id": "L0TBCBTB7P8RQ" + } + }, + "BulkDeleteMerchantCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) request.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest" + }, + "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." + } + }, + "example": { + "values": { + "id1": { + "key": "alternative_seller_name", + "merchant_id": "DM7VKY8Q63GNP" + }, + "id2": { + "key": "has_seen_tutorial", + "merchant_id": "DM7VKY8Q63GNP" + } + } + } + }, + "BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest": { + "type": "object", + "description": "Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "key": { + "type": "string", + "description": "The key of the associated custom attribute definition.\nRepresented as a qualified key if the requesting app is not the definition owner.", + "pattern": "^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$", + "readOnly": true + } + } + }, + "BulkDeleteMerchantCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse" + }, + "description": "A map of responses that correspond to individual delete requests. Each response has the\nsame key as the corresponding request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "values": { + "id1": { + "errors": [], + "merchant_id": "DM7VKY8Q63GNP" + }, + "id2": { + "errors": [], + "merchant_id": "DM7VKY8Q63GNP" + } + } + } + }, + "BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse": { + "type": "object", + "description": "Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes)\nrequest.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred while processing the individual MerchantCustomAttributeDeleteRequest request" + } + }, + "example": { + "errors": [], + "merchant_id": "DM7VKY8Q63GNP" + } + }, + "BulkDeleteOrderCustomAttributesRequest": { + "type": "object", + "description": "Represents a bulk delete request for one or more order custom attributes.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute" + }, + "description": "A map of requests that correspond to individual delete operations for custom attributes." + } + }, + "example": { + "values": { + "cover-count": { + "key": "cover-count", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F" + }, + "table-number": { + "key": "table-number", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F" + } + } + } + }, + "BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute": { + "type": "object", + "description": "Represents one delete within the bulk operation.", + "x-release-status": "BETA", + "required": [ + "order_id" + ], + "properties": { + "key": { + "type": "string", + "description": "The key of the custom attribute to delete. This key must match the key \nof an existing custom attribute definition.", + "minLength": 1, + "pattern": "^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$", + "readOnly": true + }, + "order_id": { + "type": "string", + "description": "The ID of the target [order](entity:Order).", + "minLength": 1, + "maxLength": 255 + } + } + }, + "BulkDeleteOrderCustomAttributesResponse": { + "type": "object", + "description": "Represents a response from deleting one or more order custom attributes.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/DeleteOrderCustomAttributeResponse" + }, + "description": " A map of responses that correspond to individual delete requests. Each response has the same ID \nas the corresponding request and contains either a `custom_attribute` or an `errors` field." + } + }, + "example": { + "values": { + "cover-count": {}, + "table-number": {} + } + } + }, + "BulkRetrieveBookingsRequest": { + "type": "object", + "description": "Request payload for bulk retrieval of bookings.", + "x-release-status": "PUBLIC", + "required": [ + "booking_ids" + ], + "properties": { + "booking_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve." + } + } + }, + "BulkRetrieveBookingsResponse": { + "type": "object", + "description": "Response payload for bulk retrieval of bookings.", + "x-release-status": "PUBLIC", + "properties": { + "bookings": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/RetrieveBookingResponse" + }, + "description": "Requested bookings returned as a map containing `booking_id` as the key and `RetrieveBookingResponse` as the value." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "bookings": { + "sc3p3m7dvctfr1": { + "booking": { + "all_day": false, + "appointment_segments": [ + { + "any_team_member": false, + "duration_minutes": 60, + "service_variation_id": "VG4FYBKK3UL6UITOEYQ6MFLS", + "service_variation_version": 1641341724039, + "team_member_id": "TMjiqI3PxyLMKr4k" + } + ], + "created_at": "2023-04-26T18:19:21Z", + "customer_id": "4TDWKN9E8165X8Z77MRS0VFMJM", + "id": "sc3p3m7dvctfr1", + "location_id": "LY6WNBPVM6VGV", + "start_at": "2023-05-01T14:00:00Z", + "status": "ACCEPTED", + "updated_at": "2023-04-26T18:19:21Z", + "version": 0 + }, + "errors": [] + }, + "tdegug1dvctdef": { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "NOT_FOUND", + "detail": "Specified booking was not found.", + "field": "booking_id" + } + ] + }, + "tdegug1fqni3wh": { + "booking": { + "all_day": false, + "appointment_segments": [ + { + "any_team_member": false, + "duration_minutes": 60, + "service_variation_id": "VG4FYBKK3UL6UITOEYQ6MFLS", + "service_variation_version": 1641341724039, + "team_member_id": "TMjiqI3PxyLMKr4k" + } + ], + "created_at": "2023-04-26T18:19:30Z", + "customer_id": "4TDWKN9E8165X8Z77MRS0VFMJM", + "id": "tdegug1fqni3wh", + "location_id": "LY6WNBPVM6VGV", + "start_at": "2023-05-02T14:00:00Z", + "status": "ACCEPTED", + "updated_at": "2023-04-26T18:19:30Z", + "version": 0 + }, + "errors": [] + } + }, + "errors": [] + } + }, + "BulkRetrieveCustomersRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in requests to the\n[BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "customer_ids" + ], + "properties": { + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the [customer profiles](entity:Customer) to retrieve." + } + }, + "example": { + "customer_ids": [ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8" + ] + } + }, + "BulkRetrieveCustomersResponse": { + "type": "object", + "description": "Defines the fields included in the response body from the\n[BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/RetrieveCustomerResponse" + }, + "description": "A map of responses that correspond to individual retrieve requests, represented by\nkey-value pairs.\n\nEach key is the customer ID that was specified for a retrieve request and each value\nis the corresponding response.\nIf the request succeeds, the value is the requested customer profile.\nIf the request fails, the value contains any errors that occurred during the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any top-level errors that prevented the bulk operation from running." + } + }, + "example": { + "responses": { + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8": { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "NOT_FOUND", + "detail": "Customer with ID `2GYD7WNXF7BJZW1PMGNXZ3Y8M8` not found." + } + ] + }, + "8DDA5NZVBZFGAX0V3HPF81HHE0": { + "customer": { + "birthday": "1897-07-24", + "created_at": "2024-01-19T00:27:54.59Z", + "creation_source": "THIRD_PARTY", + "email_address": "New.Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "id": "8DDA5NZVBZFGAX0V3HPF81HHE0", + "note": "updated customer note", + "preferences": { + "email_unsubscribed": false + }, + "updated_at": "2024-01-19T00:38:06Z", + "version": 3 + } + }, + "N18CPRVXR5214XPBBA6BZQWF3C": { + "customer": { + "created_at": "2024-01-19T00:27:54.59Z", + "creation_source": "THIRD_PARTY", + "family_name": "Curie", + "given_name": "Marie", + "id": "N18CPRVXR5214XPBBA6BZQWF3C", + "preferences": { + "email_unsubscribed": false + }, + "updated_at": "2024-01-19T00:38:06Z", + "version": 1 + } + } + } + } + }, + "BulkRetrieveTeamMemberBookingProfilesRequest": { + "type": "object", + "description": "Request payload for the [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "team_member_ids" + ], + "properties": { + "team_member_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A non-empty list of IDs of team members whose booking profiles you want to retrieve." + } + } + }, + "BulkRetrieveTeamMemberBookingProfilesResponse": { + "type": "object", + "description": "Response payload for the [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "team_member_booking_profiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/RetrieveTeamMemberBookingProfileResponse" + }, + "description": "The returned team members' booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](entity:TeamMemberBookingProfile) the value." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "errors": [], + "team_member_booking_profiles": { + "TMXUrsBWWcHTt79t": { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "NOT_FOUND", + "detail": "Resource not found." + } + ] + }, + "TMaJcbiRqPIGZuS9": { + "errors": [], + "team_member_booking_profile": { + "display_name": "Sandbox Staff 1", + "is_bookable": true, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + }, + "TMtdegug1fqni3wh": { + "errors": [], + "team_member_booking_profile": { + "display_name": "Sandbox Staff 2", + "is_bookable": true, + "team_member_id": "TMtdegug1fqni3wh" + } + } + } + } + }, + "BulkRetrieveVendorsRequest": { + "type": "object", + "description": "Represents an input to a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors).", + "x-release-status": "BETA", + "properties": { + "vendor_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IDs of the [Vendor](entity:Vendor) objects to retrieve.", + "nullable": true + } + }, + "example": { + "vendor_ids": [ + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4" + ] + } + }, + "BulkRetrieveVendorsResponse": { + "type": "object", + "description": "Represents an output from a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/RetrieveVendorResponse" + }, + "description": "The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](entity:Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." + } + }, + "example": { + "responses": { + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": { + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Joe's Fresh Seafood", + "note": "a vendor", + "status": "ACTIVE", + "updated_at": "2022-03-16T10:21:54.859Z", + "version": 1 + } + } + } + } + }, + "BulkSwapPlanRequest": { + "type": "object", + "description": "Defines input parameters in a call to the\n[BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint.", + "x-release-status": "BETA", + "required": [ + "new_plan_variation_id", + "old_plan_variation_id", + "location_id" + ], + "properties": { + "new_plan_variation_id": { + "type": "string", + "description": "The ID of the new subscription plan variation.\n\nThis field is required.", + "minLength": 1 + }, + "old_plan_variation_id": { + "type": "string", + "description": "The ID of the plan variation whose subscriptions should be swapped. Active subscriptions\nusing this plan variation will be subscribed to the new plan variation on their next billing\nday.", + "minLength": 1 + }, + "location_id": { + "type": "string", + "description": "The ID of the location to associate with the swapped subscriptions.", + "minLength": 1 + } + }, + "example": { + "location_id": "S8GWD5R9QB376", + "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", + "old_plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H" + } + }, + "BulkSwapPlanResponse": { + "type": "object", + "description": "Defines output parameters in a response of the\n[BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "affected_subscriptions": { + "type": "integer", + "description": "The number of affected subscriptions." + } + }, + "example": { + "affected_subscriptions": 12 + } + }, + "BulkUpdateCustomerData": { + "type": "object", + "description": "Defines the customer data provided in individual update requests for a\n[BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) operation.", + "x-release-status": "PUBLIC", + "properties": { + "given_name": { + "type": "string", + "description": "The given name (that is, the first name) associated with the customer profile.", + "maxLength": 300, + "nullable": true + }, + "family_name": { + "type": "string", + "description": "The family name (that is, the last name) associated with the customer profile.", + "maxLength": 300, + "nullable": true + }, + "company_name": { + "type": "string", + "description": "A business name associated with the customer profile.", + "maxLength": 500, + "nullable": true + }, + "nickname": { + "type": "string", + "description": "A nickname for the customer profile.", + "maxLength": 100, + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address associated with the customer profile.", + "maxLength": 254, + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The physical address associated with the customer profile. For maximum length constraints,\nsee [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address).\nThe `first_name` and `last_name` fields are ignored if they are present in the request.", + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number associated with the customer profile. The phone number must be valid\nand can contain 9–16 digits, with an optional `+` prefix and country code. For more information,\nsee [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "An optional second ID used to associate the customer profile with an\nentity in another system.", + "maxLength": 100, + "nullable": true + }, + "note": { + "type": "string", + "description": "An custom note associates with the customer profile.", + "nullable": true + }, + "birthday": { + "type": "string", + "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format.\nFor example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21.\nBirthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or\n`0000` if a birth year is not specified.", + "nullable": true + }, + "tax_ids": { + "$ref": "#/components/schemas/CustomerTaxIds", + "description": "The tax ID associated with the customer profile. This field is available only for\ncustomers of sellers in EU countries or the United Kingdom. For more information, see\n[Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the customer profile.\n\nAs a best practice, you should include this field to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol.", + "format": "int64" + } + } + }, + "BulkUpdateCustomersRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in requests to the\n[BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "customers" + ], + "properties": { + "customers": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpdateCustomerData" + }, + "description": "A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }`\nkey-value pairs.\n\nEach key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile\nthat was created by merging existing profiles, provide the ID of the newly created profile.\n\nEach value contains the updated customer data. Only new or changed fields are required. To add or\nupdate a field, specify the new value. To remove a field, specify `null`." + } + }, + "example": { + "customers": { + "8DDA5NZVBZFGAX0V3HPF81HHE0": { + "email_address": "New.Amelia.Earhart@example.com", + "note": "updated customer note", + "phone_number": null, + "version": 2 + }, + "N18CPRVXR5214XPBBA6BZQWF3C": { + "family_name": "Curie", + "given_name": "Marie", + "version": 0 + } + } + } + }, + "BulkUpdateCustomersResponse": { + "type": "object", + "description": "Defines the fields included in the response body from the\n[BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UpdateCustomerResponse" + }, + "description": "A map of responses that correspond to individual update requests, represented by\nkey-value pairs.\n\nEach key is the customer ID that was specified for an update request and each value\nis the corresponding response.\nIf the request succeeds, the value is the updated customer profile.\nIf the request fails, the value contains any errors that occurred during the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any top-level errors that prevented the bulk operation from running." + } + }, + "example": { + "responses": { + "8DDA5NZVBZFGAX0V3HPF81HHE0": { + "customer": { + "birthday": "1897-07-24", + "created_at": "2024-01-19T00:27:54.59Z", + "creation_source": "THIRD_PARTY", + "email_address": "New.Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "id": "8DDA5NZVBZFGAX0V3HPF81HHE0", + "note": "updated customer note", + "preferences": { + "email_unsubscribed": false + }, + "updated_at": "2024-01-19T00:38:06Z", + "version": 3 + } + }, + "N18CPRVXR5214XPBBA6BZQWF3C": { + "customer": { + "created_at": "2024-01-19T00:27:54.59Z", + "creation_source": "THIRD_PARTY", + "family_name": "Curie", + "given_name": "Marie", + "id": "N18CPRVXR5214XPBBA6BZQWF3C", + "preferences": { + "email_unsubscribed": false + }, + "updated_at": "2024-01-19T00:38:06Z", + "version": 1 + } + } + } + } + }, + "BulkUpdateTeamMembersRequest": { + "type": "object", + "description": "Represents a bulk update request for `TeamMember` objects.", + "x-release-status": "PUBLIC", + "required": [ + "team_members" + ], + "properties": { + "team_members": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UpdateTeamMemberRequest" + }, + "description": "The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`.\nThe maximum number of update objects is 25.\n\nFor each team member, include the fields to add, change, or clear. Fields can be cleared using a null value.\nTo update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed,\ncall [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values." + } + }, + "example": { + "team_members": { + "AFMwA08kR-MIF-3Vs0OE": { + "team_member": { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "email_address": "jane_smith@gmail.com", + "family_name": "Smith", + "given_name": "Jane", + "is_owner": false, + "phone_number": "+14159223334", + "reference_id": "reference_id_2", + "status": "ACTIVE" + } + }, + "fpgteZNMaf0qOK-a4t6P": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "YSGH2WBKG94QZ", + "GA2Y9HSJ8KRYT" + ] + }, + "email_address": "joe_doe@gmail.com", + "family_name": "Doe", + "given_name": "Joe", + "is_owner": false, + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE" + } + } + } + } + }, + "BulkUpdateTeamMembersResponse": { + "type": "object", + "description": "Represents a response from a bulk update request containing the updated `TeamMember` objects or error messages.", + "x-release-status": "PUBLIC", + "properties": { + "team_members": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UpdateTeamMemberResponse" + }, + "description": "The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "team_members": { + "AFMwA08kR-MIF-3Vs0OE": { + "team_member": { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T18:14:00Z", + "email_address": "jane_smith@example.com", + "family_name": "Smith", + "given_name": "Jane", + "id": "AFMwA08kR-MIF-3Vs0OE", + "is_owner": false, + "phone_number": "+14159223334", + "reference_id": "reference_id_2", + "status": "ACTIVE", + "updated_at": "2020-03-24T18:18:00Z" + } + }, + "fpgteZNMaf0qOK-a4t6P": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "GA2Y9HSJ8KRYT", + "YSGH2WBKG94QZ" + ] + }, + "created_at": "2020-03-24T18:14:00Z", + "email_address": "joe_doe@example.com", + "family_name": "Doe", + "given_name": "Joe", + "id": "fpgteZNMaf0qOK-a4t6P", + "is_owner": false, + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE", + "updated_at": "2020-03-24T18:18:00Z" + } + } + } + } + }, + "BulkUpdateVendorsRequest": { + "type": "object", + "description": "Represents an input to a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).", + "x-release-status": "BETA", + "required": [ + "vendors" + ], + "properties": { + "vendors": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UpdateVendorRequest" + }, + "description": "A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." + } + }, + "example": { + "vendors": { + "FMCYHBWT1TPL8MFH52PBMEN92A": { + "address": { + "address_line_1": "202 Mill St", + "administrative_district_level_1": "NJ", + "country": "US", + "locality": "Moorestown", + "postal_code": "08057" + }, + "status": "ACTIVE", + "version": 10 + }, + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": { + "note": "favorite vendor", + "status": "ACTIVE", + "version": 30 + } + } + } + }, + "BulkUpdateVendorsResponse": { + "type": "object", + "description": "Represents an output from a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered when the request fails." + }, + "responses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UpdateVendorResponse" + }, + "description": "A set of [UpdateVendorResponse](entity:UpdateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." + } + }, + "example": { + "responses": { + "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A": { + "vendor": { + "address": { + "address_line_1": "202 Mill St", + "administrative_district_level_1": "NJ", + "country": "US", + "locality": "Moorestown", + "postal_code": "08057" + }, + "contacts": [ + { + "email_address": "annie@annieshotsauce.com", + "id": "INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4", + "name": "Annie Thomas", + "ordinal": 0, + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Annie’s Hot Sauce", + "status": "ACTIVE", + "updated_at": "2022-03-16T20:21:54.859Z", + "version": 11 + } + }, + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": { + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "ordinal": 0, + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:10:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Joe's Fresh Seafood", + "note": "favorite vendor", + "status": "ACTIVE", + "updated_at": "2022-03-16T20:21:54.859Z", + "version": 31 + } + } + } + } + }, + "BulkUpsertBookingCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) request.", + "x-release-status": "PUBLIC", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BookingCustomAttributeUpsertRequest" + }, + "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the\ninformation needed to create or update a custom attribute." + } + } + }, + "BulkUpsertBookingCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "x-release-status": "PUBLIC", + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BookingCustomAttributeUpsertResponse" + }, + "description": "A map of responses that correspond to individual upsert requests. Each response has the\nsame ID as the corresponding request and contains either a `booking_id` and `custom_attribute` or an `errors` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "errors": [], + "values": { + "id1": { + "booking_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": { + "created_at": "2022-11-16T23:14:47Z", + "key": "favoriteShampoo", + "updated_at": "2022-11-16T00:16:23Z", + "value": "Spring Fresh", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + }, + "id2": { + "booking_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": { + "created_at": "2022-11-16T00:16:20Z", + "key": "hasShoes", + "updated_at": "2022-11-16T00:16:23Z", + "value": false, + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + }, + "id3": { + "booking_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": { + "created_at": "2022-11-16T00:16:20Z", + "key": "favoriteShampoo", + "updated_at": "2022-11-16T00:16:23Z", + "value": "Hydro-Cool", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + }, + "id4": { + "booking_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": { + "created_at": "2022-11-16T23:14:47Z", + "key": "partySize", + "updated_at": "2022-11-16T00:16:23Z", + "value": 4, + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + }, + "id5": { + "booking_id": "70548QG1HN43B05G0KCZ4MMC1G", + "custom_attribute": { + "created_at": "2022-11-16T00:16:20Z", + "key": "celebrating", + "updated_at": "2022-11-16T00:16:23Z", + "value": "birthday", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + } + } + } + }, + "BulkUpsertCustomerCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) request.", + "x-release-status": "PUBLIC", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest" + }, + "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the\ninformation needed to create or update a custom attribute." + } + }, + "example": { + "values": { + "id1": { + "custom_attribute": { + "key": "favoritemovie", + "value": "Dune" + }, + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8" + }, + "id2": { + "custom_attribute": { + "key": "ownsmovie", + "value": false + }, + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM" + }, + "id3": { + "custom_attribute": { + "key": "favoritemovie", + "value": "Star Wars" + }, + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM" + }, + "id4": { + "custom_attribute": { + "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808", + "value": "10.5" + }, + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8" + }, + "id5": { + "custom_attribute": { + "key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail", + "value": "fake-email@squareup.com" + }, + "customer_id": "70548QG1HN43B05G0KCZ4MMC1G" + } + } + } + }, + "BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest": { + "type": "object", + "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", + "x-release-status": "PUBLIC", + "required": [ + "customer_id", + "custom_attribute" + ], + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the target [customer profile](entity:Customer).", + "minLength": 1 + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with following fields:\n\n- `key`. This key must match the `key` of a custom attribute definition in the Square seller \naccount. If the requesting application is not the definition owner, you must provide the qualified key.\n\n- `value`. This value must conform to the `schema` specified by the definition. \nFor more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types).\n\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol for update operations, include this optional field in the request and set the\nvalue to the current version of the custom attribute." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + } + }, + "BulkUpsertCustomerCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "x-release-status": "PUBLIC", + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse" + }, + "description": "A map of responses that correspond to individual upsert requests. Each response has the\nsame ID as the corresponding request and contains either a `customer_id` and `custom_attribute` or an `errors` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "values": { + "id1": { + "custom_attribute": { + "created_at": "2021-12-08T23:14:47Z", + "key": "favoritemovie", + "updated_at": "2021-12-09T00:16:23Z", + "value": "Dune", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8" + }, + "id2": { + "custom_attribute": { + "created_at": "2021-12-09T00:16:20Z", + "key": "ownsmovie", + "updated_at": "2021-12-09T00:16:23Z", + "value": false, + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM" + }, + "id3": { + "custom_attribute": { + "created_at": "2021-12-09T00:16:20Z", + "key": "favoritemovie", + "updated_at": "2021-12-09T00:16:23Z", + "value": "Star Wars", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM" + }, + "id4": { + "custom_attribute": { + "created_at": "2021-12-08T23:14:47Z", + "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808", + "updated_at": "2021-12-09T00:16:23Z", + "value": "10.5", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8" + }, + "id5": { + "custom_attribute": { + "created_at": "2021-12-09T00:16:20Z", + "key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail", + "updated_at": "2021-12-09T00:16:23Z", + "value": "fake-email@squareup.com", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "customer_id": "70548QG1HN43B05G0KCZ4MMC1G" + } + } + } + }, + "BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse": { + "type": "object", + "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) operation.", + "x-release-status": "PUBLIC", + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the customer profile associated with the custom attribute." + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred while processing the individual request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2021-12-08T23:14:47Z", + "key": "favoritemovie", + "updated_at": "2021-12-09T00:16:23Z", + "value": "Dune", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8" + } + }, + "BulkUpsertLocationCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) request.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest" + }, + "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the\ninformation needed to create or update a custom attribute." + } + }, + "example": { + "values": { + "id1": { + "custom_attribute": { + "key": "bestseller", + "value": "hot cocoa" + }, + "location_id": "L0TBCBTB7P8RQ" + }, + "id2": { + "custom_attribute": { + "key": "bestseller", + "value": "berry smoothie" + }, + "location_id": "L9XMD04V3STJX" + }, + "id3": { + "custom_attribute": { + "key": "phone-number", + "value": "+12223334444" + }, + "location_id": "L0TBCBTB7P8RQ" + } + } + } + }, + "BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest": { + "type": "object", + "description": "Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes)\nrequest. An individual request contains a location ID, the custom attribute to create or update,\nand an optional idempotency key.", + "x-release-status": "BETA", + "required": [ + "location_id", + "custom_attribute" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the target [location](entity:Location).", + "minLength": 1 + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with following fields:\n- `key`. This key must match the `key` of a custom attribute definition in the Square seller\naccount. If the requesting application is not the definition owner, you must provide the qualified key.\n- `value`. This value must conform to the `schema` specified by the definition.\nFor more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types)..\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, specify the current version of the custom attribute. \nIf this is not important for your application, `version` can be set to -1." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + } + }, + "BulkUpsertLocationCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "x-release-status": "BETA", + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse" + }, + "description": "A map of responses that correspond to individual upsert requests. Each response has the\nsame ID as the corresponding request and contains either a `location_id` and `custom_attribute` or an `errors` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "values": { + "id1": { + "custom_attribute": { + "created_at": "2023-01-09T19:02:58.647Z", + "key": "bestseller", + "updated_at": "2023-01-09T19:21:04.551Z", + "value": "hot cocoa", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "location_id": "L0TBCBTB7P8RQ" + }, + "id2": { + "custom_attribute": { + "created_at": "2023-01-09T19:02:58.647Z", + "key": "bestseller", + "updated_at": "2023-01-09T19:21:04.551Z", + "value": "berry smoothie", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "location_id": "L9XMD04V3STJX" + }, + "id3": { + "custom_attribute": { + "created_at": "2023-01-09T19:04:57.985Z", + "key": "phone-number", + "updated_at": "2023-01-09T19:21:04.563Z", + "value": "+12239903892", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "location_id": "L0TBCBTB7P8RQ" + } + } + } + }, + "BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse": { + "type": "object", + "description": "Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) operation.", + "x-release-status": "BETA", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location associated with the custom attribute." + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred while processing the individual request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2023-01-09T19:02:58.647Z", + "key": "bestseller", + "updated_at": "2023-01-09T19:21:04.551Z", + "value": "hot cocoa", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "location_id": "L0TBCBTB7P8RQ" + } + }, + "BulkUpsertMerchantCustomAttributesRequest": { + "type": "object", + "description": "Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) request.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest" + }, + "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the\ninformation needed to create or update a custom attribute." + } + }, + "example": { + "values": { + "id1": { + "custom_attribute": { + "key": "alternative_seller_name", + "value": "Ultimate Sneaker Store" + }, + "merchant_id": "DM7VKY8Q63GNP" + }, + "id2": { + "custom_attribute": { + "key": "has_seen_tutorial", + "value": true + }, + "merchant_id": "DM7VKY8Q63GNP" + } + } + } + }, + "BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest": { + "type": "object", + "description": "Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes)\nrequest. An individual request contains a merchant ID, the custom attribute to create or update,\nand an optional idempotency key.", + "x-release-status": "BETA", + "required": [ + "merchant_id", + "custom_attribute" + ], + "properties": { + "merchant_id": { + "type": "string", + "description": "The ID of the target [merchant](entity:Merchant).", + "minLength": 1 + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with following fields:\n- `key`. This key must match the `key` of a custom attribute definition in the Square seller\naccount. If the requesting application is not the definition owner, you must provide the qualified key.\n- `value`. This value must conform to the `schema` specified by the definition.\nFor more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).\n- The version field must match the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\nIf this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + } + }, + "BulkUpsertMerchantCustomAttributesResponse": { + "type": "object", + "description": "Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "x-release-status": "BETA", + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse" + }, + "description": "A map of responses that correspond to individual upsert requests. Each response has the\nsame ID as the corresponding request and contains either a `merchant_id` and `custom_attribute` or an `errors` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "values": { + "id1": { + "custom_attribute": { + "created_at": "2023-05-06T19:02:58.647Z", + "key": "alternative_seller_name", + "updated_at": "2023-05-06T19:21:04.551Z", + "value": "Ultimate Sneaker Store", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + }, + "merchant_id": "DM7VKY8Q63GNP" + }, + "id2": { + "custom_attribute": { + "created_at": "2023-05-06T19:02:58.647Z", + "key": "has_seen_tutorial", + "updated_at": "2023-05-06T19:21:04.551Z", + "value": true, + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "merchant_id": "DM7VKY8Q63GNP" + } + } + } + }, + "BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse": { + "type": "object", + "description": "Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) operation.", + "x-release-status": "BETA", + "properties": { + "merchant_id": { + "type": "string", + "description": "The ID of the merchant associated with the custom attribute." + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred while processing the individual request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2023-05-06T19:02:58.647Z", + "key": "alternative_seller_name", + "updated_at": "2023-05-06T19:21:04.551Z", + "value": "Ultimate Sneaker Store", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + }, + "merchant_id": "DM7VKY8Q63GNP" + } + }, + "BulkUpsertOrderCustomAttributesRequest": { + "type": "object", + "description": "Represents a bulk upsert request for one or more order custom attributes.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute" + }, + "description": "A map of requests that correspond to individual upsert operations for custom attributes." + } + }, + "example": { + "values": { + "cover-count": { + "custom_attribute": { + "key": "cover-count", + "value": "6", + "version": 2 + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F" + }, + "table-number": { + "custom_attribute": { + "key": "table-number", + "value": "11", + "version": 4 + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F" + } + } + } + }, + "BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute": { + "type": "object", + "description": "Represents one upsert within the bulk operation.", + "x-release-status": "BETA", + "required": [ + "custom_attribute", + "order_id" + ], + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with the following fields:\n\n- `value`. This value must conform to the `schema` specified by the definition. \nFor more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types).\n\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. \nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 45, + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the target [order](entity:Order).", + "minLength": 1, + "maxLength": 255 + } + } + }, + "BulkUpsertOrderCustomAttributesResponse": { + "type": "object", + "description": "Represents a response from a bulk upsert of order custom attributes.", + "x-release-status": "BETA", + "required": [ + "values" + ], + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UpsertOrderCustomAttributeResponse" + }, + "description": " A map of responses that correspond to individual upsert operations for custom attributes." + } + }, + "example": { + "values": { + "cover-count": { + "custom_attribute": { + "created_at": "2022-11-22T21:27:33.429Z", + "key": "cover-count", + "updated_at": "2022-11-22T21:28:35.721Z", + "value": "6", + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + }, + "table-number": { + "custom_attribute": { + "created_at": "2022-11-22T21:24:57.823Z", + "key": "table-number", + "updated_at": "2022-11-22T21:28:35.726Z", + "value": "11", + "visibility": "VISIBILITY_HIDDEN" + } + } + } + } + }, + "BusinessAppointmentSettings": { + "type": "object", + "description": "The service appointment settings, including where and how the service is provided.", + "x-release-status": "PUBLIC", + "properties": { + "location_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BusinessAppointmentSettingsBookingLocationType" + }, + "description": "Types of the location allowed for bookings.\nSee [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values", + "nullable": true + }, + "alignment_time": { + "$ref": "#/components/schemas/BusinessAppointmentSettingsAlignmentTime", + "description": "The time unit of the service duration for bookings.\nSee [BusinessAppointmentSettingsAlignmentTime](#type-businessappointmentsettingsalignmenttime) for possible values", + "nullable": true + }, + "min_booking_lead_time_seconds": { + "type": "integer", + "description": "The minimum lead time in seconds before a service can be booked. A booking must be created at least this amount of time before its starting time.", + "nullable": true + }, + "max_booking_lead_time_seconds": { + "type": "integer", + "description": "The maximum lead time in seconds before a service can be booked. A booking must be created at most this amount of time before its starting time.", + "nullable": true + }, + "any_team_member_booking_enabled": { + "type": "boolean", + "description": "Indicates whether a customer can choose from all available time slots and have a staff member assigned\nautomatically (`true`) or not (`false`).", + "nullable": true + }, + "multiple_service_booking_enabled": { + "type": "boolean", + "description": "Indicates whether a customer can book multiple services in a single online booking.", + "nullable": true + }, + "max_appointments_per_day_limit_type": { + "$ref": "#/components/schemas/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType", + "description": "Indicates whether the daily appointment limit applies to team members or to\nbusiness locations.\nSee [BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType](#type-businessappointmentsettingsmaxappointmentsperdaylimittype) for possible values", + "nullable": true + }, + "max_appointments_per_day_limit": { + "type": "integer", + "description": "The maximum number of daily appointments per team member or per location.", + "nullable": true + }, + "cancellation_window_seconds": { + "type": "integer", + "description": "The cut-off time in seconds for allowing clients to cancel or reschedule an appointment.", + "nullable": true + }, + "cancellation_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The flat-fee amount charged for a no-show booking.", + "nullable": true + }, + "cancellation_policy": { + "$ref": "#/components/schemas/BusinessAppointmentSettingsCancellationPolicy", + "description": "The cancellation policy adopted by the seller.\nSee [BusinessAppointmentSettingsCancellationPolicy](#type-businessappointmentsettingscancellationpolicy) for possible values", + "nullable": true + }, + "cancellation_policy_text": { + "type": "string", + "description": "The free-form text of the seller's cancellation policy.", + "maxLength": 65536, + "nullable": true + }, + "skip_booking_flow_staff_selection": { + "type": "boolean", + "description": "Indicates whether customers has an assigned staff member (`true`) or can select s staff member of their choice (`false`).", + "nullable": true + } + } + }, + "BusinessAppointmentSettingsAlignmentTime": { + "type": "string", + "enum": [ + "SERVICE_DURATION", + "QUARTER_HOURLY", + "HALF_HOURLY", + "HOURLY" + ], + "x-enum-elements": [ + { + "name": "SERVICE_DURATION", + "description": "The service duration unit is one visit of a fixed time interval specified by the seller." + }, + { + "name": "QUARTER_HOURLY", + "description": "The service duration unit is a 15-minute interval. Bookings can be scheduled every quarter hour." + }, + { + "name": "HALF_HOURLY", + "description": "The service duration unit is a 30-minute interval. Bookings can be scheduled every half hour." + }, + { + "name": "HOURLY", + "description": "The service duration unit is a 60-minute interval. Bookings can be scheduled every hour." + } + ], + "description": "Time units of a service duration for bookings.", + "x-release-status": "PUBLIC" + }, + "BusinessAppointmentSettingsBookingLocationType": { + "type": "string", + "enum": [ + "BUSINESS_LOCATION", + "CUSTOMER_LOCATION", + "PHONE" + ], + "x-enum-elements": [ + { + "name": "BUSINESS_LOCATION", + "description": "The service is provided at a seller location." + }, + { + "name": "CUSTOMER_LOCATION", + "description": "The service is provided at a customer location." + }, + { + "name": "PHONE", + "description": "The service is provided over the phone." + } + ], + "description": "Supported types of location where service is provided.", + "x-release-status": "PUBLIC" + }, + "BusinessAppointmentSettingsCancellationPolicy": { + "type": "string", + "enum": [ + "CANCELLATION_TREATED_AS_NO_SHOW", + "CUSTOM_POLICY" + ], + "x-enum-elements": [ + { + "name": "CANCELLATION_TREATED_AS_NO_SHOW", + "description": "Cancellations are treated as no shows and may incur a fee as specified by `cancellation_fee_money`." + }, + { + "name": "CUSTOM_POLICY", + "description": "Cancellations follow the seller-specified policy that is described in free-form text and not enforced automatically by Square." + } + ], + "description": "The category of the seller’s cancellation policy.", + "x-release-status": "PUBLIC" + }, + "BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType": { + "type": "string", + "enum": [ + "PER_TEAM_MEMBER", + "PER_LOCATION" + ], + "x-enum-elements": [ + { + "name": "PER_TEAM_MEMBER", + "description": "The maximum number of daily appointments is set on a per team member basis." + }, + { + "name": "PER_LOCATION", + "description": "The maximum number of daily appointments is set on a per location basis." + } + ], + "description": "Types of daily appointment limits.", + "x-release-status": "PUBLIC" + }, + "BusinessBookingProfile": { + "type": "object", + "description": "A seller's business booking profile, including booking policy, appointment settings, etc.", + "x-release-status": "PUBLIC", + "properties": { + "seller_id": { + "type": "string", + "description": "The ID of the seller, obtainable using the Merchants API.", + "maxLength": 32, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the booking's creation time.", + "readOnly": true + }, + "booking_enabled": { + "type": "boolean", + "description": "Indicates whether the seller is open for booking.", + "nullable": true + }, + "customer_timezone_choice": { + "$ref": "#/components/schemas/BusinessBookingProfileCustomerTimezoneChoice", + "description": "The choice of customer's time zone information of a booking.\nThe Square online booking site and all notifications to customers uses either the seller location’s time zone\nor the time zone the customer chooses at booking.\nSee [BusinessBookingProfileCustomerTimezoneChoice](#type-businessbookingprofilecustomertimezonechoice) for possible values", + "nullable": true + }, + "booking_policy": { + "$ref": "#/components/schemas/BusinessBookingProfileBookingPolicy", + "description": "The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`).\nSee [BusinessBookingProfileBookingPolicy](#type-businessbookingprofilebookingpolicy) for possible values", + "nullable": true + }, + "allow_user_cancel": { + "type": "boolean", + "description": "Indicates whether customers can cancel or reschedule their own bookings (`true`) or not (`false`).", + "nullable": true + }, + "business_appointment_settings": { + "$ref": "#/components/schemas/BusinessAppointmentSettings", + "description": "Settings for appointment-type bookings.", + "nullable": true + }, + "support_seller_level_writes": { + "type": "boolean", + "description": "Indicates whether the seller's subscription to Square Appointments supports creating, updating or canceling an appointment through the API (`true`) or not (`false`) using seller permission.", + "nullable": true + } + } + }, + "BusinessBookingProfileBookingPolicy": { + "type": "string", + "enum": [ + "ACCEPT_ALL", + "REQUIRES_ACCEPTANCE" + ], + "x-enum-elements": [ + { + "name": "ACCEPT_ALL", + "description": "The seller accepts all booking requests automatically." + }, + { + "name": "REQUIRES_ACCEPTANCE", + "description": "The seller must accept requests to complete bookings." + } + ], + "description": "Policies for accepting bookings.", + "x-release-status": "PUBLIC" + }, + "BusinessBookingProfileCustomerTimezoneChoice": { + "type": "string", + "enum": [ + "BUSINESS_LOCATION_TIMEZONE", + "CUSTOMER_CHOICE" + ], + "x-enum-elements": [ + { + "name": "BUSINESS_LOCATION_TIMEZONE", + "description": "Use the time zone of the business location for bookings." + }, + { + "name": "CUSTOMER_CHOICE", + "description": "Use the customer-chosen time zone for bookings." + } + ], + "description": "Choices of customer-facing time zone used for bookings.", + "x-release-status": "PUBLIC" + }, + "BusinessHours": { + "type": "object", + "description": "The hours of operation for a location.", + "x-release-status": "PUBLIC", + "properties": { + "periods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BusinessHoursPeriod" + }, + "description": "The list of time periods during which the business is open. There can be at most 10 periods per day.", + "nullable": true + } + } + }, + "BusinessHoursPeriod": { + "type": "object", + "description": "Represents a period of time during which a business location is open.", + "x-release-status": "PUBLIC", + "properties": { + "day_of_week": { + "$ref": "#/components/schemas/DayOfWeek", + "description": "The day of the week for this time period.\nSee [DayOfWeek](#type-dayofweek) for possible values", + "nullable": true + }, + "start_local_time": { + "type": "string", + "description": "The start time of a business hours period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", + "nullable": true + }, + "end_local_time": { + "type": "string", + "description": "The end time of a business hours period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", + "nullable": true + } + } + }, + "BuyNowPayLaterDetails": { + "type": "object", + "description": "Additional details about a Buy Now Pay Later payment type.", + "x-release-status": "PUBLIC", + "properties": { + "brand": { + "type": "string", + "description": "The brand used for the Buy Now Pay Later payment.\nThe brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`.", + "maxLength": 50, + "nullable": true + }, + "afterpay_details": { + "$ref": "#/components/schemas/AfterpayDetails", + "description": "Details about an Afterpay payment. These details are only populated if the `brand` is\n`AFTERPAY`.", + "nullable": true + }, + "clearpay_details": { + "$ref": "#/components/schemas/ClearpayDetails", + "description": "Details about a Clearpay payment. These details are only populated if the `brand` is\n`CLEARPAY`.", + "nullable": true + } + } + }, + "CalculateLoyaltyPointsRequest": { + "type": "object", + "description": "Represents a [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd", + "properties": { + "order_id": { + "type": "string", + "description": "The [order](entity:Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`.", + "nullable": true + }, + "transaction_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The purchase amount for which to calculate the points. \nSpecify this field if your application does not use the Orders API to process orders.\nOtherwise, specify the `order_id`.", + "nullable": true + }, + "loyalty_account_id": { + "type": "string", + "description": "The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion's\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit.", + "minLength": 1, + "maxLength": 36, + "nullable": true + } + }, + "example": { + "loyalty_account_id": "79b807d2-d786-46a9-933b-918028d7a8c5", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY" + } + }, + "CalculateLoyaltyPointsResponse": { + "type": "object", + "description": "Represents a [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "points": { + "type": "integer", + "description": "The number of points that the buyer can earn from the base loyalty program." + }, + "promotion_points": { + "type": "integer", + "description": "The number of points that the buyer can earn from a loyalty promotion. To be eligible\nto earn promotion points, the purchase must first qualify for program points. When `order_id`\nis not provided in the request, this value is always 0." + } + }, + "example": { + "points": 6, + "promotion_points": 12 + } + }, + "CalculateOrderRequest": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "order" + ], + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The order to be calculated. Expects the entire order, not a sparse update." + }, + "proposed_rewards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReward" + }, + "description": "Identifies one or more loyalty reward tiers to apply during the order calculation.\nThe discounts defined by the reward tiers are added to the order only to preview the\neffect of applying the specified rewards. The rewards do not correspond to actual\nredemptions; that is, no `reward`s are created. Therefore, the reward `id`s are\nrandom strings used only to reference the reward tier.", + "nullable": true + } + }, + "example": { + "idempotency_key": "b3e98fe3-b8de-471c-82f1-545f371e637c", + "order": { + "discounts": [ + { + "name": "50% Off", + "percentage": "50", + "scope": "ORDER" + } + ], + "line_items": [ + { + "base_price_money": { + "amount": 500, + "currency": "USD" + }, + "name": "Item 1", + "quantity": "1" + }, + { + "base_price_money": { + "amount": 300, + "currency": "USD" + }, + "name": "Item 2", + "quantity": "2" + } + ], + "location_id": "D7AVYMEAPJ3A3" + } + } + }, + "CalculateOrderResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The calculated version of the order provided in the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "order": { + "created_at": "2020-05-18T16:30:49.614Z", + "discounts": [ + { + "applied_money": { + "amount": 550, + "currency": "USD" + }, + "name": "50% Off", + "percentage": "50", + "scope": "ORDER", + "type": "FIXED_PERCENTAGE", + "uid": "zGsRZP69aqSSR9lq9euSPB" + } + ], + "line_items": [ + { + "applied_discounts": [ + { + "applied_money": { + "amount": 250, + "currency": "USD" + }, + "discount_uid": "zGsRZP69aqSSR9lq9euSPB", + "uid": "9zr9S4dxvPAixvn0lpa1VC" + } + ], + "base_price_money": { + "amount": 500, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 500, + "currency": "USD" + }, + "name": "Item 1", + "quantity": "1", + "total_discount_money": { + "amount": 250, + "currency": "USD" + }, + "total_money": { + "amount": 250, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "ULkg0tQTRK2bkU9fNv3IJD", + "variation_total_price_money": { + "amount": 500, + "currency": "USD" + } + }, + { + "applied_discounts": [ + { + "applied_money": { + "amount": 300, + "currency": "USD" + }, + "discount_uid": "zGsRZP69aqSSR9lq9euSPB", + "uid": "qa8LwwZK82FgSEkQc2HYVC" + } + ], + "base_price_money": { + "amount": 300, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 600, + "currency": "USD" + }, + "name": "Item 2", + "quantity": "2", + "total_discount_money": { + "amount": 300, + "currency": "USD" + }, + "total_money": { + "amount": 300, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "mumY8Nun4BC5aKe2yyx5a", + "variation_total_price_money": { + "amount": 600, + "currency": "USD" + } + } + ], + "location_id": "D7AVYMEAPJ3A3", + "net_amounts": { + "discount_money": { + "amount": 550, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 0, + "currency": "USD" + }, + "tip_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 550, + "currency": "USD" + } + }, + "state": "OPEN", + "total_discount_money": { + "amount": 550, + "currency": "USD" + }, + "total_money": { + "amount": 550, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "total_tip_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2020-05-18T16:30:49.614Z", + "version": 1 + } + } + }, + "CancelBookingRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique key to make this request an idempotent operation.", + "maxLength": 255, + "nullable": true + }, + "booking_version": { + "type": "integer", + "description": "The revision number for the booking used for optimistic concurrency.", + "nullable": true + } + } + }, + "CancelBookingResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "booking": { + "$ref": "#/components/schemas/Booking", + "description": "The booking that was cancelled." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "booking": { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "created_at": "2020-10-28T15:47:41Z", + "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M", + "customer_note": "", + "id": "zkras0xv0xwswx", + "location_id": "LEQHH0YY8B42M", + "seller_note": "", + "start_at": "2020-11-26T13:00:00Z", + "status": "CANCELLED_BY_CUSTOMER", + "updated_at": "2020-10-28T15:49:25Z", + "version": 1 + }, + "errors": [] + } + }, + "CancelInvoiceRequest": { + "type": "object", + "description": "Describes a `CancelInvoice` request.", + "x-release-status": "PUBLIC", + "required": [ + "version" + ], + "properties": { + "version": { + "type": "integer", + "description": "The version of the [invoice](entity:Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices)." + } + }, + "example": { + "version": 0 + } + }, + "CancelInvoiceResponse": { + "type": "object", + "description": "The response returned by the `CancelInvoice` request.", + "x-release-status": "PUBLIC", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The canceled invoice." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "invoice": { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "created_at": "2020-06-18T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1, + "status": "PENDING", + "uid": "beebd363-e47f-4075-8785-c235aaa7df11" + } + ], + "request_type": "BALANCE", + "tipping_enabled": true, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "CANCELED", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2020-06-18T18:23:11Z", + "version": 1 + } + } + }, + "CancelLoyaltyPromotionRequest": { + "type": "object", + "description": "Represents a [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id=loypromo_f0f9b849-725e-378d-b810-511237e07b67", + "properties": {}, + "example": {} + }, + "CancelLoyaltyPromotionResponse": { + "type": "object", + "description": "Represents a [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_promotion": { + "$ref": "#/components/schemas/LoyaltyPromotion", + "description": "The canceled loyalty promotion." + } + }, + "example": { + "loyalty_promotion": { + "available_time": { + "start_date": "2022-08-16", + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "canceled_at": "2022-08-17T12:42:49Z", + "created_at": "2022-08-16T08:38:54Z", + "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67", + "incentive": { + "points_multiplier_data": { + "multiplier": "3.000", + "points_multiplier": 3 + }, + "type": "POINTS_MULTIPLIER" + }, + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "minimum_spend_amount_money": { + "amount": 2000, + "currency": "USD" + }, + "name": "Tuesday Happy Hour Promo", + "qualifying_category_ids": [ + "XTQPYLR3IIU9C44VRCB3XD12" + ], + "status": "CANCELED", + "trigger_limit": { + "interval": "DAY", + "times": 1 + }, + "updated_at": "2022-08-17T12:42:49Z" + } + } + }, + "CancelPaymentByIdempotencyKeyRequest": { + "type": "object", + "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey).", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "The `idempotency_key` identifying the payment to be canceled.", + "minLength": 1, + "maxLength": 45 + } + }, + "example": { + "idempotency_key": "a7e36d40-d24b-11e8-b568-0800200c9a66" + } + }, + "CancelPaymentByIdempotencyKeyResponse": { + "type": "object", + "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey).\nOn success, `errors` is empty.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "CancelPaymentRequest": { + "type": "object", + "description": "Describes the request to cancel (void) a payment using\n[CancelPayment](api-endpoint:Payments-CancelPayment).\nYou can only cancel a payment that is approved (not completed).\nFor more information, see\n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "CancelPaymentResponse": { + "type": "object", + "description": "Defines the response returned by [CancelPayment](api-endpoint:Payments-CancelPayment).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "payment": { + "$ref": "#/components/schemas/Payment", + "description": "The successfully canceled `Payment` object." + } + }, + "example": { + "payment": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "application_details": { + "application_id": "sq0ids-TcgftTEtKxJTRF1lCFJ9TA", + "square_product": "ECOMMERCE_API" + }, + "approved_money": { + "amount": 1000, + "currency": "USD" + }, + "card_details": { + "auth_result_code": "68aLBM", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2021-10-13T20:26:44.364Z", + "voided_at": "2021-10-13T20:31:21.597Z" + }, + "cvv_status": "CVV_ACCEPTED", + "entry_method": "ON_FILE", + "statement_description": "SQ *EXAMPLE TEST GOSQ.C", + "status": "VOIDED" + }, + "created_at": "2021-10-13T20:26:44.191Z", + "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8", + "delay_action": "CANCEL", + "delay_duration": "PT168H", + "delayed_until": "2021-10-20T20:26:44.191Z", + "id": "1QjqpBVyrI9S4H9sTGDWU9JeiWdZY", + "location_id": "L88917AVBK2S5", + "note": "Example Note", + "order_id": "nUSN9TdxpiK3SrQg3wzmf6r8LP9YY", + "risk_evaluation": { + "created_at": "2021-10-13T20:26:45.271Z", + "risk_level": "NORMAL" + }, + "source_type": "CARD", + "status": "CANCELED", + "tip_money": { + "amount": 100, + "currency": "USD" + }, + "total_money": { + "amount": 1100, + "currency": "USD" + }, + "updated_at": "2021-10-13T20:31:21.597Z", + "version_token": "N8AGYgEjCiY9Q57Jw7aVHEpBq8bzGCDCQMRX8Vs56N06o" + } + } + }, + "CancelSubscriptionRequest": { + "type": "object", + "description": "Defines input parameters in a request to the \n[CancelSubscription](api-endpoint:Subscriptions-CancelSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "CancelSubscriptionResponse": { + "type": "object", + "description": "Defines output parameters in a response from the \n[CancelSubscription](api-endpoint:Subscriptions-CancelSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The specified subscription scheduled for cancellation according to the action created by the request." + }, + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAction" + }, + "description": "A list of a single `CANCEL` action scheduled for the subscription.", + "x-release-status": "BETA" + } + }, + "example": { + "subscription": { + "canceled_date": "2023-06-05", + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2022-01-19T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "910afd30-464a-4e00-a8d8-2296e", + "invoice_ids": [ + "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA" + ], + "location_id": "S8GWD5R9QB376", + "paid_until_date": "2023-12-31", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "source": { + "name": "My Application" + }, + "start_date": "2022-01-19", + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 3 + } + } + }, + "CancelTerminalActionRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "CancelTerminalActionResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "action": { + "$ref": "#/components/schemas/TerminalAction", + "description": "The canceled `TerminalAction`" + } + }, + "example": { + "action": { + "app_id": "APP_ID", + "cancel_reason": "SELLER_CANCELED", + "created_at": "2021-07-28T23:22:07.476Z", + "deadline_duration": "PT5M", + "device_id": "DEVICE_ID", + "id": "termapia:jveJIAkkAjILHkdCE", + "location_id": "LOCATION_ID", + "save_card_options": { + "customer_id": "CUSTOMER_ID", + "reference_id": "user-id-1" + }, + "status": "CANCELED", + "type": "SAVE_CARD", + "updated_at": "2021-07-28T23:22:29.511Z" + } + } + }, + "CancelTerminalCheckoutRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "CancelTerminalCheckoutResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "checkout": { + "$ref": "#/components/schemas/TerminalCheckout", + "description": "The canceled `TerminalCheckout`." + } + }, + "example": { + "checkout": { + "amount_money": { + "amount": 123, + "currency": "USD" + }, + "app_id": "APP_ID", + "cancel_reason": "SELLER_CANCELED", + "created_at": "2020-03-16T15:31:19.934Z", + "deadline_duration": "PT5M", + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", + "skip_receipt_screen": true, + "tip_settings": { + "allow_tipping": true + } + }, + "id": "S1yDlPQx7slqO", + "location_id": "LOCATION_ID", + "reference_id": "id36815", + "status": "CANCELED", + "updated_at": "2020-03-16T15:31:45.787Z" + } + } + }, + "CancelTerminalRefundRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "CancelTerminalRefundResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refund": { + "$ref": "#/components/schemas/TerminalRefund", + "description": "The updated `TerminalRefund`." + } + }, + "example": { + "refund": { + "amount_money": { + "amount": 100, + "currency": "CAD" + }, + "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ", + "cancel_reason": "SELLER_CANCELED", + "card": { + "bin": "411111", + "card_brand": "INTERAC", + "card_type": "CREDIT", + "exp_month": 1, + "exp_year": 2022, + "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw", + "last_4": "1111" + }, + "created_at": "2020-10-21T22:47:23.241Z", + "deadline_duration": "PT5M", + "device_id": "42690809-faa2-4701-a24b-19d3d34c9aaa", + "id": "g6ycb6HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "location_id": "76C9W6K8CNNQ5", + "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY", + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "reason": "reason", + "status": "CANCELED", + "updated_at": "2020-10-21T22:47:30.096Z" + } + } + }, + "CaptureTransactionRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CaptureTransaction/CaptureTransactionRequest.csharp", + "java": "/sdk_samples/CaptureTransaction/CaptureTransactionRequest.java", + "javascript": "/sdk_samples/CaptureTransaction/CaptureTransactionRequest.javascript", + "php": "/sdk_samples/CaptureTransaction/CaptureTransactionRequest.php", + "python": "/sdk_samples/CaptureTransaction/CaptureTransactionRequest.python", + "ruby": "/sdk_samples/CaptureTransaction/CaptureTransactionRequest.ruby" + } + }, + "CaptureTransactionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint.", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CaptureTransaction/CaptureTransactionResponse.csharp", + "java": "/sdk_samples/CaptureTransaction/CaptureTransactionResponse.java", + "javascript": "/sdk_samples/CaptureTransaction/CaptureTransactionResponse.javascript", + "php": "/sdk_samples/CaptureTransaction/CaptureTransactionResponse.php", + "python": "/sdk_samples/CaptureTransaction/CaptureTransactionResponse.python", + "ruby": "/sdk_samples/CaptureTransaction/CaptureTransactionResponse.ruby" + } + }, + "Card": { + "type": "object", + "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "Unique ID for this card. Generated by Square.", + "maxLength": 64, + "readOnly": true + }, + "card_brand": { + "$ref": "#/components/schemas/CardBrand", + "description": "The card's brand.\nSee [CardBrand](#type-cardbrand) for possible values", + "readOnly": true + }, + "last_4": { + "type": "string", + "description": "The last 4 digits of the card number.", + "maxLength": 4, + "readOnly": true + }, + "exp_month": { + "type": "integer", + "description": "The expiration month of the associated card as an integer between 1 and 12.", + "format": "int64", + "nullable": true + }, + "exp_year": { + "type": "integer", + "description": "The four-digit year of the card's expiration date.", + "format": "int64", + "nullable": true + }, + "cardholder_name": { + "type": "string", + "description": "The name of the cardholder.", + "maxLength": 96, + "nullable": true + }, + "billing_address": { + "$ref": "#/components/schemas/Address", + "description": "The billing address for this card. `US` postal codes can be provided as a 5-digit zip code\nor 9-digit ZIP+4 (example: `12345-6789`). For a full list of field meanings by country, see\n[Working with Addresses](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-addresses).", + "nullable": true + }, + "fingerprint": { + "type": "string", + "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", + "maxLength": 255, + "readOnly": true + }, + "customer_id": { + "type": "string", + "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", + "nullable": true + }, + "merchant_id": { + "type": "string", + "description": "The ID of the merchant associated with the card.", + "readOnly": true + }, + "reference_id": { + "type": "string", + "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", + "maxLength": 128, + "nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether or not a card can be used for payments.", + "readOnly": true + }, + "card_type": { + "$ref": "#/components/schemas/CardType", + "description": "The type of the card.\nThe Card object includes this field only in response to Payments API calls.\nSee [CardType](#type-cardtype) for possible values", + "readOnly": true + }, + "prepaid_type": { + "$ref": "#/components/schemas/CardPrepaidType", + "description": "Indicates whether the card is prepaid or not.\nSee [CardPrepaidType](#type-cardprepaidtype) for possible values", + "readOnly": true + }, + "bin": { + "type": "string", + "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", + "maxLength": 6, + "readOnly": true + }, + "version": { + "type": "integer", + "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", + "format": "int64" + }, + "card_co_brand": { + "$ref": "#/components/schemas/CardCoBrand", + "description": "The card's co-brand if available. For example, an Afterpay virtual card would have a\nco-brand of AFTERPAY.\nSee [CardCoBrand](#type-cardcobrand) for possible values", + "readOnly": true + }, + "issuer_alert": { + "$ref": "#/components/schemas/CardIssuerAlert", + "description": "An alert from the issuing bank about the card status. Alerts can indicate whether\nfuture charges to the card are likely to fail. For more information, see\n[Manage Card on File Declines](https://developer.squareup.com/docs/cards-api/manage-card-on-file-declines).\n\nThis field is present only if there's an active issuer alert.\nSee [IssuerAlert](#type-issueralert) for possible values", + "readOnly": true, + "x-release-status": "BETA" + }, + "issuer_alert_at": { + "type": "string", + "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there's an active issuer alert.", + "readOnly": true, + "x-release-status": "BETA" + }, + "hsa_fsa": { + "type": "boolean", + "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "CardBrand": { + "type": "string", + "enum": [ + "OTHER_BRAND", + "VISA", + "MASTERCARD", + "AMERICAN_EXPRESS", + "DISCOVER", + "DISCOVER_DINERS", + "JCB", + "CHINA_UNIONPAY", + "SQUARE_GIFT_CARD", + "SQUARE_CAPITAL_CARD", + "INTERAC", + "EFTPOS", + "FELICA", + "EBT" + ], + "x-enum-elements": [ + { + "name": "OTHER_BRAND", + "description": "" + }, + { + "name": "VISA", + "description": "" + }, + { + "name": "MASTERCARD", + "description": "" + }, + { + "name": "AMERICAN_EXPRESS", + "description": "" + }, + { + "name": "DISCOVER", + "description": "" + }, + { + "name": "DISCOVER_DINERS", + "description": "" + }, + { + "name": "JCB", + "description": "" + }, + { + "name": "CHINA_UNIONPAY", + "description": "" + }, + { + "name": "SQUARE_GIFT_CARD", + "description": "" + }, + { + "name": "SQUARE_CAPITAL_CARD", + "description": "" + }, + { + "name": "INTERAC", + "description": "" + }, + { + "name": "EFTPOS", + "description": "" + }, + { + "name": "FELICA", + "description": "" + }, + { + "name": "EBT", + "description": "" + } + ], + "description": "Indicates a card's brand, such as `VISA` or `MASTERCARD`.", + "x-release-status": "PUBLIC" + }, + "CardCoBrand": { + "type": "string", + "enum": [ + "UNKNOWN", + "AFTERPAY", + "CLEARPAY" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN", + "description": "" + }, + { + "name": "AFTERPAY", + "description": "" + }, + { + "name": "CLEARPAY", + "description": "" + } + ], + "description": "Indicates the brand for a co-branded card.", + "x-release-status": "PUBLIC" + }, + "CardIssuerAlert": { + "type": "string", + "enum": [ + "ISSUER_ALERT_CARD_CLOSED" + ], + "x-enum-elements": [ + { + "name": "ISSUER_ALERT_CARD_CLOSED", + "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail." + } + ], + "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", + "x-release-status": "BETA" + }, + "CardPaymentDetails": { + "type": "object", + "description": "Reflects the current status of a card payment. Contains only non-confidential information.", + "x-release-status": "PUBLIC", + "properties": { + "status": { + "type": "string", + "description": "The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or\nFAILED.", + "maxLength": 50, + "nullable": true + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "The credit card's non-confidential details.", + "nullable": true + }, + "entry_method": { + "type": "string", + "description": "The method used to enter the card's details for the payment. The method can be\n`KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.", + "maxLength": 50, + "nullable": true + }, + "cvv_status": { + "type": "string", + "description": "The status code returned from the Card Verification Value (CVV) check. The code can be\n`CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`.", + "maxLength": 50, + "nullable": true + }, + "avs_status": { + "type": "string", + "description": "The status code returned from the Address Verification System (AVS) check. The code can be\n`AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`.", + "maxLength": 50, + "nullable": true + }, + "auth_result_code": { + "type": "string", + "description": "The status code returned by the card issuer that describes the payment's\nauthorization status.", + "maxLength": 10, + "nullable": true + }, + "application_identifier": { + "type": "string", + "description": "For EMV payments, the application ID identifies the EMV application used for the payment.", + "maxLength": 32, + "nullable": true + }, + "application_name": { + "type": "string", + "description": "For EMV payments, the human-readable name of the EMV application used for the payment.", + "maxLength": 16, + "nullable": true + }, + "application_cryptogram": { + "type": "string", + "description": "For EMV payments, the cryptogram generated for the payment.", + "maxLength": 16, + "nullable": true + }, + "verification_method": { + "type": "string", + "description": "For EMV payments, the method used to verify the cardholder's identity. The method can be\n`PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`.", + "maxLength": 50, + "nullable": true + }, + "verification_results": { + "type": "string", + "description": "For EMV payments, the results of the cardholder verification. The result can be\n`SUCCESS`, `FAILURE`, or `UNKNOWN`.", + "maxLength": 50, + "nullable": true + }, + "statement_description": { + "type": "string", + "description": "The statement description sent to the card networks.\n\nNote: The actual statement description varies and is likely to be truncated and appended with\nadditional information on a per issuer basis.", + "maxLength": 50, + "nullable": true + }, + "device_details": { + "$ref": "#/components/schemas/DeviceDetails", + "description": "__Deprecated__: Use `Payment.device_details` instead.\n\nDetails about the device that took the payment.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "card_payment_timeline": { + "$ref": "#/components/schemas/CardPaymentTimeline", + "description": "The timeline for card payments.", + "nullable": true + }, + "refund_requires_card_presence": { + "type": "boolean", + "description": "Whether the card must be physically present for the payment to\nbe refunded. If set to `true`, the card must be present.", + "x-release-status": "BETA", + "nullable": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request.", + "nullable": true + } + } + }, + "CardPaymentTimeline": { + "type": "object", + "description": "The timeline for card payments.", + "x-release-status": "PUBLIC", + "properties": { + "authorized_at": { + "type": "string", + "description": "The timestamp when the payment was authorized, in RFC 3339 format.", + "nullable": true + }, + "captured_at": { + "type": "string", + "description": "The timestamp when the payment was captured, in RFC 3339 format.", + "nullable": true + }, + "voided_at": { + "type": "string", + "description": "The timestamp when the payment was voided, in RFC 3339 format.", + "nullable": true + } + } + }, + "CardPrepaidType": { + "type": "string", + "enum": [ + "UNKNOWN_PREPAID_TYPE", + "NOT_PREPAID", + "PREPAID" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN_PREPAID_TYPE", + "description": "" + }, + { + "name": "NOT_PREPAID", + "description": "" + }, + { + "name": "PREPAID", + "description": "" + } + ], + "description": "Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.", + "x-release-status": "PUBLIC" + }, + "CardType": { + "type": "string", + "enum": [ + "UNKNOWN_CARD_TYPE", + "CREDIT", + "DEBIT" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN_CARD_TYPE", + "description": "" + }, + { + "name": "CREDIT", + "description": "" + }, + { + "name": "DEBIT", + "description": "" + } + ], + "description": "Indicates a card's type, such as `CREDIT` or `DEBIT`.", + "x-release-status": "PUBLIC" + }, + "CashAppDetails": { + "type": "object", + "description": "Additional details about `WALLET` type payments with the `brand` of `CASH_APP`.", + "x-release-status": "PUBLIC", + "properties": { + "buyer_full_name": { + "type": "string", + "description": "The name of the Cash App account holder.", + "maxLength": 255, + "nullable": true + }, + "buyer_country_code": { + "type": "string", + "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](entity:Country).", + "minLength": 2, + "maxLength": 2, + "nullable": true + }, + "buyer_cashtag": { + "type": "string", + "description": "$Cashtag of the Cash App account holder.", + "minLength": 1, + "maxLength": 21, + "readOnly": true + } + } + }, + "CashDrawerDevice": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The device Square-issued ID" + }, + "name": { + "type": "string", + "description": "The device merchant-specified name.", + "nullable": true + } + } + }, + "CashDrawerEventType": { + "type": "string", + "enum": [ + "NO_SALE", + "CASH_TENDER_PAYMENT", + "OTHER_TENDER_PAYMENT", + "CASH_TENDER_CANCELLED_PAYMENT", + "OTHER_TENDER_CANCELLED_PAYMENT", + "CASH_TENDER_REFUND", + "OTHER_TENDER_REFUND", + "PAID_IN", + "PAID_OUT" + ], + "x-enum-elements": [ + { + "name": "NO_SALE", + "description": "Triggered when a no sale occurs on a cash drawer.\nA CashDrawerEvent of this type must have a zero money amount." + }, + { + "name": "CASH_TENDER_PAYMENT", + "description": "Triggered when a cash tender payment occurs on a cash drawer.\nA CashDrawerEvent of this type can must not have a negative amount." + }, + { + "name": "OTHER_TENDER_PAYMENT", + "description": "Triggered when a check, gift card, or other non-cash payment occurs\non a cash drawer.\nA CashDrawerEvent of this type must have a zero money amount." + }, + { + "name": "CASH_TENDER_CANCELLED_PAYMENT", + "description": "Triggered when a split tender bill is cancelled after cash has been\ntendered.\nA CASH_TENDER_CANCELLED_PAYMENT should have a corresponding CASH_TENDER_PAYMENT.\nA CashDrawerEvent of this type must not have a negative amount." + }, + { + "name": "OTHER_TENDER_CANCELLED_PAYMENT", + "description": "Triggered when a split tender bill is cancelled after a non-cash tender\nhas been tendered. An OTHER_TENDER_CANCELLED_PAYMENT should have a corresponding\nOTHER_TENDER_PAYMENT. A CashDrawerEvent of this type must have a zero money\namount." + }, + { + "name": "CASH_TENDER_REFUND", + "description": "Triggered when a cash tender refund occurs.\nA CashDrawerEvent of this type must not have a negative amount." + }, + { + "name": "OTHER_TENDER_REFUND", + "description": "Triggered when an other tender refund occurs.\nA CashDrawerEvent of this type must have a zero money amount." + }, + { + "name": "PAID_IN", + "description": "Triggered when money unrelated to a payment is added to the cash drawer.\nFor example, an employee adds coins to the drawer.\nA CashDrawerEvent of this type must not have a negative amount." + }, + { + "name": "PAID_OUT", + "description": "Triggered when money is removed from the drawer for other reasons\nthan making change.\nFor example, an employee pays a delivery person with cash from the cash drawer.\nA CashDrawerEvent of this type must not have a negative amount." + } + ], + "description": "The types of events on a CashDrawerShift.\nEach event type represents an employee action on the actual cash drawer\nrepresented by a CashDrawerShift.", + "x-release-status": "PUBLIC" + }, + "CashDrawerShift": { + "type": "object", + "description": "This model gives the details of a cash drawer shift.\nThe cash_payment_money, cash_refund_money, cash_paid_in_money,\nand cash_paid_out_money fields are all computed by summing their respective\nevent types.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The shift unique ID." + }, + "state": { + "$ref": "#/components/schemas/CashDrawerShiftState", + "description": "The shift current state.\nSee [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values", + "nullable": true + }, + "opened_at": { + "type": "string", + "description": "The time when the shift began, in ISO 8601 format.", + "nullable": true + }, + "ended_at": { + "type": "string", + "description": "The time when the shift ended, in ISO 8601 format.", + "nullable": true + }, + "closed_at": { + "type": "string", + "description": "The time when the shift was closed, in ISO 8601 format.", + "nullable": true + }, + "description": { + "type": "string", + "description": "The free-form text description of a cash drawer by an employee.", + "nullable": true + }, + "opened_cash_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money in the cash drawer at the start of the shift.\nThe amount must be greater than or equal to zero.", + "nullable": true + }, + "cash_payment_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money added to the cash drawer from cash payments.\nThis is computed by summing all events with the types CASH_TENDER_PAYMENT and\nCASH_TENDER_CANCELED_PAYMENT. The amount is always greater than or equal to\nzero.", + "nullable": true + }, + "cash_refunds_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money removed from the cash drawer from cash refunds.\nIt is computed by summing the events of type CASH_TENDER_REFUND. The amount\nis always greater than or equal to zero.", + "nullable": true + }, + "cash_paid_in_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money added to the cash drawer for reasons other than cash\npayments. It is computed by summing the events of type PAID_IN. The amount is\nalways greater than or equal to zero.", + "nullable": true + }, + "cash_paid_out_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money removed from the cash drawer for reasons other than\ncash refunds. It is computed by summing the events of type PAID_OUT. The amount\nis always greater than or equal to zero.", + "nullable": true + }, + "expected_cash_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money that should be in the cash drawer at the end of the\nshift, based on the shift's other money amounts.\nThis can be negative if employees have not correctly recorded all the events\non the cash drawer.\ncash_paid_out_money is a summation of amounts from cash_payment_money (zero\nor positive), cash_refunds_money (zero or negative), cash_paid_in_money (zero\nor positive), and cash_paid_out_money (zero or negative) event types.", + "nullable": true + }, + "closed_cash_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money found in the cash drawer at the end of the shift\nby an auditing employee. The amount should be positive.", + "nullable": true + }, + "device": { + "$ref": "#/components/schemas/CashDrawerDevice", + "description": "The device running Square Point of Sale that was connected to the cash drawer.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The shift start time in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The shift updated at time in RFC 3339 format.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location the cash drawer shift belongs to.", + "readOnly": true + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of all team members that were logged into Square Point of Sale at any\npoint while the cash drawer shift was open.", + "readOnly": true + }, + "opening_team_member_id": { + "type": "string", + "description": "The ID of the team member that started the cash drawer shift.", + "readOnly": true + }, + "ending_team_member_id": { + "type": "string", + "description": "The ID of the team member that ended the cash drawer shift.", + "readOnly": true + }, + "closing_team_member_id": { + "type": "string", + "description": "The ID of the team member that closed the cash drawer shift by auditing\nthe cash drawer contents.", + "readOnly": true + } + } + }, + "CashDrawerShiftEvent": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the event." + }, + "event_type": { + "$ref": "#/components/schemas/CashDrawerEventType", + "description": "The type of cash drawer shift event.\nSee [CashDrawerEventType](#type-cashdrawereventtype) for possible values", + "nullable": true + }, + "event_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money that was added to or removed from the cash drawer\nin the event. The amount can be positive (for added money)\nor zero (for other tender type payments). The addition or removal of money can be determined by\nby the event type.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The event time in RFC 3339 format.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "An optional description of the event, entered by the employee that\ncreated the event.", + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "The ID of the team member that created the event.", + "readOnly": true + } + } + }, + "CashDrawerShiftState": { + "type": "string", + "enum": [ + "OPEN", + "ENDED", + "CLOSED" + ], + "x-enum-elements": [ + { + "name": "OPEN", + "description": "An open cash drawer shift." + }, + { + "name": "ENDED", + "description": "A cash drawer shift that is ended but has not yet had an employee content audit." + }, + { + "name": "CLOSED", + "description": "An ended cash drawer shift that is closed with a completed employee\ncontent audit and recorded result." + } + ], + "description": "The current state of a cash drawer shift.", + "x-release-status": "PUBLIC" + }, + "CashDrawerShiftSummary": { + "type": "object", + "description": "The summary of a closed cash drawer shift.\nThis model contains only the money counted to start a cash drawer shift, counted\nat the end of the shift, and the amount that should be in the drawer at shift\nend based on summing all cash drawer shift events.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The shift unique ID." + }, + "state": { + "$ref": "#/components/schemas/CashDrawerShiftState", + "description": "The shift current state.\nSee [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values", + "nullable": true + }, + "opened_at": { + "type": "string", + "description": "The shift start time in ISO 8601 format.", + "nullable": true + }, + "ended_at": { + "type": "string", + "description": "The shift end time in ISO 8601 format.", + "nullable": true + }, + "closed_at": { + "type": "string", + "description": "The shift close time in ISO 8601 format.", + "nullable": true + }, + "description": { + "type": "string", + "description": "An employee free-text description of a cash drawer shift.", + "nullable": true + }, + "opened_cash_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money in the cash drawer at the start of the shift. This\nmust be a positive amount.", + "nullable": true + }, + "expected_cash_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money that should be in the cash drawer at the end of the\nshift, based on the cash drawer events on the shift.\nThe amount is correct if all shift employees accurately recorded their\ncash drawer shift events. Unrecorded events and events with the wrong amount\nresult in an incorrect expected_cash_money amount that can be negative.", + "nullable": true + }, + "closed_cash_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money found in the cash drawer at the end of the shift by\nan auditing employee. The amount must be greater than or equal to zero.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The shift start time in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The shift updated at time in RFC 3339 format.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location the cash drawer shift belongs to.", + "readOnly": true + } + } + }, + "CashPaymentDetails": { + "type": "object", + "description": "Stores details about a cash payment. Contains only non-confidential information. For more information, see \n[Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments).", + "x-release-status": "PUBLIC", + "required": [ + "buyer_supplied_money" + ], + "properties": { + "buyer_supplied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount and currency of the money supplied by the buyer." + }, + "change_back_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of change due back to the buyer. \nThis read-only field is calculated\nfrom the `amount_money` and `buyer_supplied_money` fields.", + "nullable": true + } + } + }, + "CatalogAvailabilityPeriod": { + "type": "object", + "description": "Represents a time period of availability.", + "x-release-status": "BETA", + "properties": { + "start_local_time": { + "type": "string", + "description": "The start time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", + "nullable": true + }, + "end_local_time": { + "type": "string", + "description": "The end time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", + "nullable": true + }, + "day_of_week": { + "$ref": "#/components/schemas/DayOfWeek", + "description": "The day of the week for this availability period.\nSee [DayOfWeek](#type-dayofweek) for possible values", + "nullable": true + } + } + }, + "CatalogCategory": { + "type": "object", + "description": "A category to which a `CatalogItem` instance belongs.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", + "maxLength": 255, + "nullable": true + }, + "image_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of images associated with this `CatalogCategory` instance.\nCurrently these images are not displayed by Square, but are free to be displayed in 3rd party applications.", + "nullable": true + }, + "category_type": { + "$ref": "#/components/schemas/CatalogCategoryType", + "description": "The type of the category.\nSee [CatalogCategoryType](#type-catalogcategorytype) for possible values", + "nullable": true + }, + "parent_category": { + "$ref": "#/components/schemas/CatalogObjectCategory", + "description": "The ID of the parent category of this category instance.", + "nullable": true + }, + "is_top_level": { + "type": "boolean", + "description": "Indicates whether a category is a top level category, which does not have any parent_category.", + "nullable": true + }, + "channels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of IDs representing channels, such as a Square Online site, where the category can be made visible.", + "nullable": true + }, + "availability_period_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the `CatalogAvailabilityPeriod` objects associated with the category.", + "nullable": true + }, + "online_visibility": { + "type": "boolean", + "description": "Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites.", + "nullable": true + }, + "root_category": { + "type": "string", + "description": "The top-level category in a category hierarchy.", + "readOnly": true + }, + "ecom_seo_data": { + "$ref": "#/components/schemas/CatalogEcomSeoData", + "description": "The SEO data for a seller's Square Online store.", + "nullable": true + }, + "path_to_root": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CategoryPathToRootNode" + }, + "description": "The path from the category to its root category. The first node of the path is the parent of the category\nand the last is the root category. The path is empty if the category is a root category.", + "nullable": true + } + }, + "example": { + "object": { + "category_data": { + "name": "Beverages" + }, + "id": "#Beverages", + "present_at_all_locations": true, + "type": "CATEGORY" + } + } + }, + "CatalogCategoryType": { + "type": "string", + "enum": [ + "REGULAR_CATEGORY", + "MENU_CATEGORY", + "KITCHEN_CATEGORY" + ], + "x-enum-elements": [ + { + "name": "REGULAR_CATEGORY", + "description": "The regular category." + }, + { + "name": "MENU_CATEGORY", + "description": "The menu category." + }, + { + "name": "KITCHEN_CATEGORY", + "description": "Kitchen categories are used by KDS (Kitchen Display System) to route items to specific clients" + } + ], + "description": "Indicates the type of a category.", + "x-release-status": "PUBLIC" + }, + "CatalogCustomAttributeDefinition": { + "type": "object", + "description": "Contains information defining a custom attribute. Custom attributes are\nintended to store additional information about a catalog object or to associate a\ncatalog object with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes)", + "x-release-status": "PUBLIC", + "required": [ + "type", + "name", + "allowed_object_types" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionType", + "description": "The type of this custom attribute. Cannot be modified after creation.\nRequired.\nSee [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values" + }, + "name": { + "type": "string", + "description": " The name of this definition for API and seller-facing UI purposes.\nThe name must be unique within the (merchant, application) pair. Required.\nMay not be empty and may not exceed 255 characters. Can be modified after creation.", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "description": "Seller-oriented description of the meaning of this Custom Attribute,\nany constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.", + "maxLength": 255, + "nullable": true + }, + "source_application": { + "$ref": "#/components/schemas/SourceApplication", + "description": "__Read only.__ Contains information about the application that\ncreated this custom attribute definition.", + "nullable": true + }, + "allowed_object_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObjectType" + }, + "description": "The set of `CatalogObject` types that this custom atttribute may be applied to.\nCurrently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included.\nSee [CatalogObjectType](#type-catalogobjecttype) for possible values" + }, + "seller_visibility": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionSellerVisibility", + "description": "The visibility of a custom attribute in seller-facing UIs (including Square Point\nof Sale applications and Square Dashboard). May be modified.\nSee [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) for possible values", + "nullable": true + }, + "app_visibility": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionAppVisibility", + "description": "The visibility of a custom attribute to applications other than the application\nthat created the attribute.\nSee [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) for possible values", + "nullable": true + }, + "string_config": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionStringConfig", + "description": "Optionally, populated when `type` = `STRING`, unset otherwise.", + "nullable": true + }, + "number_config": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionNumberConfig", + "description": "Optionally, populated when `type` = `NUMBER`, unset otherwise.", + "nullable": true + }, + "selection_config": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionSelectionConfig", + "description": "Populated when `type` is set to `SELECTION`, unset otherwise.", + "nullable": true + }, + "custom_attribute_usage_count": { + "type": "integer", + "description": "The number of custom attributes that reference this\ncustom attribute definition. Set by the server in response to a ListCatalog\nrequest with `include_counts` set to `true`. If the actual count is greater\nthan 100, `custom_attribute_usage_count` will be set to `100`.", + "readOnly": true + }, + "key": { + "type": "string", + "description": "The name of the desired custom attribute key that can be used to access\nthe custom attribute value on catalog objects. Cannot be modified after the\ncustom attribute definition has been created.\nMust be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`.", + "minLength": 1, + "maxLength": 60, + "pattern": "^[a-zA-Z0-9_-]*$", + "nullable": true + } + } + }, + "CatalogCustomAttributeDefinitionAppVisibility": { + "type": "string", + "enum": [ + "APP_VISIBILITY_HIDDEN", + "APP_VISIBILITY_READ_ONLY", + "APP_VISIBILITY_READ_WRITE_VALUES" + ], + "x-enum-elements": [ + { + "name": "APP_VISIBILITY_HIDDEN", + "description": "Other applications cannot read this custom attribute." + }, + { + "name": "APP_VISIBILITY_READ_ONLY", + "description": "Other applications can read this custom attribute definition and\nvalues." + }, + { + "name": "APP_VISIBILITY_READ_WRITE_VALUES", + "description": "Other applications can read and write custom attribute values on objects.\nThey can read but cannot edit the custom attribute definition." + } + ], + "description": "Defines the visibility of a custom attribute to applications other than their\ncreating application.", + "x-release-status": "PUBLIC" + }, + "CatalogCustomAttributeDefinitionNumberConfig": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "precision": { + "type": "integer", + "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in number custom attribute values\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 5", + "maximum": 5, + "nullable": true + } + } + }, + "CatalogCustomAttributeDefinitionSelectionConfig": { + "type": "object", + "description": "Configuration associated with `SELECTION`-type custom attribute definitions.", + "x-release-status": "PUBLIC", + "properties": { + "max_allowed_selections": { + "type": "integer", + "description": "The maximum number of selections that can be set. The maximum value for this\nattribute is 100. The default value is 1. The value can be modified, but changing the value will not\naffect existing custom attribute values on objects. Clients need to\nhandle custom attributes with more selected values than allowed by this limit.", + "maximum": 100, + "nullable": true + }, + "allowed_selections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection" + }, + "description": "The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100\nselections can be defined. Can be modified.", + "nullable": true + } + } + }, + "CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection": { + "type": "object", + "description": "A named selection for this `SELECTION`-type custom attribute definition.", + "x-release-status": "PUBLIC", + "required": [ + "name" + ], + "properties": { + "uid": { + "type": "string", + "description": "Unique ID set by Square.", + "nullable": true + }, + "name": { + "type": "string", + "description": "Selection name, unique within `allowed_selections`.", + "minLength": 1, + "maxLength": 255 + } + } + }, + "CatalogCustomAttributeDefinitionSellerVisibility": { + "type": "string", + "enum": [ + "SELLER_VISIBILITY_HIDDEN", + "SELLER_VISIBILITY_READ_WRITE_VALUES" + ], + "x-enum-elements": [ + { + "name": "SELLER_VISIBILITY_HIDDEN", + "description": "Sellers cannot read this custom attribute in Square client\napplications or Square APIs." + }, + { + "name": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "description": "Sellers can read and write this custom attribute value in catalog objects,\nbut cannot edit the custom attribute definition." + } + ], + "description": "Defines the visibility of a custom attribute to sellers in Square\nclient applications, Square APIs or in Square UIs (including Square Point\nof Sale applications and Square Dashboard).", + "x-release-status": "PUBLIC" + }, + "CatalogCustomAttributeDefinitionStringConfig": { + "type": "object", + "description": "Configuration associated with Custom Attribute Definitions of type `STRING`.", + "x-release-status": "PUBLIC", + "properties": { + "enforce_uniqueness": { + "type": "boolean", + "description": "If true, each Custom Attribute instance associated with this Custom Attribute\nDefinition must have a unique value within the seller's catalog. For\nexample, this may be used for a value like a SKU that should not be\nduplicated within a seller's catalog. May not be modified after the\ndefinition has been created.", + "nullable": true + } + } + }, + "CatalogCustomAttributeDefinitionType": { + "type": "string", + "enum": [ + "STRING", + "BOOLEAN", + "NUMBER", + "SELECTION" + ], + "x-enum-elements": [ + { + "name": "STRING", + "description": "A free-form string containing up to 255 characters." + }, + { + "name": "BOOLEAN", + "description": "A `true` or `false` value." + }, + { + "name": "NUMBER", + "description": "A decimal string representation of a number. Can support up to 5 digits after the decimal point." + }, + { + "name": "SELECTION", + "description": "One or more choices from `allowed_selections`." + } + ], + "description": "Defines the possible types for a custom attribute.", + "x-release-status": "PUBLIC" + }, + "CatalogCustomAttributeValue": { + "type": "object", + "description": "An instance of a custom attribute. Custom attributes can be defined and\nadded to `ITEM` and `ITEM_VARIATION` type catalog objects.\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes).", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom attribute.", + "nullable": true + }, + "string_value": { + "type": "string", + "description": "The string value of the custom attribute. Populated if `type` = `STRING`.", + "nullable": true + }, + "custom_attribute_definition_id": { + "type": "string", + "description": "The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to.", + "readOnly": true + }, + "type": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinitionType", + "description": "A copy of type from the associated `CatalogCustomAttributeDefinition`.\nSee [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values", + "readOnly": true + }, + "number_value": { + "type": "string", + "description": "Populated if `type` = `NUMBER`. Contains a string\nrepresentation of a decimal number, using a `.` as the decimal separator.", + "nullable": true + }, + "boolean_value": { + "type": "boolean", + "description": "A `true` or `false` value. Populated if `type` = `BOOLEAN`.", + "nullable": true + }, + "selection_uid_values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.", + "nullable": true + }, + "key": { + "type": "string", + "description": "If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID.\nFor example, if the CatalogCustomAttributeDefinition has a key attribute of \"cocoa_brand\" and the defining application ID is \"abcd1234\", this key is \"abcd1234:cocoa_brand\"\nwhen the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply \"cocoa_brand\".", + "readOnly": true + } + } + }, + "CatalogDiscount": { + "type": "object", + "description": "A discount applicable to items.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", + "maxLength": 255, + "nullable": true + }, + "discount_type": { + "$ref": "#/components/schemas/CatalogDiscountType", + "description": "Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale.\nSee [CatalogDiscountType](#type-catalogdiscounttype) for possible values", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal\nseparator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type`\nis `VARIABLE_PERCENTAGE`.\n\nDo not use this field for amount-based or variable discounts.", + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`.\n\nDo not use this field for percentage-based or variable discounts.", + "nullable": true + }, + "pin_required": { + "type": "boolean", + "description": "Indicates whether a mobile staff member needs to enter their PIN to apply the\ndiscount to a payment in the Square Point of Sale app.", + "nullable": true + }, + "label_color": { + "type": "string", + "description": "The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.", + "nullable": true + }, + "modify_tax_basis": { + "$ref": "#/components/schemas/CatalogDiscountModifyTaxBasis", + "description": "Indicates whether this discount should reduce the price used to calculate tax.\n\nMost discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must\nbe calculated based on an item's price, ignoring a particular discount. For example,\nin many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a\ncustomer pays but does not reduce the sale price used to calculate how much sales tax is\ndue. In this case, the discount representing that manufacturer coupon should have\n`DO_NOT_MODIFY_TAX_BASIS` for this field.\n\nIf you are unsure whether you need to use this field, consult your tax professional.\nSee [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values", + "nullable": true + }, + "maximum_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "For a percentage discount, the maximum absolute value of the discount. For example, if a\n50% discount has a `maximum_amount_money` of $20, a $100 purchase will yield a $20 discount,\nnot a $50 discount.", + "nullable": true + } + }, + "example": { + "object": { + "discount_data": { + "discount_type": "FIXED_PERCENTAGE", + "label_color": "red", + "name": "Welcome to the Dark(Roast) Side!", + "percentage": "5.4", + "pin_required": false + }, + "id": "#Maythe4th", + "present_at_all_locations": true, + "type": "DISCOUNT" + } + } + }, + "CatalogDiscountModifyTaxBasis": { + "type": "string", + "enum": [ + "MODIFY_TAX_BASIS", + "DO_NOT_MODIFY_TAX_BASIS" + ], + "x-enum-elements": [ + { + "name": "MODIFY_TAX_BASIS", + "description": "Application of the discount will modify the tax basis." + }, + { + "name": "DO_NOT_MODIFY_TAX_BASIS", + "description": "Application of the discount will not modify the tax basis." + } + ], + "x-release-status": "PUBLIC" + }, + "CatalogDiscountType": { + "type": "string", + "enum": [ + "FIXED_PERCENTAGE", + "FIXED_AMOUNT", + "VARIABLE_PERCENTAGE", + "VARIABLE_AMOUNT" + ], + "x-enum-elements": [ + { + "name": "FIXED_PERCENTAGE", + "description": "Apply the discount as a fixed percentage (e.g., 5%) off the item price." + }, + { + "name": "FIXED_AMOUNT", + "description": "Apply the discount as a fixed amount (e.g., $1.00) off the item price." + }, + { + "name": "VARIABLE_PERCENTAGE", + "description": "Apply the discount as a variable percentage off the item price. The percentage will be specified at the time of sale." + }, + { + "name": "VARIABLE_AMOUNT", + "description": "Apply the discount as a variable amount off the item price. The amount will be specified at the time of sale." + } + ], + "description": "How to apply a CatalogDiscount to a CatalogItem.", + "x-release-status": "PUBLIC" + }, + "CatalogEcomSeoData": { + "type": "object", + "description": "SEO data for for a seller's Square Online store.", + "x-release-status": "PUBLIC", + "properties": { + "page_title": { + "type": "string", + "description": "The SEO title used for the Square Online store.", + "nullable": true + }, + "page_description": { + "type": "string", + "description": "The SEO description used for the Square Online store.", + "nullable": true + }, + "permalink": { + "type": "string", + "description": "The SEO permalink used for the Square Online store.", + "nullable": true + } + } + }, + "CatalogIdMapping": { + "type": "object", + "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](api-endpoint:Catalog-UpsertCatalogObject) or\n[BatchUpsertCatalogObjects](api-endpoint:Catalog-BatchUpsertCatalogObjects) to\ncreate a [CatalogObject](entity:CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", + "x-release-status": "PUBLIC", + "properties": { + "client_object_id": { + "type": "string", + "description": "The client-supplied temporary `#`-prefixed ID for a new `CatalogObject`.", + "nullable": true + }, + "object_id": { + "type": "string", + "description": "The permanent ID for the CatalogObject created by the server.", + "nullable": true + } + } + }, + "CatalogImage": { + "type": "object", + "description": "An image file to use in Square catalogs. It can be associated with\n`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects.\nOnly the images on items and item variations are exposed in Dashboard.\nOnly the first image on an item is displayed in Square Point of Sale (SPOS).\nImages on items and variations are displayed through Square Online Store.\nImages on other object types are for use by 3rd party application developers.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).\nIt is not unique and should not be shown in a buyer facing context.", + "nullable": true + }, + "url": { + "type": "string", + "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.", + "nullable": true + }, + "caption": { + "type": "string", + "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).", + "nullable": true + }, + "photo_studio_order_id": { + "type": "string", + "description": "The immutable order ID for this image object created by the Photo Studio service in Square Online Store.", + "nullable": true + } + } + }, + "CatalogInfoRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.csharp", + "java": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.java", + "javascript": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.javascript", + "php": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.php", + "python": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.python", + "ruby": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.ruby" + } + }, + "CatalogInfoResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "limits": { + "$ref": "#/components/schemas/CatalogInfoResponseLimits", + "description": "Limits that apply to this API." + }, + "standard_unit_description_group": { + "$ref": "#/components/schemas/StandardUnitDescriptionGroup", + "description": "Names and abbreviations for standard units." + } + }, + "example": { + "limits": { + "batch_delete_max_object_ids": 200, + "batch_retrieve_max_object_ids": 1000, + "batch_upsert_max_objects_per_batch": 1000, + "batch_upsert_max_total_objects": 10000, + "search_max_page_limit": 1000, + "update_item_modifier_lists_max_item_ids": 1000, + "update_item_modifier_lists_max_modifier_lists_to_disable": 1000, + "update_item_modifier_lists_max_modifier_lists_to_enable": 1000, + "update_item_taxes_max_item_ids": 1000, + "update_item_taxes_max_taxes_to_disable": 1000, + "update_item_taxes_max_taxes_to_enable": 1000 + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.csharp", + "java": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.java", + "javascript": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.javascript", + "php": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.php", + "python": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.python", + "ruby": "/sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.ruby" + } + }, + "CatalogInfoResponseLimits": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "batch_upsert_max_objects_per_batch": { + "type": "integer", + "description": "The maximum number of objects that may appear within a single batch in a\n`/v2/catalog/batch-upsert` request.", + "nullable": true + }, + "batch_upsert_max_total_objects": { + "type": "integer", + "description": "The maximum number of objects that may appear across all batches in a\n`/v2/catalog/batch-upsert` request.", + "nullable": true + }, + "batch_retrieve_max_object_ids": { + "type": "integer", + "description": "The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve`\nrequest.", + "nullable": true + }, + "search_max_page_limit": { + "type": "integer", + "description": "The maximum number of results that may be returned in a page of a\n`/v2/catalog/search` response.", + "nullable": true + }, + "batch_delete_max_object_ids": { + "type": "integer", + "description": "The maximum number of object IDs that may be included in a single\n`/v2/catalog/batch-delete` request.", + "nullable": true + }, + "update_item_taxes_max_item_ids": { + "type": "integer", + "description": "The maximum number of item IDs that may be included in a single\n`/v2/catalog/update-item-taxes` request.", + "nullable": true + }, + "update_item_taxes_max_taxes_to_enable": { + "type": "integer", + "description": "The maximum number of tax IDs to be enabled that may be included in a single\n`/v2/catalog/update-item-taxes` request.", + "nullable": true + }, + "update_item_taxes_max_taxes_to_disable": { + "type": "integer", + "description": "The maximum number of tax IDs to be disabled that may be included in a single\n`/v2/catalog/update-item-taxes` request.", + "nullable": true + }, + "update_item_modifier_lists_max_item_ids": { + "type": "integer", + "description": "The maximum number of item IDs that may be included in a single\n`/v2/catalog/update-item-modifier-lists` request.", + "nullable": true + }, + "update_item_modifier_lists_max_modifier_lists_to_enable": { + "type": "integer", + "description": "The maximum number of modifier list IDs to be enabled that may be included in\na single `/v2/catalog/update-item-modifier-lists` request.", + "nullable": true + }, + "update_item_modifier_lists_max_modifier_lists_to_disable": { + "type": "integer", + "description": "The maximum number of modifier list IDs to be disabled that may be included in\na single `/v2/catalog/update-item-modifier-lists` request.", + "nullable": true + } + } + }, + "CatalogItem": { + "type": "object", + "description": "A [CatalogObject](entity:CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.", + "maxLength": 512, + "nullable": true + }, + "description": { + "type": "string", + "description": "The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", + "maxLength": 4096, + "x-release-status": "DEPRECATED", + "nullable": true + }, + "abbreviation": { + "type": "string", + "description": "The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.\nThis attribute is searchable, and its value length is of Unicode code points.", + "maxLength": 24, + "nullable": true + }, + "label_color": { + "type": "string", + "description": "The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.", + "nullable": true + }, + "is_taxable": { + "type": "boolean", + "description": "Indicates whether the item is taxable (`true`) or non-taxable (`false`). Default is `true`.", + "nullable": true + }, + "category_id": { + "type": "string", + "description": "The ID of the item's category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "tax_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of IDs indicating the taxes enabled for\nthis item. When updating an item, any taxes listed here will be added to the item.\nTaxes may also be added to or deleted from an item using `UpdateItemTaxes`.", + "nullable": true + }, + "modifier_list_info": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogItemModifierListInfo" + }, + "description": "A set of `CatalogItemModifierListInfo` objects\nrepresenting the modifier lists that apply to this item, along with the overrides and min\nand max limits that are specific to this item. Modifier lists\nmay also be added to or deleted from an item using `UpdateItemModifierLists`.", + "nullable": true + }, + "variations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have\nat least one variation.", + "nullable": true + }, + "product_type": { + "$ref": "#/components/schemas/CatalogItemProductType", + "description": "The product type of the item. Once set, the `product_type` value cannot be modified.\n\nItems of the `LEGACY_SQUARE_ONLINE_SERVICE` and `LEGACY_SQUARE_ONLINE_MEMBERSHIP` product types can be updated\nbut cannot be created using the API.\nSee [CatalogItemProductType](#type-catalogitemproducttype) for possible values", + "nullable": true + }, + "skip_modifier_screen": { + "type": "boolean", + "description": "If `false`, the Square Point of Sale app will present the `CatalogItem`'s\ndetails screen immediately, allowing the merchant to choose `CatalogModifier`s\nbefore adding the item to the cart. This is the default behavior.\n\nIf `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected\nmodifiers, and merchants can edit modifiers by drilling down onto the item's details.\n\nThird-party clients are encouraged to implement similar behaviors.", + "nullable": true + }, + "item_options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogItemOptionForItem" + }, + "description": "List of item options IDs for this item. Used to manage and group item\nvariations in a specified order.\n\nMaximum: 6 item options.", + "nullable": true + }, + "ecom_uri": { + "type": "string", + "description": "Deprecated; see go/ecomUriUseCases. A URI pointing to a published e-commerce product page for the Item.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "ecom_image_uris": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Deprecated; see go/ecomUriUseCases. A comma-separated list of encoded URIs pointing to a set of published e-commerce images for the Item.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "image_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of images associated with this `CatalogItem` instance.\nThese images will be shown to customers in Square Online Store.\nThe first image will show up as the icon for this item in POS.", + "x-release-status": "BETA", + "nullable": true + }, + "sort_name": { + "type": "string", + "description": "A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting.\nIts value must not be empty.\n\nIt is currently supported for sellers of the Japanese locale only.", + "x-release-status": "BETA", + "nullable": true + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObjectCategory" + }, + "description": "The list of categories.", + "nullable": true + }, + "description_html": { + "type": "string", + "description": "The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags,\nis of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or\nunsupported HTML elements or attributes are ignored.\n\nSupported HTML elements include:\n- `a`: Link. Supports linking to website URLs, email address, and telephone numbers.\n- `b`, `strong`: Bold text\n- `br`: Line break\n- `code`: Computer code\n- `div`: Section\n- `h1-h6`: Headings\n- `i`, `em`: Italics\n- `li`: List element\n- `ol`: Numbered list\n- `p`: Paragraph\n- `ul`: Bullet list\n- `u`: Underline\n\n\nSupported HTML attributes include:\n- `align`: Alignment of the text content\n- `href`: Link destination\n- `rel`: Relationship between link's target and source\n- `target`: Place to open the linked document", + "maxLength": 65535, + "nullable": true + }, + "description_plaintext": { + "type": "string", + "description": "A server-generated plaintext version of the `description_html` field, without formatting tags.", + "maxLength": 65535, + "readOnly": true + }, + "channels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available.\nThis field is read only and cannot be edited.", + "nullable": true + }, + "is_archived": { + "type": "boolean", + "description": "Indicates whether this item is archived (`true`) or not (`false`).", + "nullable": true + }, + "ecom_seo_data": { + "$ref": "#/components/schemas/CatalogEcomSeoData", + "description": "The SEO data for a seller's Square Online store.", + "nullable": true + }, + "food_and_beverage_details": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetails", + "description": "The food and beverage-specific details for the `FOOD_AND_BEV` item.", + "nullable": true + }, + "reporting_category": { + "$ref": "#/components/schemas/CatalogObjectCategory", + "description": "The item's reporting category.", + "nullable": true + }, + "is_alcoholic": { + "type": "boolean", + "description": "Indicates whether this item is alcoholic (`true`) or not (`false`).", + "nullable": true + } + }, + "example": { + "object": { + "id": "#Cocoa", + "item_data": { + "abbreviation": "Ch", + "description": "Hot chocolate", + "name": "Cocoa", + "visibility": "PRIVATE" + }, + "present_at_all_locations": true, + "type": "ITEM" + } + } + }, + "CatalogItemFoodAndBeverageDetails": { + "type": "object", + "description": "The food and beverage-specific details of a `FOOD_AND_BEV` item.", + "x-release-status": "PUBLIC", + "properties": { + "calorie_count": { + "type": "integer", + "description": "The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of items.", + "nullable": true + }, + "dietary_preferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetailsDietaryPreference" + }, + "description": "The dietary preferences for the `FOOD_AND_BEV` item.", + "nullable": true + }, + "ingredients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetailsIngredient" + }, + "description": "The ingredients for the `FOOD_AND_BEV` type item.", + "nullable": true + } + } + }, + "CatalogItemFoodAndBeverageDetailsDietaryPreference": { + "type": "object", + "description": "Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its ingredients.", + "x-release-status": "PUBLIC", + "properties": { + "type": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetailsDietaryPreferenceType", + "description": "The dietary preference type. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`.\nSee [DietaryPreferenceType](#type-dietarypreferencetype) for possible values", + "nullable": true + }, + "standard_name": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference", + "description": "The name of the dietary preference from a standard pre-defined list. This should be null if it's a custom dietary preference.\nSee [StandardDietaryPreference](#type-standarddietarypreference) for possible values", + "nullable": true + }, + "custom_name": { + "type": "string", + "description": "The name of a user-defined custom dietary preference. This should be null if it's a standard dietary preference.", + "nullable": true + } + } + }, + "CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference": { + "type": "string", + "enum": [ + "DAIRY_FREE", + "GLUTEN_FREE", + "HALAL", + "KOSHER", + "NUT_FREE", + "VEGAN", + "VEGETARIAN" + ], + "x-enum-elements": [ + { + "name": "DAIRY_FREE", + "description": "" + }, + { + "name": "GLUTEN_FREE", + "description": "" + }, + { + "name": "HALAL", + "description": "" + }, + { + "name": "KOSHER", + "description": "" + }, + { + "name": "NUT_FREE", + "description": "" + }, + { + "name": "VEGAN", + "description": "" + }, + { + "name": "VEGETARIAN", + "description": "" + } + ], + "description": "Standard dietary preferences for food and beverage items that are recommended on item creation.", + "x-release-status": "PUBLIC" + }, + "CatalogItemFoodAndBeverageDetailsDietaryPreferenceType": { + "type": "string", + "enum": [ + "STANDARD", + "CUSTOM" + ], + "x-enum-elements": [ + { + "name": "STANDARD", + "description": "A standard value from a pre-determined list." + }, + { + "name": "CUSTOM", + "description": "A user-defined custom value." + } + ], + "description": "The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.", + "x-release-status": "PUBLIC" + }, + "CatalogItemFoodAndBeverageDetailsIngredient": { + "type": "object", + "description": "Describes the ingredient used in a `FOOD_AND_BEV` item.", + "x-release-status": "PUBLIC", + "properties": { + "type": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetailsDietaryPreferenceType", + "description": "The dietary preference type of the ingredient. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`.\nSee [DietaryPreferenceType](#type-dietarypreferencetype) for possible values", + "nullable": true + }, + "standard_name": { + "$ref": "#/components/schemas/CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient", + "description": "The name of the ingredient from a standard pre-defined list. This should be null if it's a custom dietary preference.\nSee [StandardIngredient](#type-standardingredient) for possible values", + "nullable": true + }, + "custom_name": { + "type": "string", + "description": "The name of a custom user-defined ingredient. This should be null if it's a standard dietary preference.", + "nullable": true + } + } + }, + "CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient": { + "type": "string", + "enum": [ + "CELERY", + "CRUSTACEANS", + "EGGS", + "FISH", + "GLUTEN", + "LUPIN", + "MILK", + "MOLLUSCS", + "MUSTARD", + "PEANUTS", + "SESAME", + "SOY", + "SULPHITES", + "TREE_NUTS" + ], + "x-enum-elements": [ + { + "name": "CELERY", + "description": "" + }, + { + "name": "CRUSTACEANS", + "description": "" + }, + { + "name": "EGGS", + "description": "" + }, + { + "name": "FISH", + "description": "" + }, + { + "name": "GLUTEN", + "description": "" + }, + { + "name": "LUPIN", + "description": "" + }, + { + "name": "MILK", + "description": "" + }, + { + "name": "MOLLUSCS", + "description": "" + }, + { + "name": "MUSTARD", + "description": "" + }, + { + "name": "PEANUTS", + "description": "" + }, + { + "name": "SESAME", + "description": "" + }, + { + "name": "SOY", + "description": "" + }, + { + "name": "SULPHITES", + "description": "" + }, + { + "name": "TREE_NUTS", + "description": "" + } + ], + "description": "Standard ingredients for food and beverage items that are recommended on item creation.", + "x-release-status": "PUBLIC" + }, + "CatalogItemModifierListInfo": { + "type": "object", + "description": "References a text-based modifier or a list of non text-based modifiers applied to a `CatalogItem` instance\nand specifies supported behaviors of the application.", + "x-release-status": "PUBLIC", + "required": [ + "modifier_list_id" + ], + "properties": { + "modifier_list_id": { + "type": "string", + "description": "The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.", + "minLength": 1 + }, + "modifier_overrides": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogModifierOverride" + }, + "description": "A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default.", + "nullable": true + }, + "min_selected_modifiers": { + "type": "integer", + "description": "If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`.\nThe default value is `-1`.\n\nWhen `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` \nand `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of\nthe `CatalogModifierList` can be selected from the `CatalogModifierList`. \n\nWhen the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`\nand `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in \nand can be selected from the `CatalogModifierList`", + "nullable": true + }, + "max_selected_modifiers": { + "type": "integer", + "description": "If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`.\nThe default value is `-1`.\n\nWhen `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` \nand `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of\nthe `CatalogModifierList` can be selected from the `CatalogModifierList`. \n\nWhen the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`\nand `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in \nand can be selected from the `CatalogModifierList`", + "nullable": true + }, + "enabled": { + "type": "boolean", + "description": "If `true`, enable this `CatalogModifierList`. The default value is `true`.", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied \nto a `CatalogItem` instance.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "CatalogItemOption": { + "type": "object", + "description": "A group of variations for a `CatalogItem`.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The item option's display name for the seller. Must be unique across\nall item options. This is a searchable attribute for use in applicable query filters.", + "nullable": true + }, + "display_name": { + "type": "string", + "description": "The item option's display name for the customer. This is a searchable attribute for use in applicable query filters.", + "nullable": true + }, + "description": { + "type": "string", + "description": "The item option's human-readable description. Displayed in the Square\nPoint of Sale app for the seller and in the Online Store or on receipts for\nthe buyer. This is a searchable attribute for use in applicable query filters.", + "nullable": true + }, + "show_colors": { + "type": "boolean", + "description": "If true, display colors for entries in `values` when present.", + "nullable": true + }, + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of CatalogObjects containing the\n`CatalogItemOptionValue`s for this item.", + "nullable": true + } + } + }, + "CatalogItemOptionForItem": { + "type": "object", + "description": " An option that can be assigned to an item.\nFor example, a t-shirt item may offer a color option or a size option.", + "x-release-status": "BETA", + "properties": { + "item_option_id": { + "type": "string", + "description": "The unique id of the item option, used to form the dimensions of the item option matrix in a specified order.", + "nullable": true + } + } + }, + "CatalogItemOptionValue": { + "type": "object", + "description": "An enumerated value that can link a\n`CatalogItemVariation` to an item option as one of\nits item option values.", + "x-release-status": "PUBLIC", + "properties": { + "item_option_id": { + "type": "string", + "description": "Unique ID of the associated item option.", + "nullable": true + }, + "name": { + "type": "string", + "description": "Name of this item option value. This is a searchable attribute for use in applicable query filters.", + "nullable": true + }, + "description": { + "type": "string", + "description": "A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The HTML-supported hex color for the item option (e.g., \"#ff8d4e85\").\nOnly displayed if `show_colors` is enabled on the parent `ItemOption`. When\nleft unset, `color` defaults to white (\"#ffffff\") when `show_colors` is\nenabled on the parent `ItemOption`.", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "Determines where this option value appears in a list of option values.", + "nullable": true + } + } + }, + "CatalogItemOptionValueForItemVariation": { + "type": "object", + "description": "A `CatalogItemOptionValue` links an item variation to an item option as\nan item option value. For example, a t-shirt item may offer a color option and\na size option. An item option value would represent each variation of t-shirt:\nFor example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\".", + "x-release-status": "PUBLIC", + "properties": { + "item_option_id": { + "type": "string", + "description": "The unique id of an item option.", + "nullable": true + }, + "item_option_value_id": { + "type": "string", + "description": "The unique id of the selected value for the item option.", + "nullable": true + } + } + }, + "CatalogItemProductType": { + "type": "string", + "enum": [ + "REGULAR", + "GIFT_CARD", + "APPOINTMENTS_SERVICE", + "FOOD_AND_BEV", + "EVENT", + "DIGITAL", + "DONATION", + "LEGACY_SQUARE_ONLINE_SERVICE", + "LEGACY_SQUARE_ONLINE_MEMBERSHIP" + ], + "x-enum-elements": [ + { + "name": "REGULAR", + "description": "An ordinary item." + }, + { + "name": "GIFT_CARD", + "description": "A Square gift card." + }, + { + "name": "APPOINTMENTS_SERVICE", + "description": "A service that can be booked using the Square Appointments app." + }, + { + "name": "FOOD_AND_BEV", + "description": "A food or beverage item that can be sold by restaurants and other food venues." + }, + { + "name": "EVENT", + "description": "An event which tickets can be sold for, including location, address, and times." + }, + { + "name": "DIGITAL", + "description": "A digital item like an ebook or song." + }, + { + "name": "DONATION", + "description": "A donation which site visitors can send for any cause." + }, + { + "name": "LEGACY_SQUARE_ONLINE_SERVICE", + "description": "A legacy Square Online service that is manually fulfilled. This corresponds to the `Other` item type displayed in the Square Seller Dashboard and Square POS apps." + }, + { + "name": "LEGACY_SQUARE_ONLINE_MEMBERSHIP", + "description": "A legacy Square Online membership that is manually fulfilled. This corresponds to the `Membership` item type displayed in the Square Seller Dashboard and Square POS apps." + } + ], + "description": "The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.", + "x-release-status": "PUBLIC" + }, + "CatalogItemVariation": { + "type": "object", + "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](entity:CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", + "x-release-status": "PUBLIC", + "properties": { + "item_id": { + "type": "string", + "description": "The ID of the `CatalogItem` associated with this item variation.", + "nullable": true + }, + "name": { + "type": "string", + "description": "The item variation's name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](entity:CatalogItem)\nuses [item options](entity:CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points.", + "nullable": true + }, + "sku": { + "type": "string", + "description": "The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters.", + "nullable": true + }, + "upc": { + "type": "string", + "description": "The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters.\n\nThe value of this attribute should be a number of 12-14 digits long. This restriction is enforced on the Square Seller Dashboard,\nSquare Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned\nto this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps\nunless it is updated to fit the expected format.", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal\nfor each item variation within a parent `CatalogItem` is set according to the item variations's\nposition. On reads, the value is not guaranteed to be sequential or unique.", + "readOnly": true + }, + "pricing_type": { + "$ref": "#/components/schemas/CatalogPricingType", + "description": "Indicates whether the item variation's price is fixed or determined at the time\nof sale.\nSee [CatalogPricingType](#type-catalogpricingtype) for possible values", + "nullable": true + }, + "price_money": { + "$ref": "#/components/schemas/Money", + "description": "The item variation's price, if fixed pricing is used.", + "nullable": true + }, + "location_overrides": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ItemVariationLocationOverrides" + }, + "description": "Per-location price and inventory overrides.", + "nullable": true + }, + "track_inventory": { + "type": "boolean", + "description": "If `true`, inventory tracking is active for the variation.", + "nullable": true + }, + "inventory_alert_type": { + "$ref": "#/components/schemas/InventoryAlertType", + "description": "Indicates whether the item variation displays an alert when its inventory quantity is less than or equal\nto its `inventory_alert_threshold`.\nSee [InventoryAlertType](#type-inventoryalerttype) for possible values", + "nullable": true + }, + "inventory_alert_threshold": { + "type": "integer", + "description": "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`\nis `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.\n\nThis value is always an integer.", + "format": "int64", + "nullable": true + }, + "user_data": { + "type": "string", + "description": "Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points.", + "maxLength": 255, + "nullable": true + }, + "service_duration": { + "type": "integer", + "description": "If the `CatalogItem` that owns this item variation is of type\n`APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For\nexample, a 30 minute appointment would have the value `1800000`, which is equal to\n30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).", + "format": "int64", + "nullable": true + }, + "available_for_booking": { + "type": "boolean", + "description": "If the `CatalogItem` that owns this item variation is of type\n`APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking.", + "x-release-status": "BETA", + "nullable": true + }, + "item_option_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogItemOptionValueForItemVariation" + }, + "description": "List of item option values associated with this item variation. Listed\nin the same order as the item options of the parent item.", + "nullable": true + }, + "measurement_unit_id": { + "type": "string", + "description": "ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity\nsold of this item variation. If left unset, the item will be sold in\nwhole quantities.", + "nullable": true + }, + "sellable": { + "type": "boolean", + "description": "Whether this variation can be sold. The inventory count of a sellable variation indicates\nthe number of units available for sale. When a variation is both stockable and sellable,\nits sellable inventory count can be smaller than or equal to its stockable count.", + "x-release-status": "BETA", + "nullable": true + }, + "stockable": { + "type": "boolean", + "description": "Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE).\nWhen a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock\nand is not an indicator of the number of units of the variation that can be sold.", + "x-release-status": "BETA", + "nullable": true + }, + "image_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of images associated with this `CatalogItemVariation` instance.\nThese images will be shown to customers in Square Online Store.", + "nullable": true + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tokens of employees that can perform the service represented by this variation. Only valid for\nvariations of type `APPOINTMENTS_SERVICE`.", + "x-release-status": "BETA", + "nullable": true + }, + "stockable_conversion": { + "$ref": "#/components/schemas/CatalogStockConversion", + "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](entity:CatalogStockConversion) type,\nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion,\nyou can accurately track inventory when an item variation is sold in one unit, but stocked in\nanother unit.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "CatalogMeasurementUnit": { + "type": "object", + "description": "Represents the unit used to measure a `CatalogItemVariation` and\nspecifies the precision for decimal quantities.", + "x-release-status": "PUBLIC", + "properties": { + "measurement_unit": { + "$ref": "#/components/schemas/MeasurementUnit", + "description": "Indicates the unit used to measure the quantity of a catalog item variation.", + "nullable": true + }, + "precision": { + "type": "integer", + "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in quantities measured with this unit.\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 3", + "nullable": true + } + } + }, + "CatalogModifier": { + "type": "object", + "description": "A modifier applicable to items at the time of sale. An example of a modifier is a Cheese add-on to a Burger item.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The modifier name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", + "maxLength": 255, + "nullable": true + }, + "price_money": { + "$ref": "#/components/schemas/Money", + "description": "The modifier price.", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "Determines where this `CatalogModifier` appears in the `CatalogModifierList`.", + "nullable": true + }, + "modifier_list_id": { + "type": "string", + "description": "The ID of the `CatalogModifierList` associated with this modifier.", + "nullable": true + }, + "location_overrides": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModifierLocationOverrides" + }, + "description": "Location-specific price overrides.", + "nullable": true + }, + "image_id": { + "type": "string", + "description": "The ID of the image associated with this `CatalogModifier` instance.\nCurrently this image is not displayed by Square, but is free to be displayed in 3rd party applications.", + "x-release-status": "BETA", + "nullable": true + } + }, + "example": { + "object": { + "modifier_data": { + "name": "Almond Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + } + } + }, + "CatalogModifierList": { + "type": "object", + "description": "For a text-based modifier, this encapsulates the modifier's text when its `modifier_type` is `TEXT`. \nFor example, to sell T-shirts with custom prints, a text-based modifier can be used to capture the buyer-supplied \ntext string to be selected for the T-shirt at the time of sale.\n\nFor non text-based modifiers, this encapsulates a non-empty list of modifiers applicable to items \nat the time of sale. Each element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type. \nFor example, a \"Condiments\" modifier list applicable to a \"Hot Dog\" item\nmay contain \"Ketchup\", \"Mustard\", and \"Relish\" modifiers. \n\nA non text-based modifier can be applied to the modified item once or multiple times, if the `selection_type` field \nis set to `SINGLE` or `MULTIPLE`, respectively. On the other hand, a text-based modifier can be applied to the item \nonly once and the `selection_type` field is always set to `SINGLE`.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The name of the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of \nUnicode code points.", + "maxLength": 255, + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "The position of this `CatalogModifierList` within a list of `CatalogModifierList` instances.", + "nullable": true + }, + "selection_type": { + "$ref": "#/components/schemas/CatalogModifierListSelectionType", + "description": "Indicates whether a single (`SINGLE`) or multiple (`MULTIPLE`) modifiers from the list\ncan be applied to a single `CatalogItem`.\n\nFor text-based modifiers, the `selection_type` attribute is always `SINGLE`. The other value is ignored.\nSee [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values", + "nullable": true + }, + "modifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A non-empty list of `CatalogModifier` objects to be included in the `CatalogModifierList`, \nfor non text-based modifiers when the `modifier_type` attribute is `LIST`. Each element of this list \nis a `CatalogObject` instance of the `MODIFIER` type, containing the following attributes:\n```\n{\n\"id\": \"{{catalog_modifier_id}}\",\n\"type\": \"MODIFIER\", \n\"modifier_data\": {{a CatalogModifier instance\u003e}} \n}\n```", + "nullable": true + }, + "image_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of images associated with this `CatalogModifierList` instance.\nCurrently these images are not displayed on Square products, but may be displayed in 3rd-party applications.", + "nullable": true + }, + "modifier_type": { + "$ref": "#/components/schemas/CatalogModifierListModifierType", + "description": "The type of the modifier. \n\nWhen this `modifier_type` value is `TEXT`, the `CatalogModifierList` represents a text-based modifier. \nWhen this `modifier_type` value is `LIST`, the `CatalogModifierList` contains a list of `CatalogModifier` objects.\nSee [CatalogModifierListModifierType](#type-catalogmodifierlistmodifiertype) for possible values", + "x-release-status": "BETA", + "nullable": true + }, + "max_length": { + "type": "integer", + "description": "The maximum length, in Unicode points, of the text string of the text-based modifier as represented by \nthis `CatalogModifierList` object with the `modifier_type` set to `TEXT`.", + "x-release-status": "BETA", + "nullable": true + }, + "text_required": { + "type": "boolean", + "description": "Whether the text string must be a non-empty string (`true`) or not (`false`) for a text-based modifier\nas represented by this `CatalogModifierList` object with the `modifier_type` set to `TEXT`.", + "x-release-status": "BETA", + "nullable": true + }, + "internal_name": { + "type": "string", + "description": "A note for internal use by the business. \n\nFor example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of \"Hello, Kitty!\" \nis to be printed on the T-shirt, this `internal_name` attribute can be \"Use italic face\" as \nan instruction for the business to follow. \n\nFor non text-based modifiers, this `internal_name` attribute can be \nused to include SKUs, internal codes, or supplemental descriptions for internal use.", + "maxLength": 512, + "x-release-status": "BETA", + "nullable": true + } + }, + "example": { + "id": "#MilkType", + "modifier_list_data": { + "allow_quantities": false, + "modifiers": [ + { + "modifier_data": { + "name": "Whole Milk", + "price_money": { + "amount": 0, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + }, + { + "modifier_data": { + "name": "Almond Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + }, + { + "modifier_data": { + "name": "Soy Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + } + ], + "name": "Milk Type", + "selection_type": "SINGLE" + }, + "present_at_all_locations": true, + "type": "MODIFIER_LIST" + } + }, + "CatalogModifierListModifierType": { + "type": "string", + "enum": [ + "LIST", + "TEXT" + ], + "x-enum-elements": [ + { + "name": "LIST", + "description": "The `CatalogModifierList` instance is a non-empty list of non text-based modifiers." + }, + { + "name": "TEXT", + "description": "The `CatalogModifierList` instance is a single text-based modifier." + } + ], + "description": "Defines the type of `CatalogModifierList`.", + "x-release-status": "BETA" + }, + "CatalogModifierListSelectionType": { + "type": "string", + "enum": [ + "SINGLE", + "MULTIPLE" + ], + "x-enum-elements": [ + { + "name": "SINGLE", + "description": "Indicates that a CatalogModifierList allows only a\nsingle CatalogModifier to be selected." + }, + { + "name": "MULTIPLE", + "description": "Indicates that a CatalogModifierList allows multiple\nCatalogModifier to be selected." + } + ], + "description": "Indicates whether a CatalogModifierList supports multiple selections.", + "x-release-status": "PUBLIC" + }, + "CatalogModifierOverride": { + "type": "object", + "description": "Options to control how to override the default behavior of the specified modifier.", + "x-release-status": "PUBLIC", + "required": [ + "modifier_id" + ], + "properties": { + "modifier_id": { + "type": "string", + "description": "The ID of the `CatalogModifier` whose default behavior is being overridden.", + "minLength": 1 + }, + "on_by_default": { + "type": "boolean", + "description": "If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`.", + "nullable": true + } + } + }, + "CatalogObject": { + "type": "object", + "description": "The wrapper object for the catalog entries of a given object type.\n\nDepending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.\n\nFor example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.\n\nIn general, if `type=\u003cOBJECT_TYPE\u003e`, the `CatalogObject` instance must have the `\u003cOBJECT_TYPE\u003e`-specific data set on the `\u003cobject_type\u003e_data` attribute. The resulting `CatalogObject` instance is also a `Catalog\u003cObjectType\u003e` instance.\n\nFor a more detailed discussion of the Catalog data model, please see the\n[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide.", + "x-release-status": "PUBLIC", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CatalogObjectType", + "description": "The type of this object. Each object type has expected\nproperties expressed in a structured format within its corresponding `*_data` field below.\nSee [CatalogObjectType](#type-catalogobjecttype) for possible values" + }, + "id": { + "type": "string", + "description": "An identifier to reference this object in the catalog. When a new `CatalogObject`\nis inserted, the client should set the id to a temporary identifier starting with\na \"`#`\" character. Other objects being inserted or updated within the same request\nmay use this identifier to refer to the new object.\n\nWhen the server receives the new object, it will supply a unique identifier that\nreplaces the temporary identifier for all future references.", + "minLength": 1 + }, + "updated_at": { + "type": "string", + "description": "Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"`\nwould indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "The version of the object. When updating an object, the version supplied\nmust match the version in the database, otherwise the write will be rejected as conflicting.", + "format": "int64" + }, + "is_deleted": { + "type": "boolean", + "description": "If `true`, the object has been deleted from the database. Must be `false` for new objects\nbeing inserted. When deleted, the `updated_at` field will equal the deletion time.", + "nullable": true + }, + "custom_attribute_values": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CatalogCustomAttributeValue" + }, + "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).", + "nullable": true + }, + "catalog_v1_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogV1Id" + }, + "description": "The Connect v1 IDs for this object at each location where it is present, where they\ndiffer from the object's Connect V2 ID. The field will only be present for objects that\nhave been created or modified by legacy APIs.", + "nullable": true + }, + "present_at_all_locations": { + "type": "boolean", + "description": "If `true`, this object is present at all locations (including future locations), except where specified in\nthe `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations),\nexcept where specified in the `present_at_location_ids` field. If not specified, defaults to `true`.", + "nullable": true + }, + "present_at_location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations where the object is present, even if `present_at_all_locations` is `false`.\nThis can include locations that are deactivated.", + "nullable": true + }, + "absent_at_location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations where the object is not present, even if `present_at_all_locations` is `true`.\nThis can include locations that are deactivated.", + "nullable": true + }, + "item_data": { + "$ref": "#/components/schemas/CatalogItem", + "description": "Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`.", + "nullable": true + }, + "category_data": { + "$ref": "#/components/schemas/CatalogCategory", + "description": "Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`.", + "nullable": true + }, + "item_variation_data": { + "$ref": "#/components/schemas/CatalogItemVariation", + "description": "Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`.", + "nullable": true + }, + "tax_data": { + "$ref": "#/components/schemas/CatalogTax", + "description": "Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`.", + "nullable": true + }, + "discount_data": { + "$ref": "#/components/schemas/CatalogDiscount", + "description": "Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`.", + "nullable": true + }, + "modifier_list_data": { + "$ref": "#/components/schemas/CatalogModifierList", + "description": "Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`.", + "nullable": true + }, + "modifier_data": { + "$ref": "#/components/schemas/CatalogModifier", + "description": "Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`.", + "nullable": true + }, + "time_period_data": { + "$ref": "#/components/schemas/CatalogTimePeriod", + "description": "Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`.", + "nullable": true + }, + "product_set_data": { + "$ref": "#/components/schemas/CatalogProductSet", + "description": "Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`.", + "nullable": true + }, + "pricing_rule_data": { + "$ref": "#/components/schemas/CatalogPricingRule", + "description": "Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`.\nA `CatalogPricingRule` object often works with a `CatalogProductSet` object or a `CatalogTimePeriod` object.", + "nullable": true + }, + "image_data": { + "$ref": "#/components/schemas/CatalogImage", + "description": "Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`.", + "nullable": true + }, + "measurement_unit_data": { + "$ref": "#/components/schemas/CatalogMeasurementUnit", + "description": "Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`.", + "nullable": true + }, + "subscription_plan_data": { + "$ref": "#/components/schemas/CatalogSubscriptionPlan", + "description": "Structured data for a `CatalogSubscriptionPlan`, set for CatalogObjects of type `SUBSCRIPTION_PLAN`.", + "nullable": true + }, + "item_option_data": { + "$ref": "#/components/schemas/CatalogItemOption", + "description": "Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`.", + "nullable": true + }, + "item_option_value_data": { + "$ref": "#/components/schemas/CatalogItemOptionValue", + "description": "Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`.", + "nullable": true + }, + "custom_attribute_definition_data": { + "$ref": "#/components/schemas/CatalogCustomAttributeDefinition", + "description": "Structured data for a `CatalogCustomAttributeDefinition`, set for CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`.", + "nullable": true + }, + "quick_amounts_settings_data": { + "$ref": "#/components/schemas/CatalogQuickAmountsSettings", + "description": "Structured data for a `CatalogQuickAmountsSettings`, set for CatalogObjects of type `QUICK_AMOUNTS_SETTINGS`.", + "x-release-status": "BETA", + "nullable": true + }, + "subscription_plan_variation_data": { + "$ref": "#/components/schemas/CatalogSubscriptionPlanVariation", + "description": "Structured data for a `CatalogSubscriptionPlanVariation`, set for CatalogObjects of type `SUBSCRIPTION_PLAN_VARIATION`.", + "nullable": true + }, + "availability_period_data": { + "$ref": "#/components/schemas/CatalogAvailabilityPeriod", + "description": "Structured data for a `CatalogAvailabilityPeriod`, set for CatalogObjects of type `AVAILABILITY_PERIOD`.", + "nullable": true + } + }, + "example": { + "catalog_object": { + "absent_at_location_ids": [ + "{{ LOCATIONID-1 }}", + "{{ LOCATIONID-N }}" + ], + "category_data": "{{ CatalogCategory object only if type=CATEGORY }}", + "connect_v1_ids": { + "catalog_v1_id": "{{ itemID from Catalog v1 }}", + "location_id": "{{ location where v1 ID is used }}" + }, + "discount_data": "{{ CatalogDiscount object only if type=DISCOUNT }}", + "id": "{{ set by Catalog during object creation }}", + "is_deleted": "{{ [true | false] }}", + "item_data": "{{ CatalogItem object only if type=ITEM }}", + "item_variation_data": "{{ CatalogItemVariation object only if type=ITEM_VARIATION }}", + "modifier_data": "{{ CatalogModifier object only if type=MODIFIER }}", + "modifier_list_data": "{{ CatalogModifierList object only if type=MODIFIER_LIST }}", + "present_at_all_locations": "{{ [true | false] }}", + "present_at_location_ids": [ + "{{ LOCATIONID-1 }}", + "{{ LOCATIONID-N }}" + ], + "tax_data": "{{ CatalogTax object only if type=TAX }}", + "type": "{{ [ITEM | ITEM_VARIATION | MODIFIER | MODIFIER_LIST | CATEGORY | DISCOUNT | TAX] }}", + "updated_at": "{{ date \u0026 time of most recent update }}", + "version": "{{ version of the CatalogObject }}" + } + } + }, + "CatalogObjectBatch": { + "type": "object", + "description": "A batch of catalog objects.", + "x-release-status": "PUBLIC", + "required": [ + "objects" + ], + "properties": { + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of CatalogObjects belonging to this batch." + } + } + }, + "CatalogObjectCategory": { + "type": "object", + "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", + "x-release-status": "BETA", + "properties": { + "id": { + "type": "string", + "description": "The ID of the object's category." + }, + "ordinal": { + "type": "integer", + "description": "The order of the object within the context of the category.", + "format": "int64", + "nullable": true + } + } + }, + "CatalogObjectReference": { + "type": "object", + "description": "A reference to a Catalog object at a specific version. In general this is\nused as an entry point into a graph of catalog objects, where the objects exist\nat a specific version.", + "x-release-status": "PUBLIC", + "properties": { + "object_id": { + "type": "string", + "description": "The ID of the referenced object.", + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the object.", + "format": "int64", + "nullable": true + } + } + }, + "CatalogObjectType": { + "type": "string", + "enum": [ + "ITEM", + "IMAGE", + "CATEGORY", + "ITEM_VARIATION", + "TAX", + "DISCOUNT", + "MODIFIER_LIST", + "MODIFIER", + "PRICING_RULE", + "PRODUCT_SET", + "TIME_PERIOD", + "MEASUREMENT_UNIT", + "SUBSCRIPTION_PLAN_VARIATION", + "ITEM_OPTION", + "ITEM_OPTION_VAL", + "CUSTOM_ATTRIBUTE_DEFINITION", + "QUICK_AMOUNTS_SETTINGS", + "SUBSCRIPTION_PLAN", + "AVAILABILITY_PERIOD" + ], + "x-enum-elements": [ + { + "name": "ITEM", + "description": "The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." + }, + { + "name": "IMAGE", + "description": "The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." + }, + { + "name": "CATEGORY", + "description": "The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." + }, + { + "name": "ITEM_VARIATION", + "description": "The `CatalogObject` instance is of the [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." + }, + { + "name": "TAX", + "description": "The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." + }, + { + "name": "DISCOUNT", + "description": "The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." + }, + { + "name": "MODIFIER_LIST", + "description": "The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." + }, + { + "name": "MODIFIER", + "description": "The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." + }, + { + "name": "PRICING_RULE", + "description": "The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." + }, + { + "name": "PRODUCT_SET", + "description": "The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." + }, + { + "name": "TIME_PERIOD", + "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." + }, + { + "name": "MEASUREMENT_UNIT", + "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." + }, + { + "name": "SUBSCRIPTION_PLAN_VARIATION", + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." + }, + { + "name": "ITEM_OPTION", + "description": "The `CatalogObject` instance is of the [CatalogItemOption](entity:CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." + }, + { + "name": "ITEM_OPTION_VAL", + "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](entity:CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." + }, + { + "name": "CUSTOM_ATTRIBUTE_DEFINITION", + "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." + }, + { + "name": "QUICK_AMOUNTS_SETTINGS", + "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](entity:CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." + }, + { + "name": "SUBSCRIPTION_PLAN", + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field." + }, + { + "name": "AVAILABILITY_PERIOD", + "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](entity:CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field." + } + ], + "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", + "x-release-status": "PUBLIC" + }, + "CatalogPricingRule": { + "type": "object", + "description": "Defines how discounts are automatically applied to a set of items that match the pricing rule\nduring the active time period.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "User-defined name for the pricing rule. For example, \"Buy one get one\nfree\" or \"10% off\".", + "nullable": true + }, + "time_period_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of unique IDs for the catalog time periods when\nthis pricing rule is in effect. If left unset, the pricing rule is always\nin effect.", + "nullable": true + }, + "discount_id": { + "type": "string", + "description": "Unique ID for the `CatalogDiscount` to take off\nthe price of all matched items.", + "nullable": true + }, + "match_products_id": { + "type": "string", + "description": "Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule\nmatches within the entire cart, and can match multiple times. This field will always be set.", + "nullable": true + }, + "apply_products_id": { + "type": "string", + "description": "__Deprecated__: Please use the `exclude_products_id` field to apply\nan exclude set instead. Exclude sets allow better control over quantity\nranges and offer more flexibility for which matched items receive a discount.\n\n`CatalogProductSet` to apply the pricing to.\nAn apply rule matches within the subset of the cart that fits the match rules (the match set).\nAn apply rule can only match once in the match set.\nIf not supplied, the pricing will be applied to all products in the match set.\nOther products retain their base price, or a price generated by other rules.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "exclude_products_id": { + "type": "string", + "description": "`CatalogProductSet` to exclude from the pricing rule.\nAn exclude rule matches within the subset of the cart that fits the match rules (the match set).\nAn exclude rule can only match once in the match set.\nIf not supplied, the pricing will be applied to all products in the match set.\nOther products retain their base price, or a price generated by other rules.", + "nullable": true + }, + "valid_from_date": { + "type": "string", + "description": "Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).", + "nullable": true + }, + "valid_from_local_time": { + "type": "string", + "description": "Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format\n(HH:MM:SS). Partial seconds will be truncated.", + "nullable": true + }, + "valid_until_date": { + "type": "string", + "description": "Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).", + "nullable": true + }, + "valid_until_local_time": { + "type": "string", + "description": "Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format\n(HH:MM:SS). Partial seconds will be truncated.", + "nullable": true + }, + "exclude_strategy": { + "$ref": "#/components/schemas/ExcludeStrategy", + "description": "If an `exclude_products_id` was given, controls which subset of matched\nproducts is excluded from any discounts.\n\nDefault value: `LEAST_EXPENSIVE`\nSee [ExcludeStrategy](#type-excludestrategy) for possible values", + "nullable": true + }, + "minimum_order_subtotal_money": { + "$ref": "#/components/schemas/Money", + "description": "The minimum order subtotal (before discounts or taxes are applied)\nthat must be met before this rule may be applied.", + "nullable": true + }, + "customer_group_ids_any": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule.\nNotice that a group ID is generated by the Customers API.\nIf this field is not set, the specified discount applies to matched products sold to anyone whether the buyer\nhas a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount\napplies only to matched products sold to customers belonging to the specified customer groups.", + "nullable": true + } + } + }, + "CatalogPricingType": { + "type": "string", + "enum": [ + "FIXED_PRICING", + "VARIABLE_PRICING" + ], + "x-enum-elements": [ + { + "name": "FIXED_PRICING", + "description": "The catalog item variation's price is fixed." + }, + { + "name": "VARIABLE_PRICING", + "description": "The catalog item variation's price is entered at the time of sale." + } + ], + "description": "Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.", + "x-release-status": "PUBLIC" + }, + "CatalogProductSet": { + "type": "object", + "description": "Represents a collection of catalog objects for the purpose of applying a\n`PricingRule`. Including a catalog object will include all of its subtypes.\nFor example, including a category in a product set will include all of its\nitems and associated item variations in the product set. Including an item in\na product set will also include its item variations.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "User-defined name for the product set. For example, \"Clearance Items\"\nor \"Winter Sale Items\".", + "nullable": true + }, + "product_ids_any": { + "type": "array", + "items": { + "type": "string" + }, + "description": " Unique IDs for any `CatalogObject` included in this product set. Any\nnumber of these catalog objects can be in an order for a pricing rule to apply.\n\nThis can be used with `product_ids_all` in a parent `CatalogProductSet` to\nmatch groups of products for a bulk discount, such as a discount for an\nentree and side combo.\n\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.\n\nMax: 500 catalog object IDs.", + "nullable": true + }, + "product_ids_all": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Unique IDs for any `CatalogObject` included in this product set.\nAll objects in this set must be included in an order for a pricing rule to apply.\n\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.\n\nMax: 500 catalog object IDs.", + "nullable": true + }, + "quantity_exact": { + "type": "integer", + "description": "If set, there must be exactly this many items from `products_any` or `products_all`\nin the cart for the discount to apply.\n\nCannot be combined with either `quantity_min` or `quantity_max`.", + "format": "int64", + "nullable": true + }, + "quantity_min": { + "type": "integer", + "description": "If set, there must be at least this many items from `products_any` or `products_all`\nin a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if\n`quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.", + "format": "int64", + "nullable": true + }, + "quantity_max": { + "type": "integer", + "description": "If set, the pricing rule will apply to a maximum of this many items from\n`products_any` or `products_all`.", + "format": "int64", + "nullable": true + }, + "all_products": { + "type": "boolean", + "description": "If set to `true`, the product set will include every item in the catalog.\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.", + "nullable": true + } + } + }, + "CatalogQuery": { + "type": "object", + "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).\nAny combination of the following types may be used together:\n- [exact_query](entity:CatalogQueryExact)\n- [prefix_query](entity:CatalogQueryPrefix)\n- [range_query](entity:CatalogQueryRange)\n- [sorted_attribute_query](entity:CatalogQuerySortedAttribute)\n- [text_query](entity:CatalogQueryText)\n\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\nSearchable attribute and objects queryable by searchable attributes:\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](entity:CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", + "x-release-status": "PUBLIC", + "properties": { + "sorted_attribute_query": { + "$ref": "#/components/schemas/CatalogQuerySortedAttribute", + "description": "A query expression to sort returned query result by the given attribute.", + "nullable": true + }, + "exact_query": { + "$ref": "#/components/schemas/CatalogQueryExact", + "description": "An exact query expression to return objects with attribute name and value\nmatching the specified attribute name and value exactly. Value matching is case insensitive.", + "nullable": true + }, + "set_query": { + "$ref": "#/components/schemas/CatalogQuerySet", + "description": "A set query expression to return objects with attribute name and value\nmatching the specified attribute name and any of the specified attribute values exactly.\nValue matching is case insensitive.", + "nullable": true + }, + "prefix_query": { + "$ref": "#/components/schemas/CatalogQueryPrefix", + "description": "A prefix query expression to return objects with attribute values\nthat have a prefix matching the specified string value. Value matching is case insensitive.", + "nullable": true + }, + "range_query": { + "$ref": "#/components/schemas/CatalogQueryRange", + "description": "A range query expression to return objects with numeric values\nthat lie in the specified range.", + "nullable": true + }, + "text_query": { + "$ref": "#/components/schemas/CatalogQueryText", + "description": "A text query expression to return objects whose searchable attributes contain all of the given\nkeywords, irrespective of their order. For example, if a `CatalogItem` contains custom attribute values of\n`{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, the query filter of `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`\nreturns this item.", + "nullable": true + }, + "items_for_tax_query": { + "$ref": "#/components/schemas/CatalogQueryItemsForTax", + "description": "A query expression to return items that have any of the specified taxes (as identified by the corresponding `CatalogTax` object IDs) enabled.", + "nullable": true + }, + "items_for_modifier_list_query": { + "$ref": "#/components/schemas/CatalogQueryItemsForModifierList", + "description": "A query expression to return items that have any of the given modifier list (as identified by the corresponding `CatalogModifierList`s IDs) enabled.", + "nullable": true + }, + "items_for_item_options_query": { + "$ref": "#/components/schemas/CatalogQueryItemsForItemOptions", + "description": "A query expression to return items that contains the specified item options (as identified the corresponding `CatalogItemOption` IDs).", + "nullable": true + }, + "item_variations_for_item_option_values_query": { + "$ref": "#/components/schemas/CatalogQueryItemVariationsForItemOptionValues", + "description": "A query expression to return item variations (of the [CatalogItemVariation](entity:CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs.", + "nullable": true + } + } + }, + "CatalogQueryExact": { + "type": "object", + "description": "The query filter to return the search result by exact match of the specified attribute name and value.", + "x-release-status": "PUBLIC", + "required": [ + "attribute_name", + "attribute_value" + ], + "properties": { + "attribute_name": { + "type": "string", + "description": "The name of the attribute to be searched. Matching of the attribute name is exact.", + "minLength": 1 + }, + "attribute_value": { + "type": "string", + "description": "The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial.\nFor example, if a specified value of \"sma\", objects with the named attribute value of \"Small\", \"small\" are both matched." + } + } + }, + "CatalogQueryItemVariationsForItemOptionValues": { + "type": "object", + "description": "The query filter to return the item variations containing the specified item option value IDs.", + "x-release-status": "PUBLIC", + "properties": { + "item_option_value_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of `CatalogItemOptionValue` IDs to be used to find associated\n`CatalogItemVariation`s. All ItemVariations that contain all of the given\nItem Option Values (in any order) will be returned.", + "nullable": true + } + } + }, + "CatalogQueryItemsForItemOptions": { + "type": "object", + "description": "The query filter to return the items containing the specified item option IDs.", + "x-release-status": "PUBLIC", + "properties": { + "item_option_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of `CatalogItemOption` IDs to be used to find associated\n`CatalogItem`s. All Items that contain all of the given Item Options (in any order)\nwill be returned.", + "nullable": true + } + } + }, + "CatalogQueryItemsForModifierList": { + "type": "object", + "description": "The query filter to return the items containing the specified modifier list IDs.", + "x-release-status": "PUBLIC", + "required": [ + "modifier_list_ids" + ], + "properties": { + "modifier_list_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s." + } + } + }, + "CatalogQueryItemsForTax": { + "type": "object", + "description": "The query filter to return the items containing the specified tax IDs.", + "x-release-status": "PUBLIC", + "required": [ + "tax_ids" + ], + "properties": { + "tax_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s." + } + } + }, + "CatalogQueryPrefix": { + "type": "object", + "description": "The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.", + "x-release-status": "PUBLIC", + "required": [ + "attribute_name", + "attribute_prefix" + ], + "properties": { + "attribute_name": { + "type": "string", + "description": "The name of the attribute to be searched.", + "minLength": 1 + }, + "attribute_prefix": { + "type": "string", + "description": "The desired prefix of the search attribute value.", + "minLength": 1 + } + } + }, + "CatalogQueryRange": { + "type": "object", + "description": "The query filter to return the search result whose named attribute values fall between the specified range.", + "x-release-status": "PUBLIC", + "required": [ + "attribute_name" + ], + "properties": { + "attribute_name": { + "type": "string", + "description": "The name of the attribute to be searched.", + "minLength": 1 + }, + "attribute_min_value": { + "type": "integer", + "description": "The desired minimum value for the search attribute (inclusive).", + "format": "int64", + "nullable": true + }, + "attribute_max_value": { + "type": "integer", + "description": "The desired maximum value for the search attribute (inclusive).", + "format": "int64", + "nullable": true + } + } + }, + "CatalogQuerySet": { + "type": "object", + "description": "The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of\nthe `attribute_values`.", + "x-release-status": "PUBLIC", + "required": [ + "attribute_name", + "attribute_values" + ], + "properties": { + "attribute_name": { + "type": "string", + "description": "The name of the attribute to be searched. Matching of the attribute name is exact.", + "minLength": 1 + }, + "attribute_values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The desired values of the search attribute. Matching of the attribute values is exact and case insensitive.\nA maximum of 250 values may be searched in a request." + } + } + }, + "CatalogQuerySortedAttribute": { + "type": "object", + "description": "The query expression to specify the key to sort search results.", + "x-release-status": "PUBLIC", + "required": [ + "attribute_name" + ], + "properties": { + "attribute_name": { + "type": "string", + "description": "The attribute whose value is used as the sort key.", + "minLength": 1 + }, + "initial_attribute_value": { + "type": "string", + "description": "The first attribute value to be returned by the query. Ascending sorts will return only\nobjects with this value or greater, while descending sorts will return only objects with this value\nor less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending).\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "CatalogQueryText": { + "type": "object", + "description": "The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.", + "x-release-status": "PUBLIC", + "required": [ + "keywords" + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 alphanumeric characters are ignored." + } + } + }, + "CatalogQuickAmount": { + "type": "object", + "description": "Represents a Quick Amount in the Catalog.", + "x-release-status": "BETA", + "required": [ + "type", + "amount" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CatalogQuickAmountType", + "description": "Represents the type of the Quick Amount.\nSee [CatalogQuickAmountType](#type-catalogquickamounttype) for possible values" + }, + "amount": { + "$ref": "#/components/schemas/Money", + "description": "Represents the actual amount of the Quick Amount with Money type." + }, + "score": { + "type": "integer", + "description": "Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].\nMANUAL type amount will always have score = 100.", + "format": "int64", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "The order in which this Quick Amount should be displayed.", + "format": "int64", + "nullable": true + } + } + }, + "CatalogQuickAmountType": { + "type": "string", + "enum": [ + "QUICK_AMOUNT_TYPE_MANUAL", + "QUICK_AMOUNT_TYPE_AUTO" + ], + "x-enum-elements": [ + { + "name": "QUICK_AMOUNT_TYPE_MANUAL", + "description": "Quick Amount is created manually by the seller." + }, + { + "name": "QUICK_AMOUNT_TYPE_AUTO", + "description": "Quick Amount is generated automatically by machine learning algorithms." + } + ], + "description": "Determines the type of a specific Quick Amount.", + "x-release-status": "BETA" + }, + "CatalogQuickAmountsSettings": { + "type": "object", + "description": "A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.", + "x-release-status": "BETA", + "required": [ + "option" + ], + "properties": { + "option": { + "$ref": "#/components/schemas/CatalogQuickAmountsSettingsOption", + "description": "Represents the option seller currently uses on Quick Amounts.\nSee [CatalogQuickAmountsSettingsOption](#type-catalogquickamountssettingsoption) for possible values" + }, + "eligible_for_auto_amounts": { + "type": "boolean", + "description": "Represents location's eligibility for auto amounts\nThe boolean should be consistent with whether there are AUTO amounts in the `amounts`.", + "nullable": true + }, + "amounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogQuickAmount" + }, + "description": "Represents a set of Quick Amounts at this location.", + "nullable": true + } + } + }, + "CatalogQuickAmountsSettingsOption": { + "type": "string", + "enum": [ + "DISABLED", + "MANUAL", + "AUTO" + ], + "x-enum-elements": [ + { + "name": "DISABLED", + "description": "Option for seller to disable Quick Amounts." + }, + { + "name": "MANUAL", + "description": "Option for seller to choose manually created Quick Amounts." + }, + { + "name": "AUTO", + "description": "Option for seller to choose automatically created Quick Amounts." + } + ], + "description": "Determines a seller's option on Quick Amounts feature.", + "x-release-status": "BETA" + }, + "CatalogStockConversion": { + "type": "object", + "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](entity:CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", + "x-release-status": "BETA", + "required": [ + "stockable_item_variation_id", + "stockable_quantity", + "nonstockable_quantity" + ], + "properties": { + "stockable_item_variation_id": { + "type": "string", + "description": "References to the stockable [CatalogItemVariation](entity:CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.`", + "minLength": 1 + }, + "stockable_quantity": { + "type": "string", + "description": "The quantity of the stockable item variation (as identified by `stockable_item_variation_id`)\nequivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`)\nas defined by this stock conversion. It accepts a decimal number in a string format that can take\nup to 10 digits before the decimal point and up to 5 digits after the decimal point.", + "minLength": 1, + "maxLength": 16 + }, + "nonstockable_quantity": { + "type": "string", + "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](entity:CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point.", + "minLength": 1, + "maxLength": 16 + } + } + }, + "CatalogSubscriptionPlan": { + "type": "object", + "description": "Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations.\nFor more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", + "x-release-status": "PUBLIC", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the plan." + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionPhase" + }, + "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error", + "nullable": true + }, + "subscription_plan_variations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "The list of subscription plan variations available for this product", + "nullable": true + }, + "eligible_item_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations.", + "nullable": true + }, + "eligible_category_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations.", + "nullable": true + }, + "all_items": { + "type": "boolean", + "description": "If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan.", + "nullable": true + } + } + }, + "CatalogSubscriptionPlanVariation": { + "type": "object", + "description": "Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold.\nFor more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", + "x-release-status": "PUBLIC", + "required": [ + "name", + "phases" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the plan variation." + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionPhase" + }, + "description": "A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation." + }, + "subscription_plan_id": { + "type": "string", + "description": "The id of the subscription plan, if there is one.", + "nullable": true + }, + "monthly_billing_anchor_date": { + "type": "integer", + "description": "The day of the month the billing period starts.", + "format": "int64", + "minimum": 1, + "maximum": 31, + "nullable": true + }, + "can_prorate": { + "type": "boolean", + "description": "Whether bills for this plan variation can be split for proration.", + "nullable": true + }, + "successor_plan_variation_id": { + "type": "string", + "description": "The ID of a \"successor\" plan variation to this one. If the field is set, and this object is disabled at all\nlocations, it indicates that this variation is deprecated and the object identified by the successor ID be used in\nits stead.", + "nullable": true + } + } + }, + "CatalogTax": { + "type": "object", + "description": "A tax applicable to an item.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", + "maxLength": 255, + "nullable": true + }, + "calculation_phase": { + "$ref": "#/components/schemas/TaxCalculationPhase", + "description": "Whether the tax is calculated based on a payment's subtotal or total.\nSee [TaxCalculationPhase](#type-taxcalculationphase) for possible values", + "nullable": true + }, + "inclusion_type": { + "$ref": "#/components/schemas/TaxInclusionType", + "description": "Whether the tax is `ADDITIVE` or `INCLUSIVE`.\nSee [TaxInclusionType](#type-taxinclusiontype) for possible values", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign.\nA value of `7.5` corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.", + "nullable": true + }, + "applies_to_custom_amounts": { + "type": "boolean", + "description": "If `true`, the fee applies to custom amounts entered into the Square Point of Sale\napp that are not associated with a particular `CatalogItem`.", + "nullable": true + }, + "enabled": { + "type": "boolean", + "description": "A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`).", + "nullable": true + }, + "applies_to_product_set_id": { + "type": "string", + "description": "The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set.", + "x-release-status": "BETA", + "nullable": true + } + }, + "example": { + "object": { + "id": "#SalesTax", + "present_at_all_locations": true, + "tax_data": { + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "enabled": true, + "fee_applies_to_custom_amounts": true, + "inclusion_type": "ADDITIVE", + "name": "Sales Tax", + "percentage": "5.0" + }, + "type": "TAX" + } + } + }, + "CatalogTimePeriod": { + "type": "object", + "description": "Represents a time period - either a single period or a repeating period.", + "x-release-status": "PUBLIC", + "properties": { + "event": { + "type": "string", + "description": "An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which\nspecifies the name, timing, duration and recurrence of this time period.\n\nExample:\n\n```\nDTSTART:20190707T180000\nDURATION:P2H\nRRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR\n```\n\nOnly `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported.\n`DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT`\nand `END:VEVENT` is not required in the request. The response will always\ninclude them.", + "nullable": true + } + } + }, + "CatalogV1Id": { + "type": "object", + "description": "A Square API V1 identifier of an item, including the object ID and its associated location ID.", + "x-release-status": "PUBLIC", + "properties": { + "catalog_v1_id": { + "type": "string", + "description": "The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the `Location` this Connect V1 ID is associated with.", + "nullable": true + } + } + }, + "CategoryPathToRootNode": { + "type": "object", + "description": "A node in the path from a retrieved category to its root node.", + "x-release-status": "PUBLIC", + "properties": { + "category_id": { + "type": "string", + "description": "The category's ID.", + "nullable": true + }, + "category_name": { + "type": "string", + "description": "The category's name.", + "nullable": true + } + } + }, + "ChangeBillingAnchorDateRequest": { + "type": "object", + "description": "Defines input parameters in a request to the\n[ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) endpoint.", + "x-release-status": "BETA", + "properties": { + "monthly_billing_anchor_date": { + "type": "integer", + "description": "The anchor day for the billing cycle.", + "minimum": 1, + "maximum": 31, + "nullable": true + }, + "effective_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes\nplace on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the billing anchor date\nis changed immediately.", + "nullable": true + } + }, + "example": { + "monthly_billing_anchor_date": 1 + } + }, + "ChangeBillingAnchorDateResponse": { + "type": "object", + "description": "Defines output parameters in a request to the\n[ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) endpoint.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The specified subscription for updating billing anchor date." + }, + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAction" + }, + "description": "A list of a single billing anchor date change for the subscription." + } + }, + "example": { + "actions": [ + { + "effective_date": "2023-11-01", + "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83", + "monthly_billing_anchor_date": 1, + "type": "CHANGE_BILLING_ANCHOR_DATE" + } + ], + "subscription": { + "created_at": "2023-06-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "9ba40961-995a-4a3d-8c53-048c40cafc13", + "location_id": "S8GWD5R9QB376", + "monthly_billing_anchor_date": 20, + "phases": [ + { + "order_template_id": "E6oBY5WfQ2eN4pkYZwq4ka6n7KeZY", + "ordinal": 0, + "plan_phase_uid": "C66BKH3ASTDYGJJCEZXQQSS7", + "uid": "98d6f53b-40e1-4714-8827-032fd923be25" + } + ], + "plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", + "price_override_money": { + "amount": 2000, + "currency": "USD" + }, + "source": { + "name": "My Application" + }, + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 3 + } + } + }, + "ChangeTiming": { + "type": "string", + "enum": [ + "IMMEDIATE", + "END_OF_BILLING_CYCLE" + ], + "x-enum-elements": [ + { + "name": "IMMEDIATE", + "description": "The action occurs immediately." + }, + { + "name": "END_OF_BILLING_CYCLE", + "description": "The action occurs at the end of the billing cycle." + } + ], + "description": "Supported timings when a pending change, as an action, takes place to a subscription.", + "x-release-status": "BETA" + }, + "ChargeRequest": { + "type": "object", + "description": "Defines the parameters that can be included in the body of\na request to the [Charge](api-endpoint:Transactions-Charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](api-endpoint:Payments-CreatePayment)", + "x-release-status": "DEPRECATED", + "required": [ + "idempotency_key", + "amount_money" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this\ntransaction among transactions you've created.\n\nIf you're unsure whether a particular transaction succeeded,\nyou can reattempt it with the same idempotency key without\nworrying about double-charging the buyer.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.", + "minLength": 1, + "maxLength": 192 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money to charge.\n\nNote that you specify the amount in the\n__smallest denomination of the applicable currency__. For example, US dollar\namounts are specified in cents. See\n[Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.\n\nThe value of `currency` must match the currency associated with the business\nthat is charging the card." + }, + "card_nonce": { + "type": "string", + "description": "A payment token generated from the [Card.tokenize()](https://developer.squareup.com/reference/sdks/web/payments/objects/Card#Card.tokenize) that represents the card\nto charge.\n\nThe application that provides a payment token to this endpoint must be the\n_same application_ that generated the payment token with the Web Payments SDK.\nOtherwise, the nonce is invalid.\n\nDo not provide a value for this field if you provide a value for\n`customer_card_id`.", + "maxLength": 192, + "nullable": true + }, + "customer_card_id": { + "type": "string", + "description": "The ID of the customer card on file to charge. Do\nnot provide a value for this field if you provide a value for `card_nonce`.\n\nIf you provide this value, you _must_ also provide a value for\n`customer_id`.", + "maxLength": 192, + "nullable": true + }, + "delay_capture": { + "type": "boolean", + "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint) or a Void\n(with the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint).\n\nDefault value: `false`", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "An optional ID you can associate with the transaction for your own\npurposes (such as to associate the transaction with an entity ID in your\nown database).\n\nThis value cannot exceed 40 characters.", + "maxLength": 40, + "nullable": true + }, + "note": { + "type": "string", + "description": "An optional note to associate with the transaction.\n\nThis value cannot exceed 60 characters.", + "maxLength": 60, + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "The ID of the customer to associate this transaction with. This field\nis required if you provide a value for `customer_card_id`, and optional\notherwise.", + "maxLength": 50, + "nullable": true + }, + "billing_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer's billing address. This value is optional, but this transaction\nis ineligible for chargeback protection if neither this parameter nor\n`shipping_address` is provided.", + "nullable": true + }, + "shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer's shipping address, if available. This value is optional,\nbut this transaction is ineligible for chargeback protection if neither this\nparameter nor `billing_address` is provided.", + "nullable": true + }, + "buyer_email_address": { + "type": "string", + "description": "The buyer's email address, if available. This value is optional,\nbut this transaction is ineligible for chargeback protection if it is not\nprovided.", + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the order to associate with this transaction.\n\nIf you provide this value, the `amount_money` value of your request must\n__exactly match__ the value of the order's `total_money` field.", + "maxLength": 192, + "nullable": true + }, + "additional_recipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChargeRequestAdditionalRecipient" + }, + "description": "The basic primitive of multi-party transaction. The value is optional.\nThe transaction facilitated by you can be split from here.\n\nIf you provide this value, the `amount_money` value in your additional_recipients\nmust not be more than 90% of the `amount_money` value in the charge request.\nThe `location_id` must be the valid location of the app owner merchant.\n\nThis field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.\n\nThis field is currently not supported in sandbox.", + "nullable": true + }, + "verification_token": { + "type": "string", + "description": "A token generated by SqPaymentForm's verifyBuyer() that represents\ncustomer's device info and 3ds challenge result.", + "nullable": true + } + }, + "example": { + "additional_recipients": [ + { + "amount_money": { + "amount": 20, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "amount_money": { + "amount": 200, + "currency": "USD" + }, + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "card_nonce": "card_nonce_from_square_123", + "delay_capture": false, + "idempotency_key": "74ae1696-b1e3-4328-af6d-f1e04d947a13", + "note": "some optional note", + "reference_id": "some optional reference id", + "shipping_address": { + "address_line_1": "123 Main St", + "administrative_district_level_1": "CA", + "country": "US", + "locality": "San Francisco", + "postal_code": "94114" + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Charge/ChargeRequest.csharp", + "java": "/sdk_samples/Charge/ChargeRequest.java", + "javascript": "/sdk_samples/Charge/ChargeRequest.javascript", + "php": "/sdk_samples/Charge/ChargeRequest.php", + "python": "/sdk_samples/Charge/ChargeRequest.python", + "ruby": "/sdk_samples/Charge/ChargeRequest.ruby" + } + }, + "ChargeRequestAdditionalRecipient": { + "type": "object", + "description": "Represents an additional recipient (other than the merchant) entitled to a portion of the tender.\nSupport is currently limited to USD, CAD and GBP currencies", + "x-release-status": "DEPRECATED", + "required": [ + "location_id", + "description", + "amount_money" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The location ID for a recipient (other than the merchant) receiving a portion of the tender.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the additional recipient.", + "minLength": 1, + "maxLength": 100 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money distributed to the recipient." + } + } + }, + "ChargeResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [Charge](api-endpoint:Transactions-Charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "transaction": { + "$ref": "#/components/schemas/Transaction", + "description": "The created transaction." + } + }, + "example": { + "transaction": { + "created_at": "2016-03-10T22:57:56Z", + "id": "KnL67ZIwXCPtzOrqj0HrkxMF", + "location_id": "18YC4JDH91E1H", + "product": "EXTERNAL_API", + "reference_id": "some optional reference id", + "tenders": [ + { + "additional_recipients": [ + { + "amount_money": { + "amount": 20, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1", + "receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF" + } + ], + "amount_money": { + "amount": 200, + "currency": "USD" + }, + "card_details": { + "card": { + "card_brand": "VISA", + "last_4": "1111" + }, + "entry_method": "KEYED", + "status": "CAPTURED" + }, + "created_at": "2016-03-10T22:57:56Z", + "id": "MtZRYYdDrYNQbOvV7nbuBvMF", + "location_id": "18YC4JDH91E1H", + "note": "some optional note", + "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF", + "type": "CARD" + } + ] + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Charge/ChargeResponse.csharp", + "java": "/sdk_samples/Charge/ChargeResponse.java", + "javascript": "/sdk_samples/Charge/ChargeResponse.javascript", + "php": "/sdk_samples/Charge/ChargeResponse.php", + "python": "/sdk_samples/Charge/ChargeResponse.python", + "ruby": "/sdk_samples/Charge/ChargeResponse.ruby" + } + }, + "Checkout": { + "type": "object", + "description": "Square Checkout lets merchants accept online payments for supported\npayment types using a checkout workflow hosted on squareup.com.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "ID generated by Square Checkout when a new checkout is requested." + }, + "checkout_page_url": { + "type": "string", + "description": "The URL that the buyer's browser should be redirected to after the\ncheckout is completed.", + "nullable": true + }, + "ask_for_shipping_address": { + "type": "boolean", + "description": "If `true`, Square Checkout will collect shipping information on your\nbehalf and store that information with the transaction information in your\nSquare Dashboard.\n\nDefault: `false`.", + "nullable": true + }, + "merchant_support_email": { + "type": "string", + "description": "The email address to display on the Square Checkout confirmation page\nand confirmation email that the buyer can use to contact the merchant.\n\nIf this value is not set, the confirmation page and email will display the\nprimary email address associated with the merchant's Square account.\n\nDefault: none; only exists if explicitly set.", + "nullable": true + }, + "pre_populate_buyer_email": { + "type": "string", + "description": "If provided, the buyer's email is pre-populated on the checkout page\nas an editable text field.\n\nDefault: none; only exists if explicitly set.", + "nullable": true + }, + "pre_populate_shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "If provided, the buyer's shipping info is pre-populated on the\ncheckout page as editable text fields.\n\nDefault: none; only exists if explicitly set.", + "nullable": true + }, + "redirect_url": { + "type": "string", + "description": "The URL to redirect to after checkout is completed with `checkoutId`,\nSquare's `orderId`, `transactionId`, and `referenceId` appended as URL\nparameters. For example, if the provided redirect_url is\n`http://www.example.com/order-complete`, a successful transaction redirects\nthe customer to:\n\n\u003cpre\u003e\u003ccode\u003ehttp://www.example.com/order-complete?checkoutId=xxxxxx\u0026amp;orderId=xxxxxx\u0026amp;referenceId=xxxxxx\u0026amp;transactionId=xxxxxx\u003c/code\u003e\u003c/pre\u003e\n\nIf you do not provide a redirect URL, Square Checkout will display an order\nconfirmation page on your behalf; however Square strongly recommends that\nyou provide a redirect URL so you can verify the transaction results and\nfinalize the order through your existing/normal confirmation workflow.", + "nullable": true + }, + "order": { + "$ref": "#/components/schemas/Order", + "description": "Order to be checked out.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time when the checkout was created, in RFC 3339 format.", + "readOnly": true + }, + "additional_recipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalRecipient" + }, + "description": "Additional recipients (other than the merchant) receiving a portion of this checkout.\nFor example, fees assessed on the purchase by a third party integration.", + "x-release-status": "DEPRECATED", + "nullable": true + } + } + }, + "CheckoutLocationSettings": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location that these settings apply to.", + "nullable": true + }, + "customer_notes_enabled": { + "type": "boolean", + "description": "Indicates whether customers are allowed to leave notes at checkout.", + "nullable": true + }, + "policies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CheckoutLocationSettingsPolicy" + }, + "description": "Policy information is displayed at the bottom of the checkout pages.\nYou can set a maximum of two policies.", + "nullable": true + }, + "branding": { + "$ref": "#/components/schemas/CheckoutLocationSettingsBranding", + "description": "The branding settings for this location.", + "nullable": true + }, + "tipping": { + "$ref": "#/components/schemas/CheckoutLocationSettingsTipping", + "description": "The tip settings for this location.", + "nullable": true + }, + "coupons": { + "$ref": "#/components/schemas/CheckoutLocationSettingsCoupons", + "description": "The coupon settings for this location.", + "nullable": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the settings were last updated, in RFC 3339 format.\nExamples for January 25th, 2020 6:25:34pm Pacific Standard Time:\nUTC: 2020-01-26T02:25:34Z\nPacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00", + "readOnly": true + } + } + }, + "CheckoutLocationSettingsBranding": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "header_type": { + "$ref": "#/components/schemas/CheckoutLocationSettingsBrandingHeaderType", + "description": "Show the location logo on the checkout page.\nSee [HeaderType](#type-headertype) for possible values", + "nullable": true + }, + "button_color": { + "type": "string", + "description": "The HTML-supported hex color for the button on the checkout page (for example, \"#FFFFFF\").", + "minLength": 7, + "maxLength": 7, + "nullable": true + }, + "button_shape": { + "$ref": "#/components/schemas/CheckoutLocationSettingsBrandingButtonShape", + "description": "The shape of the button on the checkout page.\nSee [ButtonShape](#type-buttonshape) for possible values", + "nullable": true + } + } + }, + "CheckoutLocationSettingsBrandingButtonShape": { + "type": "string", + "enum": [ + "SQUARED", + "ROUNDED", + "PILL" + ], + "x-enum-elements": [ + { + "name": "SQUARED", + "description": "" + }, + { + "name": "ROUNDED", + "description": "" + }, + { + "name": "PILL", + "description": "" + } + ], + "x-release-status": "BETA" + }, + "CheckoutLocationSettingsBrandingHeaderType": { + "type": "string", + "enum": [ + "BUSINESS_NAME", + "FRAMED_LOGO", + "FULL_WIDTH_LOGO" + ], + "x-enum-elements": [ + { + "name": "BUSINESS_NAME", + "description": "" + }, + { + "name": "FRAMED_LOGO", + "description": "" + }, + { + "name": "FULL_WIDTH_LOGO", + "description": "" + } + ], + "x-release-status": "BETA" + }, + "CheckoutLocationSettingsCoupons": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether coupons are enabled for this location.", + "nullable": true + } + } + }, + "CheckoutLocationSettingsPolicy": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID to identify the policy when making changes. You must set the UID for policy updates, but it’s optional when setting new policies.", + "nullable": true + }, + "title": { + "type": "string", + "description": "The title of the policy. This is required when setting the description, though you can update it in a different request.", + "maxLength": 50, + "nullable": true + }, + "description": { + "type": "string", + "description": "The description of the policy.", + "maxLength": 4096, + "nullable": true + } + } + }, + "CheckoutLocationSettingsTipping": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "percentages": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Set three custom percentage amounts that buyers can select at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more.", + "nullable": true + }, + "smart_tipping_enabled": { + "type": "boolean", + "description": "Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping works as follows:\nIf a transaction is less than $10, the available tipping options include No Tip, $1, $2, or $3.\nIf a transaction is $10 or more, the available tipping options include No Tip, 15%, 20%, or 25%. \nYou can set custom percentage amounts with the `percentages` field.", + "nullable": true + }, + "default_percent": { + "type": "integer", + "description": "Set the pre-selected percentage amounts that appear at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more.", + "nullable": true + }, + "smart_tips": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Money" + }, + "description": "Show the Smart Tip Amounts for this location.", + "nullable": true + }, + "default_smart_tip": { + "$ref": "#/components/schemas/Money", + "description": "Set the pre-selected whole amount that appears at checkout when Smart Tip is enabled and the transaction amount is less than $10.", + "nullable": true + } + } + }, + "CheckoutMerchantSettings": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "payment_methods": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethods", + "description": "The set of payment methods accepted for the merchant's account.", + "nullable": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the settings were last updated, in RFC 3339 format.\nExamples for January 25th, 2020 6:25:34pm Pacific Standard Time:\nUTC: 2020-01-26T02:25:34Z\nPacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00", + "readOnly": true + } + } + }, + "CheckoutMerchantSettingsPaymentMethods": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "apple_pay": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethodsPaymentMethod", + "nullable": true + }, + "google_pay": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethodsPaymentMethod", + "nullable": true + }, + "cash_app": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethodsPaymentMethod", + "nullable": true + }, + "afterpay_clearpay": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay", + "nullable": true + } + } + }, + "CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay": { + "type": "object", + "description": "The settings allowed for AfterpayClearpay.", + "x-release-status": "BETA", + "properties": { + "order_eligibility_range": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange", + "description": "Afterpay is shown as an option for order totals falling within the configured range.", + "nullable": true + }, + "item_eligibility_range": { + "$ref": "#/components/schemas/CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange", + "description": "Afterpay is shown as an option for item totals falling within the configured range.", + "nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the payment method is enabled for the account.", + "readOnly": true + } + } + }, + "CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange": { + "type": "object", + "description": "A range of purchase price that qualifies.", + "x-release-status": "BETA", + "required": [ + "min", + "max" + ], + "properties": { + "min": { + "$ref": "#/components/schemas/Money" + }, + "max": { + "$ref": "#/components/schemas/Money" + } + } + }, + "CheckoutMerchantSettingsPaymentMethodsPaymentMethod": { + "type": "object", + "description": "The settings allowed for a payment method.", + "x-release-status": "BETA", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether the payment method is enabled for the account.", + "nullable": true + } + } + }, + "CheckoutOptions": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "allow_tipping": { + "type": "boolean", + "description": "Indicates whether the payment allows tipping.", + "nullable": true + }, + "custom_fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + }, + "description": "The custom fields requesting information from the buyer.", + "nullable": true + }, + "subscription_plan_id": { + "type": "string", + "description": "The ID of the subscription plan for the buyer to pay and subscribe.\nFor more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).", + "maxLength": 255, + "nullable": true + }, + "redirect_url": { + "type": "string", + "description": "The confirmation page URL to redirect the buyer to after Square processes the payment.", + "maxLength": 2048, + "nullable": true + }, + "merchant_support_email": { + "type": "string", + "description": "The email address that buyers can use to contact the seller.", + "maxLength": 256, + "nullable": true + }, + "ask_for_shipping_address": { + "type": "boolean", + "description": "Indicates whether to include the address fields in the payment form.", + "nullable": true + }, + "accepted_payment_methods": { + "$ref": "#/components/schemas/AcceptedPaymentMethods", + "description": "The methods allowed for buyers during checkout.", + "nullable": true + }, + "app_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller.\n\nThe amount cannot be more than 90% of the total amount of the payment.\n\nThe amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-monetary-amounts).\n\nThe fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. For more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).\n\nTo set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/collect-fees/additional-considerations#permissions).", + "nullable": true + }, + "shipping_fee": { + "$ref": "#/components/schemas/ShippingFee", + "description": "The fee associated with shipping to be applied to the `Order` as a service charge.", + "nullable": true + }, + "enable_coupon": { + "type": "boolean", + "description": "Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form.", + "nullable": true + }, + "enable_loyalty": { + "type": "boolean", + "description": "Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.", + "nullable": true + } + } + }, + "CheckoutOptionsPaymentType": { + "type": "string", + "enum": [ + "CARD_PRESENT", + "MANUAL_CARD_ENTRY", + "FELICA_ID", + "FELICA_QUICPAY", + "FELICA_TRANSPORTATION_GROUP", + "FELICA_ALL", + "PAYPAY", + "QR_CODE" + ], + "x-enum-elements": [ + { + "name": "CARD_PRESENT", + "description": "Accept credit card or debit card payments via tap, dip or swipe." + }, + { + "name": "MANUAL_CARD_ENTRY", + "description": "Launches the manual credit or debit card entry screen for the buyer to complete." + }, + { + "name": "FELICA_ID", + "description": "Launches the iD checkout screen for the buyer to complete." + }, + { + "name": "FELICA_QUICPAY", + "description": "Launches the QUICPay checkout screen for the buyer to complete." + }, + { + "name": "FELICA_TRANSPORTATION_GROUP", + "description": "Launches the Transportation Group checkout screen for the buyer to complete." + }, + { + "name": "FELICA_ALL", + "description": "Launches a checkout screen for the buyer on the Square Terminal that\nallows them to select a specific FeliCa brand or select the check balance screen." + }, + { + "name": "PAYPAY", + "description": "Replaced by `QR_CODE`." + }, + { + "name": "QR_CODE", + "description": "Launches Square's QR Code checkout screen for the buyer to complete.\nDisplays a single code that supports all digital wallets connected to the target\nSeller location (e.g. PayPay)" + } + ], + "x-release-status": "PUBLIC" + }, + "ClearpayDetails": { + "type": "object", + "description": "Additional details about Clearpay payments.", + "x-release-status": "PUBLIC", + "properties": { + "email_address": { + "type": "string", + "description": "Email address on the buyer's Clearpay account.", + "maxLength": 255, + "nullable": true + } + } + }, + "CloneOrderRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the\n[CloneOrder](api-endpoint:Orders-CloneOrder) endpoint.", + "x-release-status": "BETA", + "required": [ + "order_id" + ], + "properties": { + "order_id": { + "type": "string", + "description": "The ID of the order to clone." + }, + "version": { + "type": "integer", + "description": "An optional order version for concurrency protection.\n\nIf a version is provided, it must match the latest stored version of the order to clone.\nIf a version is not provided, the API clones the latest version." + }, + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this clone request.\n\nIf you are unsure whether a particular order was cloned successfully,\nyou can reattempt the call with the same idempotency key without\nworrying about creating duplicate cloned orders.\nThe originally cloned order is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "nullable": true + } + }, + "example": { + "idempotency_key": "UNIQUE_STRING", + "order_id": "ZAISEM52YcpmcWAzERDOyiWS123", + "version": 3 + } + }, + "CloneOrderResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint.", + "x-release-status": "BETA", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The cloned order." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "order": { + "created_at": "2020-01-17T20:47:53.293Z", + "discounts": [ + { + "applied_money": { + "amount": 30, + "currency": "USD" + }, + "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", + "name": "Membership Discount", + "percentage": "0.5", + "scope": "ORDER", + "type": "FIXED_PERCENTAGE", + "uid": "membership-discount" + }, + { + "applied_money": { + "amount": 303, + "currency": "USD" + }, + "name": "Labor Day Sale", + "percentage": "5", + "scope": "ORDER", + "type": "FIXED_PERCENTAGE", + "uid": "labor-day-sale" + }, + { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "applied_money": { + "amount": 100, + "currency": "USD" + }, + "name": "Sale - $1.00 off", + "scope": "LINE_ITEM", + "type": "FIXED_AMOUNT", + "uid": "one-dollar-off" + } + ], + "id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "line_items": [ + { + "applied_discounts": [ + { + "applied_money": { + "amount": 8, + "currency": "USD" + }, + "discount_uid": "membership-discount", + "uid": "jWdgP1TpHPFBuVrz81mXVC" + }, + { + "applied_money": { + "amount": 79, + "currency": "USD" + }, + "discount_uid": "labor-day-sale", + "uid": "jnZOjjVY57eRcQAVgEwFuC" + } + ], + "applied_taxes": [ + { + "applied_money": { + "amount": 136, + "currency": "USD" + }, + "tax_uid": "state-sales-tax", + "uid": "aKG87ArnDpvMLSZJHxWUl" + } + ], + "base_price_money": { + "amount": 1599, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 1599, + "currency": "USD" + }, + "name": "New York Strip Steak", + "quantity": "1", + "total_discount_money": { + "amount": 87, + "currency": "USD" + }, + "total_money": { + "amount": 1648, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 136, + "currency": "USD" + }, + "uid": "8uSwfzvUImn3IRrvciqlXC", + "variation_total_price_money": { + "amount": 1599, + "currency": "USD" + } + }, + { + "applied_discounts": [ + { + "applied_money": { + "amount": 22, + "currency": "USD" + }, + "discount_uid": "membership-discount", + "uid": "nUXvdsIItfKko0dbYtY58C" + }, + { + "applied_money": { + "amount": 224, + "currency": "USD" + }, + "discount_uid": "labor-day-sale", + "uid": "qSdkOOOernlVQqsJ94SPjB" + }, + { + "applied_money": { + "amount": 100, + "currency": "USD" + }, + "discount_uid": "one-dollar-off", + "uid": "y7bVl4njrWAnfDwmz19izB" + } + ], + "applied_taxes": [ + { + "applied_money": { + "amount": 374, + "currency": "USD" + }, + "tax_uid": "state-sales-tax", + "uid": "v1dAgrfUVUPTnVTf9sRPz" + } + ], + "base_price_money": { + "amount": 2200, + "currency": "USD" + }, + "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", + "gross_sales_money": { + "amount": 4500, + "currency": "USD" + }, + "modifiers": [ + { + "base_price_money": { + "amount": 50, + "currency": "USD" + }, + "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ", + "name": "Well", + "total_price_money": { + "amount": 100, + "currency": "USD" + }, + "uid": "Lo3qMMckDluu9Qsb58d4CC" + } + ], + "name": "New York Steak", + "quantity": "2", + "total_discount_money": { + "amount": 346, + "currency": "USD" + }, + "total_money": { + "amount": 4528, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 374, + "currency": "USD" + }, + "uid": "v8ZuEXpOJpb0bazLuvrLDB", + "variation_name": "Larger", + "variation_total_price_money": { + "amount": 4400, + "currency": "USD" + } + } + ], + "location_id": "057P5VYJ4A5X1", + "net_amounts": { + "discount_money": { + "amount": 433, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 510, + "currency": "USD" + }, + "tip_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 6176, + "currency": "USD" + } + }, + "reference_id": "my-order-001", + "source": { + "name": "My App" + }, + "state": "DRAFT", + "taxes": [ + { + "applied_money": { + "amount": 510, + "currency": "USD" + }, + "name": "State Sales Tax", + "percentage": "9", + "scope": "ORDER", + "type": "ADDITIVE", + "uid": "state-sales-tax" + } + ], + "total_discount_money": { + "amount": 433, + "currency": "USD" + }, + "total_money": { + "amount": 6176, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 510, + "currency": "USD" + }, + "total_tip_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2020-01-17T20:47:53.293Z", + "version": 1 + } + } + }, + "CollectedData": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "input_text": { + "type": "string", + "description": "The buyer's input text.", + "readOnly": true + } + } + }, + "CompletePaymentRequest": { + "type": "object", + "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](api-endpoint:Payments-CompletePayment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", + "x-release-status": "PUBLIC", + "properties": { + "version_token": { + "type": "string", + "description": "Used for optimistic concurrency. This opaque token identifies the current `Payment` \nversion that the caller expects. If the server has a different version of the Payment, \nthe update fails and a response with a VERSION_MISMATCH error is returned.", + "x-release-status": "BETA", + "nullable": true + } + }, + "example": {} + }, + "CompletePaymentResponse": { + "type": "object", + "description": "Defines the response returned by[CompletePayment](api-endpoint:Payments-CompletePayment).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "payment": { + "$ref": "#/components/schemas/Payment", + "description": "The successfully completed payment." + } + }, + "example": { + "payment": { + "amount_money": { + "amount": 555, + "currency": "USD" + }, + "application_details": { + "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA", + "square_product": "VIRTUAL_TERMINAL" + }, + "approved_money": { + "amount": 555, + "currency": "USD" + }, + "card_details": { + "auth_result_code": "2Nkw7q", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2021-10-13T19:34:33.680Z", + "captured_at": "2021-10-13T19:34:34.340Z" + }, + "cvv_status": "CVV_ACCEPTED", + "entry_method": "KEYED", + "statement_description": "SQ *EXAMPLE TEST GOSQ.C", + "status": "CAPTURED" + }, + "created_at": "2021-10-13T19:34:33.524Z", + "delay_action": "CANCEL", + "delay_duration": "PT168H", + "delayed_until": "2021-10-20T19:34:33.524Z", + "employee_id": "TMoK_ogh6rH1o4dV", + "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "location_id": "L88917AVBK2S5", + "note": "Test Note", + "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY", + "processing_fee": [ + { + "amount_money": { + "amount": 34, + "currency": "USD" + }, + "effective_at": "2021-10-13T21:34:35.000Z", + "type": "INITIAL" + } + ], + "receipt_number": "bP9m", + "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "source_type": "CARD", + "status": "COMPLETED", + "team_member_id": "TMoK_ogh6rH1o4dV", + "total_money": { + "amount": 555, + "currency": "USD" + }, + "updated_at": "2021-10-13T19:34:34.339Z", + "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o" + } + } + }, + "Component": { + "type": "object", + "description": "The wrapper object for the component entries of a given component type.", + "x-release-status": "BETA", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ComponentComponentType", + "description": "The type of this component. Each component type has expected properties expressed\nin a structured format within its corresponding `*_details` field.\nSee [ComponentType](#type-componenttype) for possible values" + }, + "application_details": { + "$ref": "#/components/schemas/DeviceComponentDetailsApplicationDetails", + "description": "Structured data for an `Application`, set for Components of type `APPLICATION`.", + "nullable": true + }, + "card_reader_details": { + "$ref": "#/components/schemas/DeviceComponentDetailsCardReaderDetails", + "description": "Structured data for a `CardReader`, set for Components of type `CARD_READER`.", + "nullable": true + }, + "battery_details": { + "$ref": "#/components/schemas/DeviceComponentDetailsBatteryDetails", + "description": "Structured data for a `Battery`, set for Components of type `BATTERY`.", + "nullable": true + }, + "wifi_details": { + "$ref": "#/components/schemas/DeviceComponentDetailsWiFiDetails", + "description": "Structured data for a `WiFi` interface, set for Components of type `WIFI`.", + "nullable": true + }, + "ethernet_details": { + "$ref": "#/components/schemas/DeviceComponentDetailsEthernetDetails", + "description": "Structured data for an `Ethernet` interface, set for Components of type `ETHERNET`.", + "nullable": true + } + } + }, + "ComponentComponentType": { + "type": "string", + "enum": [ + "APPLICATION", + "CARD_READER", + "BATTERY", + "WIFI", + "ETHERNET", + "PRINTER" + ], + "x-enum-elements": [ + { + "name": "APPLICATION", + "description": "" + }, + { + "name": "CARD_READER", + "description": "" + }, + { + "name": "BATTERY", + "description": "" + }, + { + "name": "WIFI", + "description": "" + }, + { + "name": "ETHERNET", + "description": "" + }, + { + "name": "PRINTER", + "description": "" + } + ], + "description": "An enum for ComponentType.", + "x-release-status": "BETA" + }, + "ConfirmationDecision": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "has_agreed": { + "type": "boolean", + "description": "The buyer's decision to the displayed terms.", + "readOnly": true + } + } + }, + "ConfirmationOptions": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "title", + "body", + "agree_button_text" + ], + "properties": { + "title": { + "type": "string", + "description": "The title text to display in the confirmation screen flow on the Terminal.", + "minLength": 1, + "maxLength": 250 + }, + "body": { + "type": "string", + "description": "The agreement details to display in the confirmation flow on the Terminal.", + "minLength": 1, + "maxLength": 10000 + }, + "agree_button_text": { + "type": "string", + "description": "The button text to display indicating the customer agrees to the displayed terms.", + "minLength": 1, + "maxLength": 250 + }, + "disagree_button_text": { + "type": "string", + "description": "The button text to display indicating the customer does not agree to the displayed terms.", + "minLength": 1, + "maxLength": 250, + "nullable": true + }, + "decision": { + "$ref": "#/components/schemas/ConfirmationDecision", + "description": "The result of the buyer’s actions when presented with the confirmation screen.", + "readOnly": true + } + } + }, + "Coordinates": { + "type": "object", + "description": "Latitude and longitude coordinates.", + "x-release-status": "PUBLIC", + "properties": { + "latitude": { + "type": "number", + "description": "The latitude of the coordinate expressed in degrees.", + "nullable": true + }, + "longitude": { + "type": "number", + "description": "The longitude of the coordinate expressed in degrees.", + "nullable": true + } + } + }, + "Country": { + "type": "string", + "enum": [ + "ZZ", + "AD", + "AE", + "AF", + "AG", + "AI", + "AL", + "AM", + "AO", + "AQ", + "AR", + "AS", + "AT", + "AU", + "AW", + "AX", + "AZ", + "BA", + "BB", + "BD", + "BE", + "BF", + "BG", + "BH", + "BI", + "BJ", + "BL", + "BM", + "BN", + "BO", + "BQ", + "BR", + "BS", + "BT", + "BV", + "BW", + "BY", + "BZ", + "CA", + "CC", + "CD", + "CF", + "CG", + "CH", + "CI", + "CK", + "CL", + "CM", + "CN", + "CO", + "CR", + "CU", + "CV", + "CW", + "CX", + "CY", + "CZ", + "DE", + "DJ", + "DK", + "DM", + "DO", + "DZ", + "EC", + "EE", + "EG", + "EH", + "ER", + "ES", + "ET", + "FI", + "FJ", + "FK", + "FM", + "FO", + "FR", + "GA", + "GB", + "GD", + "GE", + "GF", + "GG", + "GH", + "GI", + "GL", + "GM", + "GN", + "GP", + "GQ", + "GR", + "GS", + "GT", + "GU", + "GW", + "GY", + "HK", + "HM", + "HN", + "HR", + "HT", + "HU", + "ID", + "IE", + "IL", + "IM", + "IN", + "IO", + "IQ", + "IR", + "IS", + "IT", + "JE", + "JM", + "JO", + "JP", + "KE", + "KG", + "KH", + "KI", + "KM", + "KN", + "KP", + "KR", + "KW", + "KY", + "KZ", + "LA", + "LB", + "LC", + "LI", + "LK", + "LR", + "LS", + "LT", + "LU", + "LV", + "LY", + "MA", + "MC", + "MD", + "ME", + "MF", + "MG", + "MH", + "MK", + "ML", + "MM", + "MN", + "MO", + "MP", + "MQ", + "MR", + "MS", + "MT", + "MU", + "MV", + "MW", + "MX", + "MY", + "MZ", + "NA", + "NC", + "NE", + "NF", + "NG", + "NI", + "NL", + "NO", + "NP", + "NR", + "NU", + "NZ", + "OM", + "PA", + "PE", + "PF", + "PG", + "PH", + "PK", + "PL", + "PM", + "PN", + "PR", + "PS", + "PT", + "PW", + "PY", + "QA", + "RE", + "RO", + "RS", + "RU", + "RW", + "SA", + "SB", + "SC", + "SD", + "SE", + "SG", + "SH", + "SI", + "SJ", + "SK", + "SL", + "SM", + "SN", + "SO", + "SR", + "SS", + "ST", + "SV", + "SX", + "SY", + "SZ", + "TC", + "TD", + "TF", + "TG", + "TH", + "TJ", + "TK", + "TL", + "TM", + "TN", + "TO", + "TR", + "TT", + "TV", + "TW", + "TZ", + "UA", + "UG", + "UM", + "US", + "UY", + "UZ", + "VA", + "VC", + "VE", + "VG", + "VI", + "VN", + "VU", + "WF", + "WS", + "YE", + "YT", + "ZA", + "ZM", + "ZW" + ], + "x-enum-elements": [ + { + "name": "ZZ", + "description": "Unknown" + }, + { + "name": "AD", + "description": "Andorra" + }, + { + "name": "AE", + "description": "United Arab Emirates" + }, + { + "name": "AF", + "description": "Afghanistan" + }, + { + "name": "AG", + "description": "Antigua and Barbuda" + }, + { + "name": "AI", + "description": "Anguilla" + }, + { + "name": "AL", + "description": "Albania" + }, + { + "name": "AM", + "description": "Armenia" + }, + { + "name": "AO", + "description": "Angola" + }, + { + "name": "AQ", + "description": "Antartica" + }, + { + "name": "AR", + "description": "Argentina" + }, + { + "name": "AS", + "description": "American Samoa" + }, + { + "name": "AT", + "description": "Austria" + }, + { + "name": "AU", + "description": "Australia" + }, + { + "name": "AW", + "description": "Aruba" + }, + { + "name": "AX", + "description": "Åland Islands" + }, + { + "name": "AZ", + "description": "Azerbaijan" + }, + { + "name": "BA", + "description": "Bosnia and Herzegovina" + }, + { + "name": "BB", + "description": "Barbados" + }, + { + "name": "BD", + "description": "Bangladesh" + }, + { + "name": "BE", + "description": "Belgium" + }, + { + "name": "BF", + "description": "Burkina Faso" + }, + { + "name": "BG", + "description": "Bulgaria" + }, + { + "name": "BH", + "description": "Bahrain" + }, + { + "name": "BI", + "description": "Burundi" + }, + { + "name": "BJ", + "description": "Benin" + }, + { + "name": "BL", + "description": "Saint Barthélemy" + }, + { + "name": "BM", + "description": "Bermuda" + }, + { + "name": "BN", + "description": "Brunei" + }, + { + "name": "BO", + "description": "Bolivia" + }, + { + "name": "BQ", + "description": "Bonaire" + }, + { + "name": "BR", + "description": "Brazil" + }, + { + "name": "BS", + "description": "Bahamas" + }, + { + "name": "BT", + "description": "Bhutan" + }, + { + "name": "BV", + "description": "Bouvet Island" + }, + { + "name": "BW", + "description": "Botswana" + }, + { + "name": "BY", + "description": "Belarus" + }, + { + "name": "BZ", + "description": "Belize" + }, + { + "name": "CA", + "description": "Canada" + }, + { + "name": "CC", + "description": "Cocos Islands" + }, + { + "name": "CD", + "description": "Democratic Republic of the Congo" + }, + { + "name": "CF", + "description": "Central African Republic" + }, + { + "name": "CG", + "description": "Congo" + }, + { + "name": "CH", + "description": "Switzerland" + }, + { + "name": "CI", + "description": "Ivory Coast" + }, + { + "name": "CK", + "description": "Cook Islands" + }, + { + "name": "CL", + "description": "Chile" + }, + { + "name": "CM", + "description": "Cameroon" + }, + { + "name": "CN", + "description": "China" + }, + { + "name": "CO", + "description": "Colombia" + }, + { + "name": "CR", + "description": "Costa Rica" + }, + { + "name": "CU", + "description": "Cuba" + }, + { + "name": "CV", + "description": "Cabo Verde" + }, + { + "name": "CW", + "description": "Curaçao" + }, + { + "name": "CX", + "description": "Christmas Island" + }, + { + "name": "CY", + "description": "Cyprus" + }, + { + "name": "CZ", + "description": "Czechia" + }, + { + "name": "DE", + "description": "Germany" + }, + { + "name": "DJ", + "description": "Djibouti" + }, + { + "name": "DK", + "description": "Denmark" + }, + { + "name": "DM", + "description": "Dominica" + }, + { + "name": "DO", + "description": "Dominican Republic" + }, + { + "name": "DZ", + "description": "Algeria" + }, + { + "name": "EC", + "description": "Ecuador" + }, + { + "name": "EE", + "description": "Estonia" + }, + { + "name": "EG", + "description": "Egypt" + }, + { + "name": "EH", + "description": "Western Sahara" + }, + { + "name": "ER", + "description": "Eritrea" + }, + { + "name": "ES", + "description": "Spain" + }, + { + "name": "ET", + "description": "Ethiopia" + }, + { + "name": "FI", + "description": "Finland" + }, + { + "name": "FJ", + "description": "Fiji" + }, + { + "name": "FK", + "description": "Falkland Islands" + }, + { + "name": "FM", + "description": "Federated States of Micronesia" + }, + { + "name": "FO", + "description": "Faroe Islands" + }, + { + "name": "FR", + "description": "France" + }, + { + "name": "GA", + "description": "Gabon" + }, + { + "name": "GB", + "description": "United Kingdom" + }, + { + "name": "GD", + "description": "Grenada" + }, + { + "name": "GE", + "description": "Georgia" + }, + { + "name": "GF", + "description": "French Guiana" + }, + { + "name": "GG", + "description": "Guernsey" + }, + { + "name": "GH", + "description": "Ghana" + }, + { + "name": "GI", + "description": "Gibraltar" + }, + { + "name": "GL", + "description": "Greenland" + }, + { + "name": "GM", + "description": "Gambia" + }, + { + "name": "GN", + "description": "Guinea" + }, + { + "name": "GP", + "description": "Guadeloupe" + }, + { + "name": "GQ", + "description": "Equatorial Guinea" + }, + { + "name": "GR", + "description": "Greece" + }, + { + "name": "GS", + "description": "South Georgia and the South Sandwich Islands" + }, + { + "name": "GT", + "description": "Guatemala" + }, + { + "name": "GU", + "description": "Guam" + }, + { + "name": "GW", + "description": "Guinea-Bissau" + }, + { + "name": "GY", + "description": "Guyana" + }, + { + "name": "HK", + "description": "Hong Kong" + }, + { + "name": "HM", + "description": "Heard Island and McDonald Islands" + }, + { + "name": "HN", + "description": "Honduras" + }, + { + "name": "HR", + "description": "Croatia" + }, + { + "name": "HT", + "description": "Haiti" + }, + { + "name": "HU", + "description": "Hungary" + }, + { + "name": "ID", + "description": "Indonesia" + }, + { + "name": "IE", + "description": "Ireland" + }, + { + "name": "IL", + "description": "Israel" + }, + { + "name": "IM", + "description": "Isle of Man" + }, + { + "name": "IN", + "description": "India" + }, + { + "name": "IO", + "description": "British Indian Ocean Territory" + }, + { + "name": "IQ", + "description": "Iraq" + }, + { + "name": "IR", + "description": "Iran" + }, + { + "name": "IS", + "description": "Iceland" + }, + { + "name": "IT", + "description": "Italy" + }, + { + "name": "JE", + "description": "Jersey" + }, + { + "name": "JM", + "description": "Jamaica" + }, + { + "name": "JO", + "description": "Jordan" + }, + { + "name": "JP", + "description": "Japan" + }, + { + "name": "KE", + "description": "Kenya" + }, + { + "name": "KG", + "description": "Kyrgyzstan" + }, + { + "name": "KH", + "description": "Cambodia" + }, + { + "name": "KI", + "description": "Kiribati" + }, + { + "name": "KM", + "description": "Comoros" + }, + { + "name": "KN", + "description": "Saint Kitts and Nevis" + }, + { + "name": "KP", + "description": "Democratic People's Republic of Korea" + }, + { + "name": "KR", + "description": "Republic of Korea" + }, + { + "name": "KW", + "description": "Kuwait" + }, + { + "name": "KY", + "description": "Cayman Islands" + }, + { + "name": "KZ", + "description": "Kazakhstan" + }, + { + "name": "LA", + "description": "Lao People's Democratic Republic" + }, + { + "name": "LB", + "description": "Lebanon" + }, + { + "name": "LC", + "description": "Saint Lucia" + }, + { + "name": "LI", + "description": "Liechtenstein" + }, + { + "name": "LK", + "description": "Sri Lanka" + }, + { + "name": "LR", + "description": "Liberia" + }, + { + "name": "LS", + "description": "Lesotho" + }, + { + "name": "LT", + "description": "Lithuania" + }, + { + "name": "LU", + "description": "Luxembourg" + }, + { + "name": "LV", + "description": "Latvia" + }, + { + "name": "LY", + "description": "Libya" + }, + { + "name": "MA", + "description": "Morocco" + }, + { + "name": "MC", + "description": "Monaco" + }, + { + "name": "MD", + "description": "Moldova" + }, + { + "name": "ME", + "description": "Montenegro" + }, + { + "name": "MF", + "description": "Saint Martin" + }, + { + "name": "MG", + "description": "Madagascar" + }, + { + "name": "MH", + "description": "Marshall Islands" + }, + { + "name": "MK", + "description": "North Macedonia" + }, + { + "name": "ML", + "description": "Mali" + }, + { + "name": "MM", + "description": "Myanmar" + }, + { + "name": "MN", + "description": "Mongolia" + }, + { + "name": "MO", + "description": "Macao" + }, + { + "name": "MP", + "description": "Northern Mariana Islands" + }, + { + "name": "MQ", + "description": "Martinique" + }, + { + "name": "MR", + "description": "Mauritania" + }, + { + "name": "MS", + "description": "Montserrat" + }, + { + "name": "MT", + "description": "Malta" + }, + { + "name": "MU", + "description": "Mauritius" + }, + { + "name": "MV", + "description": "Maldives" + }, + { + "name": "MW", + "description": "Malawi" + }, + { + "name": "MX", + "description": "Mexico" + }, + { + "name": "MY", + "description": "Malaysia" + }, + { + "name": "MZ", + "description": "Mozambique" + }, + { + "name": "NA", + "description": "Namibia" + }, + { + "name": "NC", + "description": "New Caledonia" + }, + { + "name": "NE", + "description": "Niger" + }, + { + "name": "NF", + "description": "Norfolk Island" + }, + { + "name": "NG", + "description": "Nigeria" + }, + { + "name": "NI", + "description": "Nicaragua" + }, + { + "name": "NL", + "description": "Netherlands" + }, + { + "name": "NO", + "description": "Norway" + }, + { + "name": "NP", + "description": "Nepal" + }, + { + "name": "NR", + "description": "Nauru" + }, + { + "name": "NU", + "description": "Niue" + }, + { + "name": "NZ", + "description": "New Zealand" + }, + { + "name": "OM", + "description": "Oman" + }, + { + "name": "PA", + "description": "Panama" + }, + { + "name": "PE", + "description": "Peru" + }, + { + "name": "PF", + "description": "French Polynesia" + }, + { + "name": "PG", + "description": "Papua New Guinea" + }, + { + "name": "PH", + "description": "Philippines" + }, + { + "name": "PK", + "description": "Pakistan" + }, + { + "name": "PL", + "description": "Poland" + }, + { + "name": "PM", + "description": "Saint Pierre and Miquelon" + }, + { + "name": "PN", + "description": "Pitcairn" + }, + { + "name": "PR", + "description": "Puerto Rico" + }, + { + "name": "PS", + "description": "Palestine" + }, + { + "name": "PT", + "description": "Portugal" + }, + { + "name": "PW", + "description": "Palau" + }, + { + "name": "PY", + "description": "Paraguay" + }, + { + "name": "QA", + "description": "Qatar" + }, + { + "name": "RE", + "description": "Réunion" + }, + { + "name": "RO", + "description": "Romania" + }, + { + "name": "RS", + "description": "Serbia" + }, + { + "name": "RU", + "description": "Russia" + }, + { + "name": "RW", + "description": "Rwanda" + }, + { + "name": "SA", + "description": "Saudi Arabia" + }, + { + "name": "SB", + "description": "Solomon Islands" + }, + { + "name": "SC", + "description": "Seychelles" + }, + { + "name": "SD", + "description": "Sudan" + }, + { + "name": "SE", + "description": "Sweden" + }, + { + "name": "SG", + "description": "Singapore" + }, + { + "name": "SH", + "description": "Saint Helena, Ascension and Tristan da Cunha" + }, + { + "name": "SI", + "description": "Slovenia" + }, + { + "name": "SJ", + "description": "Svalbard and Jan Mayen" + }, + { + "name": "SK", + "description": "Slovakia" + }, + { + "name": "SL", + "description": "Sierra Leone" + }, + { + "name": "SM", + "description": "San Marino" + }, + { + "name": "SN", + "description": "Senegal" + }, + { + "name": "SO", + "description": "Somalia" + }, + { + "name": "SR", + "description": "Suriname" + }, + { + "name": "SS", + "description": "South Sudan" + }, + { + "name": "ST", + "description": "Sao Tome and Principe" + }, + { + "name": "SV", + "description": "El Salvador" + }, + { + "name": "SX", + "description": "Sint Maarten" + }, + { + "name": "SY", + "description": "Syrian Arab Republic" + }, + { + "name": "SZ", + "description": "Eswatini" + }, + { + "name": "TC", + "description": "Turks and Caicos Islands" + }, + { + "name": "TD", + "description": "Chad" + }, + { + "name": "TF", + "description": "French Southern Territories" + }, + { + "name": "TG", + "description": "Togo" + }, + { + "name": "TH", + "description": "Thailand" + }, + { + "name": "TJ", + "description": "Tajikistan" + }, + { + "name": "TK", + "description": "Tokelau" + }, + { + "name": "TL", + "description": "Timor-Leste" + }, + { + "name": "TM", + "description": "Turkmenistan" + }, + { + "name": "TN", + "description": "Tunisia" + }, + { + "name": "TO", + "description": "Tonga" + }, + { + "name": "TR", + "description": "Turkey" + }, + { + "name": "TT", + "description": "Trinidad and Tobago" + }, + { + "name": "TV", + "description": "Tuvalu" + }, + { + "name": "TW", + "description": "Taiwan" + }, + { + "name": "TZ", + "description": "Tanzania" + }, + { + "name": "UA", + "description": "Ukraine" + }, + { + "name": "UG", + "description": "Uganda" + }, + { + "name": "UM", + "description": "United States Minor Outlying Islands" + }, + { + "name": "US", + "description": "United States of America" + }, + { + "name": "UY", + "description": "Uruguay" + }, + { + "name": "UZ", + "description": "Uzbekistan" + }, + { + "name": "VA", + "description": "Vatican City" + }, + { + "name": "VC", + "description": "Saint Vincent and the Grenadines" + }, + { + "name": "VE", + "description": "Venezuela" + }, + { + "name": "VG", + "description": "British Virgin Islands" + }, + { + "name": "VI", + "description": "U.S. Virgin Islands" + }, + { + "name": "VN", + "description": "Vietnam" + }, + { + "name": "VU", + "description": "Vanuatu" + }, + { + "name": "WF", + "description": "Wallis and Futuna" + }, + { + "name": "WS", + "description": "Samoa" + }, + { + "name": "YE", + "description": "Yemen" + }, + { + "name": "YT", + "description": "Mayotte" + }, + { + "name": "ZA", + "description": "South Africa" + }, + { + "name": "ZM", + "description": "Zambia" + }, + { + "name": "ZW", + "description": "Zimbabwe" + } + ], + "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", + "x-release-status": "PUBLIC" + }, + "CreateBookingCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition to create, with the following fields:\n\n- `key`\n\n- `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute\ndefinitions for the seller.\n\n- `description`\n\n- `visibility`. Note that all custom attributes are visible in exported booking data, including those set to\n`VISIBILITY_HIDDEN`.\n\n- `schema`. With the exception of the `Selection` data type, the `schema` is specified as a\nsimple URL to the JSON schema definition hosted on the Square CDN. For more information, see\n[Specifying the schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema)." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45 + } + } + }, + "CreateBookingCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The newly created custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-11-16T15:27:30Z", + "description": "The favorite shampoo of the customer.", + "key": "favoriteShampoo", + "name": "Favorite Shampoo", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-11-16T15:27:30Z", + "version": 1, + "visibility": "VISIBILITY_HIDDEN" + }, + "errors": [] + } + }, + "CreateBookingRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "booking" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique key to make this request an idempotent operation.", + "maxLength": 255 + }, + "booking": { + "$ref": "#/components/schemas/Booking", + "description": "The details of the booking to be created." + } + } + }, + "CreateBookingResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "booking": { + "$ref": "#/components/schemas/Booking", + "description": "The booking that was created." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "booking": { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "created_at": "2020-10-28T15:47:41Z", + "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M", + "customer_note": "", + "id": "zkras0xv0xwswx", + "location_id": "LEQHH0YY8B42M", + "seller_note": "", + "start_at": "2020-11-26T13:00:00Z", + "status": "ACCEPTED", + "updated_at": "2020-10-28T15:47:41Z", + "version": 0 + }, + "errors": [] + } + }, + "CreateBreakTypeRequest": { + "type": "object", + "description": "A request to create a new `BreakType`.", + "x-release-status": "PUBLIC", + "required": [ + "break_type" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string value to ensure the idempotency of the operation.", + "maxLength": 128 + }, + "break_type": { + "$ref": "#/components/schemas/BreakType", + "description": "The `BreakType` to be created." + } + }, + "example": { + "break_type": { + "break_name": "Lunch Break", + "expected_duration": "PT30M", + "is_paid": true, + "location_id": "CGJN03P1D08GF" + }, + "idempotency_key": "PAD3NG5KSN2GL" + } + }, + "CreateBreakTypeResponse": { + "type": "object", + "description": "The response to the request to create a `BreakType`. The response contains\nthe created `BreakType` object and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "break_type": { + "$ref": "#/components/schemas/BreakType", + "description": "The `BreakType` that was created by the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "break_type": { + "break_name": "Lunch Break", + "created_at": "2019-02-26T22:42:54Z", + "expected_duration": "PT30M", + "id": "49SSVDJG76WF3", + "is_paid": true, + "location_id": "CGJN03P1D08GF", + "updated_at": "2019-02-26T22:42:54Z", + "version": 1 + } + } + }, + "CreateCardRequest": { + "type": "object", + "description": "Creates a card from the source (payment token or payment id). Accessible via\nHTTP requests at POST https://connect.squareup.com/v2/cards", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "source_id", + "card" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this CreateCard request. Keys can be\nany valid string and must be unique for every request.\n\nMax: 45 characters\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1 + }, + "source_id": { + "type": "string", + "description": "The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id.", + "minLength": 1, + "maxLength": 16384 + }, + "verification_token": { + "type": "string", + "description": "An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).\nVerification tokens encapsulate customer device information and 3-D Secure\nchallenge results to indicate that Square has verified the buyer identity.\n\nSee the [SCA Overview](https://developer.squareup.com/docs/sca-overview)." + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "Payment details associated with the card to be stored." + } + }, + "example": { + "card": { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "cardholder_name": "Amelia Earhart", + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "reference_id": "user-id-1" + }, + "idempotency_key": "4935a656-a929-4792-b97c-8848be85c27c", + "source_id": "cnon:uIbfJXhXETSP197M3GB" + } + }, + "CreateCardResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](api-endpoint:Cards-CreateCard) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors resulting from the request." + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "The card created by the request." + } + }, + "example": { + "card": { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "bin": "411111", + "card_brand": "VISA", + "card_type": "CREDIT", + "cardholder_name": "Amelia Earhart", + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "enabled": true, + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q", + "hsa_fsa": false, + "id": "ccof:uIbfJXhXETSP197M3GB", + "last_4": "1111", + "merchant_id": "6SSW7HV8K2ST5", + "prepaid_type": "NOT_PREPAID", + "reference_id": "user-id-1", + "version": 1 + } + } + }, + "CreateCatalogImageRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "image" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this CreateCatalogImage request.\nKeys can be any valid string but must be unique for every CreateCatalogImage request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 128 + }, + "object_id": { + "type": "string", + "description": "Unique ID of the `CatalogObject` to attach this `CatalogImage` object to. Leave this\nfield empty to create unattached images, for example if you are building an integration\nwhere an image can be attached to catalog items at a later time." + }, + "image": { + "$ref": "#/components/schemas/CatalogObject", + "description": "The new `CatalogObject` of the `IMAGE` type, namely, a `CatalogImage` object, to encapsulate the specified image file." + }, + "is_primary": { + "type": "boolean", + "description": "If this is set to `true`, the image created will be the primary, or first image of the object referenced by `object_id`.\nIf the `CatalogObject` already has a primary `CatalogImage`, setting this field to `true` will replace the primary image.\nIf this is set to `false` and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of `image_ids` on the object.\n\nWith Square API version 2021-12-15 or later, the default value is `false`. Otherwise, the effective default value is `true`.", + "x-release-status": "BETA" + } + }, + "example": { + "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86", + "image": { + "id": "#TEMP_ID", + "image_data": { + "caption": "A picture of a cup of coffee" + }, + "type": "IMAGE" + }, + "object_id": "ND6EA5AAJEO5WL3JNNIAQA32" + } + }, + "CreateCatalogImageResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "image": { + "$ref": "#/components/schemas/CatalogObject", + "description": "The newly created `CatalogImage` including a Square-generated\nURL for the encapsulated image file." + } + }, + "example": { + "image": { + "id": "KQLFFHA6K6J3YQAQAWDQAL57", + "image_data": { + "caption": "A picture of a cup of coffee", + "url": "https://..." + }, + "type": "IMAGE" + } + } + }, + "CreateCheckoutRequest": { + "type": "object", + "description": "Defines the parameters that can be included in the body of\na request to the `CreateCheckout` endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "order" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this checkout among others you have created. It can be\nany valid string but must be unique for every order sent to Square Checkout for a given location ID.\n\nThe idempotency key is used to avoid processing the same order more than once. If you are \nunsure whether a particular checkout was created successfully, you can attempt it again with\nthe same idempotency key and all the same other parameters without worrying about creating duplicates.\n\nYou should use a random number/string generator native to the language\nyou are working in to generate strings for your idempotency keys.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 192 + }, + "order": { + "$ref": "#/components/schemas/CreateOrderRequest", + "description": "The order including line items to be checked out." + }, + "ask_for_shipping_address": { + "type": "boolean", + "description": "If `true`, Square Checkout collects shipping information on your behalf and stores \nthat information with the transaction information in the Square Seller Dashboard.\n\nDefault: `false`." + }, + "merchant_support_email": { + "type": "string", + "description": "The email address to display on the Square Checkout confirmation page\nand confirmation email that the buyer can use to contact the seller.\n\nIf this value is not set, the confirmation page and email display the\nprimary email address associated with the seller's Square account.\n\nDefault: none; only exists if explicitly set.", + "maxLength": 254 + }, + "pre_populate_buyer_email": { + "type": "string", + "description": "If provided, the buyer's email is prepopulated on the checkout page\nas an editable text field.\n\nDefault: none; only exists if explicitly set.", + "maxLength": 254 + }, + "pre_populate_shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "If provided, the buyer's shipping information is prepopulated on the\ncheckout page as editable text fields.\n\nDefault: none; only exists if explicitly set." + }, + "redirect_url": { + "type": "string", + "description": "The URL to redirect to after the checkout is completed with `checkoutId`,\n`transactionId`, and `referenceId` appended as URL parameters. For example,\nif the provided redirect URL is `http://www.example.com/order-complete`, a\nsuccessful transaction redirects the customer to:\n\n`http://www.example.com/order-complete?checkoutId=xxxxxx\u0026amp;referenceId=xxxxxx\u0026amp;transactionId=xxxxxx`\n\nIf you do not provide a redirect URL, Square Checkout displays an order\nconfirmation page on your behalf; however, it is strongly recommended that\nyou provide a redirect URL so you can verify the transaction results and\nfinalize the order through your existing/normal confirmation workflow.\n\nDefault: none; only exists if explicitly set.", + "maxLength": 800 + }, + "additional_recipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChargeRequestAdditionalRecipient" + }, + "description": "The basic primitive of a multi-party transaction. The value is optional.\nThe transaction facilitated by you can be split from here.\n\nIf you provide this value, the `amount_money` value in your `additional_recipients` field\ncannot be more than 90% of the `total_money` calculated by Square for your order.\nThe `location_id` must be a valid seller location where the checkout is occurring.\n\nThis field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.\n\nThis field is currently not supported in the Square Sandbox." + }, + "note": { + "type": "string", + "description": "An optional note to associate with the `checkout` object.\n\nThis value cannot exceed 60 characters.", + "maxLength": 60 + } + }, + "example": { + "additional_recipients": [ + { + "amount_money": { + "amount": 60, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "ask_for_shipping_address": true, + "idempotency_key": "86ae1696-b1e3-4328-af6d-f1e04d947ad6", + "merchant_support_email": "merchant+support@website.com", + "order": { + "idempotency_key": "12ae1696-z1e3-4328-af6d-f1e04d947gd4", + "order": { + "customer_id": "customer_id", + "discounts": [ + { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "scope": "LINE_ITEM", + "type": "FIXED_AMOUNT", + "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4" + } + ], + "line_items": [ + { + "applied_discounts": [ + { + "discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4" + } + ], + "applied_taxes": [ + { + "tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3" + } + ], + "base_price_money": { + "amount": 1500, + "currency": "USD" + }, + "name": "Printed T Shirt", + "quantity": "2" + }, + { + "base_price_money": { + "amount": 2500, + "currency": "USD" + }, + "name": "Slim Jeans", + "quantity": "1" + }, + { + "base_price_money": { + "amount": 3500, + "currency": "USD" + }, + "name": "Woven Sweater", + "quantity": "3" + } + ], + "location_id": "location_id", + "reference_id": "reference_id", + "taxes": [ + { + "percentage": "7.75", + "scope": "LINE_ITEM", + "type": "INCLUSIVE", + "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3" + } + ] + } + }, + "pre_populate_buyer_email": "example@email.com", + "pre_populate_shipping_address": { + "address_line_1": "1455 Market St.", + "address_line_2": "Suite 600", + "administrative_district_level_1": "CA", + "country": "US", + "first_name": "Jane", + "last_name": "Doe", + "locality": "San Francisco", + "postal_code": "94103" + }, + "redirect_url": "https://merchant.website.com/order-confirm" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateCheckout/CreateCheckoutRequest.csharp", + "java": "/sdk_samples/CreateCheckout/CreateCheckoutRequest.java", + "javascript": "/sdk_samples/CreateCheckout/CreateCheckoutRequest.javascript", + "php": "/sdk_samples/CreateCheckout/CreateCheckoutRequest.php", + "python": "/sdk_samples/CreateCheckout/CreateCheckoutRequest.python", + "ruby": "/sdk_samples/CreateCheckout/CreateCheckoutRequest.ruby" + } + }, + "CreateCheckoutResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `CreateCheckout` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "checkout": { + "$ref": "#/components/schemas/Checkout", + "description": "The newly created `checkout` object associated with the provided idempotency key." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "checkout": { + "additional_recipients": [ + { + "amount_money": { + "amount": 60, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "ask_for_shipping_address": true, + "checkout_page_url": "https://connect.squareup.com/v2/checkout?c=CAISEHGimXh-C3RIT4og1a6u1qw\u0026l=CYTKRM7R7JMV8", + "created_at": "2017-06-16T22:25:35Z", + "id": "CAISEHGimXh-C3RIT4og1a6u1qw", + "merchant_support_email": "merchant+support@website.com", + "order": { + "customer_id": "customer_id", + "discounts": [ + { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "applied_money": { + "amount": 100, + "currency": "USD" + }, + "scope": "LINE_ITEM", + "type": "FIXED_AMOUNT", + "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4" + } + ], + "line_items": [ + { + "applied_discounts": [ + { + "applied_money": { + "amount": 100, + "currency": "USD" + }, + "discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4" + } + ], + "applied_taxes": [ + { + "applied_money": { + "amount": 103, + "currency": "USD" + }, + "tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3" + } + ], + "base_price_money": { + "amount": 1500, + "currency": "USD" + }, + "name": "Printed T Shirt", + "quantity": "2", + "total_discount_money": { + "amount": 100, + "currency": "USD" + }, + "total_money": { + "amount": 1503, + "currency": "USD" + }, + "total_tax_money": { + "amount": 103, + "currency": "USD" + } + }, + { + "base_price_money": { + "amount": 2500, + "currency": "USD" + }, + "name": "Slim Jeans", + "quantity": "1", + "total_money": { + "amount": 2500, + "currency": "USD" + } + }, + { + "base_price_money": { + "amount": 3500, + "currency": "USD" + }, + "name": "Woven Sweater", + "quantity": "3", + "total_money": { + "amount": 10500, + "currency": "USD" + } + } + ], + "location_id": "location_id", + "reference_id": "reference_id", + "taxes": [ + { + "percentage": "7.75", + "scope": "LINE_ITEM", + "type": "INCLUSIVE", + "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3" + } + ], + "total_discount_money": { + "amount": 100, + "currency": "USD" + }, + "total_money": { + "amount": 14503, + "currency": "USD" + }, + "total_tax_money": { + "amount": 103, + "currency": "USD" + } + }, + "pre_populate_buyer_email": "example@email.com", + "pre_populate_shipping_address": { + "address_line_1": "1455 Market St.", + "address_line_2": "Suite 600", + "administrative_district_level_1": "CA", + "country": "US", + "first_name": "Jane", + "last_name": "Doe", + "locality": "San Francisco", + "postal_code": "94103" + }, + "redirect_url": "https://merchant.website.com/order-confirm", + "version": 1 + } + } + }, + "CreateCustomerCardRequest": { + "type": "object", + "description": "Defines the fields that are included in the request body of a request\nto the `CreateCustomerCard` endpoint.", + "x-release-status": "DEPRECATED", + "required": [ + "card_nonce" + ], + "properties": { + "card_nonce": { + "type": "string", + "description": "A card nonce representing the credit card to link to the customer.\n\nCard nonces are generated by the Square payment form when customers enter\ntheir card information. For more information, see\n[Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment).\n\n__NOTE:__ Card nonces generated by digital wallets (such as Apple Pay)\ncannot be used to create a customer card." + }, + "billing_address": { + "$ref": "#/components/schemas/Address", + "description": "Address information for the card on file.\n\n__NOTE:__ If a billing address is provided in the request, the\n`CreateCustomerCardRequest.billing_address.postal_code` must match\nthe postal code encoded in the card nonce." + }, + "cardholder_name": { + "type": "string", + "description": "The full name printed on the credit card." + }, + "verification_token": { + "type": "string", + "description": "An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).\nVerification tokens encapsulate customer device information and 3-D Secure\nchallenge results to indicate that Square has verified the buyer identity." + } + }, + "example": { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "card_nonce": "YOUR_CARD_NONCE", + "cardholder_name": "Amelia Earhart" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.csharp", + "java": "/sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.java", + "javascript": "/sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.javascript", + "php": "/sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.php", + "python": "/sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.python", + "ruby": "/sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.ruby" + } + }, + "CreateCustomerCardResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `CreateCustomerCard` endpoint.\n\nEither `errors` or `card` is present in a given response (never both).", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "The created card on file." + } + }, + "example": { + "card": { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "card_brand": "VISA", + "cardholder_name": "Amelia Earhart", + "exp_month": 11, + "exp_year": 2018, + "id": "icard-card_id", + "last_4": "1111" + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.csharp", + "java": "/sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.java", + "javascript": "/sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.javascript", + "php": "/sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.php", + "python": "/sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.python", + "ruby": "/sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.ruby" + } + }, + "CreateCustomerCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition to create. Note the following:\n- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema\ndefinition hosted on the Square CDN. For more information, including supported values and constraints, see\n[Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema).\n- If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller.\n- All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45 + } + }, + "example": { + "custom_attribute_definition": { + "description": "The favorite movie of the customer.", + "key": "favoritemovie", + "name": "Favorite Movie", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "visibility": "VISIBILITY_HIDDEN" + } + } + }, + "CreateCustomerCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The new custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-04-26T15:27:30Z", + "description": "The favorite movie of the customer.", + "key": "favoritemovie", + "name": "Favorite Movie", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-04-26T15:27:30Z", + "version": 1, + "visibility": "VISIBILITY_HIDDEN" + } + } + }, + "CreateCustomerGroupRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "group" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." + }, + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "The customer group to create." + } + }, + "example": { + "group": { + "name": "Loyal Customers" + } + } + }, + "CreateCustomerGroupResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "The successfully created customer group." + } + }, + "example": { + "group": { + "created_at": "2020-04-13T21:54:57.863Z", + "id": "2TAT3CMH4Q0A9M87XJZED0WMR3", + "name": "Loyal Customers", + "updated_at": "2020-04-13T21:54:58Z" + } + } + }, + "CreateCustomerRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in a request to the\n`CreateCustomer` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "idempotency_key": { + "type": "string", + "description": "The idempotency key for the request.\tFor more information, see\n[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." + }, + "given_name": { + "type": "string", + "description": "The given name (that is, the first name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters." + }, + "family_name": { + "type": "string", + "description": "The family name (that is, the last name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters." + }, + "company_name": { + "type": "string", + "description": "A business name associated with the customer profile.\n\nThe maximum length for this value is 500 characters." + }, + "nickname": { + "type": "string", + "description": "A nickname for the customer profile.\n\nThe maximum length for this value is 100 characters." + }, + "email_address": { + "type": "string", + "description": "The email address associated with the customer profile.\n\nThe maximum length for this value is 254 characters." + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The physical address associated with the customer profile. For maximum length constraints, see \n[Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address).\nThe `first_name` and `last_name` fields are ignored if they are present in the request." + }, + "phone_number": { + "type": "string", + "description": "The phone number associated with the customer profile. The phone number must be valid and can contain\n9–16 digits, with an optional `+` prefix and country code. For more information, see\n[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number)." + }, + "reference_id": { + "type": "string", + "description": "An optional second ID used to associate the customer profile with an\nentity in another system.\n\nThe maximum length for this value is 100 characters." + }, + "note": { + "type": "string", + "description": "A custom note associated with the customer profile." + }, + "birthday": { + "type": "string", + "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,\nspecify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`\nformat, where `YYYY` is the specified birth year or `0000` if a birth year is not specified." + }, + "tax_ids": { + "$ref": "#/components/schemas/CustomerTaxIds", + "description": "The tax ID associated with the customer profile. This field is available only for customers of sellers\nin EU countries or the United Kingdom. For more information,\nsee [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids)." + } + }, + "example": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "note": "a customer", + "phone_number": "+1-212-555-4240", + "reference_id": "YOUR_REFERENCE_ID" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateCustomer/CreateCustomerRequest.csharp", + "java": "/sdk_samples/CreateCustomer/CreateCustomerRequest.java", + "javascript": "/sdk_samples/CreateCustomer/CreateCustomerRequest.javascript", + "php": "/sdk_samples/CreateCustomer/CreateCustomerRequest.php", + "python": "/sdk_samples/CreateCustomer/CreateCustomerRequest.python", + "ruby": "/sdk_samples/CreateCustomer/CreateCustomerRequest.ruby" + } + }, + "CreateCustomerResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomer](api-endpoint:Customers-CreateCustomer) or\n[BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "customer": { + "$ref": "#/components/schemas/Customer", + "description": "The created customer." + } + }, + "example": { + "customer": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2016-03-23T20:21:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "note": "a customer", + "phone_number": "+1-212-555-4240", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID", + "updated_at": "2016-03-23T20:21:54.859Z", + "version": 0 + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateCustomer/CreateCustomerResponse.csharp", + "java": "/sdk_samples/CreateCustomer/CreateCustomerResponse.java", + "javascript": "/sdk_samples/CreateCustomer/CreateCustomerResponse.javascript", + "php": "/sdk_samples/CreateCustomer/CreateCustomerResponse.php", + "python": "/sdk_samples/CreateCustomer/CreateCustomerResponse.python", + "ruby": "/sdk_samples/CreateCustomer/CreateCustomerResponse.ruby" + } + }, + "CreateDeviceCodeRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "device_code" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this CreateDeviceCode request. Keys can\nbe any valid string but must be unique for every CreateDeviceCode request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 128 + }, + "device_code": { + "$ref": "#/components/schemas/DeviceCode", + "description": "The device code to create." + } + }, + "example": { + "device_code": { + "location_id": "B5E4484SHHNYH", + "name": "Counter 1", + "product_type": "TERMINAL_API" + }, + "idempotency_key": "01bb00a6-0c86-4770-94ed-f5fca973cd56" + } + }, + "CreateDeviceCodeResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "device_code": { + "$ref": "#/components/schemas/DeviceCode", + "description": "The created DeviceCode object containing the device code string." + } + }, + "example": { + "device_code": { + "code": "EBCARJ", + "created_at": "2020-02-06T18:44:33.000Z", + "id": "B3Z6NAMYQSMTM", + "location_id": "B5E4484SHHNYH", + "name": "Counter 1", + "pair_by": "2020-02-06T18:49:33.000Z", + "product_type": "TERMINAL_API", + "status": "UNPAIRED", + "status_changed_at": "2020-02-06T18:44:33.000Z" + } + } + }, + "CreateDisputeEvidenceFileRequest": { + "type": "object", + "description": "Defines the parameters for a `CreateDisputeEvidenceFile` request.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 45 + }, + "evidence_type": { + "$ref": "#/components/schemas/DisputeEvidenceType", + "description": "The type of evidence you are uploading.\nSee [DisputeEvidenceType](#type-disputeevidencetype) for possible values" + }, + "content_type": { + "type": "string", + "description": "The MIME type of the uploaded file.\nThe type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.", + "minLength": 1, + "maxLength": 40 + } + } + }, + "CreateDisputeEvidenceFileResponse": { + "type": "object", + "description": "Defines the fields in a `CreateDisputeEvidenceFile` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "evidence": { + "$ref": "#/components/schemas/DisputeEvidence", + "description": "The metadata of the newly uploaded dispute evidence." + } + }, + "example": { + "evidence": { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_file": { + "filename": "customer-interaction.jpg", + "filetype": "image/jpeg" + }, + "id": "TOomLInj6iWmP3N8qfCXrB", + "uploaded_at": "2022-05-18T16:01:10.000Z" + } + } + }, + "CreateDisputeEvidenceTextRequest": { + "type": "object", + "description": "Defines the parameters for a `CreateDisputeEvidenceText` request.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "evidence_text" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 45 + }, + "evidence_type": { + "$ref": "#/components/schemas/DisputeEvidenceType", + "description": "The type of evidence you are uploading.\nSee [DisputeEvidenceType](#type-disputeevidencetype) for possible values" + }, + "evidence_text": { + "type": "string", + "description": "The evidence string.", + "minLength": 1, + "maxLength": 500 + } + }, + "example": { + "evidence_text": "1Z8888888888888888", + "evidence_type": "TRACKING_NUMBER", + "idempotency_key": "ed3ee3933d946f1514d505d173c82648" + } + }, + "CreateDisputeEvidenceTextResponse": { + "type": "object", + "description": "Defines the fields in a `CreateDisputeEvidenceText` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "evidence": { + "$ref": "#/components/schemas/DisputeEvidence", + "description": "The newly uploaded dispute evidence metadata." + } + }, + "example": { + "evidence": { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_text": "The customer purchased the item twice, on April 11 and April 28.", + "evidence_type": "REBUTTAL_EXPLANATION", + "id": "TOomLInj6iWmP3N8qfCXrB", + "uploaded_at": "2022-05-18T16:01:10.000Z" + } + } + }, + "CreateGiftCardActivityRequest": { + "type": "object", + "description": "A request to create a gift card activity.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "gift_card_activity" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the `CreateGiftCardActivity` request.", + "minLength": 1, + "maxLength": 128 + }, + "gift_card_activity": { + "$ref": "#/components/schemas/GiftCardActivity", + "description": "The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target\ngift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details." + } + }, + "example": { + "gift_card_activity": { + "activate_activity_details": { + "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", + "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY" + }, + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "location_id": "81FN9BNFZTKS4", + "type": "ACTIVATE" + }, + "idempotency_key": "U16kfr-kA70er-q4Rsym-7U7NnY" + } + }, + "CreateGiftCardActivityResponse": { + "type": "object", + "description": "A response that contains a `GiftCardActivity` that was created.\nThe response might contain a set of `Error` objects if the request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card_activity": { + "$ref": "#/components/schemas/GiftCardActivity", + "description": "The gift card activity that was created." + } + }, + "example": { + "gift_card_activity": { + "activate_activity_details": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", + "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gift_card_balance_money": { + "amount": 1000, + "currency": "USD" + }, + "gift_card_gan": "7783320002929081", + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "id": "gcact_c8f8cbf1f24b448d8ecf39ed03f97864", + "location_id": "81FN9BNFZTKS4", + "type": "ACTIVATE" + } + } + }, + "CreateGiftCardRequest": { + "type": "object", + "description": "Represents a [CreateGiftCard](api-endpoint:GiftCards-CreateGiftCard) request.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "location_id", + "gift_card" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information, \nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 128 + }, + "location_id": { + "type": "string", + "description": "The ID of the [location](entity:Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller's locations.", + "minLength": 1 + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "The gift card to create. The `type` field is required for this request. The `gan_source` \nand `gan` fields are included as follows: \n\nTo direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`.\n\nTo provide a custom GAN, include `gan_source` and `gan`.\n- For `gan_source`, specify `OTHER`. \n- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be \nunique for the seller and cannot start with the same bank identification number (BIN) as major \ncredit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly \nincrease the risk of fraud. It is the responsibility of the developer to ensure the security \nof their custom GANs. For more information, see \n[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). \n\nTo register an unused, physical gift card that the seller previously ordered from Square, \ninclude `gan` and provide the GAN that is printed on the gift card." + } + }, + "example": { + "gift_card": { + "type": "DIGITAL" + }, + "idempotency_key": "NC9Tm69EjbjtConu", + "location_id": "81FN9BNFZTKS4" + } + }, + "CreateGiftCardResponse": { + "type": "object", + "description": "A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request\nresulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "The new gift card." + } + }, + "example": { + "gift_card": { + "balance_money": { + "amount": 0, + "currency": "USD" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gan": "7783320006753271", + "gan_source": "SQUARE", + "id": "gftc:6cbacbb64cf54e2ca9f573d619038059", + "state": "PENDING", + "type": "DIGITAL" + } + } + }, + "CreateInvoiceAttachmentRequest": { + "type": "object", + "description": "Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) request.", + "x-release-status": "PUBLIC", + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the `CreateInvoiceAttachment` request.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 128 + }, + "description": { + "type": "string", + "description": "The description of the attachment to display on the invoice.", + "maxLength": 128 + } + }, + "example": { + "description": "Service contract", + "idempotency_key": "ae5e84f9-4742-4fc1-ba12-a3ce3748f1c3" + } + }, + "CreateInvoiceAttachmentResponse": { + "type": "object", + "description": "Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) response.", + "x-release-status": "PUBLIC", + "properties": { + "attachment": { + "$ref": "#/components/schemas/InvoiceAttachment", + "description": "Metadata about the attachment that was added to the invoice." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "attachment": { + "description": "Service contract", + "filename": "file.jpg", + "filesize": 102705, + "hash": "273ee02cb6f5f8a3a8ca23604930dd53", + "id": "inva:0-3bB9ZuDHiziThQhuC4fwWt", + "mime_type": "image/jpeg", + "uploaded_at": "2023-02-03T20:28:14Z" + } + } + }, + "CreateInvoiceRequest": { + "type": "object", + "description": "Describes a `CreateInvoice` request.", + "x-release-status": "PUBLIC", + "required": [ + "invoice" + ], + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The invoice to create." + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the `CreateInvoice` request. If you do not \nprovide `idempotency_key` (or provide an empty string as the value), the endpoint \ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 128 + } + }, + "example": { + "idempotency_key": "ce3748f9-5fc1-4762-aa12-aae5e843f1f4", + "invoice": { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1 + } + ], + "request_type": "BALANCE", + "tipping_enabled": true + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "store_payment_method_enabled": false, + "title": "Event Planning Services" + } + } + }, + "CreateInvoiceResponse": { + "type": "object", + "description": "The response returned by the `CreateInvoice` request.", + "x-release-status": "PUBLIC", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The newly created invoice." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "invoice": { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "created_at": "2020-06-18T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1, + "status": "PENDING", + "uid": "beebd363-e47f-4075-8785-c235aaa7df11" + } + ], + "request_type": "BALANCE", + "tipping_enabled": true, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "DRAFT", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2020-06-18T17:45:13Z", + "version": 0 + } + } + }, + "CreateJobRequest": { + "type": "object", + "description": "Represents a [CreateJob](api-endpoint:Team-CreateJob) request.", + "x-release-status": "BETA", + "required": [ + "job", + "idempotency_key" + ], + "properties": { + "job": { + "$ref": "#/components/schemas/Job", + "description": "The job to create. The `title` field is required and `is_tip_eligible` defaults to true." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for the `CreateJob` request. Keys can be any valid string,\nbut must be unique for each request. For more information, see\n[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 45 + } + }, + "example": { + "idempotency_key": "idempotency-key-0", + "job": { + "is_tip_eligible": true, + "title": "Cashier" + } + } + }, + "CreateJobResponse": { + "type": "object", + "description": "Represents a [CreateJob](api-endpoint:Team-CreateJob) response. Either `job` or `errors`\nis present in the response.", + "x-release-status": "BETA", + "properties": { + "job": { + "$ref": "#/components/schemas/Job", + "description": "The new job." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "job": { + "created_at": "2021-06-11T22:55:45Z", + "id": "1yJlHapkseYnNPETIU1B", + "is_tip_eligible": true, + "title": "Cashier", + "updated_at": "2021-06-11T22:55:45Z", + "version": 1 + } + } + }, + "CreateLocationCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition to create. Note the following:\n- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema\ndefinition hosted on the Square CDN. For more information, including supported values and constraints, see\n[Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).\n- `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45 + } + }, + "example": { + "custom_attribute_definition": { + "description": "Bestselling item at location", + "key": "bestseller", + "name": "Bestseller", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "CreateLocationCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The new custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-12-02T19:06:36.559Z", + "description": "Bestselling item at location", + "key": "bestseller", + "name": "Bestseller", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-12-02T19:06:36.559Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "CreateLocationRequest": { + "type": "object", + "description": "The request object for the [CreateLocation](api-endpoint:Locations-CreateLocation) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "location": { + "$ref": "#/components/schemas/Location", + "description": "The initial values of the location being created. The `name` field is required and must be unique within a seller account.\nAll other fields are optional, but any information you care about for the location should be included.\nThe remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location)." + } + }, + "example": { + "location": { + "address": { + "address_line_1": "1234 Peachtree St. NE", + "administrative_district_level_1": "GA", + "locality": "Atlanta", + "postal_code": "30309" + }, + "description": "Midtown Atlanta store", + "name": "Midtown" + } + } + }, + "CreateLocationResponse": { + "type": "object", + "description": "The response object returned by the [CreateLocation](api-endpoint:Locations-CreateLocation) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request." + }, + "location": { + "$ref": "#/components/schemas/Location", + "description": "The newly created `Location` object." + } + }, + "example": { + "location": { + "address": { + "address_line_1": "1234 Peachtree St. NE", + "administrative_district_level_1": "GA", + "locality": "Atlanta", + "postal_code": "30309" + }, + "business_name": "Jet Fuel Coffee", + "capabilities": [ + "CREDIT_CARD_PROCESSING" + ], + "coordinates": { + "latitude": 33.7889, + "longitude": -84.3841 + }, + "country": "US", + "created_at": "2022-02-19T17:58:25Z", + "currency": "USD", + "description": "Midtown Atlanta store", + "id": "3Z4V4WHQK64X9", + "language_code": "en-US", + "mcc": "7299", + "merchant_id": "3MYCJG5GVYQ8Q", + "name": "Midtown", + "status": "ACTIVE", + "timezone": "America/New_York", + "type": "PHYSICAL" + } + } + }, + "CreateLoyaltyAccountRequest": { + "type": "object", + "description": "A request to create a new loyalty account.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_account", + "idempotency_key" + ], + "properties": { + "loyalty_account": { + "$ref": "#/components/schemas/LoyaltyAccount", + "description": "The loyalty account to create." + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateLoyaltyAccount` request. \nKeys can be any valid string, but must be unique for every request.", + "minLength": 1, + "maxLength": 128 + } + }, + "example": { + "idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996", + "loyalty_account": { + "mapping": { + "phone_number": "+14155551234" + }, + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd" + } + } + }, + "CreateLoyaltyAccountResponse": { + "type": "object", + "description": "A response that includes loyalty account created.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_account": { + "$ref": "#/components/schemas/LoyaltyAccount", + "description": "The newly created loyalty account." + } + }, + "example": { + "loyalty_account": { + "balance": 0, + "created_at": "2020-05-08T21:44:32Z", + "customer_id": "QPTXM8PQNX3Q726ZYHPMNP46XC", + "id": "79b807d2-d786-46a9-933b-918028d7a8c5", + "lifetime_points": 0, + "mapping": { + "created_at": "2020-05-08T21:44:32Z", + "id": "66aaab3f-da99-49ed-8b19-b87f851c844f", + "phone_number": "+14155551234" + }, + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "updated_at": "2020-05-08T21:44:32Z" + } + } + }, + "CreateLoyaltyPromotionRequest": { + "type": "object", + "description": "Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd", + "required": [ + "loyalty_promotion", + "idempotency_key" + ], + "properties": { + "loyalty_promotion": { + "$ref": "#/components/schemas/LoyaltyPromotion", + "description": "The loyalty promotion to create." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, which is used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 128 + } + }, + "example": { + "idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996", + "loyalty_promotion": { + "available_time": { + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "incentive": { + "points_multiplier_data": { + "multiplier": "3.0" + }, + "type": "POINTS_MULTIPLIER" + }, + "minimum_spend_amount_money": { + "amount": 2000, + "currency": "USD" + }, + "name": "Tuesday Happy Hour Promo", + "qualifying_category_ids": [ + "XTQPYLR3IIU9C44VRCB3XD12" + ], + "trigger_limit": { + "interval": "DAY", + "times": 1 + } + } + } + }, + "CreateLoyaltyPromotionResponse": { + "type": "object", + "description": "Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_promotion": { + "$ref": "#/components/schemas/LoyaltyPromotion", + "description": "The new loyalty promotion." + } + }, + "example": { + "loyalty_promotion": { + "available_time": { + "start_date": "2022-08-16", + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "created_at": "2022-08-16T08:38:54Z", + "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67", + "incentive": { + "points_multiplier_data": { + "multiplier": "3.000", + "points_multiplier": 3 + }, + "type": "POINTS_MULTIPLIER" + }, + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "minimum_spend_amount_money": { + "amount": 2000, + "currency": "USD" + }, + "name": "Tuesday Happy Hour Promo", + "qualifying_category_ids": [ + "XTQPYLR3IIU9C44VRCB3XD12" + ], + "status": "ACTIVE", + "trigger_limit": { + "interval": "DAY", + "times": 1 + }, + "updated_at": "2022-08-16T08:38:54Z" + } + } + }, + "CreateLoyaltyRewardRequest": { + "type": "object", + "description": "A request to create a loyalty reward.", + "x-release-status": "PUBLIC", + "required": [ + "reward", + "idempotency_key" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/LoyaltyReward", + "description": "The reward to create." + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateLoyaltyReward` request. \nKeys can be any valid string, but must be unique for every request.", + "minLength": 1, + "maxLength": 128 + } + }, + "example": { + "idempotency_key": "18c2e5ea-a620-4b1f-ad60-7b167285e451", + "reward": { + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f" + } + } + }, + "CreateLoyaltyRewardResponse": { + "type": "object", + "description": "A response that includes the loyalty reward created.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "reward": { + "$ref": "#/components/schemas/LoyaltyReward", + "description": "The loyalty reward created." + } + }, + "example": { + "reward": { + "created_at": "2020-05-01T21:49:54Z", + "id": "a8f43ebe-2ad6-3001-bdd5-7d7c2da08943", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + "points": 10, + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "status": "ISSUED", + "updated_at": "2020-05-01T21:49:54Z" + } + } + }, + "CreateMerchantCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition to create. Note the following:\n- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema\ndefinition hosted on the Square CDN. For more information, including supported values and constraints, see\n[Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).\n- `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45 + } + }, + "example": { + "custom_attribute_definition": { + "description": "This is the other name this merchant goes by.", + "key": "alternative_seller_name", + "name": "Alternative Merchant Name", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "CreateMerchantCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The new custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2023-05-05T19:06:36.559Z", + "description": "This is the other name this merchant goes by.", + "key": "alternative_seller_name", + "name": "Alternative Merchant Name", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2023-05-05T19:06:36.559Z", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "CreateMobileAuthorizationCodeRequest": { + "type": "object", + "description": "Defines the body parameters that can be provided in a request to the\n`CreateMobileAuthorizationCode` endpoint.", + "x-release-status": "DEPRECATED", + "properties": { + "location_id": { + "type": "string", + "description": "The Square location ID that the authorization code should be tied to.", + "minLength": 1, + "maxLength": 191 + } + }, + "example": { + "location_id": "YOUR_LOCATION_ID" + } + }, + "CreateMobileAuthorizationCodeResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `CreateMobileAuthorizationCode` endpoint.", + "x-release-status": "DEPRECATED", + "properties": { + "authorization_code": { + "type": "string", + "description": "The generated authorization code that connects a mobile application instance\nto a Square account.", + "maxLength": 191 + }, + "expires_at": { + "type": "string", + "description": "The timestamp when `authorization_code` expires, in\n[RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, \"2016-09-04T23:59:33.123Z\").", + "minLength": 20, + "maxLength": 48 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "authorization_code": "YOUR_MOBILE_AUTHORIZATION_CODE", + "expires_at": "2019-01-10T19:42:08Z" + } + }, + "CreateOrderCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a create request for an order custom attribute definition.", + "x-release-status": "BETA", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition to create. Note the following:\n- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema\ndefinition hosted on the Square CDN. For more information, including supported values and constraints, see\n[Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema).\n- If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller.\n- All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. \nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 45 + } + }, + "example": { + "custom_attribute_definition": { + "description": "The number of people seated at a table", + "key": "cover-count", + "name": "Cover count", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "idempotency_key": "IDEMPOTENCY_KEY" + } + }, + "CreateOrderCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from creating an order custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The new custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-10-06T16:53:23.141Z", + "description": "The number of people seated at a table", + "key": "cover-count", + "name": "Cover count", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-10-06T16:53:23.141Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "CreateOrderRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The order to create. If this field is set, the only other top-level field that can be\nset is the `idempotency_key`." + }, + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this\norder among orders you have created.\n\nIf you are unsure whether a particular order was created successfully,\nyou can try it again with the same idempotency key without\nworrying about creating duplicate orders.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 192 + } + }, + "example": { + "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", + "order": { + "discounts": [ + { + "name": "Labor Day Sale", + "percentage": "5", + "scope": "ORDER", + "uid": "labor-day-sale" + }, + { + "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", + "scope": "ORDER", + "uid": "membership-discount" + }, + { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "name": "Sale - $1.00 off", + "scope": "LINE_ITEM", + "uid": "one-dollar-off" + } + ], + "line_items": [ + { + "base_price_money": { + "amount": 1599, + "currency": "USD" + }, + "name": "New York Strip Steak", + "quantity": "1" + }, + { + "applied_discounts": [ + { + "discount_uid": "one-dollar-off" + } + ], + "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", + "modifiers": [ + { + "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ" + } + ], + "quantity": "2" + } + ], + "location_id": "057P5VYJ4A5X1", + "reference_id": "my-order-001", + "taxes": [ + { + "name": "State Sales Tax", + "percentage": "9", + "scope": "ORDER", + "uid": "state-sales-tax" + } + ] + } + } + }, + "CreateOrderResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `CreateOrder` endpoint.\n\nEither `errors` or `order` is present in a given response, but never both.", + "x-release-status": "PUBLIC", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The newly created order." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "order": { + "created_at": "2020-01-17T20:47:53.293Z", + "discounts": [ + { + "applied_money": { + "amount": 30, + "currency": "USD" + }, + "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", + "name": "Membership Discount", + "percentage": "0.5", + "scope": "ORDER", + "type": "FIXED_PERCENTAGE", + "uid": "membership-discount" + }, + { + "applied_money": { + "amount": 303, + "currency": "USD" + }, + "name": "Labor Day Sale", + "percentage": "5", + "scope": "ORDER", + "type": "FIXED_PERCENTAGE", + "uid": "labor-day-sale" + }, + { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "applied_money": { + "amount": 100, + "currency": "USD" + }, + "name": "Sale - $1.00 off", + "scope": "LINE_ITEM", + "type": "FIXED_AMOUNT", + "uid": "one-dollar-off" + } + ], + "id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "line_items": [ + { + "applied_discounts": [ + { + "applied_money": { + "amount": 8, + "currency": "USD" + }, + "discount_uid": "membership-discount", + "uid": "jWdgP1TpHPFBuVrz81mXVC" + }, + { + "applied_money": { + "amount": 79, + "currency": "USD" + }, + "discount_uid": "labor-day-sale", + "uid": "jnZOjjVY57eRcQAVgEwFuC" + } + ], + "applied_taxes": [ + { + "applied_money": { + "amount": 136, + "currency": "USD" + }, + "tax_uid": "state-sales-tax", + "uid": "aKG87ArnDpvMLSZJHxWUl" + } + ], + "base_price_money": { + "amount": 1599, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 1599, + "currency": "USD" + }, + "name": "New York Strip Steak", + "quantity": "1", + "total_discount_money": { + "amount": 87, + "currency": "USD" + }, + "total_money": { + "amount": 1648, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 136, + "currency": "USD" + }, + "uid": "8uSwfzvUImn3IRrvciqlXC", + "variation_total_price_money": { + "amount": 1599, + "currency": "USD" + } + }, + { + "applied_discounts": [ + { + "applied_money": { + "amount": 22, + "currency": "USD" + }, + "discount_uid": "membership-discount", + "uid": "nUXvdsIItfKko0dbYtY58C" + }, + { + "applied_money": { + "amount": 224, + "currency": "USD" + }, + "discount_uid": "labor-day-sale", + "uid": "qSdkOOOernlVQqsJ94SPjB" + }, + { + "applied_money": { + "amount": 100, + "currency": "USD" + }, + "discount_uid": "one-dollar-off", + "uid": "y7bVl4njrWAnfDwmz19izB" + } + ], + "applied_taxes": [ + { + "applied_money": { + "amount": 374, + "currency": "USD" + }, + "tax_uid": "state-sales-tax", + "uid": "v1dAgrfUVUPTnVTf9sRPz" + } + ], + "base_price_money": { + "amount": 2200, + "currency": "USD" + }, + "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", + "gross_sales_money": { + "amount": 4500, + "currency": "USD" + }, + "modifiers": [ + { + "base_price_money": { + "amount": 50, + "currency": "USD" + }, + "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ", + "name": "Well", + "total_price_money": { + "amount": 100, + "currency": "USD" + }, + "uid": "Lo3qMMckDluu9Qsb58d4CC" + } + ], + "name": "New York Steak", + "quantity": "2", + "total_discount_money": { + "amount": 346, + "currency": "USD" + }, + "total_money": { + "amount": 4528, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 374, + "currency": "USD" + }, + "uid": "v8ZuEXpOJpb0bazLuvrLDB", + "variation_name": "Larger", + "variation_total_price_money": { + "amount": 4400, + "currency": "USD" + } + } + ], + "location_id": "057P5VYJ4A5X1", + "net_amounts": { + "discount_money": { + "amount": 433, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 510, + "currency": "USD" + }, + "tip_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 6176, + "currency": "USD" + } + }, + "reference_id": "my-order-001", + "source": { + "name": "My App" + }, + "state": "OPEN", + "taxes": [ + { + "applied_money": { + "amount": 510, + "currency": "USD" + }, + "name": "State Sales Tax", + "percentage": "9", + "scope": "ORDER", + "type": "ADDITIVE", + "uid": "state-sales-tax" + } + ], + "total_discount_money": { + "amount": 433, + "currency": "USD" + }, + "total_money": { + "amount": 6176, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 510, + "currency": "USD" + }, + "total_tip_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2020-01-17T20:47:53.293Z", + "version": 1 + } + } + }, + "CreatePaymentLinkRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreatePaymentLinkRequest` request.\nIf you do not provide a unique string (or provide an empty string as the value),\nthe endpoint treats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "maxLength": 192 + }, + "description": { + "type": "string", + "description": "A description of the payment link. You provide this optional description that is useful in your\napplication context. It is not used anywhere.", + "maxLength": 4096 + }, + "quick_pay": { + "$ref": "#/components/schemas/QuickPay", + "description": "Describes an ad hoc item and price for which to generate a quick pay checkout link.\nFor more information,\nsee [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout)." + }, + "order": { + "$ref": "#/components/schemas/Order", + "description": "Describes the `Order` for which to create a checkout link.\nFor more information,\nsee [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout)." + }, + "checkout_options": { + "$ref": "#/components/schemas/CheckoutOptions", + "description": "Describes optional fields to add to the resulting checkout page.\nFor more information,\nsee [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations)." + }, + "pre_populated_data": { + "$ref": "#/components/schemas/PrePopulatedData", + "description": "Describes fields to prepopulate in the resulting checkout page.\nFor more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address)." + }, + "payment_note": { + "type": "string", + "description": "A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`.", + "maxLength": 500 + } + }, + "example": { + "idempotency_key": "cd9e25dc-d9f2-4430-aedb-61605070e95f", + "quick_pay": { + "location_id": "A9Y43N9ABXZBP", + "name": "Auto Detailing", + "price_money": { + "amount": 10000, + "currency": "USD" + } + } + } + }, + "CreatePaymentLinkResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "payment_link": { + "$ref": "#/components/schemas/PaymentLink", + "description": "The created payment link." + }, + "related_resources": { + "$ref": "#/components/schemas/PaymentLinkRelatedResources", + "description": "The list of related objects." + } + }, + "example": { + "payment_link": { + "created_at": "2022-04-25T23:58:01Z", + "id": "PKVT6XGJZXYUP3NZ", + "long_url": "https://checkout.square.site/EXAMPLE", + "order_id": "o4b7saqp4HzhNttf5AJxC0Srjd4F", + "url": "https://square.link/u/EXAMPLE", + "version": 1 + }, + "related_resources": { + "orders": [ + { + "created_at": "2022-03-03T00:53:15.829Z", + "fulfillments": [ + { + "state": "PROPOSED", + "type": "DIGITAL", + "uid": "bBpNrxjdQxGQP16sTmdzi" + } + ], + "id": "o4b7saqp4HzhNttf5AJxC0Srjd4F", + "line_items": [ + { + "base_price_money": { + "amount": 12500, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 12500, + "currency": "USD" + }, + "item_type": "ITEM", + "name": "Auto Detailing", + "quantity": "1", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 12500, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "8YX13D1U3jO7czP8JVrAR", + "variation_total_price_money": { + "amount": 12500, + "currency": "USD" + } + } + ], + "location_id": "{LOCATION_ID}", + "net_amounts": { + "discount_money": { + "amount": 0, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 0, + "currency": "USD" + }, + "tip_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 12500, + "currency": "USD" + } + }, + "source": { + "name": "Test Online Checkout Application" + }, + "state": "DRAFT", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 12500, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "total_tip_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2022-03-03T00:53:15.829Z", + "version": 1 + } + ] + } + } + }, + "CreatePaymentRequest": { + "type": "object", + "description": "Describes a request to create a payment using \n[CreatePayment](api-endpoint:Payments-CreatePayment).", + "x-release-status": "PUBLIC", + "required": [ + "source_id", + "idempotency_key" + ], + "properties": { + "source_id": { + "type": "string", + "description": "The ID for the source of funds for this payment.\nThis could be a payment token generated by the Web Payments SDK for any of its\n[supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods),\nincluding cards, bank transfers, Afterpay or Cash App Pay. If recording a payment\nthat the seller received outside of Square, specify either \"CASH\" or \"EXTERNAL\".\nFor more information, see \n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).", + "minLength": 1 + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreatePayment` request. Keys can be any valid string\nbut must be unique for every `CreatePayment` request.\n\nNote: The number of allowed characters might be less than the stated maximum, if multi-byte\ncharacters are used.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 45 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money to accept for this payment, not including `tip_money`.\n\nThe amount must be specified in the smallest denomination of the applicable currency\n(for example, US dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).\n\nThe currency code must match the currency associated with the business\nthat is accepting the payment." + }, + "tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount designated as a tip, in addition to `amount_money`.\n\nThe amount must be specified in the smallest denomination of the applicable currency\n(for example, US dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).\n\nThe currency code must match the currency associated with the business\nthat is accepting the payment." + }, + "app_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money that the developer is taking as a fee\nfor facilitating the payment on behalf of the seller.\n\nThe amount cannot be more than 90% of the total amount of the payment.\n\nThe amount must be specified in the smallest denomination of the applicable currency\n(for example, US dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).\n\nThe fee currency code must match the currency associated with the seller\nthat is accepting the payment. The application must be from a developer\naccount in the same country and using the same currency code as the seller.\n\nFor more information about the application fee scenario, see\n[Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).\n\nTo set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required.\nFor more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions)." + }, + "delay_duration": { + "type": "string", + "description": "The duration of time after the payment's creation when Square automatically \neither completes or cancels the payment depending on the `delay_action` field value. \nFor more information, see \n[Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). \n\nThis parameter should be specified as a time duration, in RFC 3339 format.\n\nNote: This feature is only supported for card payments. This parameter can only be set for a delayed\ncapture payment (`autocomplete=false`).\n\nDefault:\n\n- Card-present payments: \"PT36H\" (36 hours) from the creation time.\n- Card-not-present payments: \"P7D\" (7 days) from the creation time." + }, + "delay_action": { + "type": "string", + "description": "The action to be applied to the payment when the `delay_duration` has elapsed. The action must be\nCANCEL or COMPLETE. For more information, see \n[Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). \n\nDefault: CANCEL" + }, + "autocomplete": { + "type": "boolean", + "description": "If set to `true`, this payment will be completed when possible. If\nset to `false`, this payment is held in an approved state until either\nexplicitly completed (captured) or canceled (voided). For more information, see\n[Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).\n\nDefault: true" + }, + "order_id": { + "type": "string", + "description": "Associates a previously created order with this payment." + }, + "customer_id": { + "type": "string", + "description": "The [Customer](entity:Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Cards API." + }, + "location_id": { + "type": "string", + "description": "The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is\nused." + }, + "team_member_id": { + "type": "string", + "description": "An optional [TeamMember](entity:TeamMember) ID to associate with \nthis payment." + }, + "reference_id": { + "type": "string", + "description": "A user-defined ID to associate with the payment.\n\nYou can use this field to associate the payment to an entity in an external system \n(for example, you might specify an order ID that is generated by a third-party shopping cart).", + "maxLength": 40 + }, + "verification_token": { + "type": "string", + "description": "An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).\nVerification tokens encapsulate customer device information and 3-D Secure\nchallenge results to indicate that Square has verified the buyer identity.\n\nFor more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview)." + }, + "accept_partial_authorization": { + "type": "boolean", + "description": "If set to `true` and charging a Square Gift Card, a payment might be returned with\n`amount_money` equal to less than what was requested. For example, a request for $20 when charging\na Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose\nto prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card\npayment. This field cannot be `true` when `autocomplete = true`.\n\nFor more information, see\n[Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card).\n\nDefault: false" + }, + "buyer_email_address": { + "type": "string", + "description": "The buyer's email address.", + "maxLength": 255 + }, + "buyer_phone_number": { + "type": "string", + "description": "The buyer's phone number.\nMust follow the following format:\n1. A leading + symbol (followed by a country code)\n2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`.\nAlphabetical characters aren't allowed.\n3. The phone number must contain between 9 and 16 digits." + }, + "billing_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer's billing address." + }, + "shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer's shipping address." + }, + "note": { + "type": "string", + "description": "An optional note to be entered by the developer when creating a payment.", + "maxLength": 500 + }, + "statement_description_identifier": { + "type": "string", + "description": "Optional additional payment information to include on the customer's card statement\nas part of the statement description. This can be, for example, an invoice number, ticket number,\nor short description that uniquely identifies the purchase.\n\nNote that the `statement_description_identifier` might get truncated on the statement description\nto fit the required information including the Square identifier (SQ *) and name of the\nseller taking the payment.", + "maxLength": 20 + }, + "cash_details": { + "$ref": "#/components/schemas/CashPaymentDetails", + "description": "Additional details required when recording a cash payment (`source_id` is CASH)." + }, + "external_details": { + "$ref": "#/components/schemas/ExternalPaymentDetails", + "description": "Additional details required when recording an external payment (`source_id` is EXTERNAL)." + }, + "customer_details": { + "$ref": "#/components/schemas/CustomerDetails", + "description": "Details about the customer making the payment." + }, + "offline_payment_details": { + "$ref": "#/components/schemas/OfflinePaymentDetails", + "description": "An optional field for specifying the offline payment details. This is intended for\ninternal 1st-party callers only." + } + }, + "example": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "app_fee_money": { + "amount": 10, + "currency": "USD" + }, + "autocomplete": true, + "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8", + "idempotency_key": "7b0f3ec5-086a-4871-8f13-3c81b3875218", + "location_id": "L88917AVBK2S5", + "note": "Brief description", + "reference_id": "123456", + "source_id": "ccof:GaJGNaZa8x4OgDJn4GB" + } + }, + "CreatePaymentResponse": { + "type": "object", + "description": "Defines the response returned by [CreatePayment](api-endpoint:Payments-CreatePayment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "payment": { + "$ref": "#/components/schemas/Payment", + "description": "The newly created payment." + } + }, + "example": { + "payment": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "app_fee_money": { + "amount": 10, + "currency": "USD" + }, + "application_details": { + "application_id": "sq0ids-TcgftTEtKxJTRF1lCFJ9TA", + "square_product": "ECOMMERCE_API" + }, + "approved_money": { + "amount": 1000, + "currency": "USD" + }, + "card_details": { + "auth_result_code": "vNEn2f", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2021-10-13T21:14:29.732Z", + "captured_at": "2021-10-13T21:14:30.504Z" + }, + "cvv_status": "CVV_ACCEPTED", + "entry_method": "ON_FILE", + "statement_description": "SQ *EXAMPLE TEST GOSQ.C", + "status": "CAPTURED" + }, + "created_at": "2021-10-13T21:14:29.577Z", + "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8", + "delay_action": "CANCEL", + "delay_duration": "PT168H", + "delayed_until": "2021-10-20T21:14:29.577Z", + "id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", + "location_id": "L88917AVBK2S5", + "note": "Brief Description", + "order_id": "pRsjRTgFWATl7so6DxdKBJa7ssbZY", + "receipt_number": "R2B3", + "receipt_url": "https://squareup.com/receipt/preview/EXAMPLE_RECEIPT_ID", + "reference_id": "123456", + "risk_evaluation": { + "created_at": "2021-10-13T21:14:30.423Z", + "risk_level": "NORMAL" + }, + "source_type": "CARD", + "status": "COMPLETED", + "total_money": { + "amount": 1000, + "currency": "USD" + }, + "updated_at": "2021-10-13T21:14:30.504Z", + "version_token": "TPtNEOBOa6Qq6E3C3IjckSVOM6b3hMbfhjvTxHBQUsB6o" + } + } + }, + "CreateRefundRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint.\n\nDeprecated - recommend using [RefundPayment](api-endpoint:Refunds-RefundPayment)", + "x-release-status": "DEPRECATED", + "required": [ + "idempotency_key", + "tender_id", + "amount_money" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this\nrefund among refunds you've created for the tender.\n\nIf you're unsure whether a particular refund succeeded,\nyou can reattempt it with the same idempotency key without\nworrying about duplicating the refund.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.", + "minLength": 1, + "maxLength": 192 + }, + "tender_id": { + "type": "string", + "description": "The ID of the tender to refund.\n\nA [`Transaction`](entity:Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API.", + "minLength": 1, + "maxLength": 192 + }, + "reason": { + "type": "string", + "description": "A description of the reason for the refund.\n\nDefault value: `Refund via API`", + "maxLength": 192 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money to refund.\n\nNote that you specify the amount in the\n__smallest denomination of the applicable currency__. For example, US dollar\namounts are specified in cents. See\n[Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.\n\nThis amount cannot exceed the amount that was originally charged to the\ntender that corresponds to `tender_id`." + } + }, + "example": { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "idempotency_key": "86ae1696-b1e3-4328-af6d-f1e04d947ad2", + "reason": "a reason", + "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateRefund/CreateRefundRequest.csharp", + "java": "/sdk_samples/CreateRefund/CreateRefundRequest.java", + "javascript": "/sdk_samples/CreateRefund/CreateRefundRequest.javascript", + "php": "/sdk_samples/CreateRefund/CreateRefundRequest.php", + "python": "/sdk_samples/CreateRefund/CreateRefundRequest.python", + "ruby": "/sdk_samples/CreateRefund/CreateRefundRequest.ruby" + } + }, + "CreateRefundResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "refund": { + "$ref": "#/components/schemas/Refund", + "description": "The created refund." + } + }, + "example": { + "refund": { + "additional_recipients": [ + { + "amount_money": { + "amount": 10, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1", + "receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF" + } + ], + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "created_at": "2016-02-12T00:28:18Z", + "id": "b27436d1-7f8e-5610-45c6-417ef71434b4-SW", + "location_id": "18YC4JDH91E1H", + "reason": "some reason", + "status": "PENDING", + "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF", + "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF" + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/CreateRefund/CreateRefundResponse.csharp", + "java": "/sdk_samples/CreateRefund/CreateRefundResponse.java", + "javascript": "/sdk_samples/CreateRefund/CreateRefundResponse.javascript", + "php": "/sdk_samples/CreateRefund/CreateRefundResponse.php", + "python": "/sdk_samples/CreateRefund/CreateRefundResponse.python", + "ruby": "/sdk_samples/CreateRefund/CreateRefundResponse.ruby" + } + }, + "CreateShiftRequest": { + "type": "object", + "description": "Represents a request to create a `Shift`.", + "x-release-status": "PUBLIC", + "required": [ + "shift" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string value to ensure the idempotency of the operation.", + "maxLength": 128 + }, + "shift": { + "$ref": "#/components/schemas/Shift", + "description": "The `Shift` to be created." + } + }, + "example": { + "idempotency_key": "HIDSNG5KS478L", + "shift": { + "breaks": [ + { + "break_type_id": "REGS1EQR1TPZ5", + "end_at": "2019-01-25T06:16:00-05:00", + "expected_duration": "PT5M", + "is_paid": true, + "name": "Tea Break", + "start_at": "2019-01-25T06:11:00-05:00" + } + ], + "declared_cash_tip_money": { + "amount": 500, + "currency": "USD" + }, + "end_at": "2019-01-25T13:11:00-05:00", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "wage": { + "hourly_rate": { + "amount": 1100, + "currency": "USD" + }, + "tip_eligible": true, + "title": "Barista" + } + } + } + }, + "CreateShiftResponse": { + "type": "object", + "description": "The response to a request to create a `Shift`. The response contains\nthe created `Shift` object and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "shift": { + "$ref": "#/components/schemas/Shift", + "description": "The `Shift` that was created on the request." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "shift": { + "breaks": [ + { + "break_type_id": "REGS1EQR1TPZ5", + "end_at": "2019-01-25T06:16:00-05:00", + "expected_duration": "PT5M", + "id": "X7GAQYVVRRG6P", + "is_paid": true, + "name": "Tea Break", + "start_at": "2019-01-25T06:11:00-05:00" + } + ], + "created_at": "2019-02-28T00:39:02Z", + "declared_cash_tip_money": { + "amount": 500, + "currency": "USD" + }, + "employee_id": "ormj0jJJZ5OZIzxrZYJI", + "end_at": "2019-01-25T13:11:00-05:00", + "id": "K0YH4CV5462JB", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "status": "CLOSED", + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "timezone": "America/New_York", + "updated_at": "2019-02-28T00:39:02Z", + "version": 1, + "wage": { + "hourly_rate": { + "amount": 1100, + "currency": "USD" + }, + "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", + "tip_eligible": true, + "title": "Barista" + } + } + } + }, + "CreateSubscriptionRequest": { + "type": "object", + "description": "Defines input parameters in a request to the \n[CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "location_id", + "customer_id" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateSubscription` request.\nIf you do not provide a unique string (or provide an empty string as the value),\nthe endpoint treats each request as independent.\n\nFor more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." + }, + "location_id": { + "type": "string", + "description": "The ID of the location the subscription is associated with.", + "minLength": 1 + }, + "plan_variation_id": { + "type": "string", + "description": "The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API." + }, + "customer_id": { + "type": "string", + "description": "The ID of the [customer](entity:Customer) subscribing to the subscription plan variation.", + "minLength": 1 + }, + "start_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date to start the subscription. \nIf it is unspecified, the subscription starts immediately." + }, + "canceled_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. \n\nThis date overrides the cancellation date set in the plan variation configuration.\nIf the cancellation date is earlier than the end date of a subscription cycle, the subscription stops\nat the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. \n\nWhen the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date`\noccurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription \nstops through the end of the last cycle." + }, + "tax_percentage": { + "type": "string", + "description": "The tax to add when billing the subscription.\nThe percentage is expressed in decimal form, using a `'.'` as the decimal\nseparator and without a `'%'` sign. For example, a value of 7.5\ncorresponds to 7.5%.", + "maxLength": 10 + }, + "price_override_money": { + "$ref": "#/components/schemas/Money", + "description": "A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing.\nThis field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, \nyou should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates)." + }, + "card_id": { + "type": "string", + "description": "The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription." + }, + "timezone": { + "type": "string", + "description": "The timezone that is used in date calculations for the subscription. If unset, defaults to\nthe location timezone. If a timezone is not configured for the location, defaults to \"America/New_York\".\nFormat: the IANA Timezone Database identifier for the location timezone. For\na list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." + }, + "source": { + "$ref": "#/components/schemas/SubscriptionSource", + "description": "The origination details of the subscription.", + "x-release-status": "BETA" + }, + "monthly_billing_anchor_date": { + "type": "integer", + "description": "The day-of-the-month to change the billing date to.", + "minimum": 1, + "maximum": 31, + "x-release-status": "BETA" + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Phase" + }, + "description": "array of phases for this subscription" + } + }, + "example": { + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", + "location_id": "S8GWD5R9QB376", + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0 + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "source": { + "name": "My Application" + }, + "start_date": "2023-06-20", + "timezone": "America/Los_Angeles" + } + }, + "CreateSubscriptionResponse": { + "type": "object", + "description": "Defines output parameters in a response from the\n[CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The newly created subscription.\n\nFor more information, see\n[Subscription object](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#subscription-object)." + } + }, + "example": { + "subscription": { + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", + "location_id": "S8GWD5R9QB376", + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "source": { + "name": "My Application" + }, + "start_date": "2023-06-20", + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 1 + } + } + }, + "CreateTeamMemberRequest": { + "type": "object", + "description": "Represents a create request for a `TeamMember` object.", + "x-release-status": "PUBLIC", + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateTeamMember` request.\nKeys can be any valid string, but must be unique for every request.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).\n\nThe minimum length is 1 and the maximum length is 45." + }, + "team_member": { + "$ref": "#/components/schemas/TeamMember", + "description": "**Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide\n`job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs)." + } + }, + "example": { + "idempotency_key": "idempotency-key-0", + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "YSGH2WBKG94QZ", + "GA2Y9HSJ8KRYT" + ] + }, + "email_address": "joe_doe@gmail.com", + "family_name": "Doe", + "given_name": "Joe", + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE", + "wage_setting": { + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "pay_type": "HOURLY" + } + ] + } + } + } + }, + "CreateTeamMemberResponse": { + "type": "object", + "description": "Represents a response from a create request containing the created `TeamMember` object or error messages.", + "x-release-status": "PUBLIC", + "properties": { + "team_member": { + "$ref": "#/components/schemas/TeamMember", + "description": "The successfully created `TeamMember` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "GA2Y9HSJ8KRYT", + "YSGH2WBKG94QZ" + ] + }, + "created_at": "2021-06-11T22:55:45Z", + "email_address": "joe_doe@example.com", + "family_name": "Doe", + "given_name": "Joe", + "id": "1yJlHapkseYnNPETIU1B", + "is_owner": false, + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE", + "updated_at": "2021-06-11T22:55:45Z", + "wage_setting": { + "created_at": "2021-06-11T22:55:45Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "hourly_rate": { + "amount": 1443, + "currency": "USD" + }, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "1yJlHapkseYnNPETIU1B", + "updated_at": "2021-06-11T22:55:45Z", + "version": 1 + } + } + } + }, + "CreateTerminalActionRequest": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "idempotency_key", + "action" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateAction` request. Keys can be any valid string\nbut must be unique for every `CreateAction` request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more\ninformation.", + "minLength": 1, + "maxLength": 64 + }, + "action": { + "$ref": "#/components/schemas/TerminalAction", + "description": "The Action to create." + } + }, + "example": { + "action": { + "deadline_duration": "PT5M", + "device_id": "{{DEVICE_ID}}", + "save_card_options": { + "customer_id": "{{CUSTOMER_ID}}", + "reference_id": "user-id-1" + }, + "type": "SAVE_CARD" + }, + "idempotency_key": "thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e" + } + }, + "CreateTerminalActionResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "action": { + "$ref": "#/components/schemas/TerminalAction", + "description": "The created `TerminalAction`" + } + }, + "example": { + "action": { + "app_id": "APP_ID", + "created_at": "2021-07-28T23:22:07.476Z", + "deadline_duration": "PT5M", + "device_id": "DEVICE_ID", + "id": "termapia:jveJIAkkAjILHkdCE", + "location_id": "LOCATION_ID", + "save_card_options": { + "customer_id": "CUSTOMER_ID", + "reference_id": "user-id-1" + }, + "status": "PENDING", + "type": "SAVE_CARD", + "updated_at": "2021-07-28T23:22:07.476Z" + } + } + }, + "CreateTerminalCheckoutRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "checkout" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but\nmust be unique for every `CreateCheckout` request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 64 + }, + "checkout": { + "$ref": "#/components/schemas/TerminalCheckout", + "description": "The checkout to create." + } + }, + "example": { + "checkout": { + "amount_money": { + "amount": 2610, + "currency": "USD" + }, + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003" + }, + "note": "A brief note", + "reference_id": "id11572" + }, + "idempotency_key": "28a0c3bc-7839-11ea-bc55-0242ac130003" + } + }, + "CreateTerminalCheckoutResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "checkout": { + "$ref": "#/components/schemas/TerminalCheckout", + "description": "The created `TerminalCheckout`." + } + }, + "example": { + "checkout": { + "amount_money": { + "amount": 2610, + "currency": "USD" + }, + "app_id": "APP_ID", + "created_at": "2020-04-06T16:39:32.545Z", + "deadline_duration": "PT5M", + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", + "skip_receipt_screen": false, + "tip_settings": { + "allow_tipping": false + } + }, + "id": "08YceKh7B3ZqO", + "location_id": "LOCATION_ID", + "note": "A brief note", + "payment_type": "CARD_PRESENT", + "reference_id": "id11572", + "status": "PENDING", + "updated_at": "2020-04-06T16:39:32.545Z" + } + } + }, + "CreateTerminalRefundRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `CreateRefund` request. Keys can be any valid string but\nmust be unique for every `CreateRefund` request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 64 + }, + "refund": { + "$ref": "#/components/schemas/TerminalRefund", + "description": "The refund to create." + } + }, + "example": { + "idempotency_key": "402a640b-b26f-401f-b406-46f839590c04", + "refund": { + "amount_money": { + "amount": 111, + "currency": "CAD" + }, + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "reason": "Returning items" + } + } + }, + "CreateTerminalRefundResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refund": { + "$ref": "#/components/schemas/TerminalRefund", + "description": "The created `TerminalRefund`." + } + }, + "example": { + "refund": { + "amount_money": { + "amount": 111, + "currency": "CAD" + }, + "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ", + "card": { + "bin": "411111", + "card_brand": "INTERAC", + "card_type": "CREDIT", + "exp_month": 1, + "exp_year": 2022, + "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw", + "last_4": "1111" + }, + "created_at": "2020-09-29T15:21:46.771Z", + "deadline_duration": "PT5M", + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "location_id": "76C9W6K8CNNQ5", + "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY", + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "reason": "Returning items", + "status": "PENDING", + "updated_at": "2020-09-29T15:21:46.771Z" + } + } + }, + "CreateVendorRequest": { + "type": "object", + "description": "Represents an input to a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).", + "x-release-status": "BETA", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", + "minLength": 1, + "maxLength": 128 + }, + "vendor": { + "$ref": "#/components/schemas/Vendor", + "description": "The requested [Vendor](entity:Vendor) to be created." + } + }, + "example": { + "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "name": "Joe's Fresh Seafood", + "note": "a vendor" + } + } + }, + "CreateVendorResponse": { + "type": "object", + "description": "Represents an output from a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered when the request fails." + }, + "vendor": { + "$ref": "#/components/schemas/Vendor", + "description": "The successfully created [Vendor](entity:Vendor) object." + } + }, + "example": { + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Joe's Fresh Seafood", + "note": "a vendor", + "status": "ACTIVE", + "updated_at": "2022-03-16T10:21:54.859Z", + "version": 1 + } + } + }, + "CreateWebhookSubscriptionRequest": { + "type": "object", + "description": "Creates a [Subscription](entity:WebhookSubscription).", + "x-release-status": "PUBLIC", + "required": [ + "subscription" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request.", + "maxLength": 45 + }, + "subscription": { + "$ref": "#/components/schemas/WebhookSubscription", + "description": "The [Subscription](entity:WebhookSubscription) to create." + } + }, + "example": { + "idempotency_key": "63f84c6c-2200-4c99-846c-2670a1311fbf", + "subscription": { + "api_version": "2021-12-15", + "event_types": [ + "payment.created", + "payment.updated" + ], + "name": "Example Webhook Subscription", + "notification_url": "https://example-webhook-url.com" + } + } + }, + "CreateWebhookSubscriptionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/WebhookSubscription", + "description": "The new [Subscription](entity:WebhookSubscription)." + } + }, + "example": { + "subscription": { + "api_version": "2021-12-15", + "created_at": "2022-01-10 23:29:48 +0000 UTC", + "enabled": true, + "event_types": [ + "payment.created", + "payment.updated" + ], + "id": "wbhk_b35f6b3145074cf9ad513610786c19d5", + "name": "Example Webhook Subscription", + "notification_url": "https://example-webhook-url.com", + "signature_key": "1k9bIJKCeTmSQwyagtNRLg", + "updated_at": "2022-01-10 23:29:48 +0000 UTC" + } + } + }, + "Currency": { + "type": "string", + "enum": [ + "UNKNOWN_CURRENCY", + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BOV", + "BRL", + "BSD", + "BTN", + "BWP", + "BYR", + "BZD", + "CAD", + "CDF", + "CHE", + "CHF", + "CHW", + "CLF", + "CLP", + "CNY", + "COP", + "COU", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "INR", + "IQD", + "IRR", + "ISK", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LTL", + "LVL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MXV", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SLE", + "SOS", + "SRD", + "SSP", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "USN", + "USS", + "UYI", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XAG", + "XAU", + "XBA", + "XBB", + "XBC", + "XBD", + "XCD", + "XDR", + "XOF", + "XPD", + "XPF", + "XPT", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMK", + "ZMW", + "BTC", + "XUS" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN_CURRENCY", + "description": "Unknown currency" + }, + { + "name": "AED", + "description": "United Arab Emirates dirham" + }, + { + "name": "AFN", + "description": "Afghan afghani" + }, + { + "name": "ALL", + "description": "Albanian lek" + }, + { + "name": "AMD", + "description": "Armenian dram" + }, + { + "name": "ANG", + "description": "Netherlands Antillean guilder" + }, + { + "name": "AOA", + "description": "Angolan kwanza" + }, + { + "name": "ARS", + "description": "Argentine peso" + }, + { + "name": "AUD", + "description": "Australian dollar" + }, + { + "name": "AWG", + "description": "Aruban florin" + }, + { + "name": "AZN", + "description": "Azerbaijani manat" + }, + { + "name": "BAM", + "description": "Bosnia and Herzegovina convertible mark" + }, + { + "name": "BBD", + "description": "Barbados dollar" + }, + { + "name": "BDT", + "description": "Bangladeshi taka" + }, + { + "name": "BGN", + "description": "Bulgarian lev" + }, + { + "name": "BHD", + "description": "Bahraini dinar" + }, + { + "name": "BIF", + "description": "Burundian franc" + }, + { + "name": "BMD", + "description": "Bermudian dollar" + }, + { + "name": "BND", + "description": "Brunei dollar" + }, + { + "name": "BOB", + "description": "Boliviano" + }, + { + "name": "BOV", + "description": "Bolivian Mvdol" + }, + { + "name": "BRL", + "description": "Brazilian real" + }, + { + "name": "BSD", + "description": "Bahamian dollar" + }, + { + "name": "BTN", + "description": "Bhutanese ngultrum" + }, + { + "name": "BWP", + "description": "Botswana pula" + }, + { + "name": "BYR", + "description": "Belarusian ruble" + }, + { + "name": "BZD", + "description": "Belize dollar" + }, + { + "name": "CAD", + "description": "Canadian dollar" + }, + { + "name": "CDF", + "description": "Congolese franc" + }, + { + "name": "CHE", + "description": "WIR Euro" + }, + { + "name": "CHF", + "description": "Swiss franc" + }, + { + "name": "CHW", + "description": "WIR Franc" + }, + { + "name": "CLF", + "description": "Unidad de Fomento" + }, + { + "name": "CLP", + "description": "Chilean peso" + }, + { + "name": "CNY", + "description": "Chinese yuan" + }, + { + "name": "COP", + "description": "Colombian peso" + }, + { + "name": "COU", + "description": "Unidad de Valor Real" + }, + { + "name": "CRC", + "description": "Costa Rican colon" + }, + { + "name": "CUC", + "description": "Cuban convertible peso" + }, + { + "name": "CUP", + "description": "Cuban peso" + }, + { + "name": "CVE", + "description": "Cape Verdean escudo" + }, + { + "name": "CZK", + "description": "Czech koruna" + }, + { + "name": "DJF", + "description": "Djiboutian franc" + }, + { + "name": "DKK", + "description": "Danish krone" + }, + { + "name": "DOP", + "description": "Dominican peso" + }, + { + "name": "DZD", + "description": "Algerian dinar" + }, + { + "name": "EGP", + "description": "Egyptian pound" + }, + { + "name": "ERN", + "description": "Eritrean nakfa" + }, + { + "name": "ETB", + "description": "Ethiopian birr" + }, + { + "name": "EUR", + "description": "Euro" + }, + { + "name": "FJD", + "description": "Fiji dollar" + }, + { + "name": "FKP", + "description": "Falkland Islands pound" + }, + { + "name": "GBP", + "description": "Pound sterling" + }, + { + "name": "GEL", + "description": "Georgian lari" + }, + { + "name": "GHS", + "description": "Ghanaian cedi" + }, + { + "name": "GIP", + "description": "Gibraltar pound" + }, + { + "name": "GMD", + "description": "Gambian dalasi" + }, + { + "name": "GNF", + "description": "Guinean franc" + }, + { + "name": "GTQ", + "description": "Guatemalan quetzal" + }, + { + "name": "GYD", + "description": "Guyanese dollar" + }, + { + "name": "HKD", + "description": "Hong Kong dollar" + }, + { + "name": "HNL", + "description": "Honduran lempira" + }, + { + "name": "HRK", + "description": "Croatian kuna" + }, + { + "name": "HTG", + "description": "Haitian gourde" + }, + { + "name": "HUF", + "description": "Hungarian forint" + }, + { + "name": "IDR", + "description": "Indonesian rupiah" + }, + { + "name": "ILS", + "description": "Israeli new shekel" + }, + { + "name": "INR", + "description": "Indian rupee" + }, + { + "name": "IQD", + "description": "Iraqi dinar" + }, + { + "name": "IRR", + "description": "Iranian rial" + }, + { + "name": "ISK", + "description": "Icelandic króna" + }, + { + "name": "JMD", + "description": "Jamaican dollar" + }, + { + "name": "JOD", + "description": "Jordanian dinar" + }, + { + "name": "JPY", + "description": "Japanese yen" + }, + { + "name": "KES", + "description": "Kenyan shilling" + }, + { + "name": "KGS", + "description": "Kyrgyzstani som" + }, + { + "name": "KHR", + "description": "Cambodian riel" + }, + { + "name": "KMF", + "description": "Comoro franc" + }, + { + "name": "KPW", + "description": "North Korean won" + }, + { + "name": "KRW", + "description": "South Korean won" + }, + { + "name": "KWD", + "description": "Kuwaiti dinar" + }, + { + "name": "KYD", + "description": "Cayman Islands dollar" + }, + { + "name": "KZT", + "description": "Kazakhstani tenge" + }, + { + "name": "LAK", + "description": "Lao kip" + }, + { + "name": "LBP", + "description": "Lebanese pound" + }, + { + "name": "LKR", + "description": "Sri Lankan rupee" + }, + { + "name": "LRD", + "description": "Liberian dollar" + }, + { + "name": "LSL", + "description": "Lesotho loti" + }, + { + "name": "LTL", + "description": "Lithuanian litas" + }, + { + "name": "LVL", + "description": "Latvian lats" + }, + { + "name": "LYD", + "description": "Libyan dinar" + }, + { + "name": "MAD", + "description": "Moroccan dirham" + }, + { + "name": "MDL", + "description": "Moldovan leu" + }, + { + "name": "MGA", + "description": "Malagasy ariary" + }, + { + "name": "MKD", + "description": "Macedonian denar" + }, + { + "name": "MMK", + "description": "Myanmar kyat" + }, + { + "name": "MNT", + "description": "Mongolian tögrög" + }, + { + "name": "MOP", + "description": "Macanese pataca" + }, + { + "name": "MRO", + "description": "Mauritanian ouguiya" + }, + { + "name": "MUR", + "description": "Mauritian rupee" + }, + { + "name": "MVR", + "description": "Maldivian rufiyaa" + }, + { + "name": "MWK", + "description": "Malawian kwacha" + }, + { + "name": "MXN", + "description": "Mexican peso" + }, + { + "name": "MXV", + "description": "Mexican Unidad de Inversion" + }, + { + "name": "MYR", + "description": "Malaysian ringgit" + }, + { + "name": "MZN", + "description": "Mozambican metical" + }, + { + "name": "NAD", + "description": "Namibian dollar" + }, + { + "name": "NGN", + "description": "Nigerian naira" + }, + { + "name": "NIO", + "description": "Nicaraguan córdoba" + }, + { + "name": "NOK", + "description": "Norwegian krone" + }, + { + "name": "NPR", + "description": "Nepalese rupee" + }, + { + "name": "NZD", + "description": "New Zealand dollar" + }, + { + "name": "OMR", + "description": "Omani rial" + }, + { + "name": "PAB", + "description": "Panamanian balboa" + }, + { + "name": "PEN", + "description": "Peruvian sol" + }, + { + "name": "PGK", + "description": "Papua New Guinean kina" + }, + { + "name": "PHP", + "description": "Philippine peso" + }, + { + "name": "PKR", + "description": "Pakistani rupee" + }, + { + "name": "PLN", + "description": "Polish złoty" + }, + { + "name": "PYG", + "description": "Paraguayan guaraní" + }, + { + "name": "QAR", + "description": "Qatari riyal" + }, + { + "name": "RON", + "description": "Romanian leu" + }, + { + "name": "RSD", + "description": "Serbian dinar" + }, + { + "name": "RUB", + "description": "Russian ruble" + }, + { + "name": "RWF", + "description": "Rwandan franc" + }, + { + "name": "SAR", + "description": "Saudi riyal" + }, + { + "name": "SBD", + "description": "Solomon Islands dollar" + }, + { + "name": "SCR", + "description": "Seychelles rupee" + }, + { + "name": "SDG", + "description": "Sudanese pound" + }, + { + "name": "SEK", + "description": "Swedish krona" + }, + { + "name": "SGD", + "description": "Singapore dollar" + }, + { + "name": "SHP", + "description": "Saint Helena pound" + }, + { + "name": "SLL", + "description": "Sierra Leonean first leone" + }, + { + "name": "SLE", + "description": "Sierra Leonean second leone" + }, + { + "name": "SOS", + "description": "Somali shilling" + }, + { + "name": "SRD", + "description": "Surinamese dollar" + }, + { + "name": "SSP", + "description": "South Sudanese pound" + }, + { + "name": "STD", + "description": "São Tomé and Príncipe dobra" + }, + { + "name": "SVC", + "description": "Salvadoran colón" + }, + { + "name": "SYP", + "description": "Syrian pound" + }, + { + "name": "SZL", + "description": "Swazi lilangeni" + }, + { + "name": "THB", + "description": "Thai baht" + }, + { + "name": "TJS", + "description": "Tajikstani somoni" + }, + { + "name": "TMT", + "description": "Turkmenistan manat" + }, + { + "name": "TND", + "description": "Tunisian dinar" + }, + { + "name": "TOP", + "description": "Tongan pa'anga" + }, + { + "name": "TRY", + "description": "Turkish lira" + }, + { + "name": "TTD", + "description": "Trinidad and Tobago dollar" + }, + { + "name": "TWD", + "description": "New Taiwan dollar" + }, + { + "name": "TZS", + "description": "Tanzanian shilling" + }, + { + "name": "UAH", + "description": "Ukrainian hryvnia" + }, + { + "name": "UGX", + "description": "Ugandan shilling" + }, + { + "name": "USD", + "description": "United States dollar" + }, + { + "name": "USN", + "description": "United States dollar (next day)" + }, + { + "name": "USS", + "description": "United States dollar (same day)" + }, + { + "name": "UYI", + "description": "Uruguay Peso en Unidedades Indexadas" + }, + { + "name": "UYU", + "description": "Uruguyan peso" + }, + { + "name": "UZS", + "description": "Uzbekistan som" + }, + { + "name": "VEF", + "description": "Venezuelan bolívar soberano" + }, + { + "name": "VND", + "description": "Vietnamese đồng" + }, + { + "name": "VUV", + "description": "Vanuatu vatu" + }, + { + "name": "WST", + "description": "Samoan tala" + }, + { + "name": "XAF", + "description": "CFA franc BEAC" + }, + { + "name": "XAG", + "description": "Silver" + }, + { + "name": "XAU", + "description": "Gold" + }, + { + "name": "XBA", + "description": "European Composite Unit" + }, + { + "name": "XBB", + "description": "European Monetary Unit" + }, + { + "name": "XBC", + "description": "European Unit of Account 9" + }, + { + "name": "XBD", + "description": "European Unit of Account 17" + }, + { + "name": "XCD", + "description": "East Caribbean dollar" + }, + { + "name": "XDR", + "description": "Special drawing rights (International Monetary Fund)" + }, + { + "name": "XOF", + "description": "CFA franc BCEAO" + }, + { + "name": "XPD", + "description": "Palladium" + }, + { + "name": "XPF", + "description": "CFP franc" + }, + { + "name": "XPT", + "description": "Platinum" + }, + { + "name": "XTS", + "description": "Code reserved for testing" + }, + { + "name": "XXX", + "description": "No currency" + }, + { + "name": "YER", + "description": "Yemeni rial" + }, + { + "name": "ZAR", + "description": "South African rand" + }, + { + "name": "ZMK", + "description": "Zambian kwacha" + }, + { + "name": "ZMW", + "description": "Zambian kwacha" + }, + { + "name": "BTC", + "description": "Bitcoin" + }, + { + "name": "XUS", + "description": "USD Coin" + } + ], + "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", + "x-release-status": "PUBLIC" + }, + "CustomAttribute": { + "type": "object", + "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", + "x-release-status": "PUBLIC", + "properties": { + "key": { + "type": "string", + "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", + "minLength": 1, + "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", + "nullable": true + }, + "value": { + "description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition's schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", + "nullable": true + }, + "version": { + "type": "integer", + "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)." + }, + "visibility": { + "$ref": "#/components/schemas/CustomAttributeDefinitionVisibility", + "description": "A copy of the `visibility` field value for the associated custom attribute definition.\nSee [CustomAttributeDefinitionVisibility](#type-customattributedefinitionvisibility) for possible values", + "readOnly": true + }, + "definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "A copy of the associated custom attribute definition object. This field is only set when\nthe optional field is specified on the request.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", + "readOnly": true + } + } + }, + "CustomAttributeDefinition": { + "type": "object", + "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", + "x-release-status": "PUBLIC", + "properties": { + "key": { + "type": "string", + "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", + "minLength": 1, + "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", + "nullable": true + }, + "schema": { + "type": "object", + "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "maxLength": 255, + "nullable": true + }, + "description": { + "type": "string", + "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "maxLength": 255, + "nullable": true + }, + "visibility": { + "$ref": "#/components/schemas/CustomAttributeDefinitionVisibility", + "description": "Specifies how the custom attribute definition and its values should be shared with\nthe seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`.\nSee [Visibility](#type-visibility) for possible values", + "nullable": true + }, + "version": { + "type": "integer", + "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)." + }, + "updated_at": { + "type": "string", + "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", + "readOnly": true + } + } + }, + "CustomAttributeDefinitionVisibility": { + "type": "string", + "enum": [ + "VISIBILITY_HIDDEN", + "VISIBILITY_READ_ONLY", + "VISIBILITY_READ_WRITE_VALUES" + ], + "x-enum-elements": [ + { + "name": "VISIBILITY_HIDDEN", + "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers." + }, + { + "name": "VISIBILITY_READ_ONLY", + "description": "The seller and other developers can read the custom attribute definition and values\non resources." + }, + { + "name": "VISIBILITY_READ_WRITE_VALUES", + "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it." + } + ], + "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", + "x-release-status": "PUBLIC" + }, + "CustomAttributeFilter": { + "type": "object", + "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)\nendpoint to search for items or item variations.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition_id": { + "type": "string", + "description": "A query expression to filter items or item variations by matching their custom attributes'\n`custom_attribute_definition_id` property value against the the specified id.\nExactly one of `custom_attribute_definition_id` or `key` must be specified.", + "nullable": true + }, + "key": { + "type": "string", + "description": "A query expression to filter items or item variations by matching their custom attributes'\n`key` property value against the specified key.\nExactly one of `custom_attribute_definition_id` or `key` must be specified.", + "nullable": true + }, + "string_filter": { + "type": "string", + "description": "A query expression to filter items or item variations by matching their custom attributes'\n`string_value` property value against the specified text.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", + "nullable": true + }, + "number_filter": { + "$ref": "#/components/schemas/Range", + "description": "A query expression to filter items or item variations with their custom attributes\ncontaining a number value within the specified range.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", + "nullable": true + }, + "selection_uids_filter": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A query expression to filter items or item variations by matching their custom attributes'\n`selection_uid_values` values against the specified selection uids.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", + "nullable": true + }, + "bool_filter": { + "type": "boolean", + "description": "A query expression to filter items or item variations by matching their custom attributes'\n`boolean_value` property values against the specified Boolean expression.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", + "nullable": true + } + } + }, + "CustomField": { + "type": "object", + "description": "Describes a custom form field to add to the checkout page to collect more information from buyers during checkout.\nFor more information,\nsee [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1).", + "x-release-status": "PUBLIC", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string", + "description": "The title of the custom field.", + "minLength": 1, + "maxLength": 50 + } + } + }, + "Customer": { + "type": "object", + "description": "Represents a Square customer profile in the Customer Directory of a Square seller.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers) \nor [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint." + }, + "created_at": { + "type": "string", + "description": "The timestamp when the customer profile was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the customer profile was last updated, in RFC 3339 format.", + "readOnly": true + }, + "given_name": { + "type": "string", + "description": "The given name (that is, the first name) associated with the customer profile.", + "nullable": true + }, + "family_name": { + "type": "string", + "description": "The family name (that is, the last name) associated with the customer profile.", + "nullable": true + }, + "nickname": { + "type": "string", + "description": "A nickname for the customer profile.", + "nullable": true + }, + "company_name": { + "type": "string", + "description": "A business name associated with the customer profile.", + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address associated with the customer profile.", + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The physical address associated with the customer profile.", + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number associated with the customer profile.", + "nullable": true + }, + "birthday": { + "type": "string", + "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21`\nrepresents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year).", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "An optional second ID used to associate the customer profile with an\nentity in another system.", + "nullable": true + }, + "note": { + "type": "string", + "description": "A custom note associated with the customer profile.", + "nullable": true + }, + "preferences": { + "$ref": "#/components/schemas/CustomerPreferences", + "description": "Represents general customer preferences.", + "nullable": true + }, + "creation_source": { + "$ref": "#/components/schemas/CustomerCreationSource", + "description": "The method used to create the customer profile.\nSee [CustomerCreationSource](#type-customercreationsource) for possible values", + "nullable": true + }, + "group_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of [customer groups](entity:CustomerGroup) the customer belongs to.", + "nullable": true + }, + "segment_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of [customer segments](entity:CustomerSegment) the customer belongs to.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership.", + "format": "int64" + }, + "tax_ids": { + "$ref": "#/components/schemas/CustomerTaxIds", + "description": "The tax ID associated with the customer profile. This field is present only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "nullable": true + } + } + }, + "CustomerAddressFilter": { + "type": "object", + "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", + "x-release-status": "PUBLIC", + "properties": { + "postal_code": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "The postal code to search for. Only an `exact` match is supported.", + "nullable": true + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "The country code to search for.\nSee [Country](#type-country) for possible values", + "nullable": true + } + } + }, + "CustomerCreationSource": { + "type": "string", + "enum": [ + "OTHER", + "APPOINTMENTS", + "COUPON", + "DELETION_RECOVERY", + "DIRECTORY", + "EGIFTING", + "EMAIL_COLLECTION", + "FEEDBACK", + "IMPORT", + "INVOICES", + "LOYALTY", + "MARKETING", + "MERGE", + "ONLINE_STORE", + "INSTANT_PROFILE", + "TERMINAL", + "THIRD_PARTY", + "THIRD_PARTY_IMPORT", + "UNMERGE_RECOVERY" + ], + "x-enum-elements": [ + { + "name": "OTHER", + "description": "The default creation source. This source is typically used for backward/future\ncompatibility when the original source of a customer profile is\nunrecognized. For example, when older clients do not support newer\nsource types." + }, + { + "name": "APPOINTMENTS", + "description": "The customer profile was created automatically when an appointment\nwas scheduled." + }, + { + "name": "COUPON", + "description": "The customer profile was created automatically when a coupon was issued\nusing Square Point of Sale." + }, + { + "name": "DELETION_RECOVERY", + "description": "The customer profile was restored through Square's deletion recovery\nprocess." + }, + { + "name": "DIRECTORY", + "description": "The customer profile was created manually through Square Seller Dashboard or the \nPoint of Sale application." + }, + { + "name": "EGIFTING", + "description": "The customer profile was created automatically when a gift card was\nissued using Square Point of Sale. Customer profiles are created for\nboth the buyer and the recipient of the gift card." + }, + { + "name": "EMAIL_COLLECTION", + "description": "The customer profile was created through Square Point of Sale when\nsigning up for marketing emails during checkout." + }, + { + "name": "FEEDBACK", + "description": "The customer profile was created automatically when providing feedback\nthrough a digital receipt." + }, + { + "name": "IMPORT", + "description": "The customer profile was created automatically when importing customer\ndata through Square Seller Dashboard." + }, + { + "name": "INVOICES", + "description": "The customer profile was created automatically during an invoice payment." + }, + { + "name": "LOYALTY", + "description": "The customer profile was created automatically when customers provide a\nphone number for loyalty reward programs during checkout." + }, + { + "name": "MARKETING", + "description": "The customer profile was created as the result of a campaign managed\nthrough Square’s Facebook integration." + }, + { + "name": "MERGE", + "description": "The customer profile was created as the result of explicitly merging\nmultiple customer profiles through the Square Seller Dashboard or the Point of\nSale application." + }, + { + "name": "ONLINE_STORE", + "description": "The customer profile was created through Square's Online Store solution\n(legacy service)." + }, + { + "name": "INSTANT_PROFILE", + "description": "The customer profile was created automatically as the result of a successful\ntransaction that did not explicitly link to an existing customer profile." + }, + { + "name": "TERMINAL", + "description": "The customer profile was created through Square's Virtual Terminal." + }, + { + "name": "THIRD_PARTY", + "description": "The customer profile was created through a Square API call." + }, + { + "name": "THIRD_PARTY_IMPORT", + "description": "The customer profile was created by a third-party product and imported\nthrough an official integration." + }, + { + "name": "UNMERGE_RECOVERY", + "description": "The customer profile was restored through Square's unmerge recovery\nprocess." + } + ], + "description": "Indicates the method used to create the customer profile.", + "x-release-status": "PUBLIC" + }, + "CustomerCreationSourceFilter": { + "type": "object", + "description": "The creation source filter.\n\nIf one or more creation sources are set, customer profiles are included in,\nor excluded from, the result if they match at least one of the filter criteria.", + "x-release-status": "PUBLIC", + "properties": { + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerCreationSource" + }, + "description": "The list of creation sources used as filtering criteria.\nSee [CustomerCreationSource](#type-customercreationsource) for possible values", + "nullable": true + }, + "rule": { + "$ref": "#/components/schemas/CustomerInclusionExclusion", + "description": "Indicates whether a customer profile matching the filter criteria\nshould be included in the result or excluded from the result.\n\nDefault: `INCLUDE`.\nSee [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values", + "nullable": true + } + } + }, + "CustomerCustomAttributeFilter": { + "type": "object", + "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](entity:CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](entity:CustomAttribute).", + "x-release-status": "PUBLIC", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes)." + }, + "filter": { + "$ref": "#/components/schemas/CustomerCustomAttributeFilterValue", + "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes).\n\nYou must provide this `filter` field, the `updated_at` field, or both.", + "nullable": true + }, + "updated_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The date range for when the custom attribute was last updated. The date range can include `start_at`, `end_at`, or\nboth. Range boundaries are inclusive. Dates are specified as RFC 3339 timestamps.\n\nYou must provide this `updated_at` field, the `filter` field, or both." + } + } + }, + "CustomerCustomAttributeFilterValue": { + "type": "object", + "description": "A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](entity:CustomAttribute).", + "x-release-status": "PUBLIC", + "properties": { + "email": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "A filter for a query based on the value of an `Email`-type custom attribute. This filter is case-insensitive and can\ninclude `exact` or `fuzzy`, but not both.\n\nFor an `exact` match, provide the complete email address.\n\nFor a `fuzzy` match, provide a query expression containing one or more query tokens to match against the email address. Square removes\nany punctuation (including periods (.), underscores (_), and the @ symbol) and tokenizes the email addresses on spaces. A match is found\nif a tokenized email address contains all the tokens in the search query, irrespective of the token order. For example, `Steven gmail`\nmatches steven.jones@gmail.com and mygmail@stevensbakery.com.", + "nullable": true + }, + "phone": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "A filter for a query based on the value of a `PhoneNumber`-type custom attribute. This filter is case-insensitive and\ncan include `exact` or `fuzzy`, but not both.\n\nFor an `exact` match, provide the complete phone number. This is always an E.164-compliant phone number that starts\nwith the + sign followed by the country code and subscriber number. For example, the format for a US phone number is +12061112222.\n\nFor a `fuzzy` match, provide a query expression containing one or more query tokens to match against the phone number.\nSquare removes any punctuation and tokenizes the expression on spaces. A match is found if a tokenized phone number contains\nall the tokens in the search query, irrespective of the token order. For example, `415 123 45` is tokenized to `415`, `123`, and `45`,\nwhich matches +14151234567 and +12345674158, but does not match +1234156780. Similarly, the expression `415` matches\n+14151234567, +12345674158, and +1234156780.", + "nullable": true + }, + "text": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "A filter for a query based on the value of a `String`-type custom attribute. This filter is case-insensitive and \ncan include `exact` or `fuzzy`, but not both.\n\nFor an `exact` match, provide the complete string.\n\nFor a `fuzzy` match, provide a query expression containing one or more query tokens in any order that contain complete words\nto match against the string. Square tokenizes the expression using a grammar-based tokenizer. For example, the expressions `quick brown`,\n`brown quick`, and `quick fox` match \"The quick brown fox jumps over the lazy dog\". However, `quick foxes` and `qui` do not match.", + "nullable": true + }, + "selection": { + "$ref": "#/components/schemas/FilterValue", + "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](api:CustomerCustomAttributes) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller.", + "nullable": true + }, + "date": { + "$ref": "#/components/schemas/TimeRange", + "description": "A filter for a query based on the value of a `Date`-type custom attribute.\n\nProvide a date range for this filter using `start_at`, `end_at`, or both. Range boundaries are inclusive. Dates can be specified\nin `YYYY-MM-DD` format or as RFC 3339 timestamps.", + "nullable": true + }, + "number": { + "$ref": "#/components/schemas/FloatNumberRange", + "description": "A filter for a query based on the value of a `Number`-type custom attribute, which can be an integer or a decimal with up to\n5 digits of precision.\n\nProvide a numerical range for this filter using `start_at`, `end_at`, or both. Range boundaries are inclusive. Numbers are specified\nas decimals or integers. The absolute value of range boundaries must not exceed `(2^63-1)/10^5`, or 92233720368547.", + "nullable": true + }, + "boolean": { + "type": "boolean", + "description": "A filter for a query based on the value of a `Boolean`-type custom attribute.", + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/CustomerAddressFilter", + "description": "A filter for a query based on the value of an `Address`-type custom attribute. The filter can include `postal_code`, `country`, or both.", + "nullable": true + } + } + }, + "CustomerCustomAttributeFilters": { + "type": "object", + "description": "The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", + "x-release-status": "PUBLIC", + "properties": { + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerCustomAttributeFilter" + }, + "description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters.", + "nullable": true + } + } + }, + "CustomerDetails": { + "type": "object", + "description": "Details about the customer making the payment.", + "x-release-status": "PUBLIC", + "properties": { + "customer_initiated": { + "type": "boolean", + "description": "Indicates whether the customer initiated the payment.", + "nullable": true + }, + "seller_keyed_in": { + "type": "boolean", + "description": "Indicates that the seller keyed in payment details on behalf of the customer.\nThis is used to flag a payment as Mail Order / Telephone Order (MOTO).", + "nullable": true + } + } + }, + "CustomerFilter": { + "type": "object", + "description": "Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results.", + "x-release-status": "PUBLIC", + "properties": { + "creation_source": { + "$ref": "#/components/schemas/CustomerCreationSourceFilter", + "description": "A filter to select customers based on their creation source.", + "nullable": true + }, + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "A filter to select customers based on when they were created." + }, + "updated_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "A filter to select customers based on when they were last updated." + }, + "email_address": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "A filter to [select customers by their email address](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-email-address) \nvisible to the seller. \nThis filter is case-insensitive.\n\nFor [exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-email-address), this\nfilter causes the search to return customer profiles \nwhose `email_address` field value are identical to the email address provided\nin the query.\n\nFor [fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-email-address), \nthis filter causes the search to return customer profiles \nwhose `email_address` field value has a token-wise partial match against the filtering \nexpression in the query. For example, with `Steven gmail` provided in a search\nquery, the search returns customers whose email address is `steven.johnson@gmail.com` \nor `mygmail@stevensbakery.com`. Square removes any punctuation (including periods (.),\nunderscores (_), and the @ symbol) and tokenizes the email addresses on spaces. A match is\nfound if a tokenized email address contains all the tokens in the search query, \nirrespective of the token order.", + "nullable": true + }, + "phone_number": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "A filter to [select customers by their phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-phone-number)\nvisible to the seller.\n\nFor [exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-phone-number),\nthis filter returns customers whose phone number matches the specified query expression. The number in the query must be of an\nE.164-compliant form. In particular, it must include the leading `+` sign followed by a country code and then a subscriber number.\nFor example, the standard E.164 form of a US phone number is `+12062223333` and an E.164-compliant variation is `+1 (206) 222-3333`.\nTo match the query expression, stored customer phone numbers are converted to the standard E.164 form.\n\nFor [fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-phone-number),\nthis filter returns customers whose phone number matches the token or tokens provided in the query expression. For example, with `415`\nprovided in a search query, the search returns customers with the phone numbers `+1-415-212-1200`, `+1-212-415-1234`, and `+1 (551) 234-1567`.\nSimilarly, a search query of `415 123` returns customers with the phone numbers `+1-212-415-1234` and `+1 (551) 234-1567` but not\n`+1-212-415-1200`. A match is found if a tokenized phone number contains all the tokens in the search query, irrespective of the token order.", + "nullable": true + }, + "reference_id": { + "$ref": "#/components/schemas/CustomerTextFilter", + "description": "A filter to [select customers by their reference IDs](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-reference-id).\nThis filter is case-insensitive.\n\n[Exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-reference-id) \nof a customer's reference ID against a query's reference ID is evaluated as an\nexact match between two strings, character by character in the given order.\n\n[Fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-reference-id) \nof stored reference IDs against queried reference IDs works \nexactly the same as fuzzy matching on email addresses. Non-alphanumeric characters \nare replaced by spaces to tokenize stored and queried reference IDs. A match is found\nif a tokenized stored reference ID contains all tokens specified in any order in the query. For example,\na query of `NYC M` matches customer profiles with the `reference_id` value of `NYC_M_35_JOHNSON`\nand `NYC_27_MURRAY`.", + "nullable": true + }, + "group_ids": { + "$ref": "#/components/schemas/FilterValue", + "description": "A filter to select customers based on the [groups](entity:CustomerGroup) they belong to.\nGroup membership is controlled by sellers and developers.\n\nThe `group_ids` filter has the following syntax:\n```\n\"group_ids\": {\n\"any\": [\"{group_a_id}\", \"{group_b_id}\", ...],\n\"all\": [\"{group_1_id}\", \"{group_2_id}\", ...],\n\"none\": [\"{group_i_id}\", \"{group_ii_id}\", ...]\n}\n```\n\nYou can use any combination of the `any`, `all`, and `none` fields in the filter.\nWith `any`, the search returns customers in groups `a` or `b` or any other group specified in the list.\nWith `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list.\nWith `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list.\n\nIf any of the search conditions are not met, including when an invalid or non-existent group ID is provided,\nthe result is an empty object (`{}`).", + "nullable": true + }, + "custom_attribute": { + "$ref": "#/components/schemas/CustomerCustomAttributeFilters", + "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](api:CustomerCustomAttributes). For example, you can call\n[RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) using a customer ID from the result set.", + "nullable": true + }, + "segment_ids": { + "$ref": "#/components/schemas/FilterValue", + "description": " A filter to select customers based on the [segments](entity:CustomerSegment) they belong to.\nSegment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria.\n\nYou can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields.\nFor the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C.\n\n```\n\"segment_ids\": {\n\"all\": [\"{segment_A_id}\", \"{segment_B_id}\"],\n\"none\": [\"{segment_C_id}\"]\n}\n```\n\nIf an invalid or non-existent segment ID is provided in the filter, Square stops processing the request\nand returns a `400 BAD_REQUEST` error that includes the segment ID.", + "nullable": true + } + } + }, + "CustomerGroup": { + "type": "object", + "description": "Represents a group of customer profiles. \n\nCustomer groups can be created, be modified, and have their membership defined using \nthe Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.", + "x-release-status": "PUBLIC", + "required": [ + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique Square-generated ID for the customer group.", + "maxLength": 255, + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the customer group." + }, + "created_at": { + "type": "string", + "description": "The timestamp when the customer group was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the customer group was last updated, in RFC 3339 format.", + "readOnly": true + } + } + }, + "CustomerInclusionExclusion": { + "type": "string", + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "x-enum-elements": [ + { + "name": "INCLUDE", + "description": "Customers should be included in the result set when they match the\nfiltering criteria." + }, + { + "name": "EXCLUDE", + "description": "Customers should be excluded from the result set when they match\nthe filtering criteria." + } + ], + "description": "Indicates whether customers should be included in, or excluded from,\nthe result set when they match the filtering criteria.", + "x-release-status": "PUBLIC" + }, + "CustomerPreferences": { + "type": "object", + "description": "Represents communication preferences for the customer profile.", + "x-release-status": "PUBLIC", + "properties": { + "email_unsubscribed": { + "type": "boolean", + "description": "Indicates whether the customer has unsubscribed from marketing campaign emails. A value of `true` means that the customer chose to opt out of email marketing from the current Square seller or from all Square sellers. This value is read-only from the Customers API.", + "nullable": true + } + } + }, + "CustomerQuery": { + "type": "object", + "description": "Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request.", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/CustomerFilter", + "description": "The filtering criteria for the search query. A query can contain multiple filters in any combination.\nMultiple filters are combined as `AND` statements.\n\n__Note:__ Combining multiple filters as `OR` statements is not supported. Instead, send multiple single-filter\nsearches and join the result sets.", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/CustomerSort", + "description": "Sorting criteria for query results. The default behavior is to sort \ncustomers alphabetically by `given_name` and `family_name`.", + "nullable": true + } + } + }, + "CustomerSegment": { + "type": "object", + "description": "Represents a group of customer profiles that match one or more predefined filter criteria. \n\nSegments (also known as Smart Groups) are defined and created within the Customer Directory in the\nSquare Seller Dashboard or Point of Sale.", + "x-release-status": "PUBLIC", + "required": [ + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique Square-generated ID for the segment.", + "maxLength": 255, + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the segment.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the segment was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the segment was last updated, in RFC 3339 format.", + "readOnly": true + } + } + }, + "CustomerSort": { + "type": "object", + "description": "Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results.", + "x-release-status": "PUBLIC", + "properties": { + "field": { + "$ref": "#/components/schemas/CustomerSortField", + "description": "Indicates the fields to use as the sort key, which is either the default set of fields or `created_at`.\n\nThe default value is `DEFAULT`.\nSee [CustomerSortField](#type-customersortfield) for possible values", + "nullable": true + }, + "order": { + "$ref": "#/components/schemas/SortOrder", + "description": "Indicates the order in which results should be sorted based on the\nsort field value. Strings use standard alphabetic comparison\nto determine order. Strings representing numbers are sorted as strings.\n\nThe default value is `ASC`.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "CustomerSortField": { + "type": "string", + "enum": [ + "DEFAULT", + "CREATED_AT" + ], + "x-enum-elements": [ + { + "name": "DEFAULT", + "description": "Use the default sort key. By default, customers are sorted\nalphanumerically by concatenating their `given_name` and `family_name`. If\nneither name field is set, string comparison is performed using one of the\nremaining fields in the following order: `company_name`, `email`,\n`phone_number`." + }, + { + "name": "CREATED_AT", + "description": "Use the creation date attribute (`created_at`) of customer profiles as the sort key." + } + ], + "description": "Specifies customer attributes as the sort key to customer profiles returned from a search.", + "x-release-status": "PUBLIC" + }, + "CustomerTaxIds": { + "type": "object", + "description": "Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "x-release-status": "PUBLIC", + "properties": { + "eu_vat": { + "type": "string", + "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.", + "maxLength": 20, + "nullable": true + } + } + }, + "CustomerTextFilter": { + "type": "object", + "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", + "x-release-status": "PUBLIC", + "properties": { + "exact": { + "type": "string", + "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", + "nullable": true + }, + "fuzzy": { + "type": "string", + "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", + "nullable": true + } + } + }, + "DataCollectionOptions": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "title", + "body", + "input_type" + ], + "properties": { + "title": { + "type": "string", + "description": "The title text to display in the data collection flow on the Terminal.", + "minLength": 1, + "maxLength": 250 + }, + "body": { + "type": "string", + "description": "The body text to display under the title in the data collection screen flow on the\nTerminal.", + "minLength": 1, + "maxLength": 10000 + }, + "input_type": { + "$ref": "#/components/schemas/DataCollectionOptionsInputType", + "description": "Represents the type of the input text.\nSee [InputType](#type-inputtype) for possible values" + }, + "collected_data": { + "$ref": "#/components/schemas/CollectedData", + "description": "The buyer’s input text from the data collection screen.", + "readOnly": true + } + } + }, + "DataCollectionOptionsInputType": { + "type": "string", + "enum": [ + "EMAIL", + "PHONE_NUMBER" + ], + "x-enum-elements": [ + { + "name": "EMAIL", + "description": "This value is used to represent an input text that contains a email validation on the\nclient." + }, + { + "name": "PHONE_NUMBER", + "description": "This value is used to represent an input text that contains a phone number validation on\nthe client." + } + ], + "description": "Describes the input type of the data.", + "x-release-status": "BETA" + }, + "DateRange": { + "type": "object", + "description": "A range defined by two dates. Used for filtering a query for Connect v2\nobjects that have date properties.", + "x-release-status": "PUBLIC", + "properties": { + "start_date": { + "type": "string", + "description": "A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601\nextended format for calendar dates.\nThe beginning of a date range (inclusive).", + "nullable": true + }, + "end_date": { + "type": "string", + "description": "A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601\nextended format for calendar dates.\nThe end of a date range (inclusive).", + "nullable": true + } + } + }, + "DayOfWeek": { + "type": "string", + "enum": [ + "SUN", + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT" + ], + "x-enum-elements": [ + { + "name": "SUN", + "description": "Sunday" + }, + { + "name": "MON", + "description": "Monday" + }, + { + "name": "TUE", + "description": "Tuesday" + }, + { + "name": "WED", + "description": "Wednesday" + }, + { + "name": "THU", + "description": "Thursday" + }, + { + "name": "FRI", + "description": "Friday" + }, + { + "name": "SAT", + "description": "Saturday" + } + ], + "description": "Indicates the specific day of the week.", + "x-release-status": "PUBLIC" + }, + "DeleteBookingCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteBookingCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition) response\ncontaining error messages when errors occurred during the request. The successful response does not contain any payload.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "errors": [] + } + }, + "DeleteBookingCustomAttributeRequest": { + "type": "object", + "description": "Represents a [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteBookingCustomAttributeResponse": { + "type": "object", + "description": "Represents a [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "errors": [] + } + }, + "DeleteBreakTypeRequest": { + "type": "object", + "description": "A request to delete a `BreakType`.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteBreakTypeResponse": { + "type": "object", + "description": "The response to a request to delete a `BreakType`. The response might contain a set \nof `Error` objects if the request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteCatalogObjectRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.csharp", + "java": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.java", + "javascript": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.javascript", + "php": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.php", + "python": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.python", + "ruby": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.ruby" + } + }, + "DeleteCatalogObjectResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "deleted_object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of all catalog objects deleted by this request.\nMultiple IDs may be returned when associated objects are also deleted, for example\na catalog item variation will be deleted (and its ID included in this field)\nwhen its parent catalog item is deleted." + }, + "deleted_at": { + "type": "string", + "description": "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nof this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`." + } + }, + "example": { + "deleted_at": "2016-11-16T22:25:24.878Z", + "deleted_object_ids": [ + "7SB3ZQYJ5GDMVFL7JK46JCHT", + "KQLFFHA6K6J3YQAQAWDQAL57" + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.csharp", + "java": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.java", + "javascript": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.javascript", + "php": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.php", + "python": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.python", + "ruby": "/sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.ruby" + } + }, + "DeleteCustomerCardRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the\n`DeleteCustomerCard` endpoint.", + "x-release-status": "DEPRECATED", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.csharp", + "java": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.java", + "javascript": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.javascript", + "php": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.php", + "python": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.python", + "ruby": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.ruby" + } + }, + "DeleteCustomerCardResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `DeleteCustomerCard` endpoint.", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.csharp", + "java": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.java", + "javascript": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.javascript", + "php": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.php", + "python": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.python", + "ruby": "/sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.ruby" + } + }, + "DeleteCustomerCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [DeleteCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?key=favoritemovie", + "properties": {} + }, + "DeleteCustomerCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from a delete request containing error messages if there are any.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteCustomerCustomAttributeRequest": { + "type": "object", + "description": "Represents a [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR\u0026key=favoritemovie", + "properties": {} + }, + "DeleteCustomerCustomAttributeResponse": { + "type": "object", + "description": "Represents a [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteCustomerGroupRequest": { + "type": "object", + "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "DeleteCustomerGroupResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteCustomerRequest": { + "type": "object", + "description": "Defines the fields that are included in a request to the `DeleteCustomer`\nendpoint.", + "x-release-status": "PUBLIC", + "x-params-example": "?version=11", + "properties": { + "version": { + "type": "integer", + "description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).", + "format": "int64" + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/DeleteCustomer/DeleteCustomerRequest.csharp", + "java": "/sdk_samples/DeleteCustomer/DeleteCustomerRequest.java", + "javascript": "/sdk_samples/DeleteCustomer/DeleteCustomerRequest.javascript", + "php": "/sdk_samples/DeleteCustomer/DeleteCustomerRequest.php", + "python": "/sdk_samples/DeleteCustomer/DeleteCustomerRequest.python", + "ruby": "/sdk_samples/DeleteCustomer/DeleteCustomerRequest.ruby" + } + }, + "DeleteCustomerResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `DeleteCustomer` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/DeleteCustomer/DeleteCustomerResponse.csharp", + "java": "/sdk_samples/DeleteCustomer/DeleteCustomerResponse.java", + "javascript": "/sdk_samples/DeleteCustomer/DeleteCustomerResponse.javascript", + "php": "/sdk_samples/DeleteCustomer/DeleteCustomerResponse.php", + "python": "/sdk_samples/DeleteCustomer/DeleteCustomerResponse.python", + "ruby": "/sdk_samples/DeleteCustomer/DeleteCustomerResponse.ruby" + } + }, + "DeleteDisputeEvidenceRequest": { + "type": "object", + "description": "Defines the parameters for a `DeleteDisputeEvidence` request.", + "x-release-status": "PUBLIC", + "x-params-example": "?dispute_id=bVTprrwk0gygTLZ96VX1oB\u0026evidence_id=CpfnkwGselCwS8QFvxN6", + "properties": {}, + "example": {} + }, + "DeleteDisputeEvidenceResponse": { + "type": "object", + "description": "Defines the fields in a `DeleteDisputeEvidence` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": {} + }, + "DeleteInvoiceAttachmentRequest": { + "type": "object", + "description": "Represents a [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteInvoiceAttachmentResponse": { + "type": "object", + "description": "Represents a [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": {} + }, + "DeleteInvoiceRequest": { + "type": "object", + "description": "Describes a `DeleteInvoice` request.", + "x-release-status": "PUBLIC", + "properties": { + "version": { + "type": "integer", + "description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices)." + } + } + }, + "DeleteInvoiceResponse": { + "type": "object", + "description": "Describes a `DeleteInvoice` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": {} + }, + "DeleteLocationCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [DeleteLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "x-params-example": "?key=bestseller", + "properties": {} + }, + "DeleteLocationCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from a delete request containing error messages if there are any.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteLocationCustomAttributeRequest": { + "type": "object", + "description": "Represents a [DeleteLocationCustomAttribute](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttribute) request.", + "x-release-status": "BETA", + "x-params-example": "?location_id=L0TBCBTB7P8RQ\u0026key=bestseller", + "properties": {} + }, + "DeleteLocationCustomAttributeResponse": { + "type": "object", + "description": "Represents a [DeleteLocationCustomAttribute](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteLoyaltyRewardRequest": { + "type": "object", + "description": "A request to delete a loyalty reward.", + "x-release-status": "PUBLIC", + "x-params-example": "?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810", + "properties": {} + }, + "DeleteLoyaltyRewardResponse": { + "type": "object", + "description": "A response returned by the API call.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteMerchantCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [DeleteMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "x-params-example": "?key=alternative_seller_name", + "properties": {} + }, + "DeleteMerchantCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from a delete request containing error messages if there are any.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteMerchantCustomAttributeRequest": { + "type": "object", + "description": "Represents a [DeleteMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttribute) request.", + "x-release-status": "BETA", + "x-params-example": "?merchant_id=DM7VKY8Q63GNP\u0026key=alternative_seller_name", + "properties": {} + }, + "DeleteMerchantCustomAttributeResponse": { + "type": "object", + "description": "Represents a [DeleteMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteOrderCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a delete request for an order custom attribute definition.", + "x-release-status": "BETA", + "x-params-example": "?key=table-number", + "properties": {} + }, + "DeleteOrderCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from deleting an order custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteOrderCustomAttributeRequest": { + "type": "object", + "description": "Represents a delete request for an order custom attribute.", + "x-release-status": "BETA", + "x-params-example": "?order_id=7BbXGEIWNldxAzrtGf9GPVZTwZ4F\u0026key=seat-number", + "properties": {} + }, + "DeleteOrderCustomAttributeResponse": { + "type": "object", + "description": "Represents a response from deleting an order custom attribute.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeletePaymentLinkRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeletePaymentLinkResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + } + }, + "id": { + "type": "string", + "description": "The ID of the link that is deleted." + }, + "cancelled_order_id": { + "type": "string", + "description": "The ID of the order that is canceled. When a payment link is deleted, Square updates the\nthe `state` (of the order that the checkout link created) to CANCELED." + } + }, + "example": { + "cancelled_order_id": "asx8LgZ6MRzD0fObfkJ6obBmSh4F", + "id": "MQASNYL6QB6DFCJ3" + } + }, + "DeleteShiftRequest": { + "type": "object", + "description": "A request to delete a `Shift`.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteShiftResponse": { + "type": "object", + "description": "The response to a request to delete a `Shift`. The response might contain a set of \n`Error` objects if the request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteSnippetRequest": { + "type": "object", + "description": "Represents a `DeleteSnippet` request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteSnippetResponse": { + "type": "object", + "description": "Represents a `DeleteSnippet` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "DeleteSubscriptionActionRequest": { + "type": "object", + "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction)\nendpoint.", + "x-release-status": "BETA", + "properties": {} + }, + "DeleteSubscriptionActionResponse": { + "type": "object", + "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction)\nendpoint.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The subscription that has the specified action deleted." + } + }, + "example": { + "subscription": { + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "charged_through_date": "2023-11-20", + "created_at": "2022-07-27T21:53:10Z", + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "id": "8151fc89-da15-4eb9-a685-1a70883cebfc", + "invoice_ids": [ + "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA" + ], + "location_id": "S8GWD5R9QB376", + "paid_until_date": "2024-08-01", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "price_override_money": { + "amount": 25000, + "currency": "USD" + }, + "source": { + "name": "My Application" + }, + "start_date": "2022-07-27", + "status": "ACTIVE", + "timezone": "America/Los_Angeles" + } + } + }, + "DeleteWebhookSubscriptionRequest": { + "type": "object", + "description": "Deletes a [Subscription](entity:WebhookSubscription).", + "x-release-status": "PUBLIC", + "properties": {} + }, + "DeleteWebhookSubscriptionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](api-endpoint:WebhookSubscriptions-DeleteWebhookSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + } + }, + "example": {} + }, + "DeprecatedCreateDisputeEvidenceFileRequest": { + "type": "object", + "description": "Defines the parameters for a `DeprecatedCreateDisputeEvidenceFile` request.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 45 + }, + "evidence_type": { + "$ref": "#/components/schemas/DisputeEvidenceType", + "description": "The type of evidence you are uploading.\nSee [DisputeEvidenceType](#type-disputeevidencetype) for possible values", + "nullable": true + }, + "content_type": { + "type": "string", + "description": "The MIME type of the uploaded file.\nThe type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.", + "minLength": 1, + "maxLength": 40, + "nullable": true + } + } + }, + "DeprecatedCreateDisputeEvidenceFileResponse": { + "type": "object", + "description": "Defines the fields in a `DeprecatedCreateDisputeEvidenceFile` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "evidence": { + "$ref": "#/components/schemas/DisputeEvidence", + "description": "The metadata of the newly uploaded dispute evidence." + } + }, + "example": { + "evidence": { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_file": { + "filename": "evidence.tiff", + "filetype": "image/tiff" + }, + "evidence_id": "TOomLInj6iWmP3N8qfCXrB", + "evidence_type": "GENERIC_EVIDENCE", + "uploaded_at": "2018-10-18T16:01:10.000Z" + } + } + }, + "DeprecatedCreateDisputeEvidenceTextRequest": { + "type": "object", + "description": "Defines the parameters for a `DeprecatedCreateDisputeEvidenceText` request.", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "evidence_text" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 45 + }, + "evidence_type": { + "$ref": "#/components/schemas/DisputeEvidenceType", + "description": "The type of evidence you are uploading.\nSee [DisputeEvidenceType](#type-disputeevidencetype) for possible values", + "nullable": true + }, + "evidence_text": { + "type": "string", + "description": "The evidence string.", + "minLength": 1, + "maxLength": 500 + } + }, + "example": { + "evidence_text": "1Z8888888888888888", + "evidence_type": "TRACKING_NUMBER", + "idempotency_key": "ed3ee3933d946f1514d505d173c82648" + } + }, + "DeprecatedCreateDisputeEvidenceTextResponse": { + "type": "object", + "description": "Defines the fields in a `DeprecatedCreateDisputeEvidenceText` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "evidence": { + "$ref": "#/components/schemas/DisputeEvidence", + "description": "The newly uploaded dispute evidence metadata." + } + }, + "example": { + "evidence": { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_text": "The customer purchased the item twice, on April 11 and April 28.", + "evidence_type": "REBUTTAL_EXPLANATION", + "id": "TOomLInj6iWmP3N8qfCXrB", + "uploaded_at": "2022-05-18T16:01:10.000Z" + } + } + }, + "Destination": { + "type": "object", + "description": "Information about the destination against which the payout was made.", + "x-release-status": "PUBLIC", + "properties": { + "type": { + "$ref": "#/components/schemas/DestinationType", + "description": "Type of the destination such as a bank account or debit card.\nSee [DestinationType](#type-destinationtype) for possible values", + "nullable": true + }, + "id": { + "type": "string", + "description": "Square issued unique ID (also known as the instrument ID) associated with this destination." + } + } + }, + "DestinationDetails": { + "type": "object", + "description": "Details about a refund's destination.", + "x-release-status": "PUBLIC", + "properties": { + "card_details": { + "$ref": "#/components/schemas/DestinationDetailsCardRefundDetails", + "description": "Details about a card refund. Only populated if the destination_type is `CARD`.", + "nullable": true + }, + "cash_details": { + "$ref": "#/components/schemas/DestinationDetailsCashRefundDetails", + "description": "Details about a cash refund. Only populated if the destination_type is `CASH`.", + "nullable": true + }, + "external_details": { + "$ref": "#/components/schemas/DestinationDetailsExternalRefundDetails", + "description": "Details about an external refund. Only populated if the destination_type is `EXTERNAL`.", + "nullable": true + } + } + }, + "DestinationDetailsCardRefundDetails": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "card": { + "$ref": "#/components/schemas/Card", + "description": "The card's non-confidential details.", + "nullable": true + }, + "entry_method": { + "type": "string", + "description": "The method used to enter the card's details for the refund. The method can be\n`KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.", + "maxLength": 50, + "nullable": true + }, + "auth_result_code": { + "type": "string", + "description": "The authorization code provided by the issuer when a refund is approved.", + "maxLength": 10, + "nullable": true + } + } + }, + "DestinationDetailsCashRefundDetails": { + "type": "object", + "description": "Stores details about a cash refund. Contains only non-confidential information.", + "x-release-status": "PUBLIC", + "required": [ + "seller_supplied_money" + ], + "properties": { + "seller_supplied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount and currency of the money supplied by the seller." + }, + "change_back_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of change due back to the seller.\nThis read-only field is calculated\nfrom the `amount_money` and `seller_supplied_money` fields.", + "nullable": true + } + } + }, + "DestinationDetailsExternalRefundDetails": { + "type": "object", + "description": "Stores details about an external refund. Contains only non-confidential information.", + "x-release-status": "PUBLIC", + "required": [ + "type", + "source" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of external refund the seller paid to the buyer. It can be one of the\nfollowing:\n- CHECK - Refunded using a physical check.\n- BANK_TRANSFER - Refunded using external bank transfer.\n- OTHER\\_GIFT\\_CARD - Refunded using a non-Square gift card.\n- CRYPTO - Refunded using a crypto currency.\n- SQUARE_CASH - Refunded using Square Cash App.\n- SOCIAL - Refunded using peer-to-peer payment applications.\n- EXTERNAL - A third-party application gathered this refund outside of Square.\n- EMONEY - Refunded using an E-money provider.\n- CARD - A credit or debit card that Square does not support.\n- STORED_BALANCE - Use for house accounts, store credit, and so forth.\n- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals\n- OTHER - A type not listed here.", + "maxLength": 50 + }, + "source": { + "type": "string", + "description": "A description of the external refund source. For example,\n\"Food Delivery Service\".", + "maxLength": 255 + }, + "source_id": { + "type": "string", + "description": "An ID to associate the refund to its originating source.", + "maxLength": 255, + "nullable": true + } + } + }, + "DestinationType": { + "type": "string", + "enum": [ + "BANK_ACCOUNT", + "CARD", + "SQUARE_BALANCE", + "SQUARE_STORED_BALANCE" + ], + "x-enum-elements": [ + { + "name": "BANK_ACCOUNT", + "description": "An external bank account outside of Square." + }, + { + "name": "CARD", + "description": "An external card outside of Square used for the transfer." + }, + { + "name": "SQUARE_BALANCE", + "description": "" + }, + { + "name": "SQUARE_STORED_BALANCE", + "description": "Square Checking or Savings account (US), Square Card (CA)" + } + ], + "description": "List of possible destinations against which a payout can be made.", + "x-release-status": "PUBLIC" + }, + "Device": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "attributes" + ], + "properties": { + "id": { + "type": "string", + "description": "A synthetic identifier for the device. The identifier includes a standardized prefix and\nis otherwise an opaque id generated from key device fields.", + "readOnly": true + }, + "attributes": { + "$ref": "#/components/schemas/DeviceAttributes", + "description": "A collection of DeviceAttributes representing the device." + }, + "components": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Component" + }, + "description": "A list of components applicable to the device.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/DeviceStatus", + "description": "The current status of the device.", + "readOnly": true + } + } + }, + "DeviceAttributes": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "type", + "manufacturer" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/DeviceAttributesDeviceType", + "description": "The device type.\nSee [DeviceType](#type-devicetype) for possible values" + }, + "manufacturer": { + "type": "string", + "description": "The maker of the device." + }, + "model": { + "type": "string", + "description": "The specific model of the device.", + "nullable": true + }, + "name": { + "type": "string", + "description": "A seller-specified name for the device.", + "nullable": true + }, + "manufacturers_id": { + "type": "string", + "description": "The manufacturer-supplied identifier for the device (where available). In many cases,\nthis identifier will be a serial number.", + "nullable": true + }, + "updated_at": { + "type": "string", + "description": "The RFC 3339-formatted value of the most recent update to the device information.\n(Could represent any field update on the device.)" + }, + "version": { + "type": "string", + "description": "The current version of software installed on the device." + }, + "merchant_token": { + "type": "string", + "description": "The merchant_token identifying the merchant controlling the device.", + "nullable": true + } + } + }, + "DeviceAttributesDeviceType": { + "type": "string", + "enum": [ + "TERMINAL" + ], + "x-enum-elements": [ + { + "name": "TERMINAL", + "description": "" + } + ], + "description": "An enum identifier of the device type.", + "x-release-status": "BETA" + }, + "DeviceCheckoutOptions": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "device_id" + ], + "properties": { + "device_id": { + "type": "string", + "description": "The unique ID of the device intended for this `TerminalCheckout`.\nA list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint.\nMatch a `DeviceCode.device_id` value with `device_id` to get the associated device code." + }, + "skip_receipt_screen": { + "type": "boolean", + "description": "Instructs the device to skip the receipt screen. Defaults to false.", + "nullable": true + }, + "collect_signature": { + "type": "boolean", + "description": "Indicates that signature collection is desired during checkout. Defaults to false.", + "nullable": true + }, + "tip_settings": { + "$ref": "#/components/schemas/TipSettings", + "description": "Tip-specific settings.", + "nullable": true + }, + "show_itemized_cart": { + "type": "boolean", + "description": "Show the itemization screen prior to taking a payment. This field is only meaningful when the\ncheckout includes an order ID. Defaults to true.", + "nullable": true + } + } + }, + "DeviceCode": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "product_type" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique id for this device code.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "An optional user-defined name for the device code.", + "maxLength": 128, + "nullable": true + }, + "code": { + "type": "string", + "description": "The unique code that can be used to login.", + "readOnly": true + }, + "device_id": { + "type": "string", + "description": "The unique id of the device that used this code. Populated when the device is paired up.", + "readOnly": true + }, + "product_type": { + "$ref": "#/components/schemas/ProductType", + "description": "The targeting product type of the device code." + }, + "location_id": { + "type": "string", + "description": "The location assigned to this code.", + "maxLength": 50, + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/DeviceCodeStatus", + "description": "The pairing status of the device code.\nSee [DeviceCodeStatus](#type-devicecodestatus) for possible values", + "readOnly": true + }, + "pair_by": { + "type": "string", + "description": "When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "When this DeviceCode was created. Timestamp in RFC 3339 format.", + "readOnly": true + }, + "status_changed_at": { + "type": "string", + "description": "When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.", + "readOnly": true + }, + "paired_at": { + "type": "string", + "description": "When this DeviceCode was paired. Timestamp in RFC 3339 format.", + "readOnly": true + } + } + }, + "DeviceCodeStatus": { + "type": "string", + "enum": [ + "UNKNOWN", + "UNPAIRED", + "PAIRED", + "EXPIRED" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN", + "description": "The status cannot be determined or does not exist." + }, + { + "name": "UNPAIRED", + "description": "The device code is just created and unpaired." + }, + { + "name": "PAIRED", + "description": "The device code has been signed in and paired to a device." + }, + { + "name": "EXPIRED", + "description": "The device code was unpaired and expired before it was paired." + } + ], + "description": "DeviceCode.Status enum.", + "x-release-status": "PUBLIC" + }, + "DeviceComponentDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": {} + }, + "DeviceComponentDetailsApplicationDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "application_type": { + "$ref": "#/components/schemas/ApplicationType", + "description": "The type of application.\nSee [ApplicationType](#type-applicationtype) for possible values", + "nullable": true + }, + "version": { + "type": "string", + "description": "The version of the application." + }, + "session_location": { + "type": "string", + "description": "The location_id of the session for the application.", + "nullable": true + }, + "device_code_id": { + "type": "string", + "description": "The id of the device code that was used to log in to the device.", + "nullable": true + } + } + }, + "DeviceComponentDetailsBatteryDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "visible_percent": { + "type": "integer", + "description": "The battery charge percentage as displayed on the device.", + "nullable": true + }, + "external_power": { + "$ref": "#/components/schemas/DeviceComponentDetailsExternalPower", + "description": "The status of external_power.\nSee [ExternalPower](#type-externalpower) for possible values", + "nullable": true + } + } + }, + "DeviceComponentDetailsCardReaderDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "version": { + "type": "string", + "description": "The version of the card reader." + } + } + }, + "DeviceComponentDetailsEthernetDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "active": { + "type": "boolean", + "description": "A boolean to represent whether the Ethernet interface is currently active.", + "nullable": true + }, + "ip_address_v4": { + "type": "string", + "description": "The string representation of the device’s IPv4 address.", + "nullable": true + } + } + }, + "DeviceComponentDetailsExternalPower": { + "type": "string", + "enum": [ + "AVAILABLE_CHARGING", + "AVAILABLE_NOT_IN_USE", + "UNAVAILABLE", + "AVAILABLE_INSUFFICIENT" + ], + "x-enum-elements": [ + { + "name": "AVAILABLE_CHARGING", + "description": "Plugged in and charging." + }, + { + "name": "AVAILABLE_NOT_IN_USE", + "description": "Fully charged." + }, + { + "name": "UNAVAILABLE", + "description": "On battery power." + }, + { + "name": "AVAILABLE_INSUFFICIENT", + "description": "Not providing enough power for the device." + } + ], + "description": "An enum for ExternalPower.", + "x-release-status": "BETA" + }, + "DeviceComponentDetailsMeasurement": { + "type": "object", + "description": "A value qualified by unit of measure.", + "x-release-status": "BETA", + "properties": { + "value": { + "type": "integer", + "nullable": true + } + } + }, + "DeviceComponentDetailsNetworkInterfaceDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "ip_address_v4": { + "type": "string", + "description": "The string representation of the device’s IPv4 address.", + "nullable": true + } + } + }, + "DeviceComponentDetailsWiFiDetails": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "active": { + "type": "boolean", + "description": "A boolean to represent whether the WiFI interface is currently active.", + "nullable": true + }, + "ssid": { + "type": "string", + "description": "The name of the connected WIFI network.", + "nullable": true + }, + "ip_address_v4": { + "type": "string", + "description": "The string representation of the device’s IPv4 address.", + "nullable": true + }, + "secure_connection": { + "type": "string", + "description": "The security protocol for a secure connection (e.g. WPA2). None provided if the connection\nis unsecured.", + "nullable": true + }, + "signal_strength": { + "$ref": "#/components/schemas/DeviceComponentDetailsMeasurement", + "description": "A representation of signal strength of the WIFI network connection.", + "nullable": true + } + } + }, + "DeviceDetails": { + "type": "object", + "description": "Details about the device that took the payment.", + "x-release-status": "PUBLIC", + "properties": { + "device_id": { + "type": "string", + "description": "The Square-issued ID of the device.", + "maxLength": 255, + "nullable": true + }, + "device_installation_id": { + "type": "string", + "description": "The Square-issued installation ID for the device.", + "maxLength": 255, + "nullable": true + }, + "device_name": { + "type": "string", + "description": "The name of the device set by the seller.", + "maxLength": 255, + "nullable": true + } + } + }, + "DeviceMetadata": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "battery_percentage": { + "type": "string", + "description": "The Terminal’s remaining battery percentage, between 1-100.", + "nullable": true + }, + "charging_state": { + "type": "string", + "description": "The current charging state of the Terminal.\nOptions: `CHARGING`, `NOT_CHARGING`", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the Square seller business location associated with the Terminal.", + "nullable": true + }, + "merchant_id": { + "type": "string", + "description": "The ID of the Square merchant account that is currently signed-in to the Terminal.", + "nullable": true + }, + "network_connection_type": { + "type": "string", + "description": "The Terminal’s current network connection type.\nOptions: `WIFI`, `ETHERNET`", + "nullable": true + }, + "payment_region": { + "type": "string", + "description": "The country in which the Terminal is authorized to take payments.", + "nullable": true + }, + "serial_number": { + "type": "string", + "description": "The unique identifier assigned to the Terminal, which can be found on the lower back\nof the device.", + "nullable": true + }, + "os_version": { + "type": "string", + "description": "The current version of the Terminal’s operating system.", + "nullable": true + }, + "app_version": { + "type": "string", + "description": "The current version of the application running on the Terminal.", + "nullable": true + }, + "wifi_network_name": { + "type": "string", + "description": "The name of the Wi-Fi network to which the Terminal is connected.", + "nullable": true + }, + "wifi_network_strength": { + "type": "string", + "description": "The signal strength of the Wi-FI network connection.\nOptions: `POOR`, `FAIR`, `GOOD`, `EXCELLENT`", + "nullable": true + }, + "ip_address": { + "type": "string", + "description": "The IP address of the Terminal.", + "nullable": true + } + } + }, + "DeviceStatus": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "category": { + "$ref": "#/components/schemas/DeviceStatusCategory", + "description": "\nSee [Category](#type-category) for possible values", + "nullable": true + } + } + }, + "DeviceStatusCategory": { + "type": "string", + "enum": [ + "AVAILABLE", + "NEEDS_ATTENTION", + "OFFLINE" + ], + "x-enum-elements": [ + { + "name": "AVAILABLE", + "description": "" + }, + { + "name": "NEEDS_ATTENTION", + "description": "" + }, + { + "name": "OFFLINE", + "description": "" + } + ], + "x-release-status": "BETA" + }, + "DigitalWalletDetails": { + "type": "object", + "description": "Additional details about `WALLET` type payments. Contains only non-confidential information.", + "x-release-status": "PUBLIC", + "properties": { + "status": { + "type": "string", + "description": "The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or\n`FAILED`.", + "maxLength": 50, + "nullable": true + }, + "brand": { + "type": "string", + "description": "The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`,\n`RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`.", + "maxLength": 50, + "nullable": true + }, + "cash_app_details": { + "$ref": "#/components/schemas/CashAppDetails", + "description": "Brand-specific details for payments with the `brand` of `CASH_APP`.", + "nullable": true + } + } + }, + "DisableCardRequest": { + "type": "object", + "description": "Disables the card, preventing any further updates or charges. Disabling\nan already disabled card is allowed but has no effect. Accessible via\nHTTP requests at POST https://connect.squareup.com/v2/cards/{card_id}/disable", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "DisableCardResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](api-endpoint:Cards-DisableCard) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "The retrieved card." + } + }, + "example": { + "card": { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "bin": "411111", + "card_brand": "VISA", + "card_type": "CREDIT", + "cardholder_name": "Amelia Earhart", + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "enabled": false, + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q", + "hsa_fsa": false, + "id": "ccof:uIbfJXhXETSP197M3GB", + "last_4": "1111", + "merchant_id": "6SSW7HV8K2ST5", + "prepaid_type": "NOT_PREPAID", + "reference_id": "user-id-1", + "version": 2 + } + } + }, + "DisableEventsRequest": { + "type": "object", + "description": "Disables [Event](entity:Event)s for your application.", + "x-release-status": "BETA", + "properties": {} + }, + "DisableEventsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [DisableEvents](api-endpoint:Events-DisableEvents) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + } + }, + "example": {} + }, + "DismissTerminalActionRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "DismissTerminalActionResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "action": { + "$ref": "#/components/schemas/TerminalAction", + "description": "Current state of the action to be dismissed." + } + }, + "example": { + "action": { + "app_id": "APP_ID", + "await_next_action": true, + "await_next_action_duration": "PT5M", + "confirmation_options": { + "agree_button_text": "Agree", + "body": "I agree to receive promotional emails about future events and activities.", + "decision": { + "has_agreed": true + }, + "disagree_button_text": "Decline", + "title": "Marketing communications" + }, + "created_at": "2021-07-28T23:22:07.476Z", + "deadline_duration": "PT5M", + "device_id": "DEVICE_ID", + "id": "termapia:abcdefg1234567", + "status": "COMPLETED", + "type": "CONFIRMATION", + "updated_at": "2021-07-28T23:22:29.511Z" + } + } + }, + "DismissTerminalCheckoutRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "DismissTerminalCheckoutResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "checkout": { + "$ref": "#/components/schemas/TerminalCheckout", + "description": "Current state of the checkout to be dismissed." + } + }, + "example": { + "checkout": { + "amount_money": { + "amount": 2610, + "currency": "USD" + }, + "app_id": "APP_ID", + "created_at": "2023-11-29T14:59:50.682Z", + "deadline_duration": "PT5M", + "device_options": { + "collect_signature": true, + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", + "loyalty_settings": { + "loyalty_screen_max_display_duration": "PT60S", + "show_card_linked_reward_redemption_screen": false, + "show_loyalty_screen": false, + "show_non_qualifying_loyalty_screen": false + }, + "skip_receipt_screen": false, + "tip_settings": { + "allow_tipping": true, + "custom_tip_field": false, + "separate_tip_screen": true + } + }, + "id": "LmZEKbo3SBfqO", + "location_id": "LOCATION_ID", + "payment_ids": [ + "D7vLJqMkvSoAlX4yyFzUitOy4EPZY" + ], + "payment_options": { + "autocomplete": true + }, + "payment_type": "CARD_PRESENT", + "status": "COMPLETED", + "updated_at": "2023-11-29T15:00:18.936Z" + } + } + }, + "DismissTerminalRefundRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "DismissTerminalRefundResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "refund": { + "$ref": "#/components/schemas/TerminalRefund", + "description": "Current state of the refund to be dismissed." + } + }, + "example": { + "refund": { + "amount_money": { + "amount": 111, + "currency": "CAD" + }, + "app_id": "APP_ID", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 12, + "exp_year": 2024, + "fingerprint": "sq-1-ElNeDpZZqUBNDI7yNghyKO-o0yLXASp4qQDGIPtxnFvTTWoqdfdP6TV8gLsSxoztXA", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_details": { + "auth_result_code": "RNy6Lf", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 12, + "exp_year": 2024, + "fingerprint": "sq-1-ElNeDpZZqUBNDI7yNghyKO-o0yLXASp3qQDGIPtxnFvTTWoqdfdP6TV9gLsSxoztXA", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2023-11-30T16:15:06.645Z", + "captured_at": "2023-11-30T16:15:13.272Z" + }, + "cvv_status": "CVV_ACCEPTED", + "device_details": { + "device_credential": { + "name": "Terminal API Device created on Nov 2, 2023", + "token": "9BFDXEYKB7H8Y" + }, + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + "device_installation_id": "0ef67d8e-61a3-4418-a0be-c143bfe6108d" + }, + "entry_method": "SWIPED", + "statement_description": "SQ TREATS", + "status": "CAPTURED" + }, + "created_at": "2023-11-30T16:16:39.299Z", + "deadline_duration": "PT5M", + "device_id": "47776348fd8b32b9", + "id": "vjkNb2HD-xq5kiWWiJ7RhwrQnkxIn2N0l1nPZY", + "order_id": "s8OMhQcpEp1b61YywlccSHWqUaQZY", + "payment_id": "xq5kiWWiJ7RhwrQnkxIn2N0l1nPZY", + "reason": "Returning item", + "status": "IN_PROGRESS", + "updated_at": "2023-11-30T16:16:57.863Z" + } + } + }, + "Dispute": { + "type": "object", + "description": "Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank.", + "x-release-status": "PUBLIC", + "properties": { + "dispute_id": { + "type": "string", + "description": "The unique ID for this `Dispute`, generated by Square.", + "minLength": 1, + "maxLength": 40, + "x-release-status": "DEPRECATED", + "nullable": true + }, + "id": { + "type": "string", + "description": "The unique ID for this `Dispute`, generated by Square.", + "minLength": 1, + "maxLength": 40 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The disputed amount, which can be less than the total transaction amount.\nFor instance, if multiple items were purchased but the cardholder only initiates a dispute over some of the items.", + "nullable": true + }, + "reason": { + "$ref": "#/components/schemas/DisputeReason", + "description": "The reason why the cardholder initiated the dispute.\nSee [DisputeReason](#type-disputereason) for possible values", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/DisputeState", + "description": "The current state of this dispute.\nSee [DisputeState](#type-disputestate) for possible values", + "nullable": true + }, + "due_at": { + "type": "string", + "description": "The deadline by which the seller must respond to the dispute, in [RFC 3339 format](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates).", + "minLength": 1, + "maxLength": 40, + "nullable": true + }, + "disputed_payment": { + "$ref": "#/components/schemas/DisputedPayment", + "description": "The payment challenged in this dispute.", + "nullable": true + }, + "evidence_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the evidence associated with the dispute.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "card_brand": { + "$ref": "#/components/schemas/CardBrand", + "description": "The card brand used in the disputed payment.\nSee [CardBrand](#type-cardbrand) for possible values", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the dispute was created, in RFC 3339 format.", + "minLength": 1, + "maxLength": 40, + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the dispute was last updated, in RFC 3339 format.", + "minLength": 1, + "maxLength": 40, + "readOnly": true + }, + "brand_dispute_id": { + "type": "string", + "description": "The ID of the dispute in the card brand system, generated by the card brand.", + "minLength": 1, + "maxLength": 40, + "nullable": true + }, + "reported_date": { + "type": "string", + "description": "The timestamp when the dispute was reported, in RFC 3339 format.", + "minLength": 1, + "maxLength": 40, + "x-release-status": "DEPRECATED", + "nullable": true + }, + "reported_at": { + "type": "string", + "description": "The timestamp when the dispute was reported, in RFC 3339 format.", + "minLength": 1, + "maxLength": 40, + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the `Dispute`." + }, + "location_id": { + "type": "string", + "description": "The ID of the location where the dispute originated.", + "minLength": 1, + "maxLength": 40, + "nullable": true + } + } + }, + "DisputeEvidence": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "evidence_id": { + "type": "string", + "description": "The Square-generated ID of the evidence.", + "minLength": 1, + "maxLength": 40, + "x-release-status": "DEPRECATED", + "nullable": true + }, + "id": { + "type": "string", + "description": "The Square-generated ID of the evidence.", + "minLength": 1, + "maxLength": 40 + }, + "dispute_id": { + "type": "string", + "description": "The ID of the dispute the evidence is associated with.", + "minLength": 1, + "maxLength": 40, + "nullable": true + }, + "evidence_file": { + "$ref": "#/components/schemas/DisputeEvidenceFile", + "description": "Image, PDF, TXT", + "nullable": true + }, + "evidence_text": { + "type": "string", + "description": "Raw text", + "minLength": 1, + "maxLength": 500, + "nullable": true + }, + "uploaded_at": { + "type": "string", + "description": "The time when the evidence was uploaded, in RFC 3339 format.", + "minLength": 1, + "maxLength": 40, + "nullable": true + }, + "evidence_type": { + "$ref": "#/components/schemas/DisputeEvidenceType", + "description": "The type of the evidence.\nSee [DisputeEvidenceType](#type-disputeevidencetype) for possible values", + "nullable": true + } + } + }, + "DisputeEvidenceFile": { + "type": "object", + "description": "A file to be uploaded as dispute evidence.", + "x-release-status": "PUBLIC", + "properties": { + "filename": { + "type": "string", + "description": "The file name including the file extension. For example: \"receipt.tiff\".", + "minLength": 1, + "maxLength": 40, + "nullable": true + }, + "filetype": { + "type": "string", + "description": "Dispute evidence files must be application/pdf, image/heic, image/heif, image/jpeg, image/png, or image/tiff formats.", + "minLength": 1, + "maxLength": 40, + "nullable": true + } + } + }, + "DisputeEvidenceType": { + "type": "string", + "enum": [ + "GENERIC_EVIDENCE", + "ONLINE_OR_APP_ACCESS_LOG", + "AUTHORIZATION_DOCUMENTATION", + "CANCELLATION_OR_REFUND_DOCUMENTATION", + "CARDHOLDER_COMMUNICATION", + "CARDHOLDER_INFORMATION", + "PURCHASE_ACKNOWLEDGEMENT", + "DUPLICATE_CHARGE_DOCUMENTATION", + "PRODUCT_OR_SERVICE_DESCRIPTION", + "RECEIPT", + "SERVICE_RECEIVED_DOCUMENTATION", + "PROOF_OF_DELIVERY_DOCUMENTATION", + "RELATED_TRANSACTION_DOCUMENTATION", + "REBUTTAL_EXPLANATION", + "TRACKING_NUMBER" + ], + "x-enum-elements": [ + { + "name": "GENERIC_EVIDENCE", + "description": "Square assumes this evidence type if you do not provide a type when uploading evidence.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "ONLINE_OR_APP_ACCESS_LOG", + "description": "Server or activity logs that show proof of the cardholder’s identity and that the\ncardholder successfully ordered and received the goods (digitally or otherwise).\nExample evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email\naddress linked to a cardholder profile held by the seller, proof the same device and card (used\nin dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "AUTHORIZATION_DOCUMENTATION", + "description": "Evidence that the cardholder did provide authorization for the charge.\nExample evidence includes a signed credit card authorization.\n\nUse when uploading evidence as a file." + }, + { + "name": "CANCELLATION_OR_REFUND_DOCUMENTATION", + "description": "Evidence that the cardholder acknowledged your refund or cancellation policy.\nExample evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your\nrefund or cancellation policy.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "CARDHOLDER_COMMUNICATION", + "description": "Evidence that shows relevant communication with the cardholder.\nExample evidence includes emails or texts that show the cardholder received goods/services or\ndemonstrate cardholder satisfaction.\n\nUse when uploading evidence as a file." + }, + { + "name": "CARDHOLDER_INFORMATION", + "description": "Evidence that validates the customer's identity.\nExample evidence includes personally identifiable details such as name, email address, purchaser IP\naddress, and a copy of the cardholder ID.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "PURCHASE_ACKNOWLEDGEMENT", + "description": "Evidence that shows proof of the sale/transaction.\nExample evidence includes an invoice, contract, or other item showing the customer’s acknowledgement\nof the purchase and your terms.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "DUPLICATE_CHARGE_DOCUMENTATION", + "description": "Evidence that shows the charges in question are valid and distinct from one another.\nExample evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n\nUse when uploading evidence as a file." + }, + { + "name": "PRODUCT_OR_SERVICE_DESCRIPTION", + "description": "A description of the product or service sold.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "RECEIPT", + "description": "A receipt or message sent to the cardholder detailing the charge.\nNote: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "SERVICE_RECEIVED_DOCUMENTATION", + "description": "Evidence that the service was provided to the cardholder or the expected date that services will be rendered.\nExample evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "PROOF_OF_DELIVERY_DOCUMENTATION", + "description": "Evidence that shows the product was provided to the cardholder or the expected date of delivery.\nExample evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "RELATED_TRANSACTION_DOCUMENTATION", + "description": "Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\nNote: Square automatically provides up to five distinct Square receipts for related transactions, when available.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "REBUTTAL_EXPLANATION", + "description": "An explanation of why the cardholder’s claim is invalid.\nExample evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim\nfor credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder\nagreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n\nUse when uploading evidence as a file or string." + }, + { + "name": "TRACKING_NUMBER", + "description": "The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be\nsubmitted individually as separate pieces of evidence.\n\nUse when uploading evidence as a string." + } + ], + "description": "The type of the dispute evidence.", + "x-release-status": "PUBLIC" + }, + "DisputeReason": { + "type": "string", + "enum": [ + "AMOUNT_DIFFERS", + "CANCELLED", + "DUPLICATE", + "NO_KNOWLEDGE", + "NOT_AS_DESCRIBED", + "NOT_RECEIVED", + "PAID_BY_OTHER_MEANS", + "CUSTOMER_REQUESTS_CREDIT", + "EMV_LIABILITY_SHIFT" + ], + "x-enum-elements": [ + { + "name": "AMOUNT_DIFFERS", + "description": "The cardholder claims that they were charged the wrong amount for the purchase.\nTo challenge this dispute, provide specific and concrete evidence that the cardholder agreed\nto the amount charged." + }, + { + "name": "CANCELLED", + "description": "The cardholder claims that they attempted to return the goods or cancel the service.\nTo challenge this dispute, provide specific and concrete evidence to prove that the cardholder\nis not due a refund and that the cardholder acknowledged your cancellation policy." + }, + { + "name": "DUPLICATE", + "description": "The cardholder claims that they were charged twice for the same purchase.\nTo challenge this dispute, provide specific and concrete evidence that shows both charges are\nlegitimate and independent of one another." + }, + { + "name": "NO_KNOWLEDGE", + "description": "The cardholder claims that they did not make this purchase nor authorized the charge.\nTo challenge this dispute, provide specific and concrete evidence that proves that the cardholder\nidentity was verified at the time of purchase and that the purchase was authorized." + }, + { + "name": "NOT_AS_DESCRIBED", + "description": "The cardholder claims the product or service was provided, but the quality of the deliverable\ndid not align with the expectations of the cardholder based on the description.\nTo challenge this dispute, provide specific and concrete evidence that shows the cardholder is in\npossession of the product as described or received the service as described and agreed on." + }, + { + "name": "NOT_RECEIVED", + "description": "The cardholder claims the product or service was not received by the cardholder within the\nstated time frame.\nTo challenge this dispute, provide specific and concrete evidence to prove that the cardholder is\nin possession of or received the product or service sold." + }, + { + "name": "PAID_BY_OTHER_MEANS", + "description": "The cardholder claims that they previously paid for this purchase.\nTo challenge this dispute, provide specific and concrete evidence that shows both charges are\nlegitimate and independent of one another or proof that you already provided a credit for the charge." + }, + { + "name": "CUSTOMER_REQUESTS_CREDIT", + "description": "The cardholder claims that the purchase was canceled or returned, but they have not yet received\nthe credit.\nTo challenge this dispute, provide specific and concrete evidence to prove that the cardholder is not\ndue a refund and that they acknowledged your cancellation and/or refund policy." + }, + { + "name": "EMV_LIABILITY_SHIFT", + "description": "A chip-enabled card was not processed through a compliant chip-card reader (for example, it was swiped\ninstead of dipped into a chip-card reader).\nYou cannot challenge this dispute because the payment did not comply with EMV security requirements.\nFor more information, see [What Is EMV?](https://squareup.com/emv)" + } + ], + "description": "The list of possible reasons why a cardholder might initiate a\ndispute with their bank.", + "x-release-status": "PUBLIC" + }, + "DisputeState": { + "type": "string", + "enum": [ + "INQUIRY_EVIDENCE_REQUIRED", + "INQUIRY_PROCESSING", + "INQUIRY_CLOSED", + "EVIDENCE_REQUIRED", + "PROCESSING", + "WON", + "LOST", + "ACCEPTED" + ], + "x-enum-elements": [ + { + "name": "INQUIRY_EVIDENCE_REQUIRED", + "description": "The initial state of an inquiry with evidence required" + }, + { + "name": "INQUIRY_PROCESSING", + "description": "Inquiry evidence has been submitted and the bank is processing the inquiry" + }, + { + "name": "INQUIRY_CLOSED", + "description": "The inquiry is complete" + }, + { + "name": "EVIDENCE_REQUIRED", + "description": "The initial state of a dispute with evidence required" + }, + { + "name": "PROCESSING", + "description": "Dispute evidence has been submitted and the bank is processing the dispute" + }, + { + "name": "WON", + "description": "The bank has completed processing the dispute and the seller has won" + }, + { + "name": "LOST", + "description": "The bank has completed processing the dispute and the seller has lost" + }, + { + "name": "ACCEPTED", + "description": "The seller has accepted the dispute" + } + ], + "description": "The list of possible dispute states.", + "x-release-status": "PUBLIC" + }, + "DisputedPayment": { + "type": "object", + "description": "The payment the cardholder disputed.", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "Square-generated unique ID of the payment being disputed.", + "minLength": 1, + "maxLength": 192, + "nullable": true + } + } + }, + "EcomVisibility": { + "type": "string", + "enum": [ + "UNINDEXED", + "UNAVAILABLE", + "HIDDEN", + "VISIBLE" + ], + "x-enum-elements": [ + { + "name": "UNINDEXED", + "description": "Item is not synced with Ecom (Weebly). This is the default state" + }, + { + "name": "UNAVAILABLE", + "description": "Item is synced but is unavailable within Ecom (Weebly) and Online Checkout" + }, + { + "name": "HIDDEN", + "description": "Option for seller to choose manually created Quick Amounts." + }, + { + "name": "VISIBLE", + "description": "Item is synced but available within Ecom (Weebly) and Online Checkout but is hidden from Ecom Store." + } + ], + "description": "Determines item visibility in Ecom (Online Store) and Online Checkout.", + "x-release-status": "PUBLIC" + }, + "Employee": { + "type": "object", + "description": "An employee object that is used by the external API.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMember](entity:TeamMember).", + "x-release-status": "DEPRECATED", + "properties": { + "id": { + "type": "string", + "description": "UUID for this object." + }, + "first_name": { + "type": "string", + "description": "The employee's first name.", + "nullable": true + }, + "last_name": { + "type": "string", + "description": "The employee's last name.", + "nullable": true + }, + "email": { + "type": "string", + "description": "The employee's email address", + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The employee's phone number in E.164 format, i.e. \"+12125554250\"", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of location IDs where this employee has access to.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/EmployeeStatus", + "description": "Specifies the status of the employees being fetched.\nSee [EmployeeStatus](#type-employeestatus) for possible values", + "nullable": true + }, + "is_owner": { + "type": "boolean", + "description": "Whether this employee is the owner of the merchant. Each merchant\nhas one owner employee, and that employee has full authority over\nthe account.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format.", + "readOnly": true + } + } + }, + "EmployeeStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "Specifies that the employee is in the Active state." + }, + { + "name": "INACTIVE", + "description": "Specifies that the employee is in the Inactive state." + } + ], + "description": "The status of the Employee being retrieved.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](entity:TeamMemberStatus).", + "x-release-status": "DEPRECATED" + }, + "EmployeeWage": { + "type": "object", + "description": "The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](entity:TeamMemberWage).", + "x-release-status": "DEPRECATED", + "properties": { + "id": { + "type": "string", + "description": "The UUID for this object." + }, + "employee_id": { + "type": "string", + "description": "The `Employee` that this wage is assigned to.", + "nullable": true + }, + "title": { + "type": "string", + "description": "The job title that this wage relates to.", + "nullable": true + }, + "hourly_rate": { + "$ref": "#/components/schemas/Money", + "description": "Can be a custom-set hourly wage or the calculated effective hourly\nwage based on the annual wage and hours worked per week.", + "nullable": true + } + } + }, + "EnableEventsRequest": { + "type": "object", + "description": "Enables [Event](entity:Event)s for your application.", + "x-release-status": "BETA", + "properties": {} + }, + "EnableEventsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [EnableEvents](api-endpoint:Events-EnableEvents) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + } + }, + "example": {} + }, + "Error": { + "type": "object", + "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.", + "x-release-status": "PUBLIC", + "required": [ + "category", + "code" + ], + "properties": { + "category": { + "$ref": "#/components/schemas/ErrorCategory", + "description": "The high-level category for the error.\nSee [ErrorCategory](#type-errorcategory) for possible values" + }, + "code": { + "$ref": "#/components/schemas/ErrorCode", + "description": "The specific code of the error.\nSee [ErrorCode](#type-errorcode) for possible values" + }, + "detail": { + "type": "string", + "description": "A human-readable description of the error for debugging purposes." + }, + "field": { + "type": "string", + "description": "The name of the field provided in the original request (if any) that\nthe error pertains to." + } + } + }, + "ErrorCategory": { + "type": "string", + "enum": [ + "API_ERROR", + "AUTHENTICATION_ERROR", + "INVALID_REQUEST_ERROR", + "RATE_LIMIT_ERROR", + "PAYMENT_METHOD_ERROR", + "REFUND_ERROR", + "MERCHANT_SUBSCRIPTION_ERROR", + "EXTERNAL_VENDOR_ERROR" + ], + "x-enum-elements": [ + { + "name": "API_ERROR", + "description": "An error occurred with the Connect API itself." + }, + { + "name": "AUTHENTICATION_ERROR", + "description": "An authentication error occurred. Most commonly, the request had\na missing, malformed, or otherwise invalid `Authorization` header." + }, + { + "name": "INVALID_REQUEST_ERROR", + "description": "The request was invalid. Most commonly, a required parameter was\nmissing, or a provided parameter had an invalid value." + }, + { + "name": "RATE_LIMIT_ERROR", + "description": "Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests\nto Square APIs in a short period of time.\n\nYour application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)\nschedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule." + }, + { + "name": "PAYMENT_METHOD_ERROR", + "description": "An error occurred while processing a payment method. Most commonly,\nthe details of the payment method were invalid (such as a card's CVV\nor expiration date)." + }, + { + "name": "REFUND_ERROR", + "description": "An error occurred while attempting to process a refund." + }, + { + "name": "MERCHANT_SUBSCRIPTION_ERROR", + "description": "An error occurred when checking a merchant subscription status" + }, + { + "name": "EXTERNAL_VENDOR_ERROR", + "description": "An error that is returned from an external vendor's API" + } + ], + "description": "Indicates which high-level category of error has occurred during a\nrequest to the Connect API.", + "x-release-status": "PUBLIC" + }, + "ErrorCode": { + "type": "string", + "enum": [ + "INTERNAL_SERVER_ERROR", + "UNAUTHORIZED", + "ACCESS_TOKEN_EXPIRED", + "ACCESS_TOKEN_REVOKED", + "CLIENT_DISABLED", + "FORBIDDEN", + "INSUFFICIENT_SCOPES", + "APPLICATION_DISABLED", + "V1_APPLICATION", + "V1_ACCESS_TOKEN", + "CARD_PROCESSING_NOT_ENABLED", + "MERCHANT_SUBSCRIPTION_NOT_FOUND", + "BAD_REQUEST", + "MISSING_REQUIRED_PARAMETER", + "INCORRECT_TYPE", + "INVALID_TIME", + "INVALID_TIME_RANGE", + "INVALID_VALUE", + "INVALID_CURSOR", + "UNKNOWN_QUERY_PARAMETER", + "CONFLICTING_PARAMETERS", + "EXPECTED_JSON_BODY", + "INVALID_SORT_ORDER", + "VALUE_REGEX_MISMATCH", + "VALUE_TOO_SHORT", + "VALUE_TOO_LONG", + "VALUE_TOO_LOW", + "VALUE_TOO_HIGH", + "VALUE_EMPTY", + "ARRAY_LENGTH_TOO_LONG", + "ARRAY_LENGTH_TOO_SHORT", + "ARRAY_EMPTY", + "EXPECTED_BOOLEAN", + "EXPECTED_INTEGER", + "EXPECTED_FLOAT", + "EXPECTED_STRING", + "EXPECTED_OBJECT", + "EXPECTED_ARRAY", + "EXPECTED_MAP", + "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "INVALID_ARRAY_VALUE", + "INVALID_ENUM_VALUE", + "INVALID_CONTENT_TYPE", + "INVALID_FORM_VALUE", + "CUSTOMER_NOT_FOUND", + "ONE_INSTRUMENT_EXPECTED", + "NO_FIELDS_SET", + "TOO_MANY_MAP_ENTRIES", + "MAP_KEY_LENGTH_TOO_SHORT", + "MAP_KEY_LENGTH_TOO_LONG", + "CUSTOMER_MISSING_NAME", + "CUSTOMER_MISSING_EMAIL", + "INVALID_PAUSE_LENGTH", + "INVALID_DATE", + "UNSUPPORTED_COUNTRY", + "UNSUPPORTED_CURRENCY", + "APPLE_TTP_PIN_TOKEN", + "CARD_EXPIRED", + "INVALID_EXPIRATION", + "INVALID_EXPIRATION_YEAR", + "INVALID_EXPIRATION_DATE", + "UNSUPPORTED_CARD_BRAND", + "UNSUPPORTED_ENTRY_METHOD", + "INVALID_ENCRYPTED_CARD", + "INVALID_CARD", + "PAYMENT_AMOUNT_MISMATCH", + "GENERIC_DECLINE", + "CVV_FAILURE", + "ADDRESS_VERIFICATION_FAILURE", + "INVALID_ACCOUNT", + "CURRENCY_MISMATCH", + "INSUFFICIENT_FUNDS", + "INSUFFICIENT_PERMISSIONS", + "CARDHOLDER_INSUFFICIENT_PERMISSIONS", + "INVALID_LOCATION", + "TRANSACTION_LIMIT", + "VOICE_FAILURE", + "PAN_FAILURE", + "EXPIRATION_FAILURE", + "CARD_NOT_SUPPORTED", + "READER_DECLINED", + "INVALID_PIN", + "MISSING_PIN", + "MISSING_ACCOUNT_TYPE", + "INVALID_POSTAL_CODE", + "INVALID_FEES", + "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "PAYMENT_LIMIT_EXCEEDED", + "GIFT_CARD_AVAILABLE_AMOUNT", + "ACCOUNT_UNUSABLE", + "BUYER_REFUSED_PAYMENT", + "DELAYED_TRANSACTION_EXPIRED", + "DELAYED_TRANSACTION_CANCELED", + "DELAYED_TRANSACTION_CAPTURED", + "DELAYED_TRANSACTION_FAILED", + "CARD_TOKEN_EXPIRED", + "CARD_TOKEN_USED", + "AMOUNT_TOO_HIGH", + "UNSUPPORTED_INSTRUMENT_TYPE", + "REFUND_AMOUNT_INVALID", + "REFUND_ALREADY_PENDING", + "PAYMENT_NOT_REFUNDABLE", + "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", + "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", + "REFUND_DECLINED", + "INSUFFICIENT_PERMISSIONS_FOR_REFUND", + "INVALID_CARD_DATA", + "SOURCE_USED", + "SOURCE_EXPIRED", + "UNSUPPORTED_LOYALTY_REWARD_TIER", + "LOCATION_MISMATCH", + "ORDER_UNPAID_NOT_RETURNABLE", + "IDEMPOTENCY_KEY_REUSED", + "UNEXPECTED_VALUE", + "SANDBOX_NOT_SUPPORTED", + "INVALID_EMAIL_ADDRESS", + "INVALID_PHONE_NUMBER", + "CHECKOUT_EXPIRED", + "BAD_CERTIFICATE", + "INVALID_SQUARE_VERSION_FORMAT", + "API_VERSION_INCOMPATIBLE", + "CARD_PRESENCE_REQUIRED", + "UNSUPPORTED_SOURCE_TYPE", + "CARD_MISMATCH", + "PLAID_ERROR", + "PLAID_ERROR_ITEM_LOGIN_REQUIRED", + "PLAID_ERROR_RATE_LIMIT", + "CARD_DECLINED", + "VERIFY_CVV_FAILURE", + "VERIFY_AVS_FAILURE", + "CARD_DECLINED_CALL_ISSUER", + "CARD_DECLINED_VERIFICATION_REQUIRED", + "BAD_EXPIRATION", + "CHIP_INSERTION_REQUIRED", + "ALLOWABLE_PIN_TRIES_EXCEEDED", + "RESERVATION_DECLINED", + "UNKNOWN_BODY_PARAMETER", + "NOT_FOUND", + "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", + "METHOD_NOT_ALLOWED", + "NOT_ACCEPTABLE", + "REQUEST_TIMEOUT", + "CONFLICT", + "GONE", + "REQUEST_ENTITY_TOO_LARGE", + "UNSUPPORTED_MEDIA_TYPE", + "UNPROCESSABLE_ENTITY", + "RATE_LIMITED", + "NOT_IMPLEMENTED", + "BAD_GATEWAY", + "SERVICE_UNAVAILABLE", + "TEMPORARY_ERROR", + "GATEWAY_TIMEOUT" + ], + "x-enum-elements": [ + { + "name": "INTERNAL_SERVER_ERROR", + "description": "A general server error occurred.", + "error-category": "API_ERROR" + }, + { + "name": "UNAUTHORIZED", + "description": "A general authorization error occurred.", + "error-category": "AUTHENTICATION_ERROR" + }, + { + "name": "ACCESS_TOKEN_EXPIRED", + "description": "The provided access token has expired.", + "error-category": "AUTHENTICATION_ERROR" + }, + { + "name": "ACCESS_TOKEN_REVOKED", + "description": "The provided access token has been revoked.", + "error-category": "AUTHENTICATION_ERROR" + }, + { + "name": "CLIENT_DISABLED", + "description": "The provided client has been disabled.", + "error-category": "AUTHENTICATION_ERROR" + }, + { + "name": "FORBIDDEN", + "description": "A general access error occurred.", + "error-category": "AUTHENTICATION_ERROR" + }, + { + "name": "INSUFFICIENT_SCOPES", + "description": "The provided access token does not have permission\nto execute the requested action.", + "error-category": "AUTHENTICATION_ERROR" + }, + { + "name": "APPLICATION_DISABLED", + "description": "The calling application was disabled.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "V1_APPLICATION", + "description": "The calling application was created prior to\n2016-03-30 and is not compatible with v2 Square API calls.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "V1_ACCESS_TOKEN", + "description": "The calling application is using an access token\ncreated prior to 2016-03-30 and is not compatible with v2 Square API\ncalls.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CARD_PROCESSING_NOT_ENABLED", + "description": "The location provided in the API call is not\nenabled for credit card processing.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "MERCHANT_SUBSCRIPTION_NOT_FOUND", + "description": "A required subscription was not found for the merchant", + "error-category": "MERCHANT_SUBSCRIPTION_ERROR" + }, + { + "name": "BAD_REQUEST", + "description": "A general error occurred with the request.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "MISSING_REQUIRED_PARAMETER", + "description": "The request is missing a required path, query, or\nbody parameter.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INCORRECT_TYPE", + "description": "The value provided in the request is the wrong\ntype. For example, a string instead of an integer.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_TIME", + "description": "Formatting for the provided time value is\nincorrect.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_TIME_RANGE", + "description": "The time range provided in the request is invalid.\nFor example, the end time is before the start time.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_VALUE", + "description": "The provided value is invalid. For example,\nincluding `%` in a phone number.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_CURSOR", + "description": "The pagination cursor included in the request is\ninvalid.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNKNOWN_QUERY_PARAMETER", + "description": "The query parameters provided is invalid for the\nrequested endpoint.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CONFLICTING_PARAMETERS", + "description": "One or more of the request parameters conflict with\neach other.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_JSON_BODY", + "description": "The request body is not a JSON object.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_SORT_ORDER", + "description": "The provided sort order is not a valid key.\nCurrently, sort order must be `ASC` or `DESC`.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "VALUE_REGEX_MISMATCH", + "description": "The provided value does not match an expected\nregular expression.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "VALUE_TOO_SHORT", + "description": "The provided string value is shorter than the\nminimum length allowed.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "VALUE_TOO_LONG", + "description": "The provided string value is longer than the\nmaximum length allowed.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "VALUE_TOO_LOW", + "description": "The provided value is less than the supported\nminimum.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "VALUE_TOO_HIGH", + "description": "The provided value is greater than the supported\nmaximum.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "VALUE_EMPTY", + "description": "The provided value has a default (empty) value\nsuch as a blank string.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "ARRAY_LENGTH_TOO_LONG", + "description": "The provided array has too many elements.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "ARRAY_LENGTH_TOO_SHORT", + "description": "The provided array has too few elements.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "ARRAY_EMPTY", + "description": "The provided array is empty.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_BOOLEAN", + "description": "The endpoint expected the provided value to be a\nboolean.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_INTEGER", + "description": "The endpoint expected the provided value to be an\ninteger.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_FLOAT", + "description": "The endpoint expected the provided value to be a\nfloat.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_STRING", + "description": "The endpoint expected the provided value to be a\nstring.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_OBJECT", + "description": "The endpoint expected the provided value to be a\nJSON object.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_ARRAY", + "description": "The endpoint expected the provided value to be an\narray or list.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_MAP", + "description": "The endpoint expected the provided value to be a\nmap or associative array.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "description": "The endpoint expected the provided value to be an\narray encoded in base64.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_ARRAY_VALUE", + "description": "One or more objects in the array does not match the\narray type.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_ENUM_VALUE", + "description": "The provided static string is not valid for the\nfield.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_CONTENT_TYPE", + "description": "Invalid content type header.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_FORM_VALUE", + "description": "Only relevant for applications created prior to\n2016-03-30. Indicates there was an error while parsing form values.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CUSTOMER_NOT_FOUND", + "description": "The provided customer id can't be found in the merchant's customers list.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "ONE_INSTRUMENT_EXPECTED", + "description": "A general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "NO_FIELDS_SET", + "description": "A general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "TOO_MANY_MAP_ENTRIES", + "description": "Too many entries in the map field.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "MAP_KEY_LENGTH_TOO_SHORT", + "description": "The length of one of the provided keys in the map is too short.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "MAP_KEY_LENGTH_TOO_LONG", + "description": "The length of one of the provided keys in the map is too long.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CUSTOMER_MISSING_NAME", + "description": "The provided customer does not have a recorded name.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CUSTOMER_MISSING_EMAIL", + "description": "The provided customer does not have a recorded email.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_PAUSE_LENGTH", + "description": "The subscription cannot be paused longer than the duration of the current phase.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_DATE", + "description": "The subscription cannot be paused/resumed on the given date.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_COUNTRY", + "description": "The API request references an unsupported country.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_CURRENCY", + "description": "The API request references an unsupported currency.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "APPLE_TTP_PIN_TOKEN", + "description": "The payment was declined by the card issuer during an Apple Tap to Pay (TTP)\ntransaction with a request for the card's PIN. This code will be returned alongside\n`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an\nissuer-provided token in the `details` field that is needed to initiate the PIN\ncollection flow on the iOS device.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CARD_EXPIRED", + "description": "The card issuer declined the request because the card is expired.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_EXPIRATION", + "description": "The expiration date for the payment card is invalid. For example,\nit indicates a date in the past.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_EXPIRATION_YEAR", + "description": "The expiration year for the payment card is invalid. For example,\nit indicates a year in the past or contains invalid characters.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_EXPIRATION_DATE", + "description": "The expiration date for the payment card is invalid. For example,\nit contains invalid characters.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_CARD_BRAND", + "description": "The credit card provided is not from a supported issuer.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "UNSUPPORTED_ENTRY_METHOD", + "description": "The entry method for the credit card (swipe, dip, tap) is not supported.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_ENCRYPTED_CARD", + "description": "The encrypted card information is invalid.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_CARD", + "description": "The credit card cannot be validated based on the provided details.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "PAYMENT_AMOUNT_MISMATCH", + "description": "The payment was declined because there was a payment amount mismatch.\nThe money amount Square was expecting does not match the amount provided.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "GENERIC_DECLINE", + "description": "Square received a decline without any additional information.\nIf the payment information seems correct, the buyer can contact their\nissuer to ask for more information.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CVV_FAILURE", + "description": "The card issuer declined the request because the CVV value is invalid.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "ADDRESS_VERIFICATION_FAILURE", + "description": "The card issuer declined the request because the postal code is invalid.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_ACCOUNT", + "description": "The issuer was not able to locate the account on record.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CURRENCY_MISMATCH", + "description": "The currency associated with the payment is not valid for the provided\nfunding source. For example, a gift card funded in USD cannot be used to process\npayments in GBP.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INSUFFICIENT_FUNDS", + "description": "The funding source has insufficient funds to cover the payment.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INSUFFICIENT_PERMISSIONS", + "description": "The Square account does not have the permissions to accept\nthis payment. For example, Square may limit which merchants are\nallowed to receive gift card payments.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CARDHOLDER_INSUFFICIENT_PERMISSIONS", + "description": "The card issuer has declined the transaction due to restrictions on where the card can be used.\nFor example, a gift card is limited to a single merchant.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_LOCATION", + "description": "The Square account cannot take payments in the specified region.\nA Square account can take payments only from the region where the account was created.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "TRANSACTION_LIMIT", + "description": "The card issuer has determined the payment amount is either too high or too low.\nThe API returns the error code mostly for credit cards (for example, the card reached\nthe credit limit). However, sometimes the issuer bank can indicate the error for debit\nor prepaid cards (for example, card has insufficient funds).", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "VOICE_FAILURE", + "description": "The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "PAN_FAILURE", + "description": "The specified card number is invalid. For example, it is of\nincorrect length or is incorrectly formatted.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "EXPIRATION_FAILURE", + "description": "The card expiration date is either invalid or indicates that the\ncard is expired.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CARD_NOT_SUPPORTED", + "description": "The card is not supported either in the geographic region or by\nthe [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC).", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "READER_DECLINED", + "description": "The Square Card Reader declined the payment for an unknown reason.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_PIN", + "description": "The card issuer declined the request because the PIN is invalid.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "MISSING_PIN", + "description": "The payment is missing a required PIN.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "MISSING_ACCOUNT_TYPE", + "description": "The payment is missing a required ACCOUNT_TYPE parameter.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_POSTAL_CODE", + "description": "The postal code is incorrectly formatted.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "INVALID_FEES", + "description": "The app_fee_money on a payment is too high.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "description": "The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "PAYMENT_LIMIT_EXCEEDED", + "description": "Square declined the request because the payment amount exceeded the processing limit for this merchant.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "GIFT_CARD_AVAILABLE_AMOUNT", + "description": "When a Gift Card is a payment source, you can allow taking a partial payment\nby adding the `accept_partial_authorization` parameter in the request.\nHowever, taking such a partial payment does not work if your request also includes\n`tip_money`, `app_fee_money`, or both. Square declines such payments and returns\nthe `GIFT_CARD_AVAILABLE_AMOUNT` error.\nFor more information, see\n[CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information).", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "ACCOUNT_UNUSABLE", + "description": "The account provided cannot carry out transactions.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "BUYER_REFUSED_PAYMENT", + "description": "Bank account rejected or was not authorized for the payment.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "DELAYED_TRANSACTION_EXPIRED", + "description": "The application tried to update a delayed-capture payment that has expired.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "DELAYED_TRANSACTION_CANCELED", + "description": "The application tried to cancel a delayed-capture payment that was already cancelled.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "DELAYED_TRANSACTION_CAPTURED", + "description": "The application tried to capture a delayed-capture payment that was already captured.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "DELAYED_TRANSACTION_FAILED", + "description": "The application tried to update a delayed-capture payment that failed.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CARD_TOKEN_EXPIRED", + "description": "The provided card token (nonce) has expired.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CARD_TOKEN_USED", + "description": "The provided card token (nonce) was already used to process the payment or refund.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "AMOUNT_TOO_HIGH", + "description": "The requested payment amount is too high for the provided payment source.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_INSTRUMENT_TYPE", + "description": "The API request references an unsupported instrument type.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "REFUND_AMOUNT_INVALID", + "description": "The requested refund amount exceeds the amount available to refund.", + "error-category": "REFUND_ERROR" + }, + { + "name": "REFUND_ALREADY_PENDING", + "description": "The payment already has a pending refund.", + "error-category": "REFUND_ERROR" + }, + { + "name": "PAYMENT_NOT_REFUNDABLE", + "description": "The payment is not refundable. For example, the payment is too old to be refunded.", + "error-category": "REFUND_ERROR" + }, + { + "name": "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", + "description": "The payment is not refundable because it has been disputed.", + "error-category": "REFUND_ERROR" + }, + { + "name": "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", + "description": "The payment is not refundable because the payment is approved and needs to be completed first before the refund is issued.", + "error-category": "REFUND_ERROR" + }, + { + "name": "REFUND_DECLINED", + "description": "Request failed - The card issuer declined the refund.", + "error-category": "REFUND_ERROR" + }, + { + "name": "INSUFFICIENT_PERMISSIONS_FOR_REFUND", + "description": "The Square account does not have the permissions to process this refund.", + "error-category": "REFUND_ERROR" + }, + { + "name": "INVALID_CARD_DATA", + "description": "Generic error - the provided card data is invalid.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "SOURCE_USED", + "description": "The provided source id was already used to create a card.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "SOURCE_EXPIRED", + "description": "The provided source id has expired.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_LOYALTY_REWARD_TIER", + "description": "The referenced loyalty program reward tier is not supported.\nThis could happen if the reward tier created in a first party\napplication is incompatible with the Loyalty API.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "LOCATION_MISMATCH", + "description": "Generic error - the given location does not matching what is expected.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "ORDER_UNPAID_NOT_RETURNABLE", + "description": "The order attempting to be returned is not yet paid and cannot be returned.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "IDEMPOTENCY_KEY_REUSED", + "description": "The provided idempotency key has already been used.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNEXPECTED_VALUE", + "description": "General error - the value provided was unexpected.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "SANDBOX_NOT_SUPPORTED", + "description": "The API request is not supported in sandbox.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_EMAIL_ADDRESS", + "description": "The provided email address is invalid.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_PHONE_NUMBER", + "description": "The provided phone number is invalid.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CHECKOUT_EXPIRED", + "description": "The provided checkout URL has expired.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "BAD_CERTIFICATE", + "description": "Bad certificate.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "INVALID_SQUARE_VERSION_FORMAT", + "description": "The provided Square-Version is incorrectly formatted.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "API_VERSION_INCOMPATIBLE", + "description": "The provided Square-Version is incompatible with the requested action.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CARD_PRESENCE_REQUIRED", + "description": "The transaction requires that a card be present.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_SOURCE_TYPE", + "description": "The API request references an unsupported source type.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CARD_MISMATCH", + "description": "The provided card does not match what is expected.", + "error-category": "REFUND_ERROR" + }, + { + "name": "PLAID_ERROR", + "description": "Generic plaid error", + "error-category": "EXTERNAL_VENDOR_ERROR" + }, + { + "name": "PLAID_ERROR_ITEM_LOGIN_REQUIRED", + "description": "Plaid error - ITEM_LOGIN_REQUIRED", + "error-category": "EXTERNAL_VENDOR_ERROR" + }, + { + "name": "PLAID_ERROR_RATE_LIMIT", + "description": "Plaid error - RATE_LIMIT", + "error-category": "EXTERNAL_VENDOR_ERROR" + }, + { + "name": "CARD_DECLINED", + "description": "The card was declined.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "VERIFY_CVV_FAILURE", + "description": "The CVV could not be verified.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "VERIFY_AVS_FAILURE", + "description": "The AVS could not be verified.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CARD_DECLINED_CALL_ISSUER", + "description": "The payment card was declined with a request\nfor the card holder to call the issuer.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CARD_DECLINED_VERIFICATION_REQUIRED", + "description": "The payment card was declined with a request\nfor additional verification.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "BAD_EXPIRATION", + "description": "The card expiration date is either missing or\nincorrectly formatted.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "CHIP_INSERTION_REQUIRED", + "description": "The card issuer requires that the card be read\nusing a chip reader.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "ALLOWABLE_PIN_TRIES_EXCEEDED", + "description": "The card has exhausted its available pin entry\nretries set by the card issuer. Resolving the error typically requires the\ncard holder to contact the card issuer.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "RESERVATION_DECLINED", + "description": "The card issuer declined the refund.", + "error-category": "REFUND_ERROR" + }, + { + "name": "UNKNOWN_BODY_PARAMETER", + "description": "The body parameter is not recognized by the requested endpoint.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "NOT_FOUND", + "description": "Not Found - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", + "description": "Square could not find the associated Apple Pay certificate.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "METHOD_NOT_ALLOWED", + "description": "Method Not Allowed - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "NOT_ACCEPTABLE", + "description": "Not Acceptable - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "REQUEST_TIMEOUT", + "description": "Request Timeout - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "CONFLICT", + "description": "Conflict - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "GONE", + "description": "The target resource is no longer available and this\ncondition is likely to be permanent.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "REQUEST_ENTITY_TOO_LARGE", + "description": "Request Entity Too Large - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNSUPPORTED_MEDIA_TYPE", + "description": "Unsupported Media Type - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "UNPROCESSABLE_ENTITY", + "description": "Unprocessable Entity - a general error occurred.", + "error-category": "INVALID_REQUEST_ERROR" + }, + { + "name": "RATE_LIMITED", + "description": "Rate Limited - a general error occurred.", + "error-category": "RATE_LIMIT_ERROR" + }, + { + "name": "NOT_IMPLEMENTED", + "description": "Not Implemented - a general error occurred.", + "error-category": "API_ERROR" + }, + { + "name": "BAD_GATEWAY", + "description": "Bad Gateway - a general error occurred.", + "error-category": "API_ERROR" + }, + { + "name": "SERVICE_UNAVAILABLE", + "description": "Service Unavailable - a general error occurred.", + "error-category": "API_ERROR" + }, + { + "name": "TEMPORARY_ERROR", + "description": "A temporary internal error occurred. You can safely retry your call\nusing the same idempotency key.", + "error-category": "PAYMENT_METHOD_ERROR" + }, + { + "name": "GATEWAY_TIMEOUT", + "description": "Gateway Timeout - a general error occurred.", + "error-category": "API_ERROR" + } + ], + "description": "Indicates the specific error that occurred during a request to a\nSquare API.", + "x-release-status": "PUBLIC" + }, + "Event": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "merchant_id": { + "type": "string", + "description": "The ID of the target merchant associated with the event.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the target location associated with the event.", + "nullable": true + }, + "type": { + "type": "string", + "description": "The type of event this represents.", + "nullable": true + }, + "event_id": { + "type": "string", + "description": "A unique ID for the event.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "Timestamp of when the event was created, in RFC 3339 format.", + "readOnly": true + }, + "data": { + "$ref": "#/components/schemas/EventData", + "description": "The data associated with the event.", + "nullable": true + } + } + }, + "EventData": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "type": { + "type": "string", + "description": "The name of the affected object’s type.", + "nullable": true + }, + "id": { + "type": "string", + "description": "The ID of the affected object." + }, + "deleted": { + "type": "boolean", + "description": "This is true if the affected object has been deleted; otherwise, it's absent.", + "nullable": true + }, + "object": { + "type": "object", + "description": "An object containing fields and values relevant to the event. It is absent if the affected object has been deleted.", + "nullable": true + } + } + }, + "EventMetadata": { + "type": "object", + "description": "Contains metadata about a particular [Event](entity:Event).", + "x-release-status": "BETA", + "properties": { + "event_id": { + "type": "string", + "description": "A unique ID for the event.", + "nullable": true + }, + "api_version": { + "type": "string", + "description": "The API version of the event. This corresponds to the default API version of the developer application at the time when the event was created.", + "nullable": true + } + } + }, + "EventTypeMetadata": { + "type": "object", + "description": "Contains the metadata of a webhook event type.", + "x-release-status": "PUBLIC", + "properties": { + "event_type": { + "type": "string", + "description": "The event type.", + "readOnly": true + }, + "api_version_introduced": { + "type": "string", + "description": "The API version at which the event type was introduced.", + "readOnly": true + }, + "release_status": { + "type": "string", + "description": "The release status of the event type.", + "readOnly": true + } + } + }, + "ExcludeStrategy": { + "type": "string", + "enum": [ + "LEAST_EXPENSIVE", + "MOST_EXPENSIVE" + ], + "x-enum-elements": [ + { + "name": "LEAST_EXPENSIVE", + "description": "The least expensive matched products are excluded from the pricing. If\nthe pricing rule is set to exclude one product and multiple products in the\nmatch set qualify as least expensive, then one will be excluded at random.\n\nExcluding the least expensive product gives the best discount value to the buyer." + }, + { + "name": "MOST_EXPENSIVE", + "description": "The most expensive matched product is excluded from the pricing rule.\nIf multiple products have the same price and all qualify as least expensive,\none will be excluded at random.\n\nThis guarantees that the most expensive product is purchased at full price." + } + ], + "description": "Indicates which products matched by a CatalogPricingRule\nwill be excluded if the pricing rule uses an exclude set.", + "x-release-status": "BETA" + }, + "ExternalPaymentDetails": { + "type": "object", + "description": "Stores details about an external payment. Contains only non-confidential information.\nFor more information, see \n[Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments).", + "x-release-status": "PUBLIC", + "required": [ + "type", + "source" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of external payment the seller received. It can be one of the following:\n- CHECK - Paid using a physical check.\n- BANK_TRANSFER - Paid using external bank transfer.\n- OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card.\n- CRYPTO - Paid using a crypto currency.\n- SQUARE_CASH - Paid using Square Cash App.\n- SOCIAL - Paid using peer-to-peer payment applications.\n- EXTERNAL - A third-party application gathered this payment outside of Square.\n- EMONEY - Paid using an E-money provider.\n- CARD - A credit or debit card that Square does not support.\n- STORED_BALANCE - Use for house accounts, store credit, and so forth.\n- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals\n- OTHER - A type not listed here.", + "maxLength": 50 + }, + "source": { + "type": "string", + "description": "A description of the external payment source. For example, \n\"Food Delivery Service\".", + "maxLength": 255 + }, + "source_id": { + "type": "string", + "description": "An ID to associate the payment to its originating source.", + "maxLength": 255, + "nullable": true + }, + "source_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The fees paid to the source. The `amount_money` minus this field is \nthe net amount seller receives.", + "nullable": true + } + } + }, + "FilterValue": { + "type": "object", + "description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field.", + "x-release-status": "BETA", + "properties": { + "all": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of terms that must be present on the field of the resource.", + "nullable": true + }, + "any": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of terms where at least one of them must be present on the\nfield of the resource.", + "nullable": true + }, + "none": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of terms that must not be present on the field the resource", + "nullable": true + } + } + }, + "FloatNumberRange": { + "type": "object", + "description": "Specifies a decimal number range.", + "x-release-status": "PUBLIC", + "properties": { + "start_at": { + "type": "string", + "description": "A decimal value indicating where the range starts.", + "nullable": true + }, + "end_at": { + "type": "string", + "description": "A decimal value indicating where the range ends.", + "nullable": true + } + } + }, + "Fulfillment": { + "type": "object", + "description": "Contains details about how to fulfill this order.\nOrders can only be created with at most one fulfillment using the API.\nHowever, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the fulfillment only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/FulfillmentType", + "description": "The type of the fulfillment.\nSee [FulfillmentType](#type-fulfillmenttype) for possible values", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/FulfillmentState", + "description": "The state of the fulfillment.\nSee [FulfillmentState](#type-fulfillmentstate) for possible values", + "nullable": true + }, + "line_item_application": { + "$ref": "#/components/schemas/FulfillmentFulfillmentLineItemApplication", + "description": "Describes what order line items this fulfillment applies to.\nIt can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.\nSee [FulfillmentFulfillmentLineItemApplication](#type-fulfillmentfulfillmentlineitemapplication) for possible values", + "readOnly": true, + "x-release-status": "BETA" + }, + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FulfillmentFulfillmentEntry" + }, + "description": "A list of entries pertaining to the fulfillment of an order. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.\n\nMultiple entries can reference the same line item `uid`, as long as the total quantity among\nall fulfillment entries referencing a single line item does not exceed the quantity of the\norder's line item itself.\n\nAn order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,\n`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently\nbefore order completion.", + "readOnly": true, + "x-release-status": "BETA" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "pickup_details": { + "$ref": "#/components/schemas/FulfillmentPickupDetails", + "description": "Contains details for a pickup fulfillment. These details are required when the fulfillment\ntype is `PICKUP`.", + "nullable": true + }, + "shipment_details": { + "$ref": "#/components/schemas/FulfillmentShipmentDetails", + "description": "Contains details for a shipment fulfillment. These details are required when the fulfillment type\nis `SHIPMENT`.\n\nA shipment fulfillment's relationship to fulfillment `state`:\n`PROPOSED`: A shipment is requested.\n`RESERVED`: Fulfillment in progress. Shipment processing.\n`PREPARED`: Shipment packaged. Shipping label created.\n`COMPLETED`: Package has been shipped.\n`CANCELED`: Shipment has been canceled.\n`FAILED`: Shipment has failed.", + "x-release-status": "BETA", + "nullable": true + }, + "delivery_details": { + "$ref": "#/components/schemas/FulfillmentDeliveryDetails", + "description": "Describes delivery details of an order fulfillment.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "FulfillmentDeliveryDetails": { + "type": "object", + "description": "Describes delivery details of an order fulfillment.", + "x-release-status": "BETA", + "properties": { + "recipient": { + "$ref": "#/components/schemas/FulfillmentRecipient", + "description": "The contact information for the person to receive the fulfillment.", + "nullable": true + }, + "schedule_type": { + "$ref": "#/components/schemas/FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType", + "description": "Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then\n`deliver_at` is required. If `ASAP`, then `prep_time_duration` is required. The default is `SCHEDULED`.\nSee [OrderFulfillmentDeliveryDetailsScheduleType](#type-orderfulfillmentdeliverydetailsscheduletype) for possible values", + "nullable": true + }, + "placed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").\n\nMust be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".", + "readOnly": true + }, + "deliver_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the delivery period.\nWhen the fulfillment `schedule_type` is `ASAP`, the field is automatically\nset to the current time plus the `prep_time_duration`.\nOtherwise, the application can set this field while the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the\nterminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "prep_time_duration": { + "type": "string", + "description": "The duration of time it takes to prepare and deliver this fulfillment.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "delivery_window_duration": { + "type": "string", + "description": "The time period after `deliver_at` in which to deliver the order.\nApplications can set this field when the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state\nsuch as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "note": { + "type": "string", + "description": "Provides additional instructions about the delivery fulfillment.\nIt is displayed in the Square Point of Sale application and set by the API.", + "maxLength": 550, + "nullable": true + }, + "completed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller completed the fulfillment.\nThis field is automatically set when fulfillment `state` changes to `COMPLETED`.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "in_progress_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller started processing the fulfillment.\nThis field is automatically set when the fulfillment `state` changes to `RESERVED`.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "rejected_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. This field is\nautomatically set when the fulfillment `state` changes to `FAILED`.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "ready_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the seller marked the fulfillment as ready for\ncourier pickup. This field is automatically set when the fulfillment `state` changes\nto PREPARED.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "delivered_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was delivered to the recipient.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. This field is automatically\nset when the fulfillment `state` changes to `CANCELED`.\n\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "cancel_reason": { + "type": "string", + "description": "The delivery cancellation reason. Max length: 100 characters.", + "maxLength": 100, + "nullable": true + }, + "courier_pickup_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when an order can be picked up by the courier for delivery.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "courier_pickup_window_duration": { + "type": "string", + "description": "The time period after `courier_pickup_at` in which the courier should pick up the order.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "is_no_contact_delivery": { + "type": "boolean", + "description": "Whether the delivery is preferred to be no contact.", + "nullable": true + }, + "dropoff_notes": { + "type": "string", + "description": "A note to provide additional instructions about how to deliver the order.", + "maxLength": 550, + "nullable": true + }, + "courier_provider_name": { + "type": "string", + "description": "The name of the courier provider.", + "maxLength": 255, + "nullable": true + }, + "courier_support_phone_number": { + "type": "string", + "description": "The support phone number of the courier.", + "maxLength": 17, + "nullable": true + }, + "square_delivery_id": { + "type": "string", + "description": "The identifier for the delivery created by Square.", + "maxLength": 50, + "nullable": true + }, + "external_delivery_id": { + "type": "string", + "description": "The identifier for the delivery created by the third-party courier service.", + "maxLength": 50, + "nullable": true + }, + "managed_delivery": { + "type": "boolean", + "description": "The flag to indicate the delivery is managed by a third party (ie DoorDash), which means\nwe may not receive all recipient information for PII purposes.", + "nullable": true + } + } + }, + "FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType": { + "type": "string", + "enum": [ + "SCHEDULED", + "ASAP" + ], + "x-enum-elements": [ + { + "name": "SCHEDULED", + "description": "Indicates the fulfillment to deliver at a scheduled deliver time." + }, + { + "name": "ASAP", + "description": "Indicates that the fulfillment to deliver as soon as possible and should be prepared\nimmediately." + } + ], + "description": "The schedule type of the delivery fulfillment.", + "x-release-status": "BETA" + }, + "FulfillmentFulfillmentEntry": { + "type": "object", + "description": "Links an order line item to a fulfillment. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.", + "x-release-status": "BETA", + "required": [ + "line_item_uid", + "quantity" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the fulfillment entry only within this order.", + "maxLength": 60, + "nullable": true + }, + "line_item_uid": { + "type": "string", + "description": "The `uid` from the order line item.", + "minLength": 1 + }, + "quantity": { + "type": "string", + "description": "The quantity of the line item being fulfilled, formatted as a decimal number.\nFor example, `\"3\"`.\n\nFulfillments for line items with a `quantity_unit` can have non-integer quantities.\nFor example, `\"1.70000\"`.", + "minLength": 1, + "maxLength": 12 + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this fulfillment entry. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "nullable": true + } + } + }, + "FulfillmentFulfillmentLineItemApplication": { + "type": "string", + "enum": [ + "ALL", + "ENTRY_LIST" + ], + "x-enum-elements": [ + { + "name": "ALL", + "description": "If `ALL`, `entries` must be unset." + }, + { + "name": "ENTRY_LIST", + "description": "If `ENTRY_LIST`, supply a list of `entries`." + } + ], + "description": "The `line_item_application` describes what order line items this fulfillment applies\nto. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.", + "x-release-status": "BETA" + }, + "FulfillmentPickupDetails": { + "type": "object", + "description": "Contains details necessary to fulfill a pickup order.", + "x-release-status": "PUBLIC", + "properties": { + "recipient": { + "$ref": "#/components/schemas/FulfillmentRecipient", + "description": "Information about the person to pick up this fulfillment from a physical\nlocation.", + "nullable": true + }, + "expires_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment expires if it is not marked in progress. The timestamp must be\nin RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set\nup to 7 days in the future. If `expires_at` is not set, any new payments attached to the order\nare automatically completed.", + "nullable": true + }, + "auto_complete_duration": { + "type": "string", + "description": "The duration of time after which an in progress pickup fulfillment is automatically moved\nto the `COMPLETED` state. The duration must be in RFC 3339 format (for example, \"P1W3D\").\n\nIf not set, this pickup fulfillment remains in progress until it is canceled or completed.", + "nullable": true + }, + "schedule_type": { + "$ref": "#/components/schemas/FulfillmentPickupDetailsScheduleType", + "description": "The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`.\nSee [FulfillmentPickupDetailsScheduleType](#type-fulfillmentpickupdetailsscheduletype) for possible values", + "nullable": true + }, + "pickup_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,\n\"2016-09-04T23:59:33.123Z\".\n\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment.", + "nullable": true + }, + "pickup_window_duration": { + "type": "string", + "description": "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an\ninformational guideline for merchants.", + "nullable": true + }, + "prep_time_duration": { + "type": "string", + "description": "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "note": { + "type": "string", + "description": "A note to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API.", + "maxLength": 500, + "nullable": true + }, + "placed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "accepted_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "rejected_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "ready_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "expired_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "picked_up_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "cancel_reason": { + "type": "string", + "description": "A description of why the pickup was canceled. The maximum length: 100 characters.", + "maxLength": 100, + "nullable": true + }, + "is_curbside_pickup": { + "type": "boolean", + "description": "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.", + "x-release-status": "BETA", + "nullable": true + }, + "curbside_pickup_details": { + "$ref": "#/components/schemas/FulfillmentPickupDetailsCurbsidePickupDetails", + "description": "Specific details for curbside pickup. These details can only be populated if `is_curbside_pickup` is set to `true`.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "FulfillmentPickupDetailsCurbsidePickupDetails": { + "type": "object", + "description": "Specific details for curbside pickup.", + "x-release-status": "BETA", + "properties": { + "curbside_details": { + "type": "string", + "description": "Specific details for curbside pickup, such as parking number and vehicle model.", + "maxLength": 250, + "nullable": true + }, + "buyer_arrived_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + } + } + }, + "FulfillmentPickupDetailsScheduleType": { + "type": "string", + "enum": [ + "SCHEDULED", + "ASAP" + ], + "x-enum-elements": [ + { + "name": "SCHEDULED", + "description": "Indicates that the fulfillment will be picked up at a scheduled pickup time." + }, + { + "name": "ASAP", + "description": "Indicates that the fulfillment will be picked up as soon as possible and\nshould be prepared immediately." + } + ], + "description": "The schedule type of the pickup fulfillment.", + "x-release-status": "PUBLIC" + }, + "FulfillmentRecipient": { + "type": "object", + "description": "Information about the fulfillment recipient.", + "x-release-status": "PUBLIC", + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient's `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", + "maxLength": 191, + "nullable": true + }, + "display_name": { + "type": "string", + "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", + "maxLength": 255, + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", + "maxLength": 255, + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", + "maxLength": 17, + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The address of the fulfillment recipient. This field is required.\n\nIf provided, the address overrides the corresponding customer profile value\nindicated by `customer_id`.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "FulfillmentShipmentDetails": { + "type": "object", + "description": "Contains the details necessary to fulfill a shipment order.", + "x-release-status": "BETA", + "properties": { + "recipient": { + "$ref": "#/components/schemas/FulfillmentRecipient", + "description": "Information about the person to receive this shipment fulfillment.", + "nullable": true + }, + "carrier": { + "type": "string", + "description": "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).", + "maxLength": 50, + "nullable": true + }, + "shipping_note": { + "type": "string", + "description": "A note with additional information for the shipping carrier.", + "maxLength": 500, + "nullable": true + }, + "shipping_type": { + "type": "string", + "description": "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express).", + "maxLength": 50, + "nullable": true + }, + "tracking_number": { + "type": "string", + "description": "The reference number provided by the carrier to track the shipment's progress.", + "maxLength": 100, + "nullable": true + }, + "tracking_url": { + "type": "string", + "description": "A link to the tracking webpage on the carrier's website.", + "maxLength": 2000, + "nullable": true + }, + "placed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "in_progress_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "packaged_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "expected_shipped_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "shipped_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "cancel_reason": { + "type": "string", + "description": "A description of why the shipment was canceled.", + "maxLength": 100, + "nullable": true + }, + "failed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "failure_reason": { + "type": "string", + "description": "A description of why the shipment failed to be completed.", + "maxLength": 100, + "nullable": true + } + } + }, + "FulfillmentState": { + "type": "string", + "enum": [ + "PROPOSED", + "RESERVED", + "PREPARED", + "COMPLETED", + "CANCELED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "PROPOSED", + "description": "Indicates that the fulfillment has been proposed." + }, + { + "name": "RESERVED", + "description": "Indicates that the fulfillment has been reserved." + }, + { + "name": "PREPARED", + "description": "Indicates that the fulfillment has been prepared." + }, + { + "name": "COMPLETED", + "description": "Indicates that the fulfillment was successfully completed." + }, + { + "name": "CANCELED", + "description": "Indicates that the fulfillment was canceled." + }, + { + "name": "FAILED", + "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled." + } + ], + "description": "The current state of this fulfillment.", + "x-release-status": "PUBLIC" + }, + "FulfillmentType": { + "type": "string", + "enum": [ + "PICKUP", + "SHIPMENT", + "DELIVERY" + ], + "x-enum-elements": [ + { + "name": "PICKUP", + "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)." + }, + { + "name": "SHIPMENT", + "description": "A shipping carrier to ship the fulfillment." + }, + { + "name": "DELIVERY", + "description": "A courier to deliver the fulfillment." + } + ], + "description": "The type of fulfillment.", + "x-release-status": "PUBLIC" + }, + "GetBankAccountByV1IdRequest": { + "type": "object", + "description": "Request object for fetching a specific `BankAccount`\nby the object ID.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "GetBankAccountByV1IdResponse": { + "type": "object", + "description": "Response object returned by GetBankAccountByV1Id.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "bank_account": { + "$ref": "#/components/schemas/BankAccount", + "description": "The requested `BankAccount` object." + } + }, + "example": { + "bank_account": { + "account_number_suffix": "971", + "account_type": "CHECKING", + "bank_name": "Bank Name", + "country": "US", + "creditable": false, + "currency": "USD", + "debitable": false, + "holder_name": "Jane Doe", + "id": "w3yRgCGYQnwmdl0R3GB", + "location_id": "S8GWD5example", + "primary_bank_identification_number": "112200303", + "status": "VERIFICATION_IN_PROGRESS", + "version": 5 + } + } + }, + "GetBankAccountRequest": { + "type": "object", + "description": "Request object to fetch a specific `BankAccount`\nby the object ID.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "GetBankAccountResponse": { + "type": "object", + "description": "Response object returned by `GetBankAccount`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "bank_account": { + "$ref": "#/components/schemas/BankAccount", + "description": "The requested `BankAccount` object." + } + }, + "example": { + "bank_account": { + "account_number_suffix": "971", + "account_type": "CHECKING", + "bank_name": "Bank Name", + "country": "US", + "creditable": false, + "currency": "USD", + "debitable": false, + "holder_name": "Jane Doe", + "id": "w3yRgCGYQnwmdl0R3GB", + "location_id": "S8GWD5example", + "primary_bank_identification_number": "112200303", + "status": "VERIFICATION_IN_PROGRESS", + "version": 5 + } + } + }, + "GetBreakTypeRequest": { + "type": "object", + "description": "A request to get a `BreakType` by ID.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "GetBreakTypeResponse": { + "type": "object", + "description": "The response to a request to get a `BreakType`. The response contains\nthe requested `BreakType` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "break_type": { + "$ref": "#/components/schemas/BreakType", + "description": "The response object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "break_type": { + "break_name": "Lunch Break", + "created_at": "2019-02-21T17:50:00Z", + "expected_duration": "PT30M", + "id": "lA0mj_RSOprNPwMUXdYp", + "is_paid": true, + "location_id": "059SB0E0WCNWS", + "updated_at": "2019-02-21T17:50:00Z", + "version": 1 + } + } + }, + "GetDeviceCodeRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "GetDeviceCodeResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "device_code": { + "$ref": "#/components/schemas/DeviceCode", + "description": "The queried DeviceCode." + } + }, + "example": { + "device_code": { + "code": "EBCARJ", + "created_at": "2020-02-06T18:44:33.000Z", + "device_id": "907CS13101300122", + "id": "B3Z6NAMYQSMTM", + "location_id": "B5E4484SHHNYH", + "name": "Counter 1", + "pair_by": "2020-02-06T18:49:33.000Z", + "product_type": "TERMINAL_API", + "status": "PAIRED", + "status_changed_at": "2020-02-06T18:47:28.000Z" + } + } + }, + "GetDeviceRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "GetDeviceResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "device": { + "$ref": "#/components/schemas/Device", + "description": "The requested `Device`." + } + }, + "example": { + "device": { + "attributes": { + "manufacturer": "Square", + "manufacturers_id": "995CS397A6475287", + "merchant_token": "MLCHXZCBWFGDW", + "model": "T2", + "name": "Square Terminal 995", + "type": "TERMINAL", + "updated_at": "2023-09-29T13:12:22.365049321Z", + "version": "5.41.0085" + }, + "components": [ + { + "application_details": { + "application_type": "TERMINAL_API", + "session_location": "LMN2K7S3RTOU3", + "version": "6.25" + }, + "type": "APPLICATION" + }, + { + "card_reader_details": { + "version": "3.53.70" + }, + "type": "CARD_READER" + }, + { + "battery_details": { + "external_power": "AVAILABLE_CHARGING", + "visible_percent": 5 + }, + "type": "BATTERY" + }, + { + "type": "WIFI", + "wifi_details": { + "active": true, + "ip_address_v4": "10.0.0.7", + "secure_connection": "WPA/WPA2 PSK", + "signal_strength": { + "value": 2 + }, + "ssid": "Staff Network" + } + }, + { + "ethernet_details": { + "active": false + }, + "type": "ETHERNET" + } + ], + "id": "device:995CS397A6475287", + "status": { + "category": "AVAILABLE" + } + } + } + }, + "GetEmployeeWageRequest": { + "type": "object", + "description": "A request to get an `EmployeeWage`.", + "x-release-status": "DEPRECATED", + "properties": {} + }, + "GetEmployeeWageResponse": { + "type": "object", + "description": "A response to a request to get an `EmployeeWage`. The response contains\nthe requested `EmployeeWage` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "DEPRECATED", + "properties": { + "employee_wage": { + "$ref": "#/components/schemas/EmployeeWage", + "description": "The requested `EmployeeWage` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "employee_wage": { + "employee_id": "33fJchumvVdJwxV0H6L9", + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "id": "pXS3qCv7BERPnEGedM4S8mhm", + "title": "Manager" + } + } + }, + "GetInvoiceRequest": { + "type": "object", + "description": "Describes a `GetInvoice` request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "GetInvoiceResponse": { + "type": "object", + "description": "Describes a `GetInvoice` response.", + "x-release-status": "PUBLIC", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The invoice requested." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "invoice": { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "created_at": "2020-06-18T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1, + "status": "PENDING", + "uid": "beebd363-e47f-4075-8785-c235aaa7df11" + } + ], + "request_type": "BALANCE", + "tipping_enabled": true, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "DRAFT", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2020-06-18T17:45:13Z", + "version": 0 + } + } + }, + "GetPaymentRefundRequest": { + "type": "object", + "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](api-endpoint:Refunds-GetPaymentRefund).", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "GetPaymentRefundResponse": { + "type": "object", + "description": "Defines the response returned by [GetRefund](api-endpoint:Refunds-GetPaymentRefund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refund": { + "$ref": "#/components/schemas/PaymentRefund", + "description": "The requested `PaymentRefund`." + } + }, + "example": { + "refund": { + "amount_money": { + "amount": 555, + "currency": "USD" + }, + "created_at": "2021-10-13T19:59:05.073Z", + "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd", + "location_id": "L88917AVBK2S5", + "order_id": "9ltv0bx5PuvGXUYHYHxYSKEqC3IZY", + "payment_id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "processing_fee": [ + { + "amount_money": { + "amount": -34, + "currency": "USD" + }, + "effective_at": "2021-10-13T21:34:35.000Z", + "type": "INITIAL" + } + ], + "reason": "Example Refund", + "status": "COMPLETED", + "updated_at": "2021-10-13T20:00:02.442Z" + } + } + }, + "GetPaymentRequest": { + "type": "object", + "description": "Describes a request to retrieve a payment using \n[GetPayment](api-endpoint:Payments-GetPayment).", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "GetPaymentResponse": { + "type": "object", + "description": "Defines the response returned by [GetPayment](api-endpoint:Payments-GetPayment).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "payment": { + "$ref": "#/components/schemas/Payment", + "description": "The requested `Payment`." + } + }, + "example": { + "payment": { + "amount_money": { + "amount": 555, + "currency": "USD" + }, + "application_details": { + "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA", + "square_product": "VIRTUAL_TERMINAL" + }, + "approved_money": { + "amount": 555, + "currency": "USD" + }, + "card_details": { + "auth_result_code": "2Nkw7q", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2021-10-13T19:34:33.680Z", + "captured_at": "2021-10-13T19:34:34.340Z" + }, + "cvv_status": "CVV_ACCEPTED", + "entry_method": "KEYED", + "statement_description": "SQ *EXAMPLE TEST GOSQ.C", + "status": "CAPTURED" + }, + "created_at": "2021-10-13T19:34:33.524Z", + "delay_action": "CANCEL", + "delay_duration": "PT168H", + "delayed_until": "2021-10-20T19:34:33.524Z", + "employee_id": "TMoK_ogh6rH1o4dV", + "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "location_id": "L88917AVBK2S5", + "note": "Test Note", + "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY", + "processing_fee": [ + { + "amount_money": { + "amount": 34, + "currency": "USD" + }, + "effective_at": "2021-10-13T21:34:35.000Z", + "type": "INITIAL" + } + ], + "receipt_number": "bP9m", + "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "source_type": "CARD", + "status": "COMPLETED", + "team_member_id": "TMoK_ogh6rH1o4dV", + "total_money": { + "amount": 555, + "currency": "USD" + }, + "updated_at": "2021-10-13T19:34:34.339Z", + "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o" + } + } + }, + "GetPayoutRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "GetPayoutResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payout": { + "$ref": "#/components/schemas/Payout", + "description": "The requested payout." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "payout": { + "amount_money": { + "amount": -103, + "currency_code": "USD" + }, + "arrival_date": "2022-03-24", + "created_at": "2022-03-24T03:07:09Z", + "destination": { + "id": "bact:ZPp3oedR3AeEUNd3z7", + "type": "BANK_ACCOUNT" + }, + "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45", + "location_id": "L88917AVBK2S5", + "status": "PAID", + "type": "BATCH", + "updated_at": "2022-03-24T03:07:09Z", + "version": 1 + } + } + }, + "GetShiftRequest": { + "type": "object", + "description": "A request to get a `Shift` by ID.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "GetShiftResponse": { + "type": "object", + "description": "A response to a request to get a `Shift`. The response contains\nthe requested `Shift` object and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "shift": { + "$ref": "#/components/schemas/Shift", + "description": "The requested `Shift`." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "shift": { + "breaks": [ + { + "break_type_id": "92EPDRQKJ5088", + "end_at": "2019-02-23T20:00:00-05:00", + "expected_duration": "PT1H", + "id": "M9BBKEPQAQD2T", + "is_paid": true, + "name": "Lunch Break", + "start_at": "2019-02-23T19:00:00-05:00" + } + ], + "created_at": "2019-02-27T00:12:12Z", + "declared_cash_tip_money": { + "amount": 500, + "currency": "USD" + }, + "employee_id": "D71KRMQof6cXGUW0aAv7", + "end_at": "2019-02-23T21:00:00-05:00", + "id": "T35HMQSN89SV4", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-02-23T18:00:00-05:00", + "status": "CLOSED", + "team_member_id": "D71KRMQof6cXGUW0aAv7", + "timezone": "America/New_York", + "updated_at": "2019-02-27T00:12:12Z", + "version": 1, + "wage": { + "hourly_rate": { + "amount": 1457, + "currency": "USD" + }, + "job_id": "N4YKVLzFj3oGtNocqoYHYpW3", + "tip_eligible": true, + "title": "Cashier" + } + } + } + }, + "GetTeamMemberWageRequest": { + "type": "object", + "description": "A request to get a `TeamMemberWage`.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "GetTeamMemberWageResponse": { + "type": "object", + "description": "A response to a request to get a `TeamMemberWage`. The response contains\nthe requested `TeamMemberWage` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "team_member_wage": { + "$ref": "#/components/schemas/TeamMemberWage", + "description": "The requested `TeamMemberWage` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "team_member_wage": { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "id": "pXS3qCv7BERPnEGedM4S8mhm", + "job_id": "jxJNN6eCJsLrhg5UFJrDWDGE", + "team_member_id": "33fJchumvVdJwxV0H6L9", + "tip_eligible": false, + "title": "Manager" + } + } + }, + "GetTerminalActionRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "GetTerminalActionResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "action": { + "$ref": "#/components/schemas/TerminalAction", + "description": "The requested `TerminalAction`" + } + }, + "example": { + "action": { + "app_id": "APP_ID", + "created_at": "2021-07-28T23:22:07.476Z", + "deadline_duration": "PT5M", + "device_id": "DEVICE_ID", + "id": "termapia:jveJIAkkAjILHkdCE", + "location_id": "LOCATION_ID", + "save_card_options": { + "customer_id": "CUSTOMER_ID", + "reference_id": "user-id-1" + }, + "status": "IN_PROGRESS", + "type": "SAVE_CARD", + "updated_at": "2021-07-28T23:22:08.301Z" + } + } + }, + "GetTerminalCheckoutRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "GetTerminalCheckoutResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "checkout": { + "$ref": "#/components/schemas/TerminalCheckout", + "description": "The requested `TerminalCheckout`." + } + }, + "example": { + "checkout": { + "amount_money": { + "amount": 2610, + "currency": "USD" + }, + "app_id": "APP_ID", + "created_at": "2020-04-06T16:39:32.545Z", + "deadline_duration": "PT5M", + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", + "skip_receipt_screen": false, + "tip_settings": { + "allow_tipping": false + } + }, + "id": "08YceKh7B3ZqO", + "location_id": "LOCATION_ID", + "note": "A brief note", + "reference_id": "id11572", + "status": "IN_PROGRESS", + "updated_at": "2020-04-06T16:39:323.001Z" + } + } + }, + "GetTerminalRefundRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "GetTerminalRefundResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refund": { + "$ref": "#/components/schemas/TerminalRefund", + "description": "The requested `Refund`." + } + }, + "example": { + "refund": { + "amount_money": { + "amount": 111, + "currency": "CAD" + }, + "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ", + "card": { + "bin": "411111", + "card_brand": "INTERAC", + "card_type": "CREDIT", + "exp_month": 1, + "exp_year": 2022, + "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw", + "last_4": "1111" + }, + "created_at": "2020-09-29T15:21:46.771Z", + "deadline_duration": "PT5M", + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "location_id": "76C9W6K8CNNQ5", + "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY", + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "reason": "Returning item", + "refund_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb", + "status": "COMPLETED", + "updated_at": "2020-09-29T15:21:48.675Z" + } + } + }, + "GiftCard": { + "type": "object", + "description": "Represents a Square gift card.", + "x-release-status": "PUBLIC", + "required": [ + "type" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the gift card.", + "readOnly": true + }, + "type": { + "$ref": "#/components/schemas/GiftCardType", + "description": "The gift card type.\nSee [Type](#type-type) for possible values" + }, + "gan_source": { + "$ref": "#/components/schemas/GiftCardGANSource", + "description": "The source that generated the gift card account number (GAN). The default value is `SQUARE`.\nSee [GANSource](#type-gansource) for possible values", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/GiftCardStatus", + "description": "The current gift card state.\nSee [Status](#type-status) for possible values", + "readOnly": true + }, + "balance_money": { + "$ref": "#/components/schemas/Money", + "description": "The current gift card balance. This balance is always greater than or equal to zero.", + "readOnly": true + }, + "gan": { + "type": "string", + "description": "The gift card account number (GAN). Buyers can use the GAN to make purchases or check \nthe gift card balance.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the gift card was created, in RFC 3339 format. \nIn the case of a digital gift card, it is the time when you create a card \n(using the Square Point of Sale application, Seller Dashboard, or Gift Cards API). \nIn the case of a plastic gift card, it is the time when Square associates the card with the \nseller at the time of activation.", + "readOnly": true + }, + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked.", + "readOnly": true + } + } + }, + "GiftCardActivity": { + "type": "object", + "description": "Represents an action performed on a [gift card](entity:GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", + "x-release-status": "PUBLIC", + "required": [ + "type", + "location_id" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the gift card activity.", + "readOnly": true + }, + "type": { + "$ref": "#/components/schemas/GiftCardActivityType", + "description": "The type of gift card activity.\nSee [Type](#type-type) for possible values" + }, + "location_id": { + "type": "string", + "description": "The ID of the [business location](entity:Location) where the activity occurred." + }, + "created_at": { + "type": "string", + "description": "The timestamp when the gift card activity was created, in RFC 3339 format.", + "readOnly": true + }, + "gift_card_id": { + "type": "string", + "description": "The gift card ID. When creating a gift card activity, `gift_card_id` is not required if \n`gift_card_gan` is specified.", + "nullable": true + }, + "gift_card_gan": { + "type": "string", + "description": "The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` \nis not required if `gift_card_id` is specified.", + "nullable": true + }, + "gift_card_balance_money": { + "$ref": "#/components/schemas/Money", + "description": "The final balance on the gift card after the action is completed.", + "readOnly": true + }, + "load_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityLoad", + "description": "Additional details about a `LOAD` activity, which is used to reload money onto a gift card.", + "nullable": true + }, + "activate_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityActivate", + "description": "Additional details about an `ACTIVATE` activity, which is used to activate a gift card with \nan initial balance.", + "nullable": true + }, + "redeem_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityRedeem", + "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](api-endpoint:Payments-CreatePayment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REDEEM` activity.", + "nullable": true + }, + "clear_balance_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityClearBalance", + "description": "Additional details about a `CLEAR_BALANCE` activity, which is used to set the balance of a gift card to zero.", + "nullable": true + }, + "deactivate_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityDeactivate", + "description": "Additional details about a `DEACTIVATE` activity, which is used to deactivate a gift card.", + "nullable": true + }, + "adjust_increment_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityAdjustIncrement", + "description": "Additional details about an `ADJUST_INCREMENT` activity, which is used to add money to a gift card \noutside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow.", + "nullable": true + }, + "adjust_decrement_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityAdjustDecrement", + "description": "Additional details about an `ADJUST_DECREMENT` activity, which is used to deduct money from a gift \ncard outside of a typical `REDEEM` activity flow.", + "nullable": true + }, + "refund_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityRefund", + "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that refund payments to a gift card using the Square Refunds API, Square automatically\ncreates a `REFUND` activity that updates the gift card balance after a [RefundPayment](api-endpoint:Refunds-RefundPayment)\nrequest is completed. Applications that use a custom processing system must call\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REFUND` activity.", + "nullable": true + }, + "unlinked_activity_refund_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityUnlinkedActivityRefund", + "description": "Additional details about an `UNLINKED_ACTIVITY_REFUND` activity. This activity is used to add money \nto a gift card when refunding a payment that was processed using a custom payment processing system\nand not linked to the gift card.", + "nullable": true + }, + "import_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityImport", + "description": "Additional details about an `IMPORT` activity, which Square uses to import a third-party \ngift card with a balance.", + "readOnly": true + }, + "block_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityBlock", + "description": "Additional details about a `BLOCK` activity, which Square uses to temporarily block a gift card.", + "readOnly": true + }, + "unblock_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityUnblock", + "description": "Additional details about an `UNBLOCK` activity, which Square uses to unblock a gift card.", + "readOnly": true + }, + "import_reversal_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityImportReversal", + "description": "Additional details about an `IMPORT_REVERSAL` activity, which Square uses to reverse the \nimport of a third-party gift card.", + "readOnly": true + }, + "transfer_balance_to_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityTransferBalanceTo", + "description": "Additional details about a `TRANSFER_BALANCE_TO` activity, which Square uses to add money to\na gift card as the result of a transfer from another gift card.", + "readOnly": true + }, + "transfer_balance_from_activity_details": { + "$ref": "#/components/schemas/GiftCardActivityTransferBalanceFrom", + "description": "Additional details about a `TRANSFER_BALANCE_FROM` activity, which Square uses to deduct money from\na gift as the result of a transfer to another gift card.", + "readOnly": true + } + } + }, + "GiftCardActivityActivate": { + "type": "object", + "description": "Represents details about an `ACTIVATE` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", + "nullable": true + }, + "line_item_uid": { + "type": "string", + "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom order processing system can use this field to track information \nrelated to an order or payment.", + "nullable": true + }, + "buyer_payment_instrument_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters.", + "nullable": true + } + } + }, + "GiftCardActivityAdjustDecrement": { + "type": "object", + "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "amount_money", + "reason" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount deducted from the gift card balance. This value is a positive integer." + }, + "reason": { + "$ref": "#/components/schemas/GiftCardActivityAdjustDecrementReason", + "description": "The reason the gift card balance was adjusted.\nSee [Reason](#type-reason) for possible values" + } + } + }, + "GiftCardActivityAdjustDecrementReason": { + "type": "string", + "enum": [ + "SUSPICIOUS_ACTIVITY", + "BALANCE_ACCIDENTALLY_INCREASED", + "SUPPORT_ISSUE", + "PURCHASE_WAS_REFUNDED" + ], + "x-enum-elements": [ + { + "name": "SUSPICIOUS_ACTIVITY", + "description": "The balance was decreased because the seller detected suspicious or fraudulent activity\non the gift card." + }, + { + "name": "BALANCE_ACCIDENTALLY_INCREASED", + "description": "The balance was decreased to reverse an unintentional balance increase." + }, + { + "name": "SUPPORT_ISSUE", + "description": "The balance was decreased to accommodate support issues." + }, + { + "name": "PURCHASE_WAS_REFUNDED", + "description": "The balance was decreased because the order used to purchase or reload the\ngift card was refunded." + } + ], + "description": "Indicates the reason for deducting money from a [gift card](entity:GiftCard).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityAdjustIncrement": { + "type": "object", + "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "amount_money", + "reason" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount added to the gift card balance. This value is a positive integer." + }, + "reason": { + "$ref": "#/components/schemas/GiftCardActivityAdjustIncrementReason", + "description": "The reason the gift card balance was adjusted.\nSee [Reason](#type-reason) for possible values" + } + } + }, + "GiftCardActivityAdjustIncrementReason": { + "type": "string", + "enum": [ + "COMPLIMENTARY", + "SUPPORT_ISSUE", + "TRANSACTION_VOIDED" + ], + "x-enum-elements": [ + { + "name": "COMPLIMENTARY", + "description": "The seller gifted a complimentary gift card balance increase." + }, + { + "name": "SUPPORT_ISSUE", + "description": "The seller increased the gift card balance \nto accommodate support issues." + }, + { + "name": "TRANSACTION_VOIDED", + "description": "The transaction is voided." + } + ], + "description": "Indicates the reason for adding money to a [gift card](entity:GiftCard).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityBlock": { + "type": "object", + "description": "Represents details about a `BLOCK` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "reason" + ], + "properties": { + "reason": { + "$ref": "#/components/schemas/GiftCardActivityBlockReason", + "description": "The reason the gift card was blocked.\nSee [Reason](#type-reason) for possible values" + } + } + }, + "GiftCardActivityBlockReason": { + "type": "string", + "enum": [ + "CHARGEBACK_BLOCK" + ], + "x-enum-elements": [ + { + "name": "CHARGEBACK_BLOCK", + "description": "The gift card is blocked because the buyer initiated a chargeback on the gift card purchase." + } + ], + "description": "Indicates the reason for blocking a [gift card](entity:GiftCard).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityClearBalance": { + "type": "object", + "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "reason" + ], + "properties": { + "reason": { + "$ref": "#/components/schemas/GiftCardActivityClearBalanceReason", + "description": "The reason the gift card balance was cleared.\nSee [Reason](#type-reason) for possible values" + } + } + }, + "GiftCardActivityClearBalanceReason": { + "type": "string", + "enum": [ + "SUSPICIOUS_ACTIVITY", + "REUSE_GIFTCARD", + "UNKNOWN_REASON" + ], + "x-enum-elements": [ + { + "name": "SUSPICIOUS_ACTIVITY", + "description": "The seller suspects suspicious activity." + }, + { + "name": "REUSE_GIFTCARD", + "description": "The seller cleared the balance to reuse the gift card." + }, + { + "name": "UNKNOWN_REASON", + "description": "The gift card balance was cleared for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API." + } + ], + "description": "Indicates the reason for clearing the balance of a [gift card](entity:GiftCard).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityDeactivate": { + "type": "object", + "description": "Represents details about a `DEACTIVATE` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "reason" + ], + "properties": { + "reason": { + "$ref": "#/components/schemas/GiftCardActivityDeactivateReason", + "description": "The reason the gift card was deactivated.\nSee [Reason](#type-reason) for possible values" + } + } + }, + "GiftCardActivityDeactivateReason": { + "type": "string", + "enum": [ + "SUSPICIOUS_ACTIVITY", + "UNKNOWN_REASON", + "CHARGEBACK_DEACTIVATE" + ], + "x-enum-elements": [ + { + "name": "SUSPICIOUS_ACTIVITY", + "description": "The seller suspects suspicious activity." + }, + { + "name": "UNKNOWN_REASON", + "description": "The gift card was deactivated for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API." + }, + { + "name": "CHARGEBACK_DEACTIVATE", + "description": "A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API." + } + ], + "description": "Indicates the reason for deactivating a [gift card](entity:GiftCard).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityImport": { + "type": "object", + "description": "Represents details about an `IMPORT` [gift card activity type](entity:GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", + "x-release-status": "PUBLIC", + "required": [ + "amount_money" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The balance amount on the imported gift card." + } + } + }, + "GiftCardActivityImportReversal": { + "type": "object", + "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "amount_money" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money cleared from the third-party gift card when \nthe import was reversed." + } + } + }, + "GiftCardActivityLoad": { + "type": "object", + "description": "Represents details about a `LOAD` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", + "nullable": true + }, + "line_item_uid": { + "type": "string", + "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom order processing system can use this field to track information related to \nan order or payment.", + "nullable": true + }, + "buyer_payment_instrument_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters.", + "nullable": true + } + } + }, + "GiftCardActivityRedeem": { + "type": "object", + "description": "Represents details about a `REDEEM` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "amount_money" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request." + }, + "payment_id": { + "type": "string", + "description": "The ID of the payment that represents the gift card redemption. Square populates this field \nif the payment was processed by Square.", + "readOnly": true + }, + "reference_id": { + "type": "string", + "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom payment processing system can use this field to track information\nrelated to an order or payment.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/GiftCardActivityRedeemStatus", + "description": "The status of the gift card redemption. Gift cards redeemed from Square Point of Sale or the \nSquare Seller Dashboard use a two-state process: `PENDING` \nto `COMPLETED` or `PENDING` to `CANCELED`. Gift cards redeemed using the Gift Card Activities API \nalways have a `COMPLETED` status.\nSee [Status](#type-status) for possible values", + "readOnly": true + } + } + }, + "GiftCardActivityRedeemStatus": { + "type": "string", + "enum": [ + "PENDING", + "COMPLETED", + "CANCELED" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "The gift card redemption is pending. `PENDING` is a temporary status that applies when a \ngift card is redeemed from Square Point of Sale or another Square product. A `PENDING` status is updated to \n`COMPLETED` if the payment is captured or `CANCELED` if the authorization is voided." + }, + { + "name": "COMPLETED", + "description": "The gift card redemption is completed." + }, + { + "name": "CANCELED", + "description": "The gift card redemption is canceled. A redemption is canceled if the authorization \non the gift card is voided." + } + ], + "description": "Indicates the status of a [gift card](entity:GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityRefund": { + "type": "object", + "description": "Represents details about a `REFUND` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "properties": { + "redeem_activity_id": { + "type": "string", + "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request \nrepresents a gift card redemption.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card.", + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount added to the gift card for the refund. This value is a positive integer.\n\nThis field is required when creating a `REFUND` activity. The amount can represent a full or partial refund.", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "A client-specified ID that associates the gift card activity with an entity in another system.", + "nullable": true + }, + "payment_id": { + "type": "string", + "description": "The ID of the refunded payment. Square populates this field if the refund is for a \npayment processed by Square. This field matches the `payment_id` in the corresponding\n[RefundPayment](api-endpoint:Refunds-RefundPayment) request.", + "readOnly": true + } + } + }, + "GiftCardActivityTransferBalanceFrom": { + "type": "object", + "description": "Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "transfer_to_gift_card_id", + "amount_money" + ], + "properties": { + "transfer_to_gift_card_id": { + "type": "string", + "description": "The ID of the gift card to which the specified amount was transferred." + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount deducted from the gift card for the transfer. This value is a positive integer." + } + } + }, + "GiftCardActivityTransferBalanceTo": { + "type": "object", + "description": "Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "transfer_from_gift_card_id", + "amount_money" + ], + "properties": { + "transfer_from_gift_card_id": { + "type": "string", + "description": "The ID of the gift card from which the specified amount was transferred." + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount added to the gift card balance for the transfer. This value is a positive integer." + } + } + }, + "GiftCardActivityType": { + "type": "string", + "enum": [ + "ACTIVATE", + "LOAD", + "REDEEM", + "CLEAR_BALANCE", + "DEACTIVATE", + "ADJUST_INCREMENT", + "ADJUST_DECREMENT", + "REFUND", + "UNLINKED_ACTIVITY_REFUND", + "IMPORT", + "BLOCK", + "UNBLOCK", + "IMPORT_REVERSAL", + "TRANSFER_BALANCE_FROM", + "TRANSFER_BALANCE_TO" + ], + "x-enum-elements": [ + { + "name": "ACTIVATE", + "description": "Activated a gift card with a balance. When a gift card is activated, Square changes \nthe gift card state from `PENDING` to `ACTIVE`. A gift card must be in the `ACTIVE` state \nto be used for other balance-changing activities." + }, + { + "name": "LOAD", + "description": "Loaded a gift card with additional funds." + }, + { + "name": "REDEEM", + "description": "Redeemed a gift card for a purchase." + }, + { + "name": "CLEAR_BALANCE", + "description": "Set the balance of a gift card to zero." + }, + { + "name": "DEACTIVATE", + "description": "Permanently blocked a gift card from balance-changing activities." + }, + { + "name": "ADJUST_INCREMENT", + "description": "Added money to a gift card outside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow." + }, + { + "name": "ADJUST_DECREMENT", + "description": "Deducted money from a gift card outside of a typical `REDEEM` activity flow." + }, + { + "name": "REFUND", + "description": "Added money to a gift card from a refunded transaction. A `REFUND` activity might be linked to \na Square payment, depending on how the payment and refund are processed. For example:\n- A payment processed by Square can be refunded to a `PENDING` or `ACTIVE` gift card using the Square\nSeller Dashboard, Square Point of Sale, or Refunds API.\n- A payment processed using a custom processing system can be refunded to the same gift card." + }, + { + "name": "UNLINKED_ACTIVITY_REFUND", + "description": "Added money to a gift card from a refunded transaction that was processed using a custom payment\nprocessing system and not linked to the gift card." + }, + { + "name": "IMPORT", + "description": "Imported a third-party gift card with a balance. `IMPORT` activities are managed \nby Square and cannot be created using the Gift Card Activities API." + }, + { + "name": "BLOCK", + "description": "Temporarily blocked a gift card from balance-changing activities. `BLOCK` activities \nare managed by Square and cannot be created using the Gift Card Activities API." + }, + { + "name": "UNBLOCK", + "description": "Unblocked a gift card, which enables it to resume balance-changing activities. `UNBLOCK` \nactivities are managed by Square and cannot be created using the Gift Card Activities API." + }, + { + "name": "IMPORT_REVERSAL", + "description": "Reversed the import of a third-party gift card, which sets the gift card state to \n`PENDING` and clears the balance. `IMPORT_REVERSAL` activities are managed by Square and \ncannot be created using the Gift Card Activities API." + }, + { + "name": "TRANSFER_BALANCE_FROM", + "description": "Deducted money from a gift card as the result of a transfer to the balance of another gift card.\n`TRANSFER_BALANCE_FROM` activities are managed by Square and cannot be created using the Gift Card Activities API." + }, + { + "name": "TRANSFER_BALANCE_TO", + "description": "Added money to a gift card as the result of a transfer from the balance of another gift card.\n`TRANSFER_BALANCE_TO` activities are managed by Square and cannot be created using the Gift Card Activities API." + } + ], + "description": "Indicates the type of [gift card activity](entity:GiftCardActivity).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityUnblock": { + "type": "object", + "description": "Represents details about an `UNBLOCK` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "reason" + ], + "properties": { + "reason": { + "$ref": "#/components/schemas/GiftCardActivityUnblockReason", + "description": "The reason the gift card was unblocked.\nSee [Reason](#type-reason) for possible values" + } + } + }, + "GiftCardActivityUnblockReason": { + "type": "string", + "enum": [ + "CHARGEBACK_UNBLOCK" + ], + "x-enum-elements": [ + { + "name": "CHARGEBACK_UNBLOCK", + "description": "The gift card is unblocked because a chargeback was ruled in favor of the seller." + } + ], + "description": "Indicates the reason for unblocking a [gift card](entity:GiftCard).", + "x-release-status": "PUBLIC" + }, + "GiftCardActivityUnlinkedActivityRefund": { + "type": "object", + "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](entity:GiftCardActivityType).", + "x-release-status": "PUBLIC", + "required": [ + "amount_money" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount added to the gift card for the refund. This value is a positive integer." + }, + "reference_id": { + "type": "string", + "description": "A client-specified ID that associates the gift card activity with an entity in another system.", + "nullable": true + }, + "payment_id": { + "type": "string", + "description": "The ID of the refunded payment. This field is not used starting in Square version 2022-06-16.", + "readOnly": true + } + } + }, + "GiftCardGANSource": { + "type": "string", + "enum": [ + "SQUARE", + "OTHER" + ], + "x-enum-elements": [ + { + "name": "SQUARE", + "description": "The GAN is generated by Square." + }, + { + "name": "OTHER", + "description": "The GAN is provided by a non-Square system. For more information, see \n[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans) or \n[Third-party gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#third-party-gift-cards)." + } + ], + "description": "Indicates the source that generated the gift card \naccount number (GAN).", + "x-release-status": "PUBLIC" + }, + "GiftCardStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "DEACTIVATED", + "BLOCKED", + "PENDING" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "The gift card is active and can be used as a payment source." + }, + { + "name": "DEACTIVATED", + "description": "Any activity that changes the gift card balance is permanently forbidden." + }, + { + "name": "BLOCKED", + "description": "Any activity that changes the gift card balance is temporarily forbidden." + }, + { + "name": "PENDING", + "description": "The gift card is pending activation.\nThis is the initial state when a gift card is created. Typically, you'll call\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create an\n`ACTIVATE` activity that activates the gift card with an initial balance before first use." + } + ], + "description": "Indicates the gift card state.", + "x-release-status": "PUBLIC" + }, + "GiftCardType": { + "type": "string", + "enum": [ + "PHYSICAL", + "DIGITAL" + ], + "x-enum-elements": [ + { + "name": "PHYSICAL", + "description": "A plastic gift card." + }, + { + "name": "DIGITAL", + "description": "A digital gift card." + } + ], + "description": "Indicates the gift card type.", + "x-release-status": "PUBLIC" + }, + "InventoryAdjustment": { + "type": "object", + "description": "Represents a change in state or quantity of product inventory at a\nparticular time and location.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A unique ID generated by Square for the\n`InventoryAdjustment`.", + "maxLength": 100 + }, + "reference_id": { + "type": "string", + "description": "An optional ID provided by the application to tie the\n`InventoryAdjustment` to an external\nsystem.", + "maxLength": 255, + "nullable": true + }, + "from_state": { + "$ref": "#/components/schemas/InventoryState", + "description": "The [inventory state](entity:InventoryState) of the related quantity\nof items before the adjustment.\nSee [InventoryState](#type-inventorystate) for possible values", + "nullable": true + }, + "to_state": { + "$ref": "#/components/schemas/InventoryState", + "description": "The [inventory state](entity:InventoryState) of the related quantity\nof items after the adjustment.\nSee [InventoryState](#type-inventorystate) for possible values", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items is being tracked.", + "maxLength": 100, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", + "maxLength": 100, + "nullable": true + }, + "catalog_object_type": { + "type": "string", + "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.", + "maxLength": 14, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The number of items affected by the adjustment as a decimal string.\nCan support up to 5 digits after the decimal point.", + "maxLength": 26, + "nullable": true + }, + "total_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The total price paid for goods associated with the\nadjustment. Present if and only if `to_state` is `SOLD`. Always\nnon-negative.", + "readOnly": true + }, + "occurred_at": { + "type": "string", + "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe inventory adjustment took place. For inventory adjustment updates, the `occurred_at`\ntimestamp cannot be older than 24 hours or in the future relative to the\ntime of the request.", + "maxLength": 34, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.", + "maxLength": 34, + "readOnly": true + }, + "source": { + "$ref": "#/components/schemas/SourceApplication", + "description": "Information about the application that caused the\ninventory adjustment.", + "readOnly": true + }, + "employee_id": { + "type": "string", + "description": "The Square-generated ID of the [Employee](entity:Employee) responsible for the\ninventory adjustment.", + "maxLength": 100, + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the\ninventory adjustment.", + "maxLength": 100, + "nullable": true + }, + "transaction_id": { + "type": "string", + "description": "The Square-generated ID of the [Transaction](entity:Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", + "maxLength": 255, + "readOnly": true + }, + "refund_id": { + "type": "string", + "description": "The Square-generated ID of the [Refund](entity:Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", + "maxLength": 255, + "readOnly": true + }, + "purchase_order_id": { + "type": "string", + "description": "The Square-generated ID of the purchase order that caused the\nadjustment. Only relevant for state transitions from the Square for Retail\napp.", + "maxLength": 100, + "readOnly": true + }, + "goods_receipt_id": { + "type": "string", + "description": "The Square-generated ID of the goods receipt that caused the\nadjustment. Only relevant for state transitions from the Square for Retail\napp.", + "maxLength": 100, + "readOnly": true + }, + "adjustment_group": { + "$ref": "#/components/schemas/InventoryAdjustmentGroup", + "description": "An adjustment group bundling the related adjustments of item variations through stock conversions in a single inventory event.", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "InventoryAdjustmentGroup": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "id": { + "type": "string", + "description": "A unique ID generated by Square for the\n`InventoryAdjustmentGroup`.", + "maxLength": 100, + "readOnly": true + }, + "root_adjustment_id": { + "type": "string", + "description": "The inventory adjustment of the composed variation.", + "maxLength": 100, + "readOnly": true + }, + "from_state": { + "$ref": "#/components/schemas/InventoryState", + "description": "Representative `from_state` for adjustments within the group. For example, for a group adjustment from `IN_STOCK` to `SOLD`,\nthere can be two component adjustments in the group: one from `IN_STOCK`to `COMPOSED` and the other one from `COMPOSED` to `SOLD`.\nHere, the representative `from_state` for the `InventoryAdjustmentGroup` is `IN_STOCK`.\nSee [InventoryState](#type-inventorystate) for possible values", + "readOnly": true + }, + "to_state": { + "$ref": "#/components/schemas/InventoryState", + "description": "Representative `to_state` for adjustments within group. For example, for a group adjustment from `IN_STOCK` to `SOLD`,\nthe two component adjustments in the group can be from `IN_STOCK` to `COMPOSED` and from `COMPOSED` to `SOLD`.\nHere, the representative `to_state` of the `InventoryAdjustmentGroup` is `SOLD`.\nSee [InventoryState](#type-inventorystate) for possible values", + "readOnly": true + } + } + }, + "InventoryAlertType": { + "type": "string", + "enum": [ + "NONE", + "LOW_QUANTITY" + ], + "x-enum-elements": [ + { + "name": "NONE", + "description": "The variation does not display an alert." + }, + { + "name": "LOW_QUANTITY", + "description": "The variation generates an alert when its quantity is low." + } + ], + "description": "Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.", + "x-release-status": "PUBLIC" + }, + "InventoryChange": { + "type": "object", + "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](entity:CatalogObject) instance.", + "x-release-status": "PUBLIC", + "properties": { + "type": { + "$ref": "#/components/schemas/InventoryChangeType", + "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](entity:InventoryChangeType) for all possible values.\nSee [InventoryChangeType](#type-inventorychangetype) for possible values", + "nullable": true + }, + "physical_count": { + "$ref": "#/components/schemas/InventoryPhysicalCount", + "description": "Contains details about the physical count when `type` is\n`PHYSICAL_COUNT`, and is unset for all other change types.", + "nullable": true + }, + "adjustment": { + "$ref": "#/components/schemas/InventoryAdjustment", + "description": "Contains details about the inventory adjustment when `type` is\n`ADJUSTMENT`, and is unset for all other change types.", + "nullable": true + }, + "transfer": { + "$ref": "#/components/schemas/InventoryTransfer", + "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](entity:InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) endpoint when the seller has an active Retail Plus subscription.", + "nullable": true + }, + "measurement_unit": { + "$ref": "#/components/schemas/CatalogMeasurementUnit", + "description": "The [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "readOnly": true + }, + "measurement_unit_id": { + "type": "string", + "description": "The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "readOnly": true + } + } + }, + "InventoryChangeType": { + "type": "string", + "enum": [ + "PHYSICAL_COUNT", + "ADJUSTMENT", + "TRANSFER" + ], + "x-enum-elements": [ + { + "name": "PHYSICAL_COUNT", + "description": "The change occurred as part of a physical count update." + }, + { + "name": "ADJUSTMENT", + "description": "The change occurred as part of the normal lifecycle of goods\n(e.g., as an inventory adjustment)." + }, + { + "name": "TRANSFER", + "description": "The change occurred as part of an inventory transfer." + } + ], + "description": "Indicates how the inventory change was applied to a tracked product quantity.", + "x-release-status": "PUBLIC" + }, + "InventoryCount": { + "type": "object", + "description": "Represents Square-estimated quantity of items in a particular state at a\nparticular seller location based on the known history of physical counts and\ninventory adjustments.", + "x-release-status": "PUBLIC", + "properties": { + "catalog_object_id": { + "type": "string", + "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", + "maxLength": 100, + "nullable": true + }, + "catalog_object_type": { + "type": "string", + "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.", + "maxLength": 14, + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/InventoryState", + "description": "The current [inventory state](entity:InventoryState) for the related\nquantity of items.\nSee [InventoryState](#type-inventorystate) for possible values", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items is being tracked.", + "maxLength": 100, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The number of items affected by the estimated count as a decimal string.\nCan support up to 5 digits after the decimal point.", + "maxLength": 26, + "nullable": true + }, + "calculated_at": { + "type": "string", + "description": "An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting\nthe estimated count is received.", + "maxLength": 34, + "readOnly": true + }, + "is_estimated": { + "type": "boolean", + "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory),\n[BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges),\n[BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts), and\n[RetrieveInventoryChanges](api-endpoint:Inventory-RetrieveInventoryChanges).", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "InventoryPhysicalCount": { + "type": "object", + "description": "Represents the quantity of an item variation that is physically present\nat a specific location, verified by a seller or a seller's employee. For example,\na physical count might come from an employee counting the item variations on\nhand or from syncing with an external system.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount).", + "maxLength": 100 + }, + "reference_id": { + "type": "string", + "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external\nsystem.", + "maxLength": 255, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", + "maxLength": 100, + "nullable": true + }, + "catalog_object_type": { + "type": "string", + "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.", + "maxLength": 14, + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/InventoryState", + "description": "The current [inventory state](entity:InventoryState) for the related\nquantity of items.\nSee [InventoryState](#type-inventorystate) for possible values", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items is being tracked.", + "maxLength": 100, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The number of items affected by the physical count as a decimal string.\nThe number can support up to 5 digits after the decimal point.", + "maxLength": 26, + "nullable": true + }, + "source": { + "$ref": "#/components/schemas/SourceApplication", + "description": "Information about the application with which the\nphysical count is submitted.", + "readOnly": true + }, + "employee_id": { + "type": "string", + "description": "The Square-generated ID of the [Employee](entity:Employee) responsible for the\nphysical count.", + "maxLength": 100, + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the\nphysical count.", + "maxLength": 100, + "nullable": true + }, + "occurred_at": { + "type": "string", + "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe physical count was examined. For physical count updates, the `occurred_at`\ntimestamp cannot be older than 24 hours or in the future relative to the\ntime of the request.", + "maxLength": 34, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "An RFC 3339-formatted timestamp that indicates when the physical count is received.", + "maxLength": 34, + "readOnly": true + } + } + }, + "InventoryState": { + "type": "string", + "enum": [ + "CUSTOM", + "IN_STOCK", + "SOLD", + "RETURNED_BY_CUSTOMER", + "RESERVED_FOR_SALE", + "SOLD_ONLINE", + "ORDERED_FROM_VENDOR", + "RECEIVED_FROM_VENDOR", + "IN_TRANSIT_TO", + "NONE", + "WASTE", + "UNLINKED_RETURN", + "COMPOSED", + "DECOMPOSED", + "SUPPORTED_BY_NEWER_VERSION", + "IN_TRANSIT" + ], + "x-enum-elements": [ + { + "name": "CUSTOM", + "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state." + }, + { + "name": "IN_STOCK", + "description": "The related quantity of items are on hand and available for sale." + }, + { + "name": "SOLD", + "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked." + }, + { + "name": "RETURNED_BY_CUSTOMER", + "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state." + }, + { + "name": "RESERVED_FOR_SALE", + "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state." + }, + { + "name": "SOLD_ONLINE", + "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state." + }, + { + "name": "ORDERED_FROM_VENDOR", + "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state." + }, + { + "name": "RECEIVED_FROM_VENDOR", + "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state." + }, + { + "name": "IN_TRANSIT_TO", + "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations." + }, + { + "name": "NONE", + "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system." + }, + { + "name": "WASTE", + "description": "The related quantity of items are lost or damaged and cannot be\nsold." + }, + { + "name": "UNLINKED_RETURN", + "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system." + }, + { + "name": "COMPOSED", + "description": "The related quantity of items that are part of a composition consisting one or more components." + }, + { + "name": "DECOMPOSED", + "description": "The related quantity of items that are part of a component." + }, + { + "name": "SUPPORTED_BY_NEWER_VERSION", + "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state." + }, + { + "name": "IN_TRANSIT", + "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state." + } + ], + "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", + "x-release-status": "PUBLIC" + }, + "InventoryTransfer": { + "type": "object", + "description": "Represents the transfer of a quantity of product inventory at a\nparticular time from one location to another.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A unique ID generated by Square for the\n`InventoryTransfer`.", + "maxLength": 100 + }, + "reference_id": { + "type": "string", + "description": "An optional ID provided by the application to tie the\n`InventoryTransfer` to an external system.", + "maxLength": 255, + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/InventoryState", + "description": "The [inventory state](entity:InventoryState) for the quantity of\nitems being transferred.\nSee [InventoryState](#type-inventorystate) for possible values", + "nullable": true + }, + "from_location_id": { + "type": "string", + "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items was tracked before the transfer.", + "maxLength": 100, + "nullable": true + }, + "to_location_id": { + "type": "string", + "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items was tracked after the transfer.", + "maxLength": 100, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", + "maxLength": 100, + "nullable": true + }, + "catalog_object_type": { + "type": "string", + "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.", + "maxLength": 14, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The number of items affected by the transfer as a decimal string.\nCan support up to 5 digits after the decimal point.", + "maxLength": 26, + "nullable": true + }, + "occurred_at": { + "type": "string", + "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe transfer took place. For write actions, the `occurred_at` timestamp\ncannot be older than 24 hours or in the future relative to the time of the\nrequest.", + "maxLength": 34, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "An RFC 3339-formatted timestamp that indicates when Square\nreceived the transfer request.", + "maxLength": 34, + "readOnly": true + }, + "source": { + "$ref": "#/components/schemas/SourceApplication", + "description": "Information about the application that initiated the\ninventory transfer.", + "readOnly": true + }, + "employee_id": { + "type": "string", + "description": "The Square-generated ID of the [Employee](entity:Employee) responsible for the\ninventory transfer.", + "maxLength": 100, + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the\ninventory transfer.", + "maxLength": 100, + "nullable": true + } + } + }, + "Invoice": { + "type": "object", + "description": "Stores information about an invoice. You use the Invoices API to create and manage\ninvoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview).", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the invoice.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "The Square-assigned version number, which is incremented each time an update is committed to the invoice." + }, + "location_id": { + "type": "string", + "description": "The ID of the location that this invoice is associated with. \n\nIf specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.", + "minLength": 1, + "maxLength": 255, + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID.", + "minLength": 1, + "maxLength": 255, + "nullable": true + }, + "primary_recipient": { + "$ref": "#/components/schemas/InvoiceRecipient", + "description": "The customer who receives the invoice. This customer data is displayed on the invoice and used by Square to deliver the invoice. \n\nThis field is required to publish an invoice, and it must specify the `customer_id`.", + "nullable": true + }, + "payment_requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoicePaymentRequest" + }, + "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2–12 installments \n- One deposit with 2–12 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", + "nullable": true + }, + "delivery_method": { + "$ref": "#/components/schemas/InvoiceDeliveryMethod", + "description": "The delivery method that Square uses to send the invoice, reminders, and receipts to\nthe customer. After the invoice is published, Square processes the invoice based on the delivery\nmethod and payment request settings, either immediately or on the `scheduled_at` date, if specified.\nFor example, Square might send the invoice or receipt for an automatic payment. For invoices with\nautomatic payments, this field must be set to `EMAIL`.\n\nOne of the following is required when creating an invoice:\n- (Recommended) This `delivery_method` field. To configure an automatic payment, the\n`automatic_payment_source` field of the payment request is also required.\n- The deprecated `request_method` field of the payment request. Note that `invoice`\nobjects returned in responses do not include `request_method`.\nSee [InvoiceDeliveryMethod](#type-invoicedeliverymethod) for possible values", + "nullable": true + }, + "invoice_number": { + "type": "string", + "description": "A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.\nIf not provided when creating an invoice, Square assigns a value.\nIt increments from 1 and is padded with zeros making it 7 characters long\n(for example, 0000001 and 0000002).", + "minLength": 1, + "maxLength": 191, + "nullable": true + }, + "title": { + "type": "string", + "description": "The title of the invoice, which is displayed on the invoice.", + "minLength": 1, + "maxLength": 255, + "nullable": true + }, + "description": { + "type": "string", + "description": "The description of the invoice, which is displayed on the invoice.", + "minLength": 1, + "maxLength": 65536, + "nullable": true + }, + "scheduled_at": { + "type": "string", + "description": "The timestamp when the invoice is scheduled for processing, in RFC 3339 format.\nAfter the invoice is published, Square processes the invoice on the specified date,\naccording to the delivery method and payment request settings.\n\nIf the field is not set, Square processes the invoice immediately after it is published.", + "nullable": true + }, + "public_url": { + "type": "string", + "description": "A temporary link to the Square-hosted payment page where the customer can pay the\ninvoice. If the link expires, customers can provide the email address or phone number\nassociated with the invoice and request a new link directly from the expired payment page. \n\nThis field is added after the invoice is published and reaches the scheduled date\n(if one is defined).", + "readOnly": true + }, + "next_payment_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The current amount due for the invoice. In addition to the\namount due on the next payment request, this includes any overdue payment amounts.", + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/InvoiceStatus", + "description": "The status of the invoice.\nSee [InvoiceStatus](#type-invoicestatus) for possible values", + "readOnly": true + }, + "timezone": { + "type": "string", + "description": "The time zone used to interpret calendar dates on the invoice, such as `due_date`.\nWhen an invoice is created, this field is set to the `timezone` specified for the seller\nlocation. The value cannot be changed.\n\nFor example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles\nbecomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp\nof 2021-03-10T08:00:00Z).", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the invoice was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the invoice was last updated, in RFC 3339 format.", + "readOnly": true + }, + "accepted_payment_methods": { + "$ref": "#/components/schemas/InvoiceAcceptedPaymentMethods", + "description": "The payment methods that customers can use to pay the invoice on the Square-hosted\ninvoice page. This setting is independent of any automatic payment requests for the invoice.\n\nThis field is required when creating an invoice and must set at least one payment method to `true`.", + "nullable": true + }, + "custom_fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoiceCustomField" + }, + "description": "Additional seller-defined fields that are displayed on the invoice. For more information, see\n[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\n\nMax: 2 custom fields", + "nullable": true + }, + "subscription_id": { + "type": "string", + "description": "The ID of the [subscription](entity:Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", + "readOnly": true + }, + "sale_or_service_date": { + "type": "string", + "description": "The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.\nThis field can be used to specify a past or future date which is displayed on the invoice.", + "nullable": true + }, + "payment_conditions": { + "type": "string", + "description": "**France only.** The payment terms and conditions that are displayed on the invoice. For more information, \nsee [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).\n\nFor countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and \n\"Payment conditions are not supported for this location's country\" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.", + "minLength": 1, + "maxLength": 2000, + "nullable": true + }, + "store_payment_method_enabled": { + "type": "boolean", + "description": "Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a\nbank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the\ninvoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`.", + "nullable": true + }, + "attachments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoiceAttachment" + }, + "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints.", + "readOnly": true + }, + "creator_team_member_id": { + "type": "string", + "description": "The ID of the [team member](entity:TeamMember) who created the invoice.\nThis field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member.", + "readOnly": true + } + } + }, + "InvoiceAcceptedPaymentMethods": { + "type": "object", + "description": "The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page.", + "x-release-status": "PUBLIC", + "properties": { + "card": { + "type": "boolean", + "description": "Indicates whether credit card or debit card payments are accepted. The default value is `false`.", + "nullable": true + }, + "square_gift_card": { + "type": "boolean", + "description": "Indicates whether Square gift card payments are accepted. The default value is `false`.", + "nullable": true + }, + "bank_account": { + "type": "boolean", + "description": "Indicates whether ACH bank transfer payments are accepted. The default value is `false`.", + "nullable": true + }, + "buy_now_pay_later": { + "type": "boolean", + "description": "Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\n\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later).", + "nullable": true + }, + "cash_app_pay": { + "type": "boolean", + "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](entity:Location) in the United States.", + "nullable": true + } + } + }, + "InvoiceAttachment": { + "type": "object", + "description": "Represents a file attached to an [invoice](entity:Invoice).", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the attachment.", + "readOnly": true + }, + "filename": { + "type": "string", + "description": "The file name of the attachment, which is displayed on the invoice.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the attachment, which is displayed on the invoice.\nThis field maps to the seller-defined **Message** field.", + "readOnly": true + }, + "filesize": { + "type": "integer", + "description": "The file size of the attachment in bytes.", + "readOnly": true + }, + "hash": { + "type": "string", + "description": "The MD5 hash that was generated from the file contents.", + "readOnly": true + }, + "mime_type": { + "type": "string", + "description": "The mime type of the attachment.\nThe following mime types are supported: \nimage/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf.", + "readOnly": true + }, + "uploaded_at": { + "type": "string", + "description": "The timestamp when the attachment was uploaded, in RFC 3339 format.", + "readOnly": true + } + } + }, + "InvoiceAutomaticPaymentSource": { + "type": "string", + "enum": [ + "NONE", + "CARD_ON_FILE", + "BANK_ON_FILE" + ], + "x-enum-elements": [ + { + "name": "NONE", + "description": "An automatic payment is not configured for the payment request." + }, + { + "name": "CARD_ON_FILE", + "description": "Use a card on file as the automatic payment method. On the due date, Square charges the card\nfor the amount of the payment request.\n\nFor `CARD_ON_FILE` payments, the invoice delivery method must be `EMAIL` and `card_id` must be\nspecified for the payment request before the invoice can be published." + }, + { + "name": "BANK_ON_FILE", + "description": "Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\naccount for the amount of the payment request if the buyer has approved the payment. The buyer receives a\nrequest to approve the payment when the invoice is sent or the invoice is updated.\n\nThis payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. \n\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`." + } + ], + "description": "Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest).", + "x-release-status": "PUBLIC" + }, + "InvoiceCustomField": { + "type": "object", + "description": "An additional seller-defined and customer-facing field to include on the invoice. For more information, \nsee [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", + "x-release-status": "PUBLIC", + "properties": { + "label": { + "type": "string", + "description": "The label or title of the custom field. This field is required for a custom field.", + "maxLength": 30, + "nullable": true + }, + "value": { + "type": "string", + "description": "The text of the custom field. If omitted, only the label is rendered.", + "maxLength": 2000, + "nullable": true + }, + "placement": { + "$ref": "#/components/schemas/InvoiceCustomFieldPlacement", + "description": "The location of the custom field on the invoice. This field is required for a custom field.\nSee [InvoiceCustomFieldPlacement](#type-invoicecustomfieldplacement) for possible values", + "nullable": true + } + } + }, + "InvoiceCustomFieldPlacement": { + "type": "string", + "enum": [ + "ABOVE_LINE_ITEMS", + "BELOW_LINE_ITEMS" + ], + "x-enum-elements": [ + { + "name": "ABOVE_LINE_ITEMS", + "description": "Render the custom field above the invoice line items." + }, + { + "name": "BELOW_LINE_ITEMS", + "description": "Render the custom field below the invoice line items." + } + ], + "description": "Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF \ncopies of the invoice.", + "x-release-status": "PUBLIC" + }, + "InvoiceDeliveryMethod": { + "type": "string", + "enum": [ + "EMAIL", + "SHARE_MANUALLY", + "SMS" + ], + "x-enum-elements": [ + { + "name": "EMAIL", + "description": "Directs Square to send invoices, reminders, and receipts to the customer using email." + }, + { + "name": "SHARE_MANUALLY", + "description": "Directs Square to take no action on the invoice. In this case, the seller\nor application developer follows up with the customer for payment. For example,\na seller might collect a payment in the Seller Dashboard or Point of Sale (POS) application.\nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer to request payment." + }, + { + "name": "SMS", + "description": "Directs Square to send invoices and receipts to the customer using SMS (text message).\n\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`." + } + ], + "description": "Indicates how Square delivers the [invoice](entity:Invoice) to the customer.", + "x-release-status": "PUBLIC" + }, + "InvoiceFilter": { + "type": "object", + "description": "Describes query filters to apply.", + "x-release-status": "PUBLIC", + "required": [ + "location_ids" + ], + "properties": { + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limits the search to the specified locations. A location is required. \nIn the current implementation, only one location can be specified." + }, + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limits the search to the specified customers, within the specified locations. \nSpecifying a customer is optional. In the current implementation, \na maximum of one customer can be specified.", + "nullable": true + } + } + }, + "InvoicePaymentReminder": { + "type": "object", + "description": "Describes a payment request reminder (automatic notification) that Square sends\nto the customer. You configure a reminder relative to the payment request\n`due_date`.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A Square-assigned ID that uniquely identifies the reminder within the\n`InvoicePaymentRequest`.", + "readOnly": true + }, + "relative_scheduled_days": { + "type": "integer", + "description": "The number of days before (a negative number) or after (a positive number)\nthe payment request `due_date` when the reminder is sent. For example, -3 indicates that\nthe reminder should be sent 3 days before the payment request `due_date`.", + "minimum": -32767, + "maximum": 32767, + "nullable": true + }, + "message": { + "type": "string", + "description": "The reminder message.", + "minLength": 1, + "maxLength": 1000, + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/InvoicePaymentReminderStatus", + "description": "The status of the reminder.\nSee [InvoicePaymentReminderStatus](#type-invoicepaymentreminderstatus) for possible values", + "readOnly": true + }, + "sent_at": { + "type": "string", + "description": "If sent, the timestamp when the reminder was sent, in RFC 3339 format.", + "readOnly": true + } + } + }, + "InvoicePaymentReminderStatus": { + "type": "string", + "enum": [ + "PENDING", + "NOT_APPLICABLE", + "SENT" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "The reminder will be sent on the `relative_scheduled_date` (if the invoice is published)." + }, + { + "name": "NOT_APPLICABLE", + "description": "The reminder is not applicable and is not sent. The following are examples\nof when reminders are not applicable and are not sent:\n- You schedule a reminder to be sent before the invoice is published.\n- The invoice is configured with multiple payment requests and a payment request reminder\nis configured to be sent after the next payment request `due_date`.\n- Two reminders (for different payment requests) are configured to be sent on the\nsame date. Therefore, only one reminder is sent.\n- You configure a reminder to be sent on the date that the invoice is scheduled to be sent.\n- The payment request is already paid.\n- The invoice status is `CANCELED` or `FAILED`." + }, + { + "name": "SENT", + "description": "The reminder is sent." + } + ], + "description": "The status of a payment request reminder.", + "x-release-status": "PUBLIC" + }, + "InvoicePaymentRequest": { + "type": "object", + "description": "Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "The Square-generated ID of the payment request in an [invoice](entity:Invoice).", + "minLength": 1, + "maxLength": 255, + "nullable": true + }, + "request_method": { + "$ref": "#/components/schemas/InvoiceRequestMethod", + "description": "Indicates how Square processes the payment request. DEPRECATED at version 2021-01-21. Replaced by the\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.\n\nOne of the following is required when creating an invoice:\n- (Recommended) The `delivery_method` field of the invoice. To configure an automatic payment, the\n`automatic_payment_source` field of the payment request is also required.\n- This `request_method` field. Note that `invoice` objects returned in responses do not include `request_method`.\nSee [InvoiceRequestMethod](#type-invoicerequestmethod) for possible values", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "request_type": { + "$ref": "#/components/schemas/InvoiceRequestType", + "description": "Identifies the payment request type. This type defines how the payment request amount is determined. \nThis field is required to create a payment request.\nSee [InvoiceRequestType](#type-invoicerequesttype) for possible values", + "nullable": true + }, + "due_date": { + "type": "string", + "description": "The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field\nis required to create a payment request. If an `automatic_payment_source` is defined for the request, Square\ncharges the payment source on this date.\n\nAfter this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`\nof America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC\ntimestamp of 2021-03-10T08:00:00Z).", + "nullable": true + }, + "fixed_amount_requested_money": { + "$ref": "#/components/schemas/Money", + "description": "If the payment request specifies `DEPOSIT` or `INSTALLMENT` as the `request_type`, \nthis indicates the request amount.\nYou cannot specify this when `request_type` is `BALANCE` or when the \npayment request includes the `percentage_requested` field.", + "nullable": true + }, + "percentage_requested": { + "type": "string", + "description": "Specifies the amount for the payment request in percentage:\n\n- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount.\n- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less \nthe deposit, if requested. The sum of the `percentage_requested` in all installment \npayment requests must be equal to 100.\n\nYou cannot specify this when the payment `request_type` is `BALANCE` or when the \npayment request specifies the `fixed_amount_requested_money` field.", + "nullable": true + }, + "tipping_enabled": { + "type": "boolean", + "description": "If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) \nprovides a place for the customer to pay a tip. \n\nThis field is allowed only on the final payment request \nand the payment `request_type` must be `BALANCE` or `INSTALLMENT`.", + "nullable": true + }, + "automatic_payment_source": { + "$ref": "#/components/schemas/InvoiceAutomaticPaymentSource", + "description": "The payment method for an automatic payment.\n\nThe default value is `NONE`.\nSee [InvoiceAutomaticPaymentSource](#type-invoiceautomaticpaymentsource) for possible values", + "nullable": true + }, + "card_id": { + "type": "string", + "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.", + "minLength": 1, + "maxLength": 255, + "nullable": true + }, + "reminders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoicePaymentReminder" + }, + "description": "A list of one or more reminders to send for the payment request.", + "nullable": true + }, + "computed_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of the payment request, computed using the order amount and information from the various payment\nrequest fields (`request_type`, `fixed_amount_requested_money`, and `percentage_requested`).", + "readOnly": true + }, + "total_completed_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money already paid for the specific payment request. \nThis amount might include a rounding adjustment if the most recent invoice payment \nwas in cash in a currency that rounds cash payments (such as, `CAD` or `AUD`).", + "readOnly": true + }, + "rounding_adjustment_included_money": { + "$ref": "#/components/schemas/Money", + "description": "If the most recent payment was a cash payment \nin a currency that rounds cash payments (such as, `CAD` or `AUD`) and the payment \nis rounded from `computed_amount_money` in the payment request, then this \nfield specifies the rounding adjustment applied. This amount \nmight be negative.", + "readOnly": true + } + } + }, + "InvoiceQuery": { + "type": "object", + "description": "Describes query criteria for searching invoices.", + "x-release-status": "PUBLIC", + "required": [ + "filter" + ], + "properties": { + "filter": { + "$ref": "#/components/schemas/InvoiceFilter", + "description": "Query filters to apply in searching invoices. \nFor more information, see [Search for invoices](https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices#search-invoices)." + }, + "sort": { + "$ref": "#/components/schemas/InvoiceSort", + "description": "Describes the sort order for the search result.", + "nullable": true + } + } + }, + "InvoiceRecipient": { + "type": "object", + "description": "Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice \nand that Square uses to deliver the invoice.\n\nWhen you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates \nthe remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. \nSquare updates the customer ID in response to a merge operation, but does not update other fields.", + "x-release-status": "PUBLIC", + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the customer. This is the customer profile ID that \nyou provide when creating a draft invoice.", + "minLength": 1, + "maxLength": 255, + "nullable": true + }, + "given_name": { + "type": "string", + "description": "The recipient's given (that is, first) name.", + "readOnly": true + }, + "family_name": { + "type": "string", + "description": "The recipient's family (that is, last) name.", + "readOnly": true + }, + "email_address": { + "type": "string", + "description": "The recipient's email address.", + "readOnly": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The recipient's physical address.", + "readOnly": true + }, + "phone_number": { + "type": "string", + "description": "The recipient's phone number.", + "readOnly": true + }, + "company_name": { + "type": "string", + "description": "The name of the recipient's company.", + "readOnly": true + }, + "tax_ids": { + "$ref": "#/components/schemas/InvoiceRecipientTaxIds", + "description": "The recipient's tax IDs. The country of the seller account determines whether this field \nis available for the customer. For more information, see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).", + "readOnly": true + } + } + }, + "InvoiceRecipientTaxIds": { + "type": "object", + "description": "Represents the tax IDs for an invoice recipient. The country of the seller account determines \nwhether the corresponding `tax_ids` field is available for the customer. For more information, \nsee [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).", + "x-release-status": "PUBLIC", + "properties": { + "eu_vat": { + "type": "string", + "description": "The EU VAT identification number for the invoice recipient. For example, `IE3426675K`.", + "readOnly": true + } + } + }, + "InvoiceRequestMethod": { + "type": "string", + "enum": [ + "EMAIL", + "CHARGE_CARD_ON_FILE", + "SHARE_MANUALLY", + "CHARGE_BANK_ON_FILE", + "SMS", + "SMS_CHARGE_CARD_ON_FILE", + "SMS_CHARGE_BANK_ON_FILE" + ], + "x-enum-elements": [ + { + "name": "EMAIL", + "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](entity:Invoice))." + }, + { + "name": "CHARGE_CARD_ON_FILE", + "description": "Directs Square to charge the card on file on the `due_date` specified in the payment request\nand to use email to send invoices, reminders, and receipts." + }, + { + "name": "SHARE_MANUALLY", + "description": "Directs Square to take no specific action on the invoice. In this case, the seller \n(or the application developer) follows up with the customer for payment. For example, \na seller might collect a payment in the Seller Dashboard or use the Point of Sale (POS) application. \nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer requesting payment." + }, + { + "name": "CHARGE_BANK_ON_FILE", + "description": "Directs Square to charge the customer's bank account on file and to use email to send invoices, reminders, and receipts.\nThe customer must approve the payment.\n\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. You \ncannot set `CHARGE_BANK_ON_FILE` as a request method using the Invoices API." + }, + { + "name": "SMS", + "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](entity:Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." + }, + { + "name": "SMS_CHARGE_CARD_ON_FILE", + "description": "Directs Square to charge the card on file on the `due_date` specified in the payment request and to\nuse SMS (text message) to send invoices and receipts. \n\nYou cannot set `SMS_CHARGE_CARD_ON_FILE` as a request method using the Invoices API." + }, + { + "name": "SMS_CHARGE_BANK_ON_FILE", + "description": "Directs Square to charge the customer's bank account on file and to use SMS (text message) to send invoices and receipts.\nThe customer must approve the payment.\n\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard\nor other Square product. The bank account is provided by the customer during the payment flow. \nYou cannot set `SMS_CHARGE_BANK_ON_FILE` as a request method using the Invoices API." + } + ], + "description": "Specifies the action for Square to take for processing the invoice. For example, \nemail the invoice, charge a customer's card on file, or do nothing. DEPRECATED at\nversion 2021-01-21. The corresponding `request_method` field is replaced by the\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.", + "x-release-status": "DEPRECATED" + }, + "InvoiceRequestType": { + "type": "string", + "enum": [ + "BALANCE", + "DEPOSIT", + "INSTALLMENT" + ], + "x-enum-elements": [ + { + "name": "BALANCE", + "description": "A request for a balance payment. The balance amount is computed as follows: \n\n- If the invoice specifies only a balance payment request, the balance amount is the \ntotal amount of the associated order. \n- If the invoice also specifies a deposit request, the balance amount is the amount \nremaining after the deposit.\n\n`INSTALLMENT` and `BALANCE` payment requests are not allowed in the same invoice." + }, + { + "name": "DEPOSIT", + "description": "A request for a deposit payment. You have the option of specifying \nan exact amount or a percentage of the total order amount. If you request a deposit, \nit must be due before any other payment requests." + }, + { + "name": "INSTALLMENT", + "description": "A request for an installment payment. Installments allow buyers to pay the invoice over time. Installments can optionally be combined with a deposit. \n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)." + } + ], + "description": "Indicates the type of the payment request. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).", + "x-release-status": "PUBLIC" + }, + "InvoiceSort": { + "type": "object", + "description": "Identifies the sort field and sort order.", + "x-release-status": "PUBLIC", + "required": [ + "field" + ], + "properties": { + "field": { + "$ref": "#/components/schemas/InvoiceSortField", + "description": "The field to use for sorting.\nSee [InvoiceSortField](#type-invoicesortfield) for possible values" + }, + "order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order to use for sorting the results.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "InvoiceSortField": { + "type": "string", + "enum": [ + "INVOICE_SORT_DATE" + ], + "x-enum-elements": [ + { + "name": "INVOICE_SORT_DATE", + "description": "The field works as follows:\n\n- If the invoice is a draft, it uses the invoice `created_at` date.\n- If the invoice is scheduled for publication, it uses the `scheduled_at` date.\n- If the invoice is published, it uses the invoice publication date." + } + ], + "description": "The field to use for sorting.", + "x-release-status": "PUBLIC" + }, + "InvoiceStatus": { + "type": "string", + "enum": [ + "DRAFT", + "UNPAID", + "SCHEDULED", + "PARTIALLY_PAID", + "PAID", + "PARTIALLY_REFUNDED", + "REFUNDED", + "CANCELED", + "FAILED", + "PAYMENT_PENDING" + ], + "x-enum-elements": [ + { + "name": "DRAFT", + "description": "The invoice is a draft. You must publish a draft invoice before Square can process it.\nA draft invoice has no `public_url`, so it is not available to customers." + }, + { + "name": "UNPAID", + "description": "The invoice is published but not yet paid." + }, + { + "name": "SCHEDULED", + "description": "The invoice is scheduled to be processed. On the scheduled date,\nSquare sends the invoice, initiates an automatic payment, or takes no action, depending on\nthe delivery method and payment request settings. Square also sets the invoice status to the\nappropriate state: `UNPAID`, `PAID`, `PARTIALLY_PAID`, or `PAYMENT_PENDING`." + }, + { + "name": "PARTIALLY_PAID", + "description": "A partial payment is received for the invoice." + }, + { + "name": "PAID", + "description": "The customer paid the invoice in full." + }, + { + "name": "PARTIALLY_REFUNDED", + "description": "The invoice is paid (or partially paid) and some but not all the amount paid is\nrefunded." + }, + { + "name": "REFUNDED", + "description": "The full amount that the customer paid for the invoice is refunded." + }, + { + "name": "CANCELED", + "description": "The invoice is canceled. Square no longer requests payments from the customer.\nThe Square-hosted payment page is still accessible using the temporary `public_url`\nlink, but the invoice is shown as canceled and does not accept payment." + }, + { + "name": "FAILED", + "description": "Square canceled the invoice due to suspicious activity." + }, + { + "name": "PAYMENT_PENDING", + "description": "A payment on the invoice was initiated but has not yet been processed.\n\nWhen in this state, invoices cannot be updated and other payments cannot be initiated." + } + ], + "description": "Indicates the status of an [invoice](entity:Invoice).", + "x-release-status": "PUBLIC" + }, + "ItemVariationLocationOverrides": { + "type": "object", + "description": "Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.", + "x-release-status": "PUBLIC", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the `Location`. This can include locations that are deactivated.", + "nullable": true + }, + "price_money": { + "$ref": "#/components/schemas/Money", + "description": "The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing.", + "nullable": true + }, + "pricing_type": { + "$ref": "#/components/schemas/CatalogPricingType", + "description": "The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`.\nSee [CatalogPricingType](#type-catalogpricingtype) for possible values", + "nullable": true + }, + "track_inventory": { + "type": "boolean", + "description": "If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.", + "nullable": true + }, + "inventory_alert_type": { + "$ref": "#/components/schemas/InventoryAlertType", + "description": "Indicates whether the `CatalogItemVariation` displays an alert when its inventory\nquantity is less than or equal to its `inventory_alert_threshold`.\nSee [InventoryAlertType](#type-inventoryalerttype) for possible values", + "nullable": true + }, + "inventory_alert_threshold": { + "type": "integer", + "description": "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`\nis `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.\n\nThis value is always an integer.", + "format": "int64", + "nullable": true + }, + "sold_out": { + "type": "boolean", + "description": "Indicates whether the overridden item variation is sold out at the specified location.\n\nWhen inventory tracking is enabled on the item variation either globally or at the specified location,\nthe item variation is automatically marked as sold out when its inventory count reaches zero. The seller\ncan manually set the item variation as sold out even when the inventory count is greater than zero.\nAttempts by an application to set this attribute are ignored. Regardless how the sold-out status is set,\napplications should treat its inventory count as zero when this attribute value is `true`.", + "readOnly": true + }, + "sold_out_valid_until": { + "type": "string", + "description": "The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation\nbecomes available again at the specified location. Attempts by an application to set this attribute are ignored.\nWhen the current time is later than this attribute value, the affected item variation is no longer sold out.", + "readOnly": true + } + } + }, + "Job": { + "type": "object", + "description": "Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the\njob's title and tip eligibility. Compensation is defined in a [job assignment](entity:JobAssignment)\nin a team member's wage setting.", + "x-release-status": "BETA", + "properties": { + "id": { + "type": "string", + "description": "**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request,\ncall [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job.\nYou can also get job IDs from a team member's wage setting." + }, + "title": { + "type": "string", + "description": "The title of the job.", + "maxLength": 150, + "nullable": true + }, + "is_tip_eligible": { + "type": "boolean", + "description": "Indicates whether team members can earn tips for the job.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the job was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the job was last updated, in RFC 3339 format.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable\n[optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)\ncontrol and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't\nmatch the server version at the time of the request." + } + } + }, + "JobAssignment": { + "type": "object", + "description": "Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team\nmember earns for the job. Job assignments are listed in the team member's [wage setting](entity:WageSetting).", + "x-release-status": "PUBLIC", + "required": [ + "pay_type" + ], + "properties": { + "job_title": { + "type": "string", + "description": "The title of the job.", + "nullable": true + }, + "pay_type": { + "$ref": "#/components/schemas/JobAssignmentPayType", + "description": "The current pay type for the job assignment used to\ncalculate the pay amount in a pay period.\nSee [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values" + }, + "hourly_rate": { + "$ref": "#/components/schemas/Money", + "description": "The hourly pay rate of the job. For `SALARY` pay types, Square calculates the hourly rate based on\n`annual_rate` and `weekly_hours`.", + "nullable": true + }, + "annual_rate": { + "$ref": "#/components/schemas/Money", + "description": "The total pay amount for a 12-month period on the job. Set if the job `PayType` is `SALARY`.", + "nullable": true + }, + "weekly_hours": { + "type": "integer", + "description": "The planned hours per week for the job. Set if the job `PayType` is `SALARY`.", + "nullable": true + }, + "job_id": { + "type": "string", + "description": "The ID of the [job](entity:Job).", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "JobAssignmentPayType": { + "type": "string", + "enum": [ + "NONE", + "HOURLY", + "SALARY" + ], + "x-enum-elements": [ + { + "name": "NONE", + "description": "The job does not have a defined pay type." + }, + { + "name": "HOURLY", + "description": "The job pays an hourly rate." + }, + { + "name": "SALARY", + "description": "The job pays an annual salary." + } + ], + "description": "Enumerates the possible pay types that a job can be assigned.", + "x-release-status": "PUBLIC" + }, + "LinkCustomerToGiftCardRequest": { + "type": "object", + "description": "A request to link a customer to a gift card.", + "x-release-status": "PUBLIC", + "x-params-example": "?gift_card_id=gftc:71ea002277a34f8a945e284b04822edb", + "required": [ + "customer_id" + ], + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the customer to link to the gift card.", + "minLength": 1, + "maxLength": 191 + } + }, + "example": { + "customer_id": "GKY0FZ3V717AH8Q2D821PNT2ZW" + } + }, + "LinkCustomerToGiftCardResponse": { + "type": "object", + "description": "A response that contains the linked `GiftCard` object. If the request resulted in errors, \nthe response contains a set of `Error` objects.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "The gift card with the ID of the linked customer listed in the `customer_ids` field." + } + }, + "example": { + "gift_card": { + "balance_money": { + "amount": 2500, + "currency": "USD" + }, + "created_at": "2021-03-25T05:13:01Z", + "customer_ids": [ + "GKY0FZ3V717AH8Q2D821PNT2ZW" + ], + "gan": "7783320005440920", + "gan_source": "SQUARE", + "id": "gftc:71ea002277a34f8a945e284b04822edb", + "state": "ACTIVE", + "type": "DIGITAL" + } + } + }, + "ListBankAccountsRequest": { + "type": "object", + "description": "Request object for fetching all `BankAccount`\nobjects linked to a account.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location.", + "nullable": true + } + } + }, + "ListBankAccountsResponse": { + "type": "object", + "description": "Response object returned by ListBankAccounts.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "bank_accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BankAccount" + }, + "description": "List of BankAccounts associated with this account." + }, + "cursor": { + "type": "string", + "description": "When a response is truncated, it includes a cursor that you can \nuse in a subsequent request to fetch next set of bank accounts.\nIf empty, this is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." + } + }, + "example": { + "bank_accounts": [ + { + "account_number_suffix": "971", + "account_type": "CHECKING", + "bank_name": "Bank Name", + "country": "US", + "creditable": false, + "currency": "USD", + "debitable": false, + "holder_name": "Jane Doe", + "id": "ao6iaQ9vhDiaQD7n3GB", + "location_id": "S8GWD5example", + "primary_bank_identification_number": "112200303", + "status": "VERIFICATION_IN_PROGRESS", + "version": 5 + }, + { + "account_number_suffix": "972", + "account_type": "CHECKING", + "bank_name": "Bank Name", + "country": "US", + "creditable": false, + "currency": "USD", + "debitable": false, + "holder_name": "Jane Doe", + "id": "4x7WXuaxrkQkVlka3GB", + "location_id": "S8GWD5example", + "primary_bank_identification_number": "112200303", + "status": "VERIFICATION_IN_PROGRESS", + "version": 5 + } + ] + } + }, + "ListBookingCustomAttributeDefinitionsRequest": { + "type": "object", + "description": "Represents a [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions) request.", + "x-release-status": "PUBLIC", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + } + } + }, + "ListBookingCustomAttributeDefinitionsResponse": { + "type": "object", + "description": "Represents a [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeDefinition" + }, + "description": "The retrieved custom attribute definitions. If no custom attribute definitions are found,\nSquare returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to provide in your next call to this endpoint to retrieve the next page of\nresults for your original request. This field is present only if the request succeeded and\nadditional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH", + "custom_attribute_definitions": [ + { + "created_at": "2022-11-16T15:27:30Z", + "description": "Update the description as desired.", + "key": "favoriteShampoo", + "name": "Favorite shampoo", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-11-16T15:39:38Z", + "version": 3, + "visibility": "VISIBILITY_READ_ONLY" + }, + { + "created_at": "2022-11-16T15:49:05Z", + "description": "Number of people in the party for dine-in", + "key": "partySize", + "name": "Party size", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-11-16T15:49:05Z", + "version": 1, + "visibility": "VISIBILITY_HIDDEN" + } + ], + "errors": [] + } + }, + "ListBookingCustomAttributesRequest": { + "type": "object", + "description": "Represents a [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) request.", + "x-release-status": "PUBLIC", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "with_definitions": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + } + } + }, + "ListBookingCustomAttributesResponse": { + "type": "object", + "description": "Represents a [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttribute" + }, + "description": "The retrieved custom attributes. If `with_definitions` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field of each custom attribute.\n\nIf no custom attributes are found, Square returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attributes": [ + { + "created_at": "2022-11-16T15:50:27Z", + "key": "favoriteShampoo", + "updated_at": "2022-11-16T15:50:27Z", + "value": "Hydro-Cool", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + }, + { + "created_at": "2022-11-16T15:51:53Z", + "key": "hasShoes", + "updated_at": "2022-11-16T15:51:53Z", + "value": false, + "version": 1, + "visibility": "VISIBILITY_HIDDEN" + } + ], + "errors": [] + } + }, + "ListBookingsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of results per page to return in a paged response.", + "minimum": 1, + "maximum": 10000, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.", + "maxLength": 65536, + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.", + "maxLength": 192, + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.", + "maxLength": 32, + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.", + "maxLength": 32, + "nullable": true + }, + "start_at_min": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.", + "nullable": true + }, + "start_at_max": { + "type": "string", + "description": "The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.", + "nullable": true + } + } + }, + "ListBookingsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "bookings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Booking" + }, + "description": "The list of targeted bookings." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.", + "maxLength": 65536 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "bookings": [ + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "created_at": "2020-10-28T15:47:41Z", + "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M", + "customer_note": "", + "id": "zkras0xv0xwswx", + "location_id": "LEQHH0YY8B42M", + "seller_note": "", + "start_at": "2020-11-26T13:00:00Z", + "status": "ACCEPTED", + "updated_at": "2020-10-28T15:49:25Z", + "version": 1 + } + ], + "cursor": null, + "errors": [] + } + }, + "ListBreakTypesRequest": { + "type": "object", + "description": "A request for a filtered set of `BreakType` objects.", + "x-release-status": "PUBLIC", + "x-params-example": "?location_id=PAA1RJZZKXBFG\u0026limit=2\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED", + "properties": { + "location_id": { + "type": "string", + "description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200.", + "minimum": 1, + "maximum": 200, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pointer to the next page of `BreakType` results to fetch.", + "nullable": true + } + } + }, + "ListBreakTypesResponse": { + "type": "object", + "description": "The response to a request for a set of `BreakType` objects. The response contains\nthe requested `BreakType` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "break_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BreakType" + }, + "description": " A page of `BreakType` results." + }, + "cursor": { + "type": "string", + "description": "The value supplied in the subsequent request to fetch the next page\nof `BreakType` results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "break_types": [ + { + "break_name": "Coffee Break", + "created_at": "2019-01-22T20:47:37Z", + "expected_duration": "PT5M", + "id": "REGS1EQR1TPZ5", + "is_paid": false, + "location_id": "PAA1RJZZKXBFG", + "updated_at": "2019-01-22T20:47:37Z", + "version": 1 + }, + { + "break_name": "Lunch Break", + "created_at": "2019-01-25T19:26:30Z", + "expected_duration": "PT1H", + "id": "92EPDRQKJ5088", + "is_paid": true, + "location_id": "PAA1RJZZKXBFG", + "updated_at": "2019-01-25T19:26:30Z", + "version": 3 + } + ], + "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED" + } + }, + "ListCardsRequest": { + "type": "object", + "description": "Retrieves details for a specific Card. Accessible via\nHTTP requests at GET https://connect.squareup.com/v2/cards", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", + "maxLength": 256, + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "Limit results to cards associated with the customer supplied.\nBy default, all cards owned by the merchant are returned.", + "nullable": true + }, + "include_disabled": { + "type": "boolean", + "description": "Includes disabled cards.\nBy default, all enabled cards owned by the merchant are returned.", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "Limit results to cards associated with the reference_id supplied.", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "Sorts the returned list by when the card was created with the specified order.\nThis field defaults to ASC.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + }, + "example": {} + }, + "ListCardsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListCards](api-endpoint:Cards-ListCards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "cards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Card" + }, + "description": "The requested list of `Card`s." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + } + }, + "example": { + "cards": [ + { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "bin": "411111", + "card_brand": "VISA", + "card_type": "CREDIT", + "cardholder_name": "Amelia Earhart", + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "enabled": true, + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q", + "hsa_fsa": false, + "id": "ccof:uIbfJXhXETSP197M3GB", + "last_4": "1111", + "merchant_id": "6SSW7HV8K2ST5", + "prepaid_type": "NOT_PREPAID", + "reference_id": "user-id-1", + "version": 1 + } + ] + } + }, + "ListCashDrawerShiftEventsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "location_id" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location to list cash drawer shifts for.", + "minLength": 1 + }, + "limit": { + "type": "integer", + "description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max).", + "maximum": 1000, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "Opaque cursor for fetching the next page of results.", + "nullable": true + } + }, + "example": {} + }, + "ListCashDrawerShiftEventsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "Opaque cursor for fetching the next page. Cursor is not present in\nthe last page of results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "cash_drawer_shift_events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CashDrawerShiftEvent" + }, + "description": "All of the events (payments, refunds, etc.) for a cash drawer during\nthe shift." + } + }, + "example": { + "cash_drawer_shift_events": [ + { + "created_at": "2019-11-22T00:43:02.000Z", + "description": "", + "event_money": { + "amount": 100, + "currency": "USD" + }, + "event_type": "CASH_TENDER_PAYMENT", + "id": "9F07DB01-D85A-4B77-88C3-D5C64CEB5155", + "team_member_id": "" + }, + { + "created_at": "2019-11-22T00:43:12.000Z", + "description": "", + "event_money": { + "amount": 250, + "currency": "USD" + }, + "event_type": "CASH_TENDER_PAYMENT", + "id": "B2854CEA-A781-49B3-8F31-C64558231F48", + "team_member_id": "" + }, + { + "created_at": "2019-11-22T00:43:23.000Z", + "description": "", + "event_money": { + "amount": 250, + "currency": "USD" + }, + "event_type": "CASH_TENDER_CANCELLED_PAYMENT", + "id": "B5FB7F72-95CD-44A3-974D-26C41064D042", + "team_member_id": "" + }, + { + "created_at": "2019-11-22T00:43:46.000Z", + "description": "", + "event_money": { + "amount": 100, + "currency": "USD" + }, + "event_type": "CASH_TENDER_REFUND", + "id": "0B425480-8504-40B4-A867-37B23543931B", + "team_member_id": "" + }, + { + "created_at": "2019-11-22T00:44:18.000Z", + "description": "Transfer from another drawer", + "event_money": { + "amount": 10000, + "currency": "USD" + }, + "event_type": "PAID_IN", + "id": "8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE", + "team_member_id": "" + }, + { + "created_at": "2019-11-22T00:44:29.000Z", + "description": "Transfer out to another drawer", + "event_money": { + "amount": 10000, + "currency": "USD" + }, + "event_type": "PAID_OUT", + "id": "D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F", + "team_member_id": "" + } + ] + } + }, + "ListCashDrawerShiftsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "location_id" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location to query for a list of cash drawer shifts.", + "minLength": 1 + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "begin_time": { + "type": "string", + "description": "The inclusive start time of the query on opened_at, in ISO 8601 format.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "The exclusive end date of the query on opened_at, in ISO 8601 format.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max).", + "maximum": 1000, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "Opaque cursor for fetching the next page of results.", + "nullable": true + } + }, + "example": {} + }, + "ListCashDrawerShiftsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "Opaque cursor for fetching the next page of results. Cursor is not\npresent in the last page of results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "cash_drawer_shifts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CashDrawerShiftSummary" + }, + "description": "A collection of CashDrawerShiftSummary objects for shifts that match\nthe query." + } + }, + "example": { + "cash_drawer_shifts": [ + { + "closed_at": "2019-11-22T00:44:49.000Z", + "closed_cash_money": { + "amount": 9970, + "currency": "USD" + }, + "description": "Misplaced some change", + "ended_at": "2019-11-22T00:44:49.000Z", + "expected_cash_money": { + "amount": 10000, + "currency": "USD" + }, + "id": "DCC99978-09A6-4926-849F-300BE9C5793A", + "opened_at": "2019-11-22T00:42:54.000Z", + "opened_cash_money": { + "amount": 10000, + "currency": "USD" + }, + "state": "CLOSED" + } + ] + } + }, + "ListCatalogRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "x-params-example": "?types=category,tax", + "properties": { + "cursor": { + "type": "string", + "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", + "nullable": true + }, + "types": { + "type": "string", + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", + "format": "int64", + "x-release-status": "BETA", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/ListCatalog/ListCatalogRequest.csharp", + "java": "/sdk_samples/Catalog/ListCatalog/ListCatalogRequest.java", + "javascript": "/sdk_samples/Catalog/ListCatalog/ListCatalogRequest.javascript", + "php": "/sdk_samples/Catalog/ListCatalog/ListCatalogRequest.php", + "python": "/sdk_samples/Catalog/ListCatalog/ListCatalogRequest.python", + "ruby": "/sdk_samples/Catalog/ListCatalog/ListCatalogRequest.ruby" + } + }, + "ListCatalogResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset, this is the final response.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "The CatalogObjects returned." + } + }, + "example": { + "objects": [ + { + "category_data": { + "name": "Beverages" + }, + "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3", + "is_deleted": false, + "present_at_all_locations": true, + "type": "CATEGORY", + "updated_at": "2017-02-21T14:50:26.495Z", + "version": 1487688626495 + }, + { + "id": "L5R47DGBZOOVKCAFIXC56AEN", + "is_deleted": false, + "present_at_all_locations": true, + "tax_data": { + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "enabled": true, + "inclusion_type": "ADDITIVE", + "name": "Sales Tax", + "percentage": "5.0" + }, + "type": "TAX", + "updated_at": "2017-02-21T14:50:26.495Z", + "version": 1487688626495 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/ListCatalog/ListCatalogResponse.csharp", + "java": "/sdk_samples/Catalog/ListCatalog/ListCatalogResponse.java", + "javascript": "/sdk_samples/Catalog/ListCatalog/ListCatalogResponse.javascript", + "php": "/sdk_samples/Catalog/ListCatalog/ListCatalogResponse.php", + "python": "/sdk_samples/Catalog/ListCatalog/ListCatalogResponse.python", + "ruby": "/sdk_samples/Catalog/ListCatalog/ListCatalogResponse.ruby" + } + }, + "ListCustomerCustomAttributeDefinitionsRequest": { + "type": "object", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributeDefinitions) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?limit=2", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + } + } + }, + "ListCustomerCustomAttributeDefinitionsResponse": { + "type": "object", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributeDefinitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeDefinition" + }, + "description": "The retrieved custom attribute definitions. If no custom attribute definitions are found,\nSquare returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to provide in your next call to this endpoint to retrieve the next page of\nresults for your original request. This field is present only if the request succeeded and\nadditional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH", + "custom_attribute_definitions": [ + { + "created_at": "2022-04-26T15:27:30Z", + "description": "Update the description as desired.", + "key": "favoritemovie", + "name": "Favorite Movie", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-04-26T15:39:38Z", + "version": 3, + "visibility": "VISIBILITY_READ_ONLY" + }, + { + "created_at": "2022-04-26T15:49:05Z", + "description": "Customer owns movie.", + "key": "ownsmovie", + "name": "Owns Movie", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean" + }, + "updated_at": "2022-04-26T15:49:05Z", + "version": 1, + "visibility": "VISIBILITY_HIDDEN" + } + ] + } + }, + "ListCustomerCustomAttributesRequest": { + "type": "object", + "description": "Represents a [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "with_definitions": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + } + } + }, + "ListCustomerCustomAttributesResponse": { + "type": "object", + "description": "Represents a [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttribute" + }, + "description": "The retrieved custom attributes. If `with_definitions` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field of each custom attribute.\n\nIf no custom attributes are found, Square returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attributes": [ + { + "created_at": "2022-04-26T15:50:27Z", + "key": "favoritemovie", + "updated_at": "2022-04-26T15:50:27Z", + "value": "Dune", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + }, + { + "created_at": "2022-04-26T15:51:53Z", + "key": "ownsmovie", + "updated_at": "2022-04-26T15:51:53Z", + "value": false, + "version": 1, + "visibility": "VISIBILITY_HIDDEN" + } + ] + } + }, + "ListCustomerGroupsRequest": { + "type": "object", + "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](api-endpoint:CustomerGroups-ListCustomerGroups) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 50, + "nullable": true + } + }, + "example": {} + }, + "ListCustomerGroupsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](api-endpoint:CustomerGroups-ListCustomerGroups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "description": "A list of customer groups belonging to the current seller." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint. This value is present only if the request\nsucceeded and additional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "groups": [ + { + "created_at": "2020-04-13T21:54:57.863Z", + "id": "2TAT3CMH4Q0A9M87XJZED0WMR3", + "name": "Loyal Customers", + "updated_at": "2020-04-13T21:54:58Z" + }, + { + "created_at": "2020-04-13T21:55:18.795Z", + "id": "4XMEHESXJBNE9S9JAKZD2FGB14", + "name": "Super Loyal Customers", + "updated_at": "2020-04-13T21:55:19Z" + } + ] + } + }, + "ListCustomerSegmentsRequest": { + "type": "object", + "description": "Defines the valid parameters for requests to the `ListCustomerSegments` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 50, + "nullable": true + } + }, + "example": {} + }, + "ListCustomerSegmentsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body for requests to the `ListCustomerSegments` endpoint.\n\nEither `errors` or `segments` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerSegment" + }, + "description": "The list of customer segments belonging to the associated Square account." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor to be used in subsequent calls to `ListCustomerSegments`\nto retrieve the next set of query results. The cursor is only present if the request succeeded and\nadditional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "segments": [ + { + "created_at": "2020-01-09T19:33:24.469Z", + "id": "GMNXRZVEXNQDF.CHURN_RISK", + "name": "Lapsed", + "updated_at": "2020-04-13T21:47:04Z" + }, + { + "created_at": "2020-01-09T19:33:24.486Z", + "id": "GMNXRZVEXNQDF.LOYAL", + "name": "Regulars", + "updated_at": "2020-04-13T21:47:04Z" + }, + { + "created_at": "2020-01-09T19:33:21.813Z", + "id": "GMNXRZVEXNQDF.REACHABLE", + "name": "Reachable", + "updated_at": "2020-04-13T21:47:04Z" + }, + { + "created_at": "2020-01-09T19:33:25Z", + "id": "gv2:KF92J19VXN5FK30GX2E8HSGQ20", + "name": "Instant Profile", + "updated_at": "2020-04-13T23:01:03Z" + } + ] + } + }, + "ListCustomersRequest": { + "type": "object", + "description": "Defines the query parameters that can be included in a request to the\n`ListCustomers` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "sort_field": { + "$ref": "#/components/schemas/CustomerSortField", + "description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`.\nSee [CustomerSortField](#type-customersortfield) for possible values", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "count": { + "type": "boolean", + "description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`.", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ListCustomers/ListCustomersRequest.csharp", + "java": "/sdk_samples/ListCustomers/ListCustomersRequest.java", + "javascript": "/sdk_samples/ListCustomers/ListCustomersRequest.javascript", + "php": "/sdk_samples/ListCustomers/ListCustomersRequest.php", + "python": "/sdk_samples/ListCustomers/ListCustomersRequest.python", + "ruby": "/sdk_samples/ListCustomers/ListCustomersRequest.ruby" + } + }, + "ListCustomersResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `ListCustomers` endpoint.\n\nEither `errors` or `customers` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + }, + "description": "The customer profiles associated with the Square account or an empty object (`{}`) if none are found.\nOnly customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or\n`phone_number`) are included in the response." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor to retrieve the next set of results for the\noriginal query. A cursor is only present if the request succeeded and additional results\nare available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "count": { + "type": "integer", + "description": "The total count of customers associated with the Square account. Only customer profiles with public information\n(`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present\nonly if `count` is set to `true` in the request.", + "format": "int64" + } + }, + "example": { + "customers": [ + { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2016-03-23T20:21:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "group_ids": [ + "545AXB44B4XXWMVQ4W8SBT3HHF" + ], + "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "note": "a customer", + "phone_number": "+1-212-555-4240", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID", + "segment_ids": [ + "1KB9JE5EGJXCW.REACHABLE" + ], + "updated_at": "2016-03-23T20:21:55Z", + "version": 1 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ListCustomers/ListCustomersResponse.csharp", + "java": "/sdk_samples/ListCustomers/ListCustomersResponse.java", + "javascript": "/sdk_samples/ListCustomers/ListCustomersResponse.javascript", + "php": "/sdk_samples/ListCustomers/ListCustomersResponse.php", + "python": "/sdk_samples/ListCustomers/ListCustomersResponse.python", + "ruby": "/sdk_samples/ListCustomers/ListCustomersResponse.ruby" + } + }, + "ListDeviceCodesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty.", + "nullable": true + }, + "product_type": { + "$ref": "#/components/schemas/ProductType", + "description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty.", + "nullable": true + }, + "status": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceCodeStatus" + }, + "description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.\nSee [DeviceCodeStatus](#type-devicecodestatus) for possible values", + "nullable": true + } + }, + "example": {} + }, + "ListDeviceCodesResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "device_codes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceCode" + }, + "description": "The queried DeviceCode." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint. This value is present only if the request\nsucceeded and additional results are available.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." + } + }, + "example": { + "device_codes": [ + { + "code": "EBCARJ", + "created_at": "2020-02-06T18:44:33.000Z", + "device_id": "907CS13101300122", + "id": "B3Z6NAMYQSMTM", + "location_id": "B5E4484SHHNYH", + "name": "Counter 1", + "pair_by": "2020-02-06T18:49:33.000Z", + "product_type": "TERMINAL_API", + "status": "PAIRED", + "status_changed_at": "2020-02-06T18:47:28.000Z" + }, + { + "code": "GVXNYN", + "created_at": "2020-02-07T19:55:04.000Z", + "id": "YKGMJMYK8H4PQ", + "location_id": "A6SYFRSV4WAFW", + "name": "Unused device code", + "pair_by": "2020-02-07T20:00:04.000Z", + "product_type": "TERMINAL_API", + "status": "UNPAIRED", + "status_changed_at": "2020-02-07T19:55:04.000Z" + } + ] + } + }, + "ListDevicesRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The number of results to return in a single page.", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "location_id": { + "type": "string", + "description": "If present, only returns devices at the target location.", + "nullable": true + } + }, + "example": {} + }, + "ListDevicesResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors that occurred during the request." + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device" + }, + "description": "The requested list of `Device` objects." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + } + }, + "example": { + "cursor": "GcXjlV2iaizH7R0fMT6wUDbw6l4otigjzx8XOOspUKHo9EPLRByM", + "devices": [ + { + "attributes": { + "manufacturer": "Square", + "manufacturers_id": "995CS397A6475287", + "merchant_token": "MLCHNZCBWFDZB", + "model": "T2", + "name": "Square Terminal 995", + "type": "TERMINAL", + "updated_at": "2023-09-29T13:04:56.335762883Z", + "version": "5.41.0085" + }, + "components": [ + { + "application_details": { + "application_type": "TERMINAL_API", + "session_location": "LMN2K7S3RTOU3", + "version": "6.25" + }, + "type": "APPLICATION" + }, + { + "card_reader_details": { + "version": "3.53.70" + }, + "type": "CARD_READER" + }, + { + "battery_details": { + "external_power": "AVAILABLE_CHARGING", + "visible_percent": 5 + }, + "type": "BATTERY" + }, + { + "type": "WIFI", + "wifi_details": { + "active": true, + "ip_address_v4": "10.0.0.7", + "secure_connection": "WPA/WPA2 PSK", + "signal_strength": { + "value": 2 + }, + "ssid": "Staff Network" + } + }, + { + "ethernet_details": { + "active": false + }, + "type": "ETHERNET" + } + ], + "id": "device:995CS397A6475287", + "status": { + "category": "AVAILABLE" + } + }, + { + "attributes": { + "manufacturer": "Square", + "manufacturers_id": "995CS234B5493559", + "merchant_token": "MLCHXZCBWFGDW", + "model": "T2", + "name": "Square Terminal 995", + "type": "TERMINAL", + "updated_at": "2023-09-29T12:39:56.335742073Z", + "version": "5.41.0085" + }, + "components": [ + { + "application_details": { + "application_type": "TERMINAL_API", + "session_location": "LMN2K7S3RTOU3", + "version": "6.25" + }, + "type": "APPLICATION" + }, + { + "card_reader_details": { + "version": "3.53.70" + }, + "type": "CARD_READER" + }, + { + "battery_details": { + "external_power": "AVAILABLE_CHARGING", + "visible_percent": 24 + }, + "type": "BATTERY" + }, + { + "type": "WIFI", + "wifi_details": { + "active": true, + "ip_address_v4": "10.0.0.7", + "secure_connection": "WPA/WPA2 PSK", + "signal_strength": { + "value": 2 + }, + "ssid": "Staff Network" + } + }, + { + "ethernet_details": { + "active": false + }, + "type": "ETHERNET" + } + ], + "id": "device:995CS234B5493559", + "status": { + "category": "NEEDS_ATTENTION" + } + } + ] + } + }, + "ListDisputeEvidenceRequest": { + "type": "object", + "description": "Defines the parameters for a `ListDisputeEvidence` request.", + "x-release-status": "PUBLIC", + "x-params-example": "?dispute_id=bVTprrwk0gygTLZ96VX1oB", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + } + }, + "example": {} + }, + "ListDisputeEvidenceResponse": { + "type": "object", + "description": "Defines the fields in a `ListDisputeEvidence` response.", + "x-release-status": "PUBLIC", + "properties": { + "evidence": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisputeEvidence" + }, + "description": "The list of evidence previously uploaded to the specified dispute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request.\nIf unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "evidence": [ + { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_file": { + "filename": "customer-interaction", + "filetype": "JPG" + }, + "evidence_type": "CARDHOLDER_COMMUNICATION", + "id": "CpfnkwGselCwS8QFvxN6", + "uploaded_at": "2022-05-10T15:57:13.802Z" + }, + { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_file": { + "filename": "", + "filetype": "" + }, + "evidence_type": "REBUTTAL_EXPLANATION", + "id": "TOomLInj6iWmP3N8qfCXrB", + "uploaded_at": "2022-05-18T16:01:10.000Z" + } + ] + } + }, + "ListDisputesRequest": { + "type": "object", + "description": "Defines the request parameters for the `ListDisputes` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisputeState" + }, + "description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes.\nSee [DisputeState](#type-disputestate) for possible values", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations.", + "minLength": 1, + "maxLength": 40, + "nullable": true + } + }, + "example": {} + }, + "ListDisputesResponse": { + "type": "object", + "description": "Defines fields in a `ListDisputes` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "disputes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Dispute" + }, + "description": "The list of disputes." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request.\nIf unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "cursor": "G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG", + "disputes": [ + { + "amount_money": { + "amount": 2500, + "currency": "USD" + }, + "brand_dispute_id": "100000809947", + "card_brand": "VISA", + "created_at": "2022-06-29T18:45:22.265Z", + "disputed_payment": { + "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY" + }, + "due_at": "2022-07-13T00:00:00.000Z", + "id": "XDgyFu7yo1E2S5lQGGpYn", + "location_id": "L1HN3ZMQK64X9", + "reason": "NO_KNOWLEDGE", + "reported_at": "2022-06-29T00:00:00.000Z", + "state": "ACCEPTED", + "updated_at": "2022-07-07T19:14:42.650Z", + "version": 2 + }, + { + "amount_money": { + "amount": 2209, + "currency": "USD" + }, + "brand_dispute_id": "r5Of6YaGT7AdeRaVoAGCJw", + "card_brand": "VISA", + "created_at": "2022-04-29T18:45:22.265Z", + "disputed_payment": { + "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY" + }, + "due_at": "2022-05-13T00:00:00.000Z", + "id": "jLGg7aXC7lvKPr9PISt0T", + "location_id": "18YC4JDH91E1H", + "reason": "NOT_AS_DESCRIBED", + "reported_at": "2022-04-29T00:00:00.000Z", + "state": "EVIDENCE_REQUIRED", + "updated_at": "2022-04-29T18:45:22.265Z", + "version": 1 + } + ] + } + }, + "ListEmployeeWagesRequest": { + "type": "object", + "description": "A request for a set of `EmployeeWage` objects.", + "x-release-status": "DEPRECATED", + "x-params-example": "?employee_id=33fJchumvVdJwxV0H6L9\u0026limit=4\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED", + "properties": { + "employee_id": { + "type": "string", + "description": "Filter the returned wages to only those that are associated with the specified employee.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of `EmployeeWage` results to return per page. The number can range between\n1 and 200. The default is 200.", + "minimum": 1, + "maximum": 200, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pointer to the next page of `EmployeeWage` results to fetch.", + "nullable": true + } + } + }, + "ListEmployeeWagesResponse": { + "type": "object", + "description": "The response to a request for a set of `EmployeeWage` objects. The response contains\na set of `EmployeeWage` objects.", + "x-release-status": "DEPRECATED", + "properties": { + "employee_wages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EmployeeWage" + }, + "description": "A page of `EmployeeWage` results." + }, + "cursor": { + "type": "string", + "description": "The value supplied in the subsequent request to fetch the next page\nof `EmployeeWage` results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED", + "employee_wages": [ + { + "employee_id": "33fJchumvVdJwxV0H6L9", + "hourly_rate": { + "amount": 3250, + "currency": "USD" + }, + "id": "pXS3qCv7BERPnEGedM4S8mhm", + "title": "Manager" + }, + { + "employee_id": "33fJchumvVdJwxV0H6L9", + "hourly_rate": { + "amount": 2600, + "currency": "USD" + }, + "id": "rZduCkzYDUVL3ovh1sQgbue6", + "title": "Cook" + }, + { + "employee_id": "33fJchumvVdJwxV0H6L9", + "hourly_rate": { + "amount": 1600, + "currency": "USD" + }, + "id": "FxLbs5KpPUHa8wyt5ctjubDX", + "title": "Barista" + }, + { + "employee_id": "33fJchumvVdJwxV0H6L9", + "hourly_rate": { + "amount": 1700, + "currency": "USD" + }, + "id": "vD1wCgijMDR3cX5TPnu7VXto", + "title": "Cashier" + } + ] + } + }, + "ListEmployeesRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": { + "location_id": { + "type": "string", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/EmployeeStatus", + "description": "Specifies the EmployeeStatus to filter the employee by.\nSee [EmployeeStatus](#type-employeestatus) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The number of employees to be returned on each page.", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The token required to retrieve the specified page of results.", + "nullable": true + } + } + }, + "ListEmployeesResponse": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": { + "employees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Employee" + } + }, + "cursor": { + "type": "string", + "description": "The token to be used to retrieve the next page of results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + } + }, + "ListEventTypesRequest": { + "type": "object", + "description": "Lists all event types that can be subscribed to.", + "x-release-status": "BETA", + "properties": { + "api_version": { + "type": "string", + "description": "The API version for which to list event types. Setting this field overrides the default version used by the application.", + "nullable": true + } + } + }, + "ListEventTypesResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListEventTypes](api-endpoint:Events-ListEventTypes) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "event_types": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of event types." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventTypeMetadata" + }, + "description": "Contains the metadata of an event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata)." + } + }, + "example": { + "event_types": [ + "inventory.count.updated" + ], + "metadata": [ + { + "api_version_introduced": "2018-07-12", + "event_type": "inventory.count.updated", + "release_status": "PUBLIC" + } + ] + } + }, + "ListGiftCardActivitiesRequest": { + "type": "object", + "description": "Returns a list of gift card activities. You can optionally specify a filter to retrieve a\nsubset of activites.", + "x-release-status": "PUBLIC", + "properties": { + "gift_card_id": { + "type": "string", + "description": "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller.", + "maxLength": 50, + "nullable": true + }, + "type": { + "type": "string", + "description": "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations.", + "nullable": true + }, + "begin_time": { + "type": "string", + "description": "The timestamp for the beginning of the reporting period, in RFC 3339 format.\nThis start time is inclusive. The default value is the current time minus one year.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "The timestamp for the end of the reporting period, in RFC 3339 format.\nThis end time is inclusive. The default value is the current time.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "nullable": true + }, + "sort_order": { + "type": "string", + "description": "The order in which the endpoint returns the activities, based on `created_at`.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "nullable": true + } + }, + "example": {} + }, + "ListGiftCardActivitiesResponse": { + "type": "object", + "description": "A response that contains a list of `GiftCardActivity` objects. If the request resulted in errors, \nthe response contains a set of `Error` objects.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card_activities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GiftCardActivity" + }, + "description": "The requested gift card activities or an empty object if none are found." + }, + "cursor": { + "type": "string", + "description": "When a response is truncated, it includes a cursor that you can use in a\nsubsequent request to retrieve the next set of activities. If a cursor is not present, this is\nthe final response.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." + } + }, + "example": { + "gift_card_activities": [ + { + "created_at": "2021-06-02T22:26:38.000Z", + "gift_card_balance_money": { + "amount": 700, + "currency": "USD" + }, + "gift_card_gan": "7783320002929081", + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "id": "gcact_897698f894b44b3db46c6147e26a0e19", + "location_id": "81FN9BNFZTKS4", + "payment_id": "dEv2eksNPy6GqdYiLe4ZBNk6HqXZY", + "redeem_activity_details": { + "amount_money": { + "amount": 300, + "currency": "USD" + } + }, + "status": "COMPLETED", + "type": "REDEEM" + }, + { + "activate_activity_details": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", + "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gift_card_balance_money": { + "amount": 1000, + "currency": "USD" + }, + "gift_card_gan": "7783320002929081", + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "id": "gcact_b968ebfc7d46437b945be7b9e09123b4", + "location_id": "81FN9BNFZTKS4", + "type": "ACTIVATE" + } + ] + } + }, + "ListGiftCardsRequest": { + "type": "object", + "description": "A request to list gift cards. You can optionally specify a filter to retrieve a subset of \ngift cards.", + "x-release-status": "PUBLIC", + "x-params-example": "?type=DIGITAL\u0026state=ACTIVE\u0026cursor=Jj0rA9-rrDW5k-PsorOq-m4BiGf", + "properties": { + "type": { + "type": "string", + "description": "If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", + "nullable": true + }, + "state": { + "type": "string", + "description": "If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "If a limit is provided, the endpoint returns only the specified number of results per page.\nThe maximum value is 200. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minimum": 1, + "maximum": 200, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.", + "maxLength": 191, + "nullable": true + } + } + }, + "ListGiftCardsResponse": { + "type": "object", + "description": "A response that contains a list of `GiftCard` objects. If the request resulted in errors, \nthe response contains a set of `Error` objects.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_cards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GiftCard" + }, + "description": "The requested gift cards or an empty object if none are found." + }, + "cursor": { + "type": "string", + "description": "When a response is truncated, it includes a cursor that you can use in a\nsubsequent request to retrieve the next set of gift cards. If a cursor is not present, this is\nthe final response.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." + } + }, + "example": { + "cursor": "JbFmyvUpaNKsfC1hoLSA4WlqkgkZXTWeKuStajR5BkP7OE0ETAbeWSi6U6u7sH", + "gift_cards": [ + { + "balance_money": { + "amount": 3900, + "currency": "USD" + }, + "created_at": "2021-06-09T22:26:54.000Z", + "gan": "7783320008524605", + "gan_source": "SQUARE", + "id": "gftc:00113070ba5745f0b2377c1b9570cb03", + "state": "ACTIVE", + "type": "DIGITAL" + }, + { + "balance_money": { + "amount": 2000, + "currency": "USD" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gan": "7783320002692465", + "gan_source": "SQUARE", + "id": "gftc:00128a12725b41e58e0de1d20497a9dd", + "state": "ACTIVE", + "type": "DIGITAL" + } + ] + } + }, + "ListInvoicesRequest": { + "type": "object", + "description": "Describes a `ListInvoice` request.", + "x-release-status": "PUBLIC", + "x-params-example": "?location_id=ES0RJRZYEC39A\u0026limit=2", + "required": [ + "location_id" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location for which to list invoices.", + "minLength": 1, + "maxLength": 255 + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices.", + "nullable": true + } + } + }, + "ListInvoicesResponse": { + "type": "object", + "description": "Describes a `ListInvoice` response.", + "x-release-status": "PUBLIC", + "properties": { + "invoices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invoice" + }, + "description": "The invoices retrieved." + }, + "cursor": { + "type": "string", + "description": "When a response is truncated, it includes a cursor that you can use in a \nsubsequent request to retrieve the next set of invoices. If empty, this is the final \nresponse. \nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "cursor": "ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE", + "invoices": [ + { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "attachments": [ + { + "description": "Service contract", + "filename": "file.jpg", + "filesize": 102705, + "hash": "273ee02cb6f5f8a3a8ca23604930dd53", + "id": "inva:0-3bB9ZuDHiziThQhuC4fwWt", + "mime_type": "image/jpeg", + "uploaded_at": "2030-01-13T21:24:10Z" + } + ], + "created_at": "2030-01-13T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1, + "status": "PENDING", + "uid": "beebd363-e47f-4075-8785-c235aaa7df11" + } + ], + "request_type": "BALANCE", + "tipping_enabled": true, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "DRAFT", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2030-01-13T21:24:10Z", + "version": 1 + }, + { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": true + }, + "created_at": "2021-01-23T15:29:12Z", + "delivery_method": "EMAIL", + "id": "inv:0-ChC366qAfskpGrBI_1bozs9mEA3", + "invoice_number": "inv-455", + "location_id": "ES0RJRZYEC39A", + "next_payment_amount_money": { + "amount": 3000, + "currency": "USD" + }, + "order_id": "a65jnS8NXbfprvGJzY9F4fQTuaB", + "payment_requests": [ + { + "automatic_payment_source": "CARD_ON_FILE", + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "computed_amount_money": { + "amount": 1000, + "currency": "USD" + }, + "due_date": "2021-01-23", + "percentage_requested": "25", + "request_type": "DEPOSIT", + "tipping_enabled": false, + "total_completed_amount_money": { + "amount": 1000, + "currency": "USD" + }, + "uid": "66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176" + }, + { + "automatic_payment_source": "CARD_ON_FILE", + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "computed_amount_money": { + "amount": 3000, + "currency": "USD" + }, + "due_date": "2021-06-15", + "request_type": "BALANCE", + "tipping_enabled": false, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "120c5e18-4f80-4f6b-b159-774cb9bf8f99" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "public_url": "https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9", + "sale_or_service_date": "2030-01-24", + "status": "PARTIALLY_PAID", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "updated_at": "2021-01-23T15:29:56Z", + "version": 3 + } + ] + } + }, + "ListJobsRequest": { + "type": "object", + "description": "Represents a [ListJobs](api-endpoint:Team-ListJobs) request.", + "x-release-status": "BETA", + "properties": { + "cursor": { + "type": "string", + "description": "The pagination cursor returned by the previous call to this endpoint. Provide this\ncursor to retrieve the next page of results for your original request. For more information,\nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + } + }, + "example": {} + }, + "ListJobsResponse": { + "type": "object", + "description": "Represents a [ListJobs](api-endpoint:Team-ListJobs) response. Either `jobs` or `errors`\nis present in the response. If additional results are available, the `cursor` field is also present.", + "x-release-status": "BETA", + "properties": { + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Job" + }, + "description": "The retrieved jobs. A single paged response contains up to 100 jobs." + }, + "cursor": { + "type": "string", + "description": "An opaque cursor used to retrieve the next page of results. This field is present only\nif the request succeeded and additional results are available. For more information, see\n[Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "jobs": [ + { + "created_at": "2021-06-11T22:55:45Z", + "id": "VDNpRv8da51NU8qZFC5zDWpF", + "is_tip_eligible": true, + "title": "Cashier", + "updated_at": "2021-06-11T22:55:45Z", + "version": 2 + }, + { + "created_at": "2021-06-11T22:55:45Z", + "id": "FjS8x95cqHiMenw4f1NAUH4P", + "is_tip_eligible": false, + "title": "Chef", + "updated_at": "2021-06-11T22:55:45Z", + "version": 1 + } + ] + } + }, + "ListLocationBookingProfilesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a paged response.", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.", + "maxLength": 65536, + "nullable": true + } + } + }, + "ListLocationBookingProfilesResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "location_booking_profiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocationBookingProfile" + }, + "description": "The list of a seller's location booking profiles." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "errors": [], + "location_booking_profiles": [ + { + "booking_site_url": "https://squareup.com/book/LY6WNBPVM6VGV/testbusiness", + "location_id": "LY6WNBPVM6VGV", + "online_booking_enabled": true + }, + { + "location_id": "PYTRNBPVMJUPV", + "online_booking_enabled": false + } + ] + } + }, + "ListLocationCustomAttributeDefinitionsRequest": { + "type": "object", + "description": "Represents a [ListLocationCustomAttributeDefinitions](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributeDefinitions) request.", + "x-release-status": "BETA", + "x-params-example": "?limit=2", + "properties": { + "visibility_filter": { + "$ref": "#/components/schemas/VisibilityFilter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.\nSee [VisibilityFilter](#type-visibilityfilter) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + } + } + }, + "ListLocationCustomAttributeDefinitionsResponse": { + "type": "object", + "description": "Represents a [ListLocationCustomAttributeDefinitions](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributeDefinitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeDefinition" + }, + "description": "The retrieved custom attribute definitions. If no custom attribute definitions are found,\nSquare returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to provide in your next call to this endpoint to retrieve the next page of\nresults for your original request. This field is present only if the request succeeded and\nadditional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH", + "custom_attribute_definitions": [ + { + "created_at": "2022-12-02T19:50:21.832Z", + "description": "Location's phone number", + "key": "phone-number", + "name": "phone number", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.PhoneNumber" + }, + "updated_at": "2022-12-02T19:50:21.832Z", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + }, + { + "created_at": "2022-12-02T19:06:36.559Z", + "description": "Bestselling item at location", + "key": "bestseller", + "name": "Bestseller", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-12-03T10:17:52.341Z", + "version": 4, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + ] + } + }, + "ListLocationCustomAttributesRequest": { + "type": "object", + "description": "Represents a [ListLocationCustomAttributes](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributes) request.", + "x-release-status": "BETA", + "x-params-example": "?location_id=L0TBCBTB7P8RQ", + "properties": { + "visibility_filter": { + "$ref": "#/components/schemas/VisibilityFilter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.\nSee [VisibilityFilter](#type-visibilityfilter) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "with_definitions": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + } + } + }, + "ListLocationCustomAttributesResponse": { + "type": "object", + "description": "Represents a [ListLocationCustomAttributes](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "x-release-status": "BETA", + "properties": { + "custom_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttribute" + }, + "description": "The retrieved custom attributes. If `with_definitions` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field of each custom attribute.\nIf no custom attributes are found, Square returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attributes": [ + { + "created_at": "2022-12-12T18:13:03.745Z", + "key": "phone-number", + "updated_at": "2022-12-12T18:13:03.745Z", + "value": "+12223334444", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + { + "created_at": "2022-12-12T19:27:57.975Z", + "key": "bestseller", + "updated_at": "2022-12-12T19:27:57.975Z", + "value": "hot cocoa", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + ] + } + }, + "ListLocationsRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the\n[ListLocations](api-endpoint:Locations-ListLocations) endpoint.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "ListLocationsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](api-endpoint:Locations-ListLocations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "locations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Location" + }, + "description": "The business locations." + } + }, + "example": { + "locations": [ + { + "address": { + "address_line_1": "123 Main St", + "administrative_district_level_1": "CA", + "country": "US", + "locality": "San Francisco", + "postal_code": "94114" + }, + "business_name": "Jet Fuel Coffee", + "capabilities": [ + "CREDIT_CARD_PROCESSING" + ], + "country": "US", + "created_at": "2016-09-19T17:33:12Z", + "currency": "USD", + "id": "18YC4JDH91E1H", + "language_code": "en-US", + "merchant_id": "3MYCJG5GVYQ8Q", + "name": "Grant Park", + "phone_number": "+1 650-354-7217", + "status": "ACTIVE", + "timezone": "America/Los_Angeles" + }, + { + "address": { + "address_line_1": "1234 Peachtree St. NE", + "administrative_district_level_1": "GA", + "locality": "Atlanta", + "postal_code": "30309" + }, + "business_name": "Jet Fuel Coffee", + "capabilities": [ + "CREDIT_CARD_PROCESSING" + ], + "coordinates": { + "latitude": 33.7889, + "longitude": -84.3841 + }, + "country": "US", + "created_at": "2022-02-19T17:58:25Z", + "currency": "USD", + "description": "Midtown Atlanta store", + "id": "3Z4V4WHQK64X9", + "language_code": "en-US", + "mcc": "7299", + "merchant_id": "3MYCJG5GVYQ8Q", + "name": "Midtown", + "status": "ACTIVE", + "timezone": "America/New_York", + "type": "PHYSICAL" + } + ] + } + }, + "ListLoyaltyProgramsRequest": { + "type": "object", + "description": "A request to list `LoyaltyProgram`.", + "x-release-status": "DEPRECATED", + "properties": {}, + "example": {} + }, + "ListLoyaltyProgramsResponse": { + "type": "object", + "description": "A response that contains all loyalty programs.", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "programs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyProgram" + }, + "description": "A list of `LoyaltyProgram` for the merchant." + } + }, + "example": { + "programs": [ + { + "accrual_rules": [ + { + "accrual_type": "SPEND", + "points": 1, + "spend_data": { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "excluded_category_ids": [ + "7ZERJKO5PVYXCVUHV2JCZ2UG", + "FQKAOJE5C4FIMF5A2URMLW6V" + ], + "excluded_item_variation_ids": [ + "CBZXBUVVTYUBZGQO44RHMR6B", + "EDILT24Z2NISEXDKGY6HP7XV" + ], + "tax_mode": "BEFORE_TAX" + } + } + ], + "created_at": "2020-04-20T16:55:11Z", + "id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "location_ids": [ + "P034NEENMD09F" + ], + "reward_tiers": [ + { + "created_at": "2020-04-20T16:55:11Z", + "definition": { + "discount_type": "FIXED_PERCENTAGE", + "percentage_discount": "10", + "scope": "ORDER" + }, + "id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "name": "10% off entire sale", + "points": 10, + "pricing_rule_reference": { + "catalog_version": "1605486402527", + "object_id": "74C4JSHESNLTB2A7ITO5HO6F" + } + } + ], + "status": "ACTIVE", + "terminology": { + "one": "Point", + "other": "Points" + }, + "updated_at": "2020-05-01T02:00:02Z" + } + ] + } + }, + "ListLoyaltyPromotionsRequest": { + "type": "object", + "description": "Represents a [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd", + "properties": { + "status": { + "$ref": "#/components/schemas/LoyaltyPromotionStatus", + "description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned.\nSee [LoyaltyPromotionStatus](#type-loyaltypromotionstatus) for possible values", + "readOnly": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 30, + "nullable": true + } + }, + "example": {} + }, + "ListLoyaltyPromotionsResponse": { + "type": "object", + "description": "Represents a [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyPromotion" + }, + "description": "The retrieved loyalty promotions." + }, + "cursor": { + "type": "string", + "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "loyalty_promotions": [ + { + "available_time": { + "start_date": "2022-08-16", + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "created_at": "2022-08-16T08:38:54Z", + "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67", + "incentive": { + "points_multiplier_data": { + "multiplier": "3.000", + "points_multiplier": 3 + }, + "type": "POINTS_MULTIPLIER" + }, + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "name": "Tuesday Happy Hour Promo", + "qualifying_item_variation_ids": [ + "CJ3RYL56ITAKMD4VRCM7XERS", + "AT3RYLR3TUA9C34VRCB7X5RR" + ], + "status": "ACTIVE", + "trigger_limit": { + "interval": "DAY", + "times": 1 + }, + "updated_at": "2022-08-16T08:38:54Z" + }, + { + "available_time": { + "end_date": "2022-08-01", + "start_date": "2022-07-01", + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220704T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=MO\nEND:VEVENT", + "BEGIN:VEVENT\nDTSTART:20220705T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TU\nEND:VEVENT", + "BEGIN:VEVENT\nDTSTART:20220706T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=WE\nEND:VEVENT", + "BEGIN:VEVENT\nDTSTART:20220707T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TH\nEND:VEVENT", + "BEGIN:VEVENT\nDTSTART:20220701T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=FR\nEND:VEVENT" + ] + }, + "created_at": "2022-06-27T15:37:38Z", + "id": "loypromo_e696f057-2286-35ff-8108-132241328106", + "incentive": { + "points_multiplier_data": { + "multiplier": "2.000", + "points_multiplier": 2 + }, + "type": "POINTS_MULTIPLIER" + }, + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "minimum_spend_amount_money": { + "amount": 2000, + "currency": "USD" + }, + "name": "July Special", + "qualifying_category_ids": [ + "XTQPYLR3IIU9C44VRCB3XD12" + ], + "status": "ENDED", + "trigger_limit": { + "interval": "ALL_TIME", + "times": 5 + }, + "updated_at": "2022-06-27T15:37:38Z" + } + ] + } + }, + "ListMerchantCustomAttributeDefinitionsRequest": { + "type": "object", + "description": "Represents a [ListMerchantCustomAttributeDefinitions](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributeDefinitions) request.", + "x-release-status": "BETA", + "x-params-example": "?limit=2", + "properties": { + "visibility_filter": { + "$ref": "#/components/schemas/VisibilityFilter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.\nSee [VisibilityFilter](#type-visibilityfilter) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + } + } + }, + "ListMerchantCustomAttributeDefinitionsResponse": { + "type": "object", + "description": "Represents a [ListMerchantCustomAttributeDefinitions](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributeDefinitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeDefinition" + }, + "description": "The retrieved custom attribute definitions. If no custom attribute definitions are found,\nSquare returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to provide in your next call to this endpoint to retrieve the next page of\nresults for your original request. This field is present only if the request succeeded and\nadditional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH", + "custom_attribute_definitions": [ + { + "created_at": "2023-05-05T16:50:21.832Z", + "description": "Whether the merchant has seen the tutorial screen for using the app.", + "key": "has_seen_tutorial", + "name": "NAME", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean" + }, + "updated_at": "2023-05-05T16:50:21.832Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + { + "created_at": "2023-05-05T19:06:36.559Z", + "description": "This is the other name this merchant goes by.", + "key": "alternative_seller_name", + "name": "Alternative Merchant Name", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2023-05-05T10:17:52.341Z", + "version": 4, + "visibility": "VISIBILITY_READ_ONLY" + } + ] + } + }, + "ListMerchantCustomAttributesRequest": { + "type": "object", + "description": "Represents a [ListMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributes) request.", + "x-release-status": "BETA", + "x-params-example": "?merchant_id=DM7VKY8Q63GNP", + "properties": { + "visibility_filter": { + "$ref": "#/components/schemas/VisibilityFilter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.\nSee [VisibilityFilter](#type-visibilityfilter) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "with_definitions": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + } + } + }, + "ListMerchantCustomAttributesResponse": { + "type": "object", + "description": "Represents a [ListMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "x-release-status": "BETA", + "properties": { + "custom_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttribute" + }, + "description": "The retrieved custom attributes. If `with_definitions` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field of each custom attribute.\nIf no custom attributes are found, Square returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attributes": [ + { + "created_at": "2023-05-05T18:13:03.745Z", + "key": "has_seen_tutorial", + "updated_at": "2023-05-05T18:13:03.745Z", + "value": true, + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + { + "created_at": "2023-05-05T19:27:57.975Z", + "key": "alternative_seller_name", + "updated_at": "2023-05-05T19:27:57.975Z", + "value": "Ultimate Sneaker Store", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + } + ] + } + }, + "ListMerchantsRequest": { + "type": "object", + "description": "Request object for the [ListMerchant](api-endpoint:Merchants-ListMerchants) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "integer", + "description": "The cursor generated by the previous response.", + "nullable": true + } + } + }, + "ListMerchantsResponse": { + "type": "object", + "description": "The response object returned by the [ListMerchant](api-endpoint:Merchants-ListMerchants) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "merchant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Merchant" + }, + "description": "The requested `Merchant` entities." + }, + "cursor": { + "type": "integer", + "description": "If the response is truncated, the cursor to use in next request to fetch next set of objects." + } + }, + "example": { + "merchant": [ + { + "business_name": "Apple A Day", + "country": "US", + "created_at": "2021-12-10T19:25:52.484Z", + "currency": "USD", + "id": "DM7VKY8Q63GNP", + "language_code": "en-US", + "main_location_id": "9A65CGC72ZQG1", + "status": "ACTIVE" + } + ] + } + }, + "ListOrderCustomAttributeDefinitionsRequest": { + "type": "object", + "description": "Represents a list request for order custom attribute definitions.", + "x-release-status": "BETA", + "x-params-example": "?limit=4", + "properties": { + "visibility_filter": { + "$ref": "#/components/schemas/VisibilityFilter", + "description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write.\nSee [VisibilityFilter](#type-visibilityfilter) for possible values", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minLength": 1, + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + } + } + }, + "ListOrderCustomAttributeDefinitionsResponse": { + "type": "object", + "description": "Represents a response from listing order custom attribute definitions.", + "x-release-status": "BETA", + "required": [ + "custom_attribute_definitions" + ], + "properties": { + "custom_attribute_definitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeDefinition" + }, + "description": "The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. \nThis field is present only if the request succeeded and additional results are available.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minLength": 1 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definitions": [ + { + "created_at": "2022-11-16T18:03:44.051Z", + "description": "The number of people seated at a table", + "key": "cover-count", + "name": "Cover count", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-11-16T18:03:44.051Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + { + "created_at": "2022-11-16T18:04:32.059Z", + "description": "The identifier for a particular seat", + "key": "seat-number", + "name": "Seat number", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-11-16T18:04:32.059Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + { + "created_at": "2022-11-16T18:04:21.912Z", + "description": "The identifier for a particular table", + "key": "table-number", + "name": "Table number", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-11-16T18:04:21.912Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + ] + } + }, + "ListOrderCustomAttributesRequest": { + "type": "object", + "description": "Represents a list request for order custom attributes.", + "x-release-status": "BETA", + "x-params-example": "?order_id=7BbXGEIWNldxAzrtGf9GPVZTwZ4F\u0026with_definitions=true\u0026visibility_filter=ALL\u0026limit=4", + "properties": { + "visibility_filter": { + "$ref": "#/components/schemas/VisibilityFilter", + "description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write.\nSee [VisibilityFilter](#type-visibilityfilter) for possible values", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minLength": 1, + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "with_definitions": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "nullable": true + } + } + }, + "ListOrderCustomAttributesResponse": { + "type": "object", + "description": "Represents a response from listing order custom attributes.", + "x-release-status": "BETA", + "properties": { + "custom_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttribute" + }, + "description": "The retrieved custom attributes. If no custom attribute are found, Square returns an empty object (`{}`)." + }, + "cursor": { + "type": "string", + "description": "The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. \nThis field is present only if the request succeeded and additional results are available.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "minLength": 1 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attributes": [ + { + "created_at": "2022-11-10T17:31:36.111Z", + "key": "wayne-test-15", + "updated_at": "2022-11-10T17:31:36.111Z", + "value": "TEST", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + ] + } + }, + "ListPaymentLinksRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "A limit on the number of results to return per page. The limit is advisory and\nthe implementation might return more or less results. If the supplied limit is negative, zero, or\ngreater than the maximum limit of 1000, it is ignored.\n\nDefault value: `100`", + "nullable": true + } + } + }, + "ListPaymentLinksResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + }, + "payment_links": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentLink" + }, + "description": "The list of payment links." + }, + "cursor": { + "type": "string", + "description": " When a response is truncated, it includes a cursor that you can use in a subsequent request\nto retrieve the next set of gift cards. If a cursor is not present, this is the final response.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "cursor": "MTY1NQ==", + "payment_links": [ + { + "checkout_options": { + "ask_for_shipping_address": true + }, + "created_at": "2022-04-26T00:15:15Z", + "id": "TN4BWEDJ9AI5MBIV", + "order_id": "Qqc6yppGvxVwc46Cch4zHTaJqc4F", + "payment_note": "test", + "updated_at": "2022-04-26T00:18:24Z", + "url": "https://square.link/u/EXAMPLE", + "version": 2 + }, + { + "created_at": "2022-04-11T23:14:59Z", + "description": "", + "id": "RY5UNCUMPJN5XKCT", + "order_id": "EmBmGt3zJD15QeO1dxzBTxMxtwfZY", + "url": "https://square.link/u/EXAMPLE", + "version": 1 + } + ] + } + }, + "ListPaymentRefundsRequest": { + "type": "object", + "description": "Describes a request to list refunds using\n[ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds).\n\nThe maximum results per page is 100.", + "x-release-status": "PUBLIC", + "properties": { + "begin_time": { + "type": "string", + "description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`. \n\nDefault: The current time minus one year.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`.\n\nDefault: The current time.", + "nullable": true + }, + "sort_order": { + "type": "string", + "description": "The order in which results are listed by `PaymentRefund.created_at`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "Limit results to the location supplied. By default, results are returned\nfor all locations associated with the seller.", + "nullable": true + }, + "status": { + "type": "string", + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](entity:PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", + "nullable": true + }, + "source_type": { + "type": "string", + "description": "If provided, only returns refunds whose payments have the indicated source type.\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.\nFor information about these payment source types, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).\n\nDefault: If omitted, refunds are returned regardless of the source type.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100", + "nullable": true + }, + "updated_at_begin_time": { + "type": "string", + "description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: If omitted, the time range starts at `begin_time`.", + "nullable": true + }, + "updated_at_end_time": { + "type": "string", + "description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: The current time.", + "nullable": true + }, + "sort_field": { + "$ref": "#/components/schemas/ListPaymentRefundsRequestSortField", + "description": "The field used to sort results by. The default is `CREATED_AT`.\nSee [SortField](#type-sortfield) for possible values", + "nullable": true + } + }, + "example": {} + }, + "ListPaymentRefundsRequestSortField": { + "type": "string", + "enum": [ + "CREATED_AT", + "UPDATED_AT" + ], + "x-enum-elements": [ + { + "name": "CREATED_AT", + "description": "" + }, + { + "name": "UPDATED_AT", + "description": "" + } + ], + "x-release-status": "PUBLIC" + }, + "ListPaymentRefundsResponse": { + "type": "object", + "description": "Defines the response returned by [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentRefund" + }, + "description": "The list of requested refunds." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "cursor": "5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb", + "refunds": [ + { + "amount_money": { + "amount": 555, + "currency": "USD" + }, + "created_at": "2021-10-13T19:59:05.342Z", + "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd", + "location_id": "L88917AVBK2S5", + "order_id": "9ltv0bx5PuvGXUYHYHxYSKEqC3IZY", + "payment_id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "processing_fee": [ + { + "amount_money": { + "amount": -34, + "currency": "USD" + }, + "effective_at": "2021-10-13T21:34:35.000Z", + "type": "INITIAL" + } + ], + "reason": "Example Refund", + "status": "COMPLETED", + "updated_at": "2021-10-13T20:00:03.497Z" + } + ] + } + }, + "ListPaymentsRequest": { + "type": "object", + "description": "Describes a request to list payments using \n[ListPayments](api-endpoint:Payments-ListPayments). \n\nThe maximum results per page is 100.", + "x-release-status": "PUBLIC", + "properties": { + "begin_time": { + "type": "string", + "description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. \nThe range is determined using the `created_at` field for each Payment.\nInclusive. Default: The current time minus one year.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The \nrange is determined using the `created_at` field for each Payment.\n\nDefault: The current time.", + "nullable": true + }, + "sort_order": { + "type": "string", + "description": "The order in which results are listed by `ListPaymentsRequest.sort_field`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "Limit results to the location supplied. By default, results are returned\nfor the default (main) location associated with the seller.", + "nullable": true + }, + "total": { + "type": "integer", + "description": "The exact amount in the `total_money` for a payment.", + "format": "int64", + "nullable": true + }, + "last_4": { + "type": "string", + "description": "The last four digits of a payment card.", + "nullable": true + }, + "card_brand": { + "type": "string", + "description": "The brand of the payment card (for example, VISA).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`", + "nullable": true + }, + "is_offline_payment": { + "type": "boolean", + "description": "Whether the payment was taken offline or not.", + "nullable": true + }, + "offline_begin_time": { + "type": "string", + "description": "Indicates the start of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time.", + "nullable": true + }, + "offline_end_time": { + "type": "string", + "description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time.", + "nullable": true + }, + "updated_at_begin_time": { + "type": "string", + "description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment.", + "nullable": true + }, + "updated_at_end_time": { + "type": "string", + "description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment.", + "nullable": true + }, + "sort_field": { + "$ref": "#/components/schemas/ListPaymentsRequestSortField", + "description": "The field used to sort results by. The default is `CREATED_AT`.\nSee [SortField](#type-sortfield) for possible values", + "nullable": true + } + }, + "example": {} + }, + "ListPaymentsRequestSortField": { + "type": "string", + "enum": [ + "CREATED_AT", + "OFFLINE_CREATED_AT", + "UPDATED_AT" + ], + "x-enum-elements": [ + { + "name": "CREATED_AT", + "description": "" + }, + { + "name": "OFFLINE_CREATED_AT", + "description": "" + }, + { + "name": "UPDATED_AT", + "description": "" + } + ], + "x-release-status": "PUBLIC" + }, + "ListPaymentsResponse": { + "type": "object", + "description": "Defines the response returned by [ListPayments](api-endpoint:Payments-ListPayments).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "payments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Payment" + }, + "description": "The requested list of payments." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "payments": [ + { + "amount_money": { + "amount": 555, + "currency": "USD" + }, + "application_details": { + "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA", + "square_product": "VIRTUAL_TERMINAL" + }, + "approved_money": { + "amount": 555, + "currency": "USD" + }, + "card_details": { + "auth_result_code": "2Nkw7q", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2021-10-13T19:34:33.680Z", + "captured_at": "2021-10-13T19:34:34.340Z" + }, + "cvv_status": "CVV_ACCEPTED", + "entry_method": "KEYED", + "statement_description": "SQ *EXAMPLE TEST GOSQ.C", + "status": "CAPTURED" + }, + "created_at": "2021-10-13T19:34:33.524Z", + "delay_action": "CANCEL", + "delay_duration": "PT168H", + "delayed_until": "2021-10-20T19:34:33.524Z", + "employee_id": "TMoK_ogh6rH1o4dV", + "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "location_id": "L88917AVBK2S5", + "note": "Test Note", + "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY", + "processing_fee": [ + { + "amount_money": { + "amount": 34, + "currency": "USD" + }, + "effective_at": "2021-10-13T21:34:35.000Z", + "type": "INITIAL" + } + ], + "receipt_number": "bP9m", + "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", + "source_type": "CARD", + "status": "COMPLETED", + "team_member_id": "TMoK_ogh6rH1o4dV", + "total_money": { + "amount": 555, + "currency": "USD" + }, + "updated_at": "2021-10-13T19:34:37.261Z", + "version_token": "vguW2km0KpVCdAXZcNTZ438qg5LlVPTP4HO5OpiHNfa6o" + } + ] + } + }, + "ListPayoutEntriesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which payout entries are listed.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`", + "nullable": true + } + }, + "example": {} + }, + "ListPayoutEntriesResponse": { + "type": "object", + "description": "The response to retrieve payout records entries.", + "x-release-status": "PUBLIC", + "properties": { + "payout_entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutEntry" + }, + "description": "The requested list of payout entries, ordered with the given or default sort order." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty, this is the final response.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "cursor": "TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO", + "payout_entries": [ + { + "effective_at": "2021-12-14T23:31:49Z", + "fee_amount_money": { + "amount": -2, + "currency_code": "USD" + }, + "gross_amount_money": { + "amount": -50, + "currency_code": "USD" + }, + "id": "poe_ZQWcw41d0SGJS6IWd4cSi8mKHk", + "net_amount_money": { + "amount": -48, + "currency_code": "USD" + }, + "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6", + "type": "REFUND", + "type_refund_details": { + "payment_id": "HVdG62HeMlti8YYf94oxrN", + "refund_id": "HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY" + } + }, + { + "effective_at": "2021-12-14T23:31:49Z", + "fee_amount_money": { + "amount": 19, + "currency_code": "USD" + }, + "gross_amount_money": { + "amount": 100, + "currency_code": "USD" + }, + "id": "poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk", + "net_amount_money": { + "amount": 81, + "currency_code": "USD" + }, + "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6", + "type": "CHARGE", + "type_charge_details": { + "payment_id": "HVdG62H5K3291d0SGJS6IWd4cSi8YY" + } + } + ] + } + }, + "ListPayoutsRequest": { + "type": "object", + "description": "A request to retrieve payout records.", + "x-release-status": "PUBLIC", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location for which to list the payouts.\nBy default, payouts are returned for the default (main) location associated with the seller.", + "maxLength": 255, + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus", + "description": "If provided, only payouts with the given status are returned.", + "nullable": true + }, + "begin_time": { + "type": "string", + "description": "The timestamp for the beginning of the payout creation time, in RFC 3339 format.\nInclusive. Default: The current time minus one year.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "The timestamp for the end of the payout creation time, in RFC 3339 format.\nDefault: The current time.", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which payouts are listed.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`", + "nullable": true + } + }, + "example": {} + }, + "ListPayoutsResponse": { + "type": "object", + "description": "The response to retrieve payout records entries.", + "x-release-status": "PUBLIC", + "properties": { + "payouts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Payout" + }, + "description": "The requested list of payouts." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty, this is the final response.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "cursor": "EMPCyStibo64hS8wLayZPp3oedR3AeEUNd3z7u6zphi72LQZFIEMbkKVvot9eefpU", + "payouts": [ + { + "amount_money": { + "amount": 6259, + "currency_code": "USD" + }, + "arrival_date": "2022-03-29", + "created_at": "2022-03-29T16:12:31Z", + "destination": { + "id": "ccof:ZPp3oedR3AeEUNd3z7", + "type": "CARD" + }, + "end_to_end_id": "L2100000005", + "id": "po_b345d2c7-90b3-4f0b-a2aa-df1def7f8afc", + "location_id": "L88917AVBK2S5", + "payout_fee": [ + { + "amount_money": { + "amount": 95, + "currency_code": "USD" + }, + "effective_at": "2022-03-29T16:12:31Z", + "type": "TRANSFER_FEE" + } + ], + "status": "PAID", + "type": "BATCH", + "updated_at": "2022-03-30T01:07:22.875Z", + "version": 2 + }, + { + "amount_money": { + "amount": -103, + "currency_code": "USD" + }, + "arrival_date": "2022-03-24", + "created_at": "2022-03-24T03:07:09Z", + "destination": { + "id": "bact:ZPp3oedR3AeEUNd3z7", + "type": "BANK_ACCOUNT" + }, + "end_to_end_id": "L2100000006", + "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45", + "location_id": "L88917AVBK2S5", + "status": "PAID", + "type": "BATCH", + "updated_at": "2022-03-24T03:07:09Z", + "version": 1 + } + ] + } + }, + "ListRefundsRequest": { + "type": "object", + "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders)", + "x-release-status": "DEPRECATED", + "x-params-example": "?begin_time=2016-01-15T00:00:00Z\u0026end_time=2016-01-31T00:00:00Z", + "properties": { + "begin_time": { + "type": "string", + "description": "The beginning of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time minus one year.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "The end of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time.", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which results are listed in the response (`ASC` for\noldest first, `DESC` for newest first).\n\nDefault value: `DESC`\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ListRefunds/ListRefundsRequest.csharp", + "java": "/sdk_samples/ListRefunds/ListRefundsRequest.java", + "javascript": "/sdk_samples/ListRefunds/ListRefundsRequest.javascript", + "php": "/sdk_samples/ListRefunds/ListRefundsRequest.php", + "python": "/sdk_samples/ListRefunds/ListRefundsRequest.python", + "ruby": "/sdk_samples/ListRefunds/ListRefundsRequest.ruby" + } + }, + "ListRefundsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refund" + }, + "description": "An array of refunds that match your query." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." + } + }, + "example": { + "refunds": [ + { + "additional_recipients": [ + { + "amount_money": { + "amount": 10, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "created_at": "2016-01-20T00:28:18Z", + "id": "b27436d1-7f8e-5610-45c6-417ef71434b4-SW", + "location_id": "18YC4JDH91E1H", + "reason": "some reason", + "status": "APPROVED", + "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF", + "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF" + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ListRefunds/ListRefundsResponse.csharp", + "java": "/sdk_samples/ListRefunds/ListRefundsResponse.java", + "javascript": "/sdk_samples/ListRefunds/ListRefundsResponse.javascript", + "php": "/sdk_samples/ListRefunds/ListRefundsResponse.php", + "python": "/sdk_samples/ListRefunds/ListRefundsResponse.python", + "ruby": "/sdk_samples/ListRefunds/ListRefundsResponse.ruby" + } + }, + "ListSitesRequest": { + "type": "object", + "description": "Represents a `ListSites` request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "ListSitesResponse": { + "type": "object", + "description": "Represents a `ListSites` response. The response can include either `sites` or `errors`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "sites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Site" + }, + "description": "The sites that belong to the seller." + } + }, + "example": { + "sites": [ + { + "created_at": "2020-10-28T13:22:51.000000Z", + "domain": "mysite2.square.site", + "id": "site_278075276488921835", + "is_published": false, + "site_title": "My Second Site", + "updated_at": "2020-10-28T13:22:51.000000Z" + }, + { + "created_at": "2020-06-18T17:45:13.000000Z", + "domain": "mysite1.square.site", + "id": "site_102725345836253849", + "is_published": true, + "site_title": "My First Site", + "updated_at": "2020-11-23T02:19:10.000000Z" + } + ] + } + }, + "ListSubscriptionEventsRequest": { + "type": "object", + "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents)\nendpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The upper limit on the number of subscription events to return\nin a paged response.", + "minimum": 1, + "nullable": true + } + } + }, + "ListSubscriptionEventsResponse": { + "type": "object", + "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription_events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionEvent" + }, + "description": "The retrieved subscription events." + }, + "cursor": { + "type": "string", + "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of events.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "subscription_events": [ + { + "effective_date": "2020-04-24", + "id": "06809161-3867-4598-8269-8aea5be4f9de", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "START_SUBSCRIPTION" + }, + { + "effective_date": "2020-05-01", + "id": "f2736603-cd2e-47ec-8675-f815fff54f88", + "info": { + "code": "CUSTOMER_NO_NAME", + "detail": "The customer with ID `V74BMG0GPS2KNCWJE1BTYJ37Y0` does not have a name on record." + }, + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "DEACTIVATE_SUBSCRIPTION" + }, + { + "effective_date": "2022-05-01", + "id": "b426fc85-6859-450b-b0d0-fe3a5d1b565f", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "RESUME_SUBSCRIPTION" + }, + { + "effective_date": "2022-09-01", + "id": "09f14de1-2f53-4dae-9091-49aa53f83d01", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "PAUSE_SUBSCRIPTION" + }, + { + "effective_date": "2022-12-01", + "id": "f28a73ac-1a1b-4b0f-8eeb-709a72945776", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "RESUME_SUBSCRIPTION" + }, + { + "effective_date": "2023-04-01", + "id": "1eee8790-472d-4efe-8c69-8ad84e9cefe0", + "plan_variation_id": "02CD53CFA4d1498AFAD42", + "subscription_event_type": "PLAN_CHANGE" + }, + { + "effective_date": "2023-06-21", + "id": "a0c08083-5db0-4800-85c7-d398de4fbb6e", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "STOP_SUBSCRIPTION" + } + ] + } + }, + "ListTeamMemberBookingProfilesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "bookable_only": { + "type": "boolean", + "description": "Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a paged response.", + "minimum": 1, + "maximum": 100, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.", + "maxLength": 65536, + "nullable": true + }, + "location_id": { + "type": "string", + "description": "Indicates whether to include only team members enabled at the given location in the returned result.", + "maxLength": 32, + "nullable": true + } + } + }, + "ListTeamMemberBookingProfilesResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "team_member_booking_profiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TeamMemberBookingProfile" + }, + "description": "The list of team member booking profiles. The results are returned in the ascending order of the time\nwhen the team member booking profiles were last updated. Multiple booking profiles updated at the same time\nare further sorted in the ascending order of their IDs." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.", + "maxLength": 65536 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "errors": [], + "team_member_booking_profiles": [ + { + "display_name": "Sandbox Seller", + "is_bookable": true, + "team_member_id": "TMXUrsBWWcHTt79t" + }, + { + "display_name": "Sandbox Staff", + "is_bookable": true, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ] + } + }, + "ListTeamMemberWagesRequest": { + "type": "object", + "description": "A request for a set of `TeamMemberWage` objects.", + "x-release-status": "PUBLIC", + "x-params-example": "?team_member_id=33fJchumvVdJwxV0H6L9\u0026limit=4\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED", + "properties": { + "team_member_id": { + "type": "string", + "description": "Filter the returned wages to only those that are associated with the\nspecified team member.", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between\n1 and 200. The default is 200.", + "minimum": 1, + "maximum": 200, + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pointer to the next page of `EmployeeWage` results to fetch.", + "nullable": true + } + } + }, + "ListTeamMemberWagesResponse": { + "type": "object", + "description": "The response to a request for a set of `TeamMemberWage` objects. The response contains\na set of `TeamMemberWage` objects.", + "x-release-status": "PUBLIC", + "properties": { + "team_member_wages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TeamMemberWage" + }, + "description": "A page of `TeamMemberWage` results." + }, + "cursor": { + "type": "string", + "description": "The value supplied in the subsequent request to fetch the next page\nof `TeamMemberWage` results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED", + "team_member_wages": [ + { + "hourly_rate": { + "amount": 3250, + "currency": "USD" + }, + "id": "pXS3qCv7BERPnEGedM4S8mhm", + "job_id": "jxJNN6eCJsLrhg5UFJrDWDGE", + "team_member_id": "33fJchumvVdJwxV0H6L9", + "tip_eligible": false, + "title": "Manager" + }, + { + "hourly_rate": { + "amount": 2600, + "currency": "USD" + }, + "id": "rZduCkzYDUVL3ovh1sQgbue6", + "job_id": "gcbz15vKGnMKmaWJJ152kjim", + "team_member_id": "33fJchumvVdJwxV0H6L9", + "tip_eligible": true, + "title": "Cook" + }, + { + "hourly_rate": { + "amount": 1600, + "currency": "USD" + }, + "id": "FxLbs5KpPUHa8wyt5ctjubDX", + "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", + "team_member_id": "33fJchumvVdJwxV0H6L9", + "tip_eligible": true, + "title": "Barista" + }, + { + "hourly_rate": { + "amount": 1700, + "currency": "USD" + }, + "id": "vD1wCgijMDR3cX5TPnu7VXto", + "job_id": "N4YKVLzFj3oGtNocqoYHYpW3", + "team_member_id": "33fJchumvVdJwxV0H6L9", + "tip_eligible": true, + "title": "Cashier" + } + ] + } + }, + "ListTransactionsRequest": { + "type": "object", + "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders)", + "x-release-status": "DEPRECATED", + "x-params-example": "?begin_time=2016-01-15T00:00:00Z\u0026end_time=2016-01-31T00:00:00Z", + "properties": { + "begin_time": { + "type": "string", + "description": "The beginning of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time minus one year.", + "nullable": true + }, + "end_time": { + "type": "string", + "description": "The end of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time.", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which results are listed in the response (`ASC` for\noldest first, `DESC` for newest first).\n\nDefault value: `DESC`\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ListTransactions/ListTransactionsRequest.csharp", + "java": "/sdk_samples/ListTransactions/ListTransactionsRequest.java", + "javascript": "/sdk_samples/ListTransactions/ListTransactionsRequest.javascript", + "php": "/sdk_samples/ListTransactions/ListTransactionsRequest.php", + "python": "/sdk_samples/ListTransactions/ListTransactionsRequest.python", + "ruby": "/sdk_samples/ListTransactions/ListTransactionsRequest.ruby" + } + }, + "ListTransactionsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + }, + "description": "An array of transactions that match your query." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." + } + }, + "example": { + "transactions": [ + { + "created_at": "2016-01-20T22:57:56Z", + "id": "KnL67ZIwXCPtzOrqj0HrkxMF", + "location_id": "18YC4JDH91E1H", + "product": "EXTERNAL_API", + "reference_id": "some optional reference id", + "refunds": [ + { + "additional_recipients": [ + { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "amount_money": { + "amount": 5000, + "currency": "USD" + }, + "created_at": "2016-01-20T22:59:20Z", + "id": "7a5RcVI0CxbOcJ2wMOkE", + "location_id": "18YC4JDH91E1H", + "processing_fee_money": { + "amount": 138, + "currency": "USD" + }, + "reason": "some reason why", + "status": "APPROVED", + "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF", + "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF" + } + ], + "tenders": [ + { + "additional_recipients": [ + { + "amount_money": { + "amount": 20, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "amount_money": { + "amount": 5000, + "currency": "USD" + }, + "card_details": { + "card": { + "card_brand": "VISA", + "last_4": "1111" + }, + "entry_method": "KEYED", + "status": "CAPTURED" + }, + "created_at": "2016-01-20T22:57:56Z", + "id": "MtZRYYdDrYNQbOvV7nbuBvMF", + "location_id": "18YC4JDH91E1H", + "note": "some optional note", + "processing_fee_money": { + "amount": 138, + "currency": "USD" + }, + "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF", + "type": "CARD" + } + ] + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ListTransactions/ListTransactionsResponse.csharp", + "java": "/sdk_samples/ListTransactions/ListTransactionsResponse.java", + "javascript": "/sdk_samples/ListTransactions/ListTransactionsResponse.javascript", + "php": "/sdk_samples/ListTransactions/ListTransactionsResponse.php", + "python": "/sdk_samples/ListTransactions/ListTransactionsResponse.python", + "ruby": "/sdk_samples/ListTransactions/ListTransactionsResponse.ruby" + } + }, + "ListWebhookEventTypesRequest": { + "type": "object", + "description": "Lists all webhook event types that can be subscribed to.", + "x-release-status": "PUBLIC", + "properties": { + "api_version": { + "type": "string", + "description": "The API version for which to list event types. Setting this field overrides the default version used by the application.", + "nullable": true + } + } + }, + "ListWebhookEventTypesResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](api-endpoint:WebhookSubscriptions-ListWebhookEventTypes) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "event_types": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of event types." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventTypeMetadata" + }, + "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata)." + } + }, + "example": { + "event_types": [ + "inventory.count.updated" + ], + "metadata": [ + { + "api_version_introduced": "2018-07-12", + "event_type": "inventory.count.updated", + "release_status": "PUBLIC" + } + ] + } + }, + "ListWebhookSubscriptionsRequest": { + "type": "object", + "description": "Lists all [Subscription](entity:WebhookSubscription)s owned by your application.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "maxLength": 256, + "nullable": true + }, + "include_disabled": { + "type": "boolean", + "description": "Includes disabled [Subscription](entity:WebhookSubscription)s.\nBy default, all enabled [Subscription](entity:WebhookSubscription)s are returned.", + "nullable": true + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100", + "minimum": 1, + "maximum": 100, + "nullable": true + } + } + }, + "ListWebhookSubscriptionsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](api-endpoint:WebhookSubscriptions-ListWebhookSubscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookSubscription" + }, + "description": "The requested list of [Subscription](entity:WebhookSubscription)s." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "subscriptions": [ + { + "api_version": "2021-12-15", + "created_at": "2022-01-10 23:29:48 +0000 UTC", + "enabled": true, + "event_types": [ + "payment.created", + "payment.updated" + ], + "id": "wbhk_b35f6b3145074cf9ad513610786c19d5", + "name": "Example Webhook Subscription", + "notification_url": "https://example-webhook-url.com", + "updated_at": "2022-01-10 23:29:48 +0000 UTC" + } + ] + } + }, + "ListWorkweekConfigsRequest": { + "type": "object", + "description": "A request for a set of `WorkweekConfig` objects.", + "x-release-status": "PUBLIC", + "x-params-example": "?limit=1\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED", + "properties": { + "limit": { + "type": "integer", + "description": "The maximum number of `WorkweekConfigs` results to return per page.", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pointer to the next page of `WorkweekConfig` results to fetch.", + "nullable": true + } + } + }, + "ListWorkweekConfigsResponse": { + "type": "object", + "description": "The response to a request for a set of `WorkweekConfig` objects. The response contains\nthe requested `WorkweekConfig` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "workweek_configs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkweekConfig" + }, + "description": "A page of `WorkweekConfig` results." + }, + "cursor": { + "type": "string", + "description": "The value supplied in the subsequent request to fetch the next page of\n`WorkweekConfig` results." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED", + "workweek_configs": [ + { + "created_at": "2016-02-04T00:58:24Z", + "id": "FY4VCAQN700GM", + "start_of_day_local_time": "10:00", + "start_of_week": "MON", + "updated_at": "2019-02-28T01:04:35Z", + "version": 11 + } + ] + } + }, + "Location": { + "type": "object", + "description": "Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api).", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A short generated string of letters and numbers that uniquely identifies this location instance.", + "maxLength": 32, + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the location.\nThis information appears in the Seller Dashboard as the nickname.\nA location name must be unique within a seller account.", + "maxLength": 255, + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The physical address of the location.", + "nullable": true + }, + "timezone": { + "type": "string", + "description": "The [IANA time zone](https://www.iana.org/time-zones) identifier for\nthe time zone of the location. For example, `America/Los_Angeles`.", + "maxLength": 30, + "nullable": true + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocationCapability" + }, + "description": "The Square features that are enabled for the location.\nSee [LocationCapability](entity:LocationCapability) for possible values.\nSee [LocationCapability](#type-locationcapability) for possible values", + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/LocationStatus", + "description": "The status of the location.\nSee [LocationStatus](#type-locationstatus) for possible values", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time when the location was created, in RFC 3339 format.\nFor more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).", + "minLength": 20, + "maxLength": 25, + "readOnly": true + }, + "merchant_id": { + "type": "string", + "description": "The ID of the merchant that owns the location.", + "maxLength": 32, + "readOnly": true + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](entity:Country) for possible values.\nSee [Country](#type-country) for possible values", + "readOnly": true + }, + "language_code": { + "type": "string", + "description": "The language associated with the location, in\n[BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).\nFor more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences).", + "minLength": 2, + "maxLength": 5, + "nullable": true + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](entity:Currency) for possible values.\nSee [Currency](#type-currency) for possible values", + "readOnly": true + }, + "phone_number": { + "type": "string", + "description": "The phone number of the location. For example, `+1 855-700-6000`.", + "maxLength": 17, + "nullable": true + }, + "business_name": { + "type": "string", + "description": "The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.", + "maxLength": 255, + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/LocationType", + "description": "The type of the location.\nSee [LocationType](#type-locationtype) for possible values", + "nullable": true + }, + "website_url": { + "type": "string", + "description": "The website URL of the location. For example, `https://squareup.com`.", + "maxLength": 255, + "nullable": true + }, + "business_hours": { + "$ref": "#/components/schemas/BusinessHours", + "description": "The hours of operation for the location.", + "nullable": true + }, + "business_email": { + "type": "string", + "description": "The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.", + "maxLength": 255, + "nullable": true + }, + "description": { + "type": "string", + "description": "The description of the location. For example, `Main Street location`.", + "maxLength": 1024, + "nullable": true + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the location without the '@' symbol. For example, `Square`.", + "minLength": 1, + "maxLength": 15, + "nullable": true + }, + "instagram_username": { + "type": "string", + "description": "The Instagram username of the location without the '@' symbol. For example, `square`.", + "minLength": 1, + "maxLength": 30, + "nullable": true + }, + "facebook_url": { + "type": "string", + "description": "The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`.", + "maxLength": 255, + "nullable": true + }, + "coordinates": { + "$ref": "#/components/schemas/Coordinates", + "description": "The physical coordinates (latitude and longitude) of the location.", + "nullable": true + }, + "logo_url": { + "type": "string", + "description": "The URL of the logo image for the location. When configured in the Seller\nDashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.\nThis image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.", + "maxLength": 255, + "readOnly": true + }, + "pos_background_url": { + "type": "string", + "description": "The URL of the Point of Sale background image for the location.", + "maxLength": 255, + "readOnly": true + }, + "mcc": { + "type": "string", + "description": "A four-digit number that describes the kind of goods or services sold at the location.\nThe [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245.\nFor example, `5045`, for a location that sells computer goods and software.", + "minLength": 4, + "maxLength": 4, + "x-release-status": "BETA", + "nullable": true + }, + "full_format_logo_url": { + "type": "string", + "description": "The URL of a full-format logo image for the location. When configured in the Seller\nDashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.\nThis image can be wider than it is tall and should be at least 1280x648 pixels.", + "readOnly": true + }, + "tax_ids": { + "$ref": "#/components/schemas/TaxIds", + "description": "The tax IDs for this location.", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "LocationBookingProfile": { + "type": "object", + "description": "The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking.", + "x-release-status": "PUBLIC", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the [location](entity:Location).", + "nullable": true + }, + "booking_site_url": { + "type": "string", + "description": "Url for the online booking site for this location.", + "nullable": true + }, + "online_booking_enabled": { + "type": "boolean", + "description": "Indicates whether the location is enabled for online booking.", + "nullable": true + } + } + }, + "LocationCapability": { + "type": "string", + "enum": [ + "CREDIT_CARD_PROCESSING", + "AUTOMATIC_TRANSFERS", + "UNLINKED_REFUNDS" + ], + "x-enum-elements": [ + { + "name": "CREDIT_CARD_PROCESSING", + "description": "The capability to process credit card transactions with Square." + }, + { + "name": "AUTOMATIC_TRANSFERS", + "description": "The capability to receive automatic transfers from Square." + }, + { + "name": "UNLINKED_REFUNDS", + "description": "The capability to process unlinked refunds with Square." + } + ], + "description": "The capabilities a location might have.", + "x-release-status": "PUBLIC" + }, + "LocationStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "A location that is active for business." + }, + { + "name": "INACTIVE", + "description": "A location that is not active for business. Inactive locations provide historical\ninformation. Hide inactive locations unless the user has requested to see them." + } + ], + "description": "A location's status.", + "x-release-status": "PUBLIC" + }, + "LocationType": { + "type": "string", + "enum": [ + "PHYSICAL", + "MOBILE" + ], + "x-enum-elements": [ + { + "name": "PHYSICAL", + "description": "A place of business with a physical location." + }, + { + "name": "MOBILE", + "description": "A place of business that is mobile, such as a food truck or online store." + } + ], + "description": "A location's type.", + "x-release-status": "PUBLIC" + }, + "LoyaltyAccount": { + "type": "object", + "description": "Describes a loyalty account in a [loyalty program](entity:LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", + "x-release-status": "PUBLIC", + "required": [ + "program_id" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the loyalty account.", + "maxLength": 36, + "readOnly": true + }, + "program_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) to which the account belongs.", + "minLength": 1, + "maxLength": 36 + }, + "balance": { + "type": "integer", + "description": "The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field.\n\nYour application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange.", + "readOnly": true + }, + "lifetime_points": { + "type": "integer", + "description": "The total points accrued during the lifetime of the account.", + "readOnly": true + }, + "customer_id": { + "type": "string", + "description": "The Square-assigned ID of the [customer](entity:Customer) that is associated with the account.", + "nullable": true + }, + "enrolled_at": { + "type": "string", + "description": "The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products.\n\nIf this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer's first action on their account \n(when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale. \n\nThis field is typically specified in a `CreateLoyaltyAccount` request when creating a loyalty account for a buyer who already interacted with their account. \nFor example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the loyalty account was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the loyalty account was last updated, in RFC 3339 format.", + "readOnly": true + }, + "mapping": { + "$ref": "#/components/schemas/LoyaltyAccountMapping", + "description": "The mapping that associates the loyalty account with a buyer. Currently,\na loyalty account can only be mapped to a buyer by phone number.\n\nTo create a loyalty account, you must specify the `mapping` field, with the buyer's phone number\nin the `phone_number` field.", + "nullable": true + }, + "expiring_point_deadlines": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyAccountExpiringPointDeadline" + }, + "description": "The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. \n\nThe total number of points in this field equals the number of points in the `balance` field.", + "nullable": true + } + } + }, + "LoyaltyAccountExpiringPointDeadline": { + "type": "object", + "description": "Represents a set of points for a loyalty account that are scheduled to expire on a specific date.", + "x-release-status": "PUBLIC", + "required": [ + "points", + "expires_at" + ], + "properties": { + "points": { + "type": "integer", + "description": "The number of points scheduled to expire at the `expires_at` timestamp." + }, + "expires_at": { + "type": "string", + "description": "The timestamp of when the points are scheduled to expire, in RFC 3339 format.", + "minLength": 1 + } + } + }, + "LoyaltyAccountMapping": { + "type": "object", + "description": "Represents the mapping that associates a loyalty account with a buyer. \n\nCurrently, a loyalty account can only be mapped to a buyer by phone number. For more information, see \n[Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview).", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the mapping.", + "maxLength": 36, + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the mapping was created, in RFC 3339 format.", + "readOnly": true + }, + "phone_number": { + "type": "string", + "description": "The phone number of the buyer, in E.164 format. For example, \"+14155551111\".", + "nullable": true + } + } + }, + "LoyaltyAccountMappingType": { + "type": "string", + "enum": [ + "PHONE" + ], + "x-enum-elements": [ + { + "name": "PHONE", + "description": "The loyalty account is mapped by phone." + } + ], + "description": "The type of mapping.", + "x-release-status": "PUBLIC" + }, + "LoyaltyEvent": { + "type": "object", + "description": "Provides information about a loyalty event. \nFor more information, see [Search for Balance-Changing Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events).", + "x-release-status": "PUBLIC", + "required": [ + "id", + "type", + "created_at", + "loyalty_account_id", + "source" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the loyalty event.", + "minLength": 1, + "readOnly": true + }, + "type": { + "$ref": "#/components/schemas/LoyaltyEventType", + "description": "The type of the loyalty event.\nSee [LoyaltyEventType](#type-loyaltyeventtype) for possible values", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the event was created, in RFC 3339 format.", + "minLength": 1, + "readOnly": true + }, + "accumulate_points": { + "$ref": "#/components/schemas/LoyaltyEventAccumulatePoints", + "description": "Provides metadata when the event `type` is `ACCUMULATE_POINTS`.", + "readOnly": true + }, + "create_reward": { + "$ref": "#/components/schemas/LoyaltyEventCreateReward", + "description": "Provides metadata when the event `type` is `CREATE_REWARD`.", + "readOnly": true + }, + "redeem_reward": { + "$ref": "#/components/schemas/LoyaltyEventRedeemReward", + "description": "Provides metadata when the event `type` is `REDEEM_REWARD`.", + "readOnly": true + }, + "delete_reward": { + "$ref": "#/components/schemas/LoyaltyEventDeleteReward", + "description": "Provides metadata when the event `type` is `DELETE_REWARD`.", + "readOnly": true + }, + "adjust_points": { + "$ref": "#/components/schemas/LoyaltyEventAdjustPoints", + "description": "Provides metadata when the event `type` is `ADJUST_POINTS`.", + "readOnly": true + }, + "loyalty_account_id": { + "type": "string", + "description": "The ID of the [loyalty account](entity:LoyaltyAccount) associated with the event.", + "minLength": 1, + "maxLength": 36, + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The ID of the [location](entity:Location) where the event occurred.", + "readOnly": true + }, + "source": { + "$ref": "#/components/schemas/LoyaltyEventSource", + "description": "Defines whether the event was generated by the Square Point of Sale.\nSee [LoyaltyEventSource](#type-loyaltyeventsource) for possible values", + "readOnly": true + }, + "expire_points": { + "$ref": "#/components/schemas/LoyaltyEventExpirePoints", + "description": "Provides metadata when the event `type` is `EXPIRE_POINTS`.", + "readOnly": true + }, + "other_event": { + "$ref": "#/components/schemas/LoyaltyEventOther", + "description": "Provides metadata when the event `type` is `OTHER`.", + "readOnly": true + }, + "accumulate_promotion_points": { + "$ref": "#/components/schemas/LoyaltyEventAccumulatePromotionPoints", + "description": "Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`.", + "readOnly": true + } + } + }, + "LoyaltyEventAccumulatePoints": { + "type": "object", + "description": "Provides metadata when the event `type` is `ACCUMULATE_POINTS`.", + "x-release-status": "PUBLIC", + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram).", + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The number of points accumulated by the event.", + "minimum": 1, + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders.", + "nullable": true + } + } + }, + "LoyaltyEventAccumulatePromotionPoints": { + "type": "object", + "description": "Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`.", + "x-release-status": "PUBLIC", + "required": [ + "points", + "order_id" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).", + "maxLength": 36, + "readOnly": true + }, + "loyalty_promotion_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion).", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The number of points earned by the event.", + "readOnly": true + }, + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", + "minLength": 1, + "readOnly": true + } + } + }, + "LoyaltyEventAdjustPoints": { + "type": "object", + "description": "Provides metadata when the event `type` is `ADJUST_POINTS`.", + "x-release-status": "PUBLIC", + "required": [ + "points" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).", + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The number of points added or removed." + }, + "reason": { + "type": "string", + "description": "The reason for the adjustment of points.", + "maxLength": 3500, + "nullable": true + } + } + }, + "LoyaltyEventCreateReward": { + "type": "object", + "description": "Provides metadata when the event `type` is `CREATE_REWARD`.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_program_id", + "points" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram).", + "minLength": 1, + "maxLength": 36, + "readOnly": true + }, + "reward_id": { + "type": "string", + "description": "The Square-assigned ID of the created [loyalty reward](entity:LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The loyalty points used to create the reward.", + "readOnly": true + } + } + }, + "LoyaltyEventDateTimeFilter": { + "type": "object", + "description": "Filter events by date time range.", + "x-release-status": "PUBLIC", + "required": [ + "created_at" + ], + "properties": { + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The `created_at` date time range used to filter the result." + } + } + }, + "LoyaltyEventDeleteReward": { + "type": "object", + "description": "Provides metadata when the event `type` is `DELETE_REWARD`.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_program_id", + "points" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram).", + "minLength": 1, + "maxLength": 36, + "readOnly": true + }, + "reward_id": { + "type": "string", + "description": "The ID of the deleted [loyalty reward](entity:LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The number of points returned to the loyalty account.", + "readOnly": true + } + } + }, + "LoyaltyEventExpirePoints": { + "type": "object", + "description": "Provides metadata when the event `type` is `EXPIRE_POINTS`.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_program_id", + "points" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).", + "minLength": 1, + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The number of points expired." + } + } + }, + "LoyaltyEventFilter": { + "type": "object", + "description": "The filtering criteria. If the request specifies multiple filters, \nthe endpoint uses a logical AND to evaluate them.", + "x-release-status": "PUBLIC", + "properties": { + "loyalty_account_filter": { + "$ref": "#/components/schemas/LoyaltyEventLoyaltyAccountFilter", + "description": "Filter events by loyalty account.", + "nullable": true + }, + "type_filter": { + "$ref": "#/components/schemas/LoyaltyEventTypeFilter", + "description": "Filter events by event type.", + "nullable": true + }, + "date_time_filter": { + "$ref": "#/components/schemas/LoyaltyEventDateTimeFilter", + "description": "Filter events by date time range. \nFor each range, the start time is inclusive and the end time \nis exclusive.", + "nullable": true + }, + "location_filter": { + "$ref": "#/components/schemas/LoyaltyEventLocationFilter", + "description": "Filter events by location.", + "nullable": true + }, + "order_filter": { + "$ref": "#/components/schemas/LoyaltyEventOrderFilter", + "description": "Filter events by the order associated with the event.", + "nullable": true + } + } + }, + "LoyaltyEventLocationFilter": { + "type": "object", + "description": "Filter events by location.", + "x-release-status": "PUBLIC", + "required": [ + "location_ids" + ], + "properties": { + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The [location](entity:Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." + } + } + }, + "LoyaltyEventLoyaltyAccountFilter": { + "type": "object", + "description": "Filter events by loyalty account.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_account_id" + ], + "properties": { + "loyalty_account_id": { + "type": "string", + "description": "The ID of the [loyalty account](entity:LoyaltyAccount) associated with loyalty events.", + "minLength": 1 + } + } + }, + "LoyaltyEventOrderFilter": { + "type": "object", + "description": "Filter events by the order associated with the event.", + "x-release-status": "PUBLIC", + "required": [ + "order_id" + ], + "properties": { + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) associated with the event.", + "minLength": 1 + } + } + }, + "LoyaltyEventOther": { + "type": "object", + "description": "Provides metadata when the event `type` is `OTHER`.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_program_id", + "points" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).", + "minLength": 1, + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The number of points added or removed." + } + } + }, + "LoyaltyEventQuery": { + "type": "object", + "description": "Represents a query used to search for loyalty events.", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/LoyaltyEventFilter", + "description": "The query filter criteria.", + "nullable": true + } + } + }, + "LoyaltyEventRedeemReward": { + "type": "object", + "description": "Provides metadata when the event `type` is `REDEEM_REWARD`.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_program_id" + ], + "properties": { + "loyalty_program_id": { + "type": "string", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram).", + "minLength": 1, + "maxLength": 36, + "readOnly": true + }, + "reward_id": { + "type": "string", + "description": "The ID of the redeemed [loyalty reward](entity:LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "maxLength": 36, + "readOnly": true + }, + "order_id": { + "type": "string", + "description": "The ID of the [order](entity:Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", + "readOnly": true + } + } + }, + "LoyaltyEventSource": { + "type": "string", + "enum": [ + "SQUARE", + "LOYALTY_API" + ], + "x-enum-elements": [ + { + "name": "SQUARE", + "description": "The event is generated by the Square Point of Sale (POS)." + }, + { + "name": "LOYALTY_API", + "description": "The event is generated by something other than the Square Point of Sale that used the Loyalty API." + } + ], + "description": "Defines whether the event was generated by the Square Point of Sale.", + "x-release-status": "PUBLIC" + }, + "LoyaltyEventType": { + "type": "string", + "enum": [ + "ACCUMULATE_POINTS", + "CREATE_REWARD", + "REDEEM_REWARD", + "DELETE_REWARD", + "ADJUST_POINTS", + "EXPIRE_POINTS", + "OTHER", + "ACCUMULATE_PROMOTION_POINTS" + ], + "x-enum-elements": [ + { + "name": "ACCUMULATE_POINTS", + "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](entity:LoyaltyProgramAccrualRule)." + }, + { + "name": "CREATE_REWARD", + "description": "A [loyalty reward](entity:LoyaltyReward) is created." + }, + { + "name": "REDEEM_REWARD", + "description": "A loyalty reward is redeemed." + }, + { + "name": "DELETE_REWARD", + "description": "A loyalty reward is deleted." + }, + { + "name": "ADJUST_POINTS", + "description": "Loyalty points are manually adjusted." + }, + { + "name": "EXPIRE_POINTS", + "description": "Loyalty points are expired according to the \nexpiration policy of the loyalty program." + }, + { + "name": "OTHER", + "description": "Some other loyalty event occurred." + }, + { + "name": "ACCUMULATE_PROMOTION_POINTS", + "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](entity:LoyaltyPromotion)." + } + ], + "description": "The type of the loyalty event.", + "x-release-status": "PUBLIC" + }, + "LoyaltyEventTypeFilter": { + "type": "object", + "description": "Filter events by event type.", + "x-release-status": "PUBLIC", + "required": [ + "types" + ], + "properties": { + "types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyEventType" + }, + "description": "The loyalty event types used to filter the result.\nIf multiple values are specified, the endpoint uses a \nlogical OR to combine them.\nSee [LoyaltyEventType](#type-loyaltyeventtype) for possible values" + } + } + }, + "LoyaltyProgram": { + "type": "object", + "description": "Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. \nSquare sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. \nFor more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the loyalty program. Updates to \nthe loyalty program do not modify the identifier.", + "maxLength": 36, + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/LoyaltyProgramStatus", + "description": "Whether the program is currently active.\nSee [LoyaltyProgramStatus](#type-loyaltyprogramstatus) for possible values", + "nullable": true + }, + "reward_tiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyProgramRewardTier" + }, + "description": "The list of rewards for buyers, sorted by ascending points.", + "nullable": true + }, + "expiration_policy": { + "$ref": "#/components/schemas/LoyaltyProgramExpirationPolicy", + "description": "If present, details for how points expire.", + "nullable": true + }, + "terminology": { + "$ref": "#/components/schemas/LoyaltyProgramTerminology", + "description": "A cosmetic name for the “points” currency.", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The [locations](entity:Location) at which the program is active.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the program was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the reward was last updated, in RFC 3339 format.", + "readOnly": true + }, + "accrual_rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRule" + }, + "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions).", + "nullable": true + } + } + }, + "LoyaltyProgramAccrualRule": { + "type": "object", + "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](entity:LoyaltyProgram).", + "x-release-status": "PUBLIC", + "required": [ + "accrual_type" + ], + "properties": { + "accrual_type": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleType", + "description": "The type of the accrual rule that defines how buyers can earn points.\nSee [LoyaltyProgramAccrualRuleType](#type-loyaltyprogramaccrualruletype) for possible values" + }, + "points": { + "type": "integer", + "description": "The number of points that \nbuyers earn based on the `accrual_type`.", + "minimum": 1, + "nullable": true + }, + "visit_data": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleVisitData", + "description": "Additional data for rules with the `VISIT` accrual type.", + "nullable": true + }, + "spend_data": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleSpendData", + "description": "Additional data for rules with the `SPEND` accrual type.", + "nullable": true + }, + "item_variation_data": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleItemVariationData", + "description": "Additional data for rules with the `ITEM_VARIATION` accrual type.", + "nullable": true + }, + "category_data": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleCategoryData", + "description": "Additional data for rules with the `CATEGORY` accrual type.", + "nullable": true + } + } + }, + "LoyaltyProgramAccrualRuleCategoryData": { + "type": "object", + "description": "Represents additional data for rules with the `CATEGORY` accrual type.", + "x-release-status": "PUBLIC", + "required": [ + "category_id" + ], + "properties": { + "category_id": { + "type": "string", + "description": "The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn\npoints.", + "minLength": 1 + } + } + }, + "LoyaltyProgramAccrualRuleItemVariationData": { + "type": "object", + "description": "Represents additional data for rules with the `ITEM_VARIATION` accrual type.", + "x-release-status": "PUBLIC", + "required": [ + "item_variation_id" + ], + "properties": { + "item_variation_id": { + "type": "string", + "description": "The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn\npoints.", + "minLength": 1 + } + } + }, + "LoyaltyProgramAccrualRuleSpendData": { + "type": "object", + "description": "Represents additional data for rules with the `SPEND` accrual type.", + "x-release-status": "PUBLIC", + "required": [ + "amount_money", + "tax_mode" + ], + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount that buyers must spend to earn points. \nFor example, given an \"Earn 1 point for every $10 spent\" accrual rule, a buyer who spends $105 earns 10 points." + }, + "excluded_category_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects)\nendpoint to retrieve information about the excluded categories.", + "nullable": true + }, + "excluded_item_variation_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects)\nendpoint to retrieve information about the excluded item variations.", + "nullable": true + }, + "tax_mode": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleTaxMode", + "description": "Indicates how taxes should be treated when calculating the purchase amount used for points accrual.\nSee [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) for possible values" + } + } + }, + "LoyaltyProgramAccrualRuleTaxMode": { + "type": "string", + "enum": [ + "BEFORE_TAX", + "AFTER_TAX" + ], + "x-enum-elements": [ + { + "name": "BEFORE_TAX", + "description": "Exclude taxes from the purchase amount used for loyalty points accrual." + }, + { + "name": "AFTER_TAX", + "description": "Include taxes in the purchase amount used for loyalty points accrual." + } + ], + "description": "Indicates how taxes should be treated when calculating the purchase amount used for loyalty points accrual. \nThis setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum spend requirement.", + "x-release-status": "PUBLIC" + }, + "LoyaltyProgramAccrualRuleType": { + "type": "string", + "enum": [ + "VISIT", + "SPEND", + "ITEM_VARIATION", + "CATEGORY" + ], + "x-enum-elements": [ + { + "name": "VISIT", + "description": "A visit-based accrual rule. A buyer earns points for each visit. \nYou can specify the minimum purchase required." + }, + { + "name": "SPEND", + "description": "A spend-based accrual rule. A buyer earns points based on the amount \nspent." + }, + { + "name": "ITEM_VARIATION", + "description": "An accrual rule based on an item variation. For example, accrue \npoints for purchasing a coffee." + }, + { + "name": "CATEGORY", + "description": "An accrual rule based on an item category. For example, accrue points \nfor purchasing any item in the \"hot drink\" category: coffee, tea, or hot cocoa." + } + ], + "description": "The type of the accrual rule that defines how buyers can earn points.", + "x-release-status": "PUBLIC" + }, + "LoyaltyProgramAccrualRuleVisitData": { + "type": "object", + "description": "Represents additional data for rules with the `VISIT` accrual type.", + "x-release-status": "PUBLIC", + "required": [ + "tax_mode" + ], + "properties": { + "minimum_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The minimum purchase required during the visit to quality for points.", + "nullable": true + }, + "tax_mode": { + "$ref": "#/components/schemas/LoyaltyProgramAccrualRuleTaxMode", + "description": "Indicates how taxes should be treated when calculating the purchase amount to determine whether the visit qualifies for points. \nThis setting applies only if `minimum_amount_money` is specified.\nSee [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) for possible values" + } + } + }, + "LoyaltyProgramExpirationPolicy": { + "type": "object", + "description": "Describes when the loyalty program expires.", + "x-release-status": "PUBLIC", + "required": [ + "expiration_duration" + ], + "properties": { + "expiration_duration": { + "type": "string", + "description": "The number of months before points expire, in `P[n]M` RFC 3339 duration format. For example, a value of `P12M` represents a duration of 12 months. \nPoints are valid through the last day of the month in which they are scheduled to expire. For example, with a `P12M` duration, points earned on July 6, 2020 expire on August 1, 2021.", + "minLength": 1 + } + } + }, + "LoyaltyProgramRewardDefinition": { + "type": "object", + "description": "Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details\nare now defined using a catalog pricing rule and other catalog objects. For more information, see\n[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).", + "x-release-status": "DEPRECATED", + "required": [ + "scope", + "discount_type" + ], + "properties": { + "scope": { + "$ref": "#/components/schemas/LoyaltyProgramRewardDefinitionScope", + "description": "Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. You can find this information in the\n`product_set_data` field of the `PRODUCT_SET` catalog object referenced by the pricing rule. For `ORDER` scopes,\n`all_products` is true. For `ITEM_VARIATION` or `CATEGORY` scopes, `product_ids_any` is a list of\ncatalog object IDs of the given type.\nSee [LoyaltyProgramRewardDefinitionScope](#type-loyaltyprogramrewarddefinitionscope) for possible values", + "readOnly": true + }, + "discount_type": { + "$ref": "#/components/schemas/LoyaltyProgramRewardDefinitionType", + "description": "The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. You can find this information\nin the `discount_data.discount_type` field of the `DISCOUNT` catalog object referenced by the pricing rule.\nSee [LoyaltyProgramRewardDefinitionType](#type-loyaltyprogramrewarddefinitiontype) for possible values", + "readOnly": true + }, + "percentage_discount": { + "type": "string", + "description": "The fixed percentage of the discount. Present if `discount_type` is `FIXED_PERCENTAGE`.\nFor example, a 7.25% off discount will be represented as \"7.25\". DEPRECATED at version 2020-12-16. You can find this\ninformation in the `discount_data.percentage` field of the `DISCOUNT` catalog object referenced by the pricing rule.", + "readOnly": true + }, + "catalog_object_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the `type` field.\nDEPRECATED at version 2020-12-16. You can find this information in the `product_set_data.product_ids_any` field\nof the `PRODUCT_SET` catalog object referenced by the pricing rule.", + "readOnly": true + }, + "fixed_discount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of the discount. Present if `discount_type` is `FIXED_AMOUNT`. For example, $5 off.\nDEPRECATED at version 2020-12-16. You can find this information in the `discount_data.amount_money` field of the \n`DISCOUNT` catalog object referenced by the pricing rule.", + "readOnly": true + }, + "max_discount_money": { + "$ref": "#/components/schemas/Money", + "description": "When `discount_type` is `FIXED_PERCENTAGE`, the maximum discount amount that can be applied.\nDEPRECATED at version 2020-12-16. You can find this information in the `discount_data.maximum_amount_money` field\nof the `DISCOUNT` catalog object referenced by the the pricing rule.", + "readOnly": true + } + } + }, + "LoyaltyProgramRewardDefinitionScope": { + "type": "string", + "enum": [ + "ORDER", + "ITEM_VARIATION", + "CATEGORY" + ], + "x-enum-elements": [ + { + "name": "ORDER", + "description": "The discount applies to the entire order." + }, + { + "name": "ITEM_VARIATION", + "description": "The discount applies only to specific item variations." + }, + { + "name": "CATEGORY", + "description": "The discount applies only to items in the given categories." + } + ], + "description": "Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. Discount details\nare now defined using a catalog pricing rule and other catalog objects. For more information, see\n[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).", + "x-release-status": "DEPRECATED" + }, + "LoyaltyProgramRewardDefinitionType": { + "type": "string", + "enum": [ + "FIXED_AMOUNT", + "FIXED_PERCENTAGE" + ], + "x-enum-elements": [ + { + "name": "FIXED_AMOUNT", + "description": "The fixed amount discounted." + }, + { + "name": "FIXED_PERCENTAGE", + "description": "The fixed percentage discounted." + } + ], + "description": "The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. Discount details\nare now defined using a catalog pricing rule and other catalog objects. For more information, see\n[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).", + "x-release-status": "DEPRECATED" + }, + "LoyaltyProgramRewardTier": { + "type": "object", + "description": "Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers.", + "x-release-status": "PUBLIC", + "required": [ + "points", + "pricing_rule_reference" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the reward tier.", + "maxLength": 36, + "readOnly": true + }, + "points": { + "type": "integer", + "description": "The points exchanged for the reward tier.", + "minimum": 1 + }, + "name": { + "type": "string", + "description": "The name of the reward tier.", + "readOnly": true + }, + "definition": { + "$ref": "#/components/schemas/LoyaltyProgramRewardDefinition", + "description": "Provides details about the reward tier definition.\nDEPRECATED at version 2020-12-16. Replaced by the `pricing_rule_reference` field.", + "readOnly": true, + "x-release-status": "DEPRECATED" + }, + "created_at": { + "type": "string", + "description": "The timestamp when the reward tier was created, in RFC 3339 format.", + "readOnly": true + }, + "pricing_rule_reference": { + "$ref": "#/components/schemas/CatalogObjectReference", + "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](api-endpoint:Catalog-RetrieveCatalogObject) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details)." + } + } + }, + "LoyaltyProgramStatus": { + "type": "string", + "enum": [ + "INACTIVE", + "ACTIVE" + ], + "x-enum-elements": [ + { + "name": "INACTIVE", + "description": "The loyalty program does not have an active subscription. \nLoyalty API requests fail." + }, + { + "name": "ACTIVE", + "description": "The program is fully functional. The program has an active subscription." + } + ], + "description": "Indicates whether the program is currently active.", + "x-release-status": "PUBLIC" + }, + "LoyaltyProgramTerminology": { + "type": "object", + "description": "Represents the naming used for loyalty points.", + "x-release-status": "PUBLIC", + "required": [ + "one", + "other" + ], + "properties": { + "one": { + "type": "string", + "description": "A singular unit for a point (for example, 1 point is called 1 star).", + "minLength": 1 + }, + "other": { + "type": "string", + "description": "A plural unit for point (for example, 10 points is called 10 stars).", + "minLength": 1 + } + } + }, + "LoyaltyPromotion": { + "type": "object", + "description": "Represents a promotion for a [loyalty program](entity:LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", + "x-release-status": "PUBLIC", + "required": [ + "name", + "incentive", + "available_time" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the promotion.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the promotion.", + "minLength": 1, + "maxLength": 70 + }, + "incentive": { + "$ref": "#/components/schemas/LoyaltyPromotionIncentive", + "description": "The points incentive for the promotion. This field defines whether promotion points\nare earned by multiplying base program points or by adding a specified number of points." + }, + "available_time": { + "$ref": "#/components/schemas/LoyaltyPromotionAvailableTimeData", + "description": "The scheduling information that defines when purchases can qualify to earn points from an `ACTIVE` promotion." + }, + "trigger_limit": { + "$ref": "#/components/schemas/LoyaltyPromotionTriggerLimit", + "description": "The number of times a buyer can earn promotion points during a specified interval.\nIf not specified, buyers can trigger the promotion an unlimited number of times.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/LoyaltyPromotionStatus", + "description": "The current status of the promotion.\nSee [LoyaltyPromotionStatus](#type-loyaltypromotionstatus) for possible values", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the promotion was created, in RFC 3339 format.", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The timestamp of when the promotion was canceled, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the promotion was last updated, in RFC 3339 format.", + "readOnly": true + }, + "loyalty_program_id": { + "type": "string", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion.", + "readOnly": true + }, + "minimum_spend_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The minimum purchase amount required to earn promotion points. If specified, this amount is positive.", + "nullable": true + }, + "qualifying_item_variation_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both.", + "nullable": true + }, + "qualifying_category_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both.", + "nullable": true + } + } + }, + "LoyaltyPromotionAvailableTimeData": { + "type": "object", + "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](entity:LoyaltyPromotion).", + "x-release-status": "PUBLIC", + "required": [ + "time_periods" + ], + "properties": { + "start_date": { + "type": "string", + "description": "The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field\nbased on the provided `time_periods`.", + "readOnly": true + }, + "end_date": { + "type": "string", + "description": "The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field\nbased on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion\nremains available until it is canceled.", + "readOnly": true + }, + "time_periods": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)\n(`VEVENT`). Each event represents an available time period per day or days of the week. \nA day can have a maximum of one available time period.\n\nOnly `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and\ntimestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,\nan end date (using the `UNTIL` keyword), or both. For more information, see\n[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).\n\nNote that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request\nbut are always included in the response." + } + } + }, + "LoyaltyPromotionIncentive": { + "type": "object", + "description": "Represents how points for a [loyalty promotion](entity:LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", + "x-release-status": "PUBLIC", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/LoyaltyPromotionIncentiveType", + "description": "The type of points incentive.\nSee [LoyaltyPromotionIncentiveType](#type-loyaltypromotionincentivetype) for possible values" + }, + "points_multiplier_data": { + "$ref": "#/components/schemas/LoyaltyPromotionIncentivePointsMultiplierData", + "description": "Additional data for a `POINTS_MULTIPLIER` incentive type.", + "nullable": true + }, + "points_addition_data": { + "$ref": "#/components/schemas/LoyaltyPromotionIncentivePointsAdditionData", + "description": "Additional data for a `POINTS_ADDITION` incentive type.", + "nullable": true + } + } + }, + "LoyaltyPromotionIncentivePointsAdditionData": { + "type": "object", + "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive).", + "x-release-status": "PUBLIC", + "required": [ + "points_addition" + ], + "properties": { + "points_addition": { + "type": "integer", + "description": "The number of additional points to earn each time the promotion is triggered. For example,\nsuppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also\nqualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer\nearns a total of 8 points (5 program points + 3 promotion points = 8 points).", + "minimum": 1 + } + } + }, + "LoyaltyPromotionIncentivePointsMultiplierData": { + "type": "object", + "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive).", + "x-release-status": "PUBLIC", + "properties": { + "points_multiplier": { + "type": "integer", + "description": "The multiplier used to calculate the number of points earned each time the promotion\nis triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program.\nIf the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier`\nof 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points).\n\nDEPRECATED at version 2023-08-16. Replaced by the `multiplier` field.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) The `multiplier` field.\n- This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value.", + "minimum": 2, + "maximum": 10, + "x-release-status": "DEPRECATED", + "nullable": true + }, + "multiplier": { + "type": "string", + "description": "The multiplier used to calculate the number of points earned each time the promotion is triggered,\nspecified as a string representation of a decimal. Square supports multipliers up to 10x, with three\npoint precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the\nbase loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a\n`multiplier` of \"1.5\", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points).\nFractional points are dropped.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) This `multiplier` field.\n- The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value.", + "maxLength": 5, + "nullable": true + } + } + }, + "LoyaltyPromotionIncentiveType": { + "type": "string", + "enum": [ + "POINTS_MULTIPLIER", + "POINTS_ADDITION" + ], + "x-enum-elements": [ + { + "name": "POINTS_MULTIPLIER", + "description": "Multiply the number of points earned from the base loyalty program.\nFor example, \"Earn double points.\"" + }, + { + "name": "POINTS_ADDITION", + "description": "Add a specified number of points to those earned from the base loyalty program.\nFor example, \"Earn 10 additional points.\"" + } + ], + "description": "Indicates the type of points incentive for a [loyalty promotion](entity:LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", + "x-release-status": "PUBLIC" + }, + "LoyaltyPromotionStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "ENDED", + "CANCELED", + "SCHEDULED" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "The loyalty promotion is currently active. Buyers can earn points for purchases\nthat meet the promotion conditions, such as the promotion's `available_time`." + }, + { + "name": "ENDED", + "description": "The loyalty promotion has ended because the specified `end_date` was reached.\n`ENDED` is a terminal status." + }, + { + "name": "CANCELED", + "description": "The loyalty promotion was canceled. `CANCELED` is a terminal status." + }, + { + "name": "SCHEDULED", + "description": "The loyalty promotion is scheduled to start in the future. Square changes the\npromotion status to `ACTIVE` when the `start_date` is reached." + } + ], + "description": "Indicates the status of a [loyalty promotion](entity:LoyaltyPromotion).", + "x-release-status": "PUBLIC" + }, + "LoyaltyPromotionTriggerLimit": { + "type": "object", + "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](entity:LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", + "x-release-status": "PUBLIC", + "required": [ + "times" + ], + "properties": { + "times": { + "type": "integer", + "description": "The maximum number of times a buyer can trigger the promotion during the specified `interval`.", + "minimum": 1, + "maximum": 30 + }, + "interval": { + "$ref": "#/components/schemas/LoyaltyPromotionTriggerLimitInterval", + "description": "The time period the limit applies to.\nSee [LoyaltyPromotionTriggerLimitInterval](#type-loyaltypromotiontriggerlimitinterval) for possible values", + "nullable": true + } + } + }, + "LoyaltyPromotionTriggerLimitInterval": { + "type": "string", + "enum": [ + "ALL_TIME", + "DAY" + ], + "x-enum-elements": [ + { + "name": "ALL_TIME", + "description": "The limit applies to the entire time that the promotion is active. For example, if `times`\nis set to 1 and `time_period` is set to `ALL_TIME`, a buyer can earn promotion points a maximum\nof one time during the promotion." + }, + { + "name": "DAY", + "description": "The limit applies per day, according to the `available_time` schedule specified for the promotion.\nFor example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion\na maximum of once per day." + } + ], + "description": "Indicates the time period that the [trigger limit](entity:LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](entity:LoyaltyPromotion).", + "x-release-status": "PUBLIC" + }, + "LoyaltyReward": { + "type": "object", + "description": "Represents a contract to redeem loyalty points for a [reward tier](entity:LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_account_id", + "reward_tier_id" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the loyalty reward.", + "maxLength": 36, + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/LoyaltyRewardStatus", + "description": "The status of a loyalty reward.\nSee [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values", + "readOnly": true + }, + "loyalty_account_id": { + "type": "string", + "description": "The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount) to which the reward belongs.", + "minLength": 1, + "maxLength": 36 + }, + "reward_tier_id": { + "type": "string", + "description": "The Square-assigned ID of the [reward tier](entity:LoyaltyProgramRewardTier) used to create the reward.", + "minLength": 1, + "maxLength": 36 + }, + "points": { + "type": "integer", + "description": "The number of loyalty points used for the reward.", + "minimum": 1, + "readOnly": true + }, + "order_id": { + "type": "string", + "description": "The Square-assigned ID of the [order](entity:Order) to which the reward is attached.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the reward was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the reward was last updated, in RFC 3339 format.", + "readOnly": true + }, + "redeemed_at": { + "type": "string", + "description": "The timestamp when the reward was redeemed, in RFC 3339 format.", + "readOnly": true + } + } + }, + "LoyaltyRewardStatus": { + "type": "string", + "enum": [ + "ISSUED", + "REDEEMED", + "DELETED" + ], + "x-enum-elements": [ + { + "name": "ISSUED", + "description": "The reward is issued." + }, + { + "name": "REDEEMED", + "description": "The reward is redeemed." + }, + { + "name": "DELETED", + "description": "The reward is deleted." + } + ], + "description": "The status of the loyalty reward.", + "x-release-status": "PUBLIC" + }, + "MeasurementUnit": { + "type": "object", + "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", + "x-release-status": "PUBLIC", + "properties": { + "custom_unit": { + "$ref": "#/components/schemas/MeasurementUnitCustom", + "description": "A custom unit of measurement defined by the seller using the Point of Sale\napp or ad-hoc as an order line item.", + "nullable": true + }, + "area_unit": { + "$ref": "#/components/schemas/MeasurementUnitArea", + "description": "Represents a standard area unit.\nSee [MeasurementUnitArea](#type-measurementunitarea) for possible values", + "nullable": true + }, + "length_unit": { + "$ref": "#/components/schemas/MeasurementUnitLength", + "description": "Represents a standard length unit.\nSee [MeasurementUnitLength](#type-measurementunitlength) for possible values", + "nullable": true + }, + "volume_unit": { + "$ref": "#/components/schemas/MeasurementUnitVolume", + "description": "Represents a standard volume unit.\nSee [MeasurementUnitVolume](#type-measurementunitvolume) for possible values", + "nullable": true + }, + "weight_unit": { + "$ref": "#/components/schemas/MeasurementUnitWeight", + "description": "Represents a standard unit of weight or mass.\nSee [MeasurementUnitWeight](#type-measurementunitweight) for possible values", + "nullable": true + }, + "generic_unit": { + "$ref": "#/components/schemas/MeasurementUnitGeneric", + "description": "Reserved for API integrations that lack the ability to specify a real measurement unit\nSee [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values", + "nullable": true + }, + "time_unit": { + "$ref": "#/components/schemas/MeasurementUnitTime", + "description": "Represents a standard unit of time.\nSee [MeasurementUnitTime](#type-measurementunittime) for possible values", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/MeasurementUnitUnitType", + "description": "Represents the type of the measurement unit.\nSee [MeasurementUnitUnitType](#type-measurementunitunittype) for possible values", + "nullable": true + } + } + }, + "MeasurementUnitArea": { + "type": "string", + "enum": [ + "IMPERIAL_ACRE", + "IMPERIAL_SQUARE_INCH", + "IMPERIAL_SQUARE_FOOT", + "IMPERIAL_SQUARE_YARD", + "IMPERIAL_SQUARE_MILE", + "METRIC_SQUARE_CENTIMETER", + "METRIC_SQUARE_METER", + "METRIC_SQUARE_KILOMETER" + ], + "x-enum-elements": [ + { + "name": "IMPERIAL_ACRE", + "description": "The area is measured in acres." + }, + { + "name": "IMPERIAL_SQUARE_INCH", + "description": "The area is measured in square inches." + }, + { + "name": "IMPERIAL_SQUARE_FOOT", + "description": "The area is measured in square feet." + }, + { + "name": "IMPERIAL_SQUARE_YARD", + "description": "The area is measured in square yards." + }, + { + "name": "IMPERIAL_SQUARE_MILE", + "description": "The area is measured in square miles." + }, + { + "name": "METRIC_SQUARE_CENTIMETER", + "description": "The area is measured in square centimeters." + }, + { + "name": "METRIC_SQUARE_METER", + "description": "The area is measured in square meters." + }, + { + "name": "METRIC_SQUARE_KILOMETER", + "description": "The area is measured in square kilometers." + } + ], + "description": "Unit of area used to measure a quantity.", + "x-release-status": "PUBLIC" + }, + "MeasurementUnitCustom": { + "type": "object", + "description": "The information needed to define a custom unit, provided by the seller.", + "x-release-status": "PUBLIC", + "required": [ + "name", + "abbreviation" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom unit, for example \"bushel\"." + }, + "abbreviation": { + "type": "string", + "description": "The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears\nin the cart for the Point of Sale app, and in reports." + } + } + }, + "MeasurementUnitGeneric": { + "type": "string", + "enum": [ + "UNIT" + ], + "x-enum-elements": [ + { + "name": "UNIT", + "description": "The generic unit." + } + ], + "x-release-status": "PUBLIC" + }, + "MeasurementUnitLength": { + "type": "string", + "enum": [ + "IMPERIAL_INCH", + "IMPERIAL_FOOT", + "IMPERIAL_YARD", + "IMPERIAL_MILE", + "METRIC_MILLIMETER", + "METRIC_CENTIMETER", + "METRIC_METER", + "METRIC_KILOMETER" + ], + "x-enum-elements": [ + { + "name": "IMPERIAL_INCH", + "description": "The length is measured in inches." + }, + { + "name": "IMPERIAL_FOOT", + "description": "The length is measured in feet." + }, + { + "name": "IMPERIAL_YARD", + "description": "The length is measured in yards." + }, + { + "name": "IMPERIAL_MILE", + "description": "The length is measured in miles." + }, + { + "name": "METRIC_MILLIMETER", + "description": "The length is measured in millimeters." + }, + { + "name": "METRIC_CENTIMETER", + "description": "The length is measured in centimeters." + }, + { + "name": "METRIC_METER", + "description": "The length is measured in meters." + }, + { + "name": "METRIC_KILOMETER", + "description": "The length is measured in kilometers." + } + ], + "description": "The unit of length used to measure a quantity.", + "x-release-status": "PUBLIC" + }, + "MeasurementUnitTime": { + "type": "string", + "enum": [ + "GENERIC_MILLISECOND", + "GENERIC_SECOND", + "GENERIC_MINUTE", + "GENERIC_HOUR", + "GENERIC_DAY" + ], + "x-enum-elements": [ + { + "name": "GENERIC_MILLISECOND", + "description": "The time is measured in milliseconds." + }, + { + "name": "GENERIC_SECOND", + "description": "The time is measured in seconds." + }, + { + "name": "GENERIC_MINUTE", + "description": "The time is measured in minutes." + }, + { + "name": "GENERIC_HOUR", + "description": "The time is measured in hours." + }, + { + "name": "GENERIC_DAY", + "description": "The time is measured in days." + } + ], + "description": "Unit of time used to measure a quantity (a duration).", + "x-release-status": "PUBLIC" + }, + "MeasurementUnitUnitType": { + "type": "string", + "enum": [ + "TYPE_CUSTOM", + "TYPE_AREA", + "TYPE_LENGTH", + "TYPE_VOLUME", + "TYPE_WEIGHT", + "TYPE_GENERIC" + ], + "x-enum-elements": [ + { + "name": "TYPE_CUSTOM", + "description": "The unit details are contained in the custom_unit field." + }, + { + "name": "TYPE_AREA", + "description": "The unit details are contained in the area_unit field." + }, + { + "name": "TYPE_LENGTH", + "description": "The unit details are contained in the length_unit field." + }, + { + "name": "TYPE_VOLUME", + "description": "The unit details are contained in the volume_unit field." + }, + { + "name": "TYPE_WEIGHT", + "description": "The unit details are contained in the weight_unit field." + }, + { + "name": "TYPE_GENERIC", + "description": "The unit details are contained in the generic_unit field." + } + ], + "description": "Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.", + "x-release-status": "PUBLIC" + }, + "MeasurementUnitVolume": { + "type": "string", + "enum": [ + "GENERIC_FLUID_OUNCE", + "GENERIC_SHOT", + "GENERIC_CUP", + "GENERIC_PINT", + "GENERIC_QUART", + "GENERIC_GALLON", + "IMPERIAL_CUBIC_INCH", + "IMPERIAL_CUBIC_FOOT", + "IMPERIAL_CUBIC_YARD", + "METRIC_MILLILITER", + "METRIC_LITER" + ], + "x-enum-elements": [ + { + "name": "GENERIC_FLUID_OUNCE", + "description": "The volume is measured in ounces." + }, + { + "name": "GENERIC_SHOT", + "description": "The volume is measured in shots." + }, + { + "name": "GENERIC_CUP", + "description": "The volume is measured in cups." + }, + { + "name": "GENERIC_PINT", + "description": "The volume is measured in pints." + }, + { + "name": "GENERIC_QUART", + "description": "The volume is measured in quarts." + }, + { + "name": "GENERIC_GALLON", + "description": "The volume is measured in gallons." + }, + { + "name": "IMPERIAL_CUBIC_INCH", + "description": "The volume is measured in cubic inches." + }, + { + "name": "IMPERIAL_CUBIC_FOOT", + "description": "The volume is measured in cubic feet." + }, + { + "name": "IMPERIAL_CUBIC_YARD", + "description": "The volume is measured in cubic yards." + }, + { + "name": "METRIC_MILLILITER", + "description": "The volume is measured in metric milliliters." + }, + { + "name": "METRIC_LITER", + "description": "The volume is measured in metric liters." + } + ], + "description": "The unit of volume used to measure a quantity.", + "x-release-status": "PUBLIC" + }, + "MeasurementUnitWeight": { + "type": "string", + "enum": [ + "IMPERIAL_WEIGHT_OUNCE", + "IMPERIAL_POUND", + "IMPERIAL_STONE", + "METRIC_MILLIGRAM", + "METRIC_GRAM", + "METRIC_KILOGRAM" + ], + "x-enum-elements": [ + { + "name": "IMPERIAL_WEIGHT_OUNCE", + "description": "The weight is measured in ounces." + }, + { + "name": "IMPERIAL_POUND", + "description": "The weight is measured in pounds." + }, + { + "name": "IMPERIAL_STONE", + "description": "The weight is measured in stones." + }, + { + "name": "METRIC_MILLIGRAM", + "description": "The weight is measured in milligrams." + }, + { + "name": "METRIC_GRAM", + "description": "The weight is measured in grams." + }, + { + "name": "METRIC_KILOGRAM", + "description": "The weight is measured in kilograms." + } + ], + "description": "Unit of weight used to measure a quantity.", + "x-release-status": "PUBLIC" + }, + "Merchant": { + "type": "object", + "description": "Represents a business that sells with Square.", + "x-release-status": "PUBLIC", + "required": [ + "country" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-issued ID of the merchant." + }, + "business_name": { + "type": "string", + "description": "The name of the merchant's overall business.", + "nullable": true + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "The country code associated with the merchant, in the two-letter format of ISO 3166. For example, `US` or `JP`.\nSee [Country](#type-country) for possible values" + }, + "language_code": { + "type": "string", + "description": "The code indicating the [language preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`.", + "nullable": true + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "The currency associated with the merchant, in ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](#type-currency) for possible values", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/MerchantStatus", + "description": "The merchant's status.\nSee [MerchantStatus](#type-merchantstatus) for possible values", + "nullable": true + }, + "main_location_id": { + "type": "string", + "description": "The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-location) for this merchant.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time when the merchant was created, in RFC 3339 format.\n For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).", + "readOnly": true + } + } + }, + "MerchantStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "A fully operational merchant account. The merchant can interact with Square products and APIs." + }, + { + "name": "INACTIVE", + "description": "A functionally limited merchant account. The merchant can only have limited interaction\nvia Square APIs. The merchant cannot log in or access the seller dashboard." + } + ], + "x-release-status": "PUBLIC" + }, + "ModifierLocationOverrides": { + "type": "object", + "description": "Location-specific overrides for specified properties of a `CatalogModifier` object.", + "x-release-status": "PUBLIC", + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the `Location` object representing the location. This can include a deactivated location.", + "nullable": true + }, + "price_money": { + "$ref": "#/components/schemas/Money", + "description": "The overridden price at the specified location. If this is unspecified, the modifier price is not overridden.\nThe modifier becomes free of charge at the specified location, when this `price_money` field is set to 0.", + "nullable": true + }, + "sold_out": { + "type": "boolean", + "description": "Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out.\nThe seller can manually set this sold out status. Attempts by an application to set this attribute are ignored.", + "readOnly": true + } + } + }, + "Money": { + "type": "object", + "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", + "x-release-status": "PUBLIC", + "properties": { + "amount": { + "type": "integer", + "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", + "format": "int64", + "nullable": true + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](entity:Currency) for possible values.\nSee [Currency](#type-currency) for possible values", + "nullable": true + } + } + }, + "ObtainTokenRequest": { + "type": "object", + "description": "Represents an [ObtainToken](api-endpoint:OAuth-ObtainToken) request.", + "x-release-status": "PUBLIC", + "required": [ + "client_id", + "grant_type" + ], + "properties": { + "client_id": { + "type": "string", + "description": "The Square-issued ID of your application, which is available as the **Application ID**\non the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps).\n\nRequired for the code flow and PKCE flow for any grant type.", + "maxLength": 191 + }, + "client_secret": { + "type": "string", + "description": "The secret key for your application, which is available as the **Application secret**\non the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps).\n\nRequired for the code flow for any grant type. Don't confuse your client secret with your\npersonal access token.", + "minLength": 2, + "maxLength": 1024, + "nullable": true + }, + "code": { + "type": "string", + "description": "The authorization code to exchange for an OAuth access token. This is the `code`\nvalue that Square sent to your redirect URL in the authorization response.\n\nRequired for the code flow and PKCE flow if `grant_type` is `authorization_code`.", + "maxLength": 191, + "nullable": true + }, + "redirect_uri": { + "type": "string", + "description": "The redirect URL for your application, which you registered as the **Redirect URL**\non the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps).\n\nRequired for the code flow and PKCE flow if `grant_type` is `authorization_code` and\nyou provided the `redirect_uri` parameter in your authorization URL.", + "maxLength": 2048, + "nullable": true + }, + "grant_type": { + "type": "string", + "description": "The method used to obtain an OAuth access token. The request must include the\ncredential that corresponds to the specified grant type. Valid values are:\n- `authorization_code` - Requires the `code` field.\n- `refresh_token` - Requires the `refresh_token` field.\n- `migration_token` - LEGACY for access tokens obtained using a Square API version prior\nto 2019-03-13. Requires the `migration_token` field.", + "minLength": 10, + "maxLength": 20 + }, + "refresh_token": { + "type": "string", + "description": "A valid refresh token used to generate a new OAuth access token. This is a\nrefresh token that was returned in a previous `ObtainToken` response.\n\nRequired for the code flow and PKCE flow if `grant_type` is `refresh_token`.", + "minLength": 2, + "maxLength": 1024, + "nullable": true + }, + "migration_token": { + "type": "string", + "description": "__LEGACY__ A valid access token (obtained using a Square API version prior to 2019-03-13)\nused to generate a new OAuth access token.\n\nRequired if `grant_type` is `migration_token`. For more information, see\n[Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).", + "minLength": 2, + "maxLength": 1024, + "nullable": true + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of permissions that are explicitly requested for the access token.\nFor example, [\"MERCHANT_PROFILE_READ\",\"PAYMENTS_READ\",\"BANK_ACCOUNTS_READ\"].\n\nThe returned access token is limited to the permissions that are the intersection\nof these requested permissions and those authorized by the provided `refresh_token`.\n\nOptional for the code flow and PKCE flow if `grant_type` is `refresh_token`.", + "nullable": true + }, + "short_lived": { + "type": "boolean", + "description": "Indicates whether the returned access token should expire in 24 hours.\n\nOptional for the code flow and PKCE flow for any grant type. The default value is `false`.", + "nullable": true + }, + "code_verifier": { + "type": "string", + "description": "The secret your application generated for the authorization request used to\nobtain the authorization code. This is the source of the `code_challenge` hash you\nprovided in your authorization URL.\n\nRequired for the PKCE flow if `grant_type` is `authorization_code`.", + "nullable": true + } + }, + "example": { + "client_id": "sq0idp-uaPHILoPzWZk3tlJqlML0g", + "client_secret": "sq0csp-30a-4C_tVOnTh14Piza2BfTPBXyLafLPWSzY1qAjeBfM", + "code": "sq0cgb-l0SBqxs4uwxErTVyYOdemg", + "grant_type": "authorization_code" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ObtainToken/ObtainTokenRequest.csharp", + "java": "/sdk_samples/ObtainToken/ObtainTokenRequest.java", + "javascript": "/sdk_samples/ObtainToken/ObtainTokenRequest.javascript", + "php": "/sdk_samples/ObtainToken/ObtainTokenRequest.php", + "python": "/sdk_samples/ObtainToken/ObtainTokenRequest.python", + "ruby": "/sdk_samples/ObtainToken/ObtainTokenRequest.ruby" + } + }, + "ObtainTokenResponse": { + "type": "object", + "description": "Represents an [ObtainToken](api-endpoint:OAuth-ObtainToken) response.", + "x-release-status": "PUBLIC", + "properties": { + "access_token": { + "type": "string", + "description": "An OAuth access token used to authorize Square API requests on behalf of the seller.\nInclude this token as a bearer token in the `Authorization` header of your API requests.\n\nOAuth access tokens expire in 30 days (except `short_lived` access tokens). You should call\n`ObtainToken` and provide the returned `refresh_token` to get a new access token well before\nthe current one expires. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough).", + "minLength": 2, + "maxLength": 1024 + }, + "token_type": { + "type": "string", + "description": "The type of access token. This value is always `bearer`.", + "minLength": 2, + "maxLength": 10 + }, + "expires_at": { + "type": "string", + "description": "The timestamp of when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.", + "minLength": 20, + "maxLength": 48 + }, + "merchant_id": { + "type": "string", + "description": "The ID of the authorizing [merchant](entity:Merchant) (seller), which represents a business.", + "minLength": 8, + "maxLength": 191 + }, + "subscription_id": { + "type": "string", + "description": "__LEGACY__ The ID of merchant's subscription.\nThe ID is only present if the merchant signed up for a subscription plan during authorization." + }, + "plan_id": { + "type": "string", + "description": "__LEGACY__ The ID of the subscription plan the merchant signed\nup for. The ID is only present if the merchant signed up for a subscription plan during\nauthorization." + }, + "id_token": { + "type": "string", + "description": "The OpenID token that belongs to this person. This token is only present if the\n`OPENID` scope is included in the authorization request.\n\nDeprecated at version 2021-09-15. Square doesn't support OpenID or other single sign-on (SSO)\nprotocols on top of OAuth.", + "x-release-status": "DEPRECATED" + }, + "refresh_token": { + "type": "string", + "description": "A refresh token that can be used in an `ObtainToken` request to generate a new access token.\n\nWith the code flow:\n- For the `authorization_code` grant type, the refresh token is multi-use and never expires.\n- For the `refresh_token` grant type, the response returns the same refresh token.\n\nWith the PKCE flow:\n- For the `authorization_code` grant type, the refresh token is single-use and expires in 90 days.\n- For the `refresh_token` grant type, the refresh token is a new single-use refresh token that expires in 90 days.\n\nFor more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope).", + "minLength": 2, + "maxLength": 1024 + }, + "short_lived": { + "type": "boolean", + "description": "Indicates whether the access_token is short lived. If `true`, the access token expires\nin 24 hours. If `false`, the access token expires in 30 days." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "refresh_token_expires_at": { + "type": "string", + "description": "The timestamp of when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm)\nformat.\n\nThis field is only returned for the PKCE flow.", + "minLength": 20, + "maxLength": 48 + } + }, + "example": { + "access_token": "EAAl3ikZIe18J-2-cHlV2bL4-EaZHGoJUhtEBT7QA6-7AgwIHw8Xe1IoUvGsNxA", + "expires_at": "2025-04-03T18:31:06Z", + "merchant_id": "MLQW2MYBY81PZ", + "refresh_token": "EQAAl0OcByu3IYJYScGGg-8E5YNf0r0b6jCTCMy5nOcRZ4ok0wbWAL8vY3tZWNcc", + "short_lived": false, + "token_type": "bearer" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ObtainToken/ObtainTokenResponse.csharp", + "java": "/sdk_samples/ObtainToken/ObtainTokenResponse.java", + "javascript": "/sdk_samples/ObtainToken/ObtainTokenResponse.javascript", + "php": "/sdk_samples/ObtainToken/ObtainTokenResponse.php", + "python": "/sdk_samples/ObtainToken/ObtainTokenResponse.python", + "ruby": "/sdk_samples/ObtainToken/ObtainTokenResponse.ruby" + } + }, + "OfflinePaymentDetails": { + "type": "object", + "description": "Details specific to offline payments.", + "x-release-status": "PUBLIC", + "properties": { + "client_created_at": { + "type": "string", + "description": "The client-side timestamp of when the offline payment was created, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + } + } + }, + "Order": { + "type": "object", + "description": "Contains all information related to a single order to process with Square,\nincluding line items that specify the products to purchase. `Order` objects also\ninclude information about any associated tenders, refunds, and returns.\n\nAll Connect V2 Transactions have all been converted to Orders including all associated\nitemization data.", + "x-release-status": "PUBLIC", + "required": [ + "location_id" + ], + "properties": { + "id": { + "type": "string", + "description": "The order's unique ID.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The ID of the seller location that this order is associated with.", + "minLength": 1 + }, + "reference_id": { + "type": "string", + "description": "A client-specified ID to associate an entity in another system\nwith this order.", + "maxLength": 40, + "nullable": true + }, + "source": { + "$ref": "#/components/schemas/OrderSource", + "description": "The origination details of the order.", + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "The ID of the [customer](entity:Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", + "maxLength": 191, + "x-release-status": "BETA", + "nullable": true + }, + "line_items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "description": "The line items included in the order.", + "nullable": true + }, + "taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemTax" + }, + "description": "The list of all taxes associated with the order.\n\nTaxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an\n`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes\nwith `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.\n\nOn reads, each tax in the list includes the total amount of that tax applied to the order.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated\n`line_items.taxes` field results in an error. Use `line_items.applied_taxes`\ninstead.", + "nullable": true + }, + "discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDiscount" + }, + "description": "The list of all discounts associated with the order.\n\nDiscounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,\nan `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.\nFor discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`\nfor every line item.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated\n`line_items.discounts` field results in an error. Use `line_items.applied_discounts`\ninstead.", + "nullable": true + }, + "service_charges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderServiceCharge" + }, + "description": "A list of service charges applied to the order.", + "nullable": true + }, + "fulfillments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Fulfillment" + }, + "description": "Details about order fulfillment.\n\nOrders can only be created with at most one fulfillment. However, orders returned\nby the API might contain multiple fulfillments.", + "nullable": true + }, + "returns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + }, + "description": "A collection of items from sale orders being returned in this one. Normally part of an\nitemized return or exchange. There is exactly one `Return` object per sale `Order` being\nreferenced.", + "readOnly": true, + "x-release-status": "BETA" + }, + "return_amounts": { + "$ref": "#/components/schemas/OrderMoneyAmounts", + "description": "The rollup of the returned money amounts.", + "readOnly": true, + "x-release-status": "BETA" + }, + "net_amounts": { + "$ref": "#/components/schemas/OrderMoneyAmounts", + "description": "The net money amounts (sale money - return money).", + "readOnly": true, + "x-release-status": "BETA" + }, + "rounding_adjustment": { + "$ref": "#/components/schemas/OrderRoundingAdjustment", + "description": "A positive rounding adjustment to the total of the order. This adjustment is commonly\nused to apply cash rounding when the minimum unit of account is smaller than the lowest physical\ndenomination of the currency.", + "readOnly": true, + "x-release-status": "BETA" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tender" + }, + "description": "The tenders that were used to pay for the order.", + "readOnly": true, + "x-release-status": "BETA" + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refund" + }, + "description": "The refunds that are part of this order.", + "readOnly": true, + "x-release-status": "BETA" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the order was created, at server side, in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "closed_at": { + "type": "string", + "description": "The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "state": { + "$ref": "#/components/schemas/OrderState", + "description": "The current state of the order.\nSee [OrderState](#type-orderstate) for possible values", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version number, which is incremented each time an update is committed to the order.\nOrders not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders).", + "x-release-status": "BETA" + }, + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of money to collect for the order.", + "readOnly": true + }, + "total_tax_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of tax money to collect for the order.", + "readOnly": true + }, + "total_discount_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of discount money to collect for the order.", + "readOnly": true + }, + "total_tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of tip money to collect for the order.", + "readOnly": true + }, + "total_service_charge_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of money collected in service charges for the order.\n\nNote: `total_service_charge_money` is the sum of `applied_money` fields for each individual\nservice charge. Therefore, `total_service_charge_money` only includes inclusive tax amounts,\nnot additive tax amounts.", + "readOnly": true + }, + "ticket_name": { + "type": "string", + "description": "A short-term identifier for the order (such as a customer first name,\ntable number, or auto-generated order number that resets daily).", + "maxLength": 30, + "x-release-status": "BETA", + "nullable": true + }, + "pricing_options": { + "$ref": "#/components/schemas/OrderPricingOptions", + "description": "Pricing options for an order. The options affect how the order's price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](entity:CatalogPricingRule).", + "nullable": true + }, + "rewards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReward" + }, + "description": "A set-like list of Rewards that have been added to the Order.", + "readOnly": true, + "x-release-status": "BETA" + }, + "net_amount_due_money": { + "$ref": "#/components/schemas/Money", + "description": "The net amount of money due on the order.", + "readOnly": true + } + } + }, + "OrderCreated": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order_id": { + "type": "string", + "description": "The order's unique ID.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version number, which is incremented each time an update is committed to the order.\nOrders that were not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)" + }, + "location_id": { + "type": "string", + "description": "The ID of the seller location that this order is associated with.", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/OrderState", + "description": "The state of the order.\nSee [OrderState](#type-orderstate) for possible values", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the order was created, in RFC 3339 format.", + "readOnly": true + } + } + }, + "OrderCreatedObject": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order_created": { + "$ref": "#/components/schemas/OrderCreated", + "description": "Information about the created order.", + "nullable": true + } + } + }, + "OrderEntry": { + "type": "object", + "description": "A lightweight description of an [order](entity:Order) that is returned when\n`returned_entries` is `true` on a [SearchOrdersRequest](api-endpoint:Orders-SearchOrders).", + "x-release-status": "PUBLIC", + "properties": { + "order_id": { + "type": "string", + "description": "The ID of the order.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version number, which is incremented each time an update is committed to the order.\nOrders that were not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)", + "readOnly": true, + "x-release-status": "BETA" + }, + "location_id": { + "type": "string", + "description": "The location ID the order belongs to.", + "nullable": true + } + } + }, + "OrderFulfillment": { + "type": "object", + "description": "Contains details about how to fulfill this order.\nOrders can only be created with at most one fulfillment using the API.\nHowever, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the fulfillment only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/OrderFulfillmentType", + "description": "The type of the fulfillment.\nSee [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/OrderFulfillmentState", + "description": "The state of the fulfillment.\nSee [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values", + "nullable": true + }, + "line_item_application": { + "$ref": "#/components/schemas/OrderFulfillmentFulfillmentLineItemApplication", + "description": "Describes what order line items this fulfillment applies to.\nIt can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.\nSee [OrderFulfillmentFulfillmentLineItemApplication](#type-orderfulfillmentfulfillmentlineitemapplication) for possible values", + "readOnly": true, + "x-release-status": "BETA" + }, + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderFulfillmentFulfillmentEntry" + }, + "description": "A list of entries pertaining to the fulfillment of an order. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.\nMultiple entries can reference the same line item `uid`, as long as the total quantity among\nall fulfillment entries referencing a single line item does not exceed the quantity of the\norder's line item itself.\nAn order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,\n`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently\nbefore order completion.", + "readOnly": true, + "x-release-status": "BETA" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\nValues have a maximum length of 255 characters.\nAn application can have up to 10 entries per metadata field.\nEntries written by applications are private and can only be read or modified by the same\napplication.\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "pickup_details": { + "$ref": "#/components/schemas/OrderFulfillmentPickupDetails", + "description": "Contains details for a pickup fulfillment. These details are required when the fulfillment\ntype is `PICKUP`.", + "nullable": true + }, + "shipment_details": { + "$ref": "#/components/schemas/OrderFulfillmentShipmentDetails", + "description": "Contains details for a shipment fulfillment. These details are required when the fulfillment type\nis `SHIPMENT`.\nA shipment fulfillment's relationship to fulfillment `state`:\n`PROPOSED`: A shipment is requested.\n`RESERVED`: Fulfillment in progress. Shipment processing.\n`PREPARED`: Shipment packaged. Shipping label created.\n`COMPLETED`: Package has been shipped.\n`CANCELED`: Shipment has been canceled.\n`FAILED`: Shipment has failed.", + "x-release-status": "BETA", + "nullable": true + }, + "delivery_details": { + "$ref": "#/components/schemas/OrderFulfillmentDeliveryDetails", + "description": "Describes delivery details of an order fulfillment.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderFulfillmentDeliveryDetails": { + "type": "object", + "description": "Describes delivery details of an order fulfillment.", + "x-release-status": "BETA", + "properties": { + "recipient": { + "$ref": "#/components/schemas/OrderFulfillmentRecipient", + "description": "The contact information for the person to receive the fulfillment.", + "nullable": true + }, + "schedule_type": { + "$ref": "#/components/schemas/OrderFulfillmentDeliveryDetailsScheduleType", + "description": "Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then\n`deliver_at` is required. If `ASAP`, then `prep_time_duration` is required. The default is `SCHEDULED`.\nSee [OrderFulfillmentDeliveryDetailsScheduleType](#type-orderfulfillmentdeliverydetailsscheduletype) for possible values", + "nullable": true + }, + "placed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").\nMust be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".", + "readOnly": true + }, + "deliver_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the delivery period.\nWhen the fulfillment `schedule_type` is `ASAP`, the field is automatically\nset to the current time plus the `prep_time_duration`.\nOtherwise, the application can set this field while the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the\nterminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "prep_time_duration": { + "type": "string", + "description": "The duration of time it takes to prepare and deliver this fulfillment.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "delivery_window_duration": { + "type": "string", + "description": "The time period after `deliver_at` in which to deliver the order.\nApplications can set this field when the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state\nsuch as `COMPLETED`, `CANCELED`, and `FAILED`).\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "note": { + "type": "string", + "description": "Provides additional instructions about the delivery fulfillment.\nIt is displayed in the Square Point of Sale application and set by the API.", + "maxLength": 550, + "nullable": true + }, + "completed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller completed the fulfillment.\nThis field is automatically set when fulfillment `state` changes to `COMPLETED`.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "in_progress_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller started processing the fulfillment.\nThis field is automatically set when the fulfillment `state` changes to `RESERVED`.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "rejected_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. This field is\nautomatically set when the fulfillment `state` changes to `FAILED`.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "ready_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the seller marked the fulfillment as ready for\ncourier pickup. This field is automatically set when the fulfillment `state` changes\nto PREPARED.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "delivered_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was delivered to the recipient.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. This field is automatically\nset when the fulfillment `state` changes to `CANCELED`.\n\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "cancel_reason": { + "type": "string", + "description": "The delivery cancellation reason. Max length: 100 characters.", + "maxLength": 100, + "nullable": true + }, + "courier_pickup_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when an order can be picked up by the courier for delivery.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "courier_pickup_window_duration": { + "type": "string", + "description": "The time period after `courier_pickup_at` in which the courier should pick up the order.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "is_no_contact_delivery": { + "type": "boolean", + "description": "Whether the delivery is preferred to be no contact.", + "nullable": true + }, + "dropoff_notes": { + "type": "string", + "description": "A note to provide additional instructions about how to deliver the order.", + "maxLength": 550, + "nullable": true + }, + "courier_provider_name": { + "type": "string", + "description": "The name of the courier provider.", + "maxLength": 255, + "nullable": true + }, + "courier_support_phone_number": { + "type": "string", + "description": "The support phone number of the courier.", + "maxLength": 17, + "nullable": true + }, + "square_delivery_id": { + "type": "string", + "description": "The identifier for the delivery created by Square.", + "maxLength": 50, + "nullable": true + }, + "external_delivery_id": { + "type": "string", + "description": "The identifier for the delivery created by the third-party courier service.", + "maxLength": 50, + "nullable": true + }, + "managed_delivery": { + "type": "boolean", + "description": "The flag to indicate the delivery is managed by a third party (ie DoorDash), which means\nwe may not receive all recipient information for PII purposes.", + "nullable": true + } + } + }, + "OrderFulfillmentDeliveryDetailsScheduleType": { + "type": "string", + "enum": [ + "SCHEDULED", + "ASAP" + ], + "x-enum-elements": [ + { + "name": "SCHEDULED", + "description": "Indicates the fulfillment to deliver at a scheduled deliver time." + }, + { + "name": "ASAP", + "description": "Indicates that the fulfillment to deliver as soon as possible and should be prepared\nimmediately." + } + ], + "description": "The schedule type of the delivery fulfillment.", + "x-release-status": "BETA" + }, + "OrderFulfillmentFulfillmentEntry": { + "type": "object", + "description": "Links an order line item to a fulfillment. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.", + "x-release-status": "BETA", + "required": [ + "line_item_uid", + "quantity" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the fulfillment entry only within this order.", + "maxLength": 60, + "nullable": true + }, + "line_item_uid": { + "type": "string", + "description": "The `uid` from the order line item.", + "minLength": 1 + }, + "quantity": { + "type": "string", + "description": "The quantity of the line item being fulfilled, formatted as a decimal number.\nFor example, `\"3\"`.\nFulfillments for line items with a `quantity_unit` can have non-integer quantities.\nFor example, `\"1.70000\"`.", + "minLength": 1, + "maxLength": 12 + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this fulfillment entry. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\nValues have a maximum length of 255 characters.\nAn application can have up to 10 entries per metadata field.\nEntries written by applications are private and can only be read or modified by the same\napplication.\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "nullable": true + } + } + }, + "OrderFulfillmentFulfillmentLineItemApplication": { + "type": "string", + "enum": [ + "ALL", + "ENTRY_LIST" + ], + "x-enum-elements": [ + { + "name": "ALL", + "description": "If `ALL`, `entries` must be unset." + }, + { + "name": "ENTRY_LIST", + "description": "If `ENTRY_LIST`, supply a list of `entries`." + } + ], + "description": "The `line_item_application` describes what order line items this fulfillment applies\nto. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.", + "x-release-status": "BETA" + }, + "OrderFulfillmentPickupDetails": { + "type": "object", + "description": "Contains details necessary to fulfill a pickup order.", + "x-release-status": "PUBLIC", + "properties": { + "recipient": { + "$ref": "#/components/schemas/OrderFulfillmentRecipient", + "description": "Information about the person to pick up this fulfillment from a physical\nlocation.", + "nullable": true + }, + "expires_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment expires if it is not marked in progress. The timestamp must be\nin RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set\nup to 7 days in the future. If `expires_at` is not set, any new payments attached to the order\nare automatically completed.", + "nullable": true + }, + "auto_complete_duration": { + "type": "string", + "description": "The duration of time after which an in progress pickup fulfillment is automatically moved\nto the `COMPLETED` state. The duration must be in RFC 3339 format (for example, \"P1W3D\").\n\nIf not set, this pickup fulfillment remains in progress until it is canceled or completed.", + "nullable": true + }, + "schedule_type": { + "$ref": "#/components/schemas/OrderFulfillmentPickupDetailsScheduleType", + "description": "The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`.\nSee [OrderFulfillmentPickupDetailsScheduleType](#type-orderfulfillmentpickupdetailsscheduletype) for possible values", + "nullable": true + }, + "pickup_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,\n\"2016-09-04T23:59:33.123Z\".\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment.", + "nullable": true + }, + "pickup_window_duration": { + "type": "string", + "description": "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an\ninformational guideline for merchants.", + "nullable": true + }, + "prep_time_duration": { + "type": "string", + "description": "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\").", + "nullable": true + }, + "note": { + "type": "string", + "description": "A note to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API.", + "maxLength": 500, + "nullable": true + }, + "placed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "accepted_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "rejected_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "ready_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "expired_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "picked_up_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "cancel_reason": { + "type": "string", + "description": "A description of why the pickup was canceled. The maximum length: 100 characters.", + "maxLength": 100, + "nullable": true + }, + "is_curbside_pickup": { + "type": "boolean", + "description": "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.", + "x-release-status": "BETA", + "nullable": true + }, + "curbside_pickup_details": { + "$ref": "#/components/schemas/OrderFulfillmentPickupDetailsCurbsidePickupDetails", + "description": "Specific details for curbside pickup. These details can only be populated if `is_curbside_pickup` is set to `true`.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderFulfillmentPickupDetailsCurbsidePickupDetails": { + "type": "object", + "description": "Specific details for curbside pickup.", + "x-release-status": "BETA", + "properties": { + "curbside_details": { + "type": "string", + "description": "Specific details for curbside pickup, such as parking number and vehicle model.", + "maxLength": 250, + "nullable": true + }, + "buyer_arrived_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + } + } + }, + "OrderFulfillmentPickupDetailsScheduleType": { + "type": "string", + "enum": [ + "SCHEDULED", + "ASAP" + ], + "x-enum-elements": [ + { + "name": "SCHEDULED", + "description": "Indicates that the fulfillment will be picked up at a scheduled pickup time." + }, + { + "name": "ASAP", + "description": "Indicates that the fulfillment will be picked up as soon as possible and\nshould be prepared immediately." + } + ], + "description": "The schedule type of the pickup fulfillment.", + "x-release-status": "PUBLIC" + }, + "OrderFulfillmentRecipient": { + "type": "object", + "description": "Information about the fulfillment recipient.", + "x-release-status": "PUBLIC", + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the customer associated with the fulfillment.\nIf `customer_id` is provided, the fulfillment recipient's `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", + "maxLength": 191, + "nullable": true + }, + "display_name": { + "type": "string", + "description": "The display name of the fulfillment recipient. This field is required.\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", + "maxLength": 255, + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address of the fulfillment recipient.\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", + "maxLength": 255, + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number of the fulfillment recipient. This field is required.\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", + "maxLength": 17, + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The address of the fulfillment recipient. This field is required.\nIf provided, the address overrides the corresponding customer profile value\nindicated by `customer_id`.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderFulfillmentShipmentDetails": { + "type": "object", + "description": "Contains the details necessary to fulfill a shipment order.", + "x-release-status": "BETA", + "properties": { + "recipient": { + "$ref": "#/components/schemas/OrderFulfillmentRecipient", + "description": "Information about the person to receive this shipment fulfillment.", + "nullable": true + }, + "carrier": { + "type": "string", + "description": "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).", + "maxLength": 50, + "nullable": true + }, + "shipping_note": { + "type": "string", + "description": "A note with additional information for the shipping carrier.", + "maxLength": 500, + "nullable": true + }, + "shipping_type": { + "type": "string", + "description": "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express).", + "maxLength": 50, + "nullable": true + }, + "tracking_number": { + "type": "string", + "description": "The reference number provided by the carrier to track the shipment's progress.", + "maxLength": 100, + "nullable": true + }, + "tracking_url": { + "type": "string", + "description": "A link to the tracking webpage on the carrier's website.", + "maxLength": 2000, + "nullable": true + }, + "placed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "in_progress_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "packaged_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "expected_shipped_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "shipped_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "canceled_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").", + "nullable": true + }, + "cancel_reason": { + "type": "string", + "description": "A description of why the shipment was canceled.", + "maxLength": 100, + "nullable": true + }, + "failed_at": { + "type": "string", + "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\").", + "readOnly": true + }, + "failure_reason": { + "type": "string", + "description": "A description of why the shipment failed to be completed.", + "maxLength": 100, + "nullable": true + } + } + }, + "OrderFulfillmentState": { + "type": "string", + "enum": [ + "PROPOSED", + "RESERVED", + "PREPARED", + "COMPLETED", + "CANCELED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "PROPOSED", + "description": "Indicates that the fulfillment has been proposed." + }, + { + "name": "RESERVED", + "description": "Indicates that the fulfillment has been reserved." + }, + { + "name": "PREPARED", + "description": "Indicates that the fulfillment has been prepared." + }, + { + "name": "COMPLETED", + "description": "Indicates that the fulfillment was successfully completed." + }, + { + "name": "CANCELED", + "description": "Indicates that the fulfillment was canceled." + }, + { + "name": "FAILED", + "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled." + } + ], + "description": "The current state of this fulfillment.", + "x-release-status": "PUBLIC" + }, + "OrderFulfillmentType": { + "type": "string", + "enum": [ + "PICKUP", + "SHIPMENT", + "DELIVERY" + ], + "x-enum-elements": [ + { + "name": "PICKUP", + "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)." + }, + { + "name": "SHIPMENT", + "description": "A shipping carrier to ship the fulfillment." + }, + { + "name": "DELIVERY", + "description": "A courier to deliver the fulfillment." + } + ], + "description": "The type of fulfillment.", + "x-release-status": "PUBLIC" + }, + "OrderFulfillmentUpdated": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order_id": { + "type": "string", + "description": "The order's unique ID.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version number, which is incremented each time an update is committed to the order.\nOrders that were not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)" + }, + "location_id": { + "type": "string", + "description": "The ID of the seller location that this order is associated with.", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/OrderState", + "description": "The state of the order.\nSee [OrderState](#type-orderstate) for possible values", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the order was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp for when the order was last updated, in RFC 3339 format.", + "readOnly": true + }, + "fulfillment_update": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderFulfillmentUpdatedUpdate" + }, + "description": "The fulfillments that were updated with this version change.", + "nullable": true + } + } + }, + "OrderFulfillmentUpdatedObject": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order_fulfillment_updated": { + "$ref": "#/components/schemas/OrderFulfillmentUpdated", + "description": "Information about the updated order fulfillment.", + "nullable": true + } + } + }, + "OrderFulfillmentUpdatedUpdate": { + "type": "object", + "description": "Information about fulfillment updates.", + "x-release-status": "BETA", + "properties": { + "fulfillment_uid": { + "type": "string", + "description": "A unique ID that identifies the fulfillment only within this order.", + "nullable": true + }, + "old_state": { + "$ref": "#/components/schemas/FulfillmentState", + "description": "The state of the fulfillment before the change.\nThe state is not populated if the fulfillment is created with this new `Order` version.", + "nullable": true + }, + "new_state": { + "$ref": "#/components/schemas/FulfillmentState", + "description": "The state of the fulfillment after the change. The state might be equal to `old_state` if a non-state\nfield was changed on the fulfillment (such as the tracking number).", + "nullable": true + } + } + }, + "OrderLineItem": { + "type": "object", + "description": "Represents a line item in an order. Each line item describes a different\nproduct to purchase, with its own quantity and price details.", + "x-release-status": "PUBLIC", + "required": [ + "quantity" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the line item only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the line item.", + "maxLength": 512, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The count, or measurement, of a line item being purchased:\n\nIf `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count. For example: `3` apples.\n\nIf `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement. For example: `2.25` pounds of broccoli.\n\nFor more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).\n\nLine items with a quantity of `0` are automatically removed\nwhen paying for or otherwise completing the order.", + "minLength": 1, + "maxLength": 12 + }, + "quantity_unit": { + "$ref": "#/components/schemas/OrderQuantityUnit", + "description": "The measurement unit and decimal precision that this line item's quantity is measured in.", + "nullable": true + }, + "note": { + "type": "string", + "description": "An optional note associated with the line item.", + "maxLength": 2000, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this line item references.", + "format": "int64", + "nullable": true + }, + "variation_name": { + "type": "string", + "description": "The name of the variation applied to this line item.", + "maxLength": 400, + "nullable": true + }, + "item_type": { + "$ref": "#/components/schemas/OrderLineItemItemType", + "description": "The type of line item: an itemized sale, a non-itemized sale (custom amount), or the\nactivation or reloading of a gift card.\nSee [OrderLineItemItemType](#type-orderlineitemitemtype) for possible values", + "nullable": true + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this line item. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "modifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemModifier" + }, + "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", + "nullable": true + }, + "applied_taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedTax" + }, + "description": "The list of references to taxes applied to this line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a\ntop-level `OrderLineItemTax` applied to the line item. On reads, the\namount applied is populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every line\nitem for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`\nrecords for `LINE_ITEM` scoped taxes must be added in requests for the tax\nto apply to any line items.\n\nTo change the amount of a tax, modify the referenced top-level tax.", + "x-release-status": "BETA", + "nullable": true + }, + "applied_discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedDiscount" + }, + "description": "The list of references to discounts applied to this line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderLineItemDiscounts` applied to the line item. On reads, the amount\napplied is populated.\n\nAn `OrderLineItemAppliedDiscount` is automatically created on every line item for all\n`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records\nfor `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any\nline items.\n\nTo change the amount of a discount, modify the referenced top-level discount.", + "x-release-status": "BETA", + "nullable": true + }, + "applied_service_charges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedServiceCharge" + }, + "description": "The list of references to service charges applied to this line item. Each\n`OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a\ntop-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is\npopulated.\n\nTo change the amount of a service charge, modify the referenced top-level service charge.", + "x-release-status": "BETA", + "nullable": true + }, + "base_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The base price for a single unit of the line item.", + "nullable": true + }, + "variation_total_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The total price of all item variations sold in this line item.\nThe price is calculated as `base_price_money` multiplied by `quantity`.\nIt does not include modifiers.", + "readOnly": true + }, + "gross_sales_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money made in gross sales for this line item.\nThe amount is calculated as the sum of the variation's total price and each modifier's total price.\nFor inclusive tax items in the US, Canada, and Japan, tax is deducted from `gross_sales_money`. For Europe and\nAustralia, inclusive tax remains as part of the gross sale calculation.", + "readOnly": true + }, + "total_tax_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of tax money to collect for the line item.", + "readOnly": true + }, + "total_discount_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of discount money to collect for the line item.", + "readOnly": true + }, + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of money to collect for this line item.", + "readOnly": true + }, + "pricing_blocklists": { + "$ref": "#/components/schemas/OrderLineItemPricingBlocklists", + "description": "Describes pricing adjustments that are blocked from automatic\napplication to a line item. For more information, see\n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).", + "x-release-status": "BETA", + "nullable": true + }, + "total_service_charge_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of apportioned service charge money to collect for the line item.", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "OrderLineItemAppliedDiscount": { + "type": "object", + "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", + "x-release-status": "BETA", + "required": [ + "discount_uid" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the applied discount only within this order.", + "maxLength": 60, + "nullable": true + }, + "discount_uid": { + "type": "string", + "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", + "minLength": 1, + "maxLength": 60 + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied by the discount to the line item.", + "readOnly": true + } + } + }, + "OrderLineItemAppliedServiceCharge": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "service_charge_uid" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the applied service charge only within this order.", + "maxLength": 60, + "nullable": true + }, + "service_charge_uid": { + "type": "string", + "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", + "minLength": 1, + "maxLength": 60 + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied by the service charge to the line item.", + "readOnly": true + } + } + }, + "OrderLineItemAppliedTax": { + "type": "object", + "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", + "x-release-status": "BETA", + "required": [ + "tax_uid" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the applied tax only within this order.", + "maxLength": 60, + "nullable": true + }, + "tax_uid": { + "type": "string", + "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", + "minLength": 1, + "maxLength": 60 + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied by the tax to the line item.", + "readOnly": true + } + } + }, + "OrderLineItemDiscount": { + "type": "object", + "description": "Represents a discount that applies to one or more line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the\namount contributed by the item to the order subtotal.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the discount only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this discount references.", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "description": "The discount's name.", + "maxLength": 255, + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/OrderLineItemDiscountType", + "description": "The type of the discount.\n\nDiscounts that do not reference a catalog object ID must have a type of\n`FIXED_PERCENTAGE` or `FIXED_AMOUNT`.\nSee [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the discount, as a string representation of a decimal number.\nA value of `7.25` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", + "maxLength": 10, + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The total declared monetary amount of the discount.\n\n`amount_money` is not set for percentage-based discounts.", + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of discount actually applied to the line item.\n\nThe amount represents the amount of money applied as a line-item scoped discount.\nWhen an amount-based discount is scoped to the entire order, the value\nof `applied_money` is different than `amount_money` because the total\namount of the discount is distributed across all line items.", + "nullable": true + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this discount. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "scope": { + "$ref": "#/components/schemas/OrderLineItemDiscountScope", + "description": "Indicates the level at which the discount applies. For `ORDER` scoped discounts,\nSquare generates references in `applied_discounts` on all order line items that do\nnot have them. For `LINE_ITEM` scoped discounts, the discount only applies to line items\nwith a discount reference in their `applied_discounts` field.\n\nThis field is immutable. To change the scope of a discount, you must delete\nthe discount and re-add it as a new discount.\nSee [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values", + "nullable": true + }, + "reward_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The reward IDs corresponding to this discount. The application and\nspecification of discounts that have `reward_ids` are completely controlled by the backing\ncriteria corresponding to the reward tiers of the rewards that are added to the order\nthrough the Loyalty API. To manually unapply discounts that are the result of added rewards,\nthe rewards must be removed from the order through the Loyalty API.", + "readOnly": true, + "x-release-status": "BETA" + }, + "pricing_rule_id": { + "type": "string", + "description": "The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", + "readOnly": true + } + } + }, + "OrderLineItemDiscountScope": { + "type": "string", + "enum": [ + "OTHER_DISCOUNT_SCOPE", + "LINE_ITEM", + "ORDER" + ], + "x-enum-elements": [ + { + "name": "OTHER_DISCOUNT_SCOPE", + "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API." + }, + { + "name": "LINE_ITEM", + "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records." + }, + { + "name": "ORDER", + "description": "The discount should be applied to the entire order." + } + ], + "description": "Indicates whether this is a line-item or order-level discount.", + "x-release-status": "PUBLIC" + }, + "OrderLineItemDiscountType": { + "type": "string", + "enum": [ + "UNKNOWN_DISCOUNT", + "FIXED_PERCENTAGE", + "FIXED_AMOUNT", + "VARIABLE_PERCENTAGE", + "VARIABLE_AMOUNT" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN_DISCOUNT", + "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API." + }, + { + "name": "FIXED_PERCENTAGE", + "description": "Apply the discount as a fixed percentage (such as 5%) off the item price." + }, + { + "name": "FIXED_AMOUNT", + "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price." + }, + { + "name": "VARIABLE_PERCENTAGE", + "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase." + }, + { + "name": "VARIABLE_AMOUNT", + "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase." + } + ], + "description": "Indicates how the discount is applied to the associated line item or order.", + "x-release-status": "PUBLIC" + }, + "OrderLineItemItemType": { + "type": "string", + "enum": [ + "ITEM", + "CUSTOM_AMOUNT", + "GIFT_CARD" + ], + "x-enum-elements": [ + { + "name": "ITEM", + "description": "Indicates that the line item is an itemized sale." + }, + { + "name": "CUSTOM_AMOUNT", + "description": "Indicates that the line item is a non-itemized sale." + }, + { + "name": "GIFT_CARD", + "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`." + } + ], + "description": "Represents the line item type.", + "x-release-status": "BETA" + }, + "OrderLineItemModifier": { + "type": "object", + "description": "A [CatalogModifier](entity:CatalogModifier).", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the modifier only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this modifier references.", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the item modifier.", + "maxLength": 255, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", + "nullable": true + }, + "base_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](entity:CatalogModifier) price.", + "nullable": true + }, + "total_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The total price of the item modifier for its line item.\nThis is the modifier's `base_price_money` multiplied by the line item's quantity.", + "readOnly": true + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderLineItemPricingBlocklists": { + "type": "object", + "description": "Describes pricing adjustments that are blocked from automatic\napplication to a line item. For more information, see\n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).", + "x-release-status": "BETA", + "properties": { + "blocked_discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemPricingBlocklistsBlockedDiscount" + }, + "description": "A list of discounts blocked from applying to the line item.\nDiscounts can be blocked by the `discount_uid` (for ad hoc discounts) or\nthe `discount_catalog_object_id` (for catalog discounts).", + "nullable": true + }, + "blocked_taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemPricingBlocklistsBlockedTax" + }, + "description": "A list of taxes blocked from applying to the line item.\nTaxes can be blocked by the `tax_uid` (for ad hoc taxes) or\nthe `tax_catalog_object_id` (for catalog taxes).", + "nullable": true + } + } + }, + "OrderLineItemPricingBlocklistsBlockedDiscount": { + "type": "object", + "description": "A discount to block from applying to a line item. The discount must be\nidentified by either `discount_uid` or `discount_catalog_object_id`, but not both.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID of the `BlockedDiscount` within the order.", + "maxLength": 60, + "nullable": true + }, + "discount_uid": { + "type": "string", + "description": "The `uid` of the discount that should be blocked. Use this field to block\nad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.", + "maxLength": 60, + "nullable": true + }, + "discount_catalog_object_id": { + "type": "string", + "description": "The `catalog_object_id` of the discount that should be blocked.\nUse this field to block catalog discounts. For ad hoc discounts, use the\n`discount_uid` field.", + "maxLength": 192, + "nullable": true + } + } + }, + "OrderLineItemPricingBlocklistsBlockedTax": { + "type": "object", + "description": "A tax to block from applying to a line item. The tax must be\nidentified by either `tax_uid` or `tax_catalog_object_id`, but not both.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID of the `BlockedTax` within the order.", + "maxLength": 60, + "nullable": true + }, + "tax_uid": { + "type": "string", + "description": "The `uid` of the tax that should be blocked. Use this field to block\nad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.", + "maxLength": 60, + "nullable": true + }, + "tax_catalog_object_id": { + "type": "string", + "description": "The `catalog_object_id` of the tax that should be blocked.\nUse this field to block catalog taxes. For ad hoc taxes, use the\n`tax_uid` field.", + "maxLength": 192, + "nullable": true + } + } + }, + "OrderLineItemTax": { + "type": "object", + "description": "Represents a tax that applies to one or more line item in the order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the amount the item\ncontributes to the order subtotal.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the tax only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this tax references.", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "description": "The tax's name.", + "maxLength": 255, + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/OrderLineItemTaxType", + "description": "Indicates the calculation method used to apply the tax.\nSee [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the tax, as a string representation of a decimal\nnumber. For example, a value of `\"7.25\"` corresponds to a percentage of\n7.25%.", + "maxLength": 10, + "nullable": true + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this tax. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied to the order by the tax.\n\n- For percentage-based taxes, `applied_money` is the money\ncalculated using the percentage.", + "nullable": true + }, + "scope": { + "$ref": "#/components/schemas/OrderLineItemTaxScope", + "description": "Indicates the level at which the tax applies. For `ORDER` scoped taxes,\nSquare generates references in `applied_taxes` on all order line items that do\nnot have them. For `LINE_ITEM` scoped taxes, the tax only applies to line items\nwith references in their `applied_taxes` field.\n\nThis field is immutable. To change the scope, you must delete the tax and\nre-add it as a new tax.\nSee [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values", + "nullable": true + }, + "auto_applied": { + "type": "boolean", + "description": "Determines whether the tax was automatically applied to the order based on\nthe catalog configuration. For an example, see\n[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "OrderLineItemTaxScope": { + "type": "string", + "enum": [ + "OTHER_TAX_SCOPE", + "LINE_ITEM", + "ORDER" + ], + "x-enum-elements": [ + { + "name": "OTHER_TAX_SCOPE", + "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API." + }, + { + "name": "LINE_ITEM", + "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records." + }, + { + "name": "ORDER", + "description": "The tax should be applied to the entire order." + } + ], + "description": "Indicates whether this is a line-item or order-level tax.", + "x-release-status": "PUBLIC" + }, + "OrderLineItemTaxType": { + "type": "string", + "enum": [ + "UNKNOWN_TAX", + "ADDITIVE", + "INCLUSIVE" + ], + "x-enum-elements": [ + { + "name": "UNKNOWN_TAX", + "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API." + }, + { + "name": "ADDITIVE", + "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD." + }, + { + "name": "INCLUSIVE", + "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer." + } + ], + "description": "Indicates how the tax is applied to the associated line item or order.", + "x-release-status": "PUBLIC" + }, + "OrderMoneyAmounts": { + "type": "object", + "description": "A collection of various money amounts.", + "x-release-status": "BETA", + "properties": { + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total money.", + "nullable": true + }, + "tax_money": { + "$ref": "#/components/schemas/Money", + "description": "The money associated with taxes.", + "nullable": true + }, + "discount_money": { + "$ref": "#/components/schemas/Money", + "description": "The money associated with discounts.", + "nullable": true + }, + "tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The money associated with tips.", + "nullable": true + }, + "service_charge_money": { + "$ref": "#/components/schemas/Money", + "description": "The money associated with service charges.", + "nullable": true + } + } + }, + "OrderPricingOptions": { + "type": "object", + "description": "Pricing options for an order. The options affect how the order's price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](entity:CatalogPricingRule).", + "x-release-status": "PUBLIC", + "properties": { + "auto_apply_discounts": { + "type": "boolean", + "description": "The option to determine whether pricing rule-based\ndiscounts are automatically applied to an order.", + "nullable": true + }, + "auto_apply_taxes": { + "type": "boolean", + "description": "The option to determine whether rule-based taxes are automatically\napplied to an order when the criteria of the corresponding rules are met.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderQuantityUnit": { + "type": "object", + "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", + "x-release-status": "PUBLIC", + "properties": { + "measurement_unit": { + "$ref": "#/components/schemas/MeasurementUnit", + "description": "A [MeasurementUnit](entity:MeasurementUnit) that represents the\nunit of measure for the quantity.", + "nullable": true + }, + "precision": { + "type": "integer", + "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `\"1.0\"` and `\"1.1\"`, but not `\"1.01\"`.\n\nMin: 0. Max: 5.", + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", + "format": "int64", + "nullable": true + } + } + }, + "OrderReturn": { + "type": "object", + "description": "The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the return only within this order.", + "maxLength": 60, + "nullable": true + }, + "source_order_id": { + "type": "string", + "description": "An order that contains the original sale of these return line items. This is unset\nfor unlinked returns.", + "nullable": true + }, + "return_line_items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + }, + "description": "A collection of line items that are being returned.", + "nullable": true + }, + "return_service_charges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnServiceCharge" + }, + "description": "A collection of service charges that are being returned.", + "nullable": true + }, + "return_taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnTax" + }, + "description": "A collection of references to taxes being returned for an order, including the total\napplied tax amount to be returned. The taxes must reference a top-level tax ID from the source\norder.", + "readOnly": true + }, + "return_discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnDiscount" + }, + "description": "A collection of references to discounts being returned for an order, including the total\napplied discount amount to be returned. The discounts must reference a top-level discount ID\nfrom the source order.", + "readOnly": true + }, + "return_tips": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnTip" + }, + "description": "A collection of references to tips being returned for an order.", + "nullable": true + }, + "rounding_adjustment": { + "$ref": "#/components/schemas/OrderRoundingAdjustment", + "description": "A positive or negative rounding adjustment to the total value being returned. Adjustments are commonly\nused to apply cash rounding when the minimum unit of the account is smaller than the lowest\nphysical denomination of the currency.", + "nullable": true + }, + "return_amounts": { + "$ref": "#/components/schemas/OrderMoneyAmounts", + "description": "An aggregate monetary value being returned by this return entry.", + "nullable": true + } + } + }, + "OrderReturnDiscount": { + "type": "object", + "description": "Represents a discount being returned that applies to one or more return line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item’s contribution to the\norder subtotal.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the returned discount only within this order.", + "maxLength": 60, + "nullable": true + }, + "source_discount_uid": { + "type": "string", + "description": "The discount `uid` from the order that contains the original application of this discount.", + "maxLength": 60, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this discount references.", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "description": "The discount's name.", + "maxLength": 255, + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/OrderLineItemDiscountType", + "description": "The type of the discount. If it is created by the API, it is `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.\n\nDiscounts that do not reference a catalog object ID must have a type of\n`FIXED_PERCENTAGE` or `FIXED_AMOUNT`.\nSee [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the tax, as a string representation of a decimal number.\nA value of `\"7.25\"` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", + "maxLength": 10, + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The total declared monetary amount of the discount.\n\n`amount_money` is not set for percentage-based discounts.", + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of discount actually applied to this line item. When an amount-based\ndiscount is at the order level, this value is different from `amount_money` because the discount\nis distributed across the line items.", + "readOnly": true + }, + "scope": { + "$ref": "#/components/schemas/OrderLineItemDiscountScope", + "description": "Indicates the level at which the `OrderReturnDiscount` applies. For `ORDER` scoped\ndiscounts, the server generates references in `applied_discounts` on all\n`OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount is only applied to\n`OrderReturnLineItem`s with references in their `applied_discounts` field.\nSee [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values", + "nullable": true + } + } + }, + "OrderReturnLineItem": { + "type": "object", + "description": "The line item being returned in an order.", + "x-release-status": "BETA", + "required": [ + "quantity" + ], + "properties": { + "uid": { + "type": "string", + "description": "A unique ID for this return line-item entry.", + "maxLength": 60, + "nullable": true + }, + "source_line_item_uid": { + "type": "string", + "description": "The `uid` of the line item in the original sale order.", + "maxLength": 60, + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the line item.", + "maxLength": 512, + "nullable": true + }, + "quantity": { + "type": "string", + "description": "The quantity returned, formatted as a decimal number.\nFor example, `\"3\"`.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `\"1.70000\"`.", + "minLength": 1, + "maxLength": 12 + }, + "quantity_unit": { + "$ref": "#/components/schemas/OrderQuantityUnit", + "description": "The unit and precision that this return line item's quantity is measured in.", + "nullable": true + }, + "note": { + "type": "string", + "description": "The note of the return line item.", + "maxLength": 2000, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this line item references.", + "format": "int64", + "nullable": true + }, + "variation_name": { + "type": "string", + "description": "The name of the variation applied to this return line item.", + "maxLength": 400, + "nullable": true + }, + "item_type": { + "$ref": "#/components/schemas/OrderLineItemItemType", + "description": "The type of line item: an itemized return, a non-itemized return (custom amount),\nor the return of an unactivated gift card sale.\nSee [OrderLineItemItemType](#type-orderlineitemitemtype) for possible values", + "nullable": true + }, + "return_modifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemModifier" + }, + "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", + "nullable": true + }, + "applied_taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedTax" + }, + "description": "The list of references to `OrderReturnTax` entities applied to the return line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderReturnTax` applied to the return line item. On reads, the applied amount\nis populated.", + "nullable": true + }, + "applied_discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedDiscount" + }, + "description": "The list of references to `OrderReturnDiscount` entities applied to the return line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderReturnDiscount` applied to the return line item. On reads, the applied amount\nis populated.", + "nullable": true + }, + "base_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The base price for a single unit of the line item.", + "nullable": true + }, + "variation_total_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The total price of all item variations returned in this line item.\nThe price is calculated as `base_price_money` multiplied by `quantity` and\ndoes not include modifiers.", + "readOnly": true + }, + "gross_return_money": { + "$ref": "#/components/schemas/Money", + "description": "The gross return amount of money calculated as (item base price + modifiers price) * quantity.", + "readOnly": true + }, + "total_tax_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of tax money to return for the line item.", + "readOnly": true + }, + "total_discount_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of discount money to return for the line item.", + "readOnly": true + }, + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of money to return for this line item.", + "readOnly": true + }, + "applied_service_charges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedServiceCharge" + }, + "description": "The list of references to `OrderReturnServiceCharge` entities applied to the return\nline item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that\nreferences the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line\nitem. On reads, the applied amount is populated.", + "nullable": true + }, + "total_service_charge_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of apportioned service charge money to return for the line item.", + "readOnly": true + } + } + }, + "OrderReturnLineItemModifier": { + "type": "object", + "description": "A line item modifier being returned.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the return modifier only within this order.", + "maxLength": 60, + "nullable": true + }, + "source_modifier_uid": { + "type": "string", + "description": "The modifier `uid` from the order's line item that contains the\noriginal sale of this line item modifier.", + "maxLength": 60, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this line item modifier references.", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the item modifier.", + "maxLength": 255, + "nullable": true + }, + "base_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](entity:CatalogModifier) price.", + "nullable": true + }, + "total_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The total price of the item modifier for its line item.\nThis is the modifier's `base_price_money` multiplied by the line item's quantity.", + "readOnly": true + }, + "quantity": { + "type": "string", + "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", + "nullable": true + } + } + }, + "OrderReturnServiceCharge": { + "type": "object", + "description": "Represents the service charge applied to the original order.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the return service charge only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "source_service_charge_uid": { + "type": "string", + "description": "The service charge `uid` from the order containing the original\nservice charge. `source_service_charge_uid` is `null` for\nunlinked returns.", + "maxLength": 60, + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the service charge.", + "maxLength": 255, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this service charge references.", + "format": "int64", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the service charge, as a string representation of\na decimal number. For example, a value of `\"7.25\"` corresponds to a\npercentage of 7.25%.\n\nEither `percentage` or `amount_money` should be set, but not both.", + "maxLength": 10, + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of a non-percentage-based service charge.\n\nEither `percentage` or `amount_money` should be set, but not both.", + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied to the order by the service charge, including\nany inclusive tax amounts, as calculated by Square.\n\n- For fixed-amount service charges, `applied_money` is equal to `amount_money`.\n- For percentage-based service charges, `applied_money` is the money calculated using the percentage.", + "readOnly": true + }, + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of money to collect for the service charge.\n\n__NOTE__: If an inclusive tax is applied to the service charge, `total_money`\ndoes not equal `applied_money` plus `total_tax_money` because the inclusive\ntax amount is already included in both `applied_money` and `total_tax_money`.", + "readOnly": true + }, + "total_tax_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of tax money to collect for the service charge.", + "readOnly": true + }, + "calculation_phase": { + "$ref": "#/components/schemas/OrderServiceChargeCalculationPhase", + "description": "The calculation phase after which to apply the service charge.\nSee [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values", + "readOnly": true + }, + "taxable": { + "type": "boolean", + "description": "Indicates whether the surcharge can be taxed. Service charges\ncalculated in the `TOTAL_PHASE` cannot be marked as taxable.", + "nullable": true + }, + "applied_taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedTax" + }, + "description": "The list of references to `OrderReturnTax` entities applied to the\n`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`\nthat references the `uid` of a top-level `OrderReturnTax` that is being\napplied to the `OrderReturnServiceCharge`. On reads, the applied amount is\npopulated.", + "x-release-status": "BETA", + "nullable": true + }, + "treatment_type": { + "$ref": "#/components/schemas/OrderServiceChargeTreatmentType", + "description": "The treatment type of the service charge.\nSee [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) for possible values", + "x-release-status": "BETA", + "nullable": true + }, + "scope": { + "$ref": "#/components/schemas/OrderServiceChargeScope", + "description": "Indicates the level at which the apportioned service charge applies. For `ORDER`\nscoped service charges, Square generates references in `applied_service_charges` on\nall order line items that do not have them. For `LINE_ITEM` scoped service charges,\nthe service charge only applies to line items with a service charge reference in their\n`applied_service_charges` field.\n\nThis field is immutable. To change the scope of an apportioned service charge, you must delete\nthe apportioned service charge and re-add it as a new apportioned service charge.\nSee [OrderServiceChargeScope](#type-orderservicechargescope) for possible values", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderReturnTax": { + "type": "object", + "description": "Represents a tax being returned that applies to one or more return line items in an order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item’s contribution to the\norder subtotal.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the returned tax only within this order.", + "maxLength": 60, + "nullable": true + }, + "source_tax_uid": { + "type": "string", + "description": "The tax `uid` from the order that contains the original tax charge.", + "maxLength": 60, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this tax references.", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "description": "The tax's name.", + "maxLength": 255, + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/OrderLineItemTaxType", + "description": "Indicates the calculation method used to apply the tax.\nSee [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The percentage of the tax, as a string representation of a decimal number.\nFor example, a value of `\"7.25\"` corresponds to a percentage of 7.25%.", + "maxLength": 10, + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied by the tax in an order.", + "readOnly": true + }, + "scope": { + "$ref": "#/components/schemas/OrderLineItemTaxScope", + "description": "Indicates the level at which the `OrderReturnTax` applies. For `ORDER` scoped\ntaxes, Square generates references in `applied_taxes` on all\n`OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax is only applied to\n`OrderReturnLineItem`s with references in their `applied_discounts` field.\nSee [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values", + "nullable": true + } + } + }, + "OrderReturnTip": { + "type": "object", + "description": "A tip being returned.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the tip only within this order.", + "maxLength": 60, + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of tip being returned\n--", + "readOnly": true + }, + "source_tender_uid": { + "type": "string", + "description": "The tender `uid` from the order that contains the original application of this tip.", + "maxLength": 192, + "nullable": true + }, + "source_tender_id": { + "type": "string", + "description": "The tender `id` from the order that contains the original application of this tip.", + "maxLength": 192, + "nullable": true + } + } + }, + "OrderReward": { + "type": "object", + "description": "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API.", + "x-release-status": "BETA", + "required": [ + "id", + "reward_tier_id" + ], + "properties": { + "id": { + "type": "string", + "description": "The identifier of the reward.", + "minLength": 1 + }, + "reward_tier_id": { + "type": "string", + "description": "The identifier of the reward tier corresponding to this reward.", + "minLength": 1 + } + } + }, + "OrderRoundingAdjustment": { + "type": "object", + "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", + "x-release-status": "BETA", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the rounding adjustment only within this order.", + "maxLength": 60, + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the rounding adjustment from the original sale order.", + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The actual rounding adjustment amount.", + "nullable": true + } + } + }, + "OrderServiceCharge": { + "type": "object", + "description": "Represents a service charge applied to an order.", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "A unique ID that identifies the service charge only within this order.", + "maxLength": 60, + "x-release-status": "BETA", + "nullable": true + }, + "name": { + "type": "string", + "description": "The name of the service charge.", + "maxLength": 512, + "nullable": true + }, + "catalog_object_id": { + "type": "string", + "description": "The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).", + "maxLength": 192, + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "The version of the catalog object that this service charge references.", + "format": "int64", + "nullable": true + }, + "percentage": { + "type": "string", + "description": "The service charge percentage as a string representation of a\ndecimal number. For example, `\"7.25\"` indicates a service charge of 7.25%.\n\nExactly 1 of `percentage` or `amount_money` should be set.", + "maxLength": 10, + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of a non-percentage-based service charge.\n\nExactly one of `percentage` or `amount_money` should be set.", + "nullable": true + }, + "applied_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money applied to the order by the service charge,\nincluding any inclusive tax amounts, as calculated by Square.\n\n- For fixed-amount service charges, `applied_money` is equal to `amount_money`.\n- For percentage-based service charges, `applied_money` is the money\ncalculated using the percentage.", + "readOnly": true + }, + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of money to collect for the service charge.\n\n__Note__: If an inclusive tax is applied to the service charge,\n`total_money` does not equal `applied_money` plus `total_tax_money`\nbecause the inclusive tax amount is already included in both\n`applied_money` and `total_tax_money`.", + "readOnly": true + }, + "total_tax_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of tax money to collect for the service charge.", + "readOnly": true + }, + "calculation_phase": { + "$ref": "#/components/schemas/OrderServiceChargeCalculationPhase", + "description": "The calculation phase at which to apply the service charge.\nSee [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values", + "nullable": true + }, + "taxable": { + "type": "boolean", + "description": "Indicates whether the service charge can be taxed. If set to `true`,\norder-level taxes automatically apply to the service charge. Note that\nservice charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.", + "nullable": true + }, + "applied_taxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemAppliedTax" + }, + "description": "The list of references to the taxes applied to this service charge. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied\nis populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every taxable service charge\nfor all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records\nfor `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable\nservice charge. Taxable service charges have the `taxable` field set to `true` and calculated\nin the `SUBTOTAL_PHASE`.\n\nTo change the amount of a tax, modify the referenced top-level tax.", + "x-release-status": "BETA", + "nullable": true + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-defined data attached to this service charge. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", + "x-release-status": "BETA", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/OrderServiceChargeType", + "description": "The type of the service charge.\nSee [OrderServiceChargeType](#type-orderservicechargetype) for possible values", + "readOnly": true + }, + "treatment_type": { + "$ref": "#/components/schemas/OrderServiceChargeTreatmentType", + "description": "The treatment type of the service charge.\nSee [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) for possible values", + "x-release-status": "BETA", + "nullable": true + }, + "scope": { + "$ref": "#/components/schemas/OrderServiceChargeScope", + "description": "Indicates the level at which the apportioned service charge applies. For `ORDER`\nscoped service charges, Square generates references in `applied_service_charges` on\nall order line items that do not have them. For `LINE_ITEM` scoped service charges,\nthe service charge only applies to line items with a service charge reference in their\n`applied_service_charges` field.\n\nThis field is immutable. To change the scope of an apportioned service charge, you must delete\nthe apportioned service charge and re-add it as a new apportioned service charge.\nSee [OrderServiceChargeScope](#type-orderservicechargescope) for possible values", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "OrderServiceChargeCalculationPhase": { + "type": "string", + "enum": [ + "SUBTOTAL_PHASE", + "TOTAL_PHASE", + "APPORTIONED_PERCENTAGE_PHASE", + "APPORTIONED_AMOUNT_PHASE" + ], + "x-enum-elements": [ + { + "name": "SUBTOTAL_PHASE", + "description": "The service charge is applied after discounts, but before\ntaxes." + }, + { + "name": "TOTAL_PHASE", + "description": "The service charge is applied after all discounts and taxes\nare applied." + }, + { + "name": "APPORTIONED_PERCENTAGE_PHASE", + "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations." + }, + { + "name": "APPORTIONED_AMOUNT_PHASE", + "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations." + } + ], + "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", + "x-release-status": "PUBLIC" + }, + "OrderServiceChargeScope": { + "type": "string", + "enum": [ + "OTHER_SERVICE_CHARGE_SCOPE", + "LINE_ITEM", + "ORDER" + ], + "x-enum-elements": [ + { + "name": "OTHER_SERVICE_CHARGE_SCOPE", + "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API." + }, + { + "name": "LINE_ITEM", + "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records." + }, + { + "name": "ORDER", + "description": "The service charge should be applied to the entire order." + } + ], + "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", + "x-release-status": "BETA" + }, + "OrderServiceChargeTreatmentType": { + "type": "string", + "enum": [ + "LINE_ITEM_TREATMENT", + "APPORTIONED_TREATMENT" + ], + "x-enum-elements": [ + { + "name": "LINE_ITEM_TREATMENT", + "description": "" + }, + { + "name": "APPORTIONED_TREATMENT", + "description": "" + } + ], + "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", + "x-release-status": "BETA" + }, + "OrderServiceChargeType": { + "type": "string", + "enum": [ + "AUTO_GRATUITY", + "CUSTOM" + ], + "x-enum-elements": [ + { + "name": "AUTO_GRATUITY", + "description": "" + }, + { + "name": "CUSTOM", + "description": "" + } + ], + "x-release-status": "PUBLIC" + }, + "OrderSource": { + "type": "object", + "description": "Represents the origination details of an order.", + "x-release-status": "PUBLIC", + "properties": { + "name": { + "type": "string", + "description": "The name used to identify the place (physical or digital) that an order originates.\nIf unset, the name defaults to the name of the application that created the order.", + "nullable": true + } + } + }, + "OrderState": { + "type": "string", + "enum": [ + "OPEN", + "COMPLETED", + "CANCELED", + "DRAFT" + ], + "x-enum-elements": [ + { + "name": "OPEN", + "description": "Indicates that the order is open. Open orders can be updated." + }, + { + "name": "COMPLETED", + "description": "Indicates that the order is completed. Completed orders are fully paid. This is a terminal state." + }, + { + "name": "CANCELED", + "description": "Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state." + }, + { + "name": "DRAFT", + "description": "Indicates that the order is in a draft state. Draft orders can be updated,\nbut cannot be paid or fulfilled.\nFor more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders)." + } + ], + "description": "The state of the order.", + "x-release-status": "PUBLIC" + }, + "OrderUpdated": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order_id": { + "type": "string", + "description": "The order's unique ID.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version number, which is incremented each time an update is committed to the order.\nOrders that were not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)" + }, + "location_id": { + "type": "string", + "description": "The ID of the seller location that this order is associated with.", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/OrderState", + "description": "The state of the order.\nSee [OrderState](#type-orderstate) for possible values", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the order was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp for when the order was last updated, in RFC 3339 format.", + "readOnly": true + } + } + }, + "OrderUpdatedObject": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "order_updated": { + "$ref": "#/components/schemas/OrderUpdated", + "description": "Information about the updated order.", + "nullable": true + } + } + }, + "PaginationCursor": { + "type": "object", + "description": "Used *internally* to encapsulate pagination details. The resulting proto will be base62 encoded\nin order to produce a cursor that can be used externally.", + "x-release-status": "BETA", + "properties": { + "order_value": { + "type": "string", + "description": "The ID of the last resource in the current page. The page can be in an ascending or\ndescending order", + "nullable": true + } + } + }, + "PauseSubscriptionRequest": { + "type": "object", + "description": "Defines input parameters in a request to the\n[PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.", + "x-release-status": "BETA", + "properties": { + "pause_effective_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the subscription is paused\non the starting date of the next billing cycle.", + "nullable": true + }, + "pause_cycle_duration": { + "type": "integer", + "description": "The number of billing cycles the subscription will be paused before it is reactivated. \n\nWhen this is set, a `RESUME` action is also scheduled to take place on the subscription at \nthe end of the specified pause cycle duration. In this case, neither `resume_effective_date` \nnor `resume_change_timing` may be specified.", + "format": "int64", + "nullable": true + }, + "resume_effective_date": { + "type": "string", + "description": "The date when the subscription is reactivated by a scheduled `RESUME` action. \nThis date must be at least one billing cycle ahead of `pause_effective_date`.", + "nullable": true + }, + "resume_change_timing": { + "$ref": "#/components/schemas/ChangeTiming", + "description": "The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to \n`resume_effective_date`.\nSee [ChangeTiming](#type-changetiming) for possible values", + "nullable": true + }, + "pause_reason": { + "type": "string", + "description": "The user-provided reason to pause the subscription.", + "maxLength": 255, + "nullable": true + } + } + }, + "PauseSubscriptionResponse": { + "type": "object", + "description": "Defines output parameters in a response from the\n[PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The subscription to be paused by the scheduled `PAUSE` action." + }, + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAction" + }, + "description": "The list of a `PAUSE` action and a possible `RESUME` action created by the request." + } + }, + "example": { + "actions": [ + { + "effective_date": "2023-11-17", + "id": "99b2439e-63f7-3ad5-95f7-ab2447a80673", + "type": "PAUSE" + } + ], + "subscription": { + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", + "location_id": "S8GWD5R9QB376", + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "source": { + "name": "My Application" + }, + "start_date": "2023-06-20", + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 1 + } + } + }, + "PayOrderRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the\n[PayOrder](api-endpoint:Orders-PayOrder) endpoint.", + "x-release-status": "BETA", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this request among requests you have sent. If\nyou are unsure whether a particular payment request was completed successfully, you can reattempt\nit with the same idempotency key without worrying about duplicate payments.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1, + "maxLength": 192 + }, + "order_version": { + "type": "integer", + "description": "The version of the order being paid. If not supplied, the latest version will be paid.", + "nullable": true + }, + "payment_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the [payments](entity:Payment) to collect.\nThe payment total must match the order total.", + "nullable": true + } + }, + "example": { + "idempotency_key": "c043a359-7ad9-4136-82a9-c3f1d66dcbff", + "payment_ids": [ + "EnZdNAlWCmfh6Mt5FMNST1o7taB", + "0LRiVlbXVwe8ozu4KbZxd12mvaB" + ] + } + }, + "PayOrderResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](api-endpoint:Orders-PayOrder) endpoint.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "order": { + "$ref": "#/components/schemas/Order", + "description": "The paid, updated [order](entity:Order)." + } + }, + "example": { + "order": { + "closed_at": "2019-08-06T02:47:37.140Z", + "created_at": "2019-08-06T02:47:35.693Z", + "id": "lgwOlEityYPJtcuvKTVKT1pA986YY", + "line_items": [ + { + "base_price_money": { + "amount": 500, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 500, + "currency": "USD" + }, + "name": "Item 1", + "quantity": "1", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 500, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "QW6kofLHJK7JEKMjlSVP5C" + }, + { + "base_price_money": { + "amount": 750, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 1500, + "currency": "USD" + }, + "name": "Item 2", + "quantity": "2", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 1500, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "zhw8MNfRGdFQMI2WE1UBJD" + } + ], + "location_id": "P3CCK6HSNDAS7", + "net_amounts": { + "discount_money": { + "amount": 0, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 0, + "currency": "USD" + }, + "tip_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 2000, + "currency": "USD" + } + }, + "source": { + "name": "Source Name" + }, + "state": "COMPLETED", + "tenders": [ + { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "card_details": { + "card": { + "card_brand": "VISA", + "exp_month": 2, + "exp_year": 2022, + "fingerprint": "sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ", + "last_4": "1111" + }, + "entry_method": "KEYED", + "status": "CAPTURED" + }, + "created_at": "2019-08-06T02:47:36.293Z", + "id": "EnZdNAlWCmfh6Mt5FMNST1o7taB", + "location_id": "P3CCK6HSNDAS7", + "payment_id": "EnZdNAlWCmfh6Mt5FMNST1o7taB", + "transaction_id": "lgwOlEityYPJtcuvKTVKT1pA986YY", + "type": "CARD" + }, + { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "card_details": { + "card": { + "card_brand": "VISA", + "exp_month": 2, + "exp_year": 2022, + "fingerprint": "sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ", + "last_4": "1111" + }, + "entry_method": "KEYED", + "status": "CAPTURED" + }, + "created_at": "2019-08-06T02:47:36.809Z", + "id": "0LRiVlbXVwe8ozu4KbZxd12mvaB", + "location_id": "P3CCK6HSNDAS7", + "payment_id": "0LRiVlbXVwe8ozu4KbZxd12mvaB", + "transaction_id": "lgwOlEityYPJtcuvKTVKT1pA986YY", + "type": "CARD" + } + ], + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 2000, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2019-08-06T02:47:37.140Z", + "version": 4 + } + } + }, + "Payment": { + "type": "object", + "description": "Represents a payment processed by the Square API.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A unique ID for the payment.", + "maxLength": 192, + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the payment was created, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the payment was last updated, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount processed for this payment, not including `tip_money`.\n\nThe amount is specified in the smallest denomination of the applicable currency (for example,\nUS dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).", + "nullable": true + }, + "tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount designated as a tip. \n\nThis amount is specified in the smallest denomination of the applicable currency (for example,\nUS dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).", + "nullable": true + }, + "total_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount for the payment, including `amount_money` and `tip_money`.\nThis amount is specified in the smallest denomination of the applicable currency (for example,\nUS dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).", + "readOnly": true + }, + "app_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount the developer is taking as a fee for facilitating the payment on behalf\nof the seller. This amount is specified in the smallest denomination of the applicable currency\n(for example, US dollar amounts are specified in cents). For more information,\nsee [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).\n\nThe amount cannot be more than 90% of the `total_money` value.\n\nTo set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required.\nFor more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions).", + "nullable": true + }, + "approved_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money approved for this payment. This value may change if Square chooses to\nobtain reauthorization as part of a call to [UpdatePayment](api-endpoint:Payments-UpdatePayment).", + "nullable": true + }, + "processing_fee": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessingFee" + }, + "description": "The processing fees and fee adjustments assessed by Square for this payment.", + "readOnly": true + }, + "refunded_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of the payment refunded to date. \n\nThis amount is specified in the smallest denomination of the applicable currency (for example,\nUS dollar amounts are specified in cents).", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.", + "maxLength": 50, + "readOnly": true + }, + "delay_duration": { + "type": "string", + "description": "The duration of time after the payment's creation when Square automatically applies the\n`delay_action` to the payment. This automatic `delay_action` applies only to payments that\ndo not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration`\ntime period.\n\nThis field is specified as a time duration, in RFC 3339 format.\n\nNotes:\nThis feature is only supported for card payments.\n\nDefault:\n\n- Card-present payments: \"PT36H\" (36 hours) from the creation time.\n- Card-not-present payments: \"P7D\" (7 days) from the creation time.", + "readOnly": true + }, + "delay_action": { + "type": "string", + "description": "The action to be applied to the payment when the `delay_duration` has elapsed.\n\nCurrent values include `CANCEL` and `COMPLETE`.", + "nullable": true + }, + "delayed_until": { + "type": "string", + "description": "The read-only timestamp of when the `delay_action` is automatically applied,\nin RFC 3339 format.\n\nNote that this field is calculated by summing the payment's `delay_duration` and `created_at`\nfields. The `created_at` field is generated by Square and might not exactly match the\ntime on your local machine.", + "readOnly": true + }, + "source_type": { + "type": "string", + "description": "The source type for this payment.\n\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`,\n`CASH` and `EXTERNAL`. For information about these payment source types,\nsee [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).", + "maxLength": 50, + "readOnly": true + }, + "card_details": { + "$ref": "#/components/schemas/CardPaymentDetails", + "description": "Details about a card payment. These details are only populated if the source_type is `CARD`.", + "readOnly": true + }, + "cash_details": { + "$ref": "#/components/schemas/CashPaymentDetails", + "description": "Details about a cash payment. These details are only populated if the source_type is `CASH`.", + "nullable": true + }, + "bank_account_details": { + "$ref": "#/components/schemas/BankAccountPaymentDetails", + "description": "Details about a bank account payment. These details are only populated if the source_type is `BANK_ACCOUNT`.", + "readOnly": true + }, + "external_details": { + "$ref": "#/components/schemas/ExternalPaymentDetails", + "description": "Details about an external payment. The details are only populated \nif the `source_type` is `EXTERNAL`.", + "readOnly": true + }, + "wallet_details": { + "$ref": "#/components/schemas/DigitalWalletDetails", + "description": "Details about an wallet payment. The details are only populated \nif the `source_type` is `WALLET`.", + "readOnly": true + }, + "buy_now_pay_later_details": { + "$ref": "#/components/schemas/BuyNowPayLaterDetails", + "description": "Details about a Buy Now Pay Later payment. The details are only populated\nif the `source_type` is `BUY_NOW_PAY_LATER`. For more information, see \n[Afterpay Payments](https://developer.squareup.com/docs/payments-api/take-payments/afterpay-payments).", + "readOnly": true + }, + "square_account_details": { + "$ref": "#/components/schemas/SquareAccountDetails", + "description": "Details about a Square Account payment. The details are only populated\nif the `source_type` is `SQUARE_ACCOUNT`.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location associated with the payment.", + "maxLength": 50, + "readOnly": true + }, + "order_id": { + "type": "string", + "description": "The ID of the order associated with the payment.", + "maxLength": 192, + "readOnly": true + }, + "reference_id": { + "type": "string", + "description": "An optional ID that associates the payment with an entity in\nanother system.", + "maxLength": 40, + "readOnly": true + }, + "customer_id": { + "type": "string", + "description": "The ID of the customer associated with the payment. If the ID is \nnot provided in the `CreatePayment` request that was used to create the `Payment`, \nSquare may use information in the request \n(such as the billing and shipping address, email address, and payment source) \nto identify a matching customer profile in the Customer Directory. \nIf found, the profile ID is used. If a profile is not found, the \nAPI attempts to create an \n[instant profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). \nIf the API cannot create an \ninstant profile (either because the seller has disabled it or the \nseller's region prevents creating it), this field remains unset. Note that \nthis process is asynchronous and it may take some time before a \ncustomer ID is added to the payment.", + "maxLength": 191, + "readOnly": true + }, + "employee_id": { + "type": "string", + "description": "__Deprecated__: Use `Payment.team_member_id` instead.\n\nAn optional ID of the employee associated with taking the payment.", + "maxLength": 192, + "readOnly": true, + "x-release-status": "DEPRECATED" + }, + "team_member_id": { + "type": "string", + "description": "An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment.", + "maxLength": 192, + "nullable": true + }, + "refund_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of `refund_id`s identifying refunds for the payment.", + "readOnly": true + }, + "risk_evaluation": { + "$ref": "#/components/schemas/RiskEvaluation", + "description": "Provides information about the risk associated with the payment, as determined by Square.\nThis field is present for payments to sellers that have opted in to receive risk\nevaluations.", + "readOnly": true, + "x-release-status": "BETA" + }, + "terminal_checkout_id": { + "type": "string", + "description": "An optional ID for a Terminal checkout that is associated with the payment.", + "readOnly": true, + "x-release-status": "BETA" + }, + "buyer_email_address": { + "type": "string", + "description": "The buyer's email address.", + "maxLength": 255, + "readOnly": true + }, + "billing_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer's billing address.", + "readOnly": true + }, + "shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer's shipping address.", + "readOnly": true + }, + "note": { + "type": "string", + "description": "An optional note to include when creating a payment.", + "maxLength": 500, + "readOnly": true + }, + "statement_description_identifier": { + "type": "string", + "description": "Additional payment information that gets added to the customer's card statement\nas part of the statement description.\n\nNote that the `statement_description_identifier` might get truncated on the statement description\nto fit the required information including the Square identifier (SQ *) and the name of the\nseller taking the payment.", + "readOnly": true + }, + "capabilities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Actions that can be performed on this payment:\n- `EDIT_AMOUNT_UP` - The payment amount can be edited up.\n- `EDIT_AMOUNT_DOWN` - The payment amount can be edited down.\n- `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up.\n- `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down.\n- `EDIT_DELAY_ACTION` - The delay_action can be edited.", + "readOnly": true + }, + "receipt_number": { + "type": "string", + "description": "The payment's receipt number.\nThe field is missing if a payment is canceled.", + "maxLength": 4, + "readOnly": true + }, + "receipt_url": { + "type": "string", + "description": "The URL for the payment's receipt.\nThe field is only populated for COMPLETED payments.", + "maxLength": 255, + "readOnly": true + }, + "device_details": { + "$ref": "#/components/schemas/DeviceDetails", + "description": "Details about the device that took the payment.", + "readOnly": true + }, + "application_details": { + "$ref": "#/components/schemas/ApplicationDetails", + "description": "Details about the application that took the payment.", + "readOnly": true + }, + "is_offline_payment": { + "type": "boolean", + "description": "Whether or not this payment was taken offline.", + "readOnly": true + }, + "offline_payment_details": { + "$ref": "#/components/schemas/OfflinePaymentDetails", + "description": "Additional information about the payment if it was taken offline.", + "readOnly": true + }, + "version_token": { + "type": "string", + "description": "Used for optimistic concurrency. This opaque token identifies a specific version of the\n`Payment` object.", + "nullable": true + } + } + }, + "PaymentBalanceActivityAppFeeRefundDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "refund_id": { + "type": "string", + "description": "The ID of the refund associated with this activity.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location of the merchant associated with the payment refund activity", + "nullable": true + } + } + }, + "PaymentBalanceActivityAppFeeRevenueDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location of the merchant associated with the payment activity", + "nullable": true + } + } + }, + "PaymentBalanceActivityAutomaticSavingsDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "payout_id": { + "type": "string", + "description": "The ID of the payout associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityAutomaticSavingsReversedDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "payout_id": { + "type": "string", + "description": "The ID of the payout associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityChargeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityDepositFeeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payout_id": { + "type": "string", + "description": "The ID of the payout that triggered this deposit fee activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityDepositFeeReversedDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payout_id": { + "type": "string", + "description": "The ID of the payout that triggered this deposit fee activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityDisputeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "dispute_id": { + "type": "string", + "description": "The ID of the dispute associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityFeeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity\nThis will only be populated when a principal LedgerEntryToken is also populated.\nIf the fee is independent (there is no principal LedgerEntryToken) then this will likely not\nbe populated.", + "nullable": true + } + } + }, + "PaymentBalanceActivityFreeProcessingDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityHoldAdjustmentDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityOpenDisputeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "dispute_id": { + "type": "string", + "description": "The ID of the dispute associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityOtherAdjustmentDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityOtherDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityRefundDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "refund_id": { + "type": "string", + "description": "The ID of the refund associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityReleaseAdjustmentDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityReserveHoldDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityReserveReleaseDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivitySquareCapitalPaymentDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivitySquareCapitalReversedPaymentDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivitySquarePayrollTransferDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivitySquarePayrollTransferReversedDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityTaxOnFeeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "tax_rate_description": { + "type": "string", + "description": "The description of the tax rate being applied. For example: \"GST\", \"HST\".", + "nullable": true + } + } + }, + "PaymentBalanceActivityThirdPartyFeeDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + } + } + }, + "PaymentBalanceActivityThirdPartyFeeRefundDetail": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this activity.", + "nullable": true + }, + "refund_id": { + "type": "string", + "description": "The public refund id associated with this activity.", + "nullable": true + } + } + }, + "PaymentLink": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "version" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the payment link.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "The Square-assigned version number, which is incremented each time an update is committed to the payment link.", + "maximum": 65535 + }, + "description": { + "type": "string", + "description": "The optional description of the `payment_link` object.\nIt is primarily for use by your application and is not used anywhere.", + "maxLength": 4096, + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the order associated with the payment link.", + "maxLength": 192, + "readOnly": true + }, + "checkout_options": { + "$ref": "#/components/schemas/CheckoutOptions", + "description": "The checkout options configured for the payment link.\nFor more information, see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).", + "nullable": true + }, + "pre_populated_data": { + "$ref": "#/components/schemas/PrePopulatedData", + "description": "Describes buyer data to prepopulate\non the checkout page.", + "nullable": true + }, + "url": { + "type": "string", + "description": "The shortened URL of the payment link.", + "maxLength": 255, + "readOnly": true + }, + "long_url": { + "type": "string", + "description": "The long URL of the payment link.", + "maxLength": 255, + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the payment link was created, in RFC 3339 format." + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the payment link was last updated, in RFC 3339 format." + }, + "payment_note": { + "type": "string", + "description": "An optional note. After Square processes the payment, this note is added to the\nresulting `Payment`.", + "maxLength": 500, + "nullable": true + } + } + }, + "PaymentLinkRelatedResources": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "description": "The order associated with the payment link.", + "nullable": true + }, + "subscription_plans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "The subscription plan associated with the payment link.", + "nullable": true + } + } + }, + "PaymentOptions": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "autocomplete": { + "type": "boolean", + "description": "Indicates whether the `Payment` objects created from this `TerminalCheckout` are\nautomatically `COMPLETED` or left in an `APPROVED` state for later modification.\n\nDefault: true", + "nullable": true + }, + "delay_duration": { + "type": "string", + "description": "The duration of time after the payment's creation when Square automatically resolves the\npayment. This automatic resolution applies only to payments that do not reach a terminal state\n(`COMPLETED` or `CANCELED`) before the `delay_duration` time period.\n\nThis parameter should be specified as a time duration, in RFC 3339 format, with a minimum value\nof 1 minute and a maximum value of 36 hours. This feature is only supported for card payments,\nand all payments will be considered card-present.\n\nThis parameter can only be set for a delayed capture payment (`autocomplete=false`). For more\ninformation, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).\n\nDefault: \"PT36H\" (36 hours) from the creation time", + "nullable": true + }, + "accept_partial_authorization": { + "type": "boolean", + "description": "If set to `true` and charging a Square Gift Card, a payment might be returned with\n`amount_money` equal to less than what was requested. For example, a request for $20 when charging\na Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose\nto prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card\npayment.\n\nThis parameter can only be set for a delayed capture payment (`autocomplete=false`).\n\nFor more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards).\n\nDefault: false", + "nullable": true + }, + "delay_action": { + "$ref": "#/components/schemas/PaymentOptionsDelayAction", + "description": "The action to be applied to the `Payment` when the delay_duration has elapsed.\nThe action must be CANCEL or COMPLETE.\n\nThe action cannot be set to COMPLETE if an `order_id` is present on the TerminalCheckout.\n\nThis parameter can only be set for a delayed capture payment (`autocomplete=false`). For more\ninformation, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).\n\nDefault: CANCEL\nSee [DelayAction](#type-delayaction) for possible values", + "nullable": true + } + } + }, + "PaymentOptionsDelayAction": { + "type": "string", + "enum": [ + "CANCEL", + "COMPLETE" + ], + "x-enum-elements": [ + { + "name": "CANCEL", + "description": "Indicates that the payment should be automatically canceled when the delay duration\nelapses." + }, + { + "name": "COMPLETE", + "description": "Indicates that the payment should be automatically completed when the delay duration\nelapses." + } + ], + "description": "Describes the action to be applied to a delayed capture payment when the delay_duration\nhas elapsed.", + "x-release-status": "PUBLIC" + }, + "PaymentRefund": { + "type": "object", + "description": "Represents a refund of a payment made using Square. Contains information about\nthe original payment and the amount of money refunded.", + "x-release-status": "PUBLIC", + "required": [ + "id", + "amount_money" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for this refund, generated by Square.", + "minLength": 1, + "maxLength": 255 + }, + "status": { + "type": "string", + "description": "The refund's status:\n- `PENDING` - Awaiting approval.\n- `COMPLETED` - Successfully completed.\n- `REJECTED` - The refund was rejected.\n- `FAILED` - An error occurred.", + "maxLength": 50, + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The location ID associated with the payment this refund is attached to.", + "maxLength": 50, + "nullable": true + }, + "unlinked": { + "type": "boolean", + "description": "Flag indicating whether or not the refund is linked to an existing payment in Square.", + "readOnly": true + }, + "destination_type": { + "type": "string", + "description": "The destination type for this refund.\n\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`,\n`EXTERNAL`, and `SQUARE_ACCOUNT`.", + "maxLength": 50, + "nullable": true + }, + "destination_details": { + "$ref": "#/components/schemas/DestinationDetails", + "description": "Contains information about the refund destination. This field is populated only if\n`destination_id` is defined in the `RefundPayment` request.", + "readOnly": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money refunded. This amount is specified in the smallest denomination\nof the applicable currency (for example, US dollar amounts are specified in cents)." + }, + "app_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money the application developer contributed to help cover the refunded amount.\nThis amount is specified in the smallest denomination of the applicable currency (for example,\nUS dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).", + "nullable": true + }, + "processing_fee": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessingFee" + }, + "description": "Processing fees and fee adjustments assessed by Square for this refund.", + "nullable": true + }, + "payment_id": { + "type": "string", + "description": "The ID of the payment associated with this refund.", + "maxLength": 192, + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The ID of the order associated with the refund.", + "maxLength": 192, + "nullable": true + }, + "reason": { + "type": "string", + "description": "The reason for the refund.", + "maxLength": 192, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the refund was created, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the refund was last updated, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + }, + "team_member_id": { + "type": "string", + "description": "An optional ID of the team member associated with taking the payment.", + "maxLength": 192, + "readOnly": true + }, + "terminal_refund_id": { + "type": "string", + "description": "An optional ID for a Terminal refund.", + "readOnly": true, + "x-release-status": "BETA" + } + } + }, + "Payout": { + "type": "object", + "description": "An accounting of the amount owed the seller and record of the actual transfer to their\nexternal bank account or to the Square balance.", + "x-release-status": "PUBLIC", + "required": [ + "id", + "location_id" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique ID for the payout.", + "minLength": 1 + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus", + "description": "Indicates the payout status.\nSee [PayoutStatus](#type-payoutstatus) for possible values", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location associated with the payout.", + "minLength": 1 + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format." + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the payout was last updated, in RFC 3339 format." + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money involved in the payout. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero.", + "nullable": true + }, + "destination": { + "$ref": "#/components/schemas/Destination", + "description": "Information about the banking destination (such as a bank account, Square checking account, or debit card)\nagainst which the payout was made.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version number, which is incremented each time an update is made to this payout record.\nThe version number helps developers receive event notifications or feeds out of order." + }, + "type": { + "$ref": "#/components/schemas/PayoutType", + "description": "Indicates the payout type.\nSee [PayoutType](#type-payouttype) for possible values", + "nullable": true + }, + "payout_fee": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutFee" + }, + "description": "A list of transfer fees and any taxes on the fees assessed by Square for this payout.", + "nullable": true + }, + "arrival_date": { + "type": "string", + "description": "The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.", + "nullable": true + }, + "end_to_end_id": { + "type": "string", + "description": "A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement.", + "nullable": true + } + } + }, + "PayoutEntry": { + "type": "object", + "description": "One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity.\nThe total amount of the payout will equal the sum of the payout entries for a batch payout", + "x-release-status": "PUBLIC", + "required": [ + "id", + "payout_id" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique ID for the payout entry.", + "minLength": 1 + }, + "payout_id": { + "type": "string", + "description": "The ID of the payout entries’ associated payout.", + "minLength": 1 + }, + "effective_at": { + "type": "string", + "description": "The timestamp of when the payout entry affected the balance, in RFC 3339 format.", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/ActivityType", + "description": "The type of activity associated with this payout entry.\nSee [ActivityType](#type-activitytype) for possible values", + "nullable": true + }, + "gross_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money involved in this payout entry.", + "nullable": true + }, + "fee_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of Square fees associated with this payout entry.", + "nullable": true + }, + "net_amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The net proceeds from this transaction after any fees.", + "nullable": true + }, + "type_app_fee_revenue_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityAppFeeRevenueDetail", + "description": "Details of any developer app fee revenue generated on a payment.", + "nullable": true + }, + "type_app_fee_refund_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityAppFeeRefundDetail", + "description": "Details of a refund for an app fee on a payment.", + "nullable": true + }, + "type_automatic_savings_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityAutomaticSavingsDetail", + "description": "Details of any automatic transfer from the payment processing balance to the Square Savings account. These are, generally, proportional to the merchant's sales.", + "nullable": true + }, + "type_automatic_savings_reversed_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityAutomaticSavingsReversedDetail", + "description": "Details of any automatic transfer from the Square Savings account back to the processing balance. These are, generally, proportional to the merchant's refunds.", + "nullable": true + }, + "type_charge_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityChargeDetail", + "description": "Details of credit card payment captures.", + "nullable": true + }, + "type_deposit_fee_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityDepositFeeDetail", + "description": "Details of any fees involved with deposits such as for instant deposits.", + "nullable": true + }, + "type_deposit_fee_reversed_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityDepositFeeReversedDetail", + "description": "Details of any reversal or refund of fees involved with deposits such as for instant deposits.", + "nullable": true + }, + "type_dispute_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityDisputeDetail", + "description": "Details of any balance change due to a dispute event.", + "nullable": true + }, + "type_fee_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityFeeDetail", + "description": "Details of adjustments due to the Square processing fee.", + "nullable": true + }, + "type_free_processing_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityFreeProcessingDetail", + "description": "Square offers Free Payments Processing for a variety of business scenarios including seller referral or when Square wants to apologize for a bug, customer service, repricing complication, and so on. This entry represents details of any credit to the merchant for the purposes of Free Processing.", + "nullable": true + }, + "type_hold_adjustment_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityHoldAdjustmentDetail", + "description": "Details of any adjustment made by Square related to the holding or releasing of a payment.", + "nullable": true + }, + "type_open_dispute_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityOpenDisputeDetail", + "description": "Details of any open disputes.", + "nullable": true + }, + "type_other_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityOtherDetail", + "description": "Details of any other type that does not belong in the rest of the types.", + "nullable": true + }, + "type_other_adjustment_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityOtherAdjustmentDetail", + "description": "Details of any other type of adjustments that don't fall under existing types.", + "nullable": true + }, + "type_refund_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityRefundDetail", + "description": "Details of a refund for an existing card payment.", + "nullable": true + }, + "type_release_adjustment_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityReleaseAdjustmentDetail", + "description": "Details of fees released for adjustments.", + "nullable": true + }, + "type_reserve_hold_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityReserveHoldDetail", + "description": "Details of fees paid for funding risk reserve.", + "nullable": true + }, + "type_reserve_release_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityReserveReleaseDetail", + "description": "Details of fees released from risk reserve.", + "nullable": true + }, + "type_square_capital_payment_details": { + "$ref": "#/components/schemas/PaymentBalanceActivitySquareCapitalPaymentDetail", + "description": "Details of capital merchant cash advance (MCA) assessments. These are, generally, proportional to the merchant's sales but may be issued for other reasons related to the MCA.", + "nullable": true + }, + "type_square_capital_reversed_payment_details": { + "$ref": "#/components/schemas/PaymentBalanceActivitySquareCapitalReversedPaymentDetail", + "description": "Details of capital merchant cash advance (MCA) assessment refunds. These are, generally, proportional to the merchant's refunds but may be issued for other reasons related to the MCA.", + "nullable": true + }, + "type_tax_on_fee_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityTaxOnFeeDetail", + "description": "Details of tax paid on fee amounts.", + "nullable": true + }, + "type_third_party_fee_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityThirdPartyFeeDetail", + "description": "Details of fees collected by a 3rd party platform.", + "nullable": true + }, + "type_third_party_fee_refund_details": { + "$ref": "#/components/schemas/PaymentBalanceActivityThirdPartyFeeRefundDetail", + "description": "Details of refunded fees from a 3rd party platform.", + "nullable": true + }, + "type_square_payroll_transfer_details": { + "$ref": "#/components/schemas/PaymentBalanceActivitySquarePayrollTransferDetail", + "description": "Details of a payroll payment that was transferred to a team member’s bank account.", + "nullable": true + }, + "type_square_payroll_transfer_reversed_details": { + "$ref": "#/components/schemas/PaymentBalanceActivitySquarePayrollTransferReversedDetail", + "description": "Details of a payroll payment to a team member’s bank account that was deposited back to the seller’s account by Square.", + "nullable": true + } + } + }, + "PayoutFee": { + "type": "object", + "description": "Represents a payout fee that can incur as part of a payout.", + "x-release-status": "PUBLIC", + "properties": { + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The money amount of the payout fee.", + "nullable": true + }, + "effective_at": { + "type": "string", + "description": "The timestamp of when the fee takes effect, in RFC 3339 format.", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/PayoutFeeType", + "description": "The type of fee assessed as part of the payout.\nSee [PayoutFeeType](#type-payoutfeetype) for possible values", + "nullable": true + } + } + }, + "PayoutFeeType": { + "type": "string", + "enum": [ + "TRANSFER_FEE", + "TAX_ON_TRANSFER_FEE" + ], + "x-enum-elements": [ + { + "name": "TRANSFER_FEE", + "description": "Fee type associated with transfers." + }, + { + "name": "TAX_ON_TRANSFER_FEE", + "description": "Taxes associated with the transfer fee." + } + ], + "description": "Represents the type of payout fee that can incur as part of a payout.", + "x-release-status": "PUBLIC" + }, + "PayoutStatus": { + "type": "string", + "enum": [ + "SENT", + "FAILED", + "PAID" + ], + "x-enum-elements": [ + { + "name": "SENT", + "description": "Indicates that the payout was successfully sent to the banking destination." + }, + { + "name": "FAILED", + "description": "Indicates that the payout was rejected by the banking destination." + }, + { + "name": "PAID", + "description": "Indicates that the payout has successfully completed." + } + ], + "description": "Payout status types", + "x-release-status": "PUBLIC" + }, + "PayoutType": { + "type": "string", + "enum": [ + "BATCH", + "SIMPLE" + ], + "x-enum-elements": [ + { + "name": "BATCH", + "description": "Payouts that include a list of payout entries that can be considered settled." + }, + { + "name": "SIMPLE", + "description": "Payouts that do not have any payout entries associated with them and will\nshow up as one of the payout entries in a future BATCH payout." + } + ], + "description": "The type of payout: “BATCH” or “SIMPLE”.\nBATCH payouts include a list of payout entries that can be considered settled.\nSIMPLE payouts do not have any payout entries associated with them\nand will show up as one of the payout entries in a future BATCH payout.", + "x-release-status": "PUBLIC" + }, + "Phase": { + "type": "object", + "description": "Represents a phase, which can override subscription phases as defined by plan_id", + "x-release-status": "PUBLIC", + "properties": { + "uid": { + "type": "string", + "description": "id of subscription phase", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "index of phase in total subscription plan", + "format": "int64", + "nullable": true + }, + "order_template_id": { + "type": "string", + "description": "id of order to be used in billing", + "nullable": true + }, + "plan_phase_uid": { + "type": "string", + "description": "the uid from the plan's phase in catalog", + "nullable": true + } + } + }, + "PhaseInput": { + "type": "object", + "description": "Represents the arguments used to construct a new phase.", + "x-release-status": "PUBLIC", + "required": [ + "ordinal" + ], + "properties": { + "ordinal": { + "type": "integer", + "description": "index of phase in total subscription plan", + "format": "int64" + }, + "order_template_id": { + "type": "string", + "description": "id of order to be used in billing", + "nullable": true + } + } + }, + "PrePopulatedData": { + "type": "object", + "description": "Describes buyer data to prepopulate in the payment form.\nFor more information,\nsee [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).", + "x-release-status": "PUBLIC", + "properties": { + "buyer_email": { + "type": "string", + "description": "The buyer email to prepopulate in the payment form.", + "maxLength": 256, + "nullable": true + }, + "buyer_phone_number": { + "type": "string", + "description": "The buyer phone number to prepopulate in the payment form.", + "maxLength": 17, + "nullable": true + }, + "buyer_address": { + "$ref": "#/components/schemas/Address", + "description": "The buyer address to prepopulate in the payment form.", + "nullable": true + } + } + }, + "ProcessingFee": { + "type": "object", + "description": "Represents the Square processing fee.", + "x-release-status": "PUBLIC", + "properties": { + "effective_at": { + "type": "string", + "description": "The timestamp of when the fee takes effect, in RFC 3339 format.", + "nullable": true + }, + "type": { + "type": "string", + "description": "The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`.", + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The fee amount, which might be negative, that is assessed or adjusted by Square.\n\nPositive values represent funds being assessed, while negative values represent\nfunds being returned.", + "nullable": true + } + } + }, + "Product": { + "type": "string", + "enum": [ + "SQUARE_POS", + "EXTERNAL_API", + "BILLING", + "APPOINTMENTS", + "INVOICES", + "ONLINE_STORE", + "PAYROLL", + "DASHBOARD", + "ITEM_LIBRARY_IMPORT", + "OTHER" + ], + "x-enum-elements": [ + { + "name": "SQUARE_POS", + "description": "Square Point of Sale application." + }, + { + "name": "EXTERNAL_API", + "description": "Square Connect APIs (for example, Orders API or Checkout API)." + }, + { + "name": "BILLING", + "description": "A Square subscription (various products)." + }, + { + "name": "APPOINTMENTS", + "description": "Square Appointments." + }, + { + "name": "INVOICES", + "description": "Square Invoices." + }, + { + "name": "ONLINE_STORE", + "description": "Square Online Store." + }, + { + "name": "PAYROLL", + "description": "Square Payroll." + }, + { + "name": "DASHBOARD", + "description": "Square Dashboard." + }, + { + "name": "ITEM_LIBRARY_IMPORT", + "description": "Item Library Import." + }, + { + "name": "OTHER", + "description": "A Square product that does not match any other value." + } + ], + "description": "Indicates the Square product used to generate a change.", + "x-release-status": "PUBLIC" + }, + "ProductType": { + "type": "string", + "enum": [ + "TERMINAL_API" + ], + "x-enum-elements": [ + { + "name": "TERMINAL_API", + "description": "" + } + ], + "x-release-status": "PUBLIC" + }, + "PublishInvoiceRequest": { + "type": "object", + "description": "Describes a `PublishInvoice` request.", + "x-release-status": "PUBLIC", + "required": [ + "version" + ], + "properties": { + "version": { + "type": "integer", + "description": "The version of the [invoice](entity:Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the `PublishInvoice` request. If you do not \nprovide `idempotency_key` (or provide an empty string as the value), the endpoint \ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 128, + "nullable": true + } + }, + "example": { + "idempotency_key": "32da42d0-1997-41b0-826b-f09464fc2c2e", + "version": 1 + } + }, + "PublishInvoiceResponse": { + "type": "object", + "description": "Describes a `PublishInvoice` response.", + "x-release-status": "PUBLIC", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The published invoice." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "invoice": { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "created_at": "2020-06-18T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1, + "status": "PENDING", + "uid": "beebd363-e47f-4075-8785-c235aaa7df11" + } + ], + "request_type": "BALANCE", + "tipping_enabled": true, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "public_url": "https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9", + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "SCHEDULED", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2020-06-18T18:23:11Z", + "version": 1 + } + } + }, + "QrCodeOptions": { + "type": "object", + "description": "Fields to describe the action that displays QR-Codes.", + "x-release-status": "BETA", + "required": [ + "title", + "body", + "barcode_contents" + ], + "properties": { + "title": { + "type": "string", + "description": "The title text to display in the QR code flow on the Terminal.", + "minLength": 1, + "maxLength": 250 + }, + "body": { + "type": "string", + "description": "The body text to display in the QR code flow on the Terminal.", + "minLength": 1, + "maxLength": 10000 + }, + "barcode_contents": { + "type": "string", + "description": "The text representation of the data to show in the QR code\nas UTF8-encoded data.", + "minLength": 1, + "maxLength": 1024 + } + } + }, + "QuantityRatio": { + "type": "object", + "description": "A whole number or unreduced fractional ratio.", + "x-release-status": "BETA", + "properties": { + "quantity": { + "type": "integer", + "description": "The whole or fractional quantity as the numerator.", + "nullable": true + }, + "quantity_denominator": { + "type": "integer", + "description": "The whole or fractional quantity as the denominator.\nWith fractional quantity this field is the denominator and quantity is the numerator.\nThe default value is `1`. For example, when `quantity=3` and `quantity_denominator` is unspecified,\nthe quantity ratio is `3` or `3/1`.", + "nullable": true + } + } + }, + "QuickPay": { + "type": "object", + "description": "Describes an ad hoc item and price to generate a quick pay checkout link.\nFor more information,\nsee [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout).", + "x-release-status": "PUBLIC", + "required": [ + "name", + "price_money", + "location_id" + ], + "properties": { + "name": { + "type": "string", + "description": "The ad hoc item name. In the resulting `Order`, this name appears as the line item name.", + "minLength": 1, + "maxLength": 255 + }, + "price_money": { + "$ref": "#/components/schemas/Money", + "description": "The price of the item." + }, + "location_id": { + "type": "string", + "description": "The ID of the business location the checkout is associated with." + } + } + }, + "Range": { + "type": "object", + "description": "The range of a number value between the specified lower and upper bounds.", + "x-release-status": "PUBLIC", + "properties": { + "min": { + "type": "string", + "description": "The lower bound of the number range. At least one of `min` or `max` must be specified.\nIf unspecified, the results will have no minimum value.", + "nullable": true + }, + "max": { + "type": "string", + "description": "The upper bound of the number range. At least one of `min` or `max` must be specified.\nIf unspecified, the results will have no maximum value.", + "nullable": true + } + } + }, + "ReceiptOptions": { + "type": "object", + "description": "Describes receipt action fields.", + "x-release-status": "BETA", + "required": [ + "payment_id" + ], + "properties": { + "payment_id": { + "type": "string", + "description": "The reference to the Square payment ID for the receipt." + }, + "print_only": { + "type": "boolean", + "description": "Instructs the device to print the receipt without displaying the receipt selection screen.\nRequires `printer_enabled` set to true.\nDefaults to false.", + "nullable": true + }, + "is_duplicate": { + "type": "boolean", + "description": "Identify the receipt as a reprint rather than an original receipt.\nDefaults to false.", + "nullable": true + } + } + }, + "RedeemLoyaltyRewardRequest": { + "type": "object", + "description": "A request to redeem a loyalty reward.", + "x-release-status": "PUBLIC", + "x-params-example": "?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810", + "required": [ + "idempotency_key", + "location_id" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `RedeemLoyaltyReward` request. \nKeys can be any valid string, but must be unique for every request.", + "minLength": 1, + "maxLength": 128 + }, + "location_id": { + "type": "string", + "description": "The ID of the [location](entity:Location) where the reward is redeemed.", + "minLength": 1 + } + }, + "example": { + "idempotency_key": "98adc7f7-6963-473b-b29c-f3c9cdd7d994", + "location_id": "P034NEENMD09F" + } + }, + "RedeemLoyaltyRewardResponse": { + "type": "object", + "description": "A response that includes the `LoyaltyEvent` published for redeeming the reward.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "event": { + "$ref": "#/components/schemas/LoyaltyEvent", + "description": "The `LoyaltyEvent` for redeeming the reward." + } + }, + "example": { + "event": { + "created_at": "2020-05-08T21:56:00Z", + "id": "67377a6e-dbdc-369d-aa16-2e7ed422e71f", + "location_id": "P034NEENMD09F", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "redeem_reward": { + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "reward_id": "9f18ac21-233a-31c3-be77-b45840f5a810" + }, + "source": "LOYALTY_API", + "type": "REDEEM_REWARD" + } + } + }, + "Refund": { + "type": "object", + "description": "Represents a refund processed for a Square transaction.", + "x-release-status": "PUBLIC", + "required": [ + "id", + "location_id", + "tender_id", + "reason", + "amount_money", + "status" + ], + "properties": { + "id": { + "type": "string", + "description": "The refund's unique ID.", + "maxLength": 255 + }, + "location_id": { + "type": "string", + "description": "The ID of the refund's associated location.", + "maxLength": 50 + }, + "transaction_id": { + "type": "string", + "description": "The ID of the transaction that the refunded tender is part of.", + "maxLength": 192, + "nullable": true + }, + "tender_id": { + "type": "string", + "description": "The ID of the refunded tender.", + "maxLength": 192 + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the refund was created, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + }, + "reason": { + "type": "string", + "description": "The reason for the refund being issued.", + "maxLength": 192 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money refunded to the buyer." + }, + "status": { + "$ref": "#/components/schemas/RefundStatus", + "description": "The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`,\nor `FAILED`).\nSee [RefundStatus](#type-refundstatus) for possible values" + }, + "processing_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of Square processing fee money refunded to the *merchant*.", + "nullable": true + }, + "additional_recipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalRecipient" + }, + "description": "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration.", + "x-release-status": "DEPRECATED", + "nullable": true + } + } + }, + "RefundPaymentRequest": { + "type": "object", + "description": "Describes a request to refund a payment using [RefundPayment](api-endpoint:Refunds-RefundPayment).", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "amount_money" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": " A unique string that identifies this `RefundPayment` request. The key can be any valid string\nbut must be unique for every `RefundPayment` request.\n\nKeys are limited to a max of 45 characters - however, the number of allowed characters might be\nless than 45, if multi-byte characters are used.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", + "minLength": 1 + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money to refund.\n\nThis amount cannot be more than the `total_money` value of the payment minus the total\namount of all previously completed refunds for this payment.\n\nThis amount must be specified in the smallest denomination of the applicable currency\n(for example, US dollar amounts are specified in cents). For more information, see\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).\n\nThe currency code must match the currency associated with the business\nthat is charging the card." + }, + "app_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money the developer contributes to help cover the refunded amount.\nThis amount is specified in the smallest denomination of the applicable currency (for example,\nUS dollar amounts are specified in cents).\n\nThe value cannot be more than the `amount_money`.\n\nYou can specify this parameter in a refund request only if the same parameter was also included\nwhen taking the payment. This is part of the application fee scenario the API supports. For more\ninformation, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).\n\nTo set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required.\nFor more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions).", + "x-release-status": "BETA", + "nullable": true + }, + "payment_id": { + "type": "string", + "description": "The unique ID of the payment being refunded.\nRequired when unlinked=false, otherwise must not be set.", + "nullable": true + }, + "destination_id": { + "type": "string", + "description": "The ID indicating where funds will be refunded to. Required for unlinked refunds. For more\ninformation, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds).\n\nFor refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds\nwill be returned to the original payment source. The field may be specified in order to request\na cross-method refund to a gift card. For more information,\nsee [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards).", + "nullable": true + }, + "unlinked": { + "type": "boolean", + "description": "Indicates that the refund is not linked to a Square payment.\nIf set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not\nbe provided.", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The location ID associated with the unlinked refund.\nRequired for requests specifying `unlinked=true`.\nOtherwise, if included when `unlinked=false`, will throw an error.", + "maxLength": 50, + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "The [Customer](entity:Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Cards\nAPI. Only allowed when `unlinked=true`.", + "nullable": true + }, + "reason": { + "type": "string", + "description": "A description of the reason for the refund.", + "maxLength": 192, + "nullable": true + }, + "payment_version_token": { + "type": "string", + "description": " Used for optimistic concurrency. This opaque token identifies the current `Payment`\nversion that the caller expects. If the server has a different version of the Payment,\nthe update fails and a response with a VERSION_MISMATCH error is returned.\nIf the versions match, or the field is not provided, the refund proceeds as normal.", + "x-release-status": "BETA", + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "An optional [TeamMember](entity:TeamMember) ID to associate with this refund.", + "maxLength": 192, + "nullable": true + }, + "cash_details": { + "$ref": "#/components/schemas/DestinationDetailsCashRefundDetails", + "description": "Additional details required when recording an unlinked cash refund (`destination_id` is CASH).", + "nullable": true + }, + "external_details": { + "$ref": "#/components/schemas/DestinationDetailsExternalRefundDetails", + "description": "Additional details required when recording an unlinked external refund\n(`destination_id` is EXTERNAL).", + "nullable": true + } + }, + "example": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "app_fee_money": { + "amount": 10, + "currency": "USD" + }, + "idempotency_key": "9b7f2dcf-49da-4411-b23e-a2d6af21333a", + "payment_id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", + "reason": "Example" + } + }, + "RefundPaymentResponse": { + "type": "object", + "description": "Defines the response returned by\n[RefundPayment](api-endpoint:Refunds-RefundPayment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refund": { + "$ref": "#/components/schemas/PaymentRefund", + "description": "The successfully created `PaymentRefund`." + } + }, + "example": { + "refund": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "app_fee_money": { + "amount": 10, + "currency": "USD" + }, + "created_at": "2021-10-13T21:23:19.116Z", + "id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY_KlWP8IC1557ddwc9QWTKrCVU6m0JXDz15R2Qym5eQfR", + "location_id": "L88917AVBK2S5", + "order_id": "1JLEUZeEooAIX8HMqm9kvWd69aQZY", + "payment_id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", + "reason": "Example", + "status": "PENDING", + "updated_at": "2021-10-13T21:23:19.508Z" + } + } + }, + "RefundStatus": { + "type": "string", + "enum": [ + "PENDING", + "APPROVED", + "REJECTED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "The refund is pending." + }, + { + "name": "APPROVED", + "description": "The refund has been approved by Square." + }, + { + "name": "REJECTED", + "description": "The refund has been rejected by Square." + }, + { + "name": "FAILED", + "description": "The refund failed." + } + ], + "description": "Indicates a refund's current status.", + "x-release-status": "PUBLIC" + }, + "RegisterDomainRequest": { + "type": "object", + "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "domain_name" + ], + "properties": { + "domain_name": { + "type": "string", + "description": "A domain name as described in RFC-1034 that will be registered with ApplePay.", + "minLength": 1, + "maxLength": 255 + } + }, + "example": { + "domain_name": "example.com" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.csharp", + "java": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.java", + "javascript": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.javascript", + "php": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.php", + "python": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.python", + "ruby": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.ruby" + } + }, + "RegisterDomainResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "status": { + "$ref": "#/components/schemas/RegisterDomainResponseStatus", + "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](entity:RegisterDomainResponseStatus) for possible values.\nSee [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values" + } + }, + "example": { + "status": "VERIFIED" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.csharp", + "java": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.java", + "javascript": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.javascript", + "php": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.php", + "python": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.python", + "ruby": "/sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.ruby" + } + }, + "RegisterDomainResponseStatus": { + "type": "string", + "enum": [ + "PENDING", + "VERIFIED" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "The domain is added, but not verified." + }, + { + "name": "VERIFIED", + "description": "The domain is added and verified. It can be used to accept Apple Pay transactions." + } + ], + "description": "The status of the domain registration.", + "x-release-status": "PUBLIC" + }, + "RemoveGroupFromCustomerRequest": { + "type": "object", + "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer) endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RemoveGroupFromCustomerResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer)\nendpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {} + }, + "ResumeSubscriptionRequest": { + "type": "object", + "description": "Defines input parameters in a request to the\n[ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "resume_effective_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date when the subscription reactivated.", + "x-release-status": "BETA", + "nullable": true + }, + "resume_change_timing": { + "$ref": "#/components/schemas/ChangeTiming", + "description": "The timing to resume a subscription, relative to the specified\n`resume_effective_date` attribute value.\nSee [ChangeTiming](#type-changetiming) for possible values", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "ResumeSubscriptionResponse": { + "type": "object", + "description": "Defines output parameters in a response from the \n[ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The resumed subscription." + }, + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAction" + }, + "description": "A list of `RESUME` actions created by the request and scheduled for the subscription.", + "x-release-status": "BETA" + } + }, + "example": { + "actions": [ + { + "effective_date": "2023-09-01", + "id": "18ff74f4-3da4-30c5-929f-7d6fca84f115", + "type": "RESUME" + } + ], + "subscription": { + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", + "location_id": "S8GWD5R9QB376", + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "source": { + "name": "My Application" + }, + "start_date": "2023-06-20", + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 1 + } + } + }, + "RetrieveBookingCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "properties": { + "version": { + "type": "integer", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveBookingCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The retrieved custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-11-16T15:27:30Z", + "description": "The favorite shampoo of the customer.", + "key": "favoriteShampoo", + "name": "Favorite shampoo", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-11-16T15:27:30Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + }, + "errors": [] + } + }, + "RetrieveBookingCustomAttributeRequest": { + "type": "object", + "description": "Represents a [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) request.", + "x-release-status": "PUBLIC", + "properties": { + "with_definition": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveBookingCustomAttributeResponse": { + "type": "object", + "description": "Represents a [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The retrieved custom attribute. If `with_definition` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-11-16T15:50:27Z", + "key": "favoriteShampoo", + "updated_at": "2022-11-16T15:50:27Z", + "value": "Dune", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + }, + "errors": [] + } + }, + "RetrieveBookingRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveBookingResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "booking": { + "$ref": "#/components/schemas/Booking", + "description": "The booking that was requested." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "booking": { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "created_at": "2020-10-28T15:47:41Z", + "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M", + "customer_note": "", + "id": "zkras0xv0xwswx", + "location_id": "LEQHH0YY8B42M", + "seller_note": "", + "start_at": "2020-11-26T13:00:00Z", + "status": "ACCEPTED", + "updated_at": "2020-10-28T15:49:25Z", + "version": 1 + }, + "errors": [] + } + }, + "RetrieveBusinessBookingProfileRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveBusinessBookingProfileResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "business_booking_profile": { + "$ref": "#/components/schemas/BusinessBookingProfile", + "description": "The seller's booking profile." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "business_booking_profile": { + "allow_user_cancel": true, + "booking_enabled": true, + "booking_policy": "ACCEPT_ALL", + "business_appointment_settings": { + "alignment_time": "HALF_HOURLY", + "any_team_member_booking_enabled": true, + "cancellation_fee_money": { + "currency": "USD" + }, + "cancellation_policy": "CUSTOM_POLICY", + "location_types": [ + "BUSINESS_LOCATION" + ], + "max_booking_lead_time_seconds": 31536000, + "min_booking_lead_time_seconds": 0, + "multiple_service_booking_enabled": true, + "skip_booking_flow_staff_selection": false + }, + "created_at": "2020-09-10T21:40:38Z", + "customer_timezone_choice": "CUSTOMER_CHOICE", + "seller_id": "MLJQYZZRM0D3Y" + }, + "errors": [] + } + }, + "RetrieveCardRequest": { + "type": "object", + "description": "Retrieves details for a specific Card. Accessible via\nHTTP requests at GET https://connect.squareup.com/v2/cards/{card_id}", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveCardResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](api-endpoint:Cards-RetrieveCard) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "The retrieved card." + } + }, + "example": { + "card": { + "billing_address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "bin": "411111", + "card_brand": "VISA", + "card_type": "CREDIT", + "cardholder_name": "Amelia Earhart", + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "enabled": true, + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q", + "hsa_fsa": false, + "id": "ccof:uIbfJXhXETSP197M3GB", + "last_4": "1111", + "merchant_id": "6SSW7HV8K2ST5", + "prepaid_type": "NOT_PREPAID", + "reference_id": "user-id-1", + "version": 1 + } + } + }, + "RetrieveCashDrawerShiftRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "location_id" + ], + "properties": { + "location_id": { + "type": "string", + "description": "The ID of the location to retrieve cash drawer shifts from.", + "minLength": 1 + } + }, + "example": {} + }, + "RetrieveCashDrawerShiftResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "cash_drawer_shift": { + "$ref": "#/components/schemas/CashDrawerShift", + "description": "The cash drawer shift queried for." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "cash_drawer_shift": { + "cash_paid_in_money": { + "amount": 10000, + "currency": "USD" + }, + "cash_paid_out_money": { + "amount": -10000, + "currency": "USD" + }, + "cash_payment_money": { + "amount": 100, + "currency": "USD" + }, + "cash_refunds_money": { + "amount": -100, + "currency": "USD" + }, + "closed_at": "2019-11-22T00:44:49.000Z", + "closed_cash_money": { + "amount": 9970, + "currency": "USD" + }, + "closing_team_member_id": "", + "description": "Misplaced some change", + "device": { + "name": "My iPad" + }, + "ended_at": "2019-11-22T00:44:49.000Z", + "ending_team_member_id": "", + "expected_cash_money": { + "amount": 10000, + "currency": "USD" + }, + "id": "DCC99978-09A6-4926-849F-300BE9C5793A", + "opened_at": "2019-11-22T00:42:54.000Z", + "opened_cash_money": { + "amount": 10000, + "currency": "USD" + }, + "opening_team_member_id": "", + "state": "CLOSED" + } + } + }, + "RetrieveCatalogObjectRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "x-params-example": "?include_related_objects=true", + "properties": { + "include_related_objects": { + "type": "boolean", + "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field\nof the response. These objects are put in the `related_objects` field. Setting this to `true` is\nhelpful when the objects are needed for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included. For example,\n\nif the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`", + "nullable": true + }, + "catalog_version": { + "type": "integer", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "format": "int64", + "x-release-status": "BETA", + "nullable": true + }, + "include_category_path_to_root": { + "type": "boolean", + "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists\nof `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category\nand ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned\nin the response payload.", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.csharp", + "java": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.java", + "javascript": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.javascript", + "php": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.php", + "python": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.python", + "ruby": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.ruby" + } + }, + "RetrieveCatalogObjectResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "object": { + "$ref": "#/components/schemas/CatalogObject", + "description": "The `CatalogObject`s returned." + }, + "related_objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of `CatalogObject`s referenced by the object in the `object` field." + } + }, + "example": { + "object": { + "id": "W62UWFY35CWMYGVWK6TWJDNI", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "BJNQCF2FJ6S6UIDT65ABHLRX", + "ordinal": 0 + } + ], + "description": "Hot Leaf Juice", + "name": "Tea", + "tax_ids": [ + "HURXQOOAIC4IZSI2BEXQRYFY" + ], + "variations": [ + { + "id": "2TZFAOHWGG7PAK2QEXWYPZSP", + "is_deleted": false, + "item_variation_data": { + "item_id": "W62UWFY35CWMYGVWK6TWJDNI", + "name": "Mug", + "ordinal": 0, + "price_money": { + "amount": 150, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + }, + "related_objects": [ + { + "category_data": { + "name": "Beverages" + }, + "id": "BJNQCF2FJ6S6UIDT65ABHLRX", + "is_deleted": false, + "present_at_all_locations": true, + "type": "CATEGORY", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + }, + { + "id": "HURXQOOAIC4IZSI2BEXQRYFY", + "is_deleted": false, + "present_at_all_locations": true, + "tax_data": { + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "enabled": true, + "inclusion_type": "ADDITIVE", + "name": "Sales Tax", + "percentage": "5.0" + }, + "type": "TAX", + "updated_at": "2016-11-16T22:25:24.878Z", + "version": 1479335124878 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.csharp", + "java": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.java", + "javascript": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.javascript", + "php": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.php", + "python": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.python", + "ruby": "/sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.ruby" + } + }, + "RetrieveCustomerCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?key=favoritemovie", + "properties": { + "version": { + "type": "integer", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveCustomerCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The retrieved custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-04-26T15:27:30Z", + "description": "The favorite movie of the customer.", + "key": "favoritemovie", + "name": "Favorite Movie", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-04-26T15:27:30Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "RetrieveCustomerCustomAttributeRequest": { + "type": "object", + "description": "Represents a [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR\u0026key=favoritemovie", + "properties": { + "with_definition": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveCustomerCustomAttributeResponse": { + "type": "object", + "description": "Represents a [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The retrieved custom attribute. If `with_definition` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-04-26T15:50:27Z", + "key": "favoritemovie", + "updated_at": "2022-04-26T15:50:27Z", + "value": "Dune", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "RetrieveCustomerGroupRequest": { + "type": "object", + "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](api-endpoint:CustomerGroups-RetrieveCustomerGroup) endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveCustomerGroupResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](api-endpoint:CustomerGroups-RetrieveCustomerGroup) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "The retrieved customer group." + } + }, + "example": { + "group": { + "created_at": "2020-04-13T21:54:57.863Z", + "id": "2TAT3CMH4Q0A9M87XJZED0WMR3", + "name": "Loyal Customers", + "updated_at": "2020-04-13T21:54:58Z" + } + } + }, + "RetrieveCustomerRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the `RetrieveCustomer`\nendpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.csharp", + "java": "/sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.java", + "javascript": "/sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.javascript", + "php": "/sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.php", + "python": "/sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.python", + "ruby": "/sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.ruby" + } + }, + "RetrieveCustomerResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `RetrieveCustomer` endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "customer": { + "$ref": "#/components/schemas/Customer", + "description": "The requested customer." + } + }, + "example": { + "customer": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2016-03-23T20:21:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "group_ids": [ + "545AXB44B4XXWMVQ4W8SBT3HHF" + ], + "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "note": "a customer", + "phone_number": "+1-212-555-4240", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID", + "segment_ids": [ + "1KB9JE5EGJXCW.REACHABLE" + ], + "updated_at": "2016-03-23T20:21:54.859Z", + "version": 1 + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.csharp", + "java": "/sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.java", + "javascript": "/sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.javascript", + "php": "/sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.php", + "python": "/sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.python", + "ruby": "/sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.ruby" + } + }, + "RetrieveCustomerSegmentRequest": { + "type": "object", + "description": "Defines the valid parameters for requests to the `RetrieveCustomerSegmentRequest` endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveCustomerSegmentResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body for requests to the `RetrieveCustomerSegment` endpoint.\n\nEither `errors` or `segment` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "segment": { + "$ref": "#/components/schemas/CustomerSegment", + "description": "The retrieved customer segment." + } + }, + "example": { + "segment": { + "created_at": "2020-01-09T19:33:24.469Z", + "id": "GMNXRZVEXNQDF.CHURN_RISK", + "name": "Lapsed", + "updated_at": "2020-04-13T23:01:13Z" + } + } + }, + "RetrieveDisputeEvidenceRequest": { + "type": "object", + "description": "Defines the parameters for a `RetrieveDisputeEvidence` request.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveDisputeEvidenceResponse": { + "type": "object", + "description": "Defines the fields in a `RetrieveDisputeEvidence` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "evidence": { + "$ref": "#/components/schemas/DisputeEvidence", + "description": "Metadata about the dispute evidence file." + } + }, + "example": { + "evidence": { + "dispute_id": "bVTprrwk0gygTLZ96VX1oB", + "evidence_file": { + "filename": "customer-interaction.jpg", + "filetype": "image/jpeg" + }, + "evidence_type": "CARDHOLDER_COMMUNICATION", + "id": "TOomLInj6iWmP3N8qfCXrB", + "uploaded_at": "2022-05-18T16:01:10.000Z" + } + } + }, + "RetrieveDisputeRequest": { + "type": "object", + "description": "Defines the request parameters for the `RetrieveDispute` endpoint.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveDisputeResponse": { + "type": "object", + "description": "Defines fields in a `RetrieveDispute` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "dispute": { + "$ref": "#/components/schemas/Dispute", + "description": "Details about the requested `Dispute`." + } + }, + "example": { + "dispute": { + "amount_money": { + "amount": 2500, + "currency": "USD" + }, + "brand_dispute_id": "100000809947", + "card_brand": "VISA", + "created_at": "2022-06-29T18:45:22.265Z", + "disputed_payment": { + "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY" + }, + "due_at": "2022-07-13T00:00:00.000Z", + "id": "XDgyFu7yo1E2S5lQGGpYn", + "location_id": "L1HN3ZMQK64X9", + "reason": "NO_KNOWLEDGE", + "reported_at": "2022-06-29T00:00:00.000Z", + "state": "ACCEPTED", + "updated_at": "2022-07-07T19:14:42.650Z", + "version": 2 + } + } + }, + "RetrieveEmployeeRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": {} + }, + "RetrieveEmployeeResponse": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": { + "employee": { + "$ref": "#/components/schemas/Employee" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + } + }, + "RetrieveGiftCardFromGANRequest": { + "type": "object", + "description": "A request to retrieve gift cards by their GANs.", + "x-release-status": "PUBLIC", + "required": [ + "gan" + ], + "properties": { + "gan": { + "type": "string", + "description": "The gift card account number (GAN) of the gift card to retrieve.\nThe maximum length of a GAN is 255 digits to account for third-party GANs that have been imported.\nSquare-issued gift cards have 16-digit GANs.", + "minLength": 1, + "maxLength": 255 + } + }, + "example": { + "gan": "7783320001001635" + } + }, + "RetrieveGiftCardFromGANResponse": { + "type": "object", + "description": "A response that contains a `GiftCard`. This response might contain a set of `Error` objects\nif the request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "A gift card that was fetched, if present. It returns empty if an error occurred." + } + }, + "example": { + "gift_card": { + "balance_money": { + "amount": 5000, + "currency": "USD" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gan": "7783320001001635", + "gan_source": "SQUARE", + "id": "gftc:6944163553804e439d89adb47caf806a", + "state": "ACTIVE", + "type": "DIGITAL" + } + } + }, + "RetrieveGiftCardFromNonceRequest": { + "type": "object", + "description": "A request to retrieve a gift card by using a payment token.", + "x-release-status": "PUBLIC", + "required": [ + "nonce" + ], + "properties": { + "nonce": { + "type": "string", + "description": "The payment token of the gift card to retrieve. Payment tokens are generated by the \nWeb Payments SDK or In-App Payments SDK.", + "minLength": 1 + } + }, + "example": { + "nonce": "cnon:7783322135245171" + } + }, + "RetrieveGiftCardFromNonceResponse": { + "type": "object", + "description": "A response that contains a `GiftCard` object. If the request resulted in errors, \nthe response contains a set of `Error` objects.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "The retrieved gift card." + } + }, + "example": { + "gift_card": { + "balance_money": { + "amount": 5000, + "currency": "USD" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gan": "7783320001001635", + "gan_source": "SQUARE", + "id": "gftc:6944163553804e439d89adb47caf806a", + "state": "ACTIVE", + "type": "DIGITAL" + } + } + }, + "RetrieveGiftCardRequest": { + "type": "object", + "description": "A request to retrieve digital gift cards.", + "x-release-status": "PUBLIC", + "x-params-example": "?id=gftc:00113070ba5745f0b2377c1b9570cb03", + "properties": {} + }, + "RetrieveGiftCardResponse": { + "type": "object", + "description": "A response that contains a `GiftCard`. The response might contain a set of `Error` objects\nif the request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "The gift card retrieved." + } + }, + "example": { + "gift_card": { + "balance_money": { + "amount": 1000, + "currency": "USD" + }, + "created_at": "2021-05-20T22:26:54.000Z", + "gan": "7783320001001635", + "gan_source": "SQUARE", + "id": "gftc:00113070ba5745f0b2377c1b9570cb03", + "state": "ACTIVE", + "type": "DIGITAL" + } + } + }, + "RetrieveInventoryAdjustmentRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.csharp", + "java": "/sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.java", + "javascript": "/sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.javascript", + "php": "/sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.php", + "python": "/sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.python", + "ruby": "/sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.ruby" + } + }, + "RetrieveInventoryAdjustmentResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "adjustment": { + "$ref": "#/components/schemas/InventoryAdjustment", + "description": "The requested [InventoryAdjustment](entity:InventoryAdjustment)." + } + }, + "example": { + "adjustment": { + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "created_at": "2016-11-17T13:02:15.142Z", + "from_state": "IN_STOCK", + "id": "UDMOEO78BG6GYWA2XDRYX3KB", + "location_id": "C6W5YS5QM06F5", + "occurred_at": "2016-11-16T25:44:22.837Z", + "quantity": "7", + "reference_id": "4a366069-4096-47a2-99a5-0084ac879509", + "source": { + "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0", + "name": "Square Point of Sale 4.37", + "product": "SQUARE_POS" + }, + "team_member_id": "LRK57NSQ5X7PUD05", + "to_state": "SOLD", + "total_price_money": { + "amount": 4550, + "currency": "USD" + } + }, + "errors": [] + } + }, + "RetrieveInventoryChangesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "x-params-example": "?location_ids=\u0026cursor=", + "properties": { + "location_ids": { + "type": "string", + "description": "The [Location](entity:Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.csharp", + "java": "/sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.java", + "javascript": "/sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.javascript", + "php": "/sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.php", + "python": "/sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.python", + "ruby": "/sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.ruby" + } + }, + "RetrieveInventoryChangesResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryChange" + }, + "description": "The set of inventory changes for the requested object and locations." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." + } + }, + "example": { + "changes": [ + { + "adjustment": { + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "created_at": "2016-11-16T22:25:24.878Z", + "from_state": "IN_STOCK", + "id": "OJKJIUANKLMLQANZADNPLKAD", + "location_id": "C6W5YS5QM06F5", + "occurred_at": "2016-11-16T22:25:24.878Z", + "quantity": "3", + "reference_id": "d8207693-168f-4b44-a2fd-a7ff533ddd26", + "source": { + "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0", + "name": "Square Point of Sale 4.37", + "product": "SQUARE_POS" + }, + "team_member_id": "AV7YRCGI2H1J5NQ8E1XIZCNA", + "to_state": "SOLD", + "total_price_money": { + "amount": 5000, + "currency": "USD" + }, + "transaction_id": "5APV6JYK1SNCZD11AND2RX1Z" + }, + "type": "ADJUSTMENT" + } + ], + "errors": [] + } + }, + "RetrieveInventoryCountRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "x-params-example": "?location_ids=C6W5YS5QM06F5\u0026cursor=", + "properties": { + "location_ids": { + "type": "string", + "description": "The [Location](entity:Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "nullable": true + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.csharp", + "java": "/sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.java", + "javascript": "/sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.javascript", + "php": "/sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.php", + "python": "/sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.python", + "ruby": "/sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.ruby" + } + }, + "RetrieveInventoryCountResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "counts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InventoryCount" + }, + "description": "The current calculated inventory counts for the requested object and\nlocations." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." + } + }, + "example": { + "counts": [ + { + "calculated_at": "2016-11-16T22:28:01.223Z", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "location_id": "C6W5YS5QM06F5", + "quantity": "22", + "state": "IN_STOCK" + } + ], + "errors": [] + } + }, + "RetrieveInventoryPhysicalCountRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.csharp", + "java": "/sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.java", + "javascript": "/sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.javascript", + "php": "/sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.php", + "python": "/sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.python", + "ruby": "/sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.ruby" + } + }, + "RetrieveInventoryPhysicalCountResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "count": { + "$ref": "#/components/schemas/InventoryPhysicalCount", + "description": "The requested [InventoryPhysicalCount](entity:InventoryPhysicalCount)." + } + }, + "example": { + "count": { + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "created_at": "2016-11-16T22:25:24.878Z", + "id": "ANZADNPLKADOJKJIUANKLMLQ", + "location_id": "C6W5YS5QM06F5", + "occurred_at": "2016-11-16T22:25:24.878Z", + "quantity": "15", + "reference_id": "f857ec37-f9a0-4458-8e23-5b5e0bea4e53", + "source": { + "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0", + "name": "Square Point of Sale 4.37", + "product": "SQUARE_POS" + }, + "state": "IN_STOCK", + "team_member_id": "LRK57NSQ5X7PUD05" + }, + "errors": [] + } + }, + "RetrieveInventoryTransferRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.csharp", + "java": "/sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.java", + "javascript": "/sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.javascript", + "php": "/sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.php", + "python": "/sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.python", + "ruby": "/sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.ruby" + } + }, + "RetrieveInventoryTransferResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "transfer": { + "$ref": "#/components/schemas/InventoryTransfer", + "description": "The requested [InventoryTransfer](entity:InventoryTransfer)." + } + }, + "example": { + "errors": [], + "transfer": { + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "catalog_object_type": "ITEM_VARIATION", + "created_at": "2016-11-17T13:02:15.142Z", + "from_location_id": "C6W5YS5QM06F5", + "id": "UDMOEO78BG6GYWA2XDRYX3KB", + "occurred_at": "2016-11-16T25:44:22.837Z", + "quantity": "7", + "reference_id": "4a366069-4096-47a2-99a5-0084ac879509", + "source": { + "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0", + "name": "Square Point of Sale 4.37", + "product": "SQUARE_POS" + }, + "state": "IN_STOCK", + "team_member_id": "LRK57NSQ5X7PUD05", + "to_location_id": "59TNP9SA8VGDA" + } + } + }, + "RetrieveJobRequest": { + "type": "object", + "description": "Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) request.", + "x-release-status": "BETA", + "properties": {}, + "example": {} + }, + "RetrieveJobResponse": { + "type": "object", + "description": "Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) response. Either `job` or `errors`\nis present in the response.", + "x-release-status": "BETA", + "properties": { + "job": { + "$ref": "#/components/schemas/Job", + "description": "The retrieved job." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "job": { + "created_at": "2021-06-11T22:55:45Z", + "id": "1yJlHapkseYnNPETIU1B", + "is_tip_eligible": true, + "title": "Cashier 1", + "updated_at": "2021-06-11T22:55:45Z", + "version": 2 + } + } + }, + "RetrieveLocationBookingProfileRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveLocationBookingProfileResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "location_booking_profile": { + "$ref": "#/components/schemas/LocationBookingProfile", + "description": "The requested location booking profile." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "errors": [], + "location_booking_profile": { + "booking_enabled": true, + "booking_site_url": "https://square.site/book/L3HETDGYQ4A2C/prod-business", + "location_id": "L3HETDGYQ4A2C" + } + } + }, + "RetrieveLocationCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [RetrieveLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "x-params-example": "?key=bestseller", + "properties": { + "version": { + "type": "integer", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveLocationCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [RetrieveLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The retrieved custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-12-02T19:06:36.559Z", + "description": "Bestselling item at location", + "key": "bestseller", + "name": "Bestseller", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-12-02T19:06:36.559Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "RetrieveLocationCustomAttributeRequest": { + "type": "object", + "description": "Represents a [RetrieveLocationCustomAttribute](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttribute) request.", + "x-release-status": "BETA", + "x-params-example": "?location_id=L0TBCBTB7P8RQ\u0026key=bestseller", + "properties": { + "with_definition": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveLocationCustomAttributeResponse": { + "type": "object", + "description": "Represents a [RetrieveLocationCustomAttribute](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The retrieved custom attribute. If `with_definition` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2023-01-09T19:02:58.647Z", + "key": "bestseller", + "updated_at": "2023-01-09T19:21:04.551Z", + "value": "hot cocoa", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "RetrieveLocationRequest": { + "type": "object", + "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](api-endpoint:Locations-RetrieveLocation) endpoint.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveLocationResponse": { + "type": "object", + "description": "Defines the fields that the [RetrieveLocation](api-endpoint:Locations-RetrieveLocation)\nendpoint returns in a response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "location": { + "$ref": "#/components/schemas/Location", + "description": "The requested location." + } + }, + "example": { + "location": { + "address": { + "address_line_1": "123 Main St", + "administrative_district_level_1": "CA", + "country": "US", + "locality": "San Francisco", + "postal_code": "94114" + }, + "business_name": "Jet Fuel Coffee", + "capabilities": [ + "CREDIT_CARD_PROCESSING" + ], + "country": "US", + "created_at": "2016-09-19T17:33:12Z", + "currency": "USD", + "id": "18YC4JDH91E1H", + "language_code": "en-US", + "merchant_id": "3MYCJG5GVYQ8Q", + "name": "Grant Park", + "phone_number": "+1 650-354-7217", + "status": "ACTIVE", + "timezone": "America/Los_Angeles" + } + } + }, + "RetrieveLocationSettingsRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {} + }, + "RetrieveLocationSettingsResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "location_settings": { + "$ref": "#/components/schemas/CheckoutLocationSettings", + "description": "The location settings." + } + }, + "example": { + "location_settings": { + "branding": { + "button_color": "#ffffff", + "button_shape": "ROUNDED", + "header_type": "FRAMED_LOGO" + }, + "customer_notes_enabled": true, + "location_id": "LOCATION_ID_1", + "policies": [ + { + "description": "This is my Return Policy", + "title": "Return Policy", + "uid": "POLICY_ID_1" + } + ], + "tipping": { + "default_percent": 15, + "default_whole_amount_money": { + "amount": 100, + "currency": "USD" + }, + "percentages": [ + 10, + 15, + 20 + ], + "smart_tipping_enabled": true, + "whole_amounts": [ + { + "amount": 1000, + "currency": "USD" + }, + { + "amount": 1500, + "currency": "USD" + }, + { + "amount": 2000, + "currency": "USD" + } + ] + }, + "updated_at": "2022-06-16T22:25:35Z" + } + } + }, + "RetrieveLoyaltyAccountRequest": { + "type": "object", + "description": "A request to retrieve a loyalty account.", + "x-release-status": "PUBLIC", + "x-params-example": "?account_id=79b807d2-d786-46a9-933b-918028d7a8c5", + "properties": {} + }, + "RetrieveLoyaltyAccountResponse": { + "type": "object", + "description": "A response that includes the loyalty account.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_account": { + "$ref": "#/components/schemas/LoyaltyAccount", + "description": "The loyalty account." + } + }, + "example": { + "loyalty_account": { + "balance": 10, + "created_at": "2020-05-08T21:44:32Z", + "customer_id": "Q8002FAM9V1EZ0ADB2T5609X6NET1H0", + "id": "79b807d2-d786-46a9-933b-918028d7a8c5", + "lifetime_points": 20, + "mapping": { + "created_at": "2020-05-08T21:44:32Z", + "id": "66aaab3f-da99-49ed-8b19-b87f851c844f", + "phone_number": "+14155551234" + }, + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "updated_at": "2020-05-08T21:44:32Z" + } + } + }, + "RetrieveLoyaltyProgramRequest": { + "type": "object", + "description": "A request to retrieve the [loyalty program](entity:LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", + "x-release-status": "PUBLIC", + "x-params-example": "?program_id=main", + "properties": {} + }, + "RetrieveLoyaltyProgramResponse": { + "type": "object", + "description": "A response that contains the loyalty program.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "program": { + "$ref": "#/components/schemas/LoyaltyProgram", + "description": "The loyalty program that was requested." + } + }, + "example": { + "program": { + "accrual_rules": [ + { + "accrual_type": "SPEND", + "points": 1, + "spend_data": { + "amount_money": { + "amount": 100, + "currency": "USD" + }, + "excluded_category_ids": [ + "7ZERJKO5PVYXCVUHV2JCZ2UG", + "FQKAOJE5C4FIMF5A2URMLW6V" + ], + "excluded_item_variation_ids": [ + "CBZXBUVVTYUBZGQO44RHMR6B", + "EDILT24Z2NISEXDKGY6HP7XV" + ], + "tax_mode": "BEFORE_TAX" + } + } + ], + "created_at": "2020-04-20T16:55:11Z", + "id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "location_ids": [ + "P034NEENMD09F" + ], + "reward_tiers": [ + { + "created_at": "2020-04-20T16:55:11Z", + "definition": { + "discount_type": "FIXED_PERCENTAGE", + "percentage_discount": "10", + "scope": "ORDER" + }, + "id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "name": "10% off entire sale", + "points": 10, + "pricing_rule_reference": { + "catalog_version": "1605486402527", + "object_id": "74C4JSHESNLTB2A7ITO5HO6F" + } + } + ], + "status": "ACTIVE", + "terminology": { + "one": "Point", + "other": "Points" + }, + "updated_at": "2020-05-01T02:00:02Z" + } + } + }, + "RetrieveLoyaltyPromotionRequest": { + "type": "object", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id=loypromo_f0f9b849-725e-378d-b810-511237e07b67", + "properties": {}, + "example": {} + }, + "RetrieveLoyaltyPromotionResponse": { + "type": "object", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion) response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_promotion": { + "$ref": "#/components/schemas/LoyaltyPromotion", + "description": "The retrieved loyalty promotion." + } + }, + "example": { + "loyalty_promotion": { + "available_time": { + "start_date": "2022-08-16", + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "created_at": "2022-08-16T08:38:54Z", + "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67", + "incentive": { + "points_multiplier_data": { + "multiplier": "3.000", + "points_multiplier": 3 + }, + "type": "POINTS_MULTIPLIER" + }, + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "minimum_spend_amount_money": { + "amount": 2000, + "currency": "USD" + }, + "name": "Tuesday Happy Hour Promo", + "qualifying_item_variation_ids": [ + "CJ3RYL56ITAKMD4VRCM7XERS", + "AT3RYLR3TUA9C34VRCB7X5RR" + ], + "status": "ACTIVE", + "trigger_limit": { + "interval": "DAY", + "times": 1 + }, + "updated_at": "2022-08-16T08:38:54Z" + } + } + }, + "RetrieveLoyaltyRewardRequest": { + "type": "object", + "description": "A request to retrieve a loyalty reward.", + "x-release-status": "PUBLIC", + "x-params-example": "?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810", + "properties": {} + }, + "RetrieveLoyaltyRewardResponse": { + "type": "object", + "description": "A response that includes the loyalty reward.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "reward": { + "$ref": "#/components/schemas/LoyaltyReward", + "description": "The loyalty reward retrieved." + } + }, + "example": { + "reward": { + "created_at": "2020-05-08T21:55:42Z", + "id": "9f18ac21-233a-31c3-be77-b45840f5a810", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "points": 10, + "redeemed_at": "2020-05-08T21:56:00Z", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "status": "REDEEMED", + "updated_at": "2020-05-08T21:56:00Z" + } + } + }, + "RetrieveMerchantCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "x-params-example": "?key=alternative_seller_name", + "properties": { + "version": { + "type": "integer", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveMerchantCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The retrieved custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2023-05-05T19:06:36.559Z", + "description": "This is the other name this merchant goes by.", + "key": "alternative_seller_name", + "name": "Alternative Merchant Name", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2023-05-05T19:06:36.559Z", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "RetrieveMerchantCustomAttributeRequest": { + "type": "object", + "description": "Represents a [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) request.", + "x-release-status": "BETA", + "x-params-example": "?merchant_id=DM7VKY8Q63GNP\u0026key=alternative_seller_name", + "properties": { + "with_definition": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." + } + } + }, + "RetrieveMerchantCustomAttributeResponse": { + "type": "object", + "description": "Represents a [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The retrieved custom attribute. If `with_definition` was set to `true` in the request,\nthe custom attribute definition is returned in the `definition` field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2023-05-06T19:02:58.647Z", + "key": "alternative_seller_name", + "updated_at": "2023-05-06T19:21:04.551Z", + "value": "Ultimate Sneaker Store", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "RetrieveMerchantRequest": { + "type": "object", + "description": "Request object for the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) endpoint.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveMerchantResponse": { + "type": "object", + "description": "The response object returned by the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "merchant": { + "$ref": "#/components/schemas/Merchant", + "description": "The requested `Merchant` object." + } + }, + "example": { + "merchant": { + "business_name": "Apple A Day", + "country": "US", + "created_at": "2021-12-10T19:25:52.484Z", + "currency": "USD", + "id": "DM7VKY8Q63GNP", + "language_code": "en-US", + "main_location_id": "9A65CGC72ZQG1", + "status": "ACTIVE" + } + } + }, + "RetrieveMerchantSettingsRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": {} + }, + "RetrieveMerchantSettingsResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "merchant_settings": { + "$ref": "#/components/schemas/CheckoutMerchantSettings", + "description": "The merchant settings." + } + }, + "example": { + "merchant_settings": { + "merchant_id": "MERCHANT_ID", + "payment_methods": { + "afterpay_clearpay": { + "enabled": true, + "item_eligibility_range": { + "max": { + "amount": 10000, + "currency": "USD" + }, + "min": { + "amount": 100, + "currency": "USD" + } + }, + "order_eligibility_range": { + "max": { + "amount": 10000, + "currency": "USD" + }, + "min": { + "amount": 100, + "currency": "USD" + } + } + }, + "apple_pay": { + "enabled": true + }, + "cash_app_pay": { + "enabled": true + }, + "google_pay": { + "enabled": true + } + }, + "updated_at": "2022-06-16T22:25:35Z" + } + } + }, + "RetrieveOrderCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents a get request for an order custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "version": { + "type": "integer", + "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute." + } + } + }, + "RetrieveOrderCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from getting an order custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The retrieved custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-10-06T16:53:23.141Z", + "description": "The number of people seated at a table", + "key": "cover-count", + "name": "Cover count", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-10-06T16:53:23.141Z", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "RetrieveOrderCustomAttributeRequest": { + "type": "object", + "description": "Represents a get request for an order custom attribute.", + "x-release-status": "BETA", + "x-params-example": "?order_id=7BbXGEIWNldxAzrtGf9GPVZTwZ4F\u0026key=cover-count", + "properties": { + "version": { + "type": "integer", + "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute." + }, + "with_definition": { + "type": "boolean", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "nullable": true + } + } + }, + "RetrieveOrderCustomAttributeResponse": { + "type": "object", + "description": "Represents a response from getting an order custom attribute.", + "x-release-status": "BETA", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The retrieved custom attribute. If `with_definition` was set to `true` in the request, the custom attribute definition is returned in the `definition field." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-11-22T21:27:33.429Z", + "key": "cover-count", + "updated_at": "2022-11-22T21:28:35.721Z", + "value": "6", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "RetrieveOrderRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveOrderResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The requested order." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "order": { + "created_at": "2020-05-18T16:30:49.614Z", + "discounts": [ + { + "applied_money": { + "amount": 550, + "currency": "USD" + }, + "name": "50% Off", + "percentage": "50", + "scope": "ORDER", + "type": "FIXED_PERCENTAGE", + "uid": "zGsRZP69aqSSR9lq9euSPB" + } + ], + "id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "line_items": [ + { + "applied_discounts": [ + { + "applied_money": { + "amount": 250, + "currency": "USD" + }, + "discount_uid": "zGsRZP69aqSSR9lq9euSPB", + "uid": "9zr9S4dxvPAixvn0lpa1VC" + } + ], + "base_price_money": { + "amount": 500, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 500, + "currency": "USD" + }, + "name": "Item 1", + "quantity": "1", + "total_discount_money": { + "amount": 250, + "currency": "USD" + }, + "total_money": { + "amount": 250, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "ULkg0tQTRK2bkU9fNv3IJD", + "variation_total_price_money": { + "amount": 500, + "currency": "USD" + } + }, + { + "applied_discounts": [ + { + "applied_money": { + "amount": 300, + "currency": "USD" + }, + "discount_uid": "zGsRZP69aqSSR9lq9euSPB", + "uid": "qa8LwwZK82FgSEkQc2HYVC" + } + ], + "base_price_money": { + "amount": 300, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 600, + "currency": "USD" + }, + "name": "Item 2", + "quantity": "2", + "total_discount_money": { + "amount": 300, + "currency": "USD" + }, + "total_money": { + "amount": 300, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "mumY8Nun4BC5aKe2yyx5a", + "variation_total_price_money": { + "amount": 600, + "currency": "USD" + } + } + ], + "location_id": "D7AVYMEAPJ3A3", + "net_amounts": { + "discount_money": { + "amount": 550, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 0, + "currency": "USD" + }, + "tip_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 550, + "currency": "USD" + } + }, + "state": "OPEN", + "total_discount_money": { + "amount": 550, + "currency": "USD" + }, + "total_money": { + "amount": 550, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "total_tip_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2020-05-18T16:30:49.614Z", + "version": 1 + } + } + }, + "RetrievePaymentLinkRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrievePaymentLinkResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "payment_link": { + "$ref": "#/components/schemas/PaymentLink", + "description": "The payment link that is retrieved." + } + }, + "example": { + "payment_link": { + "created_at": "2022-04-26T00:10:29Z", + "id": "LLO5Q3FRCFICDB4B", + "long_url": "https://checkout.square.site/EXAMPLE", + "order_id": "4uKASDATqSd1QQ9jV86sPhMdVEbSJc4F", + "url": "https://square.link/u/EXAMPLE", + "version": 1 + } + } + }, + "RetrieveSnippetRequest": { + "type": "object", + "description": "Represents a `RetrieveSnippet` request.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveSnippetResponse": { + "type": "object", + "description": "Represents a `RetrieveSnippet` response. The response can include either `snippet` or `errors`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "snippet": { + "$ref": "#/components/schemas/Snippet", + "description": "The retrieved snippet." + } + }, + "example": { + "snippet": { + "content": "\u003cscript\u003evar js = 1;\u003c/script\u003e", + "created_at": "2021-03-11T25:40:09.000000Z", + "id": "snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7", + "site_id": "site_278075276488921835", + "updated_at": "2021-03-11T25:40:09.000000Z" + } + } + }, + "RetrieveSubscriptionRequest": { + "type": "object", + "description": "Defines input parameters in a request to the \n[RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "include": { + "type": "string", + "description": "A query parameter to specify related information to be included in the response. \n\nThe supported query parameter values are: \n\n- `actions`: to include scheduled actions on the targeted subscription.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "RetrieveSubscriptionResponse": { + "type": "object", + "description": "Defines output parameters in a response from the\n[RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The subscription retrieved." + } + }, + "example": { + "subscription": { + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "charged_through_date": "2023-11-20", + "created_at": "2022-07-27T21:53:10Z", + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "id": "8151fc89-da15-4eb9-a685-1a70883cebfc", + "invoice_ids": [ + "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA" + ], + "location_id": "S8GWD5R9QB376", + "paid_until_date": "2024-08-01", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "price_override_money": { + "amount": 25000, + "currency": "USD" + }, + "source": { + "name": "My Application" + }, + "start_date": "2022-07-27", + "status": "ACTIVE", + "timezone": "America/Los_Angeles" + } + } + }, + "RetrieveTeamMemberBookingProfileRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveTeamMemberBookingProfileResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "team_member_booking_profile": { + "$ref": "#/components/schemas/TeamMemberBookingProfile", + "description": "The returned team member booking profile." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "errors": [], + "team_member_booking_profile": { + "display_name": "Sandbox Staff", + "is_bookable": true, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + } + }, + "RetrieveTeamMemberRequest": { + "type": "object", + "description": "Represents a retrieve request for a `TeamMember` object.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveTeamMemberResponse": { + "type": "object", + "description": "Represents a response from a retrieve request containing a `TeamMember` object or error messages.", + "x-release-status": "PUBLIC", + "properties": { + "team_member": { + "$ref": "#/components/schemas/TeamMember", + "description": "The successfully retrieved `TeamMember` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "GA2Y9HSJ8KRYT", + "YSGH2WBKG94QZ" + ] + }, + "created_at": "2021-06-11T22:55:45Z", + "email_address": "joe_doe@example.com", + "family_name": "Doe", + "given_name": "Joe", + "id": "1yJlHapkseYnNPETIU1B", + "is_owner": false, + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE", + "updated_at": "2021-06-15T17:38:05Z", + "wage_setting": { + "created_at": "2021-06-11T22:55:45Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "hourly_rate": { + "amount": 1443, + "currency": "USD" + }, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "1yJlHapkseYnNPETIU1B", + "updated_at": "2021-06-11T22:55:45Z", + "version": 1 + } + } + } + }, + "RetrieveTokenStatusRequest": { + "type": "object", + "description": "Request object for [RetrieveTokenStatus] endpoint.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveTokenStatusResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `RetrieveTokenStatus` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "scopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of scopes associated with an access token." + }, + "expires_at": { + "type": "string", + "description": "The date and time when the `access_token` expires, in RFC 3339 format. Empty if the token never expires." + }, + "client_id": { + "type": "string", + "description": "The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token.", + "maxLength": 191 + }, + "merchant_id": { + "type": "string", + "description": "The ID of the authorizing merchant's business.", + "minLength": 8, + "maxLength": 191 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": " Any errors that occurred during the request." + } + }, + "example": { + "client_id": "CLIENT_ID", + "expires_at": "2022-10-14T14:44:00Z", + "merchant_id": "MERCHANT_ID", + "scopes": [ + "PAYMENTS_READ", + "PAYMENTS_WRITE" + ] + } + }, + "RetrieveTransactionRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.csharp", + "java": "/sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.java", + "javascript": "/sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.javascript", + "php": "/sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.php", + "python": "/sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.python", + "ruby": "/sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.ruby" + } + }, + "RetrieveTransactionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "transaction": { + "$ref": "#/components/schemas/Transaction", + "description": "The requested transaction." + } + }, + "example": { + "transaction": { + "created_at": "2016-03-10T22:57:56Z", + "id": "KnL67ZIwXCPtzOrqj0HrkxMF", + "location_id": "18YC4JDH91E1H", + "product": "EXTERNAL_API", + "reference_id": "some optional reference id", + "tenders": [ + { + "additional_recipients": [ + { + "amount_money": { + "amount": 20, + "currency": "USD" + }, + "description": "Application fees", + "location_id": "057P5VYJ4A5X1" + } + ], + "amount_money": { + "amount": 5000, + "currency": "USD" + }, + "card_details": { + "card": { + "card_brand": "VISA", + "last_4": "1111" + }, + "entry_method": "KEYED", + "status": "CAPTURED" + }, + "created_at": "2016-03-10T22:57:56Z", + "id": "MtZRYYdDrYNQbOvV7nbuBvMF", + "location_id": "18YC4JDH91E1H", + "note": "some optional note", + "processing_fee_money": { + "amount": 138, + "currency": "USD" + }, + "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF", + "type": "CARD" + } + ] + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.csharp", + "java": "/sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.java", + "javascript": "/sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.javascript", + "php": "/sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.php", + "python": "/sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.python", + "ruby": "/sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.ruby" + } + }, + "RetrieveVendorRequest": { + "type": "object", + "description": "Represents an input to a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor).", + "x-release-status": "BETA", + "properties": {} + }, + "RetrieveVendorResponse": { + "type": "object", + "description": "Represents an output from a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered when the request fails." + }, + "vendor": { + "$ref": "#/components/schemas/Vendor", + "description": "The successfully retrieved [Vendor](entity:Vendor) object." + } + }, + "example": { + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Joe's Fresh Seafood", + "note": "a vendor", + "status": "ACTIVE", + "updated_at": "2022-03-16T10:21:54.859Z", + "version": 1 + } + } + }, + "RetrieveWageSettingRequest": { + "type": "object", + "description": "Represents a retrieve request for the wage setting of a team member.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "RetrieveWageSettingResponse": { + "type": "object", + "description": "Represents a response from a retrieve request containing the specified `WageSetting` object or error messages.", + "x-release-status": "PUBLIC", + "properties": { + "wage_setting": { + "$ref": "#/components/schemas/WageSetting", + "description": "The successfully retrieved `WageSetting` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "wage_setting": { + "created_at": "2020-06-11T23:01:21+00:00", + "is_overtime_exempt": false, + "job_assignments": [ + { + "annual_rate": { + "amount": 4500000, + "currency": "USD" + }, + "hourly_rate": { + "amount": 2164, + "currency": "USD" + }, + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + } + ], + "team_member_id": "1yJlHapkseYnNPETIU1B", + "updated_at": "2020-06-11T23:01:21+00:00", + "version": 1 + } + } + }, + "RetrieveWebhookSubscriptionRequest": { + "type": "object", + "description": "Retrieves a [Subscription](entity:WebhookSubscription) using its id.", + "x-release-status": "PUBLIC", + "properties": {} + }, + "RetrieveWebhookSubscriptionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](api-endpoint:WebhookSubscriptions-RetrieveWebhookSubscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/WebhookSubscription", + "description": "The requested [Subscription](entity:WebhookSubscription)." + } + }, + "example": { + "subscription": { + "api_version": "2021-12-15", + "created_at": "2022-01-10 23:29:48 +0000 UTC", + "enabled": true, + "event_types": [ + "payment.created", + "payment.updated" + ], + "id": "wbhk_b35f6b3145074cf9ad513610786c19d5", + "name": "Example Webhook Subscription", + "notification_url": "https://example-webhook-url.com", + "signature_key": "1k9bIJKCeTmSQwyagtNRLg", + "updated_at": "2022-01-10 23:29:48 +0000 UTC" + } + } + }, + "RevokeTokenRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "client_id": { + "type": "string", + "description": "The Square-issued ID for your application, which is available on the **OAuth** page in the\n[Developer Dashboard](https://developer.squareup.com/apps).", + "maxLength": 191, + "nullable": true + }, + "access_token": { + "type": "string", + "description": "The access token of the merchant whose token you want to revoke.\nDo not provide a value for `merchant_id` if you provide this parameter.", + "minLength": 2, + "maxLength": 1024, + "nullable": true + }, + "merchant_id": { + "type": "string", + "description": "The ID of the merchant whose token you want to revoke.\nDo not provide a value for `access_token` if you provide this parameter.", + "nullable": true + }, + "revoke_only_access_token": { + "type": "boolean", + "description": "If `true`, terminate the given single access token, but do not\nterminate the entire authorization.\nDefault: `false`", + "nullable": true + } + }, + "example": { + "access_token": "ACCESS_TOKEN", + "client_id": "CLIENT_ID" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/RevokeToken/RevokeTokenRequest.csharp", + "java": "/sdk_samples/RevokeToken/RevokeTokenRequest.java", + "javascript": "/sdk_samples/RevokeToken/RevokeTokenRequest.javascript", + "php": "/sdk_samples/RevokeToken/RevokeTokenRequest.php", + "python": "/sdk_samples/RevokeToken/RevokeTokenRequest.python", + "ruby": "/sdk_samples/RevokeToken/RevokeTokenRequest.ruby" + } + }, + "RevokeTokenResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "success": { + "type": "boolean", + "description": "If the request is successful, this is `true`." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "success": true + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/RevokeToken/RevokeTokenResponse.csharp", + "java": "/sdk_samples/RevokeToken/RevokeTokenResponse.java", + "javascript": "/sdk_samples/RevokeToken/RevokeTokenResponse.javascript", + "php": "/sdk_samples/RevokeToken/RevokeTokenResponse.php", + "python": "/sdk_samples/RevokeToken/RevokeTokenResponse.python", + "ruby": "/sdk_samples/RevokeToken/RevokeTokenResponse.ruby" + } + }, + "RiskEvaluation": { + "type": "object", + "description": "Represents fraud risk information for the associated payment.\n\nWhen you take a payment through Square's Payments API (using the `CreatePayment`\nendpoint), Square evaluates it and assigns a risk level to the payment. Sellers\ncan use this information to determine the course of action (for example,\nprovide the goods/services or refund the payment).", + "x-release-status": "BETA", + "required": [ + "status" + ], + "properties": { + "created_at": { + "type": "string", + "description": "The timestamp when payment risk was evaluated, in RFC 3339 format.", + "readOnly": true + }, + "risk_level": { + "$ref": "#/components/schemas/RiskEvaluationRiskLevel", + "description": "The risk level associated with the payment\nSee [RiskEvaluationRiskLevel](#type-riskevaluationrisklevel) for possible values", + "nullable": true + } + } + }, + "RiskEvaluationRiskLevel": { + "type": "string", + "enum": [ + "PENDING", + "NORMAL", + "MODERATE", + "HIGH" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "Indicates Square is still evaluating the payment." + }, + { + "name": "NORMAL", + "description": "Indicates payment risk is within the normal range." + }, + { + "name": "MODERATE", + "description": "Indicates elevated risk level associated with the payment." + }, + { + "name": "HIGH", + "description": "Indicates significantly elevated risk level with the payment." + } + ], + "x-release-status": "BETA" + }, + "SaveCardOptions": { + "type": "object", + "description": "Describes save-card action fields.", + "x-release-status": "BETA", + "required": [ + "customer_id" + ], + "properties": { + "customer_id": { + "type": "string", + "description": "The square-assigned ID of the customer linked to the saved card." + }, + "card_id": { + "type": "string", + "description": "The id of the created card-on-file.", + "maxLength": 64, + "readOnly": true + }, + "reference_id": { + "type": "string", + "description": "An optional user-defined reference ID that can be used to associate\nthis `Card` to another entity in an external system. For example, a customer\nID generated by a third-party system.", + "maxLength": 128, + "nullable": true + } + } + }, + "SearchAvailabilityFilter": { + "type": "object", + "description": "A query filter to search for buyer-accessible availabilities by.", + "x-release-status": "PUBLIC", + "required": [ + "start_at_range" + ], + "properties": { + "start_at_range": { + "$ref": "#/components/schemas/TimeRange", + "description": "The query expression to search for buy-accessible availabilities with their starting times falling within the specified time range.\nThe time range must be at least 24 hours and at most 32 days long.\nFor waitlist availabilities, the time range can be 0 or more up to 367 days long." + }, + "location_id": { + "type": "string", + "description": "The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID.\nThis query expression cannot be set if `booking_id` is set.", + "maxLength": 32, + "nullable": true + }, + "segment_filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SegmentFilter" + }, + "description": "The query expression to search for buyer-accessible availabilities matching the specified list of segment filters.\nIf the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability.\n\nThis query expression cannot be set if `booking_id` is set.", + "nullable": true + }, + "booking_id": { + "type": "string", + "description": "The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value.\nThis is commonly used to reschedule an appointment.\nIf this expression is set, the `location_id` and `segment_filters` expressions cannot be set.", + "maxLength": 36, + "nullable": true + } + } + }, + "SearchAvailabilityQuery": { + "type": "object", + "description": "The query used to search for buyer-accessible availabilities of bookings.", + "x-release-status": "PUBLIC", + "required": [ + "filter" + ], + "properties": { + "filter": { + "$ref": "#/components/schemas/SearchAvailabilityFilter", + "description": "The query filter to search for buyer-accessible availabilities of existing bookings." + } + } + }, + "SearchAvailabilityRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "query" + ], + "properties": { + "query": { + "$ref": "#/components/schemas/SearchAvailabilityQuery", + "description": "Query conditions used to filter buyer-accessible booking availabilities." + } + } + }, + "SearchAvailabilityResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "availabilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Availability" + }, + "description": "List of appointment slots available for booking." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "availabilities": [ + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T13:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T13:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T14:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T14:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T15:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T15:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-26T16:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T09:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T09:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T10:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T10:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T11:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T11:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T12:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T12:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T13:00:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T13:30:00Z" + }, + { + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMaJcbiRqPIGZuS9" + } + ], + "location_id": "LEQHH0YY8B42M", + "start_at": "2020-11-27T14:00:00Z" + } + ], + "errors": [] + } + }, + "SearchCatalogItemsRequest": { + "type": "object", + "description": "Defines the request body for the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "text_filter": { + "type": "string", + "description": "The text filter expression to return items or item variations containing specified text in\nthe `name`, `description`, or `abbreviation` attribute value of an item, or in\nthe `name`, `sku`, or `upc` attribute value of an item variation." + }, + "category_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The category id query expression to return items containing the specified category IDs." + }, + "stock_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchCatalogItemsRequestStockLevel" + }, + "description": "The stock-level query expression to return item variations with the specified stock levels.\nSee [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values" + }, + "enabled_location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The enabled-location query expression to return items and item variations having specified enabled locations." + }, + "cursor": { + "type": "string", + "description": "The pagination token, returned in the previous response, used to fetch the next batch of pending results." + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return per page. The default value is 100.", + "maximum": 100 + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order to sort the results by item names. The default sort order is ascending (`ASC`).\nSee [SortOrder](#type-sortorder) for possible values" + }, + "product_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogItemProductType" + }, + "description": "The product types query expression to return items or item variations having the specified product types." + }, + "custom_attribute_filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeFilter" + }, + "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint." + }, + "archived_state": { + "$ref": "#/components/schemas/ArchivedState", + "description": "The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items." + } + }, + "example": { + "category_ids": [ + "WINE_CATEGORY_ID" + ], + "custom_attribute_filters": [ + { + "bool_filter": true, + "custom_attribute_definition_id": "VEGAN_DEFINITION_ID" + }, + { + "custom_attribute_definition_id": "BRAND_DEFINITION_ID", + "string_filter": "Dark Horse" + }, + { + "key": "VINTAGE", + "number_filter": { + "max": 2018, + "min": 2017 + } + }, + { + "custom_attribute_definition_id": "VARIETAL_DEFINITION_ID", + "selection_ids_filter": "MERLOT_SELECTION_ID" + } + ], + "enabled_location_ids": [ + "ATL_LOCATION_ID" + ], + "limit": 100, + "product_types": [ + "REGULAR" + ], + "sort_order": "ASC", + "stock_levels": [ + "OUT", + "LOW" + ], + "text_filter": "red" + } + }, + "SearchCatalogItemsRequestStockLevel": { + "type": "string", + "enum": [ + "OUT", + "LOW" + ], + "x-enum-elements": [ + { + "name": "OUT", + "description": "The item inventory is empty." + }, + { + "name": "LOW", + "description": "The item inventory is low." + } + ], + "description": "Defines supported stock levels of the item inventory.", + "x-release-status": "PUBLIC" + }, + "SearchCatalogItemsResponse": { + "type": "object", + "description": "Defines the response body returned from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "Returned items matching the specified query expressions." + }, + "cursor": { + "type": "string", + "description": "Pagination token used in the next request to return more of the search result." + }, + "matched_variation_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Ids of returned item variations matching the specified query expression." + } + }, + "example": { + "items": [ + { + "custom_attribute_values": { + "BRAND": { + "custom_attribute_definition_id": "BRAND_DEFINITION_ID", + "key": "BRAND", + "name": "Brand", + "string_value": "Dark Horse", + "type": "STRING" + }, + "VARIETAL": { + "custom_attribute_definition_id": "VARIETAL_DEFINITION_ID", + "key": "VARIETAL", + "name": "Varietal", + "selection_uid_values": [ + "MERLOT_SELECTION_ID", + null + ], + "type": "SELECTION" + }, + "VINTAGE": { + "custom_attribute_definition_id": "EI7IJQDUKYSHULREPIPH6HNU", + "key": "VINTAGE", + "name": "Vintage", + "number_value": 2018, + "type": "NUMBER" + } + }, + "id": "GPOKJPTV2KDLVKCADJ7I77EZ", + "is_deleted": false, + "item_data": { + "description": "A nice red wine", + "is_archived": false, + "name": "Dark Horse Merlot 2018", + "product_type": "REGULAR", + "variations": [ + { + "id": "VBJNPHCOKDFECR6VU25WRJUD", + "is_deleted": false, + "item_variation_data": { + "item_id": "GPOKJPTV2KDLVKCADJ7I77EZ", + "name": "750 mL", + "ordinal": 0, + "price_money": { + "amount": 1000, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2020-06-18T17:55:56.646Z", + "version": 1592502956646 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2020-06-18T17:55:56.646Z", + "version": 1592502956646 + } + ], + "matched_variation_ids": [ + "VBJNPHCOKDFECR6VU25WRJUD" + ] + } + }, + "SearchCatalogObjectsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + }, + "object_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObjectType" + }, + "description": "The desired set of object types to appear in the search results.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.\n\nNote that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE,\nITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest\nin this field." + }, + "include_deleted_objects": { + "type": "boolean", + "description": "If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time." + }, + "include_related_objects": { + "type": "boolean", + "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are objects that are referenced by object ID by the objects\nin the response. This is helpful if the objects are being fetched for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included.\nFor example:\n\nIf the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`" + }, + "begin_time": { + "type": "string", + "description": "Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339\nformat, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a\ntimestamp equal to `begin_time` will not be included in the response." + }, + "query": { + "$ref": "#/components/schemas/CatalogQuery", + "description": "A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned." + }, + "limit": { + "type": "integer", + "description": "A limit on the number of results to be returned in a single page. The limit is advisory -\nthe implementation may return more or fewer results. If the supplied limit is negative, zero, or\nis higher than the maximum limit of 1,000, it will be ignored." + }, + "include_category_path_to_root": { + "type": "boolean", + "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time." + } + }, + "example": { + "limit": 100, + "object_types": [ + "ITEM" + ], + "query": { + "prefix_query": { + "attribute_name": "name", + "attribute_prefix": "tea" + } + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.csharp", + "java": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.java", + "javascript": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.javascript", + "php": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.php", + "python": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.python", + "ruby": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.ruby" + } + }, + "SearchCatalogObjectsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset, this is the final response.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "The CatalogObjects returned." + }, + "related_objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogObject" + }, + "description": "A list of CatalogObjects referenced by the objects in the `objects` field." + }, + "latest_time": { + "type": "string", + "description": "When the associated product catalog was last updated. Will\nmatch the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request.", + "x-release-status": "BETA" + } + }, + "example": { + "objects": [ + { + "id": "X5DZ5NWWAQ44CKBLKIFQGOWK", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "E7CLE5RZZ744BHWVQQEAHI2C", + "ordinal": 0 + } + ], + "description": "A delicious blend of black tea.", + "name": "Tea - Black", + "product_type": "REGULAR", + "tax_ids": [ + "ZXITPM6RWHZ7GZ7EIP3YKECM" + ], + "variations": [ + { + "id": "5GSZPX6EU7MM75S57OONG3V5", + "is_deleted": false, + "item_variation_data": { + "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK", + "name": "Regular", + "ordinal": 1, + "price_money": { + "amount": 150, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2017-10-26T15:27:31.626Z", + "version": 1509031651626 + }, + { + "id": "XVLBN7DU6JTWHJTG5F265B43", + "is_deleted": false, + "item_variation_data": { + "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK", + "name": "Large", + "ordinal": 2, + "price_money": { + "amount": 225, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2017-10-26T15:27:31.626Z", + "version": 1509031651626 + } + ], + "visibility": "PRIVATE" + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2017-10-26T15:41:32.337Z", + "version": 1509032492337 + }, + { + "id": "NNNEM3LA656Q46NXLWCNI7S5", + "is_deleted": false, + "item_data": { + "categories": [ + { + "id": "E7CLE5RZZ744BHWVQQEAHI2C", + "ordinal": 0 + } + ], + "description": "Relaxing green herbal tea.", + "name": "Tea - Green", + "product_type": "REGULAR", + "tax_ids": [ + "ZXITPM6RWHZ7GZ7EIP3YKECM" + ], + "variations": [ + { + "id": "FHYBVIA6NVBCSOVETA62WEA4", + "is_deleted": false, + "item_variation_data": { + "item_id": "NNNEM3LA656Q46NXLWCNI7S5", + "name": "Regular", + "ordinal": 1, + "price_money": { + "amount": 150, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2017-10-26T15:29:00.524Z", + "version": 1509031740524 + } + ], + "visibility": "PRIVATE" + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2017-10-26T15:41:23.232Z", + "version": 1509032483232 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.csharp", + "java": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.java", + "javascript": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.javascript", + "php": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.php", + "python": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.python", + "ruby": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.ruby" + } + }, + "SearchCustomersRequest": { + "type": "object", + "description": "Defines the fields that are included in the request body of a request to the\n`SearchCustomers` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "Include the pagination cursor in subsequent calls to this endpoint to retrieve\nthe next set of results associated with the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "format": "int64", + "minimum": 1, + "maximum": 100 + }, + "query": { + "$ref": "#/components/schemas/CustomerQuery", + "description": "The filtering and sorting criteria for the search request. If a query is not specified,\nSquare returns all customer profiles ordered alphabetically by `given_name` and `family_name`." + }, + "count": { + "type": "boolean", + "description": "Indicates whether to return the total count of matching customers in the `count` field of the response.\n\nThe default value is `false`." + } + }, + "example": { + "limit": 2, + "query": { + "filter": { + "created_at": { + "end_at": "2018-02-01T00:00:00-00:00", + "start_at": "2018-01-01T00:00:00-00:00" + }, + "creation_source": { + "rule": "INCLUDE", + "values": [ + "THIRD_PARTY" + ] + }, + "email_address": { + "fuzzy": "example.com" + }, + "group_ids": { + "all": [ + "545AXB44B4XXWMVQ4W8SBT3HHF" + ] + } + }, + "sort": { + "field": "CREATED_AT", + "order": "ASC" + } + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/SearchCustomers/SearchCustomersRequest.csharp", + "java": "/sdk_samples/SearchCustomers/SearchCustomersRequest.java", + "javascript": "/sdk_samples/SearchCustomers/SearchCustomersRequest.javascript", + "php": "/sdk_samples/SearchCustomers/SearchCustomersRequest.php", + "python": "/sdk_samples/SearchCustomers/SearchCustomersRequest.python", + "ruby": "/sdk_samples/SearchCustomers/SearchCustomersRequest.ruby" + } + }, + "SearchCustomersResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the `SearchCustomers` endpoint.\n\nEither `errors` or `customers` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + }, + "description": "The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`).\nOnly customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`)\nare included in the response." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor that can be used during subsequent calls\nto `SearchCustomers` to retrieve the next set of results associated\nwith the original query. Pagination cursors are only present when\na request succeeds and additional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "count": { + "type": "integer", + "description": "The total count of customers associated with the Square account that match the search query. Only customer profiles with\npublic information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is\npresent only if `count` is set to `true` in the request.", + "format": "int64" + } + }, + "example": { + "cursor": "9dpS093Uy12AzeE", + "customers": [ + { + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2018-01-23T20:21:54.859Z", + "creation_source": "DIRECTORY", + "email_address": "james.bond@example.com", + "family_name": "Bond", + "given_name": "James", + "group_ids": [ + "545AXB44B4XXWMVQ4W8SBT3HHF" + ], + "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "phone_number": "+1-212-555-4250", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID_2", + "segment_ids": [ + "1KB9JE5EGJXCW.REACHABLE" + ], + "updated_at": "2020-04-20T10:02:43.083Z", + "version": 7 + }, + { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2018-01-30T14:10:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "amelia.earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "group_ids": [ + "545AXB44B4XXWMVQ4W8SBT3HHF" + ], + "id": "A9641GZW2H7Z56YYSD41Q12HDW", + "note": "a customer", + "phone_number": "+1-212-555-9238", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID_1", + "segment_ids": [ + "1KB9JE5EGJXCW.REACHABLE" + ], + "updated_at": "2018-03-08T18:25:21.342Z", + "version": 1 + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/SearchCustomers/SearchCustomersResponse.csharp", + "java": "/sdk_samples/SearchCustomers/SearchCustomersResponse.java", + "javascript": "/sdk_samples/SearchCustomers/SearchCustomersResponse.javascript", + "php": "/sdk_samples/SearchCustomers/SearchCustomersResponse.php", + "python": "/sdk_samples/SearchCustomers/SearchCustomersResponse.python", + "ruby": "/sdk_samples/SearchCustomers/SearchCustomersResponse.ruby" + } + }, + "SearchEventsFilter": { + "type": "object", + "description": "Criteria to filter events by.", + "x-release-status": "BETA", + "properties": { + "event_types": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Filter events by event types.", + "nullable": true + }, + "merchant_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Filter events by merchant.", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Filter events by location.", + "nullable": true + }, + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "Filter events by when they were created." + } + } + }, + "SearchEventsQuery": { + "type": "object", + "description": "Contains query criteria for the search.", + "x-release-status": "BETA", + "properties": { + "filter": { + "$ref": "#/components/schemas/SearchEventsFilter", + "description": "Criteria to filter events by.", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/SearchEventsSort", + "description": "Criteria to sort events by.", + "nullable": true + } + } + }, + "SearchEventsRequest": { + "type": "object", + "description": "Searches [Event](entity:Event)s for your application.", + "x-release-status": "BETA", + "properties": { + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "maxLength": 256 + }, + "limit": { + "type": "integer", + "description": "The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\n\nDefault: 100", + "minimum": 1, + "maximum": 100 + }, + "query": { + "$ref": "#/components/schemas/SearchEventsQuery", + "description": "The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query." + } + } + }, + "SearchEventsResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [SearchEvents](api-endpoint:Events-SearchEvents) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + }, + "description": "The list of [Event](entity:Event)s returned by the search." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventMetadata" + }, + "description": "Contains the metadata of an event. For more information, see [Event](entity:Event)." + }, + "cursor": { + "type": "string", + "description": "When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "cursor": "6b571fc9773647f=", + "events": [ + { + "created_at": "2022-04-26T10:08:40.454726", + "data": { + "id": "ORSEVtZAJxb37RA1EiGw", + "object": { + "dispute": { + "amount_money": { + "amount": 8801, + "currency": "USD" + }, + "brand_dispute_id": "r9rKGSBBQbywBNnWWIiGFg", + "card_brand": "VISA", + "created_at": "2020-02-19T21:24:53.258Z", + "disputed_payment": { + "payment_id": "fbmsaEOpoARDKxiSGH1fqPuqoqFZY" + }, + "due_at": "2020-03-04T00:00:00.000Z", + "id": "ORSEVtZAJxb37RA1EiGw", + "location_id": "VJDQQP3CG14EY", + "reason": "AMOUNT_DIFFERS", + "reported_at": "2020-02-19T00:00:00.000Z", + "state": "WON", + "updated_at": "2020-02-19T21:34:41.851Z", + "version": 6 + } + }, + "type": "dispute" + }, + "event_id": "73ecd468-0aba-424f-b862-583d44efe7c8", + "location_id": "VJDQQP3CG14EY", + "merchant_id": "0HPGX5JYE6EE1", + "type": "dispute.state.updated" + } + ], + "metadata": [ + { + "api_version": "2022-12-13", + "event_id": "73ecd468-0aba-424f-b862-583d44efe7c8" + } + ] + } + }, + "SearchEventsSort": { + "type": "object", + "description": "Criteria to sort events by.", + "x-release-status": "BETA", + "properties": { + "field": { + "$ref": "#/components/schemas/SearchEventsSortField", + "description": "Sort events by event types.\nSee [SearchEventsSortField](#type-searcheventssortfield) for possible values", + "nullable": true + }, + "order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order to use for sorting the events.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "SearchEventsSortField": { + "type": "string", + "enum": [ + "DEFAULT" + ], + "x-enum-elements": [ + { + "name": "DEFAULT", + "description": "Use the default sort key. The default behavior is to sort events by when they were created (`created_at`)." + } + ], + "description": "Specifies the sort key for events returned from a search.", + "x-release-status": "BETA" + }, + "SearchInvoicesRequest": { + "type": "object", + "description": "Describes a `SearchInvoices` request.", + "x-release-status": "PUBLIC", + "required": [ + "query" + ], + "properties": { + "query": { + "$ref": "#/components/schemas/InvoiceQuery", + "description": "Describes the query criteria for searching invoices." + }, + "limit": { + "type": "integer", + "description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "limit": 100, + "query": { + "filter": { + "customer_ids": [ + "JDKYHBWT1D4F8MFH63DBMEN8Y4" + ], + "location_ids": [ + "ES0RJRZYEC39A" + ] + }, + "sort": { + "field": "INVOICE_SORT_DATE", + "order": "DESC" + } + } + } + }, + "SearchInvoicesResponse": { + "type": "object", + "description": "Describes a `SearchInvoices` response.", + "x-release-status": "PUBLIC", + "properties": { + "invoices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invoice" + }, + "description": "The list of invoices returned by the search." + }, + "cursor": { + "type": "string", + "description": "When a response is truncated, it includes a cursor that you can use in a \nsubsequent request to fetch the next set of invoices. If empty, this is the final \nresponse. \nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "cursor": "ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE", + "invoices": [ + { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "created_at": "2020-06-18T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "reminders": [ + { + "message": "Your invoice is due tomorrow", + "relative_scheduled_days": -1, + "status": "PENDING", + "uid": "beebd363-e47f-4075-8785-c235aaa7df11" + } + ], + "request_type": "BALANCE", + "tipping_enabled": true, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "DRAFT", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2020-06-18T17:45:13Z", + "version": 0 + }, + { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": true + }, + "created_at": "2021-01-23T15:29:12Z", + "delivery_method": "EMAIL", + "id": "inv:0-ChC366qAfskpGrBI_1bozs9mEA3", + "invoice_number": "inv-455", + "location_id": "ES0RJRZYEC39A", + "next_payment_amount_money": { + "amount": 3000, + "currency": "USD" + }, + "order_id": "a65jnS8NXbfprvGJzY9F4fQTuaB", + "payment_requests": [ + { + "automatic_payment_source": "CARD_ON_FILE", + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "computed_amount_money": { + "amount": 1000, + "currency": "USD" + }, + "due_date": "2021-01-23", + "percentage_requested": "25", + "request_type": "DEPOSIT", + "tipping_enabled": false, + "total_completed_amount_money": { + "amount": 1000, + "currency": "USD" + }, + "uid": "66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176" + }, + { + "automatic_payment_source": "CARD_ON_FILE", + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "computed_amount_money": { + "amount": 3000, + "currency": "USD" + }, + "due_date": "2021-06-15", + "request_type": "BALANCE", + "tipping_enabled": false, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "120c5e18-4f80-4f6b-b159-774cb9bf8f99" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "public_url": "https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9", + "sale_or_service_date": "2030-01-24", + "status": "PARTIALLY_PAID", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "updated_at": "2021-01-23T15:29:56Z", + "version": 3 + } + ] + } + }, + "SearchLoyaltyAccountsRequest": { + "type": "object", + "description": "A request to search for loyalty accounts.", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/SearchLoyaltyAccountsRequestLoyaltyAccountQuery", + "description": "The search criteria for the request." + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to include in the response. The default value is 30.", + "minimum": 1, + "maximum": 200 + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to \nthis endpoint. Provide this to retrieve the next set of \nresults for the original query.\n\nFor more information, \nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "limit": 10, + "query": { + "mappings": [ + { + "phone_number": "+14155551234" + } + ] + } + } + }, + "SearchLoyaltyAccountsRequestLoyaltyAccountQuery": { + "type": "object", + "description": "The search criteria for the loyalty accounts.", + "x-release-status": "PUBLIC", + "properties": { + "mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyAccountMapping" + }, + "description": "The set of mappings to use in the loyalty account search. \n\nThis cannot be combined with `customer_ids`. \n\nMax: 30 mappings", + "nullable": true + }, + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of customer IDs to use in the loyalty account search. \n\nThis cannot be combined with `mappings`. \n\nMax: 30 customer IDs", + "nullable": true + } + } + }, + "SearchLoyaltyAccountsResponse": { + "type": "object", + "description": "A response that includes loyalty accounts that satisfy the search criteria.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "loyalty_accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyAccount" + }, + "description": "The loyalty accounts that met the search criteria, \nin order of creation date." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to use in a subsequent \nrequest. If empty, this is the final response.\nFor more information, \nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "loyalty_accounts": [ + { + "balance": 10, + "created_at": "2020-05-08T21:44:32Z", + "customer_id": "Q8002FAM9V1EZ0ADB2T5609X6NET1H0", + "id": "79b807d2-d786-46a9-933b-918028d7a8c5", + "lifetime_points": 20, + "mapping": { + "created_at": "2020-05-08T21:44:32Z", + "id": "66aaab3f-da99-49ed-8b19-b87f851c844f", + "phone_number": "+14155551234" + }, + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "updated_at": "2020-05-08T21:44:32Z" + } + ] + } + }, + "SearchLoyaltyEventsRequest": { + "type": "object", + "description": "A request to search for loyalty events.", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/LoyaltyEventQuery", + "description": "A set of one or more predefined query filters to apply when \nsearching for loyalty events. The endpoint performs a logical AND to \nevaluate multiple filters and performs a logical OR on arrays \nthat specifies multiple field values." + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to include in the response. \nThe last page might contain fewer events. \nThe default is 30 events.", + "minimum": 1, + "maximum": 30 + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "limit": 30, + "query": { + "filter": { + "order_filter": { + "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY" + } + } + } + } + }, + "SearchLoyaltyEventsResponse": { + "type": "object", + "description": "A response that contains loyalty events that satisfy the search \ncriteria, in order by the `created_at` date.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyEvent" + }, + "description": "The loyalty events that satisfy the search criteria." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent \nrequest. If empty, this is the final response. \nFor more information, \nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "events": [ + { + "accumulate_points": { + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY", + "points": 5 + }, + "created_at": "2020-05-08T22:01:30Z", + "id": "c27c8465-806e-36f2-b4b3-71f5887b5ba8", + "location_id": "P034NEENMD09F", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "source": "LOYALTY_API", + "type": "ACCUMULATE_POINTS" + }, + { + "created_at": "2020-05-08T22:01:15Z", + "id": "e4a5cbc3-a4d0-3779-98e9-e578885d9430", + "location_id": "P034NEENMD09F", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "redeem_reward": { + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY", + "reward_id": "d03f79f4-815f-3500-b851-cc1e68a457f9" + }, + "source": "LOYALTY_API", + "type": "REDEEM_REWARD" + }, + { + "create_reward": { + "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "points": -10, + "reward_id": "d03f79f4-815f-3500-b851-cc1e68a457f9" + }, + "created_at": "2020-05-08T22:00:44Z", + "id": "5e127479-0b03-3671-ab1e-15faea8b7188", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "source": "LOYALTY_API", + "type": "CREATE_REWARD" + } + ] + } + }, + "SearchLoyaltyRewardsRequest": { + "type": "object", + "description": "A request to search for loyalty rewards.", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/SearchLoyaltyRewardsRequestLoyaltyRewardQuery", + "description": "The search criteria for the request. \nIf empty, the endpoint retrieves all loyalty rewards in the loyalty program." + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to return in the response. The default value is 30.", + "minimum": 1, + "maximum": 30 + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to \nthis endpoint. Provide this to retrieve the next set of \nresults for the original query.\nFor more information, \nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "limit": 10, + "query": { + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd" + } + } + }, + "SearchLoyaltyRewardsRequestLoyaltyRewardQuery": { + "type": "object", + "description": "The set of search requirements.", + "x-release-status": "PUBLIC", + "required": [ + "loyalty_account_id" + ], + "properties": { + "loyalty_account_id": { + "type": "string", + "description": "The ID of the [loyalty account](entity:LoyaltyAccount) to which the loyalty reward belongs.", + "minLength": 1 + }, + "status": { + "$ref": "#/components/schemas/LoyaltyRewardStatus", + "description": "The status of the loyalty reward.\nSee [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values", + "nullable": true + } + } + }, + "SearchLoyaltyRewardsResponse": { + "type": "object", + "description": "A response that includes the loyalty rewards satisfying the search criteria.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "rewards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyReward" + }, + "description": "The loyalty rewards that satisfy the search criteria.\nThese are returned in descending order by `updated_at`." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent \nrequest. If empty, this is the final response." + } + }, + "example": { + "rewards": [ + { + "created_at": "2020-05-08T22:00:44Z", + "id": "d03f79f4-815f-3500-b851-cc1e68a457f9", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY", + "points": 10, + "redeemed_at": "2020-05-08T22:01:17Z", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "status": "REDEEMED", + "updated_at": "2020-05-08T22:01:17Z" + }, + { + "created_at": "2020-05-08T21:55:42Z", + "id": "9f18ac21-233a-31c3-be77-b45840f5a810", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "points": 10, + "redeemed_at": "2020-05-08T21:56:00Z", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "status": "REDEEMED", + "updated_at": "2020-05-08T21:56:00Z" + }, + { + "created_at": "2020-05-01T21:49:54Z", + "id": "a8f43ebe-2ad6-3001-bdd5-7d7c2da08943", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "order_id": "5NB69ZNh3FbsOs1ox43bh1xrli6YY", + "points": 10, + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "status": "DELETED", + "updated_at": "2020-05-08T21:55:10Z" + }, + { + "created_at": "2020-05-01T20:20:37Z", + "id": "a051254c-f840-3b45-8cf1-50bcd38ff92a", + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "order_id": "LQQ16znvi2VIUKPVhUfJefzr1eEZY", + "points": 10, + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "status": "ISSUED", + "updated_at": "2020-05-01T20:20:40Z" + } + ] + } + }, + "SearchOrdersCustomerFilter": { + "type": "object", + "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](entity:FulfillmentRecipient) `customer_id`.", + "x-release-status": "BETA", + "properties": { + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of customer IDs to filter by.\n\nMax: 10 customer ids.", + "nullable": true + } + } + }, + "SearchOrdersDateTimeFilter": { + "type": "object", + "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](entity:SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", + "x-release-status": "PUBLIC", + "properties": { + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The time range for filtering on the `created_at` timestamp. If you use this\nvalue, you must set the `sort_field` in the `OrdersSearchSort` object to\n`CREATED_AT`." + }, + "updated_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The time range for filtering on the `updated_at` timestamp. If you use this\nvalue, you must set the `sort_field` in the `OrdersSearchSort` object to\n`UPDATED_AT`." + }, + "closed_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The time range for filtering on the `closed_at` timestamp. If you use this\nvalue, you must set the `sort_field` in the `OrdersSearchSort` object to\n`CLOSED_AT`.", + "nullable": true + } + } + }, + "SearchOrdersFilter": { + "type": "object", + "description": "Filtering criteria to use for a `SearchOrders` request. Multiple filters\nare ANDed together.", + "x-release-status": "PUBLIC", + "properties": { + "state_filter": { + "$ref": "#/components/schemas/SearchOrdersStateFilter", + "description": "Filter by [OrderState](entity:OrderState).", + "nullable": true + }, + "date_time_filter": { + "$ref": "#/components/schemas/SearchOrdersDateTimeFilter", + "description": "Filter for results within a time range.\n\n__Important:__ If you filter for orders by time range, you must set `SearchOrdersSort`\nto sort by the same field.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", + "nullable": true + }, + "fulfillment_filter": { + "$ref": "#/components/schemas/SearchOrdersFulfillmentFilter", + "description": "Filter by the fulfillment type or state.", + "nullable": true + }, + "source_filter": { + "$ref": "#/components/schemas/SearchOrdersSourceFilter", + "description": "Filter by the source of the order.", + "nullable": true + }, + "customer_filter": { + "$ref": "#/components/schemas/SearchOrdersCustomerFilter", + "description": "Filter by customers associated with the order.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "SearchOrdersFulfillmentFilter": { + "type": "object", + "description": "Filter based on [order fulfillment](entity:Fulfillment) information.", + "x-release-status": "PUBLIC", + "properties": { + "fulfillment_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FulfillmentType" + }, + "description": "A list of [fulfillment types](entity:FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field.\nSee [FulfillmentType](#type-fulfillmenttype) for possible values", + "nullable": true + }, + "fulfillment_states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FulfillmentState" + }, + "description": "A list of [fulfillment states](entity:FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field.\nSee [FulfillmentState](#type-fulfillmentstate) for possible values", + "nullable": true + } + } + }, + "SearchOrdersQuery": { + "type": "object", + "description": "Contains query criteria for the search.", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/SearchOrdersFilter", + "description": "Criteria to filter results by.", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/SearchOrdersSort", + "description": "Criteria to sort results by.", + "nullable": true + } + } + }, + "SearchOrdersRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The location IDs for the orders to query. All locations must belong to\nthe same merchant.\n\nMax: 10 location IDs." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "query": { + "$ref": "#/components/schemas/SearchOrdersQuery", + "description": "Query conditions used to filter or sort the results. Note that when\nretrieving additional pages using a cursor, you must use the original query." + }, + "limit": { + "type": "integer", + "description": "The maximum number of results to be returned in a single page.\n\nDefault: `500`\nMax: `1000`" + }, + "return_entries": { + "type": "boolean", + "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." + } + }, + "example": { + "limit": 3, + "location_ids": [ + "057P5VYJ4A5X1", + "18YC4JDH91E1H" + ], + "query": { + "filter": { + "date_time_filter": { + "closed_at": { + "end_at": "2019-03-04T21:54:45+00:00", + "start_at": "2018-03-03T20:00:00+00:00" + } + }, + "state_filter": { + "states": [ + "COMPLETED" + ] + } + }, + "sort": { + "sort_field": "CLOSED_AT", + "sort_order": "DESC" + } + }, + "return_entries": true + } + }, + "SearchOrdersResponse": { + "type": "object", + "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](api-endpoint:Orders-SearchOrders).", + "x-release-status": "PUBLIC", + "properties": { + "order_entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderEntry" + }, + "description": "A list of [OrderEntries](entity:OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "description": "A list of\n[Order](entity:Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "[Errors](entity:Error) encountered during the search." + } + }, + "example": { + "cursor": "123", + "order_entries": [ + { + "location_id": "057P5VYJ4A5X1", + "order_id": "CAISEM82RcpmcFBM0TfOyiHV3es", + "version": 1 + }, + { + "location_id": "18YC4JDH91E1H", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY" + }, + { + "location_id": "057P5VYJ4A5X1", + "order_id": "CAISEM52YcpmcWAzERDOyiWS3ty" + } + ] + } + }, + "SearchOrdersSort": { + "type": "object", + "description": "Sorting criteria for a `SearchOrders` request. Results can only be sorted\nby a timestamp field.", + "x-release-status": "PUBLIC", + "required": [ + "sort_field" + ], + "properties": { + "sort_field": { + "$ref": "#/components/schemas/SearchOrdersSortField", + "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](entity:SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`.\nSee [SearchOrdersSortField](#type-searchorderssortfield) for possible values" + }, + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The chronological order in which results are returned. Defaults to `DESC`.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "SearchOrdersSortField": { + "type": "string", + "enum": [ + "CREATED_AT", + "UPDATED_AT", + "CLOSED_AT" + ], + "x-enum-elements": [ + { + "name": "CREATED_AT", + "description": "The time when the order was created, in RFC-3339 format. If you are also\nfiltering for a time range in this query, you must set the `CREATED_AT`\nfield in your `DateTimeFilter`." + }, + { + "name": "UPDATED_AT", + "description": "The time when the order last updated, in RFC-3339 format. If you are also\nfiltering for a time range in this query, you must set the `UPDATED_AT`\nfield in your `DateTimeFilter`." + }, + { + "name": "CLOSED_AT", + "description": "The time when the order was closed, in RFC-3339 format. If you use this\nvalue, you must also set a `StateFilter` with closed states. If you are also\nfiltering for a time range in this query, you must set the `CLOSED_AT`\nfield in your `DateTimeFilter`." + } + ], + "description": "Specifies which timestamp to use to sort `SearchOrder` results.", + "x-release-status": "PUBLIC" + }, + "SearchOrdersSourceFilter": { + "type": "object", + "description": "A filter based on order `source` information.", + "x-release-status": "PUBLIC", + "properties": { + "source_names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Filters by the [Source](entity:OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names.", + "nullable": true + } + } + }, + "SearchOrdersStateFilter": { + "type": "object", + "description": "Filter by the current order `state`.", + "x-release-status": "PUBLIC", + "required": [ + "states" + ], + "properties": { + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderState" + }, + "description": "States to filter for.\nSee [OrderState](#type-orderstate) for possible values" + } + } + }, + "SearchShiftsRequest": { + "type": "object", + "description": "A request for a filtered and sorted set of `Shift` objects.", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/ShiftQuery", + "description": "Query filters." + }, + "limit": { + "type": "integer", + "description": "The number of resources in a page (200 by default).", + "minimum": 1, + "maximum": 200 + }, + "cursor": { + "type": "string", + "description": "An opaque cursor for fetching the next page." + } + }, + "example": { + "limit": 100, + "query": { + "filter": { + "workday": { + "date_range": { + "end_date": "2019-02-03", + "start_date": "2019-01-20" + }, + "default_timezone": "America/Los_Angeles", + "match_shifts_by": "START_AT" + } + } + } + } + }, + "SearchShiftsResponse": { + "type": "object", + "description": "The response to a request for `Shift` objects. The response contains\nthe requested `Shift` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "shifts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Shift" + }, + "description": "Shifts." + }, + "cursor": { + "type": "string", + "description": "An opaque cursor for fetching the next page." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "shifts": [ + { + "breaks": [ + { + "break_type_id": "REGS1EQR1TPZ5", + "end_at": "2019-01-21T06:11:00-05:00", + "expected_duration": "PT10M", + "id": "SJW7X6AKEJQ65", + "is_paid": true, + "name": "Tea Break", + "start_at": "2019-01-21T06:11:00-05:00" + } + ], + "created_at": "2019-01-24T01:12:03Z", + "declared_cash_tip_money": { + "amount": 500, + "currency": "USD" + }, + "employee_id": "ormj0jJJZ5OZIzxrZYJI", + "end_at": "2019-01-21T13:11:00-05:00", + "id": "X714F3HA6D1PT", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-21T03:11:00-05:00", + "status": "CLOSED", + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "timezone": "America/New_York", + "updated_at": "2019-02-07T22:21:08Z", + "version": 6, + "wage": { + "hourly_rate": { + "amount": 1100, + "currency": "USD" + }, + "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", + "tip_eligible": true, + "title": "Barista" + } + }, + { + "breaks": [ + { + "break_type_id": "WQX00VR99F53J", + "end_at": "2019-01-23T14:40:00-05:00", + "expected_duration": "PT10M", + "id": "BKS6VR7WR748A", + "is_paid": true, + "name": "Tea Break", + "start_at": "2019-01-23T14:30:00-05:00" + }, + { + "break_type_id": "P6Q468ZFRN1AC", + "end_at": "2019-01-22T12:44:00-05:00", + "expected_duration": "PT15M", + "id": "BQFEZSHFZSC51", + "is_paid": false, + "name": "Coffee Break", + "start_at": "2019-01-22T12:30:00-05:00" + } + ], + "created_at": "2019-01-23T23:32:45Z", + "declared_cash_tip_money": { + "amount": 0, + "currency": "USD" + }, + "employee_id": "33fJchumvVdJwxV0H6L9", + "end_at": "2019-01-22T13:02:00-05:00", + "id": "GDHYBZYWK0P2V", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-22T12:02:00-05:00", + "status": "CLOSED", + "team_member_id": "33fJchumvVdJwxV0H6L9", + "timezone": "America/New_York", + "updated_at": "2019-01-24T00:56:25Z", + "version": 16, + "wage": { + "hourly_rate": { + "amount": 1600, + "currency": "USD" + }, + "job_id": "gcbz15vKGnMKmaWJJ152kjim", + "tip_eligible": true, + "title": "Cook" + } + } + ] + } + }, + "SearchSubscriptionsFilter": { + "type": "object", + "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "customer_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A filter to select subscriptions based on the subscribing customer IDs.", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A filter to select subscriptions based on the location.", + "nullable": true + }, + "source_names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A filter to select subscriptions based on the source application.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "SearchSubscriptionsQuery": { + "type": "object", + "description": "Represents a query, consisting of specified query expressions, used to search for subscriptions.", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/SearchSubscriptionsFilter", + "description": "A list of query expressions.", + "nullable": true + } + } + }, + "SearchSubscriptionsRequest": { + "type": "object", + "description": "Defines input parameters in a request to the \n[SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "cursor": { + "type": "string", + "description": "When the total number of resulting subscriptions exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + }, + "limit": { + "type": "integer", + "description": "The upper limit on the number of subscriptions to return\nin a paged response.", + "minimum": 1 + }, + "query": { + "$ref": "#/components/schemas/SearchSubscriptionsQuery", + "description": "A subscription query consisting of specified filtering conditions.\n\nIf this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions." + }, + "include": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An option to include related information in the response. \n\nThe supported values are: \n\n- `actions`: to include scheduled actions on the targeted subscriptions.", + "x-release-status": "BETA" + } + }, + "example": { + "query": { + "filter": { + "customer_ids": [ + "CHFGVKYY8RSV93M5KCYTG4PN0G" + ], + "location_ids": [ + "S8GWD5R9QB376" + ], + "source_names": [ + "My App" + ] + } + } + } + }, + "SearchSubscriptionsResponse": { + "type": "object", + "description": "Defines output parameters in a response from the\n[SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + }, + "description": "The subscriptions matching the specified query expressions." + }, + "cursor": { + "type": "string", + "description": "When the total number of resulting subscription exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." + } + }, + "example": { + "subscriptions": [ + { + "canceled_date": "2021-10-30", + "card_id": "ccof:mueUsvgajChmjEbp4GB", + "charged_through_date": "2021-11-20", + "created_at": "2021-10-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "de86fc96-8664-474b-af1a-abbe59cacf0e", + "location_id": "S8GWD5R9QB376", + "paid_until_date": "2021-11-20", + "plan_variation_id": "L3TJVDHVBEQEGQDEZL2JJM7R", + "source": { + "name": "My Application" + }, + "start_date": "2021-10-20", + "status": "CANCELED", + "timezone": "UTC" + }, + { + "charged_through_date": "2022-08-19", + "created_at": "2022-01-19T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", + "invoice_ids": [ + "grebK0Q_l8H4fqoMMVvt-Q", + "rcX_i3sNmHTGKhI4W2mceA" + ], + "location_id": "S8GWD5R9QB376", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "price_override_money": { + "amount": 1000, + "currency": "USD" + }, + "source": { + "name": "My Application" + }, + "start_date": "2022-01-19", + "status": "PAUSED", + "tax_percentage": "5", + "timezone": "America/Los_Angeles", + "version": 2 + }, + { + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", + "location_id": "S8GWD5R9QB376", + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "source": { + "name": "My Application" + }, + "start_date": "2023-06-20", + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 1 + } + ] + } + }, + "SearchTeamMembersFilter": { + "type": "object", + "description": "Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied\nbetween the individual fields, and `OR` logic is applied within list-based fields.\nFor example, setting this filter value:\n```\nfilter = (locations_ids = [\"A\", \"B\"], status = ACTIVE)\n```\nreturns only active team members assigned to either location \"A\" or \"B\".", + "x-release-status": "PUBLIC", + "properties": { + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When present, filters by team members assigned to the specified locations.\nWhen empty, includes team members assigned to any location.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/TeamMemberStatus", + "description": "When present, filters by team members who match the given status.\nWhen empty, includes team members of all statuses.\nSee [TeamMemberStatus](#type-teammemberstatus) for possible values", + "nullable": true + }, + "is_owner": { + "type": "boolean", + "description": "When present and set to true, returns the team member who is the owner of the Square account.", + "nullable": true + } + } + }, + "SearchTeamMembersQuery": { + "type": "object", + "description": "Represents the parameters in a search for `TeamMember` objects.", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/SearchTeamMembersFilter", + "description": "The options to filter by.", + "nullable": true + } + } + }, + "SearchTeamMembersRequest": { + "type": "object", + "description": "Represents a search request for a filtered list of `TeamMember` objects.", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/SearchTeamMembersQuery", + "description": "The query parameters." + }, + "limit": { + "type": "integer", + "description": "The maximum number of `TeamMember` objects in a page (100 by default).", + "minimum": 1, + "maximum": 200 + }, + "cursor": { + "type": "string", + "description": "The opaque cursor for fetching the next page. For more information, see\n[pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." + } + }, + "example": { + "limit": 10, + "query": { + "filter": { + "location_ids": [ + "0G5P3VGACMMQZ" + ], + "status": "ACTIVE" + } + } + } + }, + "SearchTeamMembersResponse": { + "type": "object", + "description": "Represents a response from a search request containing a filtered list of `TeamMember` objects.", + "x-release-status": "PUBLIC", + "properties": { + "team_members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TeamMember" + }, + "description": "The filtered list of `TeamMember` objects." + }, + "cursor": { + "type": "string", + "description": "The opaque cursor for fetching the next page. For more information, see\n[pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "cursor": "N:9UglUjOXQ13-hMFypCft", + "team_members": [ + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2019-07-10T17:26:48Z", + "email_address": "johnny_cash@squareup.com", + "family_name": "Cash", + "given_name": "Johnny", + "id": "-3oZQKPKVk6gUXU_V5Qa", + "is_owner": false, + "reference_id": "12345678", + "status": "ACTIVE", + "updated_at": "2020-04-28T21:49:28Z", + "wage_setting": { + "created_at": "2021-06-11T22:55:45Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "hourly_rate": { + "amount": 1443, + "currency": "USD" + }, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "-3oZQKPKVk6gUXU_V5Qa", + "updated_at": "2021-06-11T22:55:45Z", + "version": 1 + } + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T18:14:01Z", + "family_name": "Smith", + "given_name": "Lombard", + "id": "1AVJj0DjkzbmbJw5r4KK", + "is_owner": false, + "phone_number": "+14155552671", + "reference_id": "abcded", + "status": "ACTIVE", + "updated_at": "2020-06-09T17:38:05Z", + "wage_setting": { + "created_at": "2020-03-24T18:14:01Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "hourly_rate": { + "amount": 2400, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "1AVJj0DjkzbmbJw5r4KK", + "updated_at": "2020-06-09T17:38:05Z", + "version": 2 + } + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T01:09:25Z", + "family_name": "Sway", + "given_name": "Monica", + "id": "2JCmiJol_KKFs9z2Evim", + "is_owner": false, + "status": "ACTIVE", + "updated_at": "2020-03-24T01:11:25Z", + "wage_setting": { + "created_at": "2020-03-24T01:09:25Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "hourly_rate": { + "amount": 2400, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "2JCmiJol_KKFs9z2Evim", + "updated_at": "2020-03-24T01:09:25Z", + "version": 1 + } + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T01:09:23Z", + "family_name": "Ipsum", + "given_name": "Elton", + "id": "4uXcJQSLtbk3F0UQHFNQ", + "is_owner": false, + "status": "ACTIVE", + "updated_at": "2020-03-24T01:15:23Z" + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T01:09:23Z", + "family_name": "Lo", + "given_name": "Steven", + "id": "5CoUpyrw1YwGWcRd-eDL", + "is_owner": false, + "status": "ACTIVE", + "updated_at": "2020-03-24T01:19:23Z" + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T18:14:03Z", + "family_name": "Steward", + "given_name": "Patrick", + "id": "5MRPTTp8MMBLVSmzrGha", + "is_owner": false, + "phone_number": "+14155552671", + "status": "ACTIVE", + "updated_at": "2020-03-24T18:18:03Z", + "wage_setting": { + "created_at": "2020-03-24T18:14:03Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "5MRPTTp8MMBLVSmzrGha", + "updated_at": "2020-03-24T18:14:03Z", + "version": 1 + } + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T01:09:25Z", + "family_name": "Manny", + "given_name": "Ivy", + "id": "7F5ZxsfRnkexhu1PTbfh", + "is_owner": false, + "status": "ACTIVE", + "updated_at": "2020-03-24T01:09:25Z" + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T18:14:02Z", + "email_address": "john_smith@example.com", + "family_name": "Smith", + "given_name": "John", + "id": "808X9HR72yKvVaigQXf4", + "is_owner": false, + "phone_number": "+14155552671", + "status": "ACTIVE", + "updated_at": "2020-03-24T18:14:02Z" + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T18:14:00Z", + "email_address": "r_wen@example.com", + "family_name": "Wen", + "given_name": "Robert", + "id": "9MVDVoY4hazkWKGo_OuZ", + "is_owner": false, + "phone_number": "+14155552671", + "status": "ACTIVE", + "updated_at": "2020-03-24T18:14:00Z" + }, + { + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + "created_at": "2020-03-24T18:14:00Z", + "email_address": "asimpson@example.com", + "family_name": "Simpson", + "given_name": "Ashley", + "id": "9UglUjOXQ13-hMFypCft", + "is_owner": false, + "phone_number": "+14155552671", + "status": "ACTIVE", + "updated_at": "2020-03-24T18:18:00Z", + "wage_setting": { + "created_at": "2020-03-24T18:14:00Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "9UglUjOXQ13-hMFypCft", + "updated_at": "2020-03-24T18:14:03Z", + "version": 1 + } + } + ] + } + }, + "SearchTerminalActionsRequest": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "query": { + "$ref": "#/components/schemas/TerminalActionQuery", + "description": "Queries terminal actions based on given conditions and sort order.\nLeaving this unset will return all actions with the default sort order." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more\ninformation." + }, + "limit": { + "type": "integer", + "description": "Limit the number of results returned for a single request.", + "minimum": 1, + "maximum": 100 + } + }, + "example": { + "limit": 2, + "query": { + "filter": { + "created_at": { + "start_at": "2022-04-01T00:00:00.000Z" + } + }, + "sort": { + "sort_order": "DESC" + } + } + } + }, + "SearchTerminalActionsResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "action": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TerminalAction" + }, + "description": "The requested search result of `TerminalAction`s." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more\ninformation." + } + }, + "example": { + "action": [ + { + "app_id": "APP_ID", + "created_at": "2022-04-08T15:14:04.895Z", + "deadline_duration": "PT5M", + "device_id": "DEVICE_ID", + "id": "termapia:oBGWlAats8xWCiCE", + "location_id": "LOCATION_ID", + "save_card_options": { + "customer_id": "CUSTOMER_ID", + "reference_id": "user-id-1" + }, + "status": "IN_PROGRESS", + "type": "SAVE_CARD", + "updated_at": "2022-04-08T15:14:05.446Z" + }, + { + "app_id": "APP_ID", + "created_at": "2022-04-08T15:14:01.210Z", + "deadline_duration": "PT5M", + "device_id": "DEVICE_ID", + "id": "termapia:K2NY2YSSml3lTiCE", + "location_id": "LOCATION_ID", + "save_card_options": { + "card_id": "ccof:CARD_ID", + "customer_id": "CUSTOMER_ID", + "reference_id": "user-id-1" + }, + "status": "COMPLETED", + "type": "SAVE_CARD", + "updated_at": "2022-04-08T15:14:09.861Z" + } + ], + "cursor": "CURSOR" + } + }, + "SearchTerminalCheckoutsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/TerminalCheckoutQuery", + "description": "Queries Terminal checkouts based on given conditions and the sort order.\nLeaving these unset returns all checkouts with the default sort order." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + }, + "limit": { + "type": "integer", + "description": "Limits the number of results returned for a single request.", + "minimum": 1, + "maximum": 100 + } + }, + "example": { + "limit": 2, + "query": { + "filter": { + "status": "COMPLETED" + } + } + } + }, + "SearchTerminalCheckoutsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "checkouts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TerminalCheckout" + }, + "description": "The requested search result of `TerminalCheckout` objects." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + } + }, + "example": { + "checkouts": [ + { + "amount_money": { + "amount": 2610, + "currency": "USD" + }, + "app_id": "APP_ID", + "created_at": "2020-03-31T18:13:15.921Z", + "deadline_duration": "PT5M", + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", + "skip_receipt_screen": false, + "tip_settings": { + "allow_tipping": false + } + }, + "id": "tsQPvzwBpMqqO", + "note": "A brief note", + "payment_ids": [ + "rXnhZzywrEk4vR6pw76fPZfgvaB" + ], + "reference_id": "id14467", + "status": "COMPLETED", + "updated_at": "2020-03-31T18:13:52.725Z" + }, + { + "amount_money": { + "amount": 2610, + "currency": "USD" + }, + "app_id": "APP_ID", + "created_at": "2020-03-31T18:08:31.882Z", + "deadline_duration": "PT5M", + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", + "skip_receipt_screen": true, + "tip_settings": { + "allow_tipping": false + } + }, + "id": "XlOPTgcEhrbqO", + "note": "A brief note", + "payment_ids": [ + "VYBF861PaoKPP7Pih0TlbZiNvaB" + ], + "reference_id": "id41623", + "status": "COMPLETED", + "updated_at": "2020-03-31T18:08:41.635Z" + } + ], + "cursor": "RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH" + } + }, + "SearchTerminalRefundsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "query": { + "$ref": "#/components/schemas/TerminalRefundQuery", + "description": "Queries the Terminal refunds based on given conditions and the sort order. Calling\n`SearchTerminalRefunds` without an explicit query parameter returns all available\nrefunds with the default sort order." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query." + }, + "limit": { + "type": "integer", + "description": "Limits the number of results returned for a single request.", + "minimum": 1, + "maximum": 100 + } + }, + "example": { + "limit": 1, + "query": { + "filter": { + "status": "COMPLETED" + } + } + } + }, + "SearchTerminalRefundsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TerminalRefund" + }, + "description": "The requested search result of `TerminalRefund` objects." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." + } + }, + "example": { + "refunds": [ + { + "amount_money": { + "amount": 111, + "currency": "CAD" + }, + "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ", + "card": { + "bin": "411111", + "card_brand": "INTERAC", + "card_type": "CREDIT", + "exp_month": 1, + "exp_year": 2022, + "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw", + "last_4": "1111" + }, + "created_at": "2020-09-29T15:21:46.771Z", + "deadline_duration": "PT5M", + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "location_id": "76C9W6K8CNNQ5", + "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY", + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "reason": "Returning item", + "refund_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb", + "status": "COMPLETED", + "updated_at": "2020-09-29T15:21:48.675Z" + } + ] + } + }, + "SearchVendorsRequest": { + "type": "object", + "description": "Represents an input into a call to [SearchVendors](api-endpoint:Vendors-SearchVendors).", + "x-release-status": "BETA", + "properties": { + "filter": { + "$ref": "#/components/schemas/SearchVendorsRequestFilter", + "description": "Specifies a filter used to search for vendors." + }, + "sort": { + "$ref": "#/components/schemas/SearchVendorsRequestSort", + "description": "Specifies a sorter used to sort the returned vendors." + }, + "cursor": { + "type": "string", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." + } + }, + "example": { + "query": { + "filter": { + "name": [ + "Joe's Fresh Seafood", + "Hannah's Bakery" + ], + "status": [ + "ACTIVE" + ] + }, + "sort": { + "field": "CREATED_AT", + "order": "ASC" + } + } + } + }, + "SearchVendorsRequestFilter": { + "type": "object", + "description": "Defines supported query expressions to search for vendors by.", + "x-release-status": "BETA", + "properties": { + "name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The names of the [Vendor](entity:Vendor) objects to retrieve.", + "nullable": true + }, + "status": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VendorStatus" + }, + "description": "The statuses of the [Vendor](entity:Vendor) objects to retrieve.\nSee [VendorStatus](#type-vendorstatus) for possible values", + "nullable": true + } + } + }, + "SearchVendorsRequestSort": { + "type": "object", + "description": "Defines a sorter used to sort results from [SearchVendors](api-endpoint:Vendors-SearchVendors).", + "x-release-status": "BETA", + "properties": { + "field": { + "$ref": "#/components/schemas/SearchVendorsRequestSortField", + "description": "Specifies the sort key to sort the returned vendors.\nSee [Field](#type-field) for possible values", + "nullable": true + }, + "order": { + "$ref": "#/components/schemas/SortOrder", + "description": "Specifies the sort order for the returned vendors.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "SearchVendorsRequestSortField": { + "type": "string", + "enum": [ + "NAME", + "CREATED_AT" + ], + "x-enum-elements": [ + { + "name": "NAME", + "description": "To sort the result by the name of the [Vendor](entity:Vendor) objects." + }, + { + "name": "CREATED_AT", + "description": "To sort the result by the creation time of the [Vendor](entity:Vendor) objects." + } + ], + "description": "The field to sort the returned [Vendor](entity:Vendor) objects by.", + "x-release-status": "BETA" + }, + "SearchVendorsResponse": { + "type": "object", + "description": "Represents an output from a call to [SearchVendors](api-endpoint:Vendors-SearchVendors).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered when the request fails." + }, + "vendors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Vendor" + }, + "description": "The [Vendor](entity:Vendor) objects matching the specified search filter." + }, + "cursor": { + "type": "string", + "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." + } + }, + "example": { + "vendors": [ + { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Joe's Fresh Seafood", + "note": "a vendor", + "status": "ACTIVE", + "updated_at": "2022-03-16T10:21:54.859Z", + "version": 1 + } + ] + } + }, + "SegmentFilter": { + "type": "object", + "description": "A query filter to search for buyer-accessible appointment segments by.", + "x-release-status": "PUBLIC", + "required": [ + "service_variation_id" + ], + "properties": { + "service_variation_id": { + "type": "string", + "description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.", + "minLength": 1, + "maxLength": 36 + }, + "team_member_id_filter": { + "$ref": "#/components/schemas/FilterValue", + "description": "A query filter to search for buyer-accessible appointment segments with service-providing team members matching the specified list of team member IDs. Supported query expressions are\n- `ANY`: return the appointment segments with team members whose IDs match any member in this list.\n- `NONE`: return the appointment segments with team members whose IDs are not in this list.\n- `ALL`: not supported.\n\nWhen no expression is specified, any service-providing team member is eligible to fulfill the Booking.", + "nullable": true + } + } + }, + "SelectOption": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "reference_id", + "title" + ], + "properties": { + "reference_id": { + "type": "string", + "description": "The reference id for the option.", + "minLength": 1, + "maxLength": 40 + }, + "title": { + "type": "string", + "description": "The title text that displays in the select option button.", + "minLength": 1, + "maxLength": 250 + } + } + }, + "SelectOptions": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "title", + "body", + "options" + ], + "properties": { + "title": { + "type": "string", + "description": "The title text to display in the select flow on the Terminal.", + "minLength": 1, + "maxLength": 250 + }, + "body": { + "type": "string", + "description": "The body text to display in the select flow on the Terminal.", + "minLength": 1, + "maxLength": 10000 + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SelectOption" + }, + "description": "Represents the buttons/options that should be displayed in the select flow on the Terminal." + }, + "selected_option": { + "$ref": "#/components/schemas/SelectOption", + "description": "The buyer’s selected option.", + "readOnly": true + } + } + }, + "Shift": { + "type": "object", + "description": "A record of the hourly rate, start, and end times for a single work shift\nfor an employee. This might include a record of the start and end times for breaks\ntaken during the shift.", + "x-release-status": "PUBLIC", + "required": [ + "location_id", + "start_at" + ], + "properties": { + "id": { + "type": "string", + "description": "The UUID for this object.", + "maxLength": 255 + }, + "employee_id": { + "type": "string", + "description": "The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location this shift occurred at. The location should be based on\nwhere the employee clocked in.", + "minLength": 1 + }, + "timezone": { + "type": "string", + "description": "The read-only convenience value that is calculated from the location based\non the `location_id`. Format: the IANA timezone database identifier for the\nlocation timezone.", + "nullable": true + }, + "start_at": { + "type": "string", + "description": "RFC 3339; shifted to the location timezone + offset. Precision up to the\nminute is respected; seconds are truncated.", + "minLength": 1 + }, + "end_at": { + "type": "string", + "description": "RFC 3339; shifted to the timezone + offset. Precision up to the minute is\nrespected; seconds are truncated.", + "nullable": true + }, + "wage": { + "$ref": "#/components/schemas/ShiftWage", + "description": "Job and pay related information. If the wage is not set on create, it defaults to a wage\nof zero. If the title is not set on create, it defaults to the name of the role the employee\nis assigned to, if any.", + "nullable": true + }, + "breaks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Break" + }, + "description": "A list of all the paid or unpaid breaks that were taken during this shift.", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/ShiftStatus", + "description": "Describes the working state of the current `Shift`.\nSee [ShiftStatus](#type-shiftstatus) for possible values", + "nullable": true + }, + "version": { + "type": "integer", + "description": "Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write; potentially overwriting data from another\nwrite." + }, + "created_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format; presented in UTC.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format; presented in UTC.", + "readOnly": true + }, + "team_member_id": { + "type": "string", + "description": "The ID of the team member this shift belongs to. Replaced `employee_id` at version \"2020-08-26\".", + "nullable": true + }, + "declared_cash_tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The tips declared by the team member for the shift.", + "nullable": true + } + } + }, + "ShiftFilter": { + "type": "object", + "description": "Defines a filter used in a search for `Shift` records. `AND` logic is\nused by Square's servers to apply each filter property specified.", + "x-release-status": "PUBLIC", + "properties": { + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Fetch shifts for the specified location.", + "nullable": true + }, + "employee_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/ShiftFilterStatus", + "description": "Fetch a `Shift` instance by `Shift.status`.\nSee [ShiftFilterStatus](#type-shiftfilterstatus) for possible values", + "nullable": true + }, + "start": { + "$ref": "#/components/schemas/TimeRange", + "description": "Fetch `Shift` instances that start in the time range - Inclusive.", + "nullable": true + }, + "end": { + "$ref": "#/components/schemas/TimeRange", + "description": "Fetch the `Shift` instances that end in the time range - Inclusive.", + "nullable": true + }, + "workday": { + "$ref": "#/components/schemas/ShiftWorkday", + "description": "Fetch the `Shift` instances based on the workday date range.", + "nullable": true + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Fetch shifts for the specified team members. Replaced `employee_ids` at version \"2020-08-26\".", + "nullable": true + } + } + }, + "ShiftFilterStatus": { + "type": "string", + "enum": [ + "OPEN", + "CLOSED" + ], + "x-enum-elements": [ + { + "name": "OPEN", + "description": "Shifts that have been started and not ended." + }, + { + "name": "CLOSED", + "description": "Shifts that have been started and ended." + } + ], + "description": "Specifies the `status` of `Shift` records to be returned.", + "x-release-status": "PUBLIC" + }, + "ShiftQuery": { + "type": "object", + "description": "The parameters of a `Shift` search query, which includes filter and sort options.", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/ShiftFilter", + "description": "Query filter options.", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/ShiftSort", + "description": "Sort order details.", + "nullable": true + } + } + }, + "ShiftSort": { + "type": "object", + "description": "Sets the sort order of search results.", + "x-release-status": "PUBLIC", + "properties": { + "field": { + "$ref": "#/components/schemas/ShiftSortField", + "description": "The field to sort on.\nSee [ShiftSortField](#type-shiftsortfield) for possible values", + "nullable": true + }, + "order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which results are returned. Defaults to DESC.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "ShiftSortField": { + "type": "string", + "enum": [ + "START_AT", + "END_AT", + "CREATED_AT", + "UPDATED_AT" + ], + "x-enum-elements": [ + { + "name": "START_AT", + "description": "The start date/time of a `Shift`" + }, + { + "name": "END_AT", + "description": "The end date/time of a `Shift`" + }, + { + "name": "CREATED_AT", + "description": "The date/time that a `Shift` is created" + }, + { + "name": "UPDATED_AT", + "description": "The most recent date/time that a `Shift` is updated" + } + ], + "description": "Enumerates the `Shift` fields to sort on.", + "x-release-status": "PUBLIC" + }, + "ShiftStatus": { + "type": "string", + "enum": [ + "OPEN", + "CLOSED" + ], + "x-enum-elements": [ + { + "name": "OPEN", + "description": "Employee started a work shift and the shift is not complete" + }, + { + "name": "CLOSED", + "description": "Employee started and ended a work shift." + } + ], + "description": "Enumerates the possible status of a `Shift`.", + "x-release-status": "PUBLIC" + }, + "ShiftWage": { + "type": "object", + "description": "The hourly wage rate used to compensate an employee for this shift.", + "x-release-status": "PUBLIC", + "properties": { + "title": { + "type": "string", + "description": "The name of the job performed during this shift.", + "nullable": true + }, + "hourly_rate": { + "$ref": "#/components/schemas/Money", + "description": "Can be a custom-set hourly wage or the calculated effective hourly\nwage based on the annual wage and hours worked per week.", + "nullable": true + }, + "job_id": { + "type": "string", + "description": "The id of the job performed during this shift. Square\nlabor-reporting UIs might group shifts together by id. This cannot be used to retrieve the job.", + "readOnly": true + }, + "tip_eligible": { + "type": "boolean", + "description": "Whether team members are eligible for tips when working this job.", + "nullable": true + } + } + }, + "ShiftWorkday": { + "type": "object", + "description": "A `Shift` search query filter parameter that sets a range of days that\na `Shift` must start or end in before passing the filter condition.", + "x-release-status": "PUBLIC", + "properties": { + "date_range": { + "$ref": "#/components/schemas/DateRange", + "description": "Dates for fetching the shifts.", + "nullable": true + }, + "match_shifts_by": { + "$ref": "#/components/schemas/ShiftWorkdayMatcher", + "description": "The strategy on which the dates are applied.\nSee [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible values", + "nullable": true + }, + "default_timezone": { + "type": "string", + "description": "Location-specific timezones convert workdays to datetime filters.\nEvery location included in the query must have a timezone or this field\nmust be provided as a fallback. Format: the IANA timezone database\nidentifier for the relevant timezone.", + "nullable": true + } + } + }, + "ShiftWorkdayMatcher": { + "type": "string", + "enum": [ + "START_AT", + "END_AT", + "INTERSECTION" + ], + "x-enum-elements": [ + { + "name": "START_AT", + "description": "All shifts that start on or after the specified workday" + }, + { + "name": "END_AT", + "description": "All shifts that end on or before the specified workday" + }, + { + "name": "INTERSECTION", + "description": "All shifts that start between the start and end workdays (inclusive)" + } + ], + "description": "Defines the logic used to apply a workday filter.", + "x-release-status": "PUBLIC" + }, + "ShippingFee": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "charge" + ], + "properties": { + "name": { + "type": "string", + "description": "The name for the shipping fee.", + "nullable": true + }, + "charge": { + "$ref": "#/components/schemas/Money", + "description": "The amount and currency for the shipping fee." + } + } + }, + "SignatureImage": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "image_type": { + "type": "string", + "description": "The mime/type of the image data.\nUse `image/png;base64` for png.", + "readOnly": true + }, + "data": { + "type": "string", + "description": "The base64 representation of the image.", + "readOnly": true + } + } + }, + "SignatureOptions": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "title", + "body" + ], + "properties": { + "title": { + "type": "string", + "description": "The title text to display in the signature capture flow on the Terminal.", + "minLength": 1, + "maxLength": 250 + }, + "body": { + "type": "string", + "description": "The body text to display in the signature capture flow on the Terminal.", + "minLength": 1, + "maxLength": 10000 + }, + "signature": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SignatureImage" + }, + "description": "An image representation of the collected signature.", + "readOnly": true + } + } + }, + "Site": { + "type": "object", + "description": "Represents a Square Online site, which is an online store for a Square seller.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the site.", + "maxLength": 32, + "readOnly": true + }, + "site_title": { + "type": "string", + "description": "The title of the site.", + "nullable": true + }, + "domain": { + "type": "string", + "description": "The domain of the site (without the protocol). For example, `mysite1.square.site`.", + "nullable": true + }, + "is_published": { + "type": "boolean", + "description": "Indicates whether the site is published.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the site was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the site was last updated, in RFC 3339 format.", + "readOnly": true + } + } + }, + "Snippet": { + "type": "object", + "description": "Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages.", + "x-release-status": "PUBLIC", + "required": [ + "content" + ], + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID for the snippet.", + "maxLength": 48, + "readOnly": true + }, + "site_id": { + "type": "string", + "description": "The ID of the site that contains the snippet.", + "readOnly": true + }, + "content": { + "type": "string", + "description": "The snippet code, which can contain valid HTML, JavaScript, or both.", + "minLength": 1, + "maxLength": 65535 + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the snippet was initially added to the site, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the snippet was last updated on the site, in RFC 3339 format.", + "readOnly": true + } + } + }, + "SnippetResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "snippet": { + "$ref": "#/components/schemas/Snippet", + "description": "The snippet." + } + } + }, + "SortOrder": { + "type": "string", + "enum": [ + "DESC", + "ASC" + ], + "x-enum-elements": [ + { + "name": "DESC", + "description": "The results are returned in descending (e.g., newest-first or Z-A) order." + }, + { + "name": "ASC", + "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order." + } + ], + "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", + "x-release-status": "PUBLIC" + }, + "SourceApplication": { + "type": "object", + "description": "Represents information about the application used to generate a change.", + "x-release-status": "PUBLIC", + "properties": { + "product": { + "$ref": "#/components/schemas/Product", + "description": "__Read only__ The [product](entity:Product) type of the application.\nSee [Product](#type-product) for possible values", + "nullable": true + }, + "application_id": { + "type": "string", + "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](entity:Product) type is `EXTERNAL_API`.", + "nullable": true + }, + "name": { + "type": "string", + "description": "__Read only__ The display name of the application\n(for example, `\"Custom Application\"` or `\"Square POS 4.74 for Android\"`).", + "nullable": true + } + } + }, + "SquareAccountDetails": { + "type": "object", + "description": "Additional details about Square Account payments.", + "x-release-status": "PUBLIC", + "properties": { + "payment_source_token": { + "type": "string", + "description": "Unique identifier for the payment source used for this payment.", + "maxLength": 255, + "nullable": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request.", + "nullable": true + } + } + }, + "StandardUnitDescription": { + "type": "object", + "description": "Contains the name and abbreviation for standard measurement unit.", + "x-release-status": "PUBLIC", + "properties": { + "unit": { + "$ref": "#/components/schemas/MeasurementUnit", + "description": "Identifies the measurement unit being described.", + "nullable": true + }, + "name": { + "type": "string", + "description": "UI display name of the measurement unit. For example, 'Pound'.", + "nullable": true + }, + "abbreviation": { + "type": "string", + "description": "UI display abbreviation for the measurement unit. For example, 'lb'.", + "nullable": true + } + } + }, + "StandardUnitDescriptionGroup": { + "type": "object", + "description": "Group of standard measurement units.", + "x-release-status": "PUBLIC", + "properties": { + "standard_unit_descriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StandardUnitDescription" + }, + "description": "List of standard (non-custom) measurement units in this description group.", + "nullable": true + }, + "language_code": { + "type": "string", + "description": "IETF language tag.", + "nullable": true + } + } + }, + "SubmitEvidenceRequest": { + "type": "object", + "description": "Defines the parameters for a `SubmitEvidence` request.", + "x-release-status": "PUBLIC", + "properties": {}, + "example": {} + }, + "SubmitEvidenceResponse": { + "type": "object", + "description": "Defines the fields in a `SubmitEvidence` response.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "dispute": { + "$ref": "#/components/schemas/Dispute", + "description": "The `Dispute` for which evidence was submitted." + } + }, + "example": { + "dispute": { + "amount_money": { + "amount": 4350, + "currency": "USD" + }, + "brand_dispute_id": "100000399240", + "card_brand": "VISA", + "created_at": "2022-05-18T16:02:15.313Z", + "disputed_payment": { + "payment_id": "2yeBUWJzllJTpmnSqtMRAL19taB" + }, + "due_at": "2022-06-01T00:00:00.000Z", + "id": "EAZoK70gX3fyvibecLwIGB", + "location_id": "LSY8XKGSMMX94", + "reason": "CUSTOMER_REQUESTS_CREDIT", + "reported_at": "2022-05-18T00:00:00.000Z", + "state": "PROCESSING", + "updated_at": "2022-05-18T16:02:15.313Z", + "version": 4 + } + } + }, + "Subscription": { + "type": "object", + "description": "Represents a subscription purchased by a customer.\n\nFor more information, see\n[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions).", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The Square-assigned ID of the subscription.", + "maxLength": 255, + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The ID of the location associated with the subscription.", + "readOnly": true + }, + "plan_variation_id": { + "type": "string", + "description": "The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation).", + "readOnly": true + }, + "customer_id": { + "type": "string", + "description": "The ID of the subscribing [customer](entity:Customer) profile.", + "readOnly": true + }, + "start_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription.", + "readOnly": true + }, + "canceled_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription, \nwhen the subscription status changes to `CANCELED` and the subscription billing stops.\n\nIf this field is not set, the subscription ends according its subscription plan.\n\nThis field cannot be updated, other than being cleared.", + "nullable": true + }, + "charged_through_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the\nsubscription.\n\nAfter the invoice is sent for a given billing period,\nthis date will be the last day of the billing period.\nFor example,\nsuppose for the month of May a subscriber gets an invoice\n(or charged the card) on May 1. For the monthly billing scenario,\nthis date is then set to May 31.", + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/SubscriptionStatus", + "description": "The current status of the subscription.\nSee [SubscriptionStatus](#type-subscriptionstatus) for possible values", + "readOnly": true + }, + "tax_percentage": { + "type": "string", + "description": "The tax amount applied when billing the subscription. The\npercentage is expressed in decimal form, using a `'.'` as the decimal\nseparator and without a `'%'` sign. For example, a value of `7.5`\ncorresponds to 7.5%.", + "nullable": true + }, + "invoice_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the [invoices](entity:Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", + "readOnly": true + }, + "price_override_money": { + "$ref": "#/components/schemas/Money", + "description": "A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing.\nThis field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, \nyou should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates).", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version of the object. When updating an object, the version\nsupplied must match the version in the database, otherwise the write will\nbe rejected as conflicting.", + "format": "int64" + }, + "created_at": { + "type": "string", + "description": "The timestamp when the subscription was created, in RFC 3339 format.", + "readOnly": true + }, + "card_id": { + "type": "string", + "description": "The ID of the [subscriber's](entity:Customer) [card](entity:Card)\nused to charge for the subscription.", + "nullable": true + }, + "timezone": { + "type": "string", + "description": "Timezone that will be used in date calculations for the subscription.\nDefaults to the timezone of the location based on `location_id`.\nFormat: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`).", + "readOnly": true + }, + "source": { + "$ref": "#/components/schemas/SubscriptionSource", + "description": "The origination details of the subscription.", + "x-release-status": "BETA", + "nullable": true + }, + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAction" + }, + "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) with the query parameter\nof `include=actions` or from \n[SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) with the input parameter \nof `include:[\"actions\"]`.", + "x-release-status": "BETA", + "nullable": true + }, + "monthly_billing_anchor_date": { + "type": "integer", + "description": "The day of the month on which the subscription will issue invoices and publish orders.", + "readOnly": true, + "x-release-status": "BETA" + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Phase" + }, + "description": "array of phases for this subscription", + "readOnly": true + } + } + }, + "SubscriptionAction": { + "type": "object", + "description": "Represents an action as a pending change to a subscription.", + "x-release-status": "BETA", + "properties": { + "id": { + "type": "string", + "description": "The ID of an action scoped to a subscription." + }, + "type": { + "$ref": "#/components/schemas/SubscriptionActionType", + "description": "The type of the action.\nSee [SubscriptionActionType](#type-subscriptionactiontype) for possible values", + "nullable": true + }, + "effective_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date when the action occurs on the subscription.", + "nullable": true + }, + "monthly_billing_anchor_date": { + "type": "integer", + "description": "The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action.", + "nullable": true + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Phase" + }, + "description": "A list of Phases, to pass phase-specific information used in the swap.", + "nullable": true + }, + "new_plan_variation_id": { + "type": "string", + "description": "The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action.", + "nullable": true + } + } + }, + "SubscriptionActionType": { + "type": "string", + "enum": [ + "CANCEL", + "PAUSE", + "RESUME", + "SWAP_PLAN", + "CHANGE_BILLING_ANCHOR_DATE" + ], + "x-enum-elements": [ + { + "name": "CANCEL", + "description": "The action to execute a scheduled cancellation of a subscription." + }, + { + "name": "PAUSE", + "description": "The action to execute a scheduled pause of a subscription." + }, + { + "name": "RESUME", + "description": "The action to execute a scheduled resumption of a subscription." + }, + { + "name": "SWAP_PLAN", + "description": "The action to execute a scheduled swap of a subscription plan in a subscription." + }, + { + "name": "CHANGE_BILLING_ANCHOR_DATE", + "description": "A billing anchor date change action." + } + ], + "description": "Supported types of an action as a pending change to a subscription.", + "x-release-status": "BETA" + }, + "SubscriptionCadence": { + "type": "string", + "enum": [ + "DAILY", + "WEEKLY", + "EVERY_TWO_WEEKS", + "THIRTY_DAYS", + "SIXTY_DAYS", + "NINETY_DAYS", + "MONTHLY", + "EVERY_TWO_MONTHS", + "QUARTERLY", + "EVERY_FOUR_MONTHS", + "EVERY_SIX_MONTHS", + "ANNUAL", + "EVERY_TWO_YEARS" + ], + "x-enum-elements": [ + { + "name": "DAILY", + "description": "Once per day" + }, + { + "name": "WEEKLY", + "description": "Once per week" + }, + { + "name": "EVERY_TWO_WEEKS", + "description": "Every two weeks" + }, + { + "name": "THIRTY_DAYS", + "description": "Once every 30 days" + }, + { + "name": "SIXTY_DAYS", + "description": "Once every 60 days" + }, + { + "name": "NINETY_DAYS", + "description": "Once every 90 days" + }, + { + "name": "MONTHLY", + "description": "Once per month" + }, + { + "name": "EVERY_TWO_MONTHS", + "description": "Once every two months" + }, + { + "name": "QUARTERLY", + "description": "Once every three months" + }, + { + "name": "EVERY_FOUR_MONTHS", + "description": "Once every four months" + }, + { + "name": "EVERY_SIX_MONTHS", + "description": "Once every six months" + }, + { + "name": "ANNUAL", + "description": "Once per year" + }, + { + "name": "EVERY_TWO_YEARS", + "description": "Once every two years" + } + ], + "description": "Determines the billing cadence of a [Subscription](entity:Subscription)", + "x-release-status": "PUBLIC" + }, + "SubscriptionEvent": { + "type": "object", + "description": "Describes changes to a subscription and the subscription status.", + "x-release-status": "PUBLIC", + "required": [ + "id", + "subscription_event_type", + "effective_date", + "plan_variation_id" + ], + "properties": { + "id": { + "type": "string", + "description": "The ID of the subscription event." + }, + "subscription_event_type": { + "$ref": "#/components/schemas/SubscriptionEventSubscriptionEventType", + "description": "Type of the subscription event.\nSee [SubscriptionEventSubscriptionEventType](#type-subscriptioneventsubscriptioneventtype) for possible values" + }, + "effective_date": { + "type": "string", + "description": "The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the subscription event occurred." + }, + "monthly_billing_anchor_date": { + "type": "integer", + "description": "The day-of-the-month the billing anchor date was changed to, if applicable.", + "readOnly": true, + "x-release-status": "BETA" + }, + "info": { + "$ref": "#/components/schemas/SubscriptionEventInfo", + "description": "Additional information about the subscription event.", + "nullable": true + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Phase" + }, + "description": "A list of Phases, to pass phase-specific information used in the swap.", + "nullable": true + }, + "plan_variation_id": { + "type": "string", + "description": "The ID of the subscription plan variation associated with the subscription." + } + } + }, + "SubscriptionEventInfo": { + "type": "object", + "description": "Provides information about the subscription event.", + "x-release-status": "PUBLIC", + "properties": { + "detail": { + "type": "string", + "description": "A human-readable explanation for the event.", + "nullable": true + }, + "code": { + "$ref": "#/components/schemas/SubscriptionEventInfoCode", + "description": "An info code indicating the subscription event that occurred.\nSee [InfoCode](#type-infocode) for possible values", + "nullable": true + } + } + }, + "SubscriptionEventInfoCode": { + "type": "string", + "enum": [ + "LOCATION_NOT_ACTIVE", + "LOCATION_CANNOT_ACCEPT_PAYMENT", + "CUSTOMER_DELETED", + "CUSTOMER_NO_EMAIL", + "CUSTOMER_NO_NAME", + "USER_PROVIDED" + ], + "x-enum-elements": [ + { + "name": "LOCATION_NOT_ACTIVE", + "description": "The location is not active." + }, + { + "name": "LOCATION_CANNOT_ACCEPT_PAYMENT", + "description": "The location cannot accept payments." + }, + { + "name": "CUSTOMER_DELETED", + "description": "The subscribing customer profile has been deleted." + }, + { + "name": "CUSTOMER_NO_EMAIL", + "description": "The subscribing customer does not have an email." + }, + { + "name": "CUSTOMER_NO_NAME", + "description": "The subscribing customer does not have a name." + }, + { + "name": "USER_PROVIDED", + "description": "User-provided detail." + } + ], + "description": "Supported info codes of a subscription event.", + "x-release-status": "PUBLIC" + }, + "SubscriptionEventSubscriptionEventType": { + "type": "string", + "enum": [ + "START_SUBSCRIPTION", + "PLAN_CHANGE", + "STOP_SUBSCRIPTION", + "DEACTIVATE_SUBSCRIPTION", + "RESUME_SUBSCRIPTION", + "PAUSE_SUBSCRIPTION", + "BILLING_ANCHOR_DATE_CHANGED" + ], + "x-enum-elements": [ + { + "name": "START_SUBSCRIPTION", + "description": "The subscription was started." + }, + { + "name": "PLAN_CHANGE", + "description": "The subscription plan was changed." + }, + { + "name": "STOP_SUBSCRIPTION", + "description": "The subscription was stopped." + }, + { + "name": "DEACTIVATE_SUBSCRIPTION", + "description": "The subscription was deactivated" + }, + { + "name": "RESUME_SUBSCRIPTION", + "description": "The subscription was resumed." + }, + { + "name": "PAUSE_SUBSCRIPTION", + "description": "The subscription was paused." + }, + { + "name": "BILLING_ANCHOR_DATE_CHANGED", + "description": "The billing anchor date was changed." + } + ], + "description": "Supported types of an event occurred to a subscription.", + "x-release-status": "PUBLIC" + }, + "SubscriptionPhase": { + "type": "object", + "description": "Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", + "x-release-status": "PUBLIC", + "required": [ + "cadence" + ], + "properties": { + "uid": { + "type": "string", + "description": "The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.", + "nullable": true + }, + "cadence": { + "$ref": "#/components/schemas/SubscriptionCadence", + "description": "The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created.\nSee [SubscriptionCadence](#type-subscriptioncadence) for possible values" + }, + "periods": { + "type": "integer", + "description": "The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.", + "nullable": true + }, + "recurring_price_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount to bill for each `cadence`. Failure to specify this field results in a `MISSING_REQUIRED_PARAMETER` error at runtime.", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.", + "format": "int64", + "nullable": true + }, + "pricing": { + "$ref": "#/components/schemas/SubscriptionPricing", + "description": "The subscription pricing.", + "nullable": true + } + } + }, + "SubscriptionPricing": { + "type": "object", + "description": "Describes the pricing for the subscription.", + "x-release-status": "PUBLIC", + "properties": { + "type": { + "$ref": "#/components/schemas/SubscriptionPricingType", + "description": "RELATIVE or STATIC\nSee [SubscriptionPricingType](#type-subscriptionpricingtype) for possible values", + "nullable": true + }, + "discount_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The ids of the discount catalog objects", + "nullable": true + }, + "price_money": { + "$ref": "#/components/schemas/Money", + "description": "The price of the subscription, if STATIC", + "nullable": true + } + } + }, + "SubscriptionPricingType": { + "type": "string", + "enum": [ + "STATIC", + "RELATIVE" + ], + "x-enum-elements": [ + { + "name": "STATIC", + "description": "Static pricing" + }, + { + "name": "RELATIVE", + "description": "Relative pricing" + } + ], + "description": "Determines the pricing of a [Subscription](entity:Subscription)", + "x-release-status": "PUBLIC" + }, + "SubscriptionSource": { + "type": "object", + "description": "The origination details of the subscription.", + "x-release-status": "BETA", + "properties": { + "name": { + "type": "string", + "description": "The name used to identify the place (physical or digital) that\na subscription originates. If unset, the name defaults to the name\nof the application that created the subscription.", + "maxLength": 255, + "nullable": true + } + } + }, + "SubscriptionStatus": { + "type": "string", + "enum": [ + "PENDING", + "ACTIVE", + "CANCELED", + "DEACTIVATED", + "PAUSED" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "The subscription is pending to start in the future." + }, + { + "name": "ACTIVE", + "description": "The subscription is active." + }, + { + "name": "CANCELED", + "description": "The subscription is canceled." + }, + { + "name": "DEACTIVATED", + "description": "The subscription is deactivated." + }, + { + "name": "PAUSED", + "description": "The subscription is paused." + } + ], + "description": "Supported subscription statuses.", + "x-release-status": "PUBLIC" + }, + "SubscriptionTestResult": { + "type": "object", + "description": "Represents the details of a webhook subscription, including notification URL,\nevent types, and signature key.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A Square-generated unique ID for the subscription test result.", + "maxLength": 64, + "readOnly": true + }, + "status_code": { + "type": "integer", + "description": "The status code returned by the subscription notification URL.", + "nullable": true + }, + "payload": { + "type": "string", + "description": "An object containing the payload of the test event. For example, a `payment.created` event.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the subscription was created, in RFC 3339 format. \nFor example, \"2016-09-04T23:59:33.123Z\".", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the subscription was updated, in RFC 3339 format. For example, \"2016-09-04T23:59:33.123Z\".\nBecause a subscription test result is unique, this field is the same as the `created_at` field.", + "readOnly": true + } + } + }, + "SwapPlanRequest": { + "type": "object", + "description": "Defines input parameters in a call to the\n[SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint.", + "x-release-status": "BETA", + "properties": { + "new_plan_variation_id": { + "type": "string", + "description": "The ID of the new subscription plan variation.\n\nThis field is required.", + "nullable": true + }, + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PhaseInput" + }, + "description": "A list of PhaseInputs, to pass phase-specific information used in the swap.", + "nullable": true + } + }, + "example": { + "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", + "phases": [ + { + "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY", + "ordinal": 0 + } + ] + } + }, + "SwapPlanResponse": { + "type": "object", + "description": "Defines output parameters in a response of the \n[SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint.", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The subscription with the updated subscription plan." + }, + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAction" + }, + "description": "A list of a `SWAP_PLAN` action created by the request." + } + }, + "example": { + "actions": [ + { + "effective_date": "2023-11-17", + "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83", + "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", + "phases": [ + { + "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY", + "ordinal": 0 + } + ], + "type": "SWAP_PLAN" + } + ], + "subscription": { + "created_at": "2023-06-20T21:53:10Z", + "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "id": "9ba40961-995a-4a3d-8c53-048c40cafc13", + "location_id": "S8GWD5R9QB376", + "phases": [ + { + "order_template_id": "E6oBY5WfQ2eN4pkYZwq4ka6n7KeZY", + "ordinal": 0, + "plan_phase_uid": "C66BKH3ASTDYGJJCEZXQQSS7", + "uid": "98d6f53b-40e1-4714-8827-032fd923be25" + } + ], + "plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", + "price_override_money": { + "amount": 2000, + "currency": "USD" + }, + "source": { + "name": "My Application" + }, + "status": "ACTIVE", + "timezone": "America/Los_Angeles", + "version": 3 + } + } + }, + "TaxCalculationPhase": { + "type": "string", + "enum": [ + "TAX_SUBTOTAL_PHASE", + "TAX_TOTAL_PHASE" + ], + "x-enum-elements": [ + { + "name": "TAX_SUBTOTAL_PHASE", + "description": "The fee is calculated based on the payment's subtotal." + }, + { + "name": "TAX_TOTAL_PHASE", + "description": "The fee is calculated based on the payment's total." + } + ], + "description": "When to calculate the taxes due on a cart.", + "x-release-status": "PUBLIC" + }, + "TaxIds": { + "type": "object", + "description": "Identifiers for the location used by various governments for tax purposes.", + "x-release-status": "BETA", + "properties": { + "eu_vat": { + "type": "string", + "description": "The EU VAT number for this location. For example, `IE3426675K`.\nIf the EU VAT number is present, it is well-formed and has been\nvalidated with VIES, the VAT Information Exchange System.", + "readOnly": true + }, + "fr_siret": { + "type": "string", + "description": "The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements)\nnumber is a 14-digit code issued by the French INSEE. For example, `39922799000021`.", + "readOnly": true + }, + "fr_naf": { + "type": "string", + "description": "The French government uses the NAF (Nomenclature des Activités Françaises) to display and\ntrack economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code.\nFor example, `6910Z`.", + "readOnly": true + }, + "es_nif": { + "type": "string", + "description": "The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain.\nIf it is present, it has been validated. For example, `73628495A`.", + "readOnly": true + }, + "jp_qii": { + "type": "string", + "description": "The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan.\nFor example, `T1234567890123`.", + "readOnly": true + } + } + }, + "TaxInclusionType": { + "type": "string", + "enum": [ + "ADDITIVE", + "INCLUSIVE" + ], + "x-enum-elements": [ + { + "name": "ADDITIVE", + "description": "The tax is an additive tax. The tax amount is added on top of the\nCatalogItemVariation price. For example, a $1.00 item with a 10% additive\ntax would have a total cost to the buyer of $1.10." + }, + { + "name": "INCLUSIVE", + "description": "The tax is an inclusive tax. The tax amount is included in the\nCatalogItemVariation price. For example, a $1.00 item with a 10% inclusive\ntax would have a total cost to the buyer of $1.00, with $0.91 (91 cents) of\nthat total being the cost of the item and $0.09 (9 cents) being tax." + } + ], + "description": "Whether to the tax amount should be additional to or included in the CatalogItem price.", + "x-release-status": "PUBLIC" + }, + "TeamMember": { + "type": "object", + "description": "A record representing an individual team member for a business.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the team member.", + "readOnly": true + }, + "reference_id": { + "type": "string", + "description": "A second ID used to associate the team member with an entity in another system.", + "nullable": true + }, + "is_owner": { + "type": "boolean", + "description": "Whether the team member is the owner of the Square account.", + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/TeamMemberStatus", + "description": "Describes the status of the team member.\nSee [TeamMemberStatus](#type-teammemberstatus) for possible values", + "nullable": true + }, + "given_name": { + "type": "string", + "description": "The given name (that is, the first name) associated with the team member.", + "nullable": true + }, + "family_name": { + "type": "string", + "description": "The family name (that is, the last name) associated with the team member.", + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address associated with the team member. After accepting the invitation\nfrom Square, only the team member can change this value.", + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The team member's phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp when the team member was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the team member was last updated, in RFC 3339 format.", + "readOnly": true + }, + "assigned_locations": { + "$ref": "#/components/schemas/TeamMemberAssignedLocations", + "description": "Describes the team member's assigned locations.", + "nullable": true + }, + "wage_setting": { + "$ref": "#/components/schemas/WageSetting", + "description": "Information about the team member's overtime exemption status, job assignments, and compensation.", + "x-release-status": "BETA", + "nullable": true + } + } + }, + "TeamMemberAssignedLocations": { + "type": "object", + "description": "An object that represents a team member's assignment to locations.", + "x-release-status": "PUBLIC", + "properties": { + "assignment_type": { + "$ref": "#/components/schemas/TeamMemberAssignedLocationsAssignmentType", + "description": "The current assignment type of the team member.\nSee [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) for possible values", + "nullable": true + }, + "location_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The explicit locations that the team member is assigned to.", + "nullable": true + } + } + }, + "TeamMemberAssignedLocationsAssignmentType": { + "type": "string", + "enum": [ + "ALL_CURRENT_AND_FUTURE_LOCATIONS", + "EXPLICIT_LOCATIONS" + ], + "x-enum-elements": [ + { + "name": "ALL_CURRENT_AND_FUTURE_LOCATIONS", + "description": "The team member is assigned to all current and future locations. The `location_ids` field\nis empty if the team member has this assignment type." + }, + { + "name": "EXPLICIT_LOCATIONS", + "description": "The team member is assigned to an explicit subset of locations. The `location_ids` field\nis the list of locations that the team member is assigned to." + } + ], + "description": "Enumerates the possible assignment types that the team member can have.", + "x-release-status": "PUBLIC" + }, + "TeamMemberBookingProfile": { + "type": "object", + "description": "The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider.", + "x-release-status": "PUBLIC", + "properties": { + "team_member_id": { + "type": "string", + "description": "The ID of the [TeamMember](entity:TeamMember) object for the team member associated with the booking profile.", + "maxLength": 32, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the team member.", + "maxLength": 65536, + "readOnly": true + }, + "display_name": { + "type": "string", + "description": "The display name of the team member.", + "maxLength": 512, + "readOnly": true + }, + "is_bookable": { + "type": "boolean", + "description": "Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true`) or not (`false`).", + "nullable": true + }, + "profile_image_url": { + "type": "string", + "description": "The URL of the team member's image for the bookings profile.", + "maxLength": 2048, + "readOnly": true + } + } + }, + "TeamMemberInvitationStatus": { + "type": "string", + "enum": [ + "UNINVITED", + "PENDING", + "ACCEPTED" + ], + "x-enum-elements": [ + { + "name": "UNINVITED", + "description": "The team member has not received an invitation." + }, + { + "name": "PENDING", + "description": "The team member has received an invitation, but had not accepted it." + }, + { + "name": "ACCEPTED", + "description": "The team member has both received and accepted an invitation." + } + ], + "description": "Enumerates the possible invitation statuses the team member can have within a business.", + "x-release-status": "PUBLIC" + }, + "TeamMemberStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "The team member can sign in to Point of Sale and the Seller Dashboard." + }, + { + "name": "INACTIVE", + "description": "The team member can no longer sign in to Point of Sale or the Seller Dashboard,\nbut the team member's sales reports remain available." + } + ], + "description": "Enumerates the possible statuses the team member can have within a business.", + "x-release-status": "PUBLIC" + }, + "TeamMemberWage": { + "type": "object", + "description": "The hourly wage rate that a team member earns on a `Shift` for doing the job\nspecified by the `title` property of this object.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "The UUID for this object." + }, + "team_member_id": { + "type": "string", + "description": "The `TeamMember` that this wage is assigned to.", + "nullable": true + }, + "title": { + "type": "string", + "description": "The job title that this wage relates to.", + "nullable": true + }, + "hourly_rate": { + "$ref": "#/components/schemas/Money", + "description": "Can be a custom-set hourly wage or the calculated effective hourly\nwage based on the annual wage and hours worked per week.", + "nullable": true + }, + "job_id": { + "type": "string", + "description": "An identifier for the job that this wage relates to. This cannot be\nused to retrieve the job.", + "nullable": true + }, + "tip_eligible": { + "type": "boolean", + "description": "Whether team members are eligible for tips when working this job.", + "nullable": true + } + } + }, + "Tender": { + "type": "object", + "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", + "x-release-status": "PUBLIC", + "required": [ + "type" + ], + "properties": { + "id": { + "type": "string", + "description": "The tender's unique ID. It is the associated payment ID.", + "maxLength": 192 + }, + "location_id": { + "type": "string", + "description": "The ID of the transaction's associated location.", + "maxLength": 50, + "nullable": true + }, + "transaction_id": { + "type": "string", + "description": "The ID of the tender's associated transaction.", + "maxLength": 192, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the tender was created, in RFC 3339 format.", + "maxLength": 32, + "readOnly": true + }, + "note": { + "type": "string", + "description": "An optional note associated with the tender at the time of payment.", + "maxLength": 500, + "nullable": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](entity:Payment) will be equal to the\n`amount_money` of the tender.", + "nullable": true + }, + "tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The tip's amount of the tender.", + "nullable": true + }, + "processing_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of any Square processing fees applied to the tender.\n\nThis field is not immediately populated when a new transaction is created.\nIt is usually available after about ten seconds.", + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "If the tender is associated with a customer or represents a customer's card on file,\nthis is the ID of the associated customer.", + "maxLength": 191, + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/TenderType", + "description": "The type of tender, such as `CARD` or `CASH`.\nSee [TenderType](#type-tendertype) for possible values" + }, + "card_details": { + "$ref": "#/components/schemas/TenderCardDetails", + "description": "The details of the card tender.\n\nThis value is present only if the value of `type` is `CARD`.", + "nullable": true + }, + "cash_details": { + "$ref": "#/components/schemas/TenderCashDetails", + "description": "The details of the cash tender.\n\nThis value is present only if the value of `type` is `CASH`.", + "nullable": true + }, + "bank_account_details": { + "$ref": "#/components/schemas/TenderBankAccountDetails", + "description": "The details of the bank account tender.\n\nThis value is present only if the value of `type` is `BANK_ACCOUNT`.", + "nullable": true + }, + "buy_now_pay_later_details": { + "$ref": "#/components/schemas/TenderBuyNowPayLaterDetails", + "description": "The details of a Buy Now Pay Later tender.\n\nThis value is present only if the value of `type` is `BUY_NOW_PAY_LATER`.", + "nullable": true + }, + "square_account_details": { + "$ref": "#/components/schemas/TenderSquareAccountDetails", + "description": "The details of a Square Account tender.\n\nThis value is present only if the value of `type` is `SQUARE_ACCOUNT`.", + "nullable": true + }, + "additional_recipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalRecipient" + }, + "description": "Additional recipients (other than the merchant) receiving a portion of this tender.\nFor example, fees assessed on the purchase by a third party integration.", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "payment_id": { + "type": "string", + "description": "The ID of the [Payment](entity:Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API.", + "maxLength": 192, + "nullable": true + } + } + }, + "TenderBankAccountDetails": { + "type": "object", + "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](entity:BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", + "x-release-status": "PUBLIC", + "properties": { + "status": { + "$ref": "#/components/schemas/TenderBankAccountDetailsStatus", + "description": "The bank account payment's current state.\n\nSee [TenderBankAccountPaymentDetailsStatus](entity:TenderBankAccountDetailsStatus) for possible values.\nSee [TenderBankAccountDetailsStatus](#type-tenderbankaccountdetailsstatus) for possible values", + "nullable": true + } + } + }, + "TenderBankAccountDetailsStatus": { + "type": "string", + "enum": [ + "PENDING", + "COMPLETED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "The bank account payment is in progress." + }, + { + "name": "COMPLETED", + "description": "The bank account payment has been completed." + }, + { + "name": "FAILED", + "description": "The bank account payment failed." + } + ], + "description": "Indicates the bank account payment's current status.", + "x-release-status": "PUBLIC" + }, + "TenderBuyNowPayLaterDetails": { + "type": "object", + "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", + "x-release-status": "PUBLIC", + "properties": { + "buy_now_pay_later_brand": { + "$ref": "#/components/schemas/TenderBuyNowPayLaterDetailsBrand", + "description": "The Buy Now Pay Later brand.\nSee [Brand](#type-brand) for possible values", + "readOnly": true + }, + "status": { + "$ref": "#/components/schemas/TenderBuyNowPayLaterDetailsStatus", + "description": "The buy now pay later payment's current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](entity:TenderBuyNowPayLaterDetailsStatus)\nfor possible values.\nSee [Status](#type-status) for possible values", + "nullable": true + } + } + }, + "TenderBuyNowPayLaterDetailsBrand": { + "type": "string", + "enum": [ + "OTHER_BRAND", + "AFTERPAY" + ], + "x-enum-elements": [ + { + "name": "OTHER_BRAND", + "description": "" + }, + { + "name": "AFTERPAY", + "description": "" + } + ], + "x-release-status": "PUBLIC" + }, + "TenderBuyNowPayLaterDetailsStatus": { + "type": "string", + "enum": [ + "AUTHORIZED", + "CAPTURED", + "VOIDED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "AUTHORIZED", + "description": "The buy now pay later payment has been authorized but not yet captured." + }, + { + "name": "CAPTURED", + "description": "The buy now pay later payment was authorized and subsequently captured (i.e., completed)." + }, + { + "name": "VOIDED", + "description": "The buy now pay later payment was authorized and subsequently voided (i.e., canceled)." + }, + { + "name": "FAILED", + "description": "The buy now pay later payment failed." + } + ], + "x-release-status": "PUBLIC" + }, + "TenderCardDetails": { + "type": "object", + "description": "Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`", + "x-release-status": "PUBLIC", + "properties": { + "status": { + "$ref": "#/components/schemas/TenderCardDetailsStatus", + "description": "The credit card payment's current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](entity:TenderCardDetailsStatus)\nfor possible values.\nSee [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values", + "nullable": true + }, + "card": { + "$ref": "#/components/schemas/Card", + "description": "The credit card's non-confidential details.", + "nullable": true + }, + "entry_method": { + "$ref": "#/components/schemas/TenderCardDetailsEntryMethod", + "description": "The method used to enter the card's details for the transaction.\nSee [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values", + "nullable": true + } + } + }, + "TenderCardDetailsEntryMethod": { + "type": "string", + "enum": [ + "SWIPED", + "KEYED", + "EMV", + "ON_FILE", + "CONTACTLESS" + ], + "x-enum-elements": [ + { + "name": "SWIPED", + "description": "The card was swiped through a Square reader or Square stand." + }, + { + "name": "KEYED", + "description": "The card information was keyed manually into Square Point of Sale or a\nSquare-hosted web form." + }, + { + "name": "EMV", + "description": "The card was processed via EMV with a Square reader." + }, + { + "name": "ON_FILE", + "description": "The buyer's card details were already on file with Square." + }, + { + "name": "CONTACTLESS", + "description": "The card was processed via a contactless (i.e., NFC) transaction\nwith a Square reader." + } + ], + "description": "Indicates the method used to enter the card's details.", + "x-release-status": "PUBLIC" + }, + "TenderCardDetailsStatus": { + "type": "string", + "enum": [ + "AUTHORIZED", + "CAPTURED", + "VOIDED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "AUTHORIZED", + "description": "The card transaction has been authorized but not yet captured." + }, + { + "name": "CAPTURED", + "description": "The card transaction was authorized and subsequently captured (i.e., completed)." + }, + { + "name": "VOIDED", + "description": "The card transaction was authorized and subsequently voided (i.e., canceled)." + }, + { + "name": "FAILED", + "description": "The card transaction failed." + } + ], + "description": "Indicates the card transaction's current status.", + "x-release-status": "PUBLIC" + }, + "TenderCashDetails": { + "type": "object", + "description": "Represents the details of a tender with `type` `CASH`.", + "x-release-status": "PUBLIC", + "properties": { + "buyer_tendered_money": { + "$ref": "#/components/schemas/Money", + "description": "The total amount of cash provided by the buyer, before change is given.", + "nullable": true + }, + "change_back_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of change returned to the buyer.", + "nullable": true + } + } + }, + "TenderSquareAccountDetails": { + "type": "object", + "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", + "x-release-status": "PUBLIC", + "properties": { + "status": { + "$ref": "#/components/schemas/TenderSquareAccountDetailsStatus", + "description": "The Square Account payment's current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderSquareAccountDetailsStatus](entity:TenderSquareAccountDetailsStatus)\nfor possible values.\nSee [Status](#type-status) for possible values", + "nullable": true + } + } + }, + "TenderSquareAccountDetailsStatus": { + "type": "string", + "enum": [ + "AUTHORIZED", + "CAPTURED", + "VOIDED", + "FAILED" + ], + "x-enum-elements": [ + { + "name": "AUTHORIZED", + "description": "The Square Account payment has been authorized but not yet captured." + }, + { + "name": "CAPTURED", + "description": "The Square Account payment was authorized and subsequently captured (i.e., completed)." + }, + { + "name": "VOIDED", + "description": "The Square Account payment was authorized and subsequently voided (i.e., canceled)." + }, + { + "name": "FAILED", + "description": "The Square Account payment failed." + } + ], + "x-release-status": "PUBLIC" + }, + "TenderType": { + "type": "string", + "enum": [ + "CARD", + "CASH", + "THIRD_PARTY_CARD", + "SQUARE_GIFT_CARD", + "NO_SALE", + "BANK_ACCOUNT", + "WALLET", + "BUY_NOW_PAY_LATER", + "SQUARE_ACCOUNT", + "OTHER" + ], + "x-enum-elements": [ + { + "name": "CARD", + "description": "A credit card." + }, + { + "name": "CASH", + "description": "Cash." + }, + { + "name": "THIRD_PARTY_CARD", + "description": "A credit card processed with a card processor other than Square.\n\nThis value applies only to merchants in countries where Square does not\nyet provide card processing." + }, + { + "name": "SQUARE_GIFT_CARD", + "description": "A Square gift card." + }, + { + "name": "NO_SALE", + "description": "This tender represents the register being opened for a \"no sale\" event." + }, + { + "name": "BANK_ACCOUNT", + "description": "A bank account payment." + }, + { + "name": "WALLET", + "description": "A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,\nAu Pay, D Barai, Merpay, Wechat Pay, Alipay.\n\nNote: Some \"digital wallets\", including Google Pay and Apple Pay, facilitate\ncard payments. Those payments have the `CARD` type." + }, + { + "name": "BUY_NOW_PAY_LATER", + "description": "A Buy Now Pay Later payment." + }, + { + "name": "SQUARE_ACCOUNT", + "description": "A Square House Account payment." + }, + { + "name": "OTHER", + "description": "A form of tender that does not match any other value." + } + ], + "description": "Indicates a tender's type.", + "x-release-status": "PUBLIC" + }, + "TerminalAction": { + "type": "object", + "description": "Represents an action processed by the Square Terminal.", + "x-release-status": "BETA", + "properties": { + "id": { + "type": "string", + "description": "A unique ID for this `TerminalAction`.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "device_id": { + "type": "string", + "description": "The unique Id of the device intended for this `TerminalAction`.\nThe Id can be retrieved from /v2/devices api.", + "nullable": true + }, + "deadline_duration": { + "type": "string", + "description": "The duration as an RFC 3339 duration, after which the action will be automatically canceled.\nTerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason\nof `TIMED_OUT`\n\nDefault: 5 minutes from creation\n\nMaximum: 5 minutes", + "nullable": true + }, + "status": { + "type": "string", + "description": "The status of the `TerminalAction`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`", + "readOnly": true + }, + "cancel_reason": { + "$ref": "#/components/schemas/ActionCancelReason", + "description": "The reason why `TerminalAction` is canceled. Present if the status is `CANCELED`.\nSee [ActionCancelReason](#type-actioncancelreason) for possible values", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time when the `TerminalAction` was created as an RFC 3339 timestamp.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time when the `TerminalAction` was last updated as an RFC 3339 timestamp.", + "readOnly": true + }, + "app_id": { + "type": "string", + "description": "The ID of the application that created the action.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The location id the action is attached to, if a link can be made.", + "maxLength": 64, + "readOnly": true, + "x-release-status": "PUBLIC" + }, + "type": { + "$ref": "#/components/schemas/TerminalActionActionType", + "description": "Represents the type of the action.\nSee [ActionType](#type-actiontype) for possible values", + "nullable": true + }, + "qr_code_options": { + "$ref": "#/components/schemas/QrCodeOptions", + "description": "Describes configuration for the QR code action. Requires `QR_CODE` type.", + "nullable": true + }, + "save_card_options": { + "$ref": "#/components/schemas/SaveCardOptions", + "description": "Describes configuration for the save-card action. Requires `SAVE_CARD` type.", + "nullable": true + }, + "signature_options": { + "$ref": "#/components/schemas/SignatureOptions", + "description": "Describes configuration for the signature capture action. Requires `SIGNATURE` type.", + "nullable": true + }, + "confirmation_options": { + "$ref": "#/components/schemas/ConfirmationOptions", + "description": "Describes configuration for the confirmation action. Requires `CONFIRMATION` type.", + "nullable": true + }, + "receipt_options": { + "$ref": "#/components/schemas/ReceiptOptions", + "description": "Describes configuration for the receipt action. Requires `RECEIPT` type.", + "nullable": true + }, + "data_collection_options": { + "$ref": "#/components/schemas/DataCollectionOptions", + "description": "Describes configuration for the data collection action. Requires `DATA_COLLECTION` type.", + "nullable": true + }, + "select_options": { + "$ref": "#/components/schemas/SelectOptions", + "description": "Describes configuration for the select action. Requires `SELECT` type.", + "nullable": true + }, + "device_metadata": { + "$ref": "#/components/schemas/DeviceMetadata", + "description": "Details about the Terminal that received the action request (such as battery level,\noperating system version, and network connection settings).\n\nOnly available for `PING` action type.", + "readOnly": true + }, + "await_next_action": { + "type": "boolean", + "description": "Indicates the action will be linked to another action and requires a waiting dialog to be\ndisplayed instead of returning to the idle screen on completion of the action.\n\nOnly supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.", + "nullable": true + }, + "await_next_action_duration": { + "type": "string", + "description": "The timeout duration of the waiting dialog as an RFC 3339 duration, after which the\nwaiting dialog will no longer be displayed and the Terminal will return to the idle screen.\n\nDefault: 5 minutes from when the waiting dialog is displayed\n\nMaximum: 5 minutes", + "nullable": true + } + } + }, + "TerminalActionActionType": { + "type": "string", + "enum": [ + "QR_CODE", + "PING", + "SAVE_CARD", + "SIGNATURE", + "CONFIRMATION", + "RECEIPT", + "DATA_COLLECTION", + "SELECT" + ], + "x-enum-elements": [ + { + "name": "QR_CODE", + "description": "The action represents a request to display a QR code. Details are contained in\nthe `qr_code_options` object." + }, + { + "name": "PING", + "description": "The action represents a request to check if the specific device is\nonline or currently active with the merchant in question. Does not require an action options value." + }, + { + "name": "SAVE_CARD", + "description": "Represents a request to save a card for future card-on-file use. Details are contained\nin the `save_card_options` object." + }, + { + "name": "SIGNATURE", + "description": "The action represents a request to capture a buyer's signature. Details are contained\nin the `signature_options` object." + }, + { + "name": "CONFIRMATION", + "description": "The action represents a request to collect a buyer's confirmation decision to the\ndisplayed terms. Details are contained in the `confirmation_options` object." + }, + { + "name": "RECEIPT", + "description": "The action represents a request to display the receipt screen options. Details are\ncontained in the `receipt_options` object." + }, + { + "name": "DATA_COLLECTION", + "description": "The action represents a request to collect a buyer's text data. Details\nare contained in the `data_collection_options` object." + }, + { + "name": "SELECT", + "description": "The action represents a request to allow the buyer to select from provided options.\nDetails are contained in the `select_options` object." + } + ], + "description": "Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.", + "x-release-status": "BETA" + }, + "TerminalActionQuery": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "filter": { + "$ref": "#/components/schemas/TerminalActionQueryFilter", + "description": "Options for filtering returned `TerminalAction`s", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/TerminalActionQuerySort", + "description": "Option for sorting returned `TerminalAction` objects.", + "nullable": true + } + }, + "example": { + "include": [ + "CUSTOMER" + ], + "limit": 2, + "query": { + "filter": { + "status": "COMPLETED" + } + } + } + }, + "TerminalActionQueryFilter": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "device_id": { + "type": "string", + "description": "`TerminalAction`s associated with a specific device. If no device is specified then all\n`TerminalAction`s for the merchant will be displayed.", + "nullable": true + }, + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "Time range for the beginning of the reporting period. Inclusive.\nDefault value: The current time minus one day.\nNote that `TerminalAction`s are available for 30 days after creation." + }, + "status": { + "type": "string", + "description": "Filter results with the desired status of the `TerminalAction`\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/TerminalActionActionType", + "description": "Filter results with the requested ActionType.\nSee [TerminalActionActionType](#type-terminalactionactiontype) for possible values", + "nullable": true + } + } + }, + "TerminalActionQuerySort": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "TerminalCheckout": { + "type": "object", + "description": "Represents a checkout processed by the Square Terminal.", + "x-release-status": "PUBLIC", + "required": [ + "amount_money", + "device_options" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique ID for this `TerminalCheckout`.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money (including the tax amount) that the Square Terminal device should try to collect." + }, + "reference_id": { + "type": "string", + "description": "An optional user-defined reference ID that can be used to associate\nthis `TerminalCheckout` to another entity in an external system. For example, an order\nID generated by a third-party shopping cart. The ID is also associated with any payments\nused to complete the checkout.", + "maxLength": 40, + "nullable": true + }, + "note": { + "type": "string", + "description": "An optional note to associate with the checkout, as well as with any payments used to complete the checkout.\nNote: maximum 500 characters", + "maxLength": 500, + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The reference to the Square order ID for the checkout request.", + "nullable": true + }, + "payment_options": { + "$ref": "#/components/schemas/PaymentOptions", + "description": "Payment-specific options for the checkout request.", + "nullable": true + }, + "device_options": { + "$ref": "#/components/schemas/DeviceCheckoutOptions", + "description": "Options to control the display and behavior of the Square Terminal device." + }, + "deadline_duration": { + "type": "string", + "description": "An RFC 3339 duration, after which the checkout is automatically canceled.\nA `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason\nof `TIMED_OUT`.\n\nDefault: 5 minutes from creation\n\nMaximum: 5 minutes", + "x-release-status": "DEPRECATED", + "nullable": true + }, + "status": { + "type": "string", + "description": "The status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`", + "readOnly": true + }, + "cancel_reason": { + "$ref": "#/components/schemas/ActionCancelReason", + "description": "The reason why `TerminalCheckout` is canceled. Present if the status is `CANCELED`.\nSee [ActionCancelReason](#type-actioncancelreason) for possible values", + "readOnly": true + }, + "payment_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of IDs for payments created by this `TerminalCheckout`.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp.", + "readOnly": true + }, + "app_id": { + "type": "string", + "description": "The ID of the application that created the checkout.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The location of the device where the `TerminalCheckout` was directed.", + "maxLength": 64, + "readOnly": true + }, + "payment_type": { + "$ref": "#/components/schemas/CheckoutOptionsPaymentType", + "description": "The type of payment the terminal should attempt to capture from. Defaults to `CARD_PRESENT`.\nSee [CheckoutOptionsPaymentType](#type-checkoutoptionspaymenttype) for possible values", + "nullable": true + }, + "team_member_id": { + "type": "string", + "description": "An optional ID of the team member associated with creating the checkout.", + "nullable": true + }, + "customer_id": { + "type": "string", + "description": "An optional ID of the customer associated with the checkout.", + "nullable": true + }, + "app_fee_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount the developer is taking as a fee for facilitating the payment on behalf\nof the seller.\n\nThe amount cannot be more than 90% of the total amount of the payment.\n\nThe amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).\n\nThe fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller.\n\nFor more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).\n\nTo set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions).", + "nullable": true + }, + "statement_description_identifier": { + "type": "string", + "description": "Optional additional payment information to include on the customer's card statement as\npart of the statement description. This can be, for example, an invoice number, ticket number,\nor short description that uniquely identifies the purchase.", + "maxLength": 20, + "nullable": true + }, + "tip_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount designated as a tip, in addition to `amount_money`. This may only be set for a\ncheckout that has tipping disabled (`tip_settings.allow_tipping` is `false`).", + "nullable": true + } + } + }, + "TerminalCheckoutQuery": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/TerminalCheckoutQueryFilter", + "description": "Options for filtering returned `TerminalCheckout` objects.", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/TerminalCheckoutQuerySort", + "description": "Option for sorting returned `TerminalCheckout` objects.", + "nullable": true + } + } + }, + "TerminalCheckoutQueryFilter": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "device_id": { + "type": "string", + "description": "The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all\n`TerminalCheckout` objects for the merchant are displayed.", + "nullable": true + }, + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The time range for the beginning of the reporting period, which is inclusive.\nDefault value: The current time minus one day.\nNote that `TerminalCheckout`s are available for 30 days after creation." + }, + "status": { + "type": "string", + "description": "Filtered results with the desired status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`", + "nullable": true + } + } + }, + "TerminalCheckoutQuerySort": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "sort_order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which results are listed.\nDefault: `DESC`\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + } + } + }, + "TerminalRefund": { + "type": "object", + "description": "Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.", + "x-release-status": "PUBLIC", + "required": [ + "payment_id", + "amount_money", + "reason", + "device_id" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique ID for this `TerminalRefund`.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "refund_id": { + "type": "string", + "description": "The reference to the payment refund created by completing this `TerminalRefund`.", + "readOnly": true + }, + "payment_id": { + "type": "string", + "description": "The unique ID of the payment being refunded.", + "minLength": 1 + }, + "order_id": { + "type": "string", + "description": "The reference to the Square order ID for the payment identified by the `payment_id`.", + "readOnly": true + }, + "amount_money": { + "$ref": "#/components/schemas/Money", + "description": "The amount of money, inclusive of `tax_money`, that the `TerminalRefund` should return.\nThis value is limited to the amount taken in the original payment minus any completed or\npending refunds." + }, + "reason": { + "type": "string", + "description": "A description of the reason for the refund.", + "maxLength": 192 + }, + "device_id": { + "type": "string", + "description": "The unique ID of the device intended for this `TerminalRefund`.\nThe Id can be retrieved from /v2/devices api." + }, + "deadline_duration": { + "type": "string", + "description": "The RFC 3339 duration, after which the refund is automatically canceled.\nA `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason\nof `TIMED_OUT`.\n\nDefault: 5 minutes from creation.\n\nMaximum: 5 minutes", + "nullable": true + }, + "status": { + "type": "string", + "description": "The status of the `TerminalRefund`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.", + "readOnly": true + }, + "cancel_reason": { + "$ref": "#/components/schemas/ActionCancelReason", + "description": "Present if the status is `CANCELED`.\nSee [ActionCancelReason](#type-actioncancelreason) for possible values", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time when the `TerminalRefund` was created, as an RFC 3339 timestamp.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp.", + "readOnly": true + }, + "app_id": { + "type": "string", + "description": "The ID of the application that created the refund.", + "readOnly": true + }, + "location_id": { + "type": "string", + "description": "The location of the device where the `TerminalRefund` was directed.", + "maxLength": 64, + "readOnly": true + } + } + }, + "TerminalRefundQuery": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "filter": { + "$ref": "#/components/schemas/TerminalRefundQueryFilter", + "description": "The filter for the Terminal refund query.", + "nullable": true + }, + "sort": { + "$ref": "#/components/schemas/TerminalRefundQuerySort", + "description": "The sort order for the Terminal refund query.", + "nullable": true + } + } + }, + "TerminalRefundQueryFilter": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "device_id": { + "type": "string", + "description": "`TerminalRefund` objects associated with a specific device. If no device is specified, then all\n`TerminalRefund` objects for the signed-in account are displayed.", + "nullable": true + }, + "created_at": { + "$ref": "#/components/schemas/TimeRange", + "description": "The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive.\nDefault value: The current time minus one day.\nNote that `TerminalRefund`s are available for 30 days after creation." + }, + "status": { + "type": "string", + "description": "Filtered results with the desired status of the `TerminalRefund`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.", + "nullable": true + } + } + }, + "TerminalRefundQuerySort": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "sort_order": { + "type": "string", + "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "nullable": true + } + } + }, + "TestWebhookSubscriptionRequest": { + "type": "object", + "description": "Tests a [Subscription](entity:WebhookSubscription) by sending a test event to its notification URL.", + "x-release-status": "PUBLIC", + "properties": { + "event_type": { + "type": "string", + "description": "The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](entity:WebhookSubscription).", + "nullable": true + } + }, + "example": { + "event_type": "payment.created" + } + }, + "TestWebhookSubscriptionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](entity:SubscriptionTestResult) field is not\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "subscription_test_result": { + "$ref": "#/components/schemas/SubscriptionTestResult", + "description": "The [SubscriptionTestResult](entity:SubscriptionTestResult)." + } + }, + "example": { + "subscription_test_result": { + "created_at": "2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746", + "id": "23eed5a9-2b12-403e-b212-7e2889aea0f6", + "payload": "{\"merchant_id\":\"1ZYMKZY1YFGBW\",\"type\":\"payment.created\",\"event_id\":\"23eed5a9-2b12-403e-b212-7e2889aea0f6\",\"created_at\":\"2022-01-11T00:06:48.322945116Z\",\"data\":{\"type\":\"payment\",\"id\":\"KkAkhdMsgzn59SM8A89WgKwekxLZY\",\"object\":{\"payment\":{\"amount_money\":{\"amount\":100,\"currency\":\"USD\"},\"approved_money\":{\"amount\":100,\"currency\":\"USD\"},\"capabilities\":[\"EDIT_TIP_AMOUNT\",\"EDIT_TIP_AMOUNT_UP\",\"EDIT_TIP_AMOUNT_DOWN\"],\"card_details\":{\"avs_status\":\"AVS_ACCEPTED\",\"card\":{\"bin\":\"540988\",\"card_brand\":\"MASTERCARD\",\"card_type\":\"CREDIT\",\"exp_month\":11,\"exp_year\":2022,\"fingerprint\":\"sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg\",\"last_4\":\"9029\",\"prepaid_type\":\"NOT_PREPAID\"},\"card_payment_timeline\":{\"authorized_at\":\"2020-11-22T21:16:51.198Z\"},\"cvv_status\":\"CVV_ACCEPTED\",\"entry_method\":\"KEYED\",\"statement_description\":\"SQ *DEFAULT TEST ACCOUNT\",\"status\":\"AUTHORIZED\"},\"created_at\":\"2020-11-22T21:16:51.086Z\",\"delay_action\":\"CANCEL\",\"delay_duration\":\"PT168H\",\"delayed_until\":\"2020-11-29T21:16:51.086Z\",\"id\":\"hYy9pRFVxpDsO1FB05SunFWUe9JZY\",\"location_id\":\"S8GWD5R9QB376\",\"order_id\":\"03O3USaPaAaFnI6kkwB1JxGgBsUZY\",\"receipt_number\":\"hYy9\",\"risk_evaluation\":{\"created_at\":\"2020-11-22T21:16:51.198Z\",\"risk_level\":\"NORMAL\"},\"source_type\":\"CARD\",\"status\":\"APPROVED\",\"total_money\":{\"amount\":100,\"currency\":\"USD\"},\"updated_at\":\"2020-11-22T21:16:51.198Z\",\"version_token\":\"FfQhQJf9r3VSQIgyWBk1oqhIwiznLwVwJbVVA0bdyEv6o\"}}}}", + "status_code": 404, + "updated_at": "2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746" + } + } + }, + "TimeRange": { + "type": "object", + "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", + "x-release-status": "PUBLIC", + "properties": { + "start_at": { + "type": "string", + "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", + "nullable": true + }, + "end_at": { + "type": "string", + "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", + "nullable": true + } + } + }, + "TipSettings": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "allow_tipping": { + "type": "boolean", + "description": "Indicates whether tipping is enabled for this checkout. Defaults to false.", + "nullable": true + }, + "separate_tip_screen": { + "type": "boolean", + "description": "Indicates whether tip options should be presented on the screen before presenting\nthe signature screen during card payment. Defaults to false.", + "nullable": true + }, + "custom_tip_field": { + "type": "boolean", + "description": "Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false.", + "nullable": true + }, + "tip_percentages": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "A list of tip percentages that should be presented during the checkout flow, specified as\nup to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25.", + "nullable": true + }, + "smart_tipping": { + "type": "boolean", + "description": "Enables the \"Smart Tip Amounts\" behavior.\nExact tipping options depend on the region in which the Square seller is active.\n\nFor payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00.\n\nFor payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%.\n\nIf set to true, the `tip_percentages` settings is ignored.\nDefaults to false.\n\nTo learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app).", + "nullable": true + } + } + }, + "Transaction": { + "type": "object", + "description": "Represents a transaction processed with Square, either with the\nConnect API or with Square Point of Sale.\n\nThe `tenders` field of this object lists all methods of payment used to pay in\nthe transaction.", + "x-release-status": "DEPRECATED", + "properties": { + "id": { + "type": "string", + "description": "The transaction's unique ID, issued by Square payments servers.", + "maxLength": 192 + }, + "location_id": { + "type": "string", + "description": "The ID of the transaction's associated location.", + "maxLength": 50, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The timestamp for when the transaction was created, in RFC 3339 format.", + "maxLength": 32 + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tender" + }, + "description": "The tenders used to pay in the transaction.", + "nullable": true + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refund" + }, + "description": "Refunds that have been applied to any tender in the transaction.", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "If the transaction was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set.", + "maxLength": 40, + "nullable": true + }, + "product": { + "$ref": "#/components/schemas/TransactionProduct", + "description": "The Square product that processed the transaction.\nSee [TransactionProduct](#type-transactionproduct) for possible values", + "nullable": true + }, + "client_id": { + "type": "string", + "description": "If the transaction was created in the Square Point of Sale app, this value\nis the ID generated for the transaction by Square Point of Sale.\n\nThis ID has no relationship to the transaction's canonical `id`, which is\ngenerated by Square's backend servers. This value is generated for bookkeeping\npurposes, in case the transaction cannot immediately be completed (for example,\nif the transaction is processed in offline mode).\n\nIt is not currently possible with the Connect API to perform a transaction\nlookup by this value.", + "maxLength": 192, + "nullable": true + }, + "shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "The shipping address provided in the request, if any.", + "nullable": true + }, + "order_id": { + "type": "string", + "description": "The order_id is an identifier for the order associated with this transaction, if any.", + "maxLength": 192, + "nullable": true + } + } + }, + "TransactionProduct": { + "type": "string", + "enum": [ + "REGISTER", + "EXTERNAL_API", + "BILLING", + "APPOINTMENTS", + "INVOICES", + "ONLINE_STORE", + "PAYROLL", + "OTHER" + ], + "x-enum-elements": [ + { + "name": "REGISTER", + "description": "Square Point of Sale." + }, + { + "name": "EXTERNAL_API", + "description": "The Square Connect API." + }, + { + "name": "BILLING", + "description": "A Square subscription for one of multiple products." + }, + { + "name": "APPOINTMENTS", + "description": "Square Appointments." + }, + { + "name": "INVOICES", + "description": "Square Invoices." + }, + { + "name": "ONLINE_STORE", + "description": "Square Online Store." + }, + { + "name": "PAYROLL", + "description": "Square Payroll." + }, + { + "name": "OTHER", + "description": "A Square product that does not match any other value." + } + ], + "description": "Indicates the Square product used to process a transaction.", + "x-release-status": "DEPRECATED" + }, + "TransactionType": { + "type": "string", + "enum": [ + "DEBIT", + "CREDIT" + ], + "x-enum-elements": [ + { + "name": "DEBIT", + "description": "" + }, + { + "name": "CREDIT", + "description": "" + } + ], + "description": "The transaction type used in the disputed payment.", + "x-release-status": "PUBLIC" + }, + "UnlinkCustomerFromGiftCardRequest": { + "type": "object", + "description": "A request to unlink a customer from a gift card.", + "x-release-status": "PUBLIC", + "x-params-example": "?gift_card_id=gftc:71ea002277a34f8a945e284b04822edb", + "required": [ + "customer_id" + ], + "properties": { + "customer_id": { + "type": "string", + "description": "The ID of the customer to unlink from the gift card.", + "minLength": 1, + "maxLength": 191 + } + }, + "example": { + "customer_id": "GKY0FZ3V717AH8Q2D821PNT2ZW" + } + }, + "UnlinkCustomerFromGiftCardResponse": { + "type": "object", + "description": "A response that contains the unlinked `GiftCard` object. If the request resulted in errors, \nthe response contains a set of `Error` objects.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "gift_card": { + "$ref": "#/components/schemas/GiftCard", + "description": "The gift card with the ID of the unlinked customer removed from the `customer_ids` field. \nIf no other customers are linked, the `customer_ids` field is also removed." + } + }, + "example": { + "gift_card": { + "balance_money": { + "amount": 2500, + "currency": "USD" + }, + "created_at": "2021-03-25T05:13:01Z", + "gan": "7783320005440920", + "gan_source": "SQUARE", + "id": "gftc:71ea002277a34f8a945e284b04822edb", + "state": "ACTIVE", + "type": "DIGITAL" + } + } + }, + "UpdateBookingCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition that contains the fields to update. Only the following fields can be updated:\n- `name`\n- `description`\n- `visibility`\n- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed\nselections are supported.\n\nFor more information, see\n[Updatable definition fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields).\n\nTo enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include the optional `version` field and specify the current version of the custom attribute definition." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + } + }, + "UpdateBookingCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The updated custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-11-16T15:27:30Z", + "description": "Update the description as desired.", + "key": "favoriteShampoo", + "name": "Favorite shampoo", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-11-16T15:39:38Z", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + }, + "errors": [] + } + }, + "UpdateBookingRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "booking" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique key to make this request an idempotent operation.", + "maxLength": 255, + "nullable": true + }, + "booking": { + "$ref": "#/components/schemas/Booking", + "description": "The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking." + } + } + }, + "UpdateBookingResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "booking": { + "$ref": "#/components/schemas/Booking", + "description": "The booking that was updated." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors that occurred during the request." + } + }, + "example": { + "booking": { + "address": { + "address_line_1": "1955 Broadway", + "address_line_2": "Suite 600", + "administrative_district_level_1": "CA", + "locality": "Oakland", + "postal_code": "94612" + }, + "appointment_segments": [ + { + "duration_minutes": 60, + "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC", + "service_variation_version": 1599775456731, + "team_member_id": "TMXUrsBWWcHTt79t" + } + ], + "created_at": "2020-10-28T15:47:41Z", + "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M", + "customer_note": "I would like to sit near the window please", + "id": "zkras0xv0xwswx", + "location_id": "LEQHH0YY8B42M", + "location_type": "CUSTOMER_LOCATION", + "seller_note": "", + "start_at": "2020-11-26T13:00:00Z", + "status": "ACCEPTED", + "updated_at": "2020-10-28T15:49:25Z", + "version": 2 + }, + "errors": [] + } + }, + "UpdateBreakTypeRequest": { + "type": "object", + "description": "A request to update a `BreakType`.", + "x-release-status": "PUBLIC", + "required": [ + "break_type" + ], + "properties": { + "break_type": { + "$ref": "#/components/schemas/BreakType", + "description": "The updated `BreakType`." + } + }, + "example": { + "break_type": { + "break_name": "Lunch", + "expected_duration": "PT50M", + "is_paid": true, + "location_id": "26M7H24AZ9N6R", + "version": 1 + } + } + }, + "UpdateBreakTypeResponse": { + "type": "object", + "description": "A response to a request to update a `BreakType`. The response contains\nthe requested `BreakType` objects and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "break_type": { + "$ref": "#/components/schemas/BreakType", + "description": "The response object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "break_type": { + "break_name": "Lunch", + "created_at": "2018-06-12T20:19:12Z", + "expected_duration": "PT50M", + "id": "Q6JSJS6D4DBCH", + "is_paid": true, + "location_id": "26M7H24AZ9N6R", + "updated_at": "2019-02-26T23:12:59Z", + "version": 2 + } + } + }, + "UpdateCatalogImageRequest": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "idempotency_key" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this UpdateCatalogImage request.\nKeys can be any valid string but must be unique for every UpdateCatalogImage request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 128 + } + }, + "example": { + "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86", + "image": { + "image_data": { + "caption": "A picture of a cup of coffee", + "name": "Coffee" + }, + "type": "IMAGE" + }, + "object_id": "ND6EA5AAJEO5WL3JNNIAQA32" + } + }, + "UpdateCatalogImageResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "image": { + "$ref": "#/components/schemas/CatalogObject", + "description": "The newly updated `CatalogImage` including a Square-generated\nURL for the encapsulated image file." + } + }, + "example": { + "image": { + "id": "L52QOQN2SW3M5QTF9JOCQKNB", + "image_data": { + "caption": "A picture of a cup of coffee", + "name": "Coffee", + "url": "https://..." + }, + "type": "IMAGE" + } + } + }, + "UpdateCustomerCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?key=favoritemovie", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition that contains the fields to update. This endpoint\nsupports sparse updates, so only new or changed fields need to be included in the request.\nOnly the following fields can be updated:\n\n- `name`\n- `description`\n- `visibility`\n- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed\nselections are supported.\n\nFor more information, see\n[Updatable definition fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields).\n\nTo enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) \ncontrol, include the optional `version` field and specify the current version of the custom attribute definition." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute_definition": { + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateCustomerCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The updated custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-04-26T15:27:30Z", + "description": "Update the description as desired.", + "key": "favoritemovie", + "name": "Favorite Movie", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-04-26T15:39:38Z", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateCustomerGroupRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](api-endpoint:CustomerGroups-UpdateCustomerGroup) endpoint.", + "x-release-status": "PUBLIC", + "required": [ + "group" + ], + "properties": { + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "The `CustomerGroup` object including all the updates you want to make." + } + }, + "example": { + "group": { + "name": "Loyal Customers" + } + } + }, + "UpdateCustomerGroupResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](api-endpoint:CustomerGroups-UpdateCustomerGroup) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "The successfully updated customer group." + } + }, + "example": { + "group": { + "created_at": "2020-04-13T21:54:57.863Z", + "id": "2TAT3CMH4Q0A9M87XJZED0WMR3", + "name": "Loyal Customers", + "updated_at": "2020-04-13T21:54:58Z" + } + } + }, + "UpdateCustomerRequest": { + "type": "object", + "description": "Defines the body parameters that can be included in a request to the\n`UpdateCustomer` endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "given_name": { + "type": "string", + "description": "The given name (that is, the first name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters.", + "nullable": true + }, + "family_name": { + "type": "string", + "description": "The family name (that is, the last name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters.", + "nullable": true + }, + "company_name": { + "type": "string", + "description": "A business name associated with the customer profile.\n\nThe maximum length for this value is 500 characters.", + "nullable": true + }, + "nickname": { + "type": "string", + "description": "A nickname for the customer profile.\n\nThe maximum length for this value is 100 characters.", + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address associated with the customer profile.\n\nThe maximum length for this value is 254 characters.", + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The physical address associated with the customer profile. Only new or changed fields are required in the request.\n\nFor maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address).\nThe `first_name` and `last_name` fields are ignored if they are present in the request.", + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number associated with the customer profile. The phone number must be valid and can contain\n9–16 digits, with an optional `+` prefix and country code. For more information, see\n[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).", + "nullable": true + }, + "reference_id": { + "type": "string", + "description": "An optional second ID used to associate the customer profile with an\nentity in another system.\n\nThe maximum length for this value is 100 characters.", + "nullable": true + }, + "note": { + "type": "string", + "description": "A custom note associated with the customer profile.", + "nullable": true + }, + "birthday": { + "type": "string", + "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,\nspecify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`\nformat, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "The current version of the customer profile.\n\nAs a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile).", + "format": "int64" + }, + "tax_ids": { + "$ref": "#/components/schemas/CustomerTaxIds", + "description": "The tax ID associated with the customer profile. This field is available only for customers of sellers\nin EU countries or the United Kingdom. For more information,\nsee [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "nullable": true + } + }, + "example": { + "email_address": "New.Amelia.Earhart@example.com", + "note": "updated customer note", + "phone_number": null, + "version": 2 + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.csharp", + "java": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.java", + "javascript": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.javascript", + "php": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.php", + "python": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.python", + "ruby": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.ruby" + } + }, + "UpdateCustomerResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomer](api-endpoint:Customers-UpdateCustomer) or\n[BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "customer": { + "$ref": "#/components/schemas/Customer", + "description": "The updated customer." + } + }, + "example": { + "customer": { + "address": { + "address_line_1": "500 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "created_at": "2016-03-23T20:21:54.859Z", + "creation_source": "THIRD_PARTY", + "email_address": "New.Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "note": "updated customer note", + "preferences": { + "email_unsubscribed": false + }, + "reference_id": "YOUR_REFERENCE_ID", + "updated_at": "2016-05-15T20:21:55Z", + "version": 3 + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/UpdateCustomer/UpdateCustomerResponse.csharp", + "java": "/sdk_samples/UpdateCustomer/UpdateCustomerResponse.java", + "javascript": "/sdk_samples/UpdateCustomer/UpdateCustomerResponse.javascript", + "php": "/sdk_samples/UpdateCustomer/UpdateCustomerResponse.php", + "python": "/sdk_samples/UpdateCustomer/UpdateCustomerResponse.python", + "ruby": "/sdk_samples/UpdateCustomer/UpdateCustomerResponse.ruby" + } + }, + "UpdateInvoiceRequest": { + "type": "object", + "description": "Describes a `UpdateInvoice` request.", + "x-release-status": "PUBLIC", + "required": [ + "invoice" + ], + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The invoice fields to add, change, or clear. Fields can be cleared using\nnull values or the `remove` field (for individual payment requests or reminders).\nThe current invoice `version` is also required. For more information, including requirements,\nlimitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices)." + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the `UpdateInvoice` request. If you do not\nprovide `idempotency_key` (or provide an empty string as the value), the endpoint\ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 128, + "nullable": true + }, + "fields_to_clear": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to clear. Although this field is currently supported, we\nrecommend using null values or the `remove` field when possible. For examples, see\n[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices).", + "nullable": true + } + }, + "example": { + "idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be", + "invoice": { + "payment_requests": [ + { + "reminders": null, + "tipping_enabled": false, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "version": 1 + } + } + }, + "UpdateInvoiceResponse": { + "type": "object", + "description": "Describes a `UpdateInvoice` response.", + "x-release-status": "PUBLIC", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice", + "description": "The updated invoice." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + } + }, + "example": { + "invoice": { + "accepted_payment_methods": { + "bank_account": false, + "buy_now_pay_later": false, + "card": true, + "cash_app_pay": false, + "square_gift_card": false + }, + "created_at": "2020-06-18T17:45:13Z", + "custom_fields": [ + { + "label": "Event Reference Number", + "placement": "ABOVE_LINE_ITEMS", + "value": "Ref. #1234" + }, + { + "label": "Terms of Service", + "placement": "BELOW_LINE_ITEMS", + "value": "The terms of service are..." + } + ], + "delivery_method": "EMAIL", + "description": "We appreciate your business!", + "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "invoice_number": "inv-100", + "location_id": "ES0RJRZYEC39A", + "next_payment_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "payment_requests": [ + { + "automatic_payment_source": "NONE", + "computed_amount_money": { + "amount": 10000, + "currency": "USD" + }, + "due_date": "2030-01-24", + "request_type": "BALANCE", + "tipping_enabled": false, + "total_completed_amount_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355" + } + ], + "primary_recipient": { + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", + "email_address": "Amelia.Earhart@example.com", + "family_name": "Earhart", + "given_name": "Amelia", + "phone_number": "1-212-555-4240" + }, + "sale_or_service_date": "2030-01-24", + "scheduled_at": "2030-01-13T10:00:00Z", + "status": "UNPAID", + "store_payment_method_enabled": false, + "timezone": "America/Los_Angeles", + "title": "Event Planning Services", + "updated_at": "2020-06-18T18:23:11Z", + "version": 2 + } + } + }, + "UpdateItemModifierListsRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "item_ids" + ], + "properties": { + "item_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the catalog items associated with the CatalogModifierList objects being updated." + }, + "modifier_lists_to_enable": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the CatalogModifierList objects to enable for the CatalogItem.\nAt least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified.", + "nullable": true + }, + "modifier_lists_to_disable": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the CatalogModifierList objects to disable for the CatalogItem.\nAt least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified.", + "nullable": true + } + }, + "example": { + "item_ids": [ + "H42BRLUJ5KTZTTMPVSLFAACQ", + "2JXOBJIHCWBQ4NZ3RIXQGJA6" + ], + "modifier_lists_to_disable": [ + "7WRC16CJZDVLSNDQ35PP6YAD" + ], + "modifier_lists_to_enable": [ + "H42BRLUJ5KTZTTMPVSLFAACQ", + "2JXOBJIHCWBQ4NZ3RIXQGJA6" + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.csharp", + "java": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.java", + "javascript": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.javascript", + "php": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.php", + "python": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.python", + "ruby": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.ruby" + } + }, + "UpdateItemModifierListsResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "updated_at": { + "type": "string", + "description": "The database [timestamp](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`." + } + }, + "example": { + "updated_at": "2016-11-16T22:25:24.878Z" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.csharp", + "java": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.java", + "javascript": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.javascript", + "php": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.php", + "python": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.python", + "ruby": "/sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.ruby" + } + }, + "UpdateItemTaxesRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "item_ids" + ], + "properties": { + "item_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IDs for the CatalogItems associated with the CatalogTax objects being updated.\nNo more than 1,000 IDs may be provided." + }, + "taxes_to_enable": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IDs of the CatalogTax objects to enable.\nAt least one of `taxes_to_enable` or `taxes_to_disable` must be specified.", + "nullable": true + }, + "taxes_to_disable": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IDs of the CatalogTax objects to disable.\nAt least one of `taxes_to_enable` or `taxes_to_disable` must be specified.", + "nullable": true + } + }, + "example": { + "item_ids": [ + "H42BRLUJ5KTZTTMPVSLFAACQ", + "2JXOBJIHCWBQ4NZ3RIXQGJA6" + ], + "taxes_to_disable": [ + "AQCEGCEBBQONINDOHRGZISEX" + ], + "taxes_to_enable": [ + "4WRCNHCJZDVLSNDQ35PP6YAD" + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.csharp", + "java": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.java", + "javascript": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.javascript", + "php": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.php", + "python": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.python", + "ruby": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.ruby" + } + }, + "UpdateItemTaxesResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "updated_at": { + "type": "string", + "description": "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`." + } + }, + "example": { + "updated_at": "2016-11-16T22:25:24.878Z" + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.csharp", + "java": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.java", + "javascript": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.javascript", + "php": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.php", + "python": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.python", + "ruby": "/sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.ruby" + } + }, + "UpdateJobRequest": { + "type": "object", + "description": "Represents an [UpdateJob](api-endpoint:Team-UpdateJob) request.", + "x-release-status": "BETA", + "required": [ + "job" + ], + "properties": { + "job": { + "$ref": "#/components/schemas/Job", + "description": "The job with the updated fields, either `title`, `is_tip_eligible`, or both. Only changed fields need\nto be included in the request. Optionally include `version` to enable optimistic concurrency control." + } + }, + "example": { + "job": { + "is_tip_eligible": true, + "title": "Cashier 1" + } + } + }, + "UpdateJobResponse": { + "type": "object", + "description": "Represents an [UpdateJob](api-endpoint:Team-UpdateJob) response. Either `job` or `errors`\nis present in the response.", + "x-release-status": "BETA", + "properties": { + "job": { + "$ref": "#/components/schemas/Job", + "description": "The updated job." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "job": { + "created_at": "2021-06-11T22:55:45Z", + "id": "1yJlHapkseYnNPETIU1B", + "is_tip_eligible": true, + "title": "Cashier 1", + "updated_at": "2021-06-13T12:55:45Z", + "version": 2 + } + } + }, + "UpdateLocationCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "x-params-example": "?key=bestseller", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition that contains the fields to update. This endpoint\nsupports sparse updates, so only new or changed fields need to be included in the request.\nOnly the following fields can be updated:\n- `name`\n- `description`\n- `visibility`\n- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed\nselections are supported.\n\nFor more information, see\n[Update a location custom attribute definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition).\nTo enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, specify the current version of the custom attribute definition. \nIf this is not important for your application, `version` can be set to -1." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute_definition": { + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateLocationCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The updated custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-12-02T19:06:36.559Z", + "description": "Update the description as desired.", + "key": "bestseller", + "name": "Bestseller", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2022-12-02T19:34:10.181Z", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateLocationRequest": { + "type": "object", + "description": "The request object for the [UpdateLocation](api-endpoint:Locations-UpdateLocation) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "location": { + "$ref": "#/components/schemas/Location", + "description": "The `Location` object with only the fields to update.", + "nullable": true + } + }, + "example": { + "location": { + "business_hours": { + "periods": [ + { + "day_of_week": "FRI", + "end_local_time": "18:00", + "start_local_time": "07:00" + }, + { + "day_of_week": "SAT", + "end_local_time": "18:00", + "start_local_time": "07:00" + }, + { + "day_of_week": "SUN", + "end_local_time": "15:00", + "start_local_time": "09:00" + } + ] + }, + "description": "Midtown Atlanta store - Open weekends" + } + } + }, + "UpdateLocationResponse": { + "type": "object", + "description": "The response object returned by the [UpdateLocation](api-endpoint:Locations-UpdateLocation) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information about errors encountered during the request." + }, + "location": { + "$ref": "#/components/schemas/Location", + "description": "The updated `Location` object." + } + }, + "example": { + "location": { + "address": { + "address_line_1": "1234 Peachtree St. NE", + "administrative_district_level_1": "GA", + "locality": "Atlanta", + "postal_code": "30309" + }, + "business_hours": { + "periods": [ + { + "day_of_week": "FRI", + "end_local_time": "18:00", + "start_local_time": "07:00" + }, + { + "day_of_week": "SAT", + "end_local_time": "18:00", + "start_local_time": "07:00" + }, + { + "day_of_week": "SUN", + "end_local_time": "15:00", + "start_local_time": "09:00" + } + ] + }, + "business_name": "Jet Fuel Coffee", + "capabilities": [ + "CREDIT_CARD_PROCESSING" + ], + "coordinates": { + "latitude": 33.7889, + "longitude": -84.3841 + }, + "country": "US", + "created_at": "2022-02-19T17:58:25Z", + "currency": "USD", + "description": "Midtown Atlanta store - Open weekends", + "id": "3Z4V4WHQK64X9", + "language_code": "en-US", + "mcc": "7299", + "merchant_id": "3MYCJG5GVYQ8Q", + "name": "Midtown", + "status": "ACTIVE", + "timezone": "America/New_York", + "type": "PHYSICAL" + } + } + }, + "UpdateLocationSettingsRequest": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "location_settings" + ], + "properties": { + "location_settings": { + "$ref": "#/components/schemas/CheckoutLocationSettings", + "description": "Describe your updates using the `location_settings` object. Make sure it contains only the fields that have changed." + } + } + }, + "UpdateLocationSettingsResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred when updating the location settings." + }, + "location_settings": { + "$ref": "#/components/schemas/CheckoutLocationSettings", + "description": "The updated location settings." + } + }, + "example": { + "location_settings": { + "branding": { + "button_color": "#00b23b", + "button_shape": "ROUNDED", + "header_type": "FRAMED_LOGO" + }, + "customer_notes_enabled": false, + "location_id": "LOCATION_ID_1", + "policies": [ + { + "description": "This is my Return Policy", + "title": "Return Policy", + "uid": "POLICY_ID_1" + }, + { + "description": "Items may be returned within 30 days of purchase.", + "title": "Return Policy", + "uid": "POLICY_ID_2" + } + ], + "tipping": { + "default_percent": 20, + "default_whole_amount_money": { + "amount": 100, + "currency": "USD" + }, + "percentages": [ + 15, + 20, + 25 + ], + "smart_tipping_enabled": true, + "whole_amounts": [ + { + "amount": 1000, + "currency": "USD" + }, + { + "amount": 1500, + "currency": "USD" + }, + { + "amount": 2000, + "currency": "USD" + } + ] + }, + "updated_at": "2022-06-16T22:25:35Z" + } + } + }, + "UpdateMerchantCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) request.", + "x-release-status": "BETA", + "x-params-example": "?key=alternative_seller_name", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition that contains the fields to update. This endpoint\nsupports sparse updates, so only new or changed fields need to be included in the request.\nOnly the following fields can be updated:\n- `name`\n- `description`\n- `visibility`\n- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed\nselections are supported.\nFor more information, see\n[Update a merchant custom attribute definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition).\nThe version field must match the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\nIf this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute_definition": { + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateMerchantCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The updated custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2023-05-05T19:06:36.559Z", + "description": "Update the description as desired.", + "key": "alternative_seller_name", + "name": "Alternative Merchant Name", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "updated_at": "2023-05-05T19:34:10.181Z", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateMerchantSettingsRequest": { + "type": "object", + "x-release-status": "BETA", + "required": [ + "merchant_settings" + ], + "properties": { + "merchant_settings": { + "$ref": "#/components/schemas/CheckoutMerchantSettings", + "description": "Describe your updates using the `merchant_settings` object. Make sure it contains only the fields that have changed." + } + } + }, + "UpdateMerchantSettingsResponse": { + "type": "object", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred when updating the merchant settings." + }, + "merchant_settings": { + "$ref": "#/components/schemas/CheckoutMerchantSettings", + "description": "The updated merchant settings." + } + }, + "example": { + "merchant_settings": { + "merchant_id": "MERCHANT_ID", + "payment_methods": { + "afterpay_clearpay": { + "enabled": true, + "item_eligibility_range": { + "max": { + "amount": 10000, + "currency": "USD" + }, + "min": { + "amount": 100, + "currency": "USD" + } + }, + "order_eligibility_range": { + "max": { + "amount": 10000, + "currency": "USD" + }, + "min": { + "amount": 100, + "currency": "USD" + } + } + }, + "apple_pay": { + "enabled": false + }, + "cash_app_pay": { + "enabled": true + }, + "google_pay": { + "enabled": true + } + }, + "updated_at": "2022-06-16T22:25:35Z" + } + } + }, + "UpdateOrderCustomAttributeDefinitionRequest": { + "type": "object", + "description": "Represents an update request for an order custom attribute definition.", + "x-release-status": "BETA", + "x-params-example": "?key=cover-count", + "required": [ + "custom_attribute_definition" + ], + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, \nso only new or changed fields need to be included in the request. For more information, see \n[Updatable definition fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields).\n\nTo enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include the optional `version` field and specify the current version of the custom attribute definition." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. \nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute_definition": { + "key": "cover-count", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + }, + "idempotency_key": "IDEMPOTENCY_KEY" + } + }, + "UpdateOrderCustomAttributeDefinitionResponse": { + "type": "object", + "description": "Represents a response from updating an order custom attribute definition.", + "x-release-status": "BETA", + "properties": { + "custom_attribute_definition": { + "$ref": "#/components/schemas/CustomAttributeDefinition", + "description": "The updated order custom attribute definition." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute_definition": { + "created_at": "2022-11-16T16:53:23.141Z", + "description": "The number of people seated at a table", + "key": "cover-count", + "name": "Cover count", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "updated_at": "2022-11-16T17:44:11.436Z", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpdateOrderRequest": { + "type": "object", + "description": "Defines the fields that are included in requests to the\n[UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.", + "x-release-status": "BETA", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.", + "nullable": true + }, + "fields_to_clear": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nfields to clear. For example, `line_items[uid].note`.\nFor more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields).", + "nullable": true + }, + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this update request.\n\nIf you are unsure whether a particular update was applied to an order successfully,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate updates to the order.\nThe latest order version is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 192, + "nullable": true + } + }, + "example": { + "fields_to_clear": [ + "discounts" + ], + "idempotency_key": "UNIQUE_STRING", + "order": { + "line_items": [ + { + "base_price_money": { + "amount": 200, + "currency": "USD" + }, + "name": "COOKIE", + "quantity": "2", + "uid": "cookie_uid" + } + ], + "version": 1 + } + } + }, + "UpdateOrderResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.", + "x-release-status": "BETA", + "properties": { + "order": { + "$ref": "#/components/schemas/Order", + "description": "The updated order." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "order": { + "created_at": "2019-08-23T18:26:18.243Z", + "id": "DREk7wJcyXNHqULq8JJ2iPAsluJZY", + "line_items": [ + { + "base_price_money": { + "amount": 500, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 500, + "currency": "USD" + }, + "name": "Small Coffee", + "quantity": "1", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 500, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "EuYkakhmu3ksHIds5Hiot", + "variation_total_price_money": { + "amount": 500, + "currency": "USD" + } + }, + { + "base_price_money": { + "amount": 200, + "currency": "USD" + }, + "gross_sales_money": { + "amount": 400, + "currency": "USD" + }, + "name": "COOKIE", + "quantity": "2", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 400, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "uid": "cookie_uid", + "variation_total_price_money": { + "amount": 400, + "currency": "USD" + } + } + ], + "location_id": "MXVQSVNDGN3C8", + "net_amounts": { + "discount_money": { + "amount": 0, + "currency": "USD" + }, + "service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "tax_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 900, + "currency": "USD" + } + }, + "source": { + "name": "Cookies" + }, + "state": "OPEN", + "total_discount_money": { + "amount": 0, + "currency": "USD" + }, + "total_money": { + "amount": 900, + "currency": "USD" + }, + "total_service_charge_money": { + "amount": 0, + "currency": "USD" + }, + "total_tax_money": { + "amount": 0, + "currency": "USD" + }, + "updated_at": "2019-08-23T18:33:47.523Z", + "version": 2 + } + } + }, + "UpdatePaymentLinkRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "payment_link" + ], + "properties": { + "payment_link": { + "$ref": "#/components/schemas/PaymentLink", + "description": "The `payment_link` object describing the updates to apply.\nFor more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link)." + } + }, + "example": { + "payment_link": { + "checkout_options": { + "ask_for_shipping_address": true + }, + "version": 1 + } + } + }, + "UpdatePaymentLinkResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred when updating the payment link." + }, + "payment_link": { + "$ref": "#/components/schemas/PaymentLink", + "description": "The updated payment link." + } + }, + "example": { + "payment_link": { + "checkout_options": { + "ask_for_shipping_address": true + }, + "created_at": "2022-04-26T00:15:15Z", + "id": "TY4BWEDJ6AI5MBIV", + "long_url": "https://checkout.square.site/EXAMPLE", + "order_id": "Qqc8ypQGvxVwc46Cch4zHTaJqc4F", + "payment_note": "test", + "updated_at": "2022-04-26T00:18:24Z", + "url": "https://square.link/u/EXAMPLE", + "version": 2 + } + } + }, + "UpdatePaymentRequest": { + "type": "object", + "description": "Describes a request to update a payment using\n[UpdatePayment](api-endpoint:Payments-UpdatePayment).", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key" + ], + "properties": { + "payment": { + "$ref": "#/components/schemas/Payment", + "description": "The updated `Payment` object.", + "nullable": true + }, + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies this `UpdatePayment` request. Keys can be any valid string\nbut must be unique for every `UpdatePayment` request.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 45 + } + }, + "example": { + "idempotency_key": "956f8b13-e4ec-45d6-85e8-d1d95ef0c5de", + "payment": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "tip_money": { + "amount": 100, + "currency": "USD" + }, + "version_token": "ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o" + } + } + }, + "UpdatePaymentResponse": { + "type": "object", + "description": "Defines the response returned by\n[UpdatePayment](api-endpoint:Payments-UpdatePayment).", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "payment": { + "$ref": "#/components/schemas/Payment", + "description": "The updated payment." + } + }, + "example": { + "payment": { + "amount_money": { + "amount": 1000, + "currency": "USD" + }, + "application_details": { + "application_id": "sq0ids-TcgftTEtKxJTRF1lCFJ9TA", + "square_product": "ECOMMERCE_API" + }, + "approved_money": { + "amount": 1000, + "currency": "USD" + }, + "capabilities": [ + "EDIT_AMOUNT_UP", + "EDIT_AMOUNT_DOWN", + "EDIT_TIP_AMOUNT_UP", + "EDIT_TIP_AMOUNT_DOWN" + ], + "card_details": { + "auth_result_code": "68aLBM", + "avs_status": "AVS_ACCEPTED", + "card": { + "bin": "411111", + "card_brand": "VISA", + "card_type": "DEBIT", + "exp_month": 11, + "exp_year": 2022, + "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", + "last_4": "1111", + "prepaid_type": "NOT_PREPAID" + }, + "card_payment_timeline": { + "authorized_at": "2021-10-13T20:26:44.364Z" + }, + "cvv_status": "CVV_ACCEPTED", + "entry_method": "ON_FILE", + "statement_description": "SQ *EXAMPLE TEST GOSQ.C", + "status": "AUTHORIZED" + }, + "created_at": "2021-10-13T20:26:44.191Z", + "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8", + "delay_action": "CANCEL", + "delay_duration": "PT168H", + "delayed_until": "2021-10-20T20:26:44.191Z", + "id": "1QjqpBVyrI9S4H9sTGDWU9JeiWdZY", + "location_id": "L88917AVBK2S5", + "note": "Example Note", + "order_id": "nUSN9TdxpiK3SrQg3wzmf6r8LP9YY", + "receipt_number": "1Qjq", + "risk_evaluation": { + "created_at": "2021-10-13T20:26:45.271Z", + "risk_level": "NORMAL" + }, + "source_type": "CARD", + "status": "APPROVED", + "tip_money": { + "amount": 100, + "currency": "USD" + }, + "total_money": { + "amount": 1100, + "currency": "USD" + }, + "updated_at": "2021-10-13T20:26:44.364Z", + "version_token": "rDrXnqiS7fJgexccgdpzmwqTiXui1aIKCp9EchZ7trE6o" + } + } + }, + "UpdateShiftRequest": { + "type": "object", + "description": "A request to update a `Shift` object.", + "x-release-status": "PUBLIC", + "required": [ + "shift" + ], + "properties": { + "shift": { + "$ref": "#/components/schemas/Shift", + "description": "The updated `Shift` object." + } + }, + "example": { + "shift": { + "breaks": [ + { + "break_type_id": "REGS1EQR1TPZ5", + "end_at": "2019-01-25T06:16:00-05:00", + "expected_duration": "PT5M", + "id": "X7GAQYVVRRG6P", + "is_paid": true, + "name": "Tea Break", + "start_at": "2019-01-25T06:11:00-05:00" + } + ], + "declared_cash_tip_money": { + "amount": 500, + "currency": "USD" + }, + "end_at": "2019-01-25T13:11:00-05:00", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "version": 1, + "wage": { + "hourly_rate": { + "amount": 1500, + "currency": "USD" + }, + "tip_eligible": true, + "title": "Bartender" + } + } + } + }, + "UpdateShiftResponse": { + "type": "object", + "description": "The response to a request to update a `Shift`. The response contains\nthe updated `Shift` object and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "shift": { + "$ref": "#/components/schemas/Shift", + "description": "The updated `Shift`." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "shift": { + "breaks": [ + { + "break_type_id": "REGS1EQR1TPZ5", + "end_at": "2019-01-25T06:16:00-05:00", + "expected_duration": "PT5M", + "id": "X7GAQYVVRRG6P", + "is_paid": true, + "name": "Tea Break", + "start_at": "2019-01-25T06:11:00-05:00" + } + ], + "created_at": "2019-02-28T00:39:02Z", + "declared_cash_tip_money": { + "amount": 500, + "currency": "USD" + }, + "employee_id": "ormj0jJJZ5OZIzxrZYJI", + "end_at": "2019-01-25T13:11:00-05:00", + "id": "K0YH4CV5462JB", + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "status": "CLOSED", + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "timezone": "America/New_York", + "updated_at": "2019-02-28T00:42:41Z", + "version": 2, + "wage": { + "hourly_rate": { + "amount": 1500, + "currency": "USD" + }, + "job_id": "dZtrPh5GSDGugyXGByesVp51", + "tip_eligible": true, + "title": "Bartender" + } + } + } + }, + "UpdateSubscriptionRequest": { + "type": "object", + "description": "Defines input parameters in a request to the \n[UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The subscription object containing the current version, and fields to update.\nUnset fields will be left at their current server values, and JSON `null` values will\nbe treated as a request to clear the relevant data.", + "nullable": true + } + }, + "example": { + "subscription": { + "canceled_date": null, + "card_id": "{NEW CARD ID}" + } + } + }, + "UpdateSubscriptionResponse": { + "type": "object", + "description": "Defines output parameters in a response from the\n[UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/Subscription", + "description": "The updated subscription." + } + }, + "example": { + "subscription": { + "card_id": "{NEW CARD ID}", + "charged_through_date": "2023-03-13", + "created_at": "2023-01-30T19:27:32Z", + "customer_id": "AM69AB81FT4479YH9HGWS1HZY8", + "id": "7217d8ca-1fee-4446-a9e5-8540b5d8c9bb", + "invoice_ids": [ + "inv:0-ChAPSfVYvNewckgf3x4iigN_ENMM", + "inv:0-ChBQaCCLfjcm9WEUBGxvuydJENMM" + ], + "location_id": "LPJKHYR7WFDKN", + "plan_variation_id": "XOUNEKCE6NSXQW5NTSQ73MMX", + "source": { + "name": "My Application" + }, + "start_date": "2023-01-30", + "status": "ACTIVE", + "timezone": "UTC", + "version": 3 + } + } + }, + "UpdateTeamMemberRequest": { + "type": "object", + "description": "Represents an update request for a `TeamMember` object.", + "x-release-status": "PUBLIC", + "properties": { + "team_member": { + "$ref": "#/components/schemas/TeamMember", + "description": "The team member fields to add, change, or clear. Fields can be cleared using a null value. To update\n`wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call\n[ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values.", + "nullable": true + } + }, + "example": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "YSGH2WBKG94QZ", + "GA2Y9HSJ8KRYT" + ] + }, + "email_address": "joe_doe@gmail.com", + "family_name": "Doe", + "given_name": "Joe", + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE", + "wage_setting": { + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 1200, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "pay_type": "HOURLY" + } + ] + } + } + } + }, + "UpdateTeamMemberResponse": { + "type": "object", + "description": "Represents a response from an update request containing the updated `TeamMember` object or error messages.", + "x-release-status": "PUBLIC", + "properties": { + "team_member": { + "$ref": "#/components/schemas/TeamMember", + "description": "The successfully updated `TeamMember` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "team_member": { + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": [ + "GA2Y9HSJ8KRYT", + "YSGH2WBKG94QZ" + ] + }, + "created_at": "2021-06-11T22:55:45Z", + "email_address": "joe_doe@example.com", + "family_name": "Doe", + "given_name": "Joe", + "id": "1yJlHapkseYnNPETIU1B", + "is_owner": false, + "phone_number": "+14159283333", + "reference_id": "reference_id_1", + "status": "ACTIVE", + "updated_at": "2021-06-15T17:38:05Z", + "wage_setting": { + "created_at": "2021-06-11T22:55:45Z", + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "hourly_rate": { + "amount": 1443, + "currency": "USD" + }, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 1200, + "currency": "USD" + }, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "1yJlHapkseYnNPETIU1B", + "updated_at": "2021-06-11T22:55:45Z", + "version": 1 + } + } + } + }, + "UpdateVendorRequest": { + "type": "object", + "description": "Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).", + "x-release-status": "BETA", + "required": [ + "vendor" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A client-supplied, universally unique identifier (UUID) for the\nrequest.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", + "maxLength": 128, + "nullable": true + }, + "vendor": { + "$ref": "#/components/schemas/Vendor", + "description": "The specified [Vendor](entity:Vendor) to be updated." + } + }, + "example": { + "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + "vendor": { + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Jack's Chicken Shack", + "status": "ACTIVE", + "version": 1 + } + } + }, + "UpdateVendorResponse": { + "type": "object", + "description": "Represents an output from a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).", + "x-release-status": "BETA", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Errors occurred when the request fails." + }, + "vendor": { + "$ref": "#/components/schemas/Vendor", + "description": "The [Vendor](entity:Vendor) that has been updated." + } + }, + "example": { + "vendor": { + "account_number": "4025391", + "address": { + "address_line_1": "505 Electric Ave", + "address_line_2": "Suite 600", + "administrative_district_level_1": "NY", + "country": "US", + "locality": "New York", + "postal_code": "10003" + }, + "contacts": [ + { + "email_address": "joe@joesfreshseafood.com", + "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", + "name": "Joe Burrow", + "ordinal": 0, + "phone_number": "1-212-555-4250" + } + ], + "created_at": "2022-03-16T10:21:54.859Z", + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Jack's Chicken Shack", + "status": "ACTIVE", + "updated_at": "2022-03-16T20:21:54.859Z", + "version": 2 + } + } + }, + "UpdateWageSettingRequest": { + "type": "object", + "description": "Represents an update request for the `WageSetting` object describing a `TeamMember`.", + "x-release-status": "PUBLIC", + "required": [ + "wage_setting" + ], + "properties": { + "wage_setting": { + "$ref": "#/components/schemas/WageSetting", + "description": "The complete `WageSetting` object. For all job assignments, specify one of the following:\n- `job_id` (recommended) - If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get a list of all jobs.\nRequires Square API version 2024-12-18 or later.\n- `job_title` - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job.\nThis value is ignored if `job_id` is also provided." + } + }, + "example": { + "wage_setting": { + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ] + } + } + }, + "UpdateWageSettingResponse": { + "type": "object", + "description": "Represents a response from an update request containing the updated `WageSetting` object\nor error messages.", + "x-release-status": "PUBLIC", + "properties": { + "wage_setting": { + "$ref": "#/components/schemas/WageSetting", + "description": "The successfully updated `WageSetting` object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "The errors that occurred during the request." + } + }, + "example": { + "wage_setting": { + "created_at": "2019-07-10T17:26:48+00:00", + "is_overtime_exempt": true, + "job_assignments": [ + { + "annual_rate": { + "amount": 3000000, + "currency": "USD" + }, + "hourly_rate": { + "amount": 1443, + "currency": "USD" + }, + "job_title": "Manager", + "pay_type": "SALARY", + "weekly_hours": 40 + }, + { + "hourly_rate": { + "amount": 2000, + "currency": "USD" + }, + "job_title": "Cashier", + "pay_type": "HOURLY" + } + ], + "team_member_id": "-3oZQKPKVk6gUXU_V5Qa", + "updated_at": "2020-06-11T23:12:04+00:00", + "version": 1 + } + } + }, + "UpdateWebhookSubscriptionRequest": { + "type": "object", + "description": "Updates a [Subscription](entity:WebhookSubscription).", + "x-release-status": "PUBLIC", + "properties": { + "subscription": { + "$ref": "#/components/schemas/WebhookSubscription", + "description": "The [Subscription](entity:WebhookSubscription) to update.", + "nullable": true + } + }, + "example": { + "subscription": { + "enabled": false, + "name": "Updated Example Webhook Subscription" + } + } + }, + "UpdateWebhookSubscriptionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "subscription": { + "$ref": "#/components/schemas/WebhookSubscription", + "description": "The updated [Subscription](entity:WebhookSubscription)." + } + }, + "example": { + "subscription": { + "api_version": "2021-12-15", + "created_at": "2022-01-10 23:29:48 +0000 UTC", + "enabled": false, + "event_types": [ + "payment.created", + "payment.updated" + ], + "id": "wbhk_b35f6b3145074cf9ad513610786c19d5", + "name": "Updated Example Webhook Subscription", + "notification_url": "https://example-webhook-url.com", + "updated_at": "2022-01-10 23:45:51 +0000 UTC" + } + } + }, + "UpdateWebhookSubscriptionSignatureKeyRequest": { + "type": "object", + "description": "Updates a [Subscription](entity:WebhookSubscription) by replacing the existing signature key with a new one.", + "x-release-status": "PUBLIC", + "properties": { + "idempotency_key": { + "type": "string", + "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request.", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "idempotency_key": "ed80ae6b-0654-473b-bbab-a39aee89a60d" + } + }, + "UpdateWebhookSubscriptionSignatureKeyResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not\npresent.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Information on errors encountered during the request." + }, + "signature_key": { + "type": "string", + "description": "The new Square-generated signature key used to validate the origin of the webhook event.", + "readOnly": true + } + }, + "example": { + "signature_key": "1k9bIJKCeTmSQwyagtNRLg" + } + }, + "UpdateWorkweekConfigRequest": { + "type": "object", + "description": "A request to update a `WorkweekConfig` object.", + "x-release-status": "PUBLIC", + "required": [ + "workweek_config" + ], + "properties": { + "workweek_config": { + "$ref": "#/components/schemas/WorkweekConfig", + "description": "The updated `WorkweekConfig` object." + } + }, + "example": { + "workweek_config": { + "start_of_day_local_time": "10:00", + "start_of_week": "MON", + "version": 10 + } + } + }, + "UpdateWorkweekConfigResponse": { + "type": "object", + "description": "The response to a request to update a `WorkweekConfig` object. The response contains\nthe updated `WorkweekConfig` object and might contain a set of `Error` objects if\nthe request resulted in errors.", + "x-release-status": "PUBLIC", + "properties": { + "workweek_config": { + "$ref": "#/components/schemas/WorkweekConfig", + "description": "The response object." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "workweek_config": { + "created_at": "2016-02-04T00:58:24Z", + "id": "FY4VCAQN700GM", + "start_of_day_local_time": "10:00", + "start_of_week": "MON", + "updated_at": "2019-02-28T01:04:35Z", + "version": 11 + } + } + }, + "UpsertBookingCustomAttributeRequest": { + "type": "object", + "description": "Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) request.", + "x-release-status": "PUBLIC", + "required": [ + "custom_attribute" + ], + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with the following fields:\n\n- `value`. This value must conform to the `schema` specified by the definition.\nFor more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types).\n\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol for an update operation, include this optional field and specify the current version\nof the custom attribute." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + } + }, + "UpsertBookingCustomAttributeResponse": { + "type": "object", + "description": "Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-11-16T15:50:27Z", + "key": "favoriteShampoo", + "updated_at": "2022-11-16T15:50:27Z", + "value": "Spring Fresh", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + }, + "errors": [] + } + }, + "UpsertCatalogObjectRequest": { + "type": "object", + "x-release-status": "PUBLIC", + "required": [ + "idempotency_key", + "object" + ], + "properties": { + "idempotency_key": { + "type": "string", + "description": "A value you specify that uniquely identifies this\nrequest among all your requests. A common way to create\na valid idempotency key is to use a Universally unique\nidentifier (UUID).\n\nIf you're unsure whether a particular request was successful,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate objects.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", + "minLength": 1, + "maxLength": 128 + }, + "object": { + "$ref": "#/components/schemas/CatalogObject", + "description": "A CatalogObject to be created or updated.\n\n- For updates, the object must be active (the `is_deleted` field is not `true`).\n- For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID." + } + }, + "example": { + "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae", + "object": { + "id": "#Cocoa", + "item_data": { + "abbreviation": "Ch", + "description_html": "\u003cp\u003e\u003cstrong\u003eHot\u003c/strong\u003e Chocolate\u003c/p\u003e", + "name": "Cocoa", + "variations": [ + { + "id": "#Small", + "item_variation_data": { + "item_id": "#Cocoa", + "name": "Small", + "pricing_type": "VARIABLE_PRICING" + }, + "type": "ITEM_VARIATION" + }, + { + "id": "#Large", + "item_variation_data": { + "item_id": "#Cocoa", + "name": "Large", + "price_money": { + "amount": 400, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING" + }, + "type": "ITEM_VARIATION" + } + ] + }, + "type": "ITEM" + } + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.csharp", + "java": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.java", + "javascript": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.javascript", + "php": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.php", + "python": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.python", + "ruby": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.ruby" + } + }, + "UpsertCatalogObjectResponse": { + "type": "object", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "catalog_object": { + "$ref": "#/components/schemas/CatalogObject", + "description": "The successfully created or updated CatalogObject." + }, + "id_mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CatalogIdMapping" + }, + "description": "The mapping between client and server IDs for this upsert." + } + }, + "example": { + "catalog_object": { + "id": "R2TA2FOBUGCJZNIWJSOSNAI4", + "is_deleted": false, + "item_data": { + "abbreviation": "Ch", + "description": "Hot Chocolate", + "description_html": "\u003cp\u003e\u003cstrong\u003eHot\u003c/strong\u003e Chocolate\u003c/p\u003e", + "description_plaintext": "Hot Chocolate", + "name": "Cocoa", + "product_type": "REGULAR", + "variations": [ + { + "id": "QRT53UP4LITLWGOGBZCUWP63", + "is_deleted": false, + "item_variation_data": { + "item_id": "R2TA2FOBUGCJZNIWJSOSNAI4", + "name": "Small", + "ordinal": 0, + "pricing_type": "VARIABLE_PRICING", + "stockable": true + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2021-06-14T15:51:39.021Z", + "version": 1623685899021 + }, + { + "id": "NS77DKEIQ3AEQTCP727DSA7U", + "is_deleted": false, + "item_variation_data": { + "item_id": "R2TA2FOBUGCJZNIWJSOSNAI4", + "name": "Large", + "ordinal": 1, + "price_money": { + "amount": 400, + "currency": "USD" + }, + "pricing_type": "FIXED_PRICING", + "stockable": true + }, + "present_at_all_locations": true, + "type": "ITEM_VARIATION", + "updated_at": "2021-06-14T15:51:39.021Z", + "version": 1623685899021 + } + ] + }, + "present_at_all_locations": true, + "type": "ITEM", + "updated_at": "2021-06-14T15:51:39.021Z", + "version": 1623685899021 + }, + "id_mappings": [ + { + "client_object_id": "#Cocoa", + "object_id": "R2TA2FOBUGCJZNIWJSOSNAI4" + }, + { + "client_object_id": "#Small", + "object_id": "QRT53UP4LITLWGOGBZCUWP63" + }, + { + "client_object_id": "#Large", + "object_id": "NS77DKEIQ3AEQTCP727DSA7U" + } + ] + }, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.csharp", + "java": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.java", + "javascript": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.javascript", + "php": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.php", + "python": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.python", + "ruby": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.ruby" + } + }, + "UpsertCustomerCustomAttributeRequest": { + "type": "object", + "description": "Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) request.", + "x-release-status": "PUBLIC", + "x-params-example": "?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR\u0026key=favoritemovie", + "required": [ + "custom_attribute" + ], + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with the following fields:\n\n- `value`. This value must conform to the `schema` specified by the definition. \nFor more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types).\n\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol for an update operation, include this optional field and specify the current version\nof the custom attribute." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute": { + "value": "Dune" + } + } + }, + "UpsertCustomerCustomAttributeResponse": { + "type": "object", + "description": "Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "PUBLIC", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-04-26T15:50:27Z", + "key": "favoritemovie", + "updated_at": "2022-04-26T15:50:27Z", + "value": "Dune", + "version": 1, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpsertLocationCustomAttributeRequest": { + "type": "object", + "description": "Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) request.", + "x-release-status": "BETA", + "x-params-example": "?location_id=L0TBCBTB7P8RQ\u0026key=bestseller", + "required": [ + "custom_attribute" + ], + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with the following fields:\n- `value`. This value must conform to the `schema` specified by the definition.\nFor more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol for an update operation, include the current version of the custom attribute.\nIf this is not important for your application, version can be set to -1." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute": { + "value": "hot cocoa" + } + } + }, + "UpsertLocationCustomAttributeResponse": { + "type": "object", + "description": "Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2023-01-09T19:02:58.647Z", + "key": "bestseller", + "updated_at": "2023-01-09T19:21:04.551Z", + "value": "hot cocoa", + "version": 2, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "UpsertMerchantCustomAttributeRequest": { + "type": "object", + "description": "Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) request.", + "x-release-status": "BETA", + "x-params-example": "?merchant_id=DM7VKY8Q63GNP\u0026key=alternative_seller_name", + "required": [ + "custom_attribute" + ], + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with the following fields:\n- `value`. This value must conform to the `schema` specified by the definition.\nFor more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).\n- The version field must match the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\nIf this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute": { + "value": "Ultimate Sneaker Store" + } + } + }, + "UpsertMerchantCustomAttributeResponse": { + "type": "object", + "description": "Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "x-release-status": "BETA", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The new or updated custom attribute." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2023-05-06T19:02:58.647Z", + "key": "alternative_seller_name", + "updated_at": "2023-05-06T19:21:04.551Z", + "value": "Ultimate Sneaker Store", + "version": 2, + "visibility": "VISIBILITY_READ_ONLY" + } + } + }, + "UpsertOrderCustomAttributeRequest": { + "type": "object", + "description": "Represents an upsert request for an order custom attribute.", + "x-release-status": "BETA", + "required": [ + "custom_attribute" + ], + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The custom attribute to create or update, with the following fields:\n\n- `value`. This value must conform to the `schema` specified by the definition. \nFor more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types).\n\n- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute." + }, + "idempotency_key": { + "type": "string", + "description": "A unique identifier for this request, used to ensure idempotency. \nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", + "minLength": 1, + "maxLength": 45, + "nullable": true + } + }, + "example": { + "custom_attribute": { + "key": "table-number", + "value": "42", + "version": 1 + } + } + }, + "UpsertOrderCustomAttributeResponse": { + "type": "object", + "description": "Represents a response from upserting order custom attribute definitions.", + "x-release-status": "BETA", + "properties": { + "custom_attribute": { + "$ref": "#/components/schemas/CustomAttribute", + "description": "The order custom attribute that was created or modified." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": { + "custom_attribute": { + "created_at": "2022-10-06T20:41:22.673Z", + "key": "table-number", + "updated_at": "2022-10-06T20:41:22.673Z", + "value": "42", + "version": 1, + "visibility": "VISIBILITY_READ_WRITE_VALUES" + } + } + }, + "UpsertSnippetRequest": { + "type": "object", + "description": "Represents an `UpsertSnippet` request.", + "x-release-status": "PUBLIC", + "required": [ + "snippet" + ], + "properties": { + "snippet": { + "$ref": "#/components/schemas/Snippet", + "description": "The snippet for the site." + } + }, + "example": { + "snippet": { + "content": "\u003cscript\u003evar js = 1;\u003c/script\u003e" + } + } + }, + "UpsertSnippetResponse": { + "type": "object", + "description": "Represents an `UpsertSnippet` response. The response can include either `snippet` or `errors`.", + "x-release-status": "PUBLIC", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + }, + "snippet": { + "$ref": "#/components/schemas/Snippet", + "description": "The new or updated snippet." + } + }, + "example": { + "snippet": { + "content": "\u003cscript\u003evar js = 1;\u003c/script\u003e", + "created_at": "2021-03-11T25:40:09.000000Z", + "id": "snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7", + "site_id": "site_278075276488921835", + "updated_at": "2021-03-11T25:40:09.000000Z" + } + } + }, + "V1Device": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": { + "id": { + "type": "string", + "description": "The device's Square-issued ID." + }, + "name": { + "type": "string", + "description": "The device's merchant-specified name.", + "nullable": true + } + } + }, + "V1ListOrdersRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "properties": { + "order": { + "$ref": "#/components/schemas/SortOrder", + "description": "The order in which payments are listed in the response.\nSee [SortOrder](#type-sortorder) for possible values", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "The maximum number of payments to return in a single response. This value cannot exceed 200.", + "nullable": true + }, + "batch_token": { + "type": "string", + "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.", + "nullable": true + } + } + }, + "V1ListOrdersResponse": { + "type": "object", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/V1Order" + } + } + } + }, + "V1Money": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": { + "amount": { + "type": "integer", + "description": "Amount in the lowest denominated value of this Currency. E.g. in USD\nthese are cents, in JPY they are Yen (which do not have a 'cent' concept).", + "nullable": true + }, + "currency_code": { + "$ref": "#/components/schemas/Currency", + "description": "\nSee [Currency](#type-currency) for possible values", + "nullable": true + } + } + }, + "V1Order": { + "type": "object", + "description": "V1Order", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request.", + "nullable": true + }, + "id": { + "type": "string", + "description": "The order's unique identifier." + }, + "buyer_email": { + "type": "string", + "description": "The email address of the order's buyer.", + "nullable": true + }, + "recipient_name": { + "type": "string", + "description": "The name of the order's buyer.", + "nullable": true + }, + "recipient_phone_number": { + "type": "string", + "description": "The phone number to use for the order's delivery.", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/V1OrderState", + "description": "Whether the tax is an ADDITIVE tax or an INCLUSIVE tax.\nSee [V1OrderState](#type-v1orderstate) for possible values", + "nullable": true + }, + "shipping_address": { + "$ref": "#/components/schemas/Address", + "description": "The address to ship the order to.", + "nullable": true + }, + "subtotal_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The amount of all items purchased in the order, before taxes and shipping.", + "nullable": true + }, + "total_shipping_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The shipping cost for the order.", + "nullable": true + }, + "total_tax_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The total of all taxes applied to the order.", + "nullable": true + }, + "total_price_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The total cost of the order.", + "nullable": true + }, + "total_discount_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The total of all discounts applied to the order.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time when the order was created, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "description": "The time when the order was last modified, in ISO 8601 format." + }, + "expires_at": { + "type": "string", + "description": "The time when the order expires if no action is taken, in ISO 8601 format.", + "nullable": true + }, + "payment_id": { + "type": "string", + "description": "The unique identifier of the payment associated with the order.", + "nullable": true + }, + "buyer_note": { + "type": "string", + "description": "A note provided by the buyer when the order was created, if any.", + "nullable": true + }, + "completed_note": { + "type": "string", + "description": "A note provided by the merchant when the order's state was set to COMPLETED, if any", + "nullable": true + }, + "refunded_note": { + "type": "string", + "description": "A note provided by the merchant when the order's state was set to REFUNDED, if any.", + "nullable": true + }, + "canceled_note": { + "type": "string", + "description": "A note provided by the merchant when the order's state was set to CANCELED, if any.", + "nullable": true + }, + "tender": { + "$ref": "#/components/schemas/V1Tender", + "description": "The tender used to pay for the order.", + "nullable": true + }, + "order_history": { + "type": "array", + "items": { + "$ref": "#/components/schemas/V1OrderHistoryEntry" + }, + "description": "The history of actions associated with the order.", + "nullable": true + }, + "promo_code": { + "type": "string", + "description": "The promo code provided by the buyer, if any.", + "nullable": true + }, + "btc_receive_address": { + "type": "string", + "description": "For Bitcoin transactions, the address that the buyer sent Bitcoin to.", + "nullable": true + }, + "btc_price_satoshi": { + "type": "number", + "description": "For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).", + "nullable": true + } + } + }, + "V1OrderHistoryEntry": { + "type": "object", + "description": "V1OrderHistoryEntry", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "properties": { + "action": { + "$ref": "#/components/schemas/V1OrderHistoryEntryAction", + "description": "The type of action performed on the order.\nSee [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time when the action was performed, in ISO 8601 format." + } + } + }, + "V1OrderHistoryEntryAction": { + "type": "string", + "enum": [ + "ORDER_PLACED", + "DECLINED", + "PAYMENT_RECEIVED", + "CANCELED", + "COMPLETED", + "REFUNDED", + "EXPIRED" + ], + "x-enum-elements": [ + { + "name": "ORDER_PLACED", + "description": "" + }, + { + "name": "DECLINED", + "description": "" + }, + { + "name": "PAYMENT_RECEIVED", + "description": "" + }, + { + "name": "CANCELED", + "description": "" + }, + { + "name": "COMPLETED", + "description": "" + }, + { + "name": "REFUNDED", + "description": "" + }, + { + "name": "EXPIRED", + "description": "" + } + ], + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY" + }, + "V1OrderState": { + "type": "string", + "enum": [ + "PENDING", + "OPEN", + "COMPLETED", + "CANCELED", + "REFUNDED", + "REJECTED" + ], + "x-enum-elements": [ + { + "name": "PENDING", + "description": "" + }, + { + "name": "OPEN", + "description": "" + }, + { + "name": "COMPLETED", + "description": "" + }, + { + "name": "CANCELED", + "description": "" + }, + { + "name": "REFUNDED", + "description": "" + }, + { + "name": "REJECTED", + "description": "" + } + ], + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY" + }, + "V1PhoneNumber": { + "type": "object", + "description": "Represents a phone number.", + "x-release-status": "DEPRECATED", + "required": [ + "calling_code", + "number" + ], + "properties": { + "calling_code": { + "type": "string", + "description": "The phone number's international calling code. For US phone numbers, this value is +1." + }, + "number": { + "type": "string", + "description": "The phone number." + } + } + }, + "V1RetrieveOrderRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "properties": {} + }, + "V1Tender": { + "type": "object", + "description": "A tender represents a discrete monetary exchange. Square represents this\nexchange as a money object with a specific currency and amount, where the\namount is given in the smallest denomination of the given currency.\n\nSquare POS can accept more than one form of tender for a single payment (such\nas by splitting a bill between a credit card and a gift card). The `tender`\nfield of the Payment object lists all forms of tender used for the payment.\n\nSplit tender payments behave slightly differently from single tender payments:\n\nThe receipt_url for a split tender corresponds only to the first tender listed\nin the tender field. To get the receipt URLs for the remaining tenders, use\nthe receipt_url fields of the corresponding Tender objects.\n\n*A note on gift cards**: when a customer purchases a Square gift card from a\nmerchant, the merchant receives the full amount of the gift card in the\nassociated payment.\n\nWhen that gift card is used as a tender, the balance of the gift card is\nreduced and the merchant receives no funds. A `Tender` object with a type of\n`SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the\nassociated payment.", + "x-release-status": "DEPRECATED", + "properties": { + "id": { + "type": "string", + "description": "The tender's unique ID." + }, + "type": { + "$ref": "#/components/schemas/V1TenderType", + "description": "The type of tender.\nSee [V1TenderType](#type-v1tendertype) for possible values", + "nullable": true + }, + "name": { + "type": "string", + "description": "A human-readable description of the tender.", + "nullable": true + }, + "employee_id": { + "type": "string", + "description": "The ID of the employee that processed the tender.", + "nullable": true + }, + "receipt_url": { + "type": "string", + "description": "The URL of the receipt for the tender.", + "nullable": true + }, + "card_brand": { + "$ref": "#/components/schemas/V1TenderCardBrand", + "description": "The brand of credit card provided.\nSee [V1TenderCardBrand](#type-v1tendercardbrand) for possible values", + "nullable": true + }, + "pan_suffix": { + "type": "string", + "description": "The last four digits of the provided credit card's account number.", + "nullable": true + }, + "entry_method": { + "$ref": "#/components/schemas/V1TenderEntryMethod", + "description": "The tender's unique ID.\nSee [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values", + "nullable": true + }, + "payment_note": { + "type": "string", + "description": "Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.", + "nullable": true + }, + "total_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The total amount of money provided in this form of tender.", + "nullable": true + }, + "tendered_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The amount of total_money applied to the payment.", + "nullable": true + }, + "tendered_at": { + "type": "string", + "description": "The time when the tender was created, in ISO 8601 format.", + "nullable": true + }, + "settled_at": { + "type": "string", + "description": "The time when the tender was settled, in ISO 8601 format.", + "nullable": true + }, + "change_back_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The amount of total_money returned to the buyer as change.", + "nullable": true + }, + "refunded_money": { + "$ref": "#/components/schemas/V1Money", + "description": "The total of all refunds applied to this tender. This amount is always negative or zero.", + "nullable": true + }, + "is_exchange": { + "type": "boolean", + "description": "Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange.", + "nullable": true + } + } + }, + "V1TenderCardBrand": { + "type": "string", + "enum": [ + "OTHER_BRAND", + "VISA", + "MASTER_CARD", + "AMERICAN_EXPRESS", + "DISCOVER", + "DISCOVER_DINERS", + "JCB", + "CHINA_UNIONPAY", + "SQUARE_GIFT_CARD" + ], + "x-enum-elements": [ + { + "name": "OTHER_BRAND", + "description": "" + }, + { + "name": "VISA", + "description": "" + }, + { + "name": "MASTER_CARD", + "description": "" + }, + { + "name": "AMERICAN_EXPRESS", + "description": "" + }, + { + "name": "DISCOVER", + "description": "" + }, + { + "name": "DISCOVER_DINERS", + "description": "" + }, + { + "name": "JCB", + "description": "" + }, + { + "name": "CHINA_UNIONPAY", + "description": "" + }, + { + "name": "SQUARE_GIFT_CARD", + "description": "" + } + ], + "description": "The brand of a credit card.", + "x-release-status": "DEPRECATED" + }, + "V1TenderEntryMethod": { + "type": "string", + "enum": [ + "MANUAL", + "SCANNED", + "SQUARE_CASH", + "SQUARE_WALLET", + "SWIPED", + "WEB_FORM", + "OTHER" + ], + "x-enum-elements": [ + { + "name": "MANUAL", + "description": "" + }, + { + "name": "SCANNED", + "description": "" + }, + { + "name": "SQUARE_CASH", + "description": "" + }, + { + "name": "SQUARE_WALLET", + "description": "" + }, + { + "name": "SWIPED", + "description": "" + }, + { + "name": "WEB_FORM", + "description": "" + }, + { + "name": "OTHER", + "description": "" + } + ], + "x-release-status": "DEPRECATED" + }, + "V1TenderType": { + "type": "string", + "enum": [ + "CREDIT_CARD", + "CASH", + "THIRD_PARTY_CARD", + "NO_SALE", + "SQUARE_WALLET", + "SQUARE_GIFT_CARD", + "UNKNOWN", + "OTHER" + ], + "x-enum-elements": [ + { + "name": "CREDIT_CARD", + "description": "" + }, + { + "name": "CASH", + "description": "" + }, + { + "name": "THIRD_PARTY_CARD", + "description": "" + }, + { + "name": "NO_SALE", + "description": "" + }, + { + "name": "SQUARE_WALLET", + "description": "" + }, + { + "name": "SQUARE_GIFT_CARD", + "description": "" + }, + { + "name": "UNKNOWN", + "description": "" + }, + { + "name": "OTHER", + "description": "" + } + ], + "x-release-status": "DEPRECATED" + }, + "V1UpdateOrderRequest": { + "type": "object", + "description": "V1UpdateOrderRequest", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "required": [ + "action" + ], + "properties": { + "action": { + "$ref": "#/components/schemas/V1UpdateOrderRequestAction", + "description": "The action to perform on the order (COMPLETE, CANCEL, or REFUND).\nSee [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values" + }, + "shipped_tracking_number": { + "type": "string", + "description": "The tracking number of the shipment associated with the order. Only valid if action is COMPLETE.", + "nullable": true + }, + "completed_note": { + "type": "string", + "description": "A merchant-specified note about the completion of the order. Only valid if action is COMPLETE.", + "nullable": true + }, + "refunded_note": { + "type": "string", + "description": "A merchant-specified note about the refunding of the order. Only valid if action is REFUND.", + "nullable": true + }, + "canceled_note": { + "type": "string", + "description": "A merchant-specified note about the canceling of the order. Only valid if action is CANCEL.", + "nullable": true + } + } + }, + "V1UpdateOrderRequestAction": { + "type": "string", + "enum": [ + "COMPLETE", + "CANCEL", + "REFUND" + ], + "x-enum-elements": [ + { + "name": "COMPLETE", + "description": "" + }, + { + "name": "CANCEL", + "description": "" + }, + { + "name": "REFUND", + "description": "" + } + ], + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY" + }, + "Vendor": { + "type": "object", + "description": "Represents a supplier to a seller.", + "x-release-status": "BETA", + "properties": { + "id": { + "type": "string", + "description": "A unique Square-generated ID for the [Vendor](entity:Vendor).\nThis field is required when attempting to update a [Vendor](entity:Vendor).", + "maxLength": 100 + }, + "created_at": { + "type": "string", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was created.", + "maxLength": 34, + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was last updated.", + "maxLength": 34, + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the [Vendor](entity:Vendor).\nThis field is required when attempting to create or update a [Vendor](entity:Vendor).", + "maxLength": 100, + "nullable": true + }, + "address": { + "$ref": "#/components/schemas/Address", + "description": "The address of the [Vendor](entity:Vendor).", + "nullable": true + }, + "contacts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VendorContact" + }, + "description": "The contacts of the [Vendor](entity:Vendor).", + "nullable": true + }, + "account_number": { + "type": "string", + "description": "The account number of the [Vendor](entity:Vendor).", + "maxLength": 100, + "nullable": true + }, + "note": { + "type": "string", + "description": "A note detailing information about the [Vendor](entity:Vendor).", + "maxLength": 4096, + "nullable": true + }, + "version": { + "type": "integer", + "description": "The version of the [Vendor](entity:Vendor)." + }, + "status": { + "$ref": "#/components/schemas/VendorStatus", + "description": "The status of the [Vendor](entity:Vendor).\nSee [Status](#type-status) for possible values", + "nullable": true + } + } + }, + "VendorContact": { + "type": "object", + "description": "Represents a contact of a [Vendor](entity:Vendor).", + "x-release-status": "BETA", + "required": [ + "ordinal" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique Square-generated ID for the [VendorContact](entity:VendorContact).\nThis field is required when attempting to update a [VendorContact](entity:VendorContact).", + "maxLength": 100 + }, + "name": { + "type": "string", + "description": "The name of the [VendorContact](entity:VendorContact).\nThis field is required when attempting to create a [Vendor](entity:Vendor).", + "maxLength": 255, + "nullable": true + }, + "email_address": { + "type": "string", + "description": "The email address of the [VendorContact](entity:VendorContact).", + "maxLength": 255, + "nullable": true + }, + "phone_number": { + "type": "string", + "description": "The phone number of the [VendorContact](entity:VendorContact).", + "maxLength": 255, + "nullable": true + }, + "removed": { + "type": "boolean", + "description": "The state of the [VendorContact](entity:VendorContact).", + "nullable": true + }, + "ordinal": { + "type": "integer", + "description": "The ordinal of the [VendorContact](entity:VendorContact)." + } + } + }, + "VendorStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-enum-elements": [ + { + "name": "ACTIVE", + "description": "Vendor is active and can receive purchase orders." + }, + { + "name": "INACTIVE", + "description": "Vendor is inactive and cannot receive purchase orders." + } + ], + "description": "The status of the [Vendor](entity:Vendor),\nwhether a [Vendor](entity:Vendor) is active or inactive.", + "x-release-status": "BETA" + }, + "VisibilityFilter": { + "type": "string", + "enum": [ + "ALL", + "READ", + "READ_WRITE" + ], + "x-enum-elements": [ + { + "name": "ALL", + "description": "All custom attributes or custom attribute definitions." + }, + { + "name": "READ", + "description": "All custom attributes or custom attribute definitions with the `visibility` field set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." + }, + { + "name": "READ_WRITE", + "description": "All custom attributes or custom attribute definitions with the `visibility` field set to `VISIBILITY_READ_WRITE_VALUES`." + } + ], + "description": "Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.", + "x-release-status": "PUBLIC" + }, + "VoidTransactionRequest": { + "type": "object", + "x-release-status": "DEPRECATED", + "properties": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/VoidTransaction/VoidTransactionRequest.csharp", + "java": "/sdk_samples/VoidTransaction/VoidTransactionRequest.java", + "javascript": "/sdk_samples/VoidTransaction/VoidTransactionRequest.javascript", + "php": "/sdk_samples/VoidTransaction/VoidTransactionRequest.php", + "python": "/sdk_samples/VoidTransaction/VoidTransactionRequest.python", + "ruby": "/sdk_samples/VoidTransaction/VoidTransactionRequest.ruby" + } + }, + "VoidTransactionResponse": { + "type": "object", + "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint.", + "x-release-status": "DEPRECATED", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "Any errors that occurred during the request." + } + }, + "example": {}, + "x-sq-sdk-sample-code": { + "csharp": "/sdk_samples/VoidTransaction/VoidTransactionResponse.csharp", + "java": "/sdk_samples/VoidTransaction/VoidTransactionResponse.java", + "javascript": "/sdk_samples/VoidTransaction/VoidTransactionResponse.javascript", + "php": "/sdk_samples/VoidTransaction/VoidTransactionResponse.php", + "python": "/sdk_samples/VoidTransaction/VoidTransactionResponse.python", + "ruby": "/sdk_samples/VoidTransaction/VoidTransactionResponse.ruby" + } + }, + "WageSetting": { + "type": "object", + "description": "Represents information about the overtime exemption status, job assignments, and compensation\nfor a [team member](entity:TeamMember).", + "x-release-status": "PUBLIC", + "properties": { + "team_member_id": { + "type": "string", + "description": "The ID of the team member associated with the wage setting.", + "nullable": true + }, + "job_assignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobAssignment" + }, + "description": "**Required** The ordered list of jobs that the team member is assigned to.\nThe first job assignment is considered the team member's primary job.", + "nullable": true + }, + "is_overtime_exempt": { + "type": "boolean", + "description": "Whether the team member is exempt from the overtime rules of the seller's country.", + "nullable": true + }, + "version": { + "type": "integer", + "description": "**Read only** Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write, potentially overwriting data from another write. For more information,\nsee [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)." + }, + "created_at": { + "type": "string", + "description": "The timestamp when the wage setting was created, in RFC 3339 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp when the wage setting was last updated, in RFC 3339 format.", + "readOnly": true + } + } + }, + "WebhookSubscription": { + "type": "object", + "description": "Represents the details of a webhook subscription, including notification URL,\nevent types, and signature key.", + "x-release-status": "PUBLIC", + "properties": { + "id": { + "type": "string", + "description": "A Square-generated unique ID for the subscription.", + "maxLength": 64, + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of this subscription.", + "maxLength": 64, + "nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the subscription is enabled (`true`) or not (`false`).", + "nullable": true + }, + "event_types": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The event types associated with this subscription.", + "nullable": true + }, + "notification_url": { + "type": "string", + "description": "The URL to which webhooks are sent.", + "nullable": true + }, + "api_version": { + "type": "string", + "description": "The API version of the subscription.\nThis field is optional for `CreateWebhookSubscription`. \nThe value defaults to the API version used by the application.", + "nullable": true + }, + "signature_key": { + "type": "string", + "description": "The Square-generated signature key used to validate the origin of the webhook event.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The timestamp of when the subscription was created, in RFC 3339 format. For example, \"2016-09-04T23:59:33.123Z\".", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The timestamp of when the subscription was last updated, in RFC 3339 format.\nFor example, \"2016-09-04T23:59:33.123Z\".", + "readOnly": true + } + } + }, + "Weekday": { + "type": "string", + "enum": [ + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT", + "SUN" + ], + "x-enum-elements": [ + { + "name": "MON", + "description": "Monday" + }, + { + "name": "TUE", + "description": "Tuesday" + }, + { + "name": "WED", + "description": "Wednesday" + }, + { + "name": "THU", + "description": "Thursday" + }, + { + "name": "FRI", + "description": "Friday" + }, + { + "name": "SAT", + "description": "Saturday" + }, + { + "name": "SUN", + "description": "Sunday" + } + ], + "description": "The days of the week.", + "x-release-status": "PUBLIC" + }, + "WorkweekConfig": { + "type": "object", + "description": "Sets the day of the week and hour of the day that a business starts a\nworkweek. This is used to calculate overtime pay.", + "x-release-status": "PUBLIC", + "required": [ + "start_of_week", + "start_of_day_local_time" + ], + "properties": { + "id": { + "type": "string", + "description": "The UUID for this object." + }, + "start_of_week": { + "$ref": "#/components/schemas/Weekday", + "description": "The day of the week on which a business week starts for\ncompensation purposes.\nSee [Weekday](#type-weekday) for possible values" + }, + "start_of_day_local_time": { + "type": "string", + "description": "The local time at which a business week starts. Represented as a\nstring in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are\ntruncated).", + "minLength": 1 + }, + "version": { + "type": "integer", + "description": "Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write; potentially overwriting data from another\nwrite." + }, + "created_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format; presented in UTC.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "A read-only timestamp in RFC 3339 format; presented in UTC.", + "readOnly": true + } + } + } + }, + "x-apis": { + "ApplePay": { + "name": "Apple Pay", + "summary": "Apple Pay support APIs", + "description": "\nThe Apple Pay APIs provides an easy way for platform developers\nto bulk activate Web Apple Pay with Square for merchants using their platform.\n\nFor more information, see the following guides:\n- [Web Payments SDK](https://developer.squareup.com/docs/web-payments/apple-pay)\n- [In-App Payments SDK](https://developer.squareup.com/docs/in-app-payments-sdk/add-digital-wallets/apple-pay)" + }, + "BankAccounts": { + "name": "Bank Accounts", + "summary": "Get a list of a seller's bank accounts.", + "description": "\nThe Bank Accounts API allows you to get basic details about a seller's bank account, such as the\nlast few digits of the account number and the routing number. It can be paired with the Payouts API to understand the\npattern of deposits and withdrawals from a seller's bank account.\n\nFor more information, see the following guides:\n - [Bank Accounts](https://developer.squareup.com/docs/bank-accounts-api)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)\n" + }, + "BookingCustomAttributes": { + "name": "Booking Custom Attributes", + "summary": "Create and manage booking-related custom attribute definitions and custom attributes.", + "description": "\nUse the Booking Custom Attributes API to create and manage custom attributes for bookings to store properties or \nmetadata to support seller-specific customizations of and extensions to the `Booking` object. \n\nFor more information, see the following guides: \n - [Booking Custom Attributes](https://developer.squareup.com/docs/booking-custom-attributes-api/overview).\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)\n" + }, + "Bookings": { + "name": "Bookings", + "summary": "Create and manage bookings for Square sellers with the Bookings API.", + "description": "\nThe Bookings API allows you to create, retrieve, update, and cancel appointments online. When used with other Square APIs (such as the Locations API, Team API, Catalog API, and Customers API), the Bookings API lets you create online-booking applications for users to book services provided by Square sellers. \n\n\n## Why Use the Bookings API?\nThe Bookings API simplifies the scheduling process for Square sellers and their customers. By integrating with Square’s broader ecosystem, it offers a robust solution for managing appointments. Key Bookings API benefits include:\n\n\n* Comprehensive calendar control for sellers, with permissions that allow flexibility in creating bookings.\n* Streamlined buyer-level operations with secure and limited access.\n* Compatibility with Square’s Appointments subscription plans, offering additional features and functionality.\n* Custom attributes to personalize the booking experience.\n* Seamless integration with other Square APIs, such as [Customers API](https://developer.squareup.com/docs/customers-api/what-it-does), [Locations API](https://developer.squareup.com/docs/locations-api), [Team API](https://developer.squareup.com/docs/team/overview), and [Catalog API](https://developer.squareup.com/docs/catalog-api/what-it-does).\n\n\nFor more information, see the following guides:\n - [Bookings API Guide](https://developer.squareup.com/docs/bookings-api/what-it-is)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)\n" + }, + "Cards": { + "name": "Cards", + "summary": "Use the Cards API to save a credit or debit card on file.", + "description": "\nYou can use the [CreateCard](/reference/square/cards-api/create-card) endpoint to save a credit or debit card to a Square account.\nDevelopers can integrate the Cards API in their application to let Square sellers:\n\n- **Save a card that can be charged by any Square seller who uses your application.** Your application specifies the organization access token in the `CreateCard` request.\n- **Save a card that can be charged by a single Square seller.** Your application specifies the access token of the specific seller account in the `CreateCard` request.\n\nThe Cards API also supports other endpoints to manage the cards.\n\nFor more information, see the following guides:\n - [Cards](https://developer.squareup.com/docs/cards-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "CashDrawers": { + "name": "Cash Drawers", + "summary": "Get details about cash drawer shifts.", + "description": "\nCash drawer shifts track cash transactions so that the total money in the cash drawers can be reconciled for a\nspecific period of time (a cash drawer shift), for a particular device, in a particular location. The Cash Drawer Shifts API\nenables you to list and retrieve information about cash drawer shifts.\n\nFor more information, see the following guide:\n - [Cash Drawer Shifts](https://developer.squareup.com/docs/cashdrawershift-api/reporting)" + }, + "Catalog": { + "name": "Catalog", + "summary": "Programmatically catalogs a Square seller’s products for sale and services for hire.", + "description": "\nThe Catalog API allows you to programmatically catalog products or services, including items, variations, categories, discounts, taxes, modifiers, and more.\n\nFor more information, see the following guides:\n - [Catalog](https://developer.squareup.com/docs/catalog-api/what-it-does)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Checkout": { + "name": "Checkout", + "summary": "Accept payments through a pre-built, Square-hosted checkout page. No frontend required.", + "description": "\nWith the Square Checkout API, your customers can pay for a purchase through a simple, Square-hosted checkout page. It can be integrated into any payments workflow with minimal coding. \n\nYou can create and configure your checkout page through a `CreatePaymentLink` request, specifying the accepted payment methods and checkout options like tipping and custom fields. You can also configure a URL for customers to be redirected to once they complete their purchase. \n\nFirst time Square developers should utilize the payment link endpoints to create, update, retrieve, and list checkout pages. \n\nFor more information, see the following guide:\n - [Checkout](https://developer.squareup.com/docs/checkout-api-overview)" + }, + "CustomerCustomAttributes": { + "name": "Customer Custom Attributes", + "summary": "Create and manage customer-related custom attribute definitions and custom attributes.", + "description": "\nUse the Customer Custom Attributes API to create and manage custom attributes for customer profiles. Custom attributes can be used to store properties or metadata that simplify integration, synchronization, and personalization workflows. After a custom attribute definition is created in a Square seller account, the custom attribute value can be set for customer profiles in the seller's Customer Directory.\n\nFor more information, see the following guides:\n - [Customer Custom Attributes](https://developer.squareup.com/docs/customer-custom-attributes-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "CustomerGroups": { + "name": "Customer Groups", + "summary": "Create and manage customer groups to streamline and automate workflows and help personalize customer interactions.", + "description": "\nThe Customer Groups API lets you create and manage customer groups to provide targeted promotions or take other customized actions based on group membership. For example, you can create Weekly, Monthly, and Quarterly customer groups and add customers to them based on their preferences to receive marketing promotions on a weekly, monthly, and quarterly basis. You can then use the information to manage your marketing email schedule. \n\nYou can use the Customer Groups API to retrieve and manage customer groups. You can use the Customers API to add customers to and remove customers from groups and search for customers based on group membership.\n\nFor more information, see the following guide:\n - [Customer Groups](https://developer.squareup.com/docs/customer-groups-api/what-it-does)" + }, + "CustomerSegments": { + "name": "Customer Segments", + "summary": "Retrieve customer segments (also called smart groups) in a business account.", + "description": "\nThe Customer Segments API lets you retrieve information about the segments defined for a business. Square sellers can create customer segments in the Seller Dashboard or Point of Sale by defining filters for the segment. For example, a segment can include customers who have visited more than 10 times. Customers are automatically added to and removed from the segment over time based on this criterion. \n\nYou can inspect the customer's `segment_ids` property to determine which segments a customer belongs to. Then, you can use the Customer Segments API to retrieve basic details about each segment, such as the segment name and the time when it was created.\n\nFor more information, see the following guide:\n - [Customer Segments](https://developer.squareup.com/docs/customer-segments-api/what-it-does)" + }, + "Customers": { + "name": "Customers", + "summary": "Create and manage customer profiles and sync CRM systems with Square.", + "description": "\nThe Customers API enables you to create and manage customer profiles, as well as search for customers based on various criteria (including customer group membership). You can also use the API to sync contacts between your CRM system and Square.\n\nFor more information, see the following guides:\n - [Customers](https://developer.squareup.com/docs/customers-api/what-it-does)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Devices": { + "name": "Devices", + "summary": "Create device codes used to connect Square Terminal with a 3rd-party point of sale system, and get details about all connected Terminals. ", + "description": "\nFor more information, see the following guides:\n - [Devices](https://developer.squareup.com/docs/terminal-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Disputes": { + "name": "Disputes", + "summary": "Use the Disputes API to manage disputes (chargebacks).", + "description": "\nA seller has the following options to process a dispute:\n\n- Accept the dispute using the [AcceptDispute](/reference/square/disputes-api/accept-dispute) endpoint. Square returns the disputed amount from the account balance of the Square account.\n- Challenge the dispute using the [SubmitEvidence](/reference/square/disputes-api/submit-evidence) endpoint. If the payment was valid, you can contest the disputed payment.\nYou submit supporting evidence you have about the transaction, such as receipts, invoices, email correspondence, proof of delivery, or photos.\nYou upload evidence using the [CreateDisputeEvidenceFile](/reference/square/disputes-api/create-dispute-evidence-file) endpoint.\n\nThe Disputes API also supports other endpoints useful in dispute management.\n\nFor more information, see the following guides:\n - [Disputes](https://developer.squareup.com/docs/disputes-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Employees": { + "name": "Employees", + "summary": "Pull employee data into accounting and payroll systems with the Employees API.", + "description": "\nThe Employees API allows applications to retrieve a roster of employees registered in the Square Point\nof Sale system, which can be useful in payroll and account contexts.\n\nPrior to 2020-08-26, the Employees API was best used in conjunction with the Labor API, where you provide employee IDs to\nmanage shifts, breaks, and wages. After that deprecation date, the Team API should be used.\n\nFor information about migrating your code to the Team API, see [Migrate from the Square Employees API](https://developer.squareup.com/docs/team/migrate-from-v2-employees?environment=master\u0026preview=true)" + }, + "Events": { + "name": "Events", + "summary": "Search for Square API events that occur within a 28-day timeframe.", + "description": "\nIf you don't need a real-time response to data changes or need a disaster recovery or reconciliation mechanism for missed webhook events (caused by server outages, misconfigured webhook subscriptions, network errors, and other events), you can use the Events API instead of webhook subscriptions managed manually or through the Webhook Subscriptions API.\n\nBecause Square events are owned by the application and not any one seller, you cannot use OAuth access tokens with the Events API. You must use the application’s [personal access token](/docs/build-basics/access-tokens).\n\nFor more information, see:\n - [Events API](https://developer.squareup.com/docs/events-api/overview) \n" + }, + "GiftCardActivities": { + "name": "Gift Card Activities", + "summary": "Create and retrieve gift card activities.", + "description": "\nUse the Gift Card Activities API to create activities for a Square gift card (such as activating or reloading the gift card) and to track gift card activities. The Gift Card Activities API is used with the [Gift Cards API](https://developer.squareup.com/reference/square/gift-cards-api) to manage the gift card program for a Square seller.\n\nFor more information, see the following guides:\n - [Gift Card Activities](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "GiftCards": { + "name": "Gift Cards", + "summary": "Create and retrieve gift cards and manage gift cards on file.", + "description": "\n[Square Gift Cards](https://squareup.com/gift-cards) enable sellers to boost sales and attract new customers. Customers can purchase gift cards and redeem them at any of the seller's locations. Sellers can manage gift cards and track activity.\n\nUse the Gift Cards API to create and retrieve gift cards (for example, to get the gift card balance) and manage gift cards on file by linking or unlinking gift cards with customers. After creating a gift card, use the [Gift Card Activities API](https://developer.squareup.com/reference/square/gift-card-activities-api) to activate the gift card with an initial balance and manage other activities.\n\nFor more information, see the following guides:\n - [Gift Cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Inventory": { + "name": "Inventory", + "summary": "Programmatically manages a Square seller’s inventory of catalog items.", + "description": "\nThe Inventory API allows you to programmatically manage inventory counts and inventory changes of products or services.\n\nFor more information, see the following guides:\n - [Inventory](https://developer.squareup.com/docs/inventory-api/what-it-does)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Invoices": { + "name": "Invoices", + "summary": "Create, configure, and publish invoices for orders that were created using the Orders API.", + "description": "\n[Square Invoices](https://squareup.com/invoices) makes it easy for sellers to request and collect payments from their customers. Square notifies customers and processes invoice payments.\n\nUse the Invoices API to create and manage invoices for orders that were created using the Orders API. After you create the invoice and configure its delivery method, payment schedule, and other invoice settings, you can publish the invoice. Depending on the invoice settings, Square can send the invoice to the customer or automatically charge a card on file. Square hosts each invoice on a web page where customers can pay for it.\n\nFor more information, see the following guides:\n - [Invoices](https://developer.squareup.com/docs/invoices-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Labor": { + "name": "Labor", + "summary": "Manage shifts, breaks, and wages for employees in Square Point of Sale.", + "description": "\nThe Labor API allows you to see when employees clocked in and out, how much they worked during different\nperiods, and how many breaks they took. You can also call the API to register a past break, adjust a shift,\nor update a wage.\n\nThis API is used in conjunction with the Team API.\n\nFor more information, see the following guides:\n - [Labor](https://developer.squareup.com/docs/labor-api/what-it-does)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "LocationCustomAttributes": { + "name": "Location Custom Attributes", + "summary": "Create and manage location-related custom attribute definitions and custom attributes.", + "description": "\nUse the Location Custom Attributes API to create and manage custom attributes for locations. Custom attributes can be used to store properties or metadata that simplify integration, synchronization, and personalization workflows. After a custom attribute definition is created in a Square seller account, the custom attribute value can be set for locations.\n\nFor more information, see the following guides:\n - [Location Custom Attributes](https://developer.squareup.com/docs/location-custom-attributes-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Locations": { + "name": "Locations", + "summary": "Create and manage the locations of a seller's business.", + "description": "\nMany sellers use multiple locations to track where they make sales. The Locations API allows you to\ncreate and manage data about those locations, such as their addresses, names, and business hours.\n\nFor more information, see the following guides:\n - [Locations](https://developer.squareup.com/docs/locations-api)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Loyalty": { + "name": "Loyalty", + "summary": "Enroll buyers in a Square loyalty program, view program settings, manage and track loyalty activity, and create and manage promotions.", + "description": "\nSellers subscribe to [Square Loyalty](https://squareup.com/software/loyalty) to offer a loyalty program that can increase repeat visits to their business by rewarding customers.\n\nUse the Loyalty API to create loyalty accounts for buyers and enable them to earn points for purchases and redeem points for reward discounts. Also use the Loyalty API to retrieve details about the loyalty program, create and manage loyalty promotions that extend the base program, and track balance-changing events for loyalty accounts.\n\nFor more information, see the following guides:\n - [Loyalty](https://developer.squareup.com/docs/loyalty-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "MerchantCustomAttributes": { + "name": "Merchant Custom Attributes", + "summary": "Create and manage merchant-related custom attribute definitions and custom attributes.", + "description": "\nUse the Merchant Custom Attributes API to create and manage custom attributes for merchants that connect to your application. Custom attributes can be used to store properties or metadata that simplify integration, synchronization, and personalization workflows.\n\nFor more information, see the following guides:\n - [Merchant Custom Attributes](https://developer.squareup.com/docs/merchant-custom-attributes-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Merchants": { + "name": "Merchants", + "summary": "Retrieve information about an organization that sells with Square.", + "description": "\nThe Merchants API groups individual seller locations into larger organizations, allowing them to operate as a single entity. Each merchant represents one organization or business that sells with Square. Use this API to retrieve core information about the organization connecting to your application such as the merchant ID, language preferences, country, account status, and the name of the overall business.\n\nFor more information, see the following guide:\n - [Merchants](https://developer.squareup.com/docs/merchants-api)" + }, + "MobileAuthorization": { + "name": "Mobile Authorization", + "summary": "Authorize Reader SDK applications to take in-person payments.", + "description": "\n**Deprecated** - Developers should update their Reader SDK integration to use the \n[Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. \n\nThe Mobile Authorization API accepts an account credential (an OAuth token or a personal access token) and a\nlocation ID and returns an authorization code that custom mobile applications can use to initialize Square mobile\nsolutions, like Reader SDK, to accept payments using Square hardware.\n\nFor more information, see the following guide:\n - [Mobile Authorization](https://developer.squareup.com/docs/mobile-authz/what-it-does)" + }, + "OAuth": { + "name": "OAuth", + "summary": "Allow your application to gain programmatic access to other seller accounts.", + "description": "\nThe Square OAuth API lets applications request and obtain permission from a Square account to make API\ncalls on behalf of that account. Applications can request individual permissions so that users do not need\nto grant full access to their Square accounts.\n\nFor more information, see the following guides:\n - [OAuth](https://developer.squareup.com/docs/oauth-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "OrderCustomAttributes": { + "name": "Order Custom Attributes", + "summary": "Create and manage order-related custom attribute definitions and custom attributes.", + "description": "\nUse the Order Custom Attributes API to create and manage custom attributes for orders. Custom attributes can be used to store properties or metadata that simplify integration, synchronization, and personalization workflows. After a custom attribute definition is created in a Square seller account, the custom attribute value can be set for orders.\n\nFor more information, see the following guides:\n - [Order Custom Attributes](https://developer.squareup.com/docs/orders-custom-attributes-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Orders": { + "name": "Orders", + "summary": "Get sales data for a Square seller, itemize payments, push orders to POS, and more.", + "description": "\nThe Orders API is your one-stop shop for adding rich functionality to payments. You can itemize\npayments using custom line items or catalog objects, send orders to physical Point of Sale devices\nto be fulfilled, attach a customer to a payment, and more.\n\nIn addition, the Orders API lets you search through all of a seller's past sales and returns itemization\ndata, customer references, and other details from sales made using POS or online.\n\nIf you use the Square Orders API with a non-Square payments provider, Square charges a transaction fee. For more information, see [Orders API fee structure.](https://developer.squareup.com/docs/payments-pricing#orders-api-fee-structure)\n\nFor more information, see the following guides:\n - [Orders](https://developer.squareup.com/docs/orders-api/what-it-does)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Payments": { + "name": "Payments", + "summary": "The Payments API lets developers take and manage payments.", + "description": "\nApplications need the following input to take a payment:\n\n- The amount to charge.\n- The payment recipient. The payment goes to the account identified by the Authorization header in the API request.\n- The payment source. The source can be a payment token or card on file.\n\n You can generate a payment token using the Web Payments SDK and the In-App Payments SDK. For working code examples, see [Square Connect API Examples](https://github.com/square/connect-api-examples).\n\n A card on file is a credit card, debit card, or gift card that is associated with a customer. \n You can create a customer and add a card on file using Square APIs, the Square Seller Dashboard, or the Square Point of Sale application.\n\n For more information, see the following guides:\n - [Payments](https://developer.squareup.com/docs/payments-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Payouts": { + "name": "Payouts", + "summary": "Get a list of deposits and withdrawals from a seller's bank accounts.", + "description": "\nThe Payouts API allows you to see a complete list of payouts made to a seller's banking destination,\nwith a list of payout entries that describe the payments associated with each payout. It can be paired with the\nBank Accounts API to add detail about which bank account each payout was made to.\n\nFor more information, see the following guide:\n - [Payouts](https://developer.squareup.com/docs/payouts/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Refunds": { + "name": "Refunds", + "summary": "Manage and issue refunds for payments made to Square sellers.", + "description": "\nThe following applies to refunds:\n\n- You cannot refund more than what was originally collected.\n- The refund amount must be available in the account's Square balance. If the amount is not available, Square attempts to take money out of\n the associated bank account. Refunds are in a state of PENDING until the funds are secured.\n- If funds cannot be secured, the refund is not completed and the buyer does not receive a credit. The refund has \n a status of FAILED. Future refunds to this payment are not allowed and the buyer should be reimbursed by other means.\n- You can refund only payments with status COMPLETED. You cannot refund an APPROVED payment; however, you can cancel\n an approved payment.\n\nFor more information, see the following guides:\n - [Refunds](https://developer.squareup.com/docs/payments-api/refund-payments)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Reporting": { + "name": "Reporting", + "summary": "Deprecated - Use the Orders and Payments APIs instead.", + "description": "\nPrior to 2019/08/15, the Reporting API was the way to review multi-party payments taken with the Transactions\nAPI. The Payments API now includes an \"application fee\" parameter you can use to replace this functionality." + }, + "Sites": { + "name": "Sites", + "summary": "Get details about Square Online sites that belong to Square sellers.", + "description": "\nSquare sellers use Square Online to build eCommerce websites. The Sites API lets you get basic details about Square Online sites, such as the site ID, title, and domain. You can use the Sites API with the Snippets API to manage snippets that extend Square Online features.\n\n __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).\n\n For more information, see the following guide:\n - [Sites](https://developer.squareup.com/docs/sites-api/overview)" + }, + "Snippets": { + "name": "Snippets", + "summary": "Manage snippets for Square Online sites.", + "description": "\nThe Snippets API lets you manage snippets that add custom functionality to Square Online sites. A snippet is HTML, CSS, and JavaScript that is injected into the `head` element of all pages on a site, except for checkout pages. You can use the Snippets API to create applications that help meet the many needs of Square sellers.\n\n __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).\n\n For more information, see the following guide:\n - [Snippets](https://developer.squareup.com/docs/snippets-api/overview)" + }, + "Subscriptions": { + "name": "Subscriptions", + "summary": "Create and manage subscriptions.", + "description": "\nSubscriptions enable sellers to generate a reliable cash flow and recurring revenue to grow their businesses. Square offers the Subscriptions API for developers to embed subscription functionality in their applications. You first create a subscription plan using the Catalog API and then use the Subscriptions API to create and manage subscriptions. \n\nFor more information, see the following guides:\n - [Subscriptions](https://developer.squareup.com/docs/subscriptions/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Team": { + "name": "Team", + "summary": "Manage a roster of team members and pull employee data into accounting and payroll systems.", + "description": "\nThe Team API allows applications to manage team members and job definitions for Square sellers. \nThis includes creating and managing team member profiles, wage settings, and job data. The Team API \nsupports synchronization of team member data with accounting and payroll systems, which is useful \nfor applications that handle payroll, scheduling, and other team member-related activities. \nNote that some operations, such as setting permissions and passcodes, still need to be done directly \nthrough the Square Dashboard.\n\nThe Team API integrates closely with the Labor API for timecard management.\n\nFor more information, see the following guide:\n - [Team](https://developer.squareup.com/docs/team/overview)\n - [Square Webhooks](https://developer.squareup.com/docs/webhooks-overview)\n" + }, + "Terminal": { + "name": "Terminal", + "summary": "Requests a checkout from a paired Square Terminal.", + "description": "\nThe Terminal API allows you to manage sending and receiving requests and responses from a paired Square Terminal. For a Terminal checkout, refund, or action, you can create a request, check its status, cancel the request, search for in-process requests, and get the results of the request after it is completed. In the current implementation, refunds are only supported for Interac debit cards in Canada.\n\nFor more information, see the following guides:\n - [Terminal](https://developer.squareup.com/docs/terminal-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "Transactions": { + "name": "Transactions", + "summary": "Deprecated - Use the Orders and Payments APIs instead.", + "description": "\nPrior to 2019/08/15, the Transactions API was the way to take online payments. Going forward, the Payments API \nand Refunds API (together with the Orders API) replace the Transactions API. For information about migrating your code to the Payments API, see [Migrate from Transactions](https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api)" + }, + "V1Webhooks": { + "name": "V1Webhooks", + "summary": "Deprecated - Use V2 Webhooks.", + "description": "\nIf you are working with V1 (deprecated) webhooks, you use the Webhooks API to subscribe to events for each seller you are interested in receiving events for.\n\nIf you are working with V2 webhooks, you do not need to use this API.\nInstead, you subscribe to events using the [Developer Dashboard](/apps) or the [Webhook Subscriptions API](/reference/square/webhook-subscriptions-api).\nLearn how to subscribe to V2 webhooks using the [dashboard](/docs/webhooks/step2subscribe) or the [API](/docs/webhooks/webhook-subscriptions-api)." + }, + "Vendors": { + "name": "Vendors", + "summary": "Manages a seller's suppliers.", + "description": "The Vendors API allows applications to create, retrieve, and update vendors as suppliers to a seller.\n\nFor more information, see the following guides:\n - [Vendors](https://developer.squareup.com/docs/vendors-api/overview)\n - [Square Webhooks Overview](https://developer.squareup.com/docs/webhooks-overview)" + }, + "WebhookSubscriptions": { + "name": "Webhook Subscriptions", + "summary": "Create and manage webhook subscriptions.", + "description": "\nThe Webhook Subscriptions API allows you to create, retrieve, update, and delete webhook subscriptions. Because Webhook subscriptions are owned by the application and not any one seller, you cannot use OAuth Access Tokens with the Webhook Subscriptions API. You must use the application’s [personal access token](/docs/build-basics/access-tokens).\n\nFor more information, see the following guide the following guide:\n - [Webhook Subscriptions](https://developer.squareup.com/docs/webhooks/webhook-subscriptions-api)" + } + }, + "x-categories": { + "Commerce": { + "name": "Commerce", + "summary": "Process orders, manage catalogs, track inventory, book reservations, and manage vendors. ", + "description": "", + "apis": [ + "#/components/x-apis/Orders", + "#/components/x-apis/OrderCustomAttributes", + "#/components/x-apis/Catalog", + "#/components/x-apis/Inventory", + "#/components/x-apis/Bookings", + "#/components/x-apis/Booking Custom Attributes", + "#/components/x-apis/Vendors", + "#/components/x-apis/Sites", + "#/components/x-apis/Snippets", + "#/components/x-apis/Cash Drawers" + ] + }, + "Customers": { + "name": "Customers", + "summary": "Securely manage customer data and integrate engagement features to increase repeat business and attract new customers.", + "description": "\n", + "apis": [ + "#/components/x-apis/Customers", + "#/components/x-apis/CustomerCustomAttributes", + "#/components/x-apis/CustomerGroups", + "#/components/x-apis/CustomerSegments", + "#/components/x-apis/Loyalty", + "#/components/x-apis/GiftCards", + "#/components/x-apis/GiftCardActivities" + ] + }, + "Dev Essentials": { + "name": "Dev Essentials", + "summary": "Authenticate your app, provide secure delegated access to Square account data, and manage webhook subscriptions.", + "description": "", + "apis": [ + "#/components/x-apis/OAuth", + "#/components/x-apis/WebhookSubscriptions", + "#/components/x-apis/Events" + ] + }, + "Merchants": { + "name": "Merchants", + "summary": "Manage a seller's core business information used for business, and suppliers.", + "description": "", + "apis": [ + "#/components/x-apis/Merchants", + "#/components/x-apis/MerchantCustomAttributes", + "#/components/x-apis/Locations", + "#/components/x-apis/LocationCustomAttributes" + ] + }, + "Payments": { + "name": "Payments", + "summary": "Take payments, process refunds, manage disputes, enable subscriptions, and get paid for your sales.", + "description": "\n", + "apis": [ + "#/components/x-apis/Payments", + "#/components/x-apis/Refunds", + "#/components/x-apis/Checkout", + "#/components/x-apis/Terminal", + "#/components/x-apis/Disputes", + "#/components/x-apis/Invoices", + "#/components/x-apis/Cards", + "#/components/x-apis/Subscriptions", + "#/components/x-apis/BankAccounts", + "#/components/x-apis/Payouts", + "#/components/x-apis/MobileAuthorization", + "#/components/x-apis/Devices", + "#/components/x-apis/ApplePay" + ] + }, + "Staff": { + "name": "Staff", + "summary": "Manage team members and jobs, and track shift hours.", + "description": "", + "apis": [ + "#/components/x-apis/Labor", + "#/components/x-apis/Team" + ] + } + }, + "x-categories-order": [ + "Dev Essentials", + "Payments", + "Commerce", + "Customers", + "Staff", + "Merchants" + ], + "x-v1-api-mappings": { + "V1Employees": { + "V1CreateEmployee": "Employees", + "V1CreateEmployeeRole": "Employees", + "V1CreateTimecard": "Labor", + "V1DeleteTimecard": "Labor", + "V1ListCashDrawerShifts": "CashDrawers", + "V1ListEmployeeRoles": "Employees", + "V1ListEmployees": "Employees", + "V1ListTimecardEvents": "Labor", + "V1ListTimecards": "Labor", + "V1RetrieveCashDrawerShift": "CashDrawers", + "V1RetrieveEmployee": "Employees", + "V1RetrieveEmployeeRole": "Employees", + "V1RetrieveTimecard": "Labor", + "V1UpdateEmployee": "Employees", + "V1UpdateEmployeeRole": "Employees", + "V1UpdateTimecard": "Labor" + }, + "V1Items": { + "V1AdjustInventory": "Inventory", + "V1ApplyFee": "Catalog", + "V1ApplyModifierList": "Catalog", + "V1CreateCategory": "Catalog", + "V1CreateDiscount": "Catalog", + "V1CreateFee": "Catalog", + "V1CreateItem": "Catalog", + "V1CreateModifierList": "Catalog", + "V1CreateModifierOption": "Catalog", + "V1CreatePage": "Catalog", + "V1CreateVariation": "Catalog", + "V1DeleteCategory": "Catalog", + "V1DeleteDiscount": "Catalog", + "V1DeleteFee": "Catalog", + "V1DeleteItem": "Catalog", + "V1DeleteModifierList": "Catalog", + "V1DeleteModifierOption": "Catalog", + "V1DeletePage": "Catalog", + "V1DeletePageCell": "Catalog", + "V1DeleteVariation": "Catalog", + "V1ListCategories": "Catalog", + "V1ListDiscounts": "Catalog", + "V1ListFees": "Catalog", + "V1ListInventory": "Inventory", + "V1ListItems": "Catalog", + "V1ListModifierLists": "Catalog", + "V1ListPages": "Catalog", + "V1RemoveFee": "Catalog", + "V1RemoveModifierList": "Catalog", + "V1RetrieveItem": "Catalog", + "V1RetrieveModifierList": "Catalog", + "V1UpdateCategory": "Catalog", + "V1UpdateDiscount": "Catalog", + "V1UpdateFee": "Catalog", + "V1UpdateItem": "Catalog", + "V1UpdateModifierList": "Catalog", + "V1UpdateModifierOption": "Catalog", + "V1UpdatePage": "Catalog", + "V1UpdatePageCell": "Catalog", + "V1UpdateVariation": "Catalog", + "V1UploadItemImage": "Catalog" + }, + "V1Locations": { + "V1ListLocations": "Locations", + "V1RetrieveBusiness": "Merchants" + }, + "V1Transactions": { + "V1CreateRefund": "Refunds", + "V1ListBankAccounts": "BankAccounts", + "V1ListPayments": "Payments", + "V1ListRefunds": "Refunds", + "V1ListSettlements": "Payouts", + "V1RetrieveBankAccount": "BankAccounts", + "V1RetrievePayment": "Payments", + "V1RetrieveSettlement": "Payouts" + }, + "V1Webhooks": { + "V1ListWebhooks": "V1Webhooks", + "V1UpdateWebhooks": "V1Webhooks" + } + } + }, + "paths": { + "/mobile/authorization-code": { + "post": { + "tags": [ + "MobileAuthorization" + ], + "summary": "CreateMobileAuthorizationCode", + "operationId": "CreateMobileAuthorizationCode", + "description": "__Note:__ This endpoint is used by the deprecated Reader SDK. \nDevelopers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. \n\nGenerates code to authorize a mobile application to connect to a Square card reader.\n\nAuthorization codes are one-time-use codes and expire 60 minutes after being issued.\n\nThe `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nReplace `ACCESS_TOKEN` with a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": {}, + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE_IN_PERSON" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateMobileAuthorizationCodeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateMobileAuthorizationCodeResponse" + } + } + } + } + } + } + }, + "/oauth2/revoke": { + "post": { + "tags": [ + "OAuth" + ], + "summary": "RevokeToken", + "operationId": "RevokeToken", + "description": "Revokes an access token generated with the OAuth flow.\n\nIf an account has more than one OAuth access token for your application, this\nendpoint revokes all of them, regardless of which token you specify. \n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the **OAuth**\npage for your application in the Developer Dashboard.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": null + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevokeTokenRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevokeTokenResponse" + } + } + } + } + } + } + }, + "/oauth2/token": { + "post": { + "tags": [ + "OAuth" + ], + "summary": "ObtainToken", + "operationId": "ObtainToken", + "description": "Returns an OAuth access token and refresh token using the `authorization_code`\nor `refresh_token` grant type.\n\nWhen `grant_type` is `authorization_code`:\n- With the [code flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow),\nprovide `code`, `client_id`, and `client_secret`.\n- With the [PKCE flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow),\nprovide `code`, `client_id`, and `code_verifier`. \n\nWhen `grant_type` is `refresh_token`:\n- With the code flow, provide `refresh_token`, `client_id`, and `client_secret`.\nThe response returns the same refresh token provided in the request.\n- With the PKCE flow, provide `refresh_token` and `client_id`. The response returns\na new refresh token.\n\nYou can use the `scopes` parameter to limit the set of permissions authorized by the\naccess token. You can use the `short_lived` parameter to create an access token that\nexpires in 24 hours.\n\n__Important:__ OAuth tokens should be encrypted and stored on a secure server.\nApplication clients should never interact directly with OAuth tokens.", + "x-release-status": "PUBLIC", + "security": [], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObtainTokenRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObtainTokenResponse" + } + } + } + } + } + } + }, + "/oauth2/token/status": { + "post": { + "tags": [ + "OAuth" + ], + "summary": "RetrieveTokenStatus", + "operationId": "RetrieveTokenStatus", + "description": "Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).\n\nAdd the access token to the Authorization header of the request.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nwhere `ACCESS_TOKEN` is a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).\n\nIf the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveTokenStatusResponse" + } + } + } + } + } + } + }, + "/v1/{location_id}/orders": { + "get": { + "tags": [ + "V1Transactions" + ], + "summary": "V1ListOrders", + "operationId": "V1ListOrders", + "description": "Provides summary information for a merchant's online store orders.", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "deprecated": true, + "x-deprecation": {}, + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to list online store orders for.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "order", + "description": "The order in which payments are listed in the response.", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of payments to return in a single response. This value cannot exceed 200.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "batch_token", + "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/V1Order" + } + } + } + } + } + } + } + }, + "/v1/{location_id}/orders/{order_id}": { + "get": { + "tags": [ + "V1Transactions" + ], + "summary": "V1RetrieveOrder", + "operationId": "V1RetrieveOrder", + "description": "Provides comprehensive information for a single online store order, including the order's history.", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "deprecated": true, + "x-deprecation": {}, + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the order's associated location.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "order_id", + "description": "The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V1Order" + } + } + } + } + } + }, + "put": { + "tags": [ + "V1Transactions" + ], + "summary": "V1UpdateOrder", + "operationId": "V1UpdateOrder", + "description": "Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:", + "x-release-status": "DEPRECATED", + "x-visibility": "SDK_ONLY", + "deprecated": true, + "x-deprecation": {}, + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the order's associated location.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "order_id", + "description": "The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V1UpdateOrderRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V1Order" + } + } + } + } + } + } + }, + "/v2/apple-pay/domains": { + "post": { + "tags": [ + "ApplePay" + ], + "summary": "RegisterDomain", + "operationId": "RegisterDomain", + "description": "Activates a domain for use with Apple Pay on the Web and Square. A validation\nis performed on this domain by Apple to ensure that it is properly set up as\nan Apple Pay enabled domain.\n\nThis endpoint provides an easy way for platform developers to bulk activate\nApple Pay on the Web with Square for merchants using their platform.\n\nNote: You will need to host a valid domain verification file on your domain to support Apple Pay. The\ncurrent version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,\nand should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your\ndomain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding\nlong-lived caches that might not keep in sync with the correct file version.\n\nTo learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterDomainRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterDomainResponse" + } + } + } + } + } + } + }, + "/v2/bank-accounts": { + "get": { + "tags": [ + "BankAccounts" + ], + "summary": "ListBankAccounts", + "operationId": "ListBankAccounts", + "description": "Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "BANK_ACCOUNTS_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListBankAccountsResponse" + } + } + } + } + } + } + }, + "/v2/bank-accounts/by-v1-id/{v1_bank_account_id}": { + "get": { + "tags": [ + "BankAccounts" + ], + "summary": "GetBankAccountByV1Id", + "operationId": "GetBankAccountByV1Id", + "description": "Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "BANK_ACCOUNTS_READ" + ] + } + ], + "parameters": [ + { + "name": "v1_bank_account_id", + "description": "Connect V1 ID of the desired `BankAccount`. For more information, see \n[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetBankAccountByV1IdResponse" + } + } + } + } + } + } + }, + "/v2/bank-accounts/{bank_account_id}": { + "get": { + "tags": [ + "BankAccounts" + ], + "summary": "GetBankAccount", + "operationId": "GetBankAccount", + "description": "Returns details of a [BankAccount](entity:BankAccount)\nlinked to a Square account.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "BANK_ACCOUNTS_READ" + ] + } + ], + "parameters": [ + { + "name": "bank_account_id", + "description": "Square-issued ID of the desired `BankAccount`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetBankAccountResponse" + } + } + } + } + } + } + }, + "/v2/bookings": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "ListBookings", + "operationId": "ListBookings", + "description": "Retrieve a collection of bookings.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "limit", + "description": "The maximum number of results per page to return in a paged response.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "customer_id", + "description": "The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "team_member_id", + "description": "The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "start_at_min", + "description": "The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "start_at_max", + "description": "The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListBookingsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Bookings" + ], + "summary": "CreateBooking", + "operationId": "CreateBooking", + "description": "Creates a booking.\n\nThe required input must include the following:\n- `Booking.location_id`\n- `Booking.start_at`\n- `Booking.AppointmentSegment.team_member_id`\n- `Booking.AppointmentSegment.service_variation_id`\n- `Booking.AppointmentSegment.service_variation_version`\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateBookingRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateBookingResponse" + } + } + } + } + } + } + }, + "/v2/bookings/availability/search": { + "post": { + "tags": [ + "Bookings" + ], + "summary": "SearchAvailability", + "operationId": "SearchAvailability", + "description": "Searches for availabilities for booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchAvailabilityRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchAvailabilityResponse" + } + } + } + } + } + } + }, + "/v2/bookings/bulk-retrieve": { + "post": { + "tags": [ + "Bookings" + ], + "summary": "BulkRetrieveBookings", + "operationId": "BulkRetrieveBookings", + "description": "Bulk-Retrieves a list of bookings by booking IDs.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveBookingsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveBookingsResponse" + } + } + } + } + } + } + }, + "/v2/bookings/business-booking-profile": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "RetrieveBusinessBookingProfile", + "operationId": "RetrieveBusinessBookingProfile", + "description": "Retrieves a seller's booking profile.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_BUSINESS_SETTINGS_READ" + ] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveBusinessBookingProfileResponse" + } + } + } + } + } + } + }, + "/v2/bookings/custom-attribute-definitions": { + "get": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "ListBookingCustomAttributeDefinitions", + "operationId": "ListBookingCustomAttributeDefinitions", + "description": "Get all bookings custom attribute definitions.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListBookingCustomAttributeDefinitionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "CreateBookingCustomAttributeDefinition", + "operationId": "CreateBookingCustomAttributeDefinition", + "description": "Creates a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateBookingCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateBookingCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/bookings/custom-attribute-definitions/{key}": { + "delete": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "DeleteBookingCustomAttributeDefinition", + "operationId": "DeleteBookingCustomAttributeDefinition", + "description": "Deletes a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteBookingCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "RetrieveBookingCustomAttributeDefinition", + "operationId": "RetrieveBookingCustomAttributeDefinition", + "description": "Retrieves a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveBookingCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "UpdateBookingCustomAttributeDefinition", + "operationId": "UpdateBookingCustomAttributeDefinition", + "description": "Updates a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateBookingCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateBookingCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/bookings/custom-attributes/bulk-delete": { + "post": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "BulkDeleteBookingCustomAttributes", + "operationId": "BulkDeleteBookingCustomAttributes", + "description": "Bulk deletes bookings custom attributes.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteBookingCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteBookingCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/bookings/custom-attributes/bulk-upsert": { + "post": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "BulkUpsertBookingCustomAttributes", + "operationId": "BulkUpsertBookingCustomAttributes", + "description": "Bulk upserts bookings custom attributes.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertBookingCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertBookingCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/bookings/location-booking-profiles": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "ListLocationBookingProfiles", + "operationId": "ListLocationBookingProfiles", + "description": "Lists location booking profiles of a seller.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_BUSINESS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "limit", + "description": "The maximum number of results to return in a paged response.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLocationBookingProfilesResponse" + } + } + } + } + } + } + }, + "/v2/bookings/location-booking-profiles/{location_id}": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "RetrieveLocationBookingProfile", + "operationId": "RetrieveLocationBookingProfile", + "description": "Retrieves a seller's location booking profile.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_BUSINESS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to retrieve the booking profile.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLocationBookingProfileResponse" + } + } + } + } + } + } + }, + "/v2/bookings/team-member-booking-profiles": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "ListTeamMemberBookingProfiles", + "operationId": "ListTeamMemberBookingProfiles", + "description": "Lists booking profiles for team members.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_BUSINESS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "bookable_only", + "description": "Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a paged response.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "Indicates whether to include only team members enabled at the given location in the returned result.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListTeamMemberBookingProfilesResponse" + } + } + } + } + } + } + }, + "/v2/bookings/team-member-booking-profiles/bulk-retrieve": { + "post": { + "tags": [ + "Bookings" + ], + "summary": "BulkRetrieveTeamMemberBookingProfiles", + "operationId": "BulkRetrieveTeamMemberBookingProfiles", + "description": "Retrieves one or more team members' booking profiles.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_BUSINESS_SETTINGS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveTeamMemberBookingProfilesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveTeamMemberBookingProfilesResponse" + } + } + } + } + } + } + }, + "/v2/bookings/team-member-booking-profiles/{team_member_id}": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "RetrieveTeamMemberBookingProfile", + "operationId": "RetrieveTeamMemberBookingProfile", + "description": "Retrieves a team member's booking profile.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_BUSINESS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "team_member_id", + "description": "The ID of the team member to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveTeamMemberBookingProfileResponse" + } + } + } + } + } + } + }, + "/v2/bookings/{booking_id}": { + "get": { + "tags": [ + "Bookings" + ], + "summary": "RetrieveBooking", + "operationId": "RetrieveBooking", + "description": "Retrieves a booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveBookingResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Bookings" + ], + "summary": "UpdateBooking", + "operationId": "UpdateBooking", + "description": "Updates a booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the [Booking](entity:Booking) object representing the to-be-updated booking.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateBookingRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateBookingResponse" + } + } + } + } + } + } + }, + "/v2/bookings/{booking_id}/cancel": { + "post": { + "tags": [ + "Bookings" + ], + "summary": "CancelBooking", + "operationId": "CancelBooking", + "description": "Cancels an existing booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelBookingRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelBookingResponse" + } + } + } + } + } + } + }, + "/v2/bookings/{booking_id}/custom-attributes": { + "get": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "ListBookingCustomAttributes", + "operationId": "ListBookingCustomAttributes", + "description": "Lists a booking's custom attributes.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the target [booking](entity:Booking).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "with_definitions", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListBookingCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/bookings/{booking_id}/custom-attributes/{key}": { + "delete": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "DeleteBookingCustomAttribute", + "operationId": "DeleteBookingCustomAttribute", + "description": "Deletes a bookings custom attribute.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the target [booking](entity:Booking).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteBookingCustomAttributeResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "RetrieveBookingCustomAttribute", + "operationId": "RetrieveBookingCustomAttribute", + "description": "Retrieves a bookings custom attribute.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the target [booking](entity:Booking).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "with_definition", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "version", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveBookingCustomAttributeResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "BookingCustomAttributes" + ], + "summary": "UpsertBookingCustomAttribute", + "operationId": "UpsertBookingCustomAttribute", + "description": "Upserts a bookings custom attribute.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "APPOINTMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "booking_id", + "description": "The ID of the target [booking](entity:Booking).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertBookingCustomAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertBookingCustomAttributeResponse" + } + } + } + } + } + } + }, + "/v2/cards": { + "get": { + "tags": [ + "Cards" + ], + "summary": "ListCards", + "operationId": "ListCards", + "description": "Retrieves a list of cards owned by the account making the request.\nA max of 25 cards will be returned.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "customer_id", + "description": "Limit results to cards associated with the customer supplied.\nBy default, all cards owned by the merchant are returned.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "include_disabled", + "description": "Includes disabled cards.\nBy default, all enabled cards owned by the merchant are returned.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "reference_id", + "description": "Limit results to cards associated with the reference_id supplied.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "Sorts the returned list by when the card was created with the specified order.\nThis field defaults to ASC.", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCardsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Cards" + ], + "summary": "CreateCard", + "operationId": "CreateCard", + "description": "Adds a card on file to an existing merchant.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCardResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_DECLINED_VERIFICATION_REQUIRED" + }, + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CUSTOMER_NOT_FOUND" + }, + { + "error-code": "SOURCE_EXPIRED" + }, + { + "error-code": "SOURCE_USED" + }, + { + "error-code": "INVALID_CARD_DATA" + } + ] + } + }, + "/v2/cards/{card_id}": { + "get": { + "tags": [ + "Cards" + ], + "summary": "RetrieveCard", + "operationId": "RetrieveCard", + "description": "Retrieves details for a specific Card.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "card_id", + "description": "Unique ID for the desired Card.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCardResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/cards/{card_id}/disable": { + "post": { + "tags": [ + "Cards" + ], + "summary": "DisableCard", + "operationId": "DisableCard", + "description": "Disables the card, preventing any further updates or charges.\nDisabling an already disabled card is allowed but has no effect.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "card_id", + "description": "Unique ID for the desired Card.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisableCardResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/cash-drawers/shifts": { + "get": { + "tags": [ + "CashDrawers" + ], + "summary": "ListCashDrawerShifts", + "operationId": "ListCashDrawerShifts", + "description": "Provides the details for all of the cash drawer shifts for a location\nin a date range.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CASH_DRAWER_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to query for a list of cash drawer shifts.", + "schema": { + "type": "string" + }, + "in": "query", + "required": true + }, + { + "name": "sort_order", + "description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "begin_time", + "description": "The inclusive start time of the query on opened_at, in ISO 8601 format.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "end_time", + "description": "The exclusive end date of the query on opened_at, in ISO 8601 format.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "Opaque cursor for fetching the next page of results.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCashDrawerShiftsResponse" + } + } + } + } + } + } + }, + "/v2/cash-drawers/shifts/{shift_id}": { + "get": { + "tags": [ + "CashDrawers" + ], + "summary": "RetrieveCashDrawerShift", + "operationId": "RetrieveCashDrawerShift", + "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CASH_DRAWER_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to retrieve cash drawer shifts from.", + "schema": { + "type": "string" + }, + "in": "query", + "required": true + }, + { + "name": "shift_id", + "description": "The shift ID.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCashDrawerShiftResponse" + } + } + } + } + } + } + }, + "/v2/cash-drawers/shifts/{shift_id}/events": { + "get": { + "tags": [ + "CashDrawers" + ], + "summary": "ListCashDrawerShiftEvents", + "operationId": "ListCashDrawerShiftEvents", + "description": "Provides a paginated list of events for a single cash drawer shift.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CASH_DRAWER_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to list cash drawer shifts for.", + "schema": { + "type": "string" + }, + "in": "query", + "required": true + }, + { + "name": "shift_id", + "description": "The shift ID.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "limit", + "description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "Opaque cursor for fetching the next page of results.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCashDrawerShiftEventsResponse" + } + } + } + } + } + } + }, + "/v2/catalog/batch-delete": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "BatchDeleteCatalogObjects", + "operationId": "BatchDeleteCatalogObjects", + "description": "Deletes a set of [CatalogItem](entity:CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](entity:CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchDeleteCatalogObjectsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchDeleteCatalogObjectsResponse" + } + } + } + } + } + } + }, + "/v2/catalog/batch-retrieve": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "BatchRetrieveCatalogObjects", + "operationId": "BatchRetrieveCatalogObjects", + "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](entity:CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](entity:CatalogItemVariation) objects, references to\nits [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of\nany [CatalogTax](entity:CatalogTax) objects that apply to it.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveCatalogObjectsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveCatalogObjectsResponse" + } + } + } + } + } + } + }, + "/v2/catalog/batch-upsert": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "BatchUpsertCatalogObjects", + "operationId": "BatchUpsertCatalogObjects", + "description": "Creates or updates up to 10,000 target objects based on the provided\nlist of objects. The target objects are grouped into batches and each batch is\ninserted/updated in an all-or-nothing manner. If an object within a batch is\nmalformed in some way, or violates a database constraint, the entire batch\ncontaining that item will be disregarded. However, other batches in the same\nrequest may still succeed. Each batch may contain up to 1,000 objects, and\nbatches will be processed in order as long as the total object count for the\nrequest (items, variations, modifier lists, discounts, and taxes) is no more\nthan 10,000.\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchUpsertCatalogObjectsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchUpsertCatalogObjectsResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "GENERIC_DECLINE" + } + ] + } + }, + "/v2/catalog/images": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "CreateCatalogImage", + "operationId": "CreateCatalogImage", + "description": "Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing\n[CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id`\nis not specified.\n\nThis `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in\nJPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "request": { + "$ref": "#/components/schemas/CreateCatalogImageRequest" + }, + "image_file": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "image_file": { + "contentType": "image/jpeg" + }, + "request": { + "contentType": "application/json; charset=utf-8" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCatalogImageResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "GENERIC_DECLINE" + } + ] + } + }, + "/v2/catalog/images/{image_id}": { + "put": { + "tags": [ + "Catalog" + ], + "summary": "UpdateCatalogImage", + "operationId": "UpdateCatalogImage", + "description": "Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object.\n\nThis `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in\nJPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "image_id", + "description": "The ID of the `CatalogImage` object to update the encapsulated image file.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "request": { + "$ref": "#/components/schemas/UpdateCatalogImageRequest" + }, + "image_file": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "image_file": { + "contentType": "image/jpeg" + }, + "request": { + "contentType": "application/json; charset=utf-8" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCatalogImageResponse" + } + } + } + } + } + } + }, + "/v2/catalog/info": { + "get": { + "tags": [ + "Catalog" + ], + "summary": "CatalogInfo", + "operationId": "CatalogInfo", + "description": "Retrieves information about the Square Catalog API, such as batch size\nlimits that can be used by the `BatchUpsertCatalogObjects` endpoint.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_READ" + ] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CatalogInfoResponse" + } + } + } + } + } + } + }, + "/v2/catalog/list": { + "get": { + "tags": [ + "Catalog" + ], + "summary": "ListCatalog", + "operationId": "ListCatalog", + "description": "Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified types in the catalog.\n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values,\nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects)\nand set the `include_deleted_objects` attribute value to `true`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "types", + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "catalog_version", + "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", + "schema": { + "type": "integer", + "format": "int64" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCatalogResponse" + } + } + } + } + } + } + }, + "/v2/catalog/object": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "UpsertCatalogObject", + "operationId": "UpsertCatalogObject", + "description": "Creates a new or updates the specified [CatalogObject](entity:CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertCatalogObjectRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertCatalogObjectResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "GENERIC_DECLINE" + }, + { + "error-code": "INVALID_LOCATION" + } + ] + } + }, + "/v2/catalog/object/{object_id}": { + "delete": { + "tags": [ + "Catalog" + ], + "summary": "DeleteCatalogObject", + "operationId": "DeleteCatalogObject", + "description": "Deletes a single [CatalogObject](entity:CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](entity:CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](entity:CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "object_id", + "description": "The ID of the catalog object to be deleted. When an object is deleted, other\nobjects in the graph that depend on that object will be deleted as well (for example, deleting a\ncatalog item will delete its catalog item variations).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCatalogObjectResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Catalog" + ], + "summary": "RetrieveCatalogObject", + "operationId": "RetrieveCatalogObject", + "description": "Returns a single [CatalogItem](entity:CatalogItem) as a\n[CatalogObject](entity:CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](entity:CatalogItem)\ninformation including: [CatalogItemVariation](entity:CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](entity:CatalogModifierList) objects, and the ids of\nany [CatalogTax](entity:CatalogTax) objects that apply to it.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_READ" + ] + } + ], + "parameters": [ + { + "name": "object_id", + "description": "The object ID of any type of catalog objects to be retrieved.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "include_related_objects", + "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field\nof the response. These objects are put in the `related_objects` field. Setting this to `true` is\nhelpful when the objects are needed for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included. For example,\n\nif the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "catalog_version", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "schema": { + "type": "integer", + "format": "int64" + }, + "in": "query", + "required": false + }, + { + "name": "include_category_path_to_root", + "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists\nof `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category\nand ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned\nin the response payload.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCatalogObjectResponse" + } + } + } + } + } + } + }, + "/v2/catalog/search": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "SearchCatalogObjects", + "operationId": "SearchCatalogObjects", + "description": "Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCatalogObjectsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCatalogObjectsResponse" + } + } + } + } + } + } + }, + "/v2/catalog/search-catalog-items": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "SearchCatalogItems", + "operationId": "SearchCatalogItems", + "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCatalogItemsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCatalogItemsResponse" + } + } + } + } + } + } + }, + "/v2/catalog/update-item-modifier-lists": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "UpdateItemModifierLists", + "operationId": "UpdateItemModifierLists", + "description": "Updates the [CatalogModifierList](entity:CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](entity:CatalogItem) without having\nto perform an upsert on the entire item.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateItemModifierListsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateItemModifierListsResponse" + } + } + } + } + } + } + }, + "/v2/catalog/update-item-taxes": { + "post": { + "tags": [ + "Catalog" + ], + "summary": "UpdateItemTaxes", + "operationId": "UpdateItemTaxes", + "description": "Updates the [CatalogTax](entity:CatalogTax) objects that apply to the\ntargeted [CatalogItem](entity:CatalogItem) without having to perform an\nupsert on the entire item.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ITEMS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateItemTaxesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateItemTaxesResponse" + } + } + } + } + } + } + }, + "/v2/customers": { + "get": { + "tags": [ + "Customers" + ], + "summary": "ListCustomers", + "operationId": "ListCustomers", + "description": "Lists customer profiles associated with a Square account.\n\nUnder normal operating conditions, newly created or updated customer profiles become available\nfor the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated\nprofiles can take closer to one minute or longer, especially during network incidents and outages.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "sort_field", + "description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`.", + "schema": { + "$ref": "#/components/schemas/CustomerSortField" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`.", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "count", + "description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCustomersResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Customers" + ], + "summary": "CreateCustomer", + "operationId": "CreateCustomer", + "description": "Creates a new customer for a business.\n\nYou must provide at least one of the following values in your request to this\nendpoint:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_EMAIL_ADDRESS" + }, + { + "error-code": "INVALID_PHONE_NUMBER" + }, + { + "error-code": "INVALID_TIME" + }, + { + "error-code": "VALUE_TOO_LONG" + } + ] + } + }, + "/v2/customers/bulk-create": { + "post": { + "tags": [ + "Customers" + ], + "summary": "BulkCreateCustomers", + "operationId": "BulkCreateCustomers", + "description": "Creates multiple [customer profiles](entity:Customer) for a business.\n\nThis endpoint takes a map of individual create requests and returns a map of responses.\n\nYou must provide at least one of the following values in each create request:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkCreateCustomersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkCreateCustomersResponse" + } + } + } + } + } + } + }, + "/v2/customers/bulk-delete": { + "post": { + "tags": [ + "Customers" + ], + "summary": "BulkDeleteCustomers", + "operationId": "BulkDeleteCustomers", + "description": "Deletes multiple customer profiles.\n\nThe endpoint takes a list of customer IDs and returns a map of responses.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteCustomersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteCustomersResponse" + } + } + } + } + } + } + }, + "/v2/customers/bulk-retrieve": { + "post": { + "tags": [ + "Customers" + ], + "summary": "BulkRetrieveCustomers", + "operationId": "BulkRetrieveCustomers", + "description": "Retrieves multiple customer profiles.\n\nThis endpoint takes a list of customer IDs and returns a map of responses.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveCustomersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveCustomersResponse" + } + } + } + } + } + } + }, + "/v2/customers/bulk-update": { + "post": { + "tags": [ + "Customers" + ], + "summary": "BulkUpdateCustomers", + "operationId": "BulkUpdateCustomers", + "description": "Updates multiple customer profiles.\n\nThis endpoint takes a map of individual update requests and returns a map of responses.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpdateCustomersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpdateCustomersResponse" + } + } + } + } + } + } + }, + "/v2/customers/custom-attribute-definitions": { + "get": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "ListCustomerCustomAttributeDefinitions", + "operationId": "ListCustomerCustomAttributeDefinitions", + "description": "Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCustomerCustomAttributeDefinitionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "CreateCustomerCustomAttributeDefinition", + "operationId": "CreateCustomerCustomAttributeDefinition", + "description": "Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or\n[BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes)\nto set the custom attribute for customer profiles in the seller's Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/customers/custom-attribute-definitions/{key}": { + "delete": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "DeleteCustomerCustomAttributeDefinition", + "operationId": "DeleteCustomerCustomAttributeDefinition", + "description": "Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller's Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCustomerCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "RetrieveCustomerCustomAttributeDefinition", + "operationId": "RetrieveCustomerCustomAttributeDefinition", + "description": "Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCustomerCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "UpdateCustomerCustomAttributeDefinition", + "operationId": "UpdateCustomerCustomAttributeDefinition", + "description": "Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCustomerCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCustomerCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/customers/custom-attributes/bulk-upsert": { + "post": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "BulkUpsertCustomerCustomAttributes", + "operationId": "BulkUpsertCustomerCustomAttributes", + "description": "Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a customer ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertCustomerCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertCustomerCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/customers/groups": { + "get": { + "tags": [ + "CustomerGroups" + ], + "summary": "ListCustomerGroups", + "operationId": "ListCustomerGroups", + "description": "Retrieves the list of customer groups of a business.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCustomerGroupsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "CustomerGroups" + ], + "summary": "CreateCustomerGroup", + "operationId": "CreateCustomerGroup", + "description": "Creates a new customer group for a business.\n\nThe request must include the `name` value of the group.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerGroupRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerGroupResponse" + } + } + } + } + } + } + }, + "/v2/customers/groups/{group_id}": { + "delete": { + "tags": [ + "CustomerGroups" + ], + "summary": "DeleteCustomerGroup", + "operationId": "DeleteCustomerGroup", + "description": "Deletes a customer group as identified by the `group_id` value.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "group_id", + "description": "The ID of the customer group to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCustomerGroupResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "CustomerGroups" + ], + "summary": "RetrieveCustomerGroup", + "operationId": "RetrieveCustomerGroup", + "description": "Retrieves a specific customer group as identified by the `group_id` value.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "group_id", + "description": "The ID of the customer group to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCustomerGroupResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "CustomerGroups" + ], + "summary": "UpdateCustomerGroup", + "operationId": "UpdateCustomerGroup", + "description": "Updates a customer group as identified by the `group_id` value.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "group_id", + "description": "The ID of the customer group to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCustomerGroupRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCustomerGroupResponse" + } + } + } + } + } + } + }, + "/v2/customers/search": { + "post": { + "tags": [ + "Customers" + ], + "summary": "SearchCustomers", + "operationId": "SearchCustomers", + "description": "Searches the customer profiles associated with a Square account using one or more supported query filters.\n\nCalling `SearchCustomers` without any explicit query filter returns all\ncustomer profiles ordered alphabetically based on `given_name` and\n`family_name`.\n\nUnder normal operating conditions, newly created or updated customer profiles become available\nfor the search operation in well under 30 seconds. Occasionally, propagation of the new or updated\nprofiles can take closer to one minute or longer, especially during network incidents and outages.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCustomersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCustomersResponse" + } + } + } + } + } + } + }, + "/v2/customers/segments": { + "get": { + "tags": [ + "CustomerSegments" + ], + "summary": "ListCustomerSegments", + "operationId": "ListCustomerSegments", + "description": "Retrieves the list of customer segments of a business.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCustomerSegmentsResponse" + } + } + } + } + } + } + }, + "/v2/customers/segments/{segment_id}": { + "get": { + "tags": [ + "CustomerSegments" + ], + "summary": "RetrieveCustomerSegment", + "operationId": "RetrieveCustomerSegment", + "description": "Retrieves a specific customer segment as identified by the `segment_id` value.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "segment_id", + "description": "The Square-issued ID of the customer segment.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCustomerSegmentResponse" + } + } + } + } + } + } + }, + "/v2/customers/{customer_id}": { + "delete": { + "tags": [ + "Customers" + ], + "summary": "DeleteCustomer", + "operationId": "DeleteCustomer", + "description": "Deletes a customer profile from a business.\n\nTo delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the customer to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).", + "schema": { + "type": "integer", + "format": "int64" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCustomerResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Customers" + ], + "summary": "RetrieveCustomer", + "operationId": "RetrieveCustomer", + "description": "Returns details for a single customer.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the customer to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCustomerResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Customers" + ], + "summary": "UpdateCustomer", + "operationId": "UpdateCustomer", + "description": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null`.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the customer to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCustomerRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCustomerResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_EMAIL_ADDRESS" + }, + { + "error-code": "INVALID_PHONE_NUMBER" + }, + { + "error-code": "INVALID_TIME" + }, + { + "error-code": "VALUE_TOO_LONG" + } + ] + } + }, + "/v2/customers/{customer_id}/cards": { + "post": { + "tags": [ + "Customers" + ], + "summary": "CreateCustomerCard", + "operationId": "CreateCustomerCard", + "description": "Adds a card on file to an existing customer.\n\nAs with charges, calls to `CreateCustomerCard` are idempotent. Multiple\ncalls with the same card nonce return the same card record that was created\nwith the provided nonce during the _first_ call.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "replacedBy": "CreateCard", + "guideUrl": "https://developer.squareup.com/docs/customers-api/what-it-does#deprecated-createcustomercard-endpoint" + }, + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The Square ID of the customer profile the card is linked to.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerCardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerCardResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_EXPIRED" + }, + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CARD_TOKEN_EXPIRED" + }, + { + "error-code": "CARD_TOKEN_USED" + }, + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "INVALID_CARD_DATA" + }, + { + "error-code": "INVALID_EXPIRATION" + }, + { + "error-code": "UNSUPPORTED_ENTRY_METHOD" + }, + { + "error-code": "VERIFY_AVS_FAILURE" + }, + { + "error-code": "VERIFY_CVV_FAILURE" + } + ] + } + }, + "/v2/customers/{customer_id}/cards/{card_id}": { + "delete": { + "tags": [ + "Customers" + ], + "summary": "DeleteCustomerCard", + "operationId": "DeleteCustomerCard", + "description": "Removes a card on file from a customer.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "replacedBy": "DisableCard", + "guideUrl": "https://developer.squareup.com/docs/customers-api/what-it-does#deprecated-deletecustomercard-endpoint" + }, + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the customer that the card on file belongs to.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "card_id", + "description": "The ID of the card on file to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCustomerCardResponse" + } + } + } + } + } + } + }, + "/v2/customers/{customer_id}/custom-attributes": { + "get": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "ListCustomerCustomAttributes", + "operationId": "ListCustomerCustomAttributes", + "description": "Lists the [custom attributes](entity:CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the target [customer profile](entity:Customer).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "with_definitions", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCustomerCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/customers/{customer_id}/custom-attributes/{key}": { + "delete": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "DeleteCustomerCustomAttribute", + "operationId": "DeleteCustomerCustomAttribute", + "description": "Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the target [customer profile](entity:Customer).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCustomerCustomAttributeResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "RetrieveCustomerCustomAttribute", + "operationId": "RetrieveCustomerCustomAttribute", + "description": "Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the target [customer profile](entity:Customer).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "with_definition", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "version", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveCustomerCustomAttributeResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "CustomerCustomAttributes" + ], + "summary": "UpsertCustomerCustomAttribute", + "operationId": "UpsertCustomerCustomAttribute", + "description": "Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the target [customer profile](entity:Customer).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertCustomerCustomAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertCustomerCustomAttributeResponse" + } + } + } + } + } + } + }, + "/v2/customers/{customer_id}/groups/{group_id}": { + "delete": { + "tags": [ + "Customers" + ], + "summary": "RemoveGroupFromCustomer", + "operationId": "RemoveGroupFromCustomer", + "description": "Removes a group membership from a customer.\n\nThe customer is identified by the `customer_id` value\nand the customer group is identified by the `group_id` value.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the customer to remove from the group.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "group_id", + "description": "The ID of the customer group to remove the customer from.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveGroupFromCustomerResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Customers" + ], + "summary": "AddGroupToCustomer", + "operationId": "AddGroupToCustomer", + "description": "Adds a group membership to a customer.\n\nThe customer is identified by the `customer_id` value\nand the customer group is identified by the `group_id` value.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "customer_id", + "description": "The ID of the customer to add to a group.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "group_id", + "description": "The ID of the customer group to add the customer to.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddGroupToCustomerResponse" + } + } + } + } + } + } + }, + "/v2/devices": { + "get": { + "tags": [ + "Devices" + ], + "summary": "ListDevices", + "operationId": "ListDevices", + "description": "List devices associated with the merchant. Currently, only Terminal API\ndevices are supported.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "DEVICES_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The number of results to return in a single page.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "If present, only returns devices at the target location.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListDevicesResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + } + ] + } + }, + "/v2/devices/codes": { + "get": { + "tags": [ + "Devices" + ], + "summary": "ListDeviceCodes", + "operationId": "ListDeviceCodes", + "description": "Lists all DeviceCodes associated with the merchant.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DEVICE_CREDENTIAL_MANAGEMENT" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "product_type", + "description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty.", + "schema": { + "$ref": "#/components/schemas/ProductType" + }, + "in": "query", + "required": false + }, + { + "name": "status", + "description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.", + "schema": { + "$ref": "#/components/schemas/DeviceCodeStatus" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListDeviceCodesResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_CURSOR" + }, + { + "error-code": "BAD_REQUEST" + } + ] + }, + "post": { + "tags": [ + "Devices" + ], + "summary": "CreateDeviceCode", + "operationId": "CreateDeviceCode", + "description": "Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected\nterminal mode.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DEVICE_CREDENTIAL_MANAGEMENT" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDeviceCodeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDeviceCodeResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "IDEMPOTENCY_KEY_REUSED" + }, + { + "error-code": "INVALID_VALUE" + }, + { + "error-code": "UNAUTHORIZED" + } + ] + } + }, + "/v2/devices/codes/{id}": { + "get": { + "tags": [ + "Devices" + ], + "summary": "GetDeviceCode", + "operationId": "GetDeviceCode", + "description": "Retrieves DeviceCode with the associated ID.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DEVICE_CREDENTIAL_MANAGEMENT" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The unique identifier for the device code.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDeviceCodeResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + }, + { + "error-code": "UNAUTHORIZED" + } + ] + } + }, + "/v2/devices/{device_id}": { + "get": { + "tags": [ + "Devices" + ], + "summary": "GetDevice", + "operationId": "GetDevice", + "description": "Retrieves Device with the associated `device_id`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "DEVICES_READ" + ] + } + ], + "parameters": [ + { + "name": "device_id", + "description": "The unique ID for the desired `Device`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDeviceResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/disputes": { + "get": { + "tags": [ + "Disputes" + ], + "summary": "ListDisputes", + "operationId": "ListDisputes", + "description": "Returns a list of disputes associated with a particular account.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "states", + "description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes.", + "schema": { + "$ref": "#/components/schemas/DisputeState" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListDisputesResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}": { + "get": { + "tags": [ + "Disputes" + ], + "summary": "RetrieveDispute", + "operationId": "RetrieveDispute", + "description": "Returns details about a specific dispute.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_READ" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute you want more details about.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveDisputeResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}/accept": { + "post": { + "tags": [ + "Disputes" + ], + "summary": "AcceptDispute", + "operationId": "AcceptDispute", + "description": "Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and\nupdates the dispute state to ACCEPTED.\n\nSquare debits the disputed amount from the seller’s Square account. If the Square account\ndoes not have sufficient funds, Square debits the associated bank account.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute you want to accept.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AcceptDisputeResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}/evidence": { + "get": { + "tags": [ + "Disputes" + ], + "summary": "ListDisputeEvidence", + "operationId": "ListDisputeEvidence", + "description": "Returns a list of evidence associated with a dispute.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_READ" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListDisputeEvidenceResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}/evidence-files": { + "post": { + "tags": [ + "Disputes" + ], + "summary": "CreateDisputeEvidenceFile", + "operationId": "CreateDisputeEvidenceFile", + "description": "Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP\nmultipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute for which you want to upload evidence.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "request": { + "$ref": "#/components/schemas/CreateDisputeEvidenceFileRequest" + }, + "image_file": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "image_file": { + "contentType": "image/jpeg" + }, + "request": { + "contentType": "application/json; charset=utf-8" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDisputeEvidenceFileResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}/evidence-text": { + "post": { + "tags": [ + "Disputes" + ], + "summary": "CreateDisputeEvidenceText", + "operationId": "CreateDisputeEvidenceText", + "description": "Uploads text to use as evidence for a dispute challenge.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute for which you want to upload evidence.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDisputeEvidenceTextRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDisputeEvidenceTextResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}/evidence/{evidence_id}": { + "delete": { + "tags": [ + "Disputes" + ], + "summary": "DeleteDisputeEvidence", + "operationId": "DeleteDisputeEvidence", + "description": "Removes specified evidence from a dispute.\nSquare does not send the bank any evidence that is removed.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute from which you want to remove evidence.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "evidence_id", + "description": "The ID of the evidence you want to remove.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteDisputeEvidenceResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Disputes" + ], + "summary": "RetrieveDisputeEvidence", + "operationId": "RetrieveDisputeEvidence", + "description": "Returns the metadata for the evidence specified in the request URL path.\n\nYou must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_READ" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute from which you want to retrieve evidence metadata.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "evidence_id", + "description": "The ID of the evidence to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveDisputeEvidenceResponse" + } + } + } + } + } + } + }, + "/v2/disputes/{dispute_id}/submit-evidence": { + "post": { + "tags": [ + "Disputes" + ], + "summary": "SubmitEvidence", + "operationId": "SubmitEvidence", + "description": "Submits evidence to the cardholder's bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and\n[CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "DISPUTES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "dispute_id", + "description": "The ID of the dispute for which you want to submit evidence.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubmitEvidenceResponse" + } + } + } + } + } + } + }, + "/v2/employees": { + "get": { + "tags": [ + "Employees" + ], + "summary": "ListEmployees", + "operationId": "ListEmployees", + "description": "", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2020-08-26", + "retirementDate": "2021-08-26", + "replacedBy": "SearchTeamMembers", + "guideUrl": "https://developer.squareup.com/docs/team/migrate-from-v2-employees" + }, + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "status", + "description": "Specifies the EmployeeStatus to filter the employee by.", + "schema": { + "$ref": "#/components/schemas/EmployeeStatus" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The number of employees to be returned on each page.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The token required to retrieve the specified page of results.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListEmployeesResponse" + } + } + } + } + } + } + }, + "/v2/employees/{id}": { + "get": { + "tags": [ + "Employees" + ], + "summary": "RetrieveEmployee", + "operationId": "RetrieveEmployee", + "description": "", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2020-08-26", + "retirementDate": "2021-08-26", + "replacedBy": "RetrieveTeamMember", + "guideUrl": "https://developer.squareup.com/docs/team/migrate-from-v2-employees" + }, + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "UUID for the employee that was requested.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveEmployeeResponse" + } + } + } + } + } + } + }, + "/v2/events": { + "post": { + "tags": [ + "Events" + ], + "summary": "SearchEvents", + "operationId": "SearchEvents", + "description": "Search for Square API events that occur within a 28-day timeframe.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchEventsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchEventsResponse" + } + } + } + } + } + } + }, + "/v2/events/disable": { + "put": { + "tags": [ + "Events" + ], + "summary": "DisableEvents", + "operationId": "DisableEvents", + "description": "Disables events to prevent them from being searchable.\nAll events are disabled by default. You must enable events to make them searchable.\nDisabling events for a specific time period prevents them from being searchable, even if you re-enable them later.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisableEventsResponse" + } + } + } + } + } + } + }, + "/v2/events/enable": { + "put": { + "tags": [ + "Events" + ], + "summary": "EnableEvents", + "operationId": "EnableEvents", + "description": "Enables events to make them searchable. Only events that occur while in the enabled state are searchable.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnableEventsResponse" + } + } + } + } + } + } + }, + "/v2/events/types": { + "get": { + "tags": [ + "Events" + ], + "summary": "ListEventTypes", + "operationId": "ListEventTypes", + "description": "Lists all event types that you can subscribe to as webhooks or query using the Events API.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "api_version", + "description": "The API version for which to list event types. Setting this field overrides the default version used by the application.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListEventTypesResponse" + } + } + } + } + } + } + }, + "/v2/gift-cards": { + "get": { + "tags": [ + "GiftCards" + ], + "summary": "ListGiftCards", + "operationId": "ListGiftCards", + "description": "Lists all gift cards. You can specify optional filters to retrieve \na subset of the gift cards. Results are sorted by `created_at` in ascending order.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_READ" + ] + } + ], + "parameters": [ + { + "name": "type", + "description": "If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "state", + "description": "If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "If a limit is provided, the endpoint returns only the specified number of results per page.\nThe maximum value is 200. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "customer_id", + "description": "If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListGiftCardsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "GiftCards" + ], + "summary": "CreateGiftCard", + "operationId": "CreateGiftCard", + "description": "Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card\nhas a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE`\nactivity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment)\nto refund a payment to the new gift card.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateGiftCardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateGiftCardResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "TEMPORARY_ERROR" + } + ] + } + }, + "/v2/gift-cards/activities": { + "get": { + "tags": [ + "GiftCardActivities" + ], + "summary": "ListGiftCardActivities", + "operationId": "ListGiftCardActivities", + "description": "Lists gift card activities. By default, you get gift card activities for all\ngift cards in the seller's account. You can optionally specify query parameters to\nfilter the list. For example, you can get a list of gift card activities for a gift card,\nfor all gift cards in a specific region, or for activities within a time window.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_READ" + ] + } + ], + "parameters": [ + { + "name": "gift_card_id", + "description": "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "type", + "description": "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "begin_time", + "description": "The timestamp for the beginning of the reporting period, in RFC 3339 format.\nThis start time is inclusive. The default value is the current time minus one year.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "end_time", + "description": "The timestamp for the end of the reporting period, in RFC 3339 format.\nThis end time is inclusive. The default value is the current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "The order in which the endpoint returns the activities, based on `created_at`.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListGiftCardActivitiesResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "GiftCardActivities" + ], + "summary": "CreateGiftCardActivity", + "operationId": "CreateGiftCardActivity", + "description": "Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard).\nFor example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateGiftCardActivityRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateGiftCardActivityResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INSUFFICIENT_FUNDS" + }, + { + "error-code": "PAYMENT_LIMIT_EXCEEDED" + }, + { + "error-code": "REFUND_AMOUNT_INVALID" + }, + { + "error-code": "TEMPORARY_ERROR" + } + ] + } + }, + "/v2/gift-cards/from-gan": { + "post": { + "tags": [ + "GiftCards" + ], + "summary": "RetrieveGiftCardFromGAN", + "operationId": "RetrieveGiftCardFromGAN", + "description": "Retrieves a gift card using the gift card account number (GAN).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveGiftCardFromGANRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveGiftCardFromGANResponse" + } + } + } + } + } + } + }, + "/v2/gift-cards/from-nonce": { + "post": { + "tags": [ + "GiftCards" + ], + "summary": "RetrieveGiftCardFromNonce", + "operationId": "RetrieveGiftCardFromNonce", + "description": "Retrieves a gift card using a secure payment token that represents the gift card.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveGiftCardFromNonceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveGiftCardFromNonceResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_TOKEN_EXPIRED" + }, + { + "error-code": "CARD_TOKEN_USED" + } + ] + } + }, + "/v2/gift-cards/{gift_card_id}/link-customer": { + "post": { + "tags": [ + "GiftCards" + ], + "summary": "LinkCustomerToGiftCard", + "operationId": "LinkCustomerToGiftCard", + "description": "Links a customer to a gift card, which is also referred to as adding a card on file.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "gift_card_id", + "description": "The ID of the gift card to be linked.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkCustomerToGiftCardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkCustomerToGiftCardResponse" + } + } + } + } + } + } + }, + "/v2/gift-cards/{gift_card_id}/unlink-customer": { + "post": { + "tags": [ + "GiftCards" + ], + "summary": "UnlinkCustomerFromGiftCard", + "operationId": "UnlinkCustomerFromGiftCard", + "description": "Unlinks a customer from a gift card, which is also referred to as removing a card on file.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "gift_card_id", + "description": "The ID of the gift card to be unlinked.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkCustomerFromGiftCardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkCustomerFromGiftCardResponse" + } + } + } + } + } + } + }, + "/v2/gift-cards/{id}": { + "get": { + "tags": [ + "GiftCards" + ], + "summary": "RetrieveGiftCard", + "operationId": "RetrieveGiftCard", + "description": "Retrieves a gift card using the gift card ID.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "GIFTCARDS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The ID of the gift card to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveGiftCardResponse" + } + } + } + } + } + } + }, + "/v2/inventory/adjustment/{adjustment_id}": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "DeprecatedRetrieveInventoryAdjustment", + "operationId": "DeprecatedRetrieveInventoryAdjustment", + "description": "Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL\nis updated to conform to the standard convention.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "retirementDate": "2023-11-15", + "replacedBy": "RetrieveInventoryAdjustment" + }, + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "adjustment_id", + "description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryAdjustmentResponse" + } + } + } + } + } + } + }, + "/v2/inventory/adjustments/{adjustment_id}": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "RetrieveInventoryAdjustment", + "operationId": "RetrieveInventoryAdjustment", + "description": "Returns the [InventoryAdjustment](entity:InventoryAdjustment) object\nwith the provided `adjustment_id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "adjustment_id", + "description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryAdjustmentResponse" + } + } + } + } + } + } + }, + "/v2/inventory/batch-change": { + "post": { + "tags": [ + "Inventory" + ], + "summary": "DeprecatedBatchChangeInventory", + "operationId": "DeprecatedBatchChangeInventory", + "description": "Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL\nis updated to conform to the standard convention.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "retirementDate": "2023-11-15", + "replacedBy": "BatchChangeInventory" + }, + "security": [ + { + "oauth2": [ + "INVENTORY_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchChangeInventoryRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchChangeInventoryResponse" + } + } + } + } + } + } + }, + "/v2/inventory/batch-retrieve-changes": { + "post": { + "tags": [ + "Inventory" + ], + "summary": "DeprecatedBatchRetrieveInventoryChanges", + "operationId": "DeprecatedBatchRetrieveInventoryChanges", + "description": "Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL\nis updated to conform to the standard convention.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "retirementDate": "2023-11-15", + "replacedBy": "BatchRetrieveInventoryChanges" + }, + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryChangesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryChangesResponse" + } + } + } + } + } + } + }, + "/v2/inventory/batch-retrieve-counts": { + "post": { + "tags": [ + "Inventory" + ], + "summary": "DeprecatedBatchRetrieveInventoryCounts", + "operationId": "DeprecatedBatchRetrieveInventoryCounts", + "description": "Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL\nis updated to conform to the standard convention.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "retirementDate": "2023-11-15", + "replacedBy": "BatchRetrieveInventoryCounts" + }, + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryCountsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryCountsResponse" + } + } + } + } + } + } + }, + "/v2/inventory/changes/batch-create": { + "post": { + "tags": [ + "Inventory" + ], + "summary": "BatchChangeInventory", + "operationId": "BatchChangeInventory", + "description": "Applies adjustments and counts to the provided item quantities.\n\nOn success: returns the current calculated counts for all objects\nreferenced in the request.\nOn failure: returns a list of related errors.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVENTORY_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchChangeInventoryRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchChangeInventoryResponse" + } + } + } + } + } + } + }, + "/v2/inventory/changes/batch-retrieve": { + "post": { + "tags": [ + "Inventory" + ], + "summary": "BatchRetrieveInventoryChanges", + "operationId": "BatchRetrieveInventoryChanges", + "description": "Returns historical physical counts and adjustments based on the\nprovided filter criteria.\n\nResults are paginated and sorted in ascending order according their\n`occurred_at` timestamp (oldest first).\n\nBatchRetrieveInventoryChanges is a catch-all query endpoint for queries\nthat cannot be handled by other, simpler endpoints.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryChangesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryChangesResponse" + } + } + } + } + } + } + }, + "/v2/inventory/counts/batch-retrieve": { + "post": { + "tags": [ + "Inventory" + ], + "summary": "BatchRetrieveInventoryCounts", + "operationId": "BatchRetrieveInventoryCounts", + "description": "Returns current counts for the provided\n[CatalogObject](entity:CatalogObject)s at the requested\n[Location](entity:Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryCountsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveInventoryCountsResponse" + } + } + } + } + } + } + }, + "/v2/inventory/physical-count/{physical_count_id}": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "DeprecatedRetrieveInventoryPhysicalCount", + "operationId": "DeprecatedRetrieveInventoryPhysicalCount", + "description": "Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL\nis updated to conform to the standard convention.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "retirementDate": "2023-11-15", + "replacedBy": "RetrieveInventoryPhysicalCount" + }, + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "physical_count_id", + "description": "ID of the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryPhysicalCountResponse" + } + } + } + } + } + } + }, + "/v2/inventory/physical-counts/{physical_count_id}": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "RetrieveInventoryPhysicalCount", + "operationId": "RetrieveInventoryPhysicalCount", + "description": "Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "physical_count_id", + "description": "ID of the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryPhysicalCountResponse" + } + } + } + } + } + } + }, + "/v2/inventory/transfers/{transfer_id}": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "RetrieveInventoryTransfer", + "operationId": "RetrieveInventoryTransfer", + "description": "Returns the [InventoryTransfer](entity:InventoryTransfer) object\nwith the provided `transfer_id`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "transfer_id", + "description": "ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryTransferResponse" + } + } + } + } + } + } + }, + "/v2/inventory/{catalog_object_id}": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "RetrieveInventoryCount", + "operationId": "RetrieveInventoryCount", + "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](entity:CatalogObject) at a given set of\n[Location](entity:Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "catalog_object_id", + "description": "ID of the [CatalogObject](entity:CatalogObject) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "location_ids", + "description": "The [Location](entity:Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryCountResponse" + } + } + } + } + } + } + }, + "/v2/inventory/{catalog_object_id}/changes": { + "get": { + "tags": [ + "Inventory" + ], + "summary": "RetrieveInventoryChanges", + "operationId": "RetrieveInventoryChanges", + "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](entity:CatalogObject) at the requested\n[Location](entity:Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-06-16", + "retirementDate": "2023-11-15", + "replacedBy": "BatchRetrieveInventoryChanges" + }, + "security": [ + { + "oauth2": [ + "INVENTORY_READ" + ] + } + ], + "parameters": [ + { + "name": "catalog_object_id", + "description": "ID of the [CatalogObject](entity:CatalogObject) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "location_ids", + "description": "The [Location](entity:Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveInventoryChangesResponse" + } + } + } + } + } + } + }, + "/v2/invoices": { + "get": { + "tags": [ + "Invoices" + ], + "summary": "ListInvoices", + "operationId": "ListInvoices", + "description": "Returns a list of invoices for a given location. The response \nis paginated. If truncated, the response includes a `cursor` that you \nuse in a subsequent request to retrieve the next set of invoices.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVOICES_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location for which to list invoices.", + "schema": { + "type": "string" + }, + "in": "query", + "required": true + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListInvoicesResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Invoices" + ], + "summary": "CreateInvoice", + "operationId": "CreateInvoice", + "description": "Creates a draft [invoice](entity:Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateInvoiceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateInvoiceResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "MERCHANT_SUBSCRIPTION_NOT_FOUND" + } + ] + } + }, + "/v2/invoices/search": { + "post": { + "tags": [ + "Invoices" + ], + "summary": "SearchInvoices", + "operationId": "SearchInvoices", + "description": "Searches for invoices from a location specified in \nthe filter. You can optionally specify customers in the filter for whom to \nretrieve invoices. In the current implementation, you can only specify one location and \noptionally one customer.\n\nThe response is paginated. If truncated, the response includes a `cursor` \nthat you use in a subsequent request to retrieve the next set of invoices.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVOICES_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchInvoicesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchInvoicesResponse" + } + } + } + } + } + } + }, + "/v2/invoices/{invoice_id}": { + "delete": { + "tags": [ + "Invoices" + ], + "summary": "DeleteInvoice", + "operationId": "DeleteInvoice", + "description": "Deletes the specified invoice. When an invoice is deleted, the \nassociated order status changes to CANCELED. You can only delete a draft \ninvoice (you cannot delete a published invoice, including one that is scheduled for processing).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the invoice to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteInvoiceResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Invoices" + ], + "summary": "GetInvoice", + "operationId": "GetInvoice", + "description": "Retrieves an invoice by invoice ID.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVOICES_READ" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the invoice to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoiceResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Invoices" + ], + "summary": "UpdateInvoice", + "operationId": "UpdateInvoice", + "description": "Updates an invoice. This endpoint supports sparse updates, so you only need\nto specify the fields you want to change along with the required `version` field.\nSome restrictions apply to updating invoices. For example, you cannot change the\n`order_id` or `location_id` field.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the invoice to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateInvoiceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateInvoiceResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_DECLINED" + }, + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "MERCHANT_SUBSCRIPTION_NOT_FOUND" + } + ] + } + }, + "/v2/invoices/{invoice_id}/attachments": { + "post": { + "tags": [ + "Invoices" + ], + "summary": "CreateInvoiceAttachment", + "operationId": "CreateInvoiceAttachment", + "description": "Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads\nwith a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file\nin a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.\n\nInvoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices\nin the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.\n\n__NOTE:__ When testing in the Sandbox environment, the total file size is limited to 1 KB.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the [invoice](entity:Invoice) to attach the file to.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "request": { + "$ref": "#/components/schemas/CreateInvoiceAttachmentRequest" + }, + "image_file": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "image_file": { + "contentType": "image/jpeg" + }, + "request": { + "contentType": "application/json; charset=utf-8" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateInvoiceAttachmentResponse" + } + } + } + } + } + } + }, + "/v2/invoices/{invoice_id}/attachments/{attachment_id}": { + "delete": { + "tags": [ + "Invoices" + ], + "summary": "DeleteInvoiceAttachment", + "operationId": "DeleteInvoiceAttachment", + "description": "Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only\nfrom invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the [invoice](entity:Invoice) to delete the attachment from.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "attachment_id", + "description": "The ID of the [attachment](entity:InvoiceAttachment) to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteInvoiceAttachmentResponse" + } + } + } + } + } + } + }, + "/v2/invoices/{invoice_id}/cancel": { + "post": { + "tags": [ + "Invoices" + ], + "summary": "CancelInvoice", + "operationId": "CancelInvoice", + "description": "Cancels an invoice. The seller cannot collect payments for \nthe canceled invoice.\n\nYou cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the [invoice](entity:Invoice) to cancel.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelInvoiceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelInvoiceResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "VERSION_MISMATCH" + } + ] + } + }, + "/v2/invoices/{invoice_id}/publish": { + "post": { + "tags": [ + "Invoices" + ], + "summary": "PublishInvoice", + "operationId": "PublishInvoice", + "description": "Publishes the specified draft invoice. \n\nAfter an invoice is published, Square \nfollows up based on the invoice configuration. For example, Square \nsends the invoice to the customer's email address, charges the customer's card on file, or does \nnothing. Square also makes the invoice available on a Square-hosted invoice page. \n\nThe invoice `status` also changes from `DRAFT` to a status \nbased on the invoice configuration. For example, the status changes to `UNPAID` if \nSquare emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the \ninvoice amount.\n\nIn addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ`\nand `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "invoice_id", + "description": "The ID of the invoice to publish.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishInvoiceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishInvoiceResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_DECLINED" + }, + { + "error-code": "INVALID_CARD" + } + ] + } + }, + "/v2/labor/break-types": { + "get": { + "tags": [ + "Labor" + ], + "summary": "ListBreakTypes", + "operationId": "ListBreakTypes", + "description": "Returns a paginated list of `BreakType` instances for a business.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pointer to the next page of `BreakType` results to fetch.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListBreakTypesResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Labor" + ], + "summary": "CreateBreakType", + "operationId": "CreateBreakType", + "description": "Creates a new `BreakType`.\n\nA `BreakType` is a template for creating `Break` objects.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `break_name`\n- `expected_duration`\n- `is_paid`\n\nYou can only have three `BreakType` instances per location. If you attempt to add a fourth\n`BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\"\nis returned.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateBreakTypeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateBreakTypeResponse" + } + } + } + } + } + } + }, + "/v2/labor/break-types/{id}": { + "delete": { + "tags": [ + "Labor" + ], + "summary": "DeleteBreakType", + "operationId": "DeleteBreakType", + "description": "Deletes an existing `BreakType`.\n\nA `BreakType` can be deleted even if it is referenced from a `Shift`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `BreakType` being deleted.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteBreakTypeResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Labor" + ], + "summary": "GetBreakType", + "operationId": "GetBreakType", + "description": "Returns a single `BreakType` specified by `id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `BreakType` being retrieved.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetBreakTypeResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Labor" + ], + "summary": "UpdateBreakType", + "operationId": "UpdateBreakType", + "description": "Updates an existing `BreakType`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_WRITE", + "TIMECARDS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": " The UUID for the `BreakType` being updated.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateBreakTypeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateBreakTypeResponse" + } + } + } + } + } + } + }, + "/v2/labor/employee-wages": { + "get": { + "tags": [ + "Labor" + ], + "summary": "ListEmployeeWages", + "operationId": "ListEmployeeWages", + "description": "Returns a paginated list of `EmployeeWage` instances for a business.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2020-08-26", + "retirementDate": "TBD", + "replacedBy": "ListTeamMemberWages", + "guideUrl": "https://developer.squareup.com/docs/labor-api/migrate-to-teams" + }, + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "employee_id", + "description": "Filter the returned wages to only those that are associated with the specified employee.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of `EmployeeWage` results to return per page. The number can range between\n1 and 200. The default is 200.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pointer to the next page of `EmployeeWage` results to fetch.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListEmployeeWagesResponse" + } + } + } + } + } + } + }, + "/v2/labor/employee-wages/{id}": { + "get": { + "tags": [ + "Labor" + ], + "summary": "GetEmployeeWage", + "operationId": "GetEmployeeWage", + "description": "Returns a single `EmployeeWage` specified by `id`.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2020-08-26", + "retirementDate": "TBD", + "replacedBy": "GetTeamMemberWage", + "guideUrl": "https://developer.squareup.com/docs/labor-api/migrate-to-teams" + }, + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `EmployeeWage` being retrieved.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetEmployeeWageResponse" + } + } + } + } + } + } + }, + "/v2/labor/shifts": { + "post": { + "tags": [ + "Labor" + ], + "summary": "CreateShift", + "operationId": "CreateShift", + "description": "Creates a new `Shift`.\n\nA `Shift` represents a complete workday for a single team member.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `team_member_id`\n- `start_at`\n\nAn attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:\n- The `status` of the new `Shift` is `OPEN` and the team member has another\nshift with an `OPEN` status.\n- The `start_at` date is in the future.\n- The `start_at` or `end_at` date overlaps another shift for the same team member.\n- The `Break` instances are set in the request and a break `start_at`\nis before the `Shift.start_at`, a break `end_at` is after\nthe `Shift.end_at`, or both.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateShiftRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateShiftResponse" + } + } + } + } + } + } + }, + "/v2/labor/shifts/search": { + "post": { + "tags": [ + "Labor" + ], + "summary": "SearchShifts", + "operationId": "SearchShifts", + "description": "Returns a paginated list of `Shift` records for a business.\nThe list to be returned can be filtered by:\n- Location IDs\n- Team member IDs\n- Shift status (`OPEN` or `CLOSED`)\n- Shift start\n- Shift end\n- Workday details\n\nThe list can be sorted by:\n- `START_AT`\n- `END_AT`\n- `CREATED_AT`\n- `UPDATED_AT`", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchShiftsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchShiftsResponse" + } + } + } + } + } + } + }, + "/v2/labor/shifts/{id}": { + "delete": { + "tags": [ + "Labor" + ], + "summary": "DeleteShift", + "operationId": "DeleteShift", + "description": "Deletes a `Shift`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `Shift` being deleted.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteShiftResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Labor" + ], + "summary": "GetShift", + "operationId": "GetShift", + "description": "Returns a single `Shift` specified by `id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `Shift` being retrieved.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetShiftResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Labor" + ], + "summary": "UpdateShift", + "operationId": "UpdateShift", + "description": "Updates an existing `Shift`.\n\nWhen adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have\nthe `end_at` property set to a valid RFC-3339 datetime string.\n\nWhen closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at`\nset on each `Break`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_WRITE", + "TIMECARDS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The ID of the object being updated.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateShiftRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateShiftResponse" + } + } + } + } + } + } + }, + "/v2/labor/team-member-wages": { + "get": { + "tags": [ + "Labor" + ], + "summary": "ListTeamMemberWages", + "operationId": "ListTeamMemberWages", + "description": "Returns a paginated list of `TeamMemberWage` instances for a business.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "team_member_id", + "description": "Filter the returned wages to only those that are associated with the\nspecified team member.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between\n1 and 200. The default is 200.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pointer to the next page of `EmployeeWage` results to fetch.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListTeamMemberWagesResponse" + } + } + } + } + } + } + }, + "/v2/labor/team-member-wages/{id}": { + "get": { + "tags": [ + "Labor" + ], + "summary": "GetTeamMemberWage", + "operationId": "GetTeamMemberWage", + "description": "Returns a single `TeamMemberWage` specified by `id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `TeamMemberWage` being retrieved.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTeamMemberWageResponse" + } + } + } + } + } + } + }, + "/v2/labor/workweek-configs": { + "get": { + "tags": [ + "Labor" + ], + "summary": "ListWorkweekConfigs", + "operationId": "ListWorkweekConfigs", + "description": "Returns a list of `WorkweekConfig` instances for a business.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "limit", + "description": "The maximum number of `WorkweekConfigs` results to return per page.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pointer to the next page of `WorkweekConfig` results to fetch.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListWorkweekConfigsResponse" + } + } + } + } + } + } + }, + "/v2/labor/workweek-configs/{id}": { + "put": { + "tags": [ + "Labor" + ], + "summary": "UpdateWorkweekConfig", + "operationId": "UpdateWorkweekConfig", + "description": "Updates a `WorkweekConfig`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "TIMECARDS_SETTINGS_WRITE", + "TIMECARDS_SETTINGS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The UUID for the `WorkweekConfig` object being updated.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWorkweekConfigRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWorkweekConfigResponse" + } + } + } + } + } + } + }, + "/v2/locations": { + "get": { + "tags": [ + "Locations" + ], + "summary": "ListLocations", + "operationId": "ListLocations", + "description": "Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),\nincluding those with an inactive status. Locations are listed alphabetically by `name`.", + "x-release-status": "PUBLIC", + "x-unitTests": [ + { + "expectedResponse": { + "headers": {}, + "statusCode": "200", + "x-allowExtraHeaders": true, + "x-arrayCheckCount": false, + "x-arrayOrderedMatching": false, + "x-bodyMatchMode": "NONE", + "x-matchResponseSchema": true + }, + "request": { + "method": "GET", + "uri": "/v2/locations" + }, + "x-testEnabled": true, + "x-testName": "ListLocations", + "x-testShouldPass": true + } + ], + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLocationsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Locations" + ], + "summary": "CreateLocation", + "operationId": "CreateLocation", + "description": "Creates a [location](https://developer.squareup.com/docs/locations-api).\nCreating new locations allows for separate configuration of receipt layouts, item prices,\nand sales reports. Developers can use locations to separate sales activity through applications\nthat integrate with Square from sales activity elsewhere in a seller's account.\nLocations created programmatically with the Locations API last forever and\nare visible to the seller for their own management. Therefore, ensure that\neach location has a sensible and unique name.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLocationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLocationResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + } + ] + } + }, + "/v2/locations/custom-attribute-definitions": { + "get": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "ListLocationCustomAttributeDefinitions", + "operationId": "ListLocationCustomAttributeDefinitions", + "description": "Lists the location-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "visibility_filter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.", + "schema": { + "$ref": "#/components/schemas/VisibilityFilter" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLocationCustomAttributeDefinitionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "CreateLocationCustomAttributeDefinition", + "operationId": "CreateLocationCustomAttributeDefinition", + "description": "Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with locations.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or\n[BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes)\nto set the custom attribute for locations.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLocationCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLocationCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/locations/custom-attribute-definitions/{key}": { + "delete": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "DeleteLocationCustomAttributeDefinition", + "operationId": "DeleteLocationCustomAttributeDefinition", + "description": "Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall locations.\nOnly the definition owner can delete a custom attribute definition.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteLocationCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "RetrieveLocationCustomAttributeDefinition", + "operationId": "RetrieveLocationCustomAttributeDefinition", + "description": "Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLocationCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "UpdateLocationCustomAttributeDefinition", + "operationId": "UpdateLocationCustomAttributeDefinition", + "description": "Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLocationCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLocationCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/locations/custom-attributes/bulk-delete": { + "post": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "BulkDeleteLocationCustomAttributes", + "operationId": "BulkDeleteLocationCustomAttributes", + "description": "Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteLocationCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteLocationCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/locations/custom-attributes/bulk-upsert": { + "post": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "BulkUpsertLocationCustomAttributes", + "operationId": "BulkUpsertLocationCustomAttributes", + "description": "Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for one or more locations.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint.\nThis `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a location ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertLocationCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertLocationCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/locations/{location_id}": { + "get": { + "tags": [ + "Locations" + ], + "summary": "RetrieveLocation", + "operationId": "RetrieveLocation", + "description": "Retrieves details of a single location. Specify \"main\"\nas the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to retrieve. Specify the string\n\"main\" to return the main location.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLocationResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "NOT_FOUND" + } + ] + }, + "put": { + "tags": [ + "Locations" + ], + "summary": "UpdateLocation", + "operationId": "UpdateLocation", + "description": "Updates a [location](https://developer.squareup.com/docs/locations-api).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLocationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLocationResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + } + ] + } + }, + "/v2/locations/{location_id}/checkouts": { + "post": { + "tags": [ + "Checkout" + ], + "summary": "CreateCheckout", + "operationId": "CreateCheckout", + "description": "Links a `checkoutId` to a `checkout_page_url` that customers are\ndirected to in order to provide their payment information using a\npayment processing workflow hosted on connect.squareup.com. \n\n\nNOTE: The Checkout API has been updated with new features. \nFor more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2022-08-17", + "retirementDate": "TBD", + "replacedBy": "CreatePaymentLink", + "guideUrl": "https://developer.squareup.com/docs/migrate-from-v1/guides/v1-checkout" + }, + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE", + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the business location to associate the checkout with.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCheckoutRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCheckoutResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "AMOUNT_TOO_HIGH" + }, + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "ORDER_EXPIRED" + } + ] + } + }, + "/v2/locations/{location_id}/custom-attributes": { + "get": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "ListLocationCustomAttributes", + "operationId": "ListLocationCustomAttributes", + "description": "Lists the [custom attributes](entity:CustomAttribute) associated with a location.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the target [location](entity:Location).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "visibility_filter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.", + "schema": { + "$ref": "#/components/schemas/VisibilityFilter" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "with_definitions", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLocationCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/locations/{location_id}/custom-attributes/{key}": { + "delete": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "DeleteLocationCustomAttribute", + "operationId": "DeleteLocationCustomAttribute", + "description": "Deletes a [custom attribute](entity:CustomAttribute) associated with a location.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the target [location](entity:Location).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteLocationCustomAttributeResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "RetrieveLocationCustomAttribute", + "operationId": "RetrieveLocationCustomAttribute", + "description": "Retrieves a [custom attribute](entity:CustomAttribute) associated with a location.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the target [location](entity:Location).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "with_definition", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "version", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLocationCustomAttributeResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "LocationCustomAttributes" + ], + "summary": "UpsertLocationCustomAttribute", + "operationId": "UpsertLocationCustomAttribute", + "description": "Creates or updates a [custom attribute](entity:CustomAttribute) for a location.\nUse this endpoint to set the value of a custom attribute for a specified location.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the target [location](entity:Location).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertLocationCustomAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertLocationCustomAttributeResponse" + } + } + } + } + } + } + }, + "/v2/locations/{location_id}/transactions": { + "get": { + "tags": [ + "Transactions" + ], + "summary": "ListTransactions", + "operationId": "ListTransactions", + "description": "Lists transactions for a particular location.\n\nTransactions include payment information from sales and exchanges and refund\ninformation from returns and exchanges.\n\nMax results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2019-08-15", + "retirementDate": "TBD", + "replacedBy": "SearchOrders", + "guideUrl": "https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api" + }, + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location to list transactions for.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "begin_time", + "description": "The beginning of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time minus one year.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "end_time", + "description": "The end of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "The order in which results are listed in the response (`ASC` for\noldest first, `DESC` for newest first).\n\nDefault value: `DESC`", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListTransactionsResponse" + } + } + } + } + } + } + }, + "/v2/locations/{location_id}/transactions/{transaction_id}": { + "get": { + "tags": [ + "Transactions" + ], + "summary": "RetrieveTransaction", + "operationId": "RetrieveTransaction", + "description": "Retrieves details for a single transaction.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2019-08-15", + "retirementDate": "TBD", + "replacedBy": "BatchRetrieveOrders", + "guideUrl": "https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api" + }, + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the transaction's associated location.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "transaction_id", + "description": "The ID of the transaction to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveTransactionResponse" + } + } + } + } + } + } + }, + "/v2/locations/{location_id}/transactions/{transaction_id}/capture": { + "post": { + "tags": [ + "Transactions" + ], + "summary": "CaptureTransaction", + "operationId": "CaptureTransaction", + "description": "Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2019-08-15", + "retirementDate": "TBD", + "replacedBy": "CompletePayment", + "guideUrl": "https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api" + }, + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "transaction_id", + "description": "", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CaptureTransactionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "DELAYED_TRANSACTION_CANCELED" + }, + { + "error-code": "DELAYED_TRANSACTION_EXPIRED" + } + ] + } + }, + "/v2/locations/{location_id}/transactions/{transaction_id}/void": { + "post": { + "tags": [ + "Transactions" + ], + "summary": "VoidTransaction", + "operationId": "VoidTransaction", + "description": "Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2019-08-15", + "retirementDate": "TBD", + "replacedBy": "CancelPayment", + "guideUrl": "https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api" + }, + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "transaction_id", + "description": "", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VoidTransactionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "DELAYED_TRANSACTION_CAPTURED" + }, + { + "error-code": "DELAYED_TRANSACTION_EXPIRED" + } + ] + } + }, + "/v2/loyalty/accounts": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "CreateLoyaltyAccount", + "operationId": "CreateLoyaltyAccount", + "description": "Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLoyaltyAccountRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLoyaltyAccountResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_PHONE_NUMBER" + } + ] + } + }, + "/v2/loyalty/accounts/search": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "SearchLoyaltyAccounts", + "operationId": "SearchLoyaltyAccounts", + "description": "Searches for loyalty accounts in a loyalty program.\n\nYou can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely.\n\nSearch results are sorted by `created_at` in ascending order.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchLoyaltyAccountsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchLoyaltyAccountsResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/accounts/{account_id}": { + "get": { + "tags": [ + "Loyalty" + ], + "summary": "RetrieveLoyaltyAccount", + "operationId": "RetrieveLoyaltyAccount", + "description": "Retrieves a loyalty account.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [ + { + "name": "account_id", + "description": "The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLoyaltyAccountResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/accounts/{account_id}/accumulate": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "AccumulateLoyaltyPoints", + "operationId": "AccumulateLoyaltyPoints", + "description": "Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [ + { + "name": "account_id", + "description": "The ID of the target [loyalty account](entity:LoyaltyAccount).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AccumulateLoyaltyPointsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AccumulateLoyaltyPointsResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/accounts/{account_id}/adjust": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "AdjustLoyaltyPoints", + "operationId": "AdjustLoyaltyPoints", + "description": "Adds points to or subtracts points from a buyer's account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints)\nto add points when a buyer pays for the purchase.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [ + { + "name": "account_id", + "description": "The ID of the target [loyalty account](entity:LoyaltyAccount).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdjustLoyaltyPointsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdjustLoyaltyPointsResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/events/search": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "SearchLoyaltyEvents", + "operationId": "SearchLoyaltyEvents", + "description": "Searches for loyalty events.\n\nA Square loyalty program maintains a ledger of events that occur during the lifetime of a\nbuyer's loyalty account. Each change in the point balance\n(for example, points earned, points redeemed, and points expired) is\nrecorded in the ledger. Using this endpoint, you can search the ledger for events.\n\nSearch results are sorted by `created_at` in descending order.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchLoyaltyEventsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchLoyaltyEventsResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/programs": { + "get": { + "tags": [ + "Loyalty" + ], + "summary": "ListLoyaltyPrograms", + "operationId": "ListLoyaltyPrograms", + "description": "Returns a list of loyalty programs in the seller's account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`.", + "x-release-status": "DEPRECATED", + "deprecated": true, + "x-deprecation": { + "deprecationDate": "2021-05-13", + "replacedBy": "RetrieveLoyaltyProgram", + "guideUrl": "https://developer.squareup.com/docs/loyalty-api/overview#migration-notes" + }, + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLoyaltyProgramsResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "UNSUPPORTED_LOYALTY_REWARD_TIER" + } + ] + } + }, + "/v2/loyalty/programs/{program_id}": { + "get": { + "tags": [ + "Loyalty" + ], + "summary": "RetrieveLoyaltyProgram", + "operationId": "RetrieveLoyaltyProgram", + "description": "Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`.\n\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [ + { + "name": "program_id", + "description": "The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLoyaltyProgramResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "UNSUPPORTED_LOYALTY_REWARD_TIER" + } + ] + } + }, + "/v2/loyalty/programs/{program_id}/calculate": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "CalculateLoyaltyPoints", + "operationId": "CalculateLoyaltyPoints", + "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](entity:LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [ + { + "name": "program_id", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculateLoyaltyPointsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculateLoyaltyPointsResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/programs/{program_id}/promotions": { + "get": { + "tags": [ + "Loyalty" + ], + "summary": "ListLoyaltyPromotions", + "operationId": "ListLoyaltyPromotions", + "description": "Lists the loyalty promotions associated with a [loyalty program](entity:LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [ + { + "name": "program_id", + "description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "status", + "description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned.", + "schema": { + "$ref": "#/components/schemas/LoyaltyPromotionStatus" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLoyaltyPromotionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Loyalty" + ], + "summary": "CreateLoyaltyPromotion", + "operationId": "CreateLoyaltyPromotion", + "description": "Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [ + { + "name": "program_id", + "description": "The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)\nusing the `main` keyword.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLoyaltyPromotionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLoyaltyPromotionResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/programs/{program_id}/promotions/{promotion_id}": { + "get": { + "tags": [ + "Loyalty" + ], + "summary": "RetrieveLoyaltyPromotion", + "operationId": "RetrieveLoyaltyPromotion", + "description": "Retrieves a loyalty promotion.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [ + { + "name": "promotion_id", + "description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "program_id", + "description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLoyaltyPromotionResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "CancelLoyaltyPromotion", + "operationId": "CancelLoyaltyPromotion", + "description": "Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the\nend date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion.\nBecause updating a promotion is not supported, you can also use this endpoint to cancel a promotion before\nyou create a new one.\n\nThis endpoint sets the loyalty promotion to the `CANCELED` state", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [ + { + "name": "promotion_id", + "description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "program_id", + "description": "The ID of the base [loyalty program](entity:LoyaltyProgram).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelLoyaltyPromotionResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/rewards": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "CreateLoyaltyReward", + "operationId": "CreateLoyaltyReward", + "description": "Creates a loyalty reward. In the process, the endpoint does following:\n\n- Uses the `reward_tier_id` in the request to determine the number of points\nto lock for this reward.\n- If the request includes `order_id`, it adds the reward and related discount to the order.\n\nAfter a reward is created, the points are locked and\nnot available for the buyer to redeem another reward.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLoyaltyRewardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLoyaltyRewardResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/rewards/search": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "SearchLoyaltyRewards", + "operationId": "SearchLoyaltyRewards", + "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchLoyaltyRewardsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchLoyaltyRewardsResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/rewards/{reward_id}": { + "delete": { + "tags": [ + "Loyalty" + ], + "summary": "DeleteLoyaltyReward", + "operationId": "DeleteLoyaltyReward", + "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [ + { + "name": "reward_id", + "description": "The ID of the [loyalty reward](entity:LoyaltyReward) to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteLoyaltyRewardResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Loyalty" + ], + "summary": "RetrieveLoyaltyReward", + "operationId": "RetrieveLoyaltyReward", + "description": "Retrieves a loyalty reward.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_READ" + ] + } + ], + "parameters": [ + { + "name": "reward_id", + "description": "The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLoyaltyRewardResponse" + } + } + } + } + } + } + }, + "/v2/loyalty/rewards/{reward_id}/redeem": { + "post": { + "tags": [ + "Loyalty" + ], + "summary": "RedeemLoyaltyReward", + "operationId": "RedeemLoyaltyReward", + "description": "Redeems a loyalty reward.\n\nThe endpoint sets the reward to the `REDEEMED` terminal state.\n\nIf you are using your own order processing system (not using the\nOrders API), you call this endpoint after the buyer paid for the\npurchase.\n\nAfter the reward reaches the terminal state, it cannot be deleted.\nIn other words, points used for the reward cannot be returned\nto the account.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "LOYALTY_WRITE" + ] + } + ], + "parameters": [ + { + "name": "reward_id", + "description": "The ID of the [loyalty reward](entity:LoyaltyReward) to redeem.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedeemLoyaltyRewardRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedeemLoyaltyRewardResponse" + } + } + } + } + } + } + }, + "/v2/merchants": { + "get": { + "tags": [ + "Merchants" + ], + "summary": "ListMerchants", + "operationId": "ListMerchants", + "description": "Provides details about the merchant associated with a given access token.\n\nThe access token used to connect your application to a Square seller is associated\nwith a single merchant. That means that `ListMerchants` returns a list\nwith a single `Merchant` object. You can specify your personal access token\nto get your own merchant information or specify an OAuth token to get the\ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant)\nendpoint to retrieve the merchant information.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "The cursor generated by the previous response.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListMerchantsResponse" + } + } + } + } + } + } + }, + "/v2/merchants/custom-attribute-definitions": { + "get": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "ListMerchantCustomAttributeDefinitions", + "operationId": "ListMerchantCustomAttributeDefinitions", + "description": "Lists the merchant-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "visibility_filter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.", + "schema": { + "$ref": "#/components/schemas/VisibilityFilter" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListMerchantCustomAttributeDefinitionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "CreateMerchantCustomAttributeDefinition", + "operationId": "CreateMerchantCustomAttributeDefinition", + "description": "Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with a merchant connecting to your application.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) or\n[BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes)\nto set the custom attribute for a merchant.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateMerchantCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateMerchantCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/merchants/custom-attribute-definitions/{key}": { + "delete": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "DeleteMerchantCustomAttributeDefinition", + "operationId": "DeleteMerchantCustomAttributeDefinition", + "description": "Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nthe merchant.\nOnly the definition owner can delete a custom attribute definition.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteMerchantCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "RetrieveMerchantCustomAttributeDefinition", + "operationId": "RetrieveMerchantCustomAttributeDefinition", + "description": "Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveMerchantCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "UpdateMerchantCustomAttributeDefinition", + "operationId": "UpdateMerchantCustomAttributeDefinition", + "description": "Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMerchantCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMerchantCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/merchants/custom-attributes/bulk-delete": { + "post": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "BulkDeleteMerchantCustomAttributes", + "operationId": "BulkDeleteMerchantCustomAttributes", + "description": "Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteMerchantCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteMerchantCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/merchants/custom-attributes/bulk-upsert": { + "post": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "BulkUpsertMerchantCustomAttributes", + "operationId": "BulkUpsertMerchantCustomAttributes", + "description": "Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for a merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint.\nThis `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a merchant ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertMerchantCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertMerchantCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/merchants/{merchant_id}": { + "get": { + "tags": [ + "Merchants" + ], + "summary": "RetrieveMerchant", + "operationId": "RetrieveMerchant", + "description": "Retrieves the `Merchant` object for the given `merchant_id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "merchant_id", + "description": "The ID of the merchant to retrieve. If the string \"me\" is supplied as the ID,\nthen retrieve the merchant that is currently accessible to this call.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveMerchantResponse" + } + } + } + } + } + } + }, + "/v2/merchants/{merchant_id}/custom-attributes": { + "get": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "ListMerchantCustomAttributes", + "operationId": "ListMerchantCustomAttributes", + "description": "Lists the [custom attributes](entity:CustomAttribute) associated with a merchant.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "merchant_id", + "description": "The ID of the target [merchant](entity:Merchant).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "visibility_filter", + "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.", + "schema": { + "$ref": "#/components/schemas/VisibilityFilter" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "with_definitions", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListMerchantCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/merchants/{merchant_id}/custom-attributes/{key}": { + "delete": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "DeleteMerchantCustomAttribute", + "operationId": "DeleteMerchantCustomAttribute", + "description": "Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "merchant_id", + "description": "The ID of the target [merchant](entity:Merchant).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteMerchantCustomAttributeResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "RetrieveMerchantCustomAttribute", + "operationId": "RetrieveMerchantCustomAttribute", + "description": "Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "merchant_id", + "description": "The ID of the target [merchant](entity:Merchant).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "with_definition", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "version", + "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveMerchantCustomAttributeResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "MerchantCustomAttributes" + ], + "summary": "UpsertMerchantCustomAttribute", + "operationId": "UpsertMerchantCustomAttribute", + "description": "Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant.\nUse this endpoint to set the value of a custom attribute for a specified merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE" + ] + } + ], + "parameters": [ + { + "name": "merchant_id", + "description": "The ID of the target [merchant](entity:Merchant).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "key", + "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertMerchantCustomAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertMerchantCustomAttributeResponse" + } + } + } + } + } + } + }, + "/v2/online-checkout/location-settings/{location_id}": { + "get": { + "tags": [ + "Checkout" + ], + "summary": "RetrieveLocationSettings", + "operationId": "RetrieveLocationSettings", + "description": "Retrieves the location-level settings for a Square-hosted checkout page.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location for which to retrieve settings.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveLocationSettingsResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Checkout" + ], + "summary": "UpdateLocationSettings", + "operationId": "UpdateLocationSettings", + "description": "Updates the location-level settings for a Square-hosted checkout page.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE", + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location for which to retrieve settings.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLocationSettingsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLocationSettingsResponse" + } + } + } + } + } + } + }, + "/v2/online-checkout/merchant-settings": { + "get": { + "tags": [ + "Checkout" + ], + "summary": "RetrieveMerchantSettings", + "operationId": "RetrieveMerchantSettings", + "description": "Retrieves the merchant-level settings for a Square-hosted checkout page.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "PAYMENT_METHODS_READ", + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveMerchantSettingsResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Checkout" + ], + "summary": "UpdateMerchantSettings", + "operationId": "UpdateMerchantSettings", + "description": "Updates the merchant-level settings for a Square-hosted checkout page.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "MERCHANT_PROFILE_WRITE", + "PAYMENT_METHODS_READ", + "MERCHANT_PROFILE_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMerchantSettingsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMerchantSettingsResponse" + } + } + } + } + } + } + }, + "/v2/online-checkout/payment-links": { + "get": { + "tags": [ + "Checkout" + ], + "summary": "ListPaymentLinks", + "operationId": "ListPaymentLinks", + "description": "Lists all payment links.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "A limit on the number of results to return per page. The limit is advisory and\nthe implementation might return more or less results. If the supplied limit is negative, zero, or\ngreater than the maximum limit of 1000, it is ignored.\n\nDefault value: `100`", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListPaymentLinksResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Checkout" + ], + "summary": "CreatePaymentLink", + "operationId": "CreatePaymentLink", + "description": "Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE", + "ORDERS_READ", + "ORDERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePaymentLinkRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePaymentLinkResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_PHONE_NUMBER" + }, + { + "error-code": "INVALID_EMAIL_ADDRESS" + }, + { + "error-code": "MISSING_REQUIRED_PARAMETER" + }, + { + "error-code": "CONFLICTING_PARAMETERS" + } + ] + } + }, + "/v2/online-checkout/payment-links/{id}": { + "delete": { + "tags": [ + "Checkout" + ], + "summary": "DeletePaymentLink", + "operationId": "DeletePaymentLink", + "description": "Deletes a payment link.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_READ", + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The ID of the payment link to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeletePaymentLinkResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Checkout" + ], + "summary": "RetrievePaymentLink", + "operationId": "RetrievePaymentLink", + "description": "Retrieves a payment link.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The ID of link to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrievePaymentLinkResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Checkout" + ], + "summary": "UpdatePaymentLink", + "operationId": "UpdatePaymentLink", + "description": "Updates a payment link. You can update the `payment_link` fields such as\n`description`, `checkout_options`, and `pre_populated_data`.\nYou cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE", + "ORDERS_READ", + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "id", + "description": "The ID of the payment link to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePaymentLinkRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePaymentLinkResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_PHONE_NUMBER" + }, + { + "error-code": "INVALID_EMAIL_ADDRESS" + } + ] + } + }, + "/v2/orders": { + "post": { + "tags": [ + "Orders" + ], + "summary": "CreateOrder", + "operationId": "CreateOrder", + "description": "Creates a new [order](entity:Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOrderRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOrderResponse" + } + } + } + } + } + } + }, + "/v2/orders/batch-retrieve": { + "post": { + "tags": [ + "Orders" + ], + "summary": "BatchRetrieveOrders", + "operationId": "BatchRetrieveOrders", + "description": "Retrieves a set of [orders](entity:Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveOrdersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchRetrieveOrdersResponse" + } + } + } + } + } + } + }, + "/v2/orders/calculate": { + "post": { + "tags": [ + "Orders" + ], + "summary": "CalculateOrder", + "operationId": "CalculateOrder", + "description": "Enables applications to preview order pricing without creating an order.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculateOrderRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculateOrderResponse" + } + } + } + } + } + } + }, + "/v2/orders/clone": { + "post": { + "tags": [ + "Orders" + ], + "summary": "CloneOrder", + "operationId": "CloneOrder", + "description": "Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has\nonly the core fields (such as line items, taxes, and discounts) copied from the original order.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CloneOrderRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CloneOrderResponse" + } + } + } + } + } + } + }, + "/v2/orders/custom-attribute-definitions": { + "get": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "ListOrderCustomAttributeDefinitions", + "operationId": "ListOrderCustomAttributeDefinitions", + "description": "Lists the order-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "visibility_filter", + "description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write.", + "schema": { + "$ref": "#/components/schemas/VisibilityFilter" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListOrderCustomAttributeDefinitionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "CreateOrderCustomAttributeDefinition", + "operationId": "CreateOrderCustomAttributeDefinition", + "description": "Creates an order-related custom attribute definition. Use this endpoint to\ndefine a custom attribute that can be associated with orders.\n\nAfter creating a custom attribute definition, you can set the custom attribute for orders\nin the Square seller account.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOrderCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOrderCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/orders/custom-attribute-definitions/{key}": { + "delete": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "DeleteOrderCustomAttributeDefinition", + "operationId": "DeleteOrderCustomAttributeDefinition", + "description": "Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nOnly the definition owner can delete a custom attribute definition.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteOrderCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "RetrieveOrderCustomAttributeDefinition", + "operationId": "RetrieveOrderCustomAttributeDefinition", + "description": "Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveOrderCustomAttributeDefinitionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "UpdateOrderCustomAttributeDefinition", + "operationId": "UpdateOrderCustomAttributeDefinition", + "description": "Updates an order-related custom attribute definition for a Square seller account.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "key", + "description": "The key of the custom attribute definition to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateOrderCustomAttributeDefinitionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateOrderCustomAttributeDefinitionResponse" + } + } + } + } + } + } + }, + "/v2/orders/custom-attributes/bulk-delete": { + "post": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "BulkDeleteOrderCustomAttributes", + "operationId": "BulkDeleteOrderCustomAttributes", + "description": "Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)\n\nThis `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete\nrequests and returns a map of individual delete responses. Each delete request has a unique ID\nand provides an order ID and custom attribute. Each delete response is returned with the ID\nof the corresponding request.\n\nTo delete a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteOrderCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkDeleteOrderCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/orders/custom-attributes/bulk-upsert": { + "post": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "BulkUpsertOrderCustomAttributes", + "operationId": "BulkUpsertOrderCustomAttributes", + "description": "Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)\n\nThis `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides an order ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertOrderCustomAttributesRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpsertOrderCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/orders/search": { + "post": { + "tags": [ + "Orders" + ], + "summary": "SearchOrders", + "operationId": "SearchOrders", + "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](entity:SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](entity:OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchOrdersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchOrdersResponse" + } + } + } + } + } + } + }, + "/v2/orders/{order_id}": { + "get": { + "tags": [ + "Orders" + ], + "summary": "RetrieveOrder", + "operationId": "RetrieveOrder", + "description": "Retrieves an [Order](entity:Order) by ID.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the order to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveOrderResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Orders" + ], + "summary": "UpdateOrder", + "operationId": "UpdateOrder", + "description": "Updates an open [order](entity:Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the order to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateOrderRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateOrderResponse" + } + } + } + } + } + } + }, + "/v2/orders/{order_id}/custom-attributes": { + "get": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "ListOrderCustomAttributes", + "operationId": "ListOrderCustomAttributes", + "description": "Lists the [custom attributes](entity:CustomAttribute) associated with an order.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the target [order](entity:Order).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "visibility_filter", + "description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write.", + "schema": { + "$ref": "#/components/schemas/VisibilityFilter" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "with_definitions", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListOrderCustomAttributesResponse" + } + } + } + } + } + } + }, + "/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}": { + "delete": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "DeleteOrderCustomAttribute", + "operationId": "DeleteOrderCustomAttribute", + "description": "Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the target [order](entity:Order).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "custom_attribute_key", + "description": "The key of the custom attribute to delete. This key must match the key of an\nexisting custom attribute definition.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteOrderCustomAttributeResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "RetrieveOrderCustomAttribute", + "operationId": "RetrieveOrderCustomAttribute", + "description": "Retrieves a [custom attribute](entity:CustomAttribute) associated with an order.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\nalso known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_READ" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the target [order](entity:Order).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "custom_attribute_key", + "description": "The key of the custom attribute to retrieve. This key must match the key of an\nexisting custom attribute definition.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "version", + "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "with_definition", + "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveOrderCustomAttributeResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderCustomAttributes" + ], + "summary": "UpsertOrderCustomAttribute", + "operationId": "UpsertOrderCustomAttribute", + "description": "Creates or updates a [custom attribute](entity:CustomAttribute) for an order.\n\nUse this endpoint to set the value of a custom attribute for a specific order.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the target [order](entity:Order).", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "custom_attribute_key", + "description": "The key of the custom attribute to create or update. This key must match the key \nof an existing custom attribute definition.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertOrderCustomAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertOrderCustomAttributeResponse" + } + } + } + } + } + } + }, + "/v2/orders/{order_id}/pay": { + "post": { + "tags": [ + "Orders" + ], + "summary": "PayOrder", + "operationId": "PayOrder", + "description": "Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE", + "ORDERS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "order_id", + "description": "The ID of the order being paid.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayOrderRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayOrderResponse" + } + } + } + } + } + } + }, + "/v2/payments": { + "get": { + "tags": [ + "Payments" + ], + "summary": "ListPayments", + "operationId": "ListPayments", + "description": "Retrieves a list of payments taken by the account making the request.\n\nResults are eventually consistent, and new payments or changes to payments might take several\nseconds to appear.\n\nThe maximum results per page is 100.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "begin_time", + "description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. \nThe range is determined using the `created_at` field for each Payment.\nInclusive. Default: The current time minus one year.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "end_time", + "description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The \nrange is determined using the `created_at` field for each Payment.\n\nDefault: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "The order in which results are listed by `ListPaymentsRequest.sort_field`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "Limit results to the location supplied. By default, results are returned\nfor the default (main) location associated with the seller.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "total", + "description": "The exact amount in the `total_money` for a payment.", + "schema": { + "type": "integer", + "format": "int64" + }, + "in": "query", + "required": false + }, + { + "name": "last_4", + "description": "The last four digits of a payment card.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "card_brand", + "description": "The brand of the payment card (for example, VISA).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "is_offline_payment", + "description": "Whether the payment was taken offline or not.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "offline_begin_time", + "description": "Indicates the start of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "offline_end_time", + "description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "updated_at_begin_time", + "description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "updated_at_end_time", + "description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_field", + "description": "The field used to sort results by. The default is `CREATED_AT`.", + "schema": { + "$ref": "#/components/schemas/ListPaymentsRequestSortField" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListPaymentsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Payments" + ], + "summary": "CreatePayment", + "operationId": "CreatePayment", + "description": "Creates a payment using the provided source. You can use this endpoint \nto charge a card (credit/debit card or \nSquare gift card) or record a payment that the seller received outside of Square \n(cash payment from a buyer or a payment that an external entity \nprocessed on behalf of the seller).\n\nThe endpoint creates a \n`Payment` object and returns it in the response.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePaymentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePaymentResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "ADDRESS_VERIFICATION_FAILURE" + }, + { + "error-code": "ALLOWABLE_PIN_TRIES_EXCEEDED" + }, + { + "error-code": "APPLE_TTP_PIN_TOKEN" + }, + { + "error-code": "BAD_EXPIRATION" + }, + { + "error-code": "CARDHOLDER_INSUFFICIENT_PERMISSIONS" + }, + { + "error-code": "CARD_DECLINED_VERIFICATION_REQUIRED" + }, + { + "error-code": "CARD_EXPIRED" + }, + { + "error-code": "CARD_NOT_SUPPORTED" + }, + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CARD_TOKEN_EXPIRED" + }, + { + "error-code": "CARD_TOKEN_USED" + }, + { + "error-code": "CHIP_INSERTION_REQUIRED" + }, + { + "error-code": "CVV_FAILURE" + }, + { + "error-code": "EXPIRATION_FAILURE" + }, + { + "error-code": "GENERIC_DECLINE" + }, + { + "error-code": "GIFT_CARD_AVAILABLE_AMOUNT" + }, + { + "error-code": "INSUFFICIENT_FUNDS" + }, + { + "error-code": "INSUFFICIENT_PERMISSIONS" + }, + { + "error-code": "INVALID_ACCOUNT" + }, + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "INVALID_CARD_DATA" + }, + { + "error-code": "INVALID_EMAIL_ADDRESS" + }, + { + "error-code": "INVALID_EXPIRATION" + }, + { + "error-code": "INVALID_FEES" + }, + { + "error-code": "INVALID_LOCATION" + }, + { + "error-code": "INVALID_PHONE_NUMBER" + }, + { + "error-code": "INVALID_PIN" + }, + { + "error-code": "INVALID_POSTAL_CODE" + }, + { + "error-code": "ISSUER_INSTALLMENT_ERROR" + }, + { + "error-code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED" + }, + { + "error-code": "PAN_FAILURE" + }, + { + "error-code": "PAYMENT_AMOUNT_MISMATCH" + }, + { + "error-code": "PAYMENT_LIMIT_EXCEEDED" + }, + { + "error-code": "TEMPORARY_ERROR" + }, + { + "error-code": "TRANSACTION_LIMIT" + }, + { + "error-code": "VOICE_FAILURE" + } + ] + } + }, + "/v2/payments/cancel": { + "post": { + "tags": [ + "Payments" + ], + "summary": "CancelPaymentByIdempotencyKey", + "operationId": "CancelPaymentByIdempotencyKey", + "description": "Cancels (voids) a payment identified by the idempotency key that is specified in the\nrequest.\n\nUse this method when the status of a `CreatePayment` request is unknown (for example, after you send a\n`CreatePayment` request, a network error occurs and you do not get a response). In this case, you can\ndirect Square to cancel the payment using this endpoint. In the request, you provide the same\nidempotency key that you provided in your `CreatePayment` request that you want to cancel. After\ncanceling the payment, you can submit your `CreatePayment` request again.\n\nNote that if no payment with the specified idempotency key is found, no action is taken and the endpoint\nreturns successfully.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelPaymentByIdempotencyKeyRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelPaymentByIdempotencyKeyResponse" + } + } + } + } + } + } + }, + "/v2/payments/{payment_id}": { + "get": { + "tags": [ + "Payments" + ], + "summary": "GetPayment", + "operationId": "GetPayment", + "description": "Retrieves details for a specific payment.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "payment_id", + "description": "A unique ID for the desired payment.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPaymentResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Payments" + ], + "summary": "UpdatePayment", + "operationId": "UpdatePayment", + "description": "Updates a payment with the APPROVED status.\nYou can update the `amount_money` and `tip_money` using this endpoint.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "payment_id", + "description": "The ID of the payment to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePaymentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePaymentResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "AMOUNT_TOO_HIGH" + }, + { + "error-code": "CARDHOLDER_INSUFFICIENT_PERMISSIONS" + }, + { + "error-code": "CARD_DECLINED_VERIFICATION_REQUIRED" + }, + { + "error-code": "CARD_EXPIRED" + }, + { + "error-code": "CHIP_INSERTION_REQUIRED" + }, + { + "error-code": "CVV_FAILURE" + }, + { + "error-code": "GENERIC_DECLINE" + }, + { + "error-code": "INSUFFICIENT_FUNDS" + }, + { + "error-code": "INVALID_ACCOUNT" + }, + { + "error-code": "INVALID_FEES" + }, + { + "error-code": "PAN_FAILURE" + }, + { + "error-code": "PAYMENT_LIMIT_EXCEEDED" + }, + { + "error-code": "TEMPORARY_ERROR" + }, + { + "error-code": "TRANSACTION_LIMIT" + }, + { + "error-code": "VOICE_FAILURE" + } + ] + } + }, + "/v2/payments/{payment_id}/cancel": { + "post": { + "tags": [ + "Payments" + ], + "summary": "CancelPayment", + "operationId": "CancelPayment", + "description": "Cancels (voids) a payment. You can use this endpoint to cancel a payment with \nthe APPROVED `status`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "payment_id", + "description": "The ID of the payment to cancel.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelPaymentResponse" + } + } + } + } + } + } + }, + "/v2/payments/{payment_id}/complete": { + "post": { + "tags": [ + "Payments" + ], + "summary": "CompletePayment", + "operationId": "CompletePayment", + "description": "Completes (captures) a payment.\nBy default, payments are set to complete immediately after they are created.\n\nYou can use this endpoint to complete a payment with the APPROVED `status`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "payment_id", + "description": "The unique ID identifying the payment to be completed.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletePaymentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletePaymentResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "VERSION_MISMATCH" + } + ] + } + }, + "/v2/payouts": { + "get": { + "tags": [ + "Payouts" + ], + "summary": "ListPayouts", + "operationId": "ListPayouts", + "description": "Retrieves a list of all payouts for the default location.\nYou can filter payouts by location ID, status, time range, and order them in ascending or descending order.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "location_id", + "description": "The ID of the location for which to list the payouts.\nBy default, payouts are returned for the default (main) location associated with the seller.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "status", + "description": "If provided, only payouts with the given status are returned.", + "schema": { + "$ref": "#/components/schemas/PayoutStatus" + }, + "in": "query", + "required": false + }, + { + "name": "begin_time", + "description": "The timestamp for the beginning of the payout creation time, in RFC 3339 format.\nInclusive. Default: The current time minus one year.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "end_time", + "description": "The timestamp for the end of the payout creation time, in RFC 3339 format.\nDefault: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "The order in which payouts are listed.", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListPayoutsResponse" + } + } + } + } + } + } + }, + "/v2/payouts/{payout_id}": { + "get": { + "tags": [ + "Payouts" + ], + "summary": "GetPayout", + "operationId": "GetPayout", + "description": "Retrieves details of a specific payout identified by a payout ID.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "payout_id", + "description": "The ID of the payout to retrieve the information for.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPayoutResponse" + } + } + } + } + } + } + }, + "/v2/payouts/{payout_id}/payout-entries": { + "get": { + "tags": [ + "Payouts" + ], + "summary": "ListPayoutEntries", + "operationId": "ListPayoutEntries", + "description": "Retrieves a list of all payout entries for a specific payout.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "payout_id", + "description": "The ID of the payout to retrieve the information for.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "sort_order", + "description": "The order in which payout entries are listed.", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListPayoutEntriesResponse" + } + } + } + } + } + } + }, + "/v2/refunds": { + "get": { + "tags": [ + "Refunds" + ], + "summary": "ListPaymentRefunds", + "operationId": "ListPaymentRefunds", + "description": "Retrieves a list of refunds for the account making the request.\n\nResults are eventually consistent, and new refunds or changes to refunds might take several\nseconds to appear.\n\nThe maximum results per page is 100.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "begin_time", + "description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`. \n\nDefault: The current time minus one year.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "end_time", + "description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`.\n\nDefault: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "The order in which results are listed by `PaymentRefund.created_at`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "location_id", + "description": "Limit results to the location supplied. By default, results are returned\nfor all locations associated with the seller.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "status", + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](entity:PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "source_type", + "description": "If provided, only returns refunds whose payments have the indicated source type.\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.\nFor information about these payment source types, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).\n\nDefault: If omitted, refunds are returned regardless of the source type.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + }, + { + "name": "updated_at_begin_time", + "description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: If omitted, the time range starts at `begin_time`.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "updated_at_end_time", + "description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: The current time.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "sort_field", + "description": "The field used to sort results by. The default is `CREATED_AT`.", + "schema": { + "$ref": "#/components/schemas/ListPaymentRefundsRequestSortField" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListPaymentRefundsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Refunds" + ], + "summary": "RefundPayment", + "operationId": "RefundPayment", + "description": "Refunds a payment. You can refund the entire payment amount or a\nportion of it. You can use this endpoint to refund a card payment or record a \nrefund of a cash or external payment. For more information, see\n[Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundPaymentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundPaymentResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_MISMATCH" + }, + { + "error-code": "CARD_PRESENCE_REQUIRED" + }, + { + "error-code": "CARD_TOKEN_USED" + }, + { + "error-code": "GENERIC_DECLINE" + }, + { + "error-code": "INSUFFICIENT_PERMISSIONS_FOR_REFUND" + }, + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "INVALID_CARD_DATA" + }, + { + "error-code": "INVALID_FEES" + }, + { + "error-code": "PAYMENT_NOT_REFUNDABLE" + }, + { + "error-code": "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE" + }, + { + "error-code": "REFUND_AMOUNT_INVALID" + }, + { + "error-code": "REFUND_DECLINED" + }, + { + "error-code": "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION" + }, + { + "error-code": "UNSUPPORTED_CARD_BRAND" + }, + { + "error-code": "UNSUPPORTED_COUNTRY" + }, + { + "error-code": "UNSUPPORTED_CURRENCY" + }, + { + "error-code": "UNSUPPORTED_INSTRUMENT_TYPE" + }, + { + "error-code": "UNSUPPORTED_SOURCE_TYPE" + }, + { + "error-code": "VALUE_TOO_HIGH" + }, + { + "error-code": "VERSION_MISMATCH" + } + ] + } + }, + "/v2/refunds/{refund_id}": { + "get": { + "tags": [ + "Refunds" + ], + "summary": "GetPaymentRefund", + "operationId": "GetPaymentRefund", + "description": "Retrieves a specific refund using the `refund_id`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "refund_id", + "description": "The unique ID for the desired `PaymentRefund`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPaymentRefundResponse" + } + } + } + } + } + } + }, + "/v2/sites": { + "get": { + "tags": [ + "Sites" + ], + "summary": "ListSites", + "operationId": "ListSites", + "description": "Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ONLINE_STORE_SITE_READ" + ] + } + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListSitesResponse" + } + } + } + } + } + } + }, + "/v2/sites/{site_id}/snippet": { + "delete": { + "tags": [ + "Snippets" + ], + "summary": "DeleteSnippet", + "operationId": "DeleteSnippet", + "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ONLINE_STORE_SNIPPETS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "site_id", + "description": "The ID of the site that contains the snippet.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteSnippetResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Snippets" + ], + "summary": "RetrieveSnippet", + "operationId": "RetrieveSnippet", + "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ONLINE_STORE_SNIPPETS_READ" + ] + } + ], + "parameters": [ + { + "name": "site_id", + "description": "The ID of the site that contains the snippet.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveSnippetResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Snippets" + ], + "summary": "UpsertSnippet", + "operationId": "UpsertSnippet", + "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "ONLINE_STORE_SNIPPETS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "site_id", + "description": "The ID of the site where you want to add or update the snippet.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertSnippetRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertSnippetResponse" + } + } + } + } + } + } + }, + "/v2/subscriptions": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "CreateSubscription", + "operationId": "CreateSubscription", + "description": "Enrolls a customer in a subscription.\n\nIf you provide a card on file in the request, Square charges the card for\nthe subscription. Otherwise, Square sends an invoice to the customer's email\naddress. The subscription starts immediately, unless the request includes\nthe optional `start_date`. Each individual subscription is associated with a particular location.\n\nFor more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ", + "PAYMENTS_WRITE", + "SUBSCRIPTIONS_WRITE", + "ITEMS_READ", + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateSubscriptionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CUSTOMER_MISSING_EMAIL" + }, + { + "error-code": "CUSTOMER_MISSING_NAME" + }, + { + "error-code": "CUSTOMER_NOT_FOUND" + }, + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "INVALID_DATE" + } + ] + } + }, + "/v2/subscriptions/bulk-swap-plan": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "BulkSwapPlan", + "operationId": "BulkSwapPlan", + "description": "Schedules a plan variation change for all active subscriptions under a given plan\nvariation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_WRITE", + "SUBSCRIPTIONS_READ", + "ITEMS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkSwapPlanRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkSwapPlanResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CUSTOMER_NOT_FOUND" + } + ] + } + }, + "/v2/subscriptions/search": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "SearchSubscriptions", + "operationId": "SearchSubscriptions", + "description": "Searches for subscriptions.\n\nResults are ordered chronologically by subscription creation date. If\nthe request specifies more than one location ID,\nthe endpoint orders the result\nby location ID, and then by creation date within each location. If no locations are given\nin the query, all locations are searched.\n\nYou can also optionally specify `customer_ids` to search by customer.\nIf left unset, all customers\nassociated with the specified locations are returned.\nIf the request specifies customer IDs, the endpoint orders results\nfirst by location, within location by customer ID, and within\ncustomer by subscription creation date.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchSubscriptionsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchSubscriptionsResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CUSTOMER_NOT_FOUND" + } + ] + } + }, + "/v2/subscriptions/{subscription_id}": { + "get": { + "tags": [ + "Subscriptions" + ], + "summary": "RetrieveSubscription", + "operationId": "RetrieveSubscription", + "description": "Retrieves a specific subscription.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_READ" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "include", + "description": "A query parameter to specify related information to be included in the response. \n\nThe supported query parameter values are: \n\n- `actions`: to include scheduled actions on the targeted subscription.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveSubscriptionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Subscriptions" + ], + "summary": "UpdateSubscription", + "operationId": "UpdateSubscription", + "description": "Updates a subscription by modifying or clearing `subscription` field values.\nTo clear a field, set its value to `null`.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ", + "PAYMENTS_WRITE", + "SUBSCRIPTIONS_WRITE", + "ITEMS_READ", + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSubscriptionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CUSTOMER_NOT_FOUND" + }, + { + "error-code": "INVALID_CARD" + } + ] + } + }, + "/v2/subscriptions/{subscription_id}/actions/{action_id}": { + "delete": { + "tags": [ + "Subscriptions" + ], + "summary": "DeleteSubscriptionAction", + "operationId": "DeleteSubscriptionAction", + "description": "Deletes a scheduled action for a subscription.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription the targeted action is to act upon.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "action_id", + "description": "The ID of the targeted action to be deleted.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteSubscriptionActionResponse" + } + } + } + } + } + } + }, + "/v2/subscriptions/{subscription_id}/billing-anchor": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "ChangeBillingAnchorDate", + "operationId": "ChangeBillingAnchorDate", + "description": "Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates)\nfor a subscription.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_WRITE", + "SUBSCRIPTIONS_READ", + "ITEMS_READ" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to update the billing anchor date.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeBillingAnchorDateRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeBillingAnchorDateResponse" + } + } + } + } + } + } + }, + "/v2/subscriptions/{subscription_id}/cancel": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "CancelSubscription", + "operationId": "CancelSubscription", + "description": "Schedules a `CANCEL` action to cancel an active subscription. This \nsets the `canceled_date` field to the end of the active billing period. After this date, \nthe subscription status changes from ACTIVE to CANCELED.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to cancel.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelSubscriptionResponse" + } + } + } + } + } + } + }, + "/v2/subscriptions/{subscription_id}/events": { + "get": { + "tags": [ + "Subscriptions" + ], + "summary": "ListSubscriptionEvents", + "operationId": "ListSubscriptionEvents", + "description": "Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "SUBSCRIPTIONS_READ" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to retrieve the events for.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + }, + { + "name": "cursor", + "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The upper limit on the number of subscription events to return\nin a paged response.", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListSubscriptionEventsResponse" + } + } + } + } + } + } + }, + "/v2/subscriptions/{subscription_id}/pause": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "PauseSubscription", + "operationId": "PauseSubscription", + "description": "Schedules a `PAUSE` action to pause an active subscription.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ", + "PAYMENTS_WRITE", + "SUBSCRIPTIONS_WRITE", + "ITEMS_READ", + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to pause.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PauseSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PauseSubscriptionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CUSTOMER_NOT_FOUND" + }, + { + "error-code": "INVALID_PAUSE_LENGTH" + }, + { + "error-code": "INVALID_DATE" + } + ] + } + }, + "/v2/subscriptions/{subscription_id}/resume": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "ResumeSubscription", + "operationId": "ResumeSubscription", + "description": "Schedules a `RESUME` action to resume a paused or a deactivated subscription.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ", + "PAYMENTS_WRITE", + "SUBSCRIPTIONS_WRITE", + "ITEMS_READ", + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to resume.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResumeSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResumeSubscriptionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CUSTOMER_MISSING_EMAIL" + }, + { + "error-code": "CUSTOMER_MISSING_NAME" + }, + { + "error-code": "CUSTOMER_NOT_FOUND" + }, + { + "error-code": "INVALID_CARD" + }, + { + "error-code": "INVALID_DATE" + } + ] + } + }, + "/v2/subscriptions/{subscription_id}/swap-plan": { + "post": { + "tags": [ + "Subscriptions" + ], + "summary": "SwapPlan", + "operationId": "SwapPlan", + "description": "Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. \nFor more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "CUSTOMERS_READ", + "PAYMENTS_WRITE", + "SUBSCRIPTIONS_WRITE", + "ITEMS_READ", + "ORDERS_WRITE", + "INVOICES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "The ID of the subscription to swap the subscription plan for.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwapPlanRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwapPlanResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "CARD_PROCESSING_NOT_ENABLED" + }, + { + "error-code": "CUSTOMER_NOT_FOUND" + } + ] + } + }, + "/v2/team-members": { + "post": { + "tags": [ + "Team" + ], + "summary": "CreateTeamMember", + "operationId": "CreateTeamMember", + "description": "Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates.\nYou must provide the following values in your request to this endpoint:\n- `given_name`\n- `family_name`\n\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTeamMemberRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTeamMemberResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_EMAIL_ADDRESS" + }, + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "FORBIDDEN" + } + ] + } + }, + "/v2/team-members/bulk-create": { + "post": { + "tags": [ + "Team" + ], + "summary": "BulkCreateTeamMembers", + "operationId": "BulkCreateTeamMembers", + "description": "Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates.\nThis process is non-transactional and processes as much of the request as possible. If one of the creates in\nthe request cannot be successfully processed, the request is not marked as failed, but the body of the response\ncontains explicit error information for the failed create.\n\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkCreateTeamMembersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkCreateTeamMembersResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "FORBIDDEN" + } + ] + } + }, + "/v2/team-members/bulk-update": { + "post": { + "tags": [ + "Team" + ], + "summary": "BulkUpdateTeamMembers", + "operationId": "BulkUpdateTeamMembers", + "description": "Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates.\nThis process is non-transactional and processes as much of the request as possible. If one of the updates in\nthe request cannot be successfully processed, the request is not marked as failed, but the body of the response\ncontains explicit error information for the failed update.\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpdateTeamMembersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpdateTeamMembersResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "FORBIDDEN" + } + ] + } + }, + "/v2/team-members/jobs": { + "get": { + "tags": [ + "Team" + ], + "summary": "ListJobs", + "operationId": "ListJobs", + "description": "Lists jobs in a seller account. Results are sorted by title in ascending order.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "The pagination cursor returned by the previous call to this endpoint. Provide this\ncursor to retrieve the next page of results for your original request. For more information,\nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListJobsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Team" + ], + "summary": "CreateJob", + "operationId": "CreateJob", + "description": "Creates a job in a seller account. A job defines a title and tip eligibility. Note that\ncompensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateJobRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateJobResponse" + } + } + } + } + } + } + }, + "/v2/team-members/jobs/{job_id}": { + "get": { + "tags": [ + "Team" + ], + "summary": "RetrieveJob", + "operationId": "RetrieveJob", + "description": "Retrieves a specified job.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "job_id", + "description": "The ID of the job to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveJobResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Team" + ], + "summary": "UpdateJob", + "operationId": "UpdateJob", + "description": "Updates the title or tip eligibility of a job. Changes to the title propagate to all\n`JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to\ntip eligibility propagate to all `TeamMemberWage` objects that reference the job ID.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "job_id", + "description": "The ID of the job to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateJobRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateJobResponse" + } + } + } + } + } + } + }, + "/v2/team-members/search": { + "post": { + "tags": [ + "Team" + ], + "summary": "SearchTeamMembers", + "operationId": "SearchTeamMembers", + "description": "Returns a paginated list of `TeamMember` objects for a business. \nThe list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether\nthe team member is the Square account owner.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTeamMembersRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTeamMembersResponse" + } + } + } + } + } + } + }, + "/v2/team-members/{team_member_id}": { + "get": { + "tags": [ + "Team" + ], + "summary": "RetrieveTeamMember", + "operationId": "RetrieveTeamMember", + "description": "Retrieves a `TeamMember` object for the given `TeamMember.id`.\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "team_member_id", + "description": "The ID of the team member to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveTeamMemberResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Team" + ], + "summary": "UpdateTeamMember", + "operationId": "UpdateTeamMember", + "description": "Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates.\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "team_member_id", + "description": "The ID of the team member to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTeamMemberRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTeamMemberResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "INVALID_EMAIL_ADDRESS" + }, + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "FORBIDDEN" + } + ] + } + }, + "/v2/team-members/{team_member_id}/wage-setting": { + "get": { + "tags": [ + "Team" + ], + "summary": "RetrieveWageSetting", + "operationId": "RetrieveWageSetting", + "description": "Retrieves a `WageSetting` object for a team member specified\nby `TeamMember.id`. For more information, see\n[Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting).\n\nSquare recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers)\nto get this information directly from the `TeamMember.wage_setting` field.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_READ" + ] + } + ], + "parameters": [ + { + "name": "team_member_id", + "description": "The ID of the team member for which to retrieve the wage setting.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveWageSettingResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Team" + ], + "summary": "UpdateWageSetting", + "operationId": "UpdateWageSetting", + "description": "Creates or updates a `WageSetting` object. The object is created if a\n`WageSetting` with the specified `team_member_id` doesn't exist. Otherwise,\nit fully replaces the `WageSetting` object for the team member.\nThe `WageSetting` is returned on a successful update. For more information, see\n[Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).\n\nSquare recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember)\nto manage the `TeamMember.wage_setting` field directly.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "EMPLOYEES_WRITE" + ] + } + ], + "parameters": [ + { + "name": "team_member_id", + "description": "The ID of the team member for which to update the `WageSetting` object.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWageSettingRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWageSettingResponse" + } + } + } + } + } + } + }, + "/v2/terminals/actions": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "CreateTerminalAction", + "operationId": "CreateTerminalAction", + "description": "Creates a Terminal action request and sends it to the specified device.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTerminalActionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTerminalActionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "IDEMPOTENCY_KEY_REUSED" + }, + { + "error-code": "INVALID_LOCATION" + }, + { + "error-code": "INVALID_VALUE" + }, + { + "error-code": "UNAUTHORIZED" + } + ] + } + }, + "/v2/terminals/actions/search": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "SearchTerminalActions", + "operationId": "SearchTerminalActions", + "description": "Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTerminalActionsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTerminalActionsResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "INVALID_CURSOR" + }, + { + "error-code": "UNKNOWN_QUERY_PARAMETER" + } + ] + } + }, + "/v2/terminals/actions/{action_id}": { + "get": { + "tags": [ + "Terminal" + ], + "summary": "GetTerminalAction", + "operationId": "GetTerminalAction", + "description": "Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "action_id", + "description": "Unique ID for the desired `TerminalAction`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTerminalActionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/terminals/actions/{action_id}/cancel": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "CancelTerminalAction", + "operationId": "CancelTerminalAction", + "description": "Cancels a Terminal action request if the status of the request permits it.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "action_id", + "description": "Unique ID for the desired `TerminalAction`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelTerminalActionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + }, + { + "error-code": "TEMPORARY_ERROR" + } + ] + } + }, + "/v2/terminals/actions/{action_id}/dismiss": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "DismissTerminalAction", + "operationId": "DismissTerminalAction", + "description": "Dismisses a Terminal action request if the status and type of the request permits it.\n\nSee [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "action_id", + "description": "Unique ID for the `TerminalAction` associated with the action to be dismissed.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DismissTerminalActionResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/terminals/checkouts": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "CreateTerminalCheckout", + "operationId": "CreateTerminalCheckout", + "description": "Creates a Terminal checkout request and sends it to the specified device to take a payment\nfor the requested amount.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTerminalCheckoutRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTerminalCheckoutResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "IDEMPOTENCY_KEY_REUSED" + }, + { + "error-code": "INVALID_FEES" + }, + { + "error-code": "INVALID_LOCATION" + }, + { + "error-code": "INVALID_VALUE" + }, + { + "error-code": "UNAUTHORIZED" + } + ] + } + }, + "/v2/terminals/checkouts/search": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "SearchTerminalCheckouts", + "operationId": "SearchTerminalCheckouts", + "description": "Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTerminalCheckoutsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTerminalCheckoutsResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "INVALID_CURSOR" + }, + { + "error-code": "UNKNOWN_QUERY_PARAMETER" + } + ] + } + }, + "/v2/terminals/checkouts/{checkout_id}": { + "get": { + "tags": [ + "Terminal" + ], + "summary": "GetTerminalCheckout", + "operationId": "GetTerminalCheckout", + "description": "Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "checkout_id", + "description": "The unique ID for the desired `TerminalCheckout`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTerminalCheckoutResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/terminals/checkouts/{checkout_id}/cancel": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "CancelTerminalCheckout", + "operationId": "CancelTerminalCheckout", + "description": "Cancels a Terminal checkout request if the status of the request permits it.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "checkout_id", + "description": "The unique ID for the desired `TerminalCheckout`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelTerminalCheckoutResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/terminals/checkouts/{checkout_id}/dismiss": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "DismissTerminalCheckout", + "operationId": "DismissTerminalCheckout", + "description": "Dismisses a Terminal checkout request if the status and type of the request permits it.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "checkout_id", + "description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DismissTerminalCheckoutResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/terminals/refunds": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "CreateTerminalRefund", + "operationId": "CreateTerminalRefund", + "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds).", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTerminalRefundRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTerminalRefundResponse" + } + } + } + } + } + } + }, + "/v2/terminals/refunds/search": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "SearchTerminalRefunds", + "operationId": "SearchTerminalRefunds", + "description": "Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTerminalRefundsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTerminalRefundsResponse" + } + } + } + } + } + } + }, + "/v2/terminals/refunds/{terminal_refund_id}": { + "get": { + "tags": [ + "Terminal" + ], + "summary": "GetTerminalRefund", + "operationId": "GetTerminalRefund", + "description": "Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_READ" + ] + } + ], + "parameters": [ + { + "name": "terminal_refund_id", + "description": "The unique ID for the desired `TerminalRefund`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTerminalRefundResponse" + } + } + } + } + } + } + }, + "/v2/terminals/refunds/{terminal_refund_id}/cancel": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "CancelTerminalRefund", + "operationId": "CancelTerminalRefund", + "description": "Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [ + "PAYMENTS_WRITE" + ] + } + ], + "parameters": [ + { + "name": "terminal_refund_id", + "description": "The unique ID for the desired `TerminalRefund`.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelTerminalRefundResponse" + } + } + } + } + } + } + }, + "/v2/terminals/refunds/{terminal_refund_id}/dismiss": { + "post": { + "tags": [ + "Terminal" + ], + "summary": "DismissTerminalRefund", + "operationId": "DismissTerminalRefund", + "description": "Dismisses a Terminal refund request if the status and type of the request permits it.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "terminal_refund_id", + "description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DismissTerminalRefundResponse" + } + } + } + } + }, + "x-endpoint-errors": [ + { + "error-code": "BAD_REQUEST" + }, + { + "error-code": "NOT_FOUND" + } + ] + } + }, + "/v2/vendors/bulk-create": { + "post": { + "tags": [ + "Vendors" + ], + "summary": "BulkCreateVendors", + "operationId": "BulkCreateVendors", + "description": "Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkCreateVendorsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkCreateVendorsResponse" + } + } + } + } + } + } + }, + "/v2/vendors/bulk-retrieve": { + "post": { + "tags": [ + "Vendors" + ], + "summary": "BulkRetrieveVendors", + "operationId": "BulkRetrieveVendors", + "description": "Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveVendorsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRetrieveVendorsResponse" + } + } + } + } + } + } + }, + "/v2/vendors/bulk-update": { + "put": { + "tags": [ + "Vendors" + ], + "summary": "BulkUpdateVendors", + "operationId": "BulkUpdateVendors", + "description": "Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpdateVendorsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkUpdateVendorsResponse" + } + } + } + } + } + } + }, + "/v2/vendors/create": { + "post": { + "tags": [ + "Vendors" + ], + "summary": "CreateVendor", + "operationId": "CreateVendor", + "description": "Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateVendorRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateVendorResponse" + } + } + } + } + } + } + }, + "/v2/vendors/search": { + "post": { + "tags": [ + "Vendors" + ], + "summary": "SearchVendors", + "operationId": "SearchVendors", + "description": "Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_READ" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchVendorsRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchVendorsResponse" + } + } + } + } + } + } + }, + "/v2/vendors/{vendor_id}": { + "get": { + "tags": [ + "Vendors" + ], + "summary": "RetrieveVendor", + "operationId": "RetrieveVendor", + "description": "Retrieves the vendor of a specified [Vendor](entity:Vendor) ID.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_READ" + ] + } + ], + "parameters": [ + { + "name": "vendor_id", + "description": "ID of the [Vendor](entity:Vendor) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveVendorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Vendors" + ], + "summary": "UpdateVendor", + "operationId": "UpdateVendor", + "description": "Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller.", + "x-release-status": "BETA", + "security": [ + { + "oauth2": [ + "VENDOR_WRITE" + ] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateVendorRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateVendorResponse" + } + } + } + } + } + } + }, + "/v2/webhooks/event-types": { + "get": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "ListWebhookEventTypes", + "operationId": "ListWebhookEventTypes", + "description": "Lists all webhook event types that can be subscribed to.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "api_version", + "description": "The API version for which to list event types. Setting this field overrides the default version used by the application.", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListWebhookEventTypesResponse" + } + } + } + } + } + } + }, + "/v2/webhooks/subscriptions": { + "get": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "ListWebhookSubscriptions", + "operationId": "ListWebhookSubscriptions", + "description": "Lists all webhook subscriptions owned by your application.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "cursor", + "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", + "schema": { + "type": "string" + }, + "in": "query", + "required": false + }, + { + "name": "include_disabled", + "description": "Includes disabled [Subscription](entity:WebhookSubscription)s.\nBy default, all enabled [Subscription](entity:WebhookSubscription)s are returned.", + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "required": false + }, + { + "name": "sort_order", + "description": "Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", + "schema": { + "$ref": "#/components/schemas/SortOrder" + }, + "in": "query", + "required": false + }, + { + "name": "limit", + "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100", + "schema": { + "type": "integer" + }, + "in": "query", + "required": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListWebhookSubscriptionsResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "CreateWebhookSubscription", + "operationId": "CreateWebhookSubscription", + "description": "Creates a webhook subscription.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateWebhookSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateWebhookSubscriptionResponse" + } + } + } + } + } + } + }, + "/v2/webhooks/subscriptions/{subscription_id}": { + "delete": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "DeleteWebhookSubscription", + "operationId": "DeleteWebhookSubscription", + "description": "Deletes a webhook subscription.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteWebhookSubscriptionResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "RetrieveWebhookSubscription", + "operationId": "RetrieveWebhookSubscription", + "description": "Retrieves a webhook subscription identified by its ID.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetrieveWebhookSubscriptionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "UpdateWebhookSubscription", + "operationId": "UpdateWebhookSubscription", + "description": "Updates a webhook subscription.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWebhookSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWebhookSubscriptionResponse" + } + } + } + } + } + } + }, + "/v2/webhooks/subscriptions/{subscription_id}/signature-key": { + "post": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "UpdateWebhookSubscriptionSignatureKey", + "operationId": "UpdateWebhookSubscriptionSignatureKey", + "description": "Updates a webhook subscription by replacing the existing signature key with a new one.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWebhookSubscriptionSignatureKeyRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWebhookSubscriptionSignatureKeyResponse" + } + } + } + } + } + } + }, + "/v2/webhooks/subscriptions/{subscription_id}/test": { + "post": { + "tags": [ + "WebhookSubscriptions" + ], + "summary": "TestWebhookSubscription", + "operationId": "TestWebhookSubscription", + "description": "Tests a webhook subscription by sending a test event to the notification URL.", + "x-release-status": "PUBLIC", + "security": [ + { + "oauth2": [] + } + ], + "parameters": [ + { + "name": "subscription_id", + "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test.", + "schema": { + "type": "string" + }, + "in": "path", + "required": true + } + ], + "requestBody": { + "required": true, + "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestWebhookSubscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestWebhookSubscriptionResponse" + } + } + } + } + } + } + } + }, + "x-fern-global-headers": [ + { + "header": "Square-Version", + "name": "version", + "optional": true, + "env": "VERSION", + "type": "literal\u003c\"2025-04-16\"\u003e" + } + ] +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index bcd6d5c8..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,949 +0,0 @@ -# Change Log - -For general API and SDK changelogs, see [Square APIs and SDKs Release Notes](https://developer.squareup.com/docs/changelog/connect). - -## Version 17.0.0.20211215 (2021-12-15) -### API updates - -* **Invoices API:** - * The Invoices API now supports seller accounts in France. For more information, see [International availability and considerations.](https://developer.squareup.com/docs/invoices-api/overview#international-availability-invoices) - * France only: [`Invoice`](https://developer.squareup.com/reference/square_2021-12-15/objects/Invoice) object. Added a new `payment_conditions` field, which contains payment terms and conditions that are displayed on the invoice. This field is available only for sellers in France. For more information, see [Payment conditions.](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions) - - Square version 2021-12-15 or higher is required to set this field, but it is returned in `ListInvoices` and `RetrieveInvoice` requests for all Square versions. - -* **Cards API** - * Added the `CARD_DECLINED_VERIFICATION_REQUIRED` error code to the list of error codes returned by [CreateCard](https://developer.squareup.com/reference/square_2021-12-15/cards-api/CreateCard). -* **Catalog API:** - * [CreateCatalogImage](https://developer.squareup.com/reference/square_2021-12-15/catalog-api/create-catalog-image) endpoint - * Updated to support attaching multiple images to a [Catalogbject](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogObject) instance. - * Added `is_primary` option to let the caller choose to attach an image as the primary image on the object for display with the Square Point of Sale and other first-party Square applications. For more information, see [Upload and Attach Images.](https://developer.squareup.com/docs/catalog-api/upload-and-attach-images) - * [CatalogObject](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogObject) object - * Retired the `image_id` field, used to hold a single image object attached to an image-supporting object of the `ITEM`, `ITEM_VARIATION`, `CATEGORY`, or `MODIFIER_LIST` type, in Square API version 2021-12-15 and later, which supports attachment of multiple images. The `image_id` field is still supported in Square API version prior to 2021-12-15. For more information, see [Work with Images: Overview.](https://developer.squareup.com/docs/catalog-api/cookbook/create-catalog-image#overview) - * [CatalogItem](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogItem), [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogItemVariation), [CatalogCategory](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogCategory) or [CatalogModifierList](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogModifierList) object - * Added `image_ids` list to hold attached image objects. The first element of `image_ids` list refers to the primary image attached to the catalog object. For more information, see [Work with Images: Overview.](https://developer.squareup.com/docs/catalog-api/cookbook/create-catalog-image#overview) - * [UpdateCatalogImage](https://developer.squareup.com/reference/square_2021-12-15/catalog-api/update-catalog-image) endpoint - * Added to support replacing the image file encapsulated by an existing [CatalogImage](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogImage) object. For more information, see [Replace image file on a CatalogImage object.](https://developer.squareup.com/docs/catalog-api/manage-images#replace-the-image-file-of-a-catalogimage-object) - - * [CatalogPricingRule](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogPricingRule) object - * Added [minimum_order_subtotal_money](https://developer.squareup.com/reference/square_2021-12-15/objects/CatalogPricingRule#definition__property-minimum_order_subtotal_money) field to require that the minimum order subtotal be reached before the pricing rule may be applied. - -### Documentation updates -* Added a new top-level node for Developer Tools. This node includes such features as Sandbox, API Logs, and Webhooks. -* Added [Webhook Event Logs (beta)](https://developer.squareup.com/docs/devtools/webhook-logs) documentation to the Developer Tools node. - - -## Version 16.0.0.20211117 (2021-11-17) -## API updates - -* **Cards API.** The [Card](https://developer.squareup.com/reference/square_2021-11-17/objects/card) object and webhook response body for all webhooks are updated updated with fields. - * Added the [Card.merchant_id](https://developer.squareup.com/reference/square_2021-11-17/objects/Card#definition__property-merchant_id) field to identify the Square seller that stored the payment card on file. - * Added a [Card](https://developer.squareup.com/reference/square_2021-11-17/objects/Card) object to the response bodies of all [Cards API webhooks](https://developer.squareup.com/docs/webhooks/v2webhook-events-tech-ref#cards-api). The `Card` is added as a child of the `data.object` field in all webhook responses. - -* **Bookings API.** The new [ListBookings](https://developer.squareup.com/reference/square_2021-11-17/bookings-api/list-bookings) endpoint supports browsing a collection of bookings of a seller. For more information, see [Use the Bookings API: list bookings.](https://developer.squareup.com/docs/bookings-api/use-the-api#list-bookings) - -* **Subscriptions API.** Introduced the new [actions framework](https://developer.squareup.com/docs/subscriptions-api/overview#subscriptions-actions-overview) representing scheduled, future changes to subscriptions. - * The new [PauseSubscription](https://developer.squareup.com/reference/square_2021-11-17/subscriptions-api/pause-subscription) endpoint supports temporarily pausing a subscription. Calling this endpoint schedules a new `PAUSE` action. - * The new [SwapPlan](https://developer.squareup.com/reference/square_2021-11-17/subscriptions-api/swap-plan) endpoint supports changing the subscription plan associated with a single customer. Calling this endpoint schedules a new `SWAP_PLAN` action. - * The new [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2021-11-17/subscriptions-api/delete-subscription-action) endpoint supports deleting a scheduled action. - * The [ResumeSubscription](https://developer.squareup.com/reference/square_2021-11-17/subscriptions-api/resume-subscription) endpoint has been updated to support resuming a paused subscription. Calling this endpoint schedules a new `RESUME` action. - * The [CancelSubscription](https://developer.squareup.com/reference/square_2021-11-17/subscriptions-api/cancel-subscription) endpoint now schedules a new `CANCEL` action. - * Added an optional `include` body parameter to the [SearchSubscriptions](https://developer.squareup.com/reference/square_2021-11-17/subscriptions-api/search-subscriptions) endpoint. Include `actions` in the request to return all [actions](https://developer.squareup.com/docs/subscriptions-api/overview#subscriptions-actions-overview) associated with the subscriptions. - -## Documentation Update - -* **Migration Guides.** - * [Migrate from the Connect V1 Refunds API.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-refunds) The topic is updated to include information to migrate from the v1 ListRefunds endpoint to the appropriate Square API counterparts. - * [Migrate from the Connect V1 Payments API.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-payments) The topic provides developers information to migrate from the Connect V1 Payments API to the appropriate Square API counterparts. - - Code that relies on these V1 API endpoints must be updated to avoid breaking when these APIs reach retirement. - - -## Version 15.0.0.20211020 (2021-10-20) -## API updates -* **Transactions API.** Three previously deprecated endpoints (`ListRefunds`, `Charge`, and `CreateRefund`) in the [Transactions API](https://developer.squareup.com/reference/square_2021-10-20/transactions-api) are removed from Square API version 2021-10-20 and later. These endpoints will work if you are using Square API versions prior to 2021-10-20. However, these endpoints will eventually be retired from all Square versions. - - * Instead of the Transactions API `Charge` endpoint, use the Payments API [CreatePayment](https://developer.squareup.com/reference/square_2021-10-20/payments-api/create-payment) endpoint. - * Instead of the Transactions API `CreateRefund` endpoint, use the Refunds API [RefundPayment](https://developer.squareup.com/reference/square_2021-10-20/payments-api/refund-payment) endpoint. - * Instead of the Transactions API `ListRefunds` endpoint, use the Refunds API [ListPaymentRefund](https://developer.squareup.com/reference/square_2021-10-20/payments-api/list-payment-refunds) endpoint. - -* **Payments API:** - * [Payment](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment) object. - * Added the [device_details](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-device_details) read-only field to view details of the device used to take a payment. This `Payment`-level field provides device information for all types of payments. Previously, device details were only available for card payments (`Payment.card_details.device_details`), which is now deprecated. - * Added the [team_member_id](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-team_member_id) that applications can use to view the ID of the [TeamMember](https://developer.squareup.com/reference/square_2021-10-20/objects/TeamMember) associated with the payment. Use this field instead of the `Payment.employee_id` field, which is now deprecated. - * Added the [application_details](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-application_details) read-only field to view details of the application that took the payment. - - * These `Payment` fields have moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle) (GA) state:[tip_money](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-tip_money), [delay_duration](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-delay_duration), [statement_description_identifier](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-statement_description_identifier), [delay_duration](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-delay_duration), [delay_action](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-delay_action), [delayed_until](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-delayed_until), and [statement_description_identifier](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-statement_description_identifier). - - * The [ACH Bank Transfer Payments](https://developer.squareup.com/docs/payments-api/take-payments/ach-payments) feature has moved to the GA state. Accordingly, the [bank_account_details](https://developer.squareup.com/reference/square_2021-10-20/objects/Payment#definition__property-bank_account_details) field (and its [BankAccountPaymentDetails](https://developer.squareup.com/reference/square_2021-10-20/objects/BankAccountPaymentDetails) type) are moved to the GA state. - * [CreatePayment](https://developer.squareup.com/reference/square_2021-10-20/payments-api/create-payment) endpoint. - * Added the [team_member_id](https://developer.squareup.com/reference/square_2021-10-20/payments-api/create-payment#request__property-team_member_id) request field to record the ID of the team member associated with the payment. - * The [accept_partial_authorization](https://developer.squareup.com/reference/square_2021-10-20/payments-api/create-payment#request__property-accept_partial_authorization) request field has moved to the GA state. - * [CompletePayment](https://developer.squareup.com/reference/square_2021-10-20/payments-api/complete-payment) endpoint. Added the `version_token` request field to support optimistic concurrency. For more information, see [Delayed capture of a card payment.](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment) - -* **Refunds API:** - * [RefundPayment](https://developer.squareup.com/reference/square_2021-10-20/refunds-api/refund-payment) endpoint. - * Added the `team_member_id` request field to record the ID of the team member associated with the refund. - * Added the `payment_version_token` request field to support optimistic concurrency. For more information, see [Refund Payment.](https://developer.squareup.com/docs/payments-api/refund-payments#optimistic-concurrency) - -* **Customers API:** - * [Customer](https://developer.squareup.com/reference/square_2021-10-20/objects/Customer) object. Added a new `tax_ids` field of the [CustomerTaxIds](https://developer.squareup.com/reference/square_2021-10-20/objects/CustomerTaxIds) type, which can contain the EU VAT ID of the customer. This field is available only for customers of sellers in France, Ireland, or the United Kingdom. For more information, see [Customer tax IDs.](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids) - - * [UpdateCustomer](https://developer.squareup.com/reference/square_2021-10-20/customers-api/update-customer) endpoint. The Customers API now returns a `400 BAD_REQUEST` error if the request body does not contain any fields. For earlier Square versions, the Customers API will continue to return a `200 OK` response along with the customer profile. For more information, see [Migration notes.](https://developer.squareup.com/docs/customers-api/what-it-does#migration-notes) - -* **Invoices API:** - * [InvoiceRecipient](https://developer.squareup.com/reference/square_2021-10-20/objects/InvoiceRecipient) object. Added a new, read-only `tax_ids` field of the [InvoiceRecipientTaxIds](https://developer.squareup.com/reference/square_2021-10-20/objects/InvoiceRecipientTaxIds) type, which can contain the EU VAT ID of the invoice recipient. This field is available only for customers of sellers in Ireland or the United Kingdom. If defined, `tax_ids` is returned for all Square API versions. For more information, see [Invoice recipient tax IDs.](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids) - * Square now sends emails for test invoices that are published in the Sandbox environment. - -* **Catalog API:** - * [CatalogSubscriptionPlan.name](https://developer.squareup.com/reference/square_2021-10-20/objects/CatalogSubscriptionPlan#definition__property-name) can be updated after the subscription plan is created. The change is retroactively applicable to prior versions of the Square API. - -* **Subscriptions API:** - * The new [SubscriptionSource](https://developer.squareup.com/reference/square_2021-10-20/objects/SubscriptionSource) data type is introduced to encapsulate the source where a subscription is created. The new `SubscriptionSource.name` value is propagated to the `Order.source` attribute when an order is made on the subscription. The new feature is retroactively applicable to prior versions of the Square API. - * The new [Subscription.source](https://developer.squareup.com/reference/square_2021-10-20/objects/Subscription#definition__property-source) attribute is introduced to indicate the source where the subscription was created. This new feature is retroactively applicable to prior versions of the Square API. - * The new [SearchSubscriptionsFilter.source_names](https://developer.squareup.com/reference/square_2021-10-20/objects/SearchSubscriptionFilter#definition__property-source_names) query expression is introduced to enable search for subscriptions by the subscription source name. This new feature is retroactively applicable to prior versions of the Square API. - - -## Version 14.1.1.20210915 (2021-09-15) -## SDK updates -* Upgraded jsonpickle dependency - -## Version 14.1.0.20210915 (2021-09-15) -## API updates - -* **Invoices API:** - * [Invoice](https://developer.squareup.com/reference/square_2021-09-15/objects/Invoice) object. Added a new, optional `sale_or_service_date` field used to specify the date of the sale or the date that the service is rendered. If specified, this date is displayed on the invoice. - -* **Orders API:** - * [CreateOrder](https://developer.squareup.com/reference/square_2021-09-15/orders-api/create-order). The endpoint now supports creating temporary, draft orders. For more information, see [Create a draft order.](https://developer.squareup.com/docs/orders-api/create-orders#create-a-draft-order) - * [CloneOrder](https://developer.squareup.com/reference/square_2021-09-15/orders-api/clone-order). The Orders API supports this new endpoint to clone an existing order. For more information, see [Clone an order.](https://developer.squareup.com/docs/orders-api/create-orders#clone-an-order) - * These fields have moved to the [general availability (GA)](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) state: [OrderLineItem.item_type](https://developer.squareup.com/reference/square_2021-09-15/objects/OrderLineItem#definition__property-item_type), [OrderServiceCharge.type](https://developer.squareup.com/reference/square_2021-09-15/objects/OrderServiceCharge#definition__property-type), and `catalog_version` field on every order type that contains this field. - -* **Team API:** - * [SearchTeamMembersFilter](https://developer.squareup.com/reference/square_2021-09-15/objects/SearchTeamMembersFilter) object now has an `is_owner` field that when set, causes a team member search to return only the seller who owns a Square account. - -* **Terminal API:** - * [TerminalCheckout](https://developer.squareup.com/reference/square_2021-09-15/objects/TerminalCheckout) object. The `customer_id` field is now GA. - -## Documentation updates -* **OAuth API:** - * Revised API descriptions for the ObtainToken and Authorize endpoints. Clarified that the Authorize endpoint is not a callable API but is used to direct the seller to the Square authorization page. For more information about the Authorize endpoint, see [Create the Redirect URL and Square Authorization Page URL.](https://developer.squareup.com/docs/oauth-api/create-urls-for-square-authorization) - - -## Version 13.1.0.20210818 (2021-08-18) -## API updates - -* **Customers API:** - * [Customer](https://developer.squareup.com/reference/square_2021-08-18/objects/Customer) object. The `version` field has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. This field represents the current version of the customer profile and enables optimistic concurrency control. For more information, see [Customer profile versions and optimistic concurrency support.](https://developer.squareup.com/docs/customers-api/what-it-does#customer-profile-versions-and-optimistic-concurrency-support) - * [ListCustomers](https://developer.squareup.com/reference/square_2021-08-18/customers-api/list-customers) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response. - -* **Customer Groups API:** - * [ListCustomerGroups](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/list-customer-groups) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response. - -* **Customer Segments API:** - * [ListCustomerSegments](https://developer.squareup.com/reference/square_2021-08-18/customer-segments-api/list-customer-segments) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response. - -* **Invoices API:** - * Square Invoices Plus is a monthly subscription plan that allows access to premium invoice features. After Invoices Plus is launched in September 2021, a subscription will be required to create invoices with custom fields and installment payments. For more information, including how to handle new errors, see [Premium features available with Invoices Plus.](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription) - -* **Loyalty API:** - * [LoyaltyAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccount) object. Added a new `expiring_point_deadlines` field that specifies when points in the account balance are scheduled to expire. This field contains a list of [LoyaltyAccountExpiringPointDeadline](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccountExpiringPointDeadline) objects. For more information, see [Expiring points.](https://developer.squareup.com/docs/loyalty-api/overview#expiring-points) - -## Documentation updates - -* [App Marketplace.](https://developer.squareup.com/docs/app-marketplace) Added the following topics: - * [How to apply.](https://developer.squareup.com/docs/app-marketplace#how-to-apply) Documented the process to list an application on the Square App Marketplace. - * [App Marketplace API Usage Requirements.](https://developer.squareup.com/docs/app-marketplace/requirements) Added a topic that describes a set of API usage requirements and recommendations for partner applications. - -* [Automatic communications from Square about invoices.](https://developer.squareup.com/docs/invoices-api/overview#automatic-communication-from-square-to-customers) Documented the invoice-related communications sent from Square to customers and sellers. - -* [Snippets best practices.](https://developer.squareup.com/docs/snippets-api/overview#best-practices) Documented best practices and additional requirements for snippets and applications that integrate with the Snippets API. - - -## Version 13.0.0.20210721 (2021-07-21) -## SDK updates - * The [Square Python SDK](https://developer.squareup.com/docs/sdks/python) now requires Python 3.7 or later, if Python 3 is used. With Python 2, the minimum version remains at 2.7. - -## API updates - -* **Orders API:** - * [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderServiceCharge) object. Added a new field, `type`. It identifies the service charge type. - - * [OrderQuantityUnit](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderQuantityUnit), - [OrderLineItem](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItem), - [OrderLineItemDiscount](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemDiscount), - [OrderLineItemModifier](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemModifier), - [OrderLineItemTax](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemTax), - [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderServiceCharge), - [OrderReturnLineItem](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnLineItem), - [OrderReturnLineItemModifier](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnLineItemModifier), - [OrderReturnServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnServiceCharge), - [OrderReturnTax](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnTax), and - [OrderReturnDiscount](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnDiscount) objects. Added a new field, `catalog_version`. -* **Locations API:** - * [Location](https://developer.squareup.com/reference/square_2021-07-21/objects/Location) object. Added a new field `tax_ids` of type `TaxIds`. In the current implementation, sellers in Ireland and France can configure tax IDs during the onboarding process. They can also provide the information later by updating the location information in the Seller Dashboard. These tax IDs appear in this field. - -* **Loyalty API:** - * As of July 15, 2021, the country in which the seller’s Square account is activated determines whether Square uses pretax or post-tax purchase amounts to calculate accrued points. This change supports consumption tax models, such as value-added tax (VAT). Previously, point accrual was based on pretax purchase amounts only. This change does not affect the existing point balance of loyalty accounts. For more information, see [Availability of Square Loyalty.](https://developer.squareup.com/docs/loyalty-api/overview#loyalty-market-availability) - -* **Payments API:** - * [UpdatePayment](https://developer.squareup.com/reference/square_2021-07-21/payments-api/update-payment). The endpoint has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. Also, you can now update gift card payments (similar to card, cash, and external payments). - -* **Subscriptions API:** - * The [Subscriptions API](https://developer.squareup.com/docs/subscriptions-api/overview) has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. - * [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2021-07-21/objects/CatalogSubscriptionPlan) object. The `name` and `price` are now write-once fields. You specify these values at the time of creating a plan. After the plan is created, these fields cannot be updated. This makes a subscription plan immutable. - -* **Inventory API:** - * [RetrieveInventoryTransfer.](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Transfer) This new endpoint is introduced to support the retrieval of inventory transfer. - * [RetrieveInventoryChanges.](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Changes) This endpoint is deprecated. Its support ends when it is retired in about 12 months. - * The following endpoints have updated URLs to conform to the standard REST API convention. For more information about migrating deprecated URLs to updated URLs in your application, see [Inventory API: Migrate to Updated API Entities.](https://developer.squareup.com/docs/inventory-api/migrate-to-updated-api-entities) - * [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Adjustment) - * [BatchChangeInventory](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Change-Inventory) - * [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Retrieve-Inventory-Changes) - * [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Retrieve-Inventory-Counts) - * [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Physical-Count) - -## Documentation updates -* **Webhooks.** Revised the steps and descriptions for creating and using webhooks. For more information, see [Webhooks Overview.](https://developer.squareup.com/docs/webhooks/overview) - - -## Version 12.0.0.20210616 (2021-06-16) -## New API releases -* **Gift Cards API and Gift Card Activities API.** Gift card support is integrated in the [Square Seller Dashboard](https://squareup.com/dashboard/) and the [Square Point of Sale](https://squareup.com/us/en/point-of-sale) application. Sellers can sell, redeem, track, and reload Square gift cards. Now developers can use the [Gift Cards API](https://developer.squareup.com/reference/square_2021-06-16/gift-cards-api) and the [Gift Card Activities API](https://developer.squareup.com/reference/square_2021-06-16/gift-card-activities-api) to integrate Square gift cards into third-party applications. For more information, see [Gift Cards API Overview.](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api) - -* **Cards API.** The [Cards API](https://developer.squareup.com/reference/square_2021-06-16/cards-api) replaces the deprecated `CreateCustomerCard` and `DeleteCustomerCard` endpoints and lets an application save a customer payment card on file along with other card management operations. For more information, see [Cards API Overview.](https://developer.squareup.com/docs/cards-api/overview) - -## API updates -* **Catalog API:** - * [CatalogPricingRule](https://developer.squareup.com/reference/square_2021-06-16/objects/CatalogPricingRule). Support of the [customer group discount](https://developer.squareup.com/reference/square_2021-06-16/objects/CatalogPricingRule#definition__property-customer_group_ids_any) becomes GA. For more information, see [CreateCustomerGroupDiscounts.](https://developer.squareup.com/docs/catalog-api/configure-customer-group-discounts) - * [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-06-16/objects/CatalogItemVariation). Offers Beta support of the [stockable](https://developer.squareup.com/reference/square_2021-06-16/objects/CatalogItemVariation#definition__property-stockable) and [stockable_conversion](https://developer.squareup.com/reference/square_2021-06-16/objects/CatalogItemVariation#definition__property-stockable_conversion) attributes to enable sales of a product in multiple measurement units. - * [UpsertCatalogObject](https://developer.squareup.com/reference/square_2021-06-16/catalog-api/upsert-catalog-object) and [BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2021-06-16/catalog-api/batch-upsert-catalog-objects). Support creating an item with stockable and non-stockable variations with a specified stock conversion between the two. For more information, see [Enable Stock Conversion.](https://developer.squareup.com/docs/inventory-api/enable-stock-conversion) - * [UpsertCatalogObject](https://developer.squareup.com/reference/square_2021-06-16/catalog-api/upsert-catalog-object) and [BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2021-06-16/catalog-api/batch-upsert-catalog-objects). Require that an item be created with at least one variation. Otherwise, an `INVALID_REQUEST` error is returned. - -* **Customers API:** - * Using the Customers API to manage cards on file is deprecated: - * The [CreateCustomerCard](https://developer.squareup.com/reference/square_2021-06-16/customers-api/create-customer-card) endpoint is deprecated and replaced by the [CreateCard](https://developer.squareup.com/reference/square_2021-06-16/cards-api/create-card) and [LinkCustomerToGiftCard](https://developer.squareup.com/reference/square_2021-06-16/gift-cards-api/link-customer-to-gift-card) endpoints. - * The [DeleteCustomerCard](https://developer.squareup.com/reference/square_2021-06-16/customers-api/delete-customer-card) endpoint is deprecated and replaced by the [DisableCard](https://developer.squareup.com/reference/square_2021-06-16/cards-api/disable-card) and [UnlinkCustomerFromGiftCard](https://developer.squareup.com/reference/square_2021-06-16/gift-cards-api/unlink-customer-from-gift-card) endpoints. - * The `cards` field in the [Customer](https://developer.squareup.com/reference/square_2021-06-16/objects/Customer) object is deprecated and replaced by the following endpoints: - * [ListCards](https://developer.squareup.com/reference/square_2021-06-16/cards-api/list-cards) to retrieve credit and debit cards on file. - * [ListGiftCards](https://developer.squareup.com/reference/square_2021-06-16/gift-cards-api/list-gift-cards) to retrieve gift cards on file. - - For more information, see [Migrate to the Cards API and Gift Cards API.](https://developer.squareup.com/docs/customers-api/use-the-api/integrate-with-other-services#migrate-customer-cards) - - * [Customer](https://developer.squareup.com/reference/square_2021-06-16/objects/Customer) object. In the `cards` field, the IDs for gift cards now have a `gftc:` prefix followed by the card number. This is a service-level change that applies to all Square API versions. - -* **Disputes API:** - * The Disputes API is now GA. - * `RemoveDisputeEvidence`. Renamed to [DeleteDisputeEvidence](https://developer.squareup.com/reference/square_2021-06-16/objects/DeleteDisputeEvidence). - * [CreateDisputeEvidenceFile.](https://developer.squareup.com/reference/square_2021-06-16/objects/CreateDisputeEvidenceFile) The URL is changed from `/v2/disputes/{dispute_id}/evidence_file` to `/v2/disputes/{dispute_id}/evidence-files`. - * [CreateDisputeEvidenceText.](https://developer.squareup.com/reference/square_2021-06-16/objects/CreateDisputeEvidenceText) The URL is changed from `/v2/disputes/{dispute_id}/evidence_text` to `/v2/disputes/{dispute_id}/evidence-text`. - * [ListDisputeEvidence.](https://developer.squareup.com/reference/square_2021-06-16/objects/ListDisputeEvidence) The endpoint now returns a pagination cursor and accepts a pagination cursor in requests. - * `DISPUTES_READ` and `DISPUTES_WRITE` permissions are required for all Disputes API endpoints instead of `PAYMENTS_READ` and `PAYMENTS_WRITE`. - * [DisputeEvidence.](https://developer.squareup.com/reference/square_2021-06-16/objects/DisputeEvidence) The `evidence_id` field is deprecated and replaced by the `id` field. - * The `dispute.state.changed` webhook is renamed to `dispute.state.updated`. - * [Dispute](https://developer.squareup.com/reference/square_2021-06-16/objects/Dispute) object. The following breaking changes are made: - * The `dispute_id` field is deprecated and replaced by the `id` field. - * The `reported_date` field is deprecated and replaced by the `reported_at` field. - * The `evidence_ids` field is deprecated with no replacement. - - For more information about the GA release of the Disputes API, see [Disputes Overview.](https://developer.squareup.com/docs/disputes-api/overview) - - -* **Inventory API:** - * [CatalogStockConversion](https://developer.squareup.com/docs/{SQUARE_TECH_REF}/objects/CatalogStockConversion) (Beta). Enables selling a product in multiple measurement units and lets Square sellers manage inventory counts of the product's stockable and a non-stockable variations in a self-consistent manner. For more information, see [Enable Stock Conversion.](https://developer.squareup.com/docs/inventory-api/enable-stock-conversion) - -* **Invoices API:** - * [CreateInvoice.](https://developer.squareup.com/reference/square_2021-06-16/invoices-api/create-invoice) The `location_id` field is now optional and defaults to the location ID of the associated order. If specified in the request, the value must match the location ID of the associated order. This is a service-level change that applies to all Square API versions. - -* **Loyalty API:** - * [LoyaltyProgramAccrualRule](https://developer.squareup.com/reference/square_2021-06-16/objects/LoyaltyProgramAccrualRule) object. New `excluded_category_ids` and `excluded_item_variation_ids` fields that represent any categories and items that are excluded from accruing points in spend-based loyalty programs. - -* **Subscriptions API:** - * [Subscription.](https://developer.squareup.com/reference/square_2021-06-16/objects/Subscription) The `paid_until_date` field is renamed to `charge_through_date`. - * [UpdateSubscription.](https://developer.squareup.com/reference/square_2021-06-16/subscriptions-api/update-subscription) The `version` field is now optional because it can update only the latest version of a subscription. - - * [CreateSubscription.](https://developer.squareup.com/reference/square_2021-06-16/subscriptions-api/create-subscription) The `idempotency_key` field is now optional in the request. If you do not provide it, each `CreateSubscription` assumes a unique (never used before) value and creates a subscription for each call. - -## Documentation updates -* [Order fee structure.](https://developer.squareup.com/docs/payments-pricing#orders-api-fee-structure) Documented the transaction fee related to using the Orders API with a non-Square payments provider. - - -## Version 11.0.0.20210513 (2021-05-13) -## New API releases - -* **Sites API.** The [Sites API](https://developer.squareup.com/reference/square_2021-05-13/sites-api) lets you retrieve basic details about the Square Online sites that belong to a Square seller. For more information, see [Sites API Overview.](https://developer.squareup.com/docs/sites-api/overview) - - -* **Snippets API.** The [Snippets API](https://developer.squareup.com/reference/square_2021-05-13/snippets-api) lets you manage snippets that provide custom functionality on Square Online sites. A snippet is a script that is injected into all pages on a site, except for checkout pages. For more information, see [Snippets API Overview.](https://developer.squareup.com/docs/snippets-api/overview) - -The Sites API and Snippets API are publicly available to all developers as part of an early access program (EAP). For more information, see [Early access program for Square Online APIs.](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis) - -## API updates - -* **Payments API.** - * [CreatePayment.](https://developer.squareup.com/reference/square_2021-05-13/payments-api/create-payment) The endpoint now supports ACH bank transfer payments. For more information, see [ACH Payment](https://developer.squareup.com/docs/payments-api/take-payments/ach-payments). - -* **Loyalty API:** - * The [Loyalty API](https://developer.squareup.com/docs/loyalty-api/overview) has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. - - * The [ListLoyaltyPrograms](https://developer.squareup.com/reference/square_2021-05-13/loyalty-api/list-loyalty-programs) endpoint is deprecated and replaced by the [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2021-05-13/loyalty-api/retrieve-loyalty-program) endpoint when used with the `main` keyword. - - * [LoyaltyAccount](https://developer.squareup.com/reference/square_2021-05-13/objects/LoyaltyAccount)  object. The `mappings` field is retired and replaced by `mapping`. - - * [LoyaltyAccountMapping](https://developer.squareup.com/reference/square_2021-05-13/objects/LoyaltyAccountMapping) object. The `type` and `value` fields are retired and replaced by `phone_number`. - - Starting in Square version 2021-05-13: - * `mappings` is not accepted in `CreateLoyaltyAccount` requests or returned in responses. - * `type` and `value` are not accepted in `CreateLoyaltyAccount` or `SearchLoyaltyAccounts` requests or returned in responses. - - For more information, see [Migration notes.](https://developer.squareup.com/docs/loyalty-api/overview#migration-notes) - -## Documentation updates -* **Getting Started** Added step that shows how to use the API Logs to examine a transaction. - - -## Version 10.0.0.20210421 (2021-04-21) -## New API releases - -## Existing API updates - -* **Subscriptions API:** - * [ResumeSubscription.](https://developer.squareup.com/reference/square_2021-04-21/subscriptions-api/resume-subscription) This new endpoint enables applications to resume [deactivated subscriptions.](https://developer.squareup.com/docs/subscriptions-api/overview#deactivated-subscriptions) After a subscription is created, there are events that can make a subscription non-billable, causing Square to deactivate the subscription. A seller can also resume deactivated subscriptions in the Seller Dashboard. Applications can call [ListSubscriptionEvents](https://developer.squareup.com/reference/square_2021-04-21/subscriptions-api/list-subscription-events) to determine why Square deactivated a subscription. - -* **Customers API:** - - * [Customer](https://developer.squareup.com/reference/square_2021-04-21/objects/Customer) object: - * New `version` field (beta). This field represents the current version of the customer profile. You can include it in your `UpdateCustomer` and `DeleteCustomer` requests to enable optimistic concurrency. For more information, see [Customer profile versions and optimistic concurrency support.](https://developer.squareup.com/docs/customers-api/what-it-does#customer-profile-versions-and-optimistic-concurrency-support) - * The `groups` field and corresponding `CustomerGroupInfo` object are retired. - - * [Customer webhooks](https://developer.squareup.com/docs/customers-api/use-the-api/customer-webhooks) have moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. Event notifications now include the `version` field (beta). - -* **Invoices API:** - - * The [Invoices API](https://developer.squareup.com/docs/invoices-api/overview) has moved to the GA state. - - * [Invoice](https://developer.squareup.com/reference/square_2021-04-21/objects/Invoice) object: - * A new required `accepted_payment_methods` field that defines the methods of payment that customers can use to pay an invoice on the Square-hosted invoice page. Valid values are defined in the new [InvoiceAcceptedPaymentMethods](https://developer.squareup.com/reference/square_2021-04-21/objects/InvoiceAcceptedPaymentMethods) enum. For more information, see the [migration notes.](https://developer.squareup.com/docs/invoices-api/overview#migration-notes) - * A new `subscription_id` field, which is included in invoices created for subscription billing. - -* **Loyalty API:** (beta) - - * [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2021-04-21/loyalty-api/retrieve-loyalty-program) endpoint. This new endpoint accepts a program ID or the `main` keyword and returns the loyalty program in a seller's account. For more information, see [Retrieve a loyalty program.](https://developer.squareup.com/docs/loyalty-api/overview#retrieve-loyalty-program) This endpoint is preferred over the `ListLoyaltyPrograms` endpoint. - - * Introduced a new mapping implementation for loyalty accounts: - * [LoyaltyAccount](https://developer.squareup.com/reference/square_2021-04-21/objects/LoyaltyAccount) object. Added the `mapping` field (of type `LoyaltyAccountMapping`), which is used to associate the loyalty account with a buyer. This field is recommended over the `mappings` field. - * [LoyaltyAccountMapping](https://developer.squareup.com/reference/square_2021-04-21/objects/LoyaltyAccountMapping) object. Added the `phone_number` field to represent a phone number mapping. This field is recommended over the `type` and `value` fields. - - * A new [loyalty.program.created](https://developer.squareup.com/reference/square_2021-04-21/webhooks/loyalty.program.created) webhook. Square now publishes an event notification when a loyalty program is created in the Square Seller Dashboard. - -* **Inventory API:** - * [InventoryChange](https://developer.squareup.com/reference/square_2021-04-21/objects/InventoryChange) can now have its own measurement unit. - -* **Catalog API:** - * [CatalogItem](https://developer.squareup.com/reference/square_2021-04-21/objects/CatalogItem) introduces the `sort_name` attribute that can take Japanese writing scripts to sort items by. When it is unspecified, the regular `name` attribute is used for sorting. - * [CatalogPricingRule](https://developer.squareup.com/reference/square_2021-04-21/objects/CatalogCatalogPricingRule) has the new `customer_group_ids_any` attribute included to support automatic application of discounts to specified product set purchased by members of any of the customer groups identified by the `customer_group_ids_any` attribute values. -* **Team API** - * New [Team webhooks](https://developer.squareup.com/reference/square_2021-04-21/team-api/webhooks): `team_member.created`, `team_member.updated`, `team_member.wage_setting.updated` to notify on created and updated team members and wage settings. - - - - -## Version 9.1.0.20210317 (2021-03-17) - -## Existing API updates - -* **Payments API:** - * [CreatePayment](https://developer.squareup.com/reference/square_2021-03-17/payments-api/create-payment). Until now, the `CreatePayment` endpoint supported only taking card payments. In this release, the API now supports cash and external payments. For more information, see [Take Payments.](https://developer.squareup.com/docs/payments-api/take-payments) - * [UpdatePayment](https://developer.squareup.com/reference/square_2021-03-17/payments-api/update-payment). This new endpoint enables developers to change the payment amount and tip amount after a payment is created. For more information, see [Update Payments.](https://developer.squareup.com/docs/payments-api/update-payments) - -* **Invoices API:** - * [InvoiceDeliveryMethod](https://developer.squareup.com/reference/square_2021-03-17/enums/InvoiceDeliveryMethod) enum. Added the read-only `SMS` value. - * [InvoiceRequestMethod](https://developer.squareup.com/reference/square_2021-03-17/enums/InvoiceRequestMethod) enum (deprecated). Added the read-only `SMS`, `SMS_CHARGE_CARD_ON_FILE`, and `SMS_CHARGE_BANK_ON_FILE` values for backward compatibility. - - These values direct Square to send invoices and receipts to customers using SMS (text message). SMS settings can be configured from first-party Square applications only; they cannot be configured from the Invoices API. Square does not send invoice reminders when using SMS to communicate with customers. - - -* **Terminal API:** - * [TerminalCheckout](https://developer.squareup.com/reference/square_2021-03-17/objects/TerminalCheckout). Previously, `TerminalCheckout` only supported tapped, dipped, or swiped credit cards. It now supports manual card entry and e-money. Added the `payment_type` field to denote a request for a manually entered payment card or an e-money payment. - * [TerminalCheckoutPaymentType.](https://developer.squareup.com/reference/square_2021-03-17enums/TerminalCheckoutPaymentType) A new enum for the Terminal checkout payment types that can be requested. - * [E-money support](https://developer.squareup.com/docs/terminal-api/e-money-payments) is now available for Terminal checkout requests in Japan. - - -## SDKs -* **Square Java SDK:** - * Updated the OkHttp dependency to version 4.9.0. - * Fixed a `NullPointerException` when passing an empty order ID to the `UpdateOrder` method. - -## Documentation updates - -* **Multi-language code examples.** Previously, various topics showed only cURL examples for the REST API operations. These topics now show examples in multiple languages. You can use the language drop-down list to choose a language. - -* [When to Use Connect V1.](https://developer.squareup.com/docs/build-basics/using-connect-v1) Content is revised to reflect the most current information about when to use the Connect V1 API. - - -## Version 9.0.0.20210226 (2021-02-26) -## Existing API updates - -* **Customers API:** - - * [New webhooks](https://developer.squareup.com/docs/customers-api/use-the-api/customer-webhooks) (beta). Square now sends notifications for the following events: - * [customer.created](https://developer.squareup.com/reference/square_2021-02-26/webhooks/customer.created) - * [customer.deleted](https://developer.squareup.com/reference/square_2021-02-26/webhooks/customer.deleted) - * [customer.updated](https://developer.squareup.com/reference/square_2021-02-26/webhooks/customer.updated) - -* **Orders API:** - * [CreateOrder](https://developer.squareup.com/reference/square_2021-02-26/orders-api/create-order). Removed the `location_id` field from the request. It was an unused field. - -* **Payments API:** - * [Payment](https://developer.squareup.com/reference/square_2021-02-26/objects/Payment). This type now returns the `card_payment_timeline` [(CardPaymentTimeline](https://developer.squareup.com/reference/square_2021-02-26/objects/CardPaymentTimeline)) as part of the `card_details` field. - -* **v1 Items API:** - * The following endpoints are [retired:](https://developer.squareup.com/docs/build-basics/api-lifecycle) - * `AdjustInventory`: Use the Square Inventory API [BatchChangeInventory](https://developer.squareup.com/reference/square_2021-02-26/inventory-api/batch-change-inventory) endpoint. - * `ListInventory`: Use the Square Inventory API [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2021-02-26/inventory-api/batch-retrieve-inventory-counts) endpoint. - -* **v1 Employees.Timecards:** - * The following endpoints are retired: - * `CreateTimecard`: Use the Square Labor API [CreateShift](https://developer.squareup.com/reference/square_2021-02-26/labor-api/create-shift) endpoint. - * `DeleteTimecard`: Use the Square Labor API [DeleteShift](https://developer.squareup.com/reference/square_2021-02-26/labor-api/delete-shift) endpoint. - * `ListTimecards`: Use the Square Labor API [SearchShift](https://developer.squareup.com/reference/square_2021-02-26/labor-api/search-shift) endpoint. - * `RetrieveTimecards`: Use the Square Labor API [GetShift](https://developer.squareup.com/reference/square_2021-02-26/labor-api/get-shift) endpoint. - * `UpdateTimecard`: Use the Square Labor API [UpdateShift](https://developer.squareup.com/reference/square_2021-02-26/labor-api/update-shift) endpoint. - * `ListTimecardEvents`: No direct replacement. To learn about replacing the v1 functionality, see the [migration guide.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-timecards#endpoints) - -* **v1 Employees.CashDrawers:** - * The following endpoints are retired: - * `ListCashDrawerShifts`: Use the Square CashDrawerShifts API [ListCashDrawerShifts](https://developer.squareup.com/reference/square_2021-02-26/cash-drawers-api/list-cash-drawer-shifts) endpoint. - * `RetrieveCashDrawerShift`: Use the Square CashDrawerShifts API [RetrieveCashDrawerShift](https://developer.squareup.com/reference/square_2021-02-26/cash-drawers-api/retrieve-cash-drawer-shift) endpoint. -* **v1 Transactions.BankAccounts:** - * The following endpoints are retired: - * `ListBankAccounts`: Use the Square Bank Accounts API [ListBankAccounts](https://developer.squareup.com/reference/square_2021-02-26/bank-accounts-api/list-bank-accounts) endpoint. - * `RetrieveBankAccount`: Use the Square Bank Accounts API [GetBankAccount](https://developer.squareup.com/reference/square_2021-02-26/bank-accounts-api/get-bank-account) endpoint. - -## SDKs - -* **All Square SDKs:** - - By default, all SDKs send requests to Square's production (https://connect.squareup.com) or sandbox (https://connect.squareupsandbox.com) hosts based on the client's `environment` parameter. - - You now have the option to use a custom URL instead. To use a custom URL, follow the example for your language to set the `environment` parameter to `custom` and the `customUrl` parameter to your URL: - - - Java - - ```java - new SquareClient.Builder() - .environment(Environment.CUSTOM) - .customUrl("https://example.com") - ``` - - - .NET - - ```csharp - new Square.SquareClient.Builder() - .Environment(Environment.Custom) - .CustomUrl("https://example.com") - ``` - - - Node.js - - ```javascript - new Client({ - environment: Environment.Custom, - customUrl: 'https://example.com' - }); - ``` - - - PHP - - ```php - new Square\SquareClient([ - 'environment' => Environment::CUSTOM, - 'customUrl' => 'https://example.com', - ]); - ``` - - - Python - - ```python - Client( - environment = 'custom', - custom_url = 'https://example.com',) - ``` - - - Ruby - - ```ruby - Square::Client.new( - environment: 'custom', - custom_url: 'https://example.com' - }); - ``` - - -* **Square .NET SDK:** - - Square has overridden the `Equals` and `GetHashCode` methods for models: - - * In the `Equals` override, Square has implemented a field-level comparison. - * The Square `GetHashCode` override now ensures that hashes are deterministic and unique for each object. - -* **Square Node.js SDK:** - - Endpoints that return 64-bit integers now return a `BigInt` object instead of a `Number` object. - - -* **Connect Node.js SDK:** (deprecated) - - The deprecated Connect Node.js SDK is in the security [maintenance state.](https://developer.squareup.com/docs/build-basics/api-lifecycle#maintenance) It does not receive any bug fixes or API updates from the Square version 2021-02-26 release. However, the SDK will receive support and security patches until it is retired (end of life) in the second quarter of 2021. For more information, including steps for migrating to the [Square Node.js SDK,](https://github.com/square/square-nodejs-sdk) see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) - -## Documentation updates -* **Catalog API:** - * [Update Catalog Objects.](https://developer.squareup.com/docs/catalog-api/update-catalog-objects) Provides programming guidance to update catalog objects. - -* **Inventory API:** - * [List or retrieve inventory.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items#list-or-retrieve-inventory) Migrate the retired v1 endpoint of `ListInventory` to the v2 endpoint of `BatchRetrieveInventoryCounts`. Compare and contrast the programming patterns between the v1 endpoint of `ListInventory` and its v2 counterparts of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2021-02-26/inventory-api/batch-retrieve-inventory-counts) or [RetrieveInventoryCount](https://developer.squareup.com/reference/square_2021-02-26/inventory-api/retrieve-inventory-count). - * [Adjust or change inventory.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items#adjust-or-change-inventory) Migrate the retired v1 endpoint of `AdjustInventory` to the v2 endpoint of `BatchChangeInventory`. Compare and contrast the programming patterns between the v1 endpoint of `AdjustInventory` and its v2 counterparts of [BatchChangeInventory](https://developer.squareup.com/reference/square_2021-02-26/inventory-api/batch-change-inventory). - -* **Get Started topic.** Revised the [Get Started](https://developer.squareup.com/docs/get-started) experience. In addition to clarifications, it now includes the use of the Square Sandbox and API Explorer. These are the tools and environments developers use to explore Square APIs. - - -## Version 8.1.0.20210121 (2021-01-21T00:00) -## Existing API updates - -* **Invoices API:** (beta) - - The `InvoicePaymentRequest.request_method` field is deprecated, and its current options are separated into two new fields that better represent their scope: - * `Invoice.delivery_method` specifies how Square should send invoices, reminders, and receipts to the customer. - * `InvoicePaymentRequest.automatic_payment_source` specifies the payment method for an automatic payment. - - As part of this change, the [InvoiceDeliveryMethod](https://developer.squareup.com/reference/square_2021-01-21/enums/InvoiceDeliveryMethod) and [InvoiceAutomaticPaymentSource](https://developer.squareup.com/reference/square_2021-01-21/enums/InvoiceAutomaticPaymentSource) enums are added and the `InvoiceRequestMethod` enum is deprecated. - - The Invoices API will continue to accept `request_method` in create and update requests until the field is retired, but starting in this version, `request_method` is not included in returned `Invoice` objects. For more information, see the [migration notes.](https://developer.squareup.com/docs/invoices-api/overview#migrate-InvoicePaymentRequest.request_method) - - -* **Locations API:** - * The [Locations.MCC](https://developer.squareup.com/reference/square_2021-01-21/objects/Location#definition__property-mcc) field is now updatable (beta). You can use the `UpdateLocation` endpoint to update the merchant category code (MCC) associated with a seller location. For more information, see [Initialize a merchant category code.](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) - - - - -## SDKs -* **Connect Node.js SDK:** (deprecated) - - The deprecated Connect Node.js SDK is in the security [maintenance state.](https://developer.squareup.com/docs/build-basics/api-lifecycle#maintenance) It will not receive any bug fixes or API updates from the Square version 2021-01-21 release. However, the SDK will receive support and security patches until it is retired (EOL) in Q2, 2021. For more information, including steps for migrating to the [Square Node.js SDK,](https://github.com/square/square-nodejs-sdk) see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) - -## Documentation updates -* **Catalog API:** - * The [Use Item Options to Manage Item Variations](https://developer.squareup.com/docs/catalog-api/item-options-migration) topic is added. It demonstrates how item variations are usually used and how item options can be used to enable random access to item variations. - -* **Inventory API:** - * The [Inventory API](inventory-api/what-it-does) content is updated. It provides clearer guidance about how to use the API, with a task-oriented TOC and improved code examples. - - - -## Version 8.0.0.20201216 (2020-12-16T00:00) -## Existing API updates - -* **Orders API:** - * [OrderLineItemPricingBlocklists.](https://developer.squareup.com/reference/square_2020-12-16/objects/OrderLineItemPricingBlocklists) You can explicitly specify taxes and discounts in an order or automatically apply preconfigured taxes and discounts to an order. In addition, you can now block applying these taxes and discounts to a specific [OrderLineItem](https://developer.squareup.com/reference/square_2020-12-16/objects/OrderLineItem) in an [order](https://developer.squareup.com/reference/square_2020-12-16/objects/Order). You add the `pricing_blocklists` attribute to individual line items and specify the `blocked_discounts` and `blocked_taxes` that you do not want to apply. For more information, see [Apply Taxes and Discounts.](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts) For example walkthroughs, see [Automatically Apply Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-discounts) and [Automatically Apply Taxes.](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes) - * [OrderPricingOptions](https://developer.squareup.com/reference/square_2020-12-16/objects/OrderPricingOptions). Previously, the `pricing_options` field in an [order](https://developer.squareup.com/reference/square_2020-12-16/objects/OrderPricingOptions) supported only `auto_apply_discounts` to enable the automatic application of preconfigured discounts. Now it also supports `auto_apply_taxes` to enable the automatic application of preconfigured taxes. For more information, see [Automatically apply preconfigured catalog taxes or discounts.](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts#automatically-apply-preconfigured-catalog-taxes-or-discounts) - - * [OrderLineItemTax](https://developer.squareup.com/reference/square_2020-12-16/objects/OrderLineItemTax). It now includes the new `auto_applied` field. It indicates whether the tax was automatically applied using a preconfigured [CatalogTax](https://developer.squareup.com/reference/square_2020-12-16/objects/CatalogTax). - - -* **Bookings API:** - * The [CancelBooking](https://developer.squareup.com/reference/square_2020-12-16/bookings-api/cancel-booking) endpoint supports canceling an accepted or pending booking. - * The [booking.created](https://developer.squareup.com/reference/square_2020-12-16/webhooks/booking.created) webhook event notifies when a new booking is created by calling the [CreateBooking](https://developer.squareup.com/reference/square_2020-12-16/bookings-api/cancel-booking) endpoint. - * The [booking.updated](https://developer.squareup.com/reference/square_2020-12-16/webhooks/booking.updated) webhook event notifies when an existing booking is updated. - -* **Catalog API:** - * [ListCatalog](https://developer.squareup.com/reference/square_2020-12-16/catalog-api/list-catalog), [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2020-12-16/catalog-api/retrieve-catalog-object), and [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2020-12-16/catalog-api/batch-retrieve-catalog-objects) now support the `catalog_version` filter to return catalog objects of the specified version. - -* **Customers API:** - * [SearchCustomers](https://developer.squareup.com/reference/square_2020-12-16/customers-api/search-customers) endpoint. The `email_address`, `group_ids`, `phone_number`, and `reference_id` query filters are now generally available (GA). - * The [Customer Groups](https://developer.squareup.com/reference/square_2020-12-16/customer-groups-api) API is now GA. - * The [Customer Segments](https://developer.squareup.com/reference/square_2020-12-16/customer-segments-api) API is now GA. - - -* **Invoices API:** (beta) - * [Invoice](https://developer.squareup.com/reference/square_2020-12-16/objects/Invoice) object. Added the `custom_fields` field, which contains up to two customer-facing, seller-defined fields to display on the invoice. For more information, see [Custom fields.](https://developer.squareup.com/docs/invoices-api/overview#custom-fields) - As part of this change, the following objects are added: - * [InvoiceCustomField](https://developer.squareup.com/reference/square_2020-12-16/objects/InvoiceCustomField) object - * [InvoiceCustomFieldPlacement](https://developer.squareup.com/reference/square_2020-12-16/enums/InvoiceCustomFieldPlacement) enum - * [InvoiceRequestMethod](https://developer.squareup.com/reference/square_2020-12-16/enums/InvoiceRequestMethod) enum. Added the read-only CHARGE_BANK_ON_FILE value, which represents a bank transfer automatic payment method for a recurring invoice. - - -* **Loyalty API:** (beta) - * [LoyaltyProgramRewardTier](https://developer.squareup.com/reference/square_2020-12-16/objects/LoyaltyProgramRewardTier) object. The `definition` field in this type is deprecated and replaced by the new `pricing_rule_reference` field. You can use `pricing_rule_reference` fields to retrieve catalog objects that define the discount details for the reward tier. For more information, see [Get discount details for a reward tier.](https://developer.squareup.com/docs/loyalty-api/overview#get-discount-details-for-a-reward-tier) - As part of this change, the following APIs are deprecated: - * [LoyaltyProgramRewardDefinition](https://developer.squareup.com/reference/square_2020-12-16/objects/LoyaltyProgramRewardDefinition) object - * [LoyaltyProgramRewardDefinitionScope](https://developer.squareup.com/reference/square_2020-12-16/enums/LoyaltyProgramRewardDefinitionScope) enum - * [LoyaltyProgramRewardDefinitionType](https://developer.squareup.com/reference/square_2020-12-16/enums/LoyaltyProgramRewardDefinitionType) enum - -## New SDK release -* **Square Node.js SDK:** - - The new [Square Node.js SDK](https://github.com/square/square-nodejs-sdk) is now GA and replaces the deprecated Connect Node.js SDK. For migration information, see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) - - -## Documentation updates - -* [Get Right-Sized Permissions with Down-Scoped OAuth Tokens.](https://developer.squareup.com/docs/oauth-api/cookbook/downscoped-access) This new OAuth API topic shows how to get an additional reduced-scope OAuth token with a 24-hour expiration by using the refresh token from the Square account authorization OAuth flow. - - -## Version 7.0.0.20201118 (2020-11-18T00:00) -## New API releases - -* **Bookings API** (beta). This API enables you, as an application developer, to create applications to set up and manage bookings for appointments of fixed duration in which selected staff members of a Square seller provide specified services in supported locations for particular customers. - * For an overview, see [Manage Bookings for Square Sellers](https://developer.squareup.com/docs/bookings-api/what-it-is). - * For technical reference, see [Bookings API](https://developer.squareup.com/reference/square_2020-11-18/bookings-api). - -## Existing API updates - -* **Payments API:** - * [Payment.](https://developer.squareup.com/reference/square_2020-11-18/objects/Payment) The object now includes the `risk_evaluation` field to identify the Square-assigned risk level associated with the payment. Sellers can use this information to provide the goods and services or refund the payment. - -## New SDK release -* **New Square Node.js SDK (beta)** - - The new [Square Node.js SDK](https://github.com/square/square-nodejs-sdk) is available in beta and will eventually replace the deprecated Connect Node.js SDK. For migration information, see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) The following topics are updated to use the new SDK: - * [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) - * [Verify the Buyer When Using a Nonce for an Online Payment](https://developer.squareup.com/docs/payment-form/cookbook/verify-buyer-on-card-charge) - * [Create a Gift Card Payment Endpoint](https://developer.squareup.com/docs/payment-form/gift-cards/part-2) - - -## Documentation Updates - -* The **Testing** topics are moved from the end of the table of contents to the top, in the **Home** section under [Testing your App](https://developer.squareup.com/docs/testing-your-app). -* [Pay for orders.]](https://developer.squareup.com/docs/orders-api/pay-for-order) Topic revised to add clarity when to use Payments API and Orders API to pay for an order. The [Orders Integration]](https://developer.squareup.com/docs/payments-api/take-payments?preview=true#orders-integration) topic in Payments API simplified accordingly. - - -## Version 6.5.0.20201028 (2020-10-28T00:00) - -## Existing API updates - -* **Terminal API.** New endpoints to enable sellers in Canada refund Interac payments. - * New endpoints: - - * [CreateTerminalRefund](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/create-terminal-refund) - * [GetTerminalRefund](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/get-terminal-refund) - * [CancelTerminalRefund](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/cancel-terminal-refund) - * [SearchTerminalRefunds](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/search-terminal-refunds) - - * New webhooks: - * `terminal.refund.created`. Notification of a new Terminal refund request. - * `terminal.refund.updated`. Notification that a Terminal refund request state is changed. - - * New topic [Refund Interac Payments.](https://developer.squareup.com/docs/terminal-api/square-terminal-refunds). Describes how to refund Interac payments. - -* **Loyalty API (beta):** - * [SearchLoyaltyAccounts.](https://developer.squareup.com/reference/square_2020-10-28/loyalty-api/search-loyalty-accounts) The endpoint supports a new query parameter to search by customer ID. - -* **Locations API:** - * [Location](https://developer.squareup.com/reference/square_2020-10-28/objects/Location) object. Has a new read-only field,[full_format_logo_url](https://developer.squareup.com/reference/square_2020-10-28/objects/Location#definition__property-full_format_logo_url), which provides URL of a full-format logo image for the location. - * [Webhooks](https://developer.squareup.com/docs/webhooks-api/subscribe-to-events#locations) The Locations API now supports notifications for when a location is created and when a location is updated. - -* **Orders API:** - * [RetrieveOrder](https://developer.squareup.com/reference/square_2020-10-28/orders-api/retrieve-order), new endpoint. For more information, see the [Retrieve Orders](https://developer.squareup.com/docs/orders-api/manage-orders#retrieve-orders) overview. - -* **Invoices API (beta):** - * [Invoice](https://developer.squareup.com/reference/square_2020-10-28/objects/Invoice) object. The [payment_requests](https://developer.squareup.com/reference/square_2020-10-28/objects/Invoice#definition__property-payment_requests) field can now contain up to 13 payment requests, with a maximum of 12 `INSTALLMENT` request types. This is a service-level change that applies to all Square API versions. For more information, see [Payment requests.](https://developer.squareup.com/docs/invoices-api/overview#payment-requests) - -## Version 6.4.0.20200923 (2020-09-23) -## Existing API updates -* Invoices API (beta) - * [InvoiceStatus](https://developer.squareup.com/reference/square_2020-09-23/enums/InvoiceStatus) enum. Added the `PAYMENT_PENDING` value. Previously, the Invoices API returned a `PAID` or `PARTIALLY_PAID` status for invoices in a payment pending state. Now, the Invoices API returns a `PAYMENT_PENDING` status for all invoices in a payment pending state, including those previously returned as `PAID` or `PARTIALLY_PAID`. -* Payments API - * [ListPayment](https://developer.squareup.com/reference/square_2020-09-23/payments-api/list-payments). The endpoint now supports the `limit` parameter. -* Refunds API - * [ListPaymentRefunds](https://developer.squareup.com/reference/square_2020-09-23/refunds-api/list-payment-refunds). The endpoint now supports the `limit` parameter. -* [DeviceDetails](https://developer.squareup.com/reference/square_2020-09-23/objects/DeviceDetails#definition__property-device_installation_id). The object now includes the `device_installation_id` field. -## Documentation updates -* [Payment status.](https://developer.squareup.com/docs/payments-api/take-payments#payment-status) Added details about the `Payment.status` changes and how the status relates to the seller receiving the funds. -* [Refund status.](https://developer.squareup.com/docs/payments-api/refund-payments#refund-status) Added details about the `PaymentRefund.status` changes and how the status relates to the cardholder receiving the funds. -* [CreateRefund errors.](https://developer.squareup.com/docs/payments-api/error-codes#createrefund-errors) Added documentation for the `REFUND_DECLINED` error code. - -## Version 6.3.0.20200826 (2020-08-26) -## Existing API updates -* Orders API - * [Order](https://developer.squareup.com/reference/square_2020-08-26/objects/Order) object. The `total_tip_money` field is now GA. - * [CreateOrder](https://developer.squareup.com/reference/square_2020-08-26/orders-api/create-order), [UpdateOrder](https://developer.squareup.com/reference/square_2020-08-26/orders-api/update-order), and [BatchRetrieveOrders](https://developer.squareup.com/reference/square_2020-08-26/orders-api/batch-retrieve-orders). These APIs now support merchant-scoped endpoints (for example, the `CreateOrder` endpoint `POST /v2/orders`). The location-scoped variants of these endpoints (for example, the `CreateOrder` endpoint `POST /v2/locations/{location_id}/orders`) continue to work, but these endpoints are now deprecated. You should use the merchant-scoped endpoints (you provide the location information in the request body). -* Labor API - * [Migrate from Employees to Team Members.](https://developer.squareup.com/docs/labor-api/migrate-to-teams) The Employees API is now deprecated in this release. Accordingly, update references to the `Shift.employee_id` field to the `Shift.team_member_id` field of the Labor API. -* v2 Employees API (deprecated) - * [Migrate from the Square Employees API.](https://developer.squareup.com/docs/team/migrate-from-v2-employees) The v2 Employees API is now deprecated. This topic provides information to migrate to the Team API. -* v1 Employees API (deprecated) - * [Migrate from the v1 Employees API.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-employees) The v1 Employees API is now deprecated. This topic provides information to migrate to the Team API. - -## Documentation updates -* Point of Sale API - * [Build on iOS.](https://developer.squareup.com/docs/pos-api/build-on-ios) Corrected the Swift example code in step 7. -* Team API - * [Team API Overview.](https://developer.squareup.com/docs/team/overview) Documented the limitation related to creating a team member in the Square Sandbox. - -## All SDKs - -SDK technical reference documentation: - -* Nulls in SDK documentation example code are replaced with example values. - -## .NET SDK - -Bug fixes: - -* The `APIException.Errors` property was not set on instantiation. Behavior is now corrected to instantiate the class with an empty `Errors` list. - -## Version 6.2.0.20200812 (2020-08-12) -## API releases -* Subscriptions API (beta): - * For an overview, see [Square Subscriptions.](https://developer.squareup.com/docs/subscriptions/overview) - * For technical reference, see [Subscriptions API.](https://developer.squareup.com/reference/square_2020-08-12/subscriptions-api) - -## Existing API updates -* Catalog API - * [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2020-08-12/objects/CatalogSubscriptionPlan) (beta). This catalog type is added in support of the Subscriptions API. Subscription plans are stored as catalog object of the `SUBSCRIPTION_PLAN` type. For more information, see [Set Up and Manage a Subscription Plan.](https://developer.squareup.com/docs/subscriptions-api/setup-plan) - -## SqPaymentForm SDK updates -* [SqPaymentForm.masterpassImageURL.](https://developer.squareup.com/docs/api/paymentform#masterpassimageurl) This function is updated to return a Secure Remote Commerce background image URL. - -## Documentation updates -* Locations API - * [About the main location.](https://developer.squareup.com/docs/locations-api#about-the-main-location) Added clarifying information about the main location concept. -* OAuth API - * [Migrate to the Square API OAuth Flow.](https://developer.squareup.com/docs/oauth-api/migrate-to-square-oauth-flow) Added a new topic to document migration from a v1 location-scoped OAuth access token to the Square seller-scoped OAuth access token. -* Payment Form SDK - * Renamed the Add a Masterpass Button topic to [Add a Secure Remote Commerce Button.](https://developer.squareup.com/docs/payment-form/add-digital-wallets/masterpass) Updated the instructions to add a Secure Remote Commerce button to replace a legacy Masterpass button. - * [Payment form technical reference.](https://developer.squareup.com/docs/api/paymentform) Updated the reference to show code examples for adding a Secure Remote Commerce button. - -## Version 6.1.0.20200722 (2020-07-22) -## API releases - -* Invoices API (beta): - * For an overview, see [Manage Invoices Using the Invoices API](https://developer.squareup.com/docs/invoices-api/overview). - * For technical reference, see [Invoices API](https://developer.squareup.com/reference/square_2020-07-22/invoices-api). - -## Existing API updates - -* Catalog API - * [SearchCatalogItems](https://developer.squareup.com/reference/square_2020-07-22/catalog-api/search-catalog-items). You can now call the new search endpoint to [search for catalog items or item variations](https://developer.squareup.com/docs/catalog-api/search-catalog-items), with simplified programming experiences, using one or more of the supported query filters, including the custom attribute value filter. -* Locations API - * [Locations API Overview](https://developer.squareup.com/docs/locations-api). Introduced the "main" location concept. - * [RetrieveLocation](https://developer.squareup.com/reference/square_2020-07-22/locations-api/retrieve-location). You can now specify "main" as the location ID to retrieve the main location information. - -* Merchants API - * [RetrieveMerchant](https://developer.squareup.com/reference/square_2020-07-22/merchants-api/retrieve-merchant) and [ListMerchants](https://developer.squareup.com/reference/square_2020-07-22/merchants-api/retrieve-merchant). These endpoints now return a new field, `main_location_id`. - -* Orders API - * [PricingOptions](https://developer.squareup.com/reference/square_2020-07-22/objects/Order#definition__property-pricing_options). You can now enable the `auto_apply_discounts` of the options to have rule-based discounts automatically applied to an [Order](https://developer.squareup.com/reference/square_2020-07-22/objects/Order) that is pre-configured with a [pricing rule](https://developer.squareup.com/reference/square_2020-07-22/objects/CatalogPricingRule). - -* [Inventory API](https://developer.squareup.com/reference/square_2020-07-22/inventory-api) - * Replaced 500 error on max string length exceeded with a max length error message. Max length attribute added to string type fields. - -* Terminal API (beta) - * [TerminalCheckout](https://developer.squareup.com/reference/square_2020-07-22/objects/TerminalCheckout) object. The `TerminalCheckoutCancelReason` field is renamed to `ActionCancelReason`. - -## Documentation updates - -* Catalog API - * [Search a catalog](https://developer.squareup.com/docs/catalog-api/search-catalog). New topics added to provide actionable guides to using the existing [SearchCatalogObjects](https://developer.squareup.com/reference/square_2020-07-22/catalog-api/search-catalog-objects) endpoint, in addition to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2020-07-22/catalog-api/search-catalog-items) endpoints. - -* Orders API - * [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders). Updated existing content with the new pricing option for the automatic application of rule-based discounts. - - -## Version 6.0.0.20200625 (2020-06-25) - -## New API release -* Team API generally available (GA) - * For an overview, see [Team API Overview](https://developer.squareup.com/docs/team/overview). - * For technical reference, see [Team API](https://developer.squareup.com/reference/square_2020-06-25/team-api). - -## Existing API updates -* Catalog API - * [Pricing](https://developer.squareup.com/reference/square_2020-06-25/objects/CatalogPricingRule) is now GA. It allows an application to configure catalog item pricing rules for the specified discounts to apply automatically. -* Payments API - * The [CardPaymentDetails](https://developer.squareup.com/reference/square_2020-06-25/objects/CardPaymentDetails) type now supports a new field, [refund_requires_card_presence](https://developer.squareup.com/reference/square_2020-06-25/objects/CardPaymentDetails#definition__property-refund_requires_card_presence). When set to true, the payment card must be physically present to refund a payment. - -## Version 5.3.0.20200528 (2020-05-28) - -## API releases - -* Loyalty API (beta): - * For an overview, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview?train=2020-05-28). - * For technical reference, see [Loyalty API](https://developer.squareup.com/reference/square/loyalty-api). - -## Existing API updates - -* Orders API - * [CalculateOrder (beta)](https://developer.squareup.com/reference/square/orders-api/calculate-order) endpoint. Use the endpoint to calculate adjustments (for example, taxes and discounts) to an order for preview purposes. In response, the endpoint returns the order showing the calculated totals. You can use this endpoint with an existing order or an order that has not been created. - - The endpoint does not update an existing order. It only returns a calculated view of the order that you provided in the request. To create or update an order, use the [CreateOrder](https://developer.squareup.com/reference/square/orders-api/create-order) and [UpdateOrder](https://developer.squareup.com/reference/square/orders-api/update-order) endpoints, respectively. - * [Order](https://developer.squareup.com/reference/square_2020-05-28/objects/Order?train=2020-05-28) type. Two fields are added in support of the Loyalty API integration. For more information, see [Deferred reward creation](https://developer.squareup.com/docs/loyalty-api/overview?train=2020-05-28#deferred-reward-creation). For an example, see [Redeem Points](https://developer.squareup.com/docs/loyalty-api/walkthrough1/redeem-points?train=2020-05-28). - * `Order.rewards` represents rewards added to an order by calling the [CreateLoyaltyReward](https://developer.squareup.com/reference/square/loyalty-api/create-loyalty-reward) endpoint. - * `Order.discount.reward_ids` indicates that a discount is the result of the specified rewards that were added to an order using the `CreateLoyaltyReward` endpoint. - -* Customers API - - * The [Search Customers](https://developer.squareup.com/reference/square/customers-api/search-customers) endpoint supports search by email address, phone number, and reference ID with the following additional query filters: - - * The [`email_address` query filter](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#search-by-email-address) (beta) supports an [exact](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#exact-search-by-email-address) or [fuzzy](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#fuzzy-search-by-email-address) search for customer profiles by their email addresses. - - * The [`phone_number` query filter](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#search-by-phone-number) (beta) supports an [exact](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#exact-search-by-phone-number) or [fuzzy](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#fuzzy-search-by-phone-number) search for customer profiles by their phone numbers. - - * The [`reference_id` query filter](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#search-by-reference-id) (beta) supports an [exact](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#exact-search-by-reference-id) or [fuzzy](https://developer.squareup.com/docs/customers-api/cookbook/search-customers?train=2020-05-28#fuzzy-search-by-reference-id) search for customer profiles by their reference IDs. - - * The [`created_at`](https://developer.squareup.com/reference/square/objects/Customer#definition__property-created_at), [`updated_at`](https://developer.squareup.com/reference/square/objects/Customer#definition__property-updated_at), and [`id`](https://developer.squareup.com/reference/square/objects/Customer#definition__property-id) attributes on the [Customer](https://developer.squareup.com/docs/S%7BSQUARE_TECH_REF%7D/objects/customers?train=2020-05-28) resource are updated to be optional. As a result, they no longer are required input parameters when you call the Square SDKs to create a `Customer` object. You might need to update the dependent SDKs to the latest version to mediate breaking your existing code. - -## Square Webhooks - -* [Square Webhooks](https://developer.squareup.com/reference/square/webhooks) (formerly v2 Webhooks). The status is changed from beta to general availability (GA). - -* [v1 Webhooks](https://developer.squareup.com/docs/webhooks-api/v1-tech-ref?train=2020-05-28). The v1 Inventory and Timecards webooks are now deprecated and replaced by [inventory.count.updated](https://developer.squareup.com/reference/square/webhooks/inventory.count.updated) and [labor.shift.updated](https://developer.squareup.com/reference/square/webhooks/inventory.count.updated). - -## Version 5.2.2.20200422 (2020-04-25) -## Existing API updates - -* **OAuth API** - * [Obtain Token](https://developer.squareup.com/reference/square/oauth-api/revoke-token) endpoint: Removed the `scopes` property from the request body. - -## Version 5.2.1.20200422 (2020-04-22) -## API releases -* **Customer Segments API (beta).** `limit` field removed from **ListCustomerSegments** endpoint. - - -**Note:** This release fixes a bug introduced on the [April 22, 2020](changelog/connect-logs/2020-04-22) release of the Square API. - -## Version 5.2.0.20200422 (2020-04-22) -## API releases -* **Terminal API.** The new Terminal API lets a custom third-party POS app integrate with the Square Terminal to send terminal checkout requests to collect payments. - * For an overview, see [Overview](https://developer.squareup.com/docs/terminal-api/overview). - * For technical reference, see [Terminal API](https://developer.squareup.com/reference/square/terminal-api). - -* **Devices API.** The new Devices API lets a custom third-party POS app generate a code used to sign in to a Square Terminal to create a pairing that lets the POS app send terminal checkout requests. For technical reference, see [Devices API](https://developer.squareup.com/reference/square/devices-api). - -* **Customer Groups API (beta).** The new Customer Groups API (Beta) enables full CRUD management of customer groups, including the ability to list, retrieve, create, update, and delete customer groups. Previously, this functionality was only available through the Square dashboard and point-of-sale product interfaces. - * For an overview, see [Overview](https://developer.squareup.com/docs/customer-groups-api/what-it-does) - * For technical reference, see [Customer Groups](https://developer.squareup.com/reference/square/customer-groups-api). - -* **Customer Segments API (beta).** The new Customer Segments API (Beta) lets you list and retrieve customer segment (also called smart groups) information. Coupled with the new `segment_ids` field on the customer resource, this API lets you better understand and track the customer segments to which a customer belongs. - * For an overview, see [Overview](https://developer.squareup.com/docs/customer-segmentss-api/what-it-does) - * For technical reference, see [Customer Segments]( https://developer.squareup.com/reference/square/customer-segments-api). - - -* **New webhooks** v2 Webhooks (beta) now supports webhooks for the following APIs: - * Orders API. `order.created`, `order.updated`, and `order.fulfillment.updated` - * Terminal API. `terminal.checkout.created` and `terminal.checkout.updated` - * Devices API. `device.code.paired` - - For more information, see [Subscribe to Events](webhooks-api/subscribe-to-events). - -## Existing API updates -* **Customers API** - * [AddGroupToCustomer](https://developer.squareup.com/reference/square/customers-api/add-group-to-customer) endpoint. Added to add customer memberships to a customer group. - * [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square/customers-api/remove-group-from-customer) endpoint. Added to remove customer memberships from a customer group. - * [Customer](https://developer.squareup.com/reference/square/obects/Customer) object. Updated as follows: - * [`group_ids`](https://developer.squareup.com/reference/square/obects/Customer#definition__property-group_ids) field. Added to designate groups the customer is in. - * [`segment_ids`](https://developer.squareup.com/reference/square/obects/Customer#definition__property-segment_ids) field. Added to designate segments the customer is in. - * [`groups`](https://developer.squareup.com/reference/square/obects/Customer#definition__property-groups) field. Deprecated to be replaced by `group_ids` and `segment_ids`. It remains supported for one year from this release. - * [CustomerQuery](https://developer.squareup.com/reference/square/objects/CustomerQuery) object's `filter` parameter. Updated as follows: - * `group_ids` filter. Added to search for customers based on whether they belong to any, all, or none of the specified groups. - - -* **Orders API** - * [OrderFulfillmentPickupDetails](https://developer.squareup.com/reference/square/objects/OrderFulfillmentPickupDetails) type updated to support curbside pickup: - * `is_curbside_pickup`. This Boolean field indicates curbside pickup. - * `CurbsidePickupDetails`. This type provides supporting information for curbside pickup, including a buyer description (for example, "buyer is in a red car") and a timestamp when the buyer arrived for the pickup. - - -* **OAuth API** - * [RevokeToken](https://developer.squareup.com/reference/square/oauth-api/revoke-token) endpoint. Added a new field called [revoke_only_access_token](https://developer.squareup.com/reference/square/oauth-api/revoke-token#request__property-revoke_only_access_token). This field allows a client to revoke an access token but leave the parent authorization active. - * [ObtainToken](https://developer.squareup.com/reference/square/oauth-api/obtain-token) endpoint. Added a new field called [scopes](https://developer.squareup.com/reference/square/oauth-api/obtain-token#request__property-scopes). This field lets a client change the set of permissions for an access token when making a request to refresh the token. - - -* **Catalog API** - * [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square/objects/CatalogQuickAmountsSettings) type. Added to support predefined custom payment amounts in the Square Register checkout dialog box. - * ENUM`CatalogItemProductType`. The ENUM value `GIFT_CARD` is now deprecated. - -* **Payments API.** See [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally. - -## Version 5.1.0.20200325 (2020-03-25) -## Existing API updates -* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capture]](https://developer.squareup.com/docs/payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type: - * `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capture]](https://developer.squareup.com/docs/payments-api/take-payments). - * `delay_action`. Defines the action that Square takes on the payment when the `delay_duration` elapses. In this release, the API supports only the cancel payment action. - * `delayed_until`. Provides the date and time on Square servers when Square applies `delay_action` on the payment. - -## Version 5.0.0.20200226 (2020-02-26) -## API releases -* **GA release**: All SDKs have been updated to support the new Bank Accounts and CashDrawerShifts APIs. - -* **Beta release**: All SDKs have been updated to support the new Disputes API. - - -## Existing API updates - -All SDKs have been updated to support the following changes: - -* **Catalog API** - * Batch upsert catalog objects endpoint — The `batches` field is now required and the array must have at least one element. - * CatalogModifier — Two fields added: - * `ordinal` to support custom ordering in a modifier list - * `modifier_list_id` to reference the parent modifier list - * CatalogModifierList — New field added: `ordinal` to support custom ordering in a list of **CatalogModifierList** objects. - -* **Customers API changes** - * SearchCustomers endpoint — `limit` size reduced from 1000 to 100 to improve the endpoint performance. - -* **Orders API changes** - * CreateOrderRequest — Previously these request fields were deprecated: `line_items`, `taxes`, `discounts`. These fields are no longer available. Instead you now use the `Order` object in the request. For example, `Order.line_items`, `Order.taxes`, and `Order.discounts`. - * OrderLineItem type — There are two changes: - * The `taxes` field that was previously deprecated is no longer available. Instead, you now use the `OrderLineItem.applied_taxes` field. This also now requires that you set the `OrderLineItemTax.scope` field. - * The `discounts` field that was previously deprecated is no longer available. Instead, you now use the `OrderLineItem.applied_discounts` field. This also now requires that you set the `OrderLineItemDiscount.scope` field. - -* **Shared object updates** - * **Card object** — New fields added: `card_type`, `prepaid_type`. Currently, only the Payments API responses populate these fields. - -## Version 4.1.0.20200122 (2020-01-22) - -* New field: The **Employee** object now has an `is_owner` field. -* New enumeration: The **CardBrand** enumeration has a new `SQUARE_CAPITAL_CARD` enum value to support a Square one-time Installments payment. - -* New request body field constraint: The __Refund__ Payment request now requires a payment_id. - -## Version 4.0.0-20191217 (2019-12-17) -!!!important -Square is excited to announce the public release of customized SDKs for [Java](https://github.com/square/square-java-sdk) and [.NET](https://github.com/square/square-dotnet-sdk). For more information, see [Square SDKs](https://developer.squareup.com/docs/sdks). -!!! - -* __GA release:__ SDKs updated to support new `receipt_url` and `receipt_number` fields added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type. - -* __Beta release:__ SDKs updated to support the new [CashDrawerShifts](cashdrawershift-api/reporting) API. - -* Square now follows the semantic versioning scheme for all SDKs except PHP and Node.js. This versioning scheme uses three numbers to delineate MAJOR, MINOR, and PATCH versions of our SDK. In addition, the SDK version also includes the API version so you know what Square API version the SDK is related to. For more information, see [Versioning and SDKs](https://developer.squareup.com/docs/build-basics/versioning-overview#versioning-and-sdks). -* Java, .Net, Python, and Ruby SDKs are now version 4.0.0. Java and .Net SDKs have breaking changes in version 4.0.0. Ruby and Python do not have breaking changes. - -## Version 3.20191120.0 (2019-11-20) -!!!important -Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](https://developer.squareup.com/docs/migrate-from-v1) information page for details. -!!! - -* __GA releases:__ SDKs now support the new `modify_tax_basis` field to Discounts and v2 Sandbox -* __BETA releases:__ SDKs now support the Shifts API webhooks for Labor shift created, updated, deleted, CreateLocation endpoint, and the ability to customize statement description in Payments API. -* **Deprecated**: Support for v1Items API and v1Locations API is fully deprecated. - -## 3.20191023.0 (2019-10-23) -* **GA release**: Merchants.ListMerchant is GA for all SDKs. -* **Beta release**: All SDKs support exclusion strategies for pricing rules. - -## 3.20190925.0 (2019-09-25) - -* **GA release**: All SDKs have been updated to support the new Merchants API. - -* **Beta release**: All SDKs have been updated to support the new endpoints (RetrieveLocation, UpdateLocation) added to the Locations API. - -* **Beta release**: All SDKs have been updated to support the new field (`mcc`) added to the `Location` type. - -* **GA release**: All SDKs have been updated to support the new field (`bin`) added to the `Card` type. - -* **GA release**: All SDKs have been updated to support the new `CardPaymentDetails` fields (`verification_results`, `statement_description`, and `verification_method`). - -* **GA release**: All SDKs have been updated to support the new `Payment` field, (`employee_id`). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 830654f5..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,21 +0,0 @@ -# Contributing to Square SDKs - -Thank you for your willingness to help improve the Square SDKs. Your feedback and expertise ultimately benefits everyone who builds with Square. - -If you encounter a bug while using Square SDKs, please [let us know](#bug-reporting). We'll investigate the issue and fix it as soon as possible. - -We also accept feedback in the form of a pull request (PR), and will follow up with you if we need more information. However, any code changes required will be perfomed by Square engineering, and we'll close the PR. - -## Bug report - -To report a bug: -* Go to the **[Issues](../../issues)** page. -* Click **New issue**. -* Click **Get started**. - -## Other support - -For all other support, including new feature requests, see: - -* Square developer forums: [https://developer.squareup.com/forums](https://developer.squareup.com/forums) -* Square support center: [https://squareup.com/help/us/en](https://squareup.com/help/us/en) diff --git a/LICENSE b/LICENSE index 71fb2ce0..f5669d1d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,10 +1,21 @@ -Copyright 2024 Square, Inc. -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. +MIT License + +Copyright (c) 2025 Square. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index c1a7121c..00000000 --- a/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -include LICENSE -include README.md diff --git a/README.md b/README.md index 0180a108..20016f60 100644 --- a/README.md +++ b/README.md @@ -1,194 +1,244 @@ -![Square logo] +# Square Python Library -# Square Python SDK +[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fsquare%2Fsquare-python-sdk) +[![pypi](https://img.shields.io/pypi/v/squareup)](https://pypi.org/project/squareup) -[![Build](https://github.com/square/square-python-sdk/actions/workflows/python-package.yml/badge.svg)](https://github.com/square/square-python-sdk/actions/workflows/python-package.yml) -[![PyPi version](https://badge.fury.io/py/squareup.svg?new)](https://badge.fury.io/py/squareup) -[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) +The Square Python library provides convenient access to the Square API from Python. -Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders. +## Installation -* [Requirements](#requirements) -* [Installation](#installation) -* [Quickstart](#quickstart) -* [Usage](#usage) -* [Tests](#tests) -* [SDK Reference](#sdk-reference) -* [Deprecated APIs](#deprecated-apis) +```sh +pip install squareup +``` -## Requirements +## Usage -Use of the Python SDK requires: +Instantiate and use the client with the following: + +```python +from square import Square + +client = Square( + # This is the default and can be omitted. + token=os.environ.get("SQUARE_TOKEN"), +) +client.payments.create( + source_id="ccof:GaJGNaZa8x4OgDJn4GB", + idempotency_key="7b0f3ec5-086a-4871-8f13-3c81b3875218", + amount_money={ + "amount": 1000, + "currency": "USD" + }, + app_fee_money={ + "amount": 10, + "currency": "USD" + }, + autocomplete=True, + customer_id="W92WH6P11H4Z77CTET0RNTGFW8", + location_id="L88917AVBK2S5", + reference_id="123456", + note="Brief description" +) +``` -* Python 3 version 3.7 or higher +## Async Client + +The SDK also exports an `async` client so that you can make non-blocking calls to our API. + +```python +import asyncio + +from square import AsyncSquare + +async def main() -> None: + client = AsyncSquare( + # This is the default and can be omitted. + token=os.environ.get("SQUARE_TOKEN"), + ) + await client.payments.create( + source_id="ccof:GaJGNaZa8x4OgDJn4GB", + idempotency_key="7b0f3ec5-086a-4871-8f13-3c81b3875218", + amount_money={ + "amount": 1000, + "currency": "USD" + }, + app_fee_money={ + "amount": 10, + "currency": "USD" + }, + autocomplete=True, + customer_id="W92WH6P11H4Z77CTET0RNTGFW8", + location_id="L88917AVBK2S5", + reference_id="123456", + note="Brief description" + ) + + +asyncio.run(main()) +``` -## Installation +## Legacy SDK -For more information, see [Set Up Your Square SDK for a Python Project](https://developer.squareup.com/docs/sdks/python/setup-project). +While the new SDK has a lot of improvements, we at Square understand that it takes time +to upgrade when there are breaking changes. To make the migration easier, the old SDK +is published as `squareup_legacy` so that the two SDKs can be used side-by-side in the +same project. -## Quickstart +Check out the [example](./example/README.md) for a full demonstration, but the gist is +shown below: -For more information, see [Square Python SDK Quickstart](https://developer.squareup.com/docs/sdks/python/quick-start). +```python +from square import Square +from square_legacy.client import Client as LegacySquare -## Usage -For more information, see [Using the Square Python SDK](https://developer.squareup.com/docs/sdks/python/using-python-sdk). -## Tests +def main(): + client = Square(token=os.environ.get("SQUARE_TOKEN")) + legacy_client = LegacySquare(access_token=os.environ.get("SQUARE_TOKEN")) -First, clone the repo locally and `cd` into the directory. + ... +``` -```sh -git clone https://github.com/square/square-python-sdk.git -cd square-python-sdk +We recommend migrating to the new SDK using the following steps: + +1. Upgrade the PyPi package to ^42.0.0 +2. Run `pip install squareup_legacy` +3. Search and replace all requires and imports from `square` to `square_legacy` +4. Gradually move over to use the new SDK by importing it from the `square` module + +## Versioning + +By default, the SDK is pinned to the latest version. If you would like +to override this version you can specify it like so: + +```python +client = Square( + version="2025-03-19" +) ``` -Next, install dependencies. +## Automatic Pagination -```sh -python3 -m pip install . +Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used +as generators for the underlying object. + +```python +from square import Square + +client = Square() +response = client.payments.list() +for item in response: + yield item +# Alternatively, you can paginate page-by-page. +for page in response.iter_pages(): + yield page ``` -Before running the tests, find a sandbox token in your [Developer Dashboard] and set a `SQUARE_SANDBOX_TOKEN` environment variable. +## Exception Handling -```sh -export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE" +When the API returns a non-success status code (4xx or 5xx response), a subclass of +the following error will be thrown. + +```python +from square.core.api_error import ApiError + +try: + client.payments.create(...) +except ApiError as e: + print(e.status_code) + print(e.body) +``` + +## Webhook Signature Verification + +The SDK provides utility methods that allow you to verify webhook signatures and ensure +that all webhook events originate from Square. The `verify_signature` method will verify +the signature. + +```python +from square.utils.webhooks_helper import verify_signature + +is_valid = verify_signature( + request_body=request_body, + signature_header=request.headers['x-square-hmacsha256-signature'], + signature_key="YOUR_SIGNATURE_KEY", + notification_url="https://example.com/webhook", # The URL where event notifications are sent. +) ``` -Ensure you have `pytest` installed: +## Advanced + +### Retries + +The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long +as the request is deemed retriable and the number of retry attempts has not grown larger than the configured +retry limit (default: 2). +A request is deemed retriable when any of the following HTTP status codes is returned: + +- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) +- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) +- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) + +Use the `max_retries` request option to configure this behavior. + +```python +from square.core.request_options import RequestOptions + +client.payments.create( + ..., + request_options=RequestOptions( + max_retries=1 + ) +) ``` -python3 -m pip install pytest + +### Timeouts + +The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. + +```python + +from square import Square + +client = Square( + ..., + timeout=20.0, +) + +# Override timeout for a specific method +client.payments.create( + ..., + request_options=RequestOptions( + timeout_in_seconds=20 + ) +) ``` -And lastly, run the tests. +### Custom Client -```sh -pytest +You can override the `httpx` client to customize it for your use-case. Some common use-cases +include support for proxies and transports. + +```python +import httpx +from square import Square + +client = Square( + ..., + httpx_client=httpx.Client( + proxies="http://my.test.proxy.example.com", + transport=httpx.HTTPTransport(local_address="0.0.0.0"), + ), +) ``` -## SDK Reference - -### Payments -* [Payments] -* [Refunds] -* [Disputes] -* [Checkout] -* [Apple Pay] -* [Cards] -* [Payouts] - -### Terminal -* [Terminal] - -### Orders -* [Orders] -* [Order Custom Attributes] - -### Subscriptions -* [Subscriptions] - -### Invoices -* [Invoices] - -### Items -* [Catalog] -* [Inventory] - -### Customers -* [Customers] -* [Customer Groups] -* [Customer Segments] - -### Loyalty -* [Loyalty] - -### Gift Cards -* [Gift Cards] -* [Gift Card Activities] - -### Bookings -* [Bookings] -* [Booking Custom Attributes] - -### Business -* [Merchants] -* [Merchant Custom Attributes] -* [Locations] -* [Location Custom Attributes] -* [Devices] -* [Cash Drawers] - -### Team -* [Team] -* [Labor] - -### Financials -* [Bank Accounts] - -### Online -* [Sites] -* [Snippets] - -### Authorization -* [Mobile Authorization] -* [OAuth] - -### Webhook Subscriptions -* [Webhook Subscriptions] -## Deprecated APIs - -The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle): - -* [Employees] - replaced by the [Team] API. For more information, see [Migrate from the Employees API](https://developer.squareup.com/docs/team/migrate-from-v2-employees). - -* [Transactions] - replaced by the [Orders] and [Payments] APIs. For more information, see [Migrate from the Transactions API](https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api). - -[//]: # "Link anchor definitions" -[Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg -[Developer Dashboard]: https://developer.squareup.com/apps -[Square API]: https://squareup.com/developers -[sign up for a developer account]: https://squareup.com/signup?v=developers -[Client]: doc/client.md -[Devices]: doc/api/devices.md -[Disputes]: doc/api/disputes.md -[Terminal]: doc/api/terminal.md -[Cash Drawers]: doc/api/cash-drawers.md -[Vendors]: doc/api/vendors.md -[Customer Groups]: doc/api/customer-groups.md -[Customer Custom Attributes]: doc/api/customer-custom-attributes.md -[Customer Segments]: doc/api/customer-segments.md -[Bank Accounts]: doc/api/bank-accounts.md -[Payments]: doc/api/payments.md -[Checkout]: doc/api/checkout.md -[Catalog]: doc/api/catalog.md -[Customers]: doc/api/customers.md -[Inventory]: doc/api/inventory.md -[Labor]: doc/api/labor.md -[Loyalty]: doc/api/loyalty.md -[Bookings]: doc/api/bookings.md -[Booking Custom Attributes]: doc/api/booking-custom-attributes.md -[Locations]: doc/api/locations.md -[Location Custom Attributes]: doc/api/location-custom-attributes.md -[Merchants]: doc/api/merchants.md -[Merchant Custom Attributes]: doc/api/merchant-custom-attributes.md -[Orders]: doc/api/orders.md -[Order Custom Attributes]: doc/api/order-custom-attributes.md -[Invoices]: doc/api/invoices.md -[Apple Pay]: doc/api/apple-pay.md -[Refunds]: doc/api/refunds.md -[Subscriptions]: doc/api/subscriptions.md -[Mobile Authorization]: doc/api/mobile-authorization.md -[OAuth]: doc/api/o-auth.md -[Team]: doc/api/team.md -[Python SDK]: https://github.com/square/square-python-sdk -[Locations overview]: https://developer.squareup.com/docs/locations-api/what-it-does -[OAuth overview]: https://developer.squareup.com/docs/oauth-api/what-it-does -[Sites]: doc/api/sites.md -[Snippets]: doc/api/snippets.md -[Cards]: doc/api/cards.md -[Payouts]: doc/api/payouts.md -[Gift Cards]: doc/api/gift-cards.md -[Gift Card Activities]: doc/api/gift-card-activities.md -[Employees]: doc/api/employees.md -[Transactions]: doc/api/transactions.md -[Webhook Subscriptions]: doc/api/webhook-subscriptions.md +## Contributing + +While we value open-source contributions to this SDK, this library is generated programmatically. +Additions made directly to this library would have to be moved over to our generation code, +otherwise they would be overwritten upon the next generated release. Feel free to open a PR as +a proof of concept, but know that we will not be able to merge it as-is. We suggest opening +an issue first to discuss with us! + +On the other hand, contributions to the README are always very welcome! diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..728f6973 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,29 @@ +# Square legacy compatiblity + +While the new SDK has a lot of improvements, we at Square understand that +it takes time to upgrade when there are breaking changes. To make the +migration easier, the new SDK can be used alongisde legacy SDK, which is +now published as `squareup_legacy`. + +This example demonstrates how you can use the legacy SDK alongside the new +SDK inside a single file. + +```python +from square import Square +from square_legacy.client import Client as LegacySquare + + +def main(): + client = Square(token="") + legacy_client = LegacySquare(access_token="") + + ... +``` + +You can run the example with the following: + +```sh +cd example +poetry install +poetry run run-example +``` \ No newline at end of file diff --git a/examples/poetry.lock b/examples/poetry.lock new file mode 100644 index 00000000..192a3f48 --- /dev/null +++ b/examples/poetry.lock @@ -0,0 +1,703 @@ +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. + +[[package]] +name = "annotated-types" +version = "0.7.0" +description = "Reusable constraint types to use with typing.Annotated" +optional = false +python-versions = ">=3.8" +files = [ + {file = "annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53"}, + {file = "annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89"}, +] + +[package.dependencies] +typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.9\""} + +[[package]] +name = "anyio" +version = "4.5.2" +description = "High level compatibility layer for multiple asynchronous event loop implementations" +optional = false +python-versions = ">=3.8" +files = [ + {file = "anyio-4.5.2-py3-none-any.whl", hash = "sha256:c011ee36bc1e8ba40e5a81cb9df91925c218fe9b778554e0b56a21e1b5d4716f"}, + {file = "anyio-4.5.2.tar.gz", hash = "sha256:23009af4ed04ce05991845451e11ef02fc7c5ed29179ac9a420e5ad0ac7ddc5b"}, +] + +[package.dependencies] +exceptiongroup = {version = ">=1.0.2", markers = "python_version < \"3.11\""} +idna = ">=2.8" +sniffio = ">=1.1" +typing-extensions = {version = ">=4.1", markers = "python_version < \"3.11\""} + +[package.extras] +doc = ["Sphinx (>=7.4,<8.0)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd-theme"] +test = ["anyio[trio]", "coverage[toml] (>=7)", "exceptiongroup (>=1.2.0)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "truststore (>=0.9.1)", "uvloop (>=0.21.0b1)"] +trio = ["trio (>=0.26.1)"] + +[[package]] +name = "apimatic-core" +version = "0.2.19" +description = "A library that contains core logic and utilities for consuming REST APIs using Python SDKs generated by APIMatic." +optional = false +python-versions = "*" +files = [ + {file = "apimatic_core-0.2.19-py3-none-any.whl", hash = "sha256:9f9f2c15ee290a3fc81939b40b4a96648358787feab003212ec80c1f100dbcd8"}, + {file = "apimatic_core-0.2.19.tar.gz", hash = "sha256:42aab56a20ab6dc5d33f5343f77b3ab7849d765520363451a114e842080a7266"}, +] + +[package.dependencies] +apimatic-core-interfaces = ">=0.1.0,<0.2.0" +jsonpickle = ">=3.3.0,<3.4.0" +jsonpointer = ">=2.3,<3.0" +python-dateutil = ">=2.8,<3.0" +requests = ">=2.31,<3.0" +setuptools = ">=68.0.0" + +[[package]] +name = "apimatic-core-interfaces" +version = "0.1.6" +description = "An abstract layer of the functionalities provided by apimatic-core-library, requests-client-adapter and APIMatic SDKs." +optional = false +python-versions = "*" +files = [ + {file = "apimatic_core_interfaces-0.1.6-py3-none-any.whl", hash = "sha256:c739222f562b477d5ae0d41ba85c3622325cf6720593b95b8242fa1596a63afe"}, + {file = "apimatic_core_interfaces-0.1.6.tar.gz", hash = "sha256:786b6a564d6005b0040581dba2c8e28286c19e29096970dfcac025c0e12327c8"}, +] + +[[package]] +name = "apimatic-requests-client-adapter" +version = "0.1.7" +description = "An adapter for requests client library consumed by the SDKs generated with APIMatic" +optional = false +python-versions = "*" +files = [ + {file = "apimatic_requests_client_adapter-0.1.7-py3-none-any.whl", hash = "sha256:47e1fa946f14d4cdd029b8a66d2a4abcbd8fd1fda5355eb8e702be8e105523f1"}, + {file = "apimatic_requests_client_adapter-0.1.7.tar.gz", hash = "sha256:a6215a63c39885f390c0c91f1ac023e60f0c8ae958f72ba903ede5ed2bcf4a2e"}, +] + +[package.dependencies] +apimatic-core-interfaces = ">=0.1.0,<0.2.0" +cachecontrol = ">=0.12.6,<0.13.0" +requests = ">=2.31,<3.0" + +[[package]] +name = "cachecontrol" +version = "0.12.14" +description = "httplib2 caching for requests" +optional = false +python-versions = ">=3.6" +files = [ + {file = "CacheControl-0.12.14-py2.py3-none-any.whl", hash = "sha256:1c2939be362a70c4e5f02c6249462b3b7a24441e4f1ced5e9ef028172edf356a"}, + {file = "CacheControl-0.12.14.tar.gz", hash = "sha256:d1087f45781c0e00616479bfd282c78504371ca71da017b49df9f5365a95feba"}, +] + +[package.dependencies] +msgpack = ">=0.5.2" +requests = "*" + +[package.extras] +filecache = ["lockfile (>=0.9)"] +redis = ["redis (>=2.10.5)"] + +[[package]] +name = "certifi" +version = "2025.1.31" +description = "Python package for providing Mozilla's CA Bundle." +optional = false +python-versions = ">=3.6" +files = [ + {file = "certifi-2025.1.31-py3-none-any.whl", hash = "sha256:ca78db4565a652026a4db2bcdf68f2fb589ea80d0be70e03929ed730746b84fe"}, + {file = "certifi-2025.1.31.tar.gz", hash = "sha256:3d5da6925056f6f18f119200434a4780a94263f10d1c21d032a6f6b2baa20651"}, +] + +[[package]] +name = "charset-normalizer" +version = "3.4.1" +description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." +optional = false +python-versions = ">=3.7" +files = [ + {file = "charset_normalizer-3.4.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:91b36a978b5ae0ee86c394f5a54d6ef44db1de0815eb43de826d41d21e4af3de"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7461baadb4dc00fd9e0acbe254e3d7d2112e7f92ced2adc96e54ef6501c5f176"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e218488cd232553829be0664c2292d3af2eeeb94b32bea483cf79ac6a694e037"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:80ed5e856eb7f30115aaf94e4a08114ccc8813e6ed1b5efa74f9f82e8509858f"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b010a7a4fd316c3c484d482922d13044979e78d1861f0e0650423144c616a46a"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4532bff1b8421fd0a320463030c7520f56a79c9024a4e88f01c537316019005a"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:d973f03c0cb71c5ed99037b870f2be986c3c05e63622c017ea9816881d2dd247"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:3a3bd0dcd373514dcec91c411ddb9632c0d7d92aed7093b8c3bbb6d69ca74408"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:d9c3cdf5390dcd29aa8056d13e8e99526cda0305acc038b96b30352aff5ff2bb"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:2bdfe3ac2e1bbe5b59a1a63721eb3b95fc9b6817ae4a46debbb4e11f6232428d"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:eab677309cdb30d047996b36d34caeda1dc91149e4fdca0b1a039b3f79d9a807"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-win32.whl", hash = "sha256:c0429126cf75e16c4f0ad00ee0eae4242dc652290f940152ca8c75c3a4b6ee8f"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-win_amd64.whl", hash = "sha256:9f0b8b1c6d84c8034a44893aba5e767bf9c7a211e313a9605d9c617d7083829f"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:8bfa33f4f2672964266e940dd22a195989ba31669bd84629f05fab3ef4e2d125"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:28bf57629c75e810b6ae989f03c0828d64d6b26a5e205535585f96093e405ed1"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f08ff5e948271dc7e18a35641d2f11a4cd8dfd5634f55228b691e62b37125eb3"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:234ac59ea147c59ee4da87a0c0f098e9c8d169f4dc2a159ef720f1a61bbe27cd"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fd4ec41f914fa74ad1b8304bbc634b3de73d2a0889bd32076342a573e0779e00"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eea6ee1db730b3483adf394ea72f808b6e18cf3cb6454b4d86e04fa8c4327a12"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:c96836c97b1238e9c9e3fe90844c947d5afbf4f4c92762679acfe19927d81d77"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:4d86f7aff21ee58f26dcf5ae81a9addbd914115cdebcbb2217e4f0ed8982e146"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:09b5e6733cbd160dcc09589227187e242a30a49ca5cefa5a7edd3f9d19ed53fd"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:5777ee0881f9499ed0f71cc82cf873d9a0ca8af166dfa0af8ec4e675b7df48e6"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:237bdbe6159cff53b4f24f397d43c6336c6b0b42affbe857970cefbb620911c8"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-win32.whl", hash = "sha256:8417cb1f36cc0bc7eaba8ccb0e04d55f0ee52df06df3ad55259b9a323555fc8b"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-win_amd64.whl", hash = "sha256:d7f50a1f8c450f3925cb367d011448c39239bb3eb4117c36a6d354794de4ce76"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:73d94b58ec7fecbc7366247d3b0b10a21681004153238750bb67bd9012414545"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dad3e487649f498dd991eeb901125411559b22e8d7ab25d3aeb1af367df5efd7"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c30197aa96e8eed02200a83fba2657b4c3acd0f0aa4bdc9f6c1af8e8962e0757"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2369eea1ee4a7610a860d88f268eb39b95cb588acd7235e02fd5a5601773d4fa"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc2722592d8998c870fa4e290c2eec2c1569b87fe58618e67d38b4665dfa680d"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffc9202a29ab3920fa812879e95a9e78b2465fd10be7fcbd042899695d75e616"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:804a4d582ba6e5b747c625bf1255e6b1507465494a40a2130978bda7b932c90b"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0f55e69f030f7163dffe9fd0752b32f070566451afe180f99dbeeb81f511ad8d"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c4c3e6da02df6fa1410a7680bd3f63d4f710232d3139089536310d027950696a"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:5df196eb874dae23dcfb968c83d4f8fdccb333330fe1fc278ac5ceeb101003a9"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e358e64305fe12299a08e08978f51fc21fac060dcfcddd95453eabe5b93ed0e1"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-win32.whl", hash = "sha256:9b23ca7ef998bc739bf6ffc077c2116917eabcc901f88da1b9856b210ef63f35"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-win_amd64.whl", hash = "sha256:6ff8a4a60c227ad87030d76e99cd1698345d4491638dfa6673027c48b3cd395f"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:aabfa34badd18f1da5ec1bc2715cadc8dca465868a4e73a0173466b688f29dda"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22e14b5d70560b8dd51ec22863f370d1e595ac3d024cb8ad7d308b4cd95f8313"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8436c508b408b82d87dc5f62496973a1805cd46727c34440b0d29d8a2f50a6c9"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2d074908e1aecee37a7635990b2c6d504cd4766c7bc9fc86d63f9c09af3fa11b"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:955f8851919303c92343d2f66165294848d57e9bba6cf6e3625485a70a038d11"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:44ecbf16649486d4aebafeaa7ec4c9fed8b88101f4dd612dcaf65d5e815f837f"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:0924e81d3d5e70f8126529951dac65c1010cdf117bb75eb02dd12339b57749dd"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:2967f74ad52c3b98de4c3b32e1a44e32975e008a9cd2a8cc8966d6a5218c5cb2"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:c75cb2a3e389853835e84a2d8fb2b81a10645b503eca9bcb98df6b5a43eb8886"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:09b26ae6b1abf0d27570633b2b078a2a20419c99d66fb2823173d73f188ce601"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:fa88b843d6e211393a37219e6a1c1df99d35e8fd90446f1118f4216e307e48cd"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-win32.whl", hash = "sha256:eb8178fe3dba6450a3e024e95ac49ed3400e506fd4e9e5c32d30adda88cbd407"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-win_amd64.whl", hash = "sha256:b1ac5992a838106edb89654e0aebfc24f5848ae2547d22c2c3f66454daa11971"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f30bf9fd9be89ecb2360c7d94a711f00c09b976258846efe40db3d05828e8089"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:97f68b8d6831127e4787ad15e6757232e14e12060bec17091b85eb1486b91d8d"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7974a0b5ecd505609e3b19742b60cee7aa2aa2fb3151bc917e6e2646d7667dcf"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fc54db6c8593ef7d4b2a331b58653356cf04f67c960f584edb7c3d8c97e8f39e"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:311f30128d7d333eebd7896965bfcfbd0065f1716ec92bd5638d7748eb6f936a"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_aarch64.whl", hash = "sha256:7d053096f67cd1241601111b698f5cad775f97ab25d81567d3f59219b5f1adbd"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_i686.whl", hash = "sha256:807f52c1f798eef6cf26beb819eeb8819b1622ddfeef9d0977a8502d4db6d534"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_ppc64le.whl", hash = "sha256:dccbe65bd2f7f7ec22c4ff99ed56faa1e9f785482b9bbd7c717e26fd723a1d1e"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_s390x.whl", hash = "sha256:2fb9bd477fdea8684f78791a6de97a953c51831ee2981f8e4f583ff3b9d9687e"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_x86_64.whl", hash = "sha256:01732659ba9b5b873fc117534143e4feefecf3b2078b0a6a2e925271bb6f4cfa"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-win32.whl", hash = "sha256:7a4f97a081603d2050bfaffdefa5b02a9ec823f8348a572e39032caa8404a487"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:7b1bef6280950ee6c177b326508f86cad7ad4dff12454483b51d8b7d673a2c5d"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:ecddf25bee22fe4fe3737a399d0d177d72bc22be6913acfab364b40bce1ba83c"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c60ca7339acd497a55b0ea5d506b2a2612afb2826560416f6894e8b5770d4a9"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b7b2d86dd06bfc2ade3312a83a5c364c7ec2e3498f8734282c6c3d4b07b346b8"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dd78cfcda14a1ef52584dbb008f7ac81c1328c0f58184bf9a84c49c605002da6"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e27f48bcd0957c6d4cb9d6fa6b61d192d0b13d5ef563e5f2ae35feafc0d179c"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:01ad647cdd609225c5350561d084b42ddf732f4eeefe6e678765636791e78b9a"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:619a609aa74ae43d90ed2e89bdd784765de0a25ca761b93e196d938b8fd1dbbd"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:89149166622f4db9b4b6a449256291dc87a99ee53151c74cbd82a53c8c2f6ccd"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:7709f51f5f7c853f0fb938bcd3bc59cdfdc5203635ffd18bf354f6967ea0f824"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:345b0426edd4e18138d6528aed636de7a9ed169b4aaf9d61a8c19e39d26838ca"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:0907f11d019260cdc3f94fbdb23ff9125f6b5d1039b76003b5b0ac9d6a6c9d5b"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-win32.whl", hash = "sha256:ea0d8d539afa5eb2728aa1932a988a9a7af94f18582ffae4bc10b3fbdad0626e"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:329ce159e82018d646c7ac45b01a430369d526569ec08516081727a20e9e4af4"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:b97e690a2118911e39b4042088092771b4ae3fc3aa86518f84b8cf6888dbdb41"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:78baa6d91634dfb69ec52a463534bc0df05dbd546209b79a3880a34487f4b84f"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1a2bc9f351a75ef49d664206d51f8e5ede9da246602dc2d2726837620ea034b2"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:75832c08354f595c760a804588b9357d34ec00ba1c940c15e31e96d902093770"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0af291f4fe114be0280cdd29d533696a77b5b49cfde5467176ecab32353395c4"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0167ddc8ab6508fe81860a57dd472b2ef4060e8d378f0cc555707126830f2537"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:2a75d49014d118e4198bcee5ee0a6f25856b29b12dbf7cd012791f8a6cc5c496"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:363e2f92b0f0174b2f8238240a1a30142e3db7b957a5dd5689b0e75fb717cc78"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:ab36c8eb7e454e34e60eb55ca5d241a5d18b2c6244f6827a30e451c42410b5f7"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:4c0907b1928a36d5a998d72d64d8eaa7244989f7aaaf947500d3a800c83a3fd6"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:04432ad9479fa40ec0f387795ddad4437a2b50417c69fa275e212933519ff294"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-win32.whl", hash = "sha256:3bed14e9c89dcb10e8f3a29f9ccac4955aebe93c71ae803af79265c9ca5644c5"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:49402233c892a461407c512a19435d1ce275543138294f7ef013f0b63d5d3765"}, + {file = "charset_normalizer-3.4.1-py3-none-any.whl", hash = "sha256:d98b1668f06378c6dbefec3b92299716b931cd4e6061f3c875a71ced1780ab85"}, + {file = "charset_normalizer-3.4.1.tar.gz", hash = "sha256:44251f18cd68a75b56585dd00dae26183e102cd5e0f9f1466e6df5da2ed64ea3"}, +] + +[[package]] +name = "deprecation" +version = "2.1.0" +description = "A library to handle automated deprecations" +optional = false +python-versions = "*" +files = [ + {file = "deprecation-2.1.0-py2.py3-none-any.whl", hash = "sha256:a10811591210e1fb0e768a8c25517cabeabcba6f0bf96564f8ff45189f90b14a"}, + {file = "deprecation-2.1.0.tar.gz", hash = "sha256:72b3bde64e5d778694b0cf68178aed03d15e15477116add3fb773e581f9518ff"}, +] + +[package.dependencies] +packaging = "*" + +[[package]] +name = "exceptiongroup" +version = "1.2.2" +description = "Backport of PEP 654 (exception groups)" +optional = false +python-versions = ">=3.7" +files = [ + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, +] + +[package.extras] +test = ["pytest (>=6)"] + +[[package]] +name = "h11" +version = "0.14.0" +description = "A pure-Python, bring-your-own-I/O implementation of HTTP/1.1" +optional = false +python-versions = ">=3.7" +files = [ + {file = "h11-0.14.0-py3-none-any.whl", hash = "sha256:e3fe4ac4b851c468cc8363d500db52c2ead036020723024a109d37346efaa761"}, + {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"}, +] + +[[package]] +name = "httpcore" +version = "1.0.8" +description = "A minimal low-level HTTP client." +optional = false +python-versions = ">=3.8" +files = [ + {file = "httpcore-1.0.8-py3-none-any.whl", hash = "sha256:5254cf149bcb5f75e9d1b2b9f729ea4a4b883d1ad7379fc632b727cec23674be"}, + {file = "httpcore-1.0.8.tar.gz", hash = "sha256:86e94505ed24ea06514883fd44d2bc02d90e77e7979c8eb71b90f41d364a1bad"}, +] + +[package.dependencies] +certifi = "*" +h11 = ">=0.13,<0.15" + +[package.extras] +asyncio = ["anyio (>=4.0,<5.0)"] +http2 = ["h2 (>=3,<5)"] +socks = ["socksio (==1.*)"] +trio = ["trio (>=0.22.0,<1.0)"] + +[[package]] +name = "httpx" +version = "0.28.1" +description = "The next generation HTTP client." +optional = false +python-versions = ">=3.8" +files = [ + {file = "httpx-0.28.1-py3-none-any.whl", hash = "sha256:d909fcccc110f8c7faf814ca82a9a4d816bc5a6dbfea25d6591d6985b8ba59ad"}, + {file = "httpx-0.28.1.tar.gz", hash = "sha256:75e98c5f16b0f35b567856f597f06ff2270a374470a5c2392242528e3e3e42fc"}, +] + +[package.dependencies] +anyio = "*" +certifi = "*" +httpcore = "==1.*" +idna = "*" + +[package.extras] +brotli = ["brotli", "brotlicffi"] +cli = ["click (==8.*)", "pygments (==2.*)", "rich (>=10,<14)"] +http2 = ["h2 (>=3,<5)"] +socks = ["socksio (==1.*)"] +zstd = ["zstandard (>=0.18.0)"] + +[[package]] +name = "idna" +version = "3.10" +description = "Internationalized Domain Names in Applications (IDNA)" +optional = false +python-versions = ">=3.6" +files = [ + {file = "idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3"}, + {file = "idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9"}, +] + +[package.extras] +all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"] + +[[package]] +name = "jsonpickle" +version = "3.3.0" +description = "Python library for serializing arbitrary object graphs into JSON" +optional = false +python-versions = ">=3.7" +files = [ + {file = "jsonpickle-3.3.0-py3-none-any.whl", hash = "sha256:287c12143f35571ab00e224fa323aa4b090d5a7f086f5f494d7ee9c7eb1a380a"}, + {file = "jsonpickle-3.3.0.tar.gz", hash = "sha256:ab467e601e5b1a1cd76f1819d014795165da071744ef30bf3786e9bc549de25a"}, +] + +[package.extras] +docs = ["furo", "rst.linker (>=1.9)", "sphinx"] +packaging = ["build", "twine"] +testing = ["bson", "ecdsa", "feedparser", "gmpy2", "numpy", "pandas", "pymongo", "pytest (>=3.5,!=3.7.3)", "pytest-benchmark", "pytest-benchmark[histogram]", "pytest-checkdocs (>=1.2.3)", "pytest-cov", "pytest-enabler (>=1.0.1)", "pytest-ruff (>=0.2.1)", "scikit-learn", "scipy", "scipy (>=1.9.3)", "simplejson", "sqlalchemy", "ujson"] + +[[package]] +name = "jsonpointer" +version = "2.4" +description = "Identify specific nodes in a JSON document (RFC 6901)" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*" +files = [ + {file = "jsonpointer-2.4-py2.py3-none-any.whl", hash = "sha256:15d51bba20eea3165644553647711d150376234112651b4f1811022aecad7d7a"}, + {file = "jsonpointer-2.4.tar.gz", hash = "sha256:585cee82b70211fa9e6043b7bb89db6e1aa49524340dde8ad6b63206ea689d88"}, +] + +[[package]] +name = "msgpack" +version = "1.1.0" +description = "MessagePack serializer" +optional = false +python-versions = ">=3.8" +files = [ + {file = "msgpack-1.1.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:7ad442d527a7e358a469faf43fda45aaf4ac3249c8310a82f0ccff9164e5dccd"}, + {file = "msgpack-1.1.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:74bed8f63f8f14d75eec75cf3d04ad581da6b914001b474a5d3cd3372c8cc27d"}, + {file = "msgpack-1.1.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:914571a2a5b4e7606997e169f64ce53a8b1e06f2cf2c3a7273aa106236d43dd5"}, + {file = "msgpack-1.1.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c921af52214dcbb75e6bdf6a661b23c3e6417f00c603dd2070bccb5c3ef499f5"}, + {file = "msgpack-1.1.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d8ce0b22b890be5d252de90d0e0d119f363012027cf256185fc3d474c44b1b9e"}, + {file = "msgpack-1.1.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:73322a6cc57fcee3c0c57c4463d828e9428275fb85a27aa2aa1a92fdc42afd7b"}, + {file = "msgpack-1.1.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:e1f3c3d21f7cf67bcf2da8e494d30a75e4cf60041d98b3f79875afb5b96f3a3f"}, + {file = "msgpack-1.1.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:64fc9068d701233effd61b19efb1485587560b66fe57b3e50d29c5d78e7fef68"}, + {file = "msgpack-1.1.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:42f754515e0f683f9c79210a5d1cad631ec3d06cea5172214d2176a42e67e19b"}, + {file = "msgpack-1.1.0-cp310-cp310-win32.whl", hash = "sha256:3df7e6b05571b3814361e8464f9304c42d2196808e0119f55d0d3e62cd5ea044"}, + {file = "msgpack-1.1.0-cp310-cp310-win_amd64.whl", hash = "sha256:685ec345eefc757a7c8af44a3032734a739f8c45d1b0ac45efc5d8977aa4720f"}, + {file = "msgpack-1.1.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:3d364a55082fb2a7416f6c63ae383fbd903adb5a6cf78c5b96cc6316dc1cedc7"}, + {file = "msgpack-1.1.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:79ec007767b9b56860e0372085f8504db5d06bd6a327a335449508bbee9648fa"}, + {file = "msgpack-1.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:6ad622bf7756d5a497d5b6836e7fc3752e2dd6f4c648e24b1803f6048596f701"}, + {file = "msgpack-1.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8e59bca908d9ca0de3dc8684f21ebf9a690fe47b6be93236eb40b99af28b6ea6"}, + {file = "msgpack-1.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5e1da8f11a3dd397f0a32c76165cf0c4eb95b31013a94f6ecc0b280c05c91b59"}, + {file = "msgpack-1.1.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:452aff037287acb1d70a804ffd022b21fa2bb7c46bee884dbc864cc9024128a0"}, + {file = "msgpack-1.1.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8da4bf6d54ceed70e8861f833f83ce0814a2b72102e890cbdfe4b34764cdd66e"}, + {file = "msgpack-1.1.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:41c991beebf175faf352fb940bf2af9ad1fb77fd25f38d9142053914947cdbf6"}, + {file = "msgpack-1.1.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a52a1f3a5af7ba1c9ace055b659189f6c669cf3657095b50f9602af3a3ba0fe5"}, + {file = "msgpack-1.1.0-cp311-cp311-win32.whl", hash = "sha256:58638690ebd0a06427c5fe1a227bb6b8b9fdc2bd07701bec13c2335c82131a88"}, + {file = "msgpack-1.1.0-cp311-cp311-win_amd64.whl", hash = "sha256:fd2906780f25c8ed5d7b323379f6138524ba793428db5d0e9d226d3fa6aa1788"}, + {file = "msgpack-1.1.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:d46cf9e3705ea9485687aa4001a76e44748b609d260af21c4ceea7f2212a501d"}, + {file = "msgpack-1.1.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:5dbad74103df937e1325cc4bfeaf57713be0b4f15e1c2da43ccdd836393e2ea2"}, + {file = "msgpack-1.1.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:58dfc47f8b102da61e8949708b3eafc3504509a5728f8b4ddef84bd9e16ad420"}, + {file = "msgpack-1.1.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4676e5be1b472909b2ee6356ff425ebedf5142427842aa06b4dfd5117d1ca8a2"}, + {file = "msgpack-1.1.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17fb65dd0bec285907f68b15734a993ad3fc94332b5bb21b0435846228de1f39"}, + {file = "msgpack-1.1.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a51abd48c6d8ac89e0cfd4fe177c61481aca2d5e7ba42044fd218cfd8ea9899f"}, + {file = "msgpack-1.1.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:2137773500afa5494a61b1208619e3871f75f27b03bcfca7b3a7023284140247"}, + {file = "msgpack-1.1.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:398b713459fea610861c8a7b62a6fec1882759f308ae0795b5413ff6a160cf3c"}, + {file = "msgpack-1.1.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:06f5fd2f6bb2a7914922d935d3b8bb4a7fff3a9a91cfce6d06c13bc42bec975b"}, + {file = "msgpack-1.1.0-cp312-cp312-win32.whl", hash = "sha256:ad33e8400e4ec17ba782f7b9cf868977d867ed784a1f5f2ab46e7ba53b6e1e1b"}, + {file = "msgpack-1.1.0-cp312-cp312-win_amd64.whl", hash = "sha256:115a7af8ee9e8cddc10f87636767857e7e3717b7a2e97379dc2054712693e90f"}, + {file = "msgpack-1.1.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:071603e2f0771c45ad9bc65719291c568d4edf120b44eb36324dcb02a13bfddf"}, + {file = "msgpack-1.1.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:0f92a83b84e7c0749e3f12821949d79485971f087604178026085f60ce109330"}, + {file = "msgpack-1.1.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:4a1964df7b81285d00a84da4e70cb1383f2e665e0f1f2a7027e683956d04b734"}, + {file = "msgpack-1.1.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:59caf6a4ed0d164055ccff8fe31eddc0ebc07cf7326a2aaa0dbf7a4001cd823e"}, + {file = "msgpack-1.1.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0907e1a7119b337971a689153665764adc34e89175f9a34793307d9def08e6ca"}, + {file = "msgpack-1.1.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:65553c9b6da8166e819a6aa90ad15288599b340f91d18f60b2061f402b9a4915"}, + {file = "msgpack-1.1.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:7a946a8992941fea80ed4beae6bff74ffd7ee129a90b4dd5cf9c476a30e9708d"}, + {file = "msgpack-1.1.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:4b51405e36e075193bc051315dbf29168d6141ae2500ba8cd80a522964e31434"}, + {file = "msgpack-1.1.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:b4c01941fd2ff87c2a934ee6055bda4ed353a7846b8d4f341c428109e9fcde8c"}, + {file = "msgpack-1.1.0-cp313-cp313-win32.whl", hash = "sha256:7c9a35ce2c2573bada929e0b7b3576de647b0defbd25f5139dcdaba0ae35a4cc"}, + {file = "msgpack-1.1.0-cp313-cp313-win_amd64.whl", hash = "sha256:bce7d9e614a04d0883af0b3d4d501171fbfca038f12c77fa838d9f198147a23f"}, + {file = "msgpack-1.1.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c40ffa9a15d74e05ba1fe2681ea33b9caffd886675412612d93ab17b58ea2fec"}, + {file = "msgpack-1.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f1ba6136e650898082d9d5a5217d5906d1e138024f836ff48691784bbe1adf96"}, + {file = "msgpack-1.1.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e0856a2b7e8dcb874be44fea031d22e5b3a19121be92a1e098f46068a11b0870"}, + {file = "msgpack-1.1.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:471e27a5787a2e3f974ba023f9e265a8c7cfd373632247deb225617e3100a3c7"}, + {file = "msgpack-1.1.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:646afc8102935a388ffc3914b336d22d1c2d6209c773f3eb5dd4d6d3b6f8c1cb"}, + {file = "msgpack-1.1.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:13599f8829cfbe0158f6456374e9eea9f44eee08076291771d8ae93eda56607f"}, + {file = "msgpack-1.1.0-cp38-cp38-win32.whl", hash = "sha256:8a84efb768fb968381e525eeeb3d92857e4985aacc39f3c47ffd00eb4509315b"}, + {file = "msgpack-1.1.0-cp38-cp38-win_amd64.whl", hash = "sha256:879a7b7b0ad82481c52d3c7eb99bf6f0645dbdec5134a4bddbd16f3506947feb"}, + {file = "msgpack-1.1.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:53258eeb7a80fc46f62fd59c876957a2d0e15e6449a9e71842b6d24419d88ca1"}, + {file = "msgpack-1.1.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:7e7b853bbc44fb03fbdba34feb4bd414322180135e2cb5164f20ce1c9795ee48"}, + {file = "msgpack-1.1.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f3e9b4936df53b970513eac1758f3882c88658a220b58dcc1e39606dccaaf01c"}, + {file = "msgpack-1.1.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:46c34e99110762a76e3911fc923222472c9d681f1094096ac4102c18319e6468"}, + {file = "msgpack-1.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8a706d1e74dd3dea05cb54580d9bd8b2880e9264856ce5068027eed09680aa74"}, + {file = "msgpack-1.1.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:534480ee5690ab3cbed89d4c8971a5c631b69a8c0883ecfea96c19118510c846"}, + {file = "msgpack-1.1.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:8cf9e8c3a2153934a23ac160cc4cba0ec035f6867c8013cc6077a79823370346"}, + {file = "msgpack-1.1.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:3180065ec2abbe13a4ad37688b61b99d7f9e012a535b930e0e683ad6bc30155b"}, + {file = "msgpack-1.1.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:c5a91481a3cc573ac8c0d9aace09345d989dc4a0202b7fcb312c88c26d4e71a8"}, + {file = "msgpack-1.1.0-cp39-cp39-win32.whl", hash = "sha256:f80bc7d47f76089633763f952e67f8214cb7b3ee6bfa489b3cb6a84cfac114cd"}, + {file = "msgpack-1.1.0-cp39-cp39-win_amd64.whl", hash = "sha256:4d1b7ff2d6146e16e8bd665ac726a89c74163ef8cd39fa8c1087d4e52d3a2325"}, + {file = "msgpack-1.1.0.tar.gz", hash = "sha256:dd432ccc2c72b914e4cb77afce64aab761c1137cc698be3984eee260bcb2896e"}, +] + +[[package]] +name = "packaging" +version = "24.2" +description = "Core utilities for Python packages" +optional = false +python-versions = ">=3.8" +files = [ + {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"}, + {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"}, +] + +[[package]] +name = "pydantic" +version = "2.10.6" +description = "Data validation using Python type hints" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pydantic-2.10.6-py3-none-any.whl", hash = "sha256:427d664bf0b8a2b34ff5dd0f5a18df00591adcee7198fbd71981054cef37b584"}, + {file = "pydantic-2.10.6.tar.gz", hash = "sha256:ca5daa827cce33de7a42be142548b0096bf05a7e7b365aebfa5f8eeec7128236"}, +] + +[package.dependencies] +annotated-types = ">=0.6.0" +pydantic-core = "2.27.2" +typing-extensions = ">=4.12.2" + +[package.extras] +email = ["email-validator (>=2.0.0)"] +timezone = ["tzdata"] + +[[package]] +name = "pydantic-core" +version = "2.27.2" +description = "Core functionality for Pydantic validation and serialization" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pydantic_core-2.27.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2d367ca20b2f14095a8f4fa1210f5a7b78b8a20009ecced6b12818f455b1e9fa"}, + {file = "pydantic_core-2.27.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:491a2b73db93fab69731eaee494f320faa4e093dbed776be1a829c2eb222c34c"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7969e133a6f183be60e9f6f56bfae753585680f3b7307a8e555a948d443cc05a"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:3de9961f2a346257caf0aa508a4da705467f53778e9ef6fe744c038119737ef5"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e2bb4d3e5873c37bb3dd58714d4cd0b0e6238cebc4177ac8fe878f8b3aa8e74c"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:280d219beebb0752699480fe8f1dc61ab6615c2046d76b7ab7ee38858de0a4e7"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47956ae78b6422cbd46f772f1746799cbb862de838fd8d1fbd34a82e05b0983a"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:14d4a5c49d2f009d62a2a7140d3064f686d17a5d1a268bc641954ba181880236"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:337b443af21d488716f8d0b6164de833e788aa6bd7e3a39c005febc1284f4962"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_armv7l.whl", hash = "sha256:03d0f86ea3184a12f41a2d23f7ccb79cdb5a18e06993f8a45baa8dfec746f0e9"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7041c36f5680c6e0f08d922aed302e98b3745d97fe1589db0a3eebf6624523af"}, + {file = "pydantic_core-2.27.2-cp310-cp310-win32.whl", hash = "sha256:50a68f3e3819077be2c98110c1f9dcb3817e93f267ba80a2c05bb4f8799e2ff4"}, + {file = "pydantic_core-2.27.2-cp310-cp310-win_amd64.whl", hash = "sha256:e0fd26b16394ead34a424eecf8a31a1f5137094cabe84a1bcb10fa6ba39d3d31"}, + {file = "pydantic_core-2.27.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:8e10c99ef58cfdf2a66fc15d66b16c4a04f62bca39db589ae8cba08bc55331bc"}, + {file = "pydantic_core-2.27.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:26f32e0adf166a84d0cb63be85c562ca8a6fa8de28e5f0d92250c6b7e9e2aff7"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c19d1ea0673cd13cc2f872f6c9ab42acc4e4f492a7ca9d3795ce2b112dd7e15"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5e68c4446fe0810e959cdff46ab0a41ce2f2c86d227d96dc3847af0ba7def306"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d9640b0059ff4f14d1f37321b94061c6db164fbe49b334b31643e0528d100d99"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:40d02e7d45c9f8af700f3452f329ead92da4c5f4317ca9b896de7ce7199ea459"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1c1fd185014191700554795c99b347d64f2bb637966c4cfc16998a0ca700d048"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d81d2068e1c1228a565af076598f9e7451712700b673de8f502f0334f281387d"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:1a4207639fb02ec2dbb76227d7c751a20b1a6b4bc52850568e52260cae64ca3b"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_armv7l.whl", hash = "sha256:3de3ce3c9ddc8bbd88f6e0e304dea0e66d843ec9de1b0042b0911c1663ffd474"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:30c5f68ded0c36466acede341551106821043e9afaad516adfb6e8fa80a4e6a6"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win32.whl", hash = "sha256:c70c26d2c99f78b125a3459f8afe1aed4d9687c24fd677c6a4436bc042e50d6c"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win_amd64.whl", hash = "sha256:08e125dbdc505fa69ca7d9c499639ab6407cfa909214d500897d02afb816e7cc"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win_arm64.whl", hash = "sha256:26f0d68d4b235a2bae0c3fc585c585b4ecc51382db0e3ba402a22cbc440915e4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:9e0c8cfefa0ef83b4da9588448b6d8d2a2bf1a53c3f1ae5fca39eb3061e2f0b0"}, + {file = "pydantic_core-2.27.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:83097677b8e3bd7eaa6775720ec8e0405f1575015a463285a92bfdfe254529ef"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:172fce187655fece0c90d90a678424b013f8fbb0ca8b036ac266749c09438cb7"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:519f29f5213271eeeeb3093f662ba2fd512b91c5f188f3bb7b27bc5973816934"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:05e3a55d124407fffba0dd6b0c0cd056d10e983ceb4e5dbd10dda135c31071d6"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9c3ed807c7b91de05e63930188f19e921d1fe90de6b4f5cd43ee7fcc3525cb8c"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6fb4aadc0b9a0c063206846d603b92030eb6f03069151a625667f982887153e2"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:28ccb213807e037460326424ceb8b5245acb88f32f3d2777427476e1b32c48c4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:de3cd1899e2c279b140adde9357c4495ed9d47131b4a4eaff9052f23398076b3"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:220f892729375e2d736b97d0e51466252ad84c51857d4d15f5e9692f9ef12be4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a0fcd29cd6b4e74fe8ddd2c90330fd8edf2e30cb52acda47f06dd615ae72da57"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win32.whl", hash = "sha256:1e2cb691ed9834cd6a8be61228471d0a503731abfb42f82458ff27be7b2186fc"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win_amd64.whl", hash = "sha256:cc3f1a99a4f4f9dd1de4fe0312c114e740b5ddead65bb4102884b384c15d8bc9"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win_arm64.whl", hash = "sha256:3911ac9284cd8a1792d3cb26a2da18f3ca26c6908cc434a18f730dc0db7bfa3b"}, + {file = "pydantic_core-2.27.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:7d14bd329640e63852364c306f4d23eb744e0f8193148d4044dd3dacdaacbd8b"}, + {file = "pydantic_core-2.27.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:82f91663004eb8ed30ff478d77c4d1179b3563df6cdb15c0817cd1cdaf34d154"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:71b24c7d61131bb83df10cc7e687433609963a944ccf45190cfc21e0887b08c9"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa8e459d4954f608fa26116118bb67f56b93b209c39b008277ace29937453dc9"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ce8918cbebc8da707ba805b7fd0b382816858728ae7fe19a942080c24e5b7cd1"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:eda3f5c2a021bbc5d976107bb302e0131351c2ba54343f8a496dc8783d3d3a6a"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bd8086fa684c4775c27f03f062cbb9eaa6e17f064307e86b21b9e0abc9c0f02e"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:8d9b3388db186ba0c099a6d20f0604a44eabdeef1777ddd94786cdae158729e4"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:7a66efda2387de898c8f38c0cf7f14fca0b51a8ef0b24bfea5849f1b3c95af27"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:18a101c168e4e092ab40dbc2503bdc0f62010e95d292b27827871dc85450d7ee"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:ba5dd002f88b78a4215ed2f8ddbdf85e8513382820ba15ad5ad8955ce0ca19a1"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win32.whl", hash = "sha256:1ebaf1d0481914d004a573394f4be3a7616334be70261007e47c2a6fe7e50130"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win_amd64.whl", hash = "sha256:953101387ecf2f5652883208769a79e48db18c6df442568a0b5ccd8c2723abee"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win_arm64.whl", hash = "sha256:ac4dbfd1691affb8f48c2c13241a2e3b60ff23247cbcf981759c768b6633cf8b"}, + {file = "pydantic_core-2.27.2-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:d3e8d504bdd3f10835468f29008d72fc8359d95c9c415ce6e767203db6127506"}, + {file = "pydantic_core-2.27.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:521eb9b7f036c9b6187f0b47318ab0d7ca14bd87f776240b90b21c1f4f149320"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85210c4d99a0114f5a9481b44560d7d1e35e32cc5634c656bc48e590b669b145"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d716e2e30c6f140d7560ef1538953a5cd1a87264c737643d481f2779fc247fe1"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f66d89ba397d92f840f8654756196d93804278457b5fbede59598a1f9f90b228"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:669e193c1c576a58f132e3158f9dfa9662969edb1a250c54d8fa52590045f046"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9fdbe7629b996647b99c01b37f11170a57ae675375b14b8c13b8518b8320ced5"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d262606bf386a5ba0b0af3b97f37c83d7011439e3dc1a9298f21efb292e42f1a"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:cabb9bcb7e0d97f74df8646f34fc76fbf793b7f6dc2438517d7a9e50eee4f14d"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_armv7l.whl", hash = "sha256:d2d63f1215638d28221f664596b1ccb3944f6e25dd18cd3b86b0a4c408d5ebb9"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:bca101c00bff0adb45a833f8451b9105d9df18accb8743b08107d7ada14bd7da"}, + {file = "pydantic_core-2.27.2-cp38-cp38-win32.whl", hash = "sha256:f6f8e111843bbb0dee4cb6594cdc73e79b3329b526037ec242a3e49012495b3b"}, + {file = "pydantic_core-2.27.2-cp38-cp38-win_amd64.whl", hash = "sha256:fd1aea04935a508f62e0d0ef1f5ae968774a32afc306fb8545e06f5ff5cdf3ad"}, + {file = "pydantic_core-2.27.2-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:c10eb4f1659290b523af58fa7cffb452a61ad6ae5613404519aee4bfbf1df993"}, + {file = "pydantic_core-2.27.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ef592d4bad47296fb11f96cd7dc898b92e795032b4894dfb4076cfccd43a9308"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c61709a844acc6bf0b7dce7daae75195a10aac96a596ea1b776996414791ede4"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:42c5f762659e47fdb7b16956c71598292f60a03aa92f8b6351504359dbdba6cf"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4c9775e339e42e79ec99c441d9730fccf07414af63eac2f0e48e08fd38a64d76"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:57762139821c31847cfb2df63c12f725788bd9f04bc2fb392790959b8f70f118"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0d1e85068e818c73e048fe28cfc769040bb1f475524f4745a5dc621f75ac7630"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:097830ed52fd9e427942ff3b9bc17fab52913b2f50f2880dc4a5611446606a54"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:044a50963a614ecfae59bb1eaf7ea7efc4bc62f49ed594e18fa1e5d953c40e9f"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_armv7l.whl", hash = "sha256:4e0b4220ba5b40d727c7f879eac379b822eee5d8fff418e9d3381ee45b3b0362"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5e4f4bb20d75e9325cc9696c6802657b58bc1dbbe3022f32cc2b2b632c3fbb96"}, + {file = "pydantic_core-2.27.2-cp39-cp39-win32.whl", hash = "sha256:cca63613e90d001b9f2f9a9ceb276c308bfa2a43fafb75c8031c4f66039e8c6e"}, + {file = "pydantic_core-2.27.2-cp39-cp39-win_amd64.whl", hash = "sha256:77d1bca19b0f7021b3a982e6f903dcd5b2b06076def36a652e3907f596e29f67"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:2bf14caea37e91198329b828eae1618c068dfb8ef17bb33287a7ad4b61ac314e"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:b0cb791f5b45307caae8810c2023a184c74605ec3bcbb67d13846c28ff731ff8"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:688d3fd9fcb71f41c4c015c023d12a79d1c4c0732ec9eb35d96e3388a120dcf3"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3d591580c34f4d731592f0e9fe40f9cc1b430d297eecc70b962e93c5c668f15f"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:82f986faf4e644ffc189a7f1aafc86e46ef70372bb153e7001e8afccc6e54133"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:bec317a27290e2537f922639cafd54990551725fc844249e64c523301d0822fc"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:0296abcb83a797db256b773f45773da397da75a08f5fcaef41f2044adec05f50"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:0d75070718e369e452075a6017fbf187f788e17ed67a3abd47fa934d001863d9"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:7e17b560be3c98a8e3aa66ce828bdebb9e9ac6ad5466fba92eb74c4c95cb1151"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:c33939a82924da9ed65dab5a65d427205a73181d8098e79b6b426bdf8ad4e656"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:00bad2484fa6bda1e216e7345a798bd37c68fb2d97558edd584942aa41b7d278"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c817e2b40aba42bac6f457498dacabc568c3b7a986fc9ba7c8d9d260b71485fb"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:251136cdad0cb722e93732cb45ca5299fb56e1344a833640bf93b2803f8d1bfd"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d2088237af596f0a524d3afc39ab3b036e8adb054ee57cbb1dcf8e09da5b29cc"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:d4041c0b966a84b4ae7a09832eb691a35aec90910cd2dbe7a208de59be77965b"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:8083d4e875ebe0b864ffef72a4304827015cff328a1be6e22cc850753bfb122b"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f141ee28a0ad2123b6611b6ceff018039df17f32ada8b534e6aa039545a3efb2"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7d0c8399fcc1848491f00e0314bd59fb34a9c008761bcb422a057670c3f65e35"}, + {file = "pydantic_core-2.27.2.tar.gz", hash = "sha256:eb026e5a4c1fee05726072337ff51d1efb6f59090b7da90d30ea58625b1ffb39"}, +] + +[package.dependencies] +typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0" + +[[package]] +name = "python-dateutil" +version = "2.9.0.post0" +description = "Extensions to the standard Python datetime module" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, + {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, +] + +[package.dependencies] +six = ">=1.5" + +[[package]] +name = "requests" +version = "2.32.3" +description = "Python HTTP for Humans." +optional = false +python-versions = ">=3.8" +files = [ + {file = "requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6"}, + {file = "requests-2.32.3.tar.gz", hash = "sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"}, +] + +[package.dependencies] +certifi = ">=2017.4.17" +charset-normalizer = ">=2,<4" +idna = ">=2.5,<4" +urllib3 = ">=1.21.1,<3" + +[package.extras] +socks = ["PySocks (>=1.5.6,!=1.5.7)"] +use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] + +[[package]] +name = "setuptools" +version = "75.3.2" +description = "Easily download, build, install, upgrade, and uninstall Python packages" +optional = false +python-versions = ">=3.8" +files = [ + {file = "setuptools-75.3.2-py3-none-any.whl", hash = "sha256:90ab613b6583fc02d5369cbca13ea26ea0e182d1df2d943ee9cbe81d4c61add9"}, + {file = "setuptools-75.3.2.tar.gz", hash = "sha256:3c1383e1038b68556a382c1e8ded8887cd20141b0eb5708a6c8d277de49364f5"}, +] + +[package.extras] +check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1)", "ruff (>=0.5.2)"] +core = ["importlib-metadata (>=6)", "importlib-resources (>=5.10.2)", "jaraco.collections", "jaraco.functools", "jaraco.text (>=3.7)", "more-itertools", "more-itertools (>=8.8)", "packaging", "packaging (>=24)", "platformdirs (>=4.2.2)", "tomli (>=2.0.1)", "wheel (>=0.43.0)"] +cover = ["pytest-cov"] +doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "pyproject-hooks (!=1.1)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier", "towncrier (<24.7)"] +enabler = ["pytest-enabler (>=2.2)"] +test = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "ini2toml[lite] (>=0.14)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "jaraco.test (>=5.5)", "packaging (>=23.2)", "pip (>=19.1)", "pyproject-hooks (!=1.1)", "pytest (>=6,!=8.1.*)", "pytest-home (>=0.5)", "pytest-perf", "pytest-subprocess", "pytest-timeout", "pytest-xdist (>=3)", "ruff (<=0.7.1)", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel (>=0.44.0)"] +type = ["importlib-metadata (>=7.0.2)", "jaraco.develop (>=7.21)", "mypy (==1.12.*)", "pytest-mypy"] + +[[package]] +name = "six" +version = "1.17.0" +description = "Python 2 and 3 compatibility utilities" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274"}, + {file = "six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81"}, +] + +[[package]] +name = "sniffio" +version = "1.3.1" +description = "Sniff out which async library your code is running under" +optional = false +python-versions = ">=3.7" +files = [ + {file = "sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2"}, + {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"}, +] + +[[package]] +name = "squareup" +version = "0.0.4" +description = "" +optional = false +python-versions = "^3.8" +files = [] +develop = true + +[package.dependencies] +httpx = ">=0.21.2" +pydantic = ">= 1.9.2" +pydantic-core = "^2.18.2" +typing_extensions = ">= 4.0.0" + +[package.source] +type = "directory" +url = ".." + +[[package]] +name = "squareup-legacy" +version = "41.0.0.20250416" +description = "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management." +optional = false +python-versions = "^3.7" +files = [] +develop = true + +[package.dependencies] +apimatic-core = "~=0.2.0, >= 0.2.17" +apimatic-core-interfaces = "~=0.1.0, >= 0.1.5" +apimatic-requests-client-adapter = "~=0.1.0, >= 0.1.6" +deprecation = "~=2.1" + +[package.source] +type = "directory" +url = "../legacy" + +[[package]] +name = "typing-extensions" +version = "4.13.2" +description = "Backported and Experimental Type Hints for Python 3.8+" +optional = false +python-versions = ">=3.8" +files = [ + {file = "typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c"}, + {file = "typing_extensions-4.13.2.tar.gz", hash = "sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef"}, +] + +[[package]] +name = "urllib3" +version = "2.2.3" +description = "HTTP library with thread-safe connection pooling, file post, and more." +optional = false +python-versions = ">=3.8" +files = [ + {file = "urllib3-2.2.3-py3-none-any.whl", hash = "sha256:ca899ca043dcb1bafa3e262d73aa25c465bfb49e0bd9dd5d59f1d0acba2f8fac"}, + {file = "urllib3-2.2.3.tar.gz", hash = "sha256:e7d814a81dad81e6caf2ec9fdedb284ecc9c73076b62654547cc64ccdcae26e9"}, +] + +[package.extras] +brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"] +h2 = ["h2 (>=4,<5)"] +socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] +zstd = ["zstandard (>=0.18.0)"] + +[metadata] +lock-version = "2.0" +python-versions = "^3.8" +content-hash = "6dac7e4306b0e30d04e4624ce97e212caae17d10422e4c779b1db58e62f7496c" diff --git a/examples/pyproject.toml b/examples/pyproject.toml new file mode 100644 index 00000000..9a36d926 --- /dev/null +++ b/examples/pyproject.toml @@ -0,0 +1,17 @@ +[tool.poetry] +name = "squareup-example" +version = "0.1.0" +description = "Example project demonstrating usage of square and square_legacy" +authors = [] +readme = "README.md" +packages = [ + { include = "example", from = "src" } +] + +[tool.poetry.dependencies] +python = "^3.8" +squareup = {path = "../", develop = true} # Use local square package +squareup-legacy = {path = "../legacy/", develop = true} # Use local square_legacy package + +[tool.poetry.scripts] +run-example = "example.main:main" \ No newline at end of file diff --git a/examples/src/example/main.py b/examples/src/example/main.py new file mode 100644 index 00000000..980c4938 --- /dev/null +++ b/examples/src/example/main.py @@ -0,0 +1,35 @@ +""" +Example script demonstrating how to use both square and square_legacy packages together. +""" + +from square_legacy.client import Client as LegacySquare # type: ignore + +from square import Square + + +def main(): + print("Using both square and square_legacy packages together") + + # Initialize clients from both packages + client = Square(token="") + legacy_client = LegacySquare(access_token="") + + # Use functionality from new client + print("\nUsing new square client:") + try: + response = client.payments.list() + print(f"New client payment results: {response.items}") + except Exception as e: + print(f"Example new client call failed: {e}") + + # Use functionality from legacy client + print("\nUsing legacy square client:") + try: + legacy_response = legacy_client.payments.list_payments() + print(f"Legacy client payment results: {legacy_response}") + except Exception as e: + print(f"Example legacy client call failed: {e}") + + +if __name__ == "__main__": + main() diff --git a/doc/api/apple-pay.md b/legacy/doc/api/apple-pay.md similarity index 100% rename from doc/api/apple-pay.md rename to legacy/doc/api/apple-pay.md diff --git a/doc/api/bank-accounts.md b/legacy/doc/api/bank-accounts.md similarity index 100% rename from doc/api/bank-accounts.md rename to legacy/doc/api/bank-accounts.md diff --git a/doc/api/booking-custom-attributes.md b/legacy/doc/api/booking-custom-attributes.md similarity index 100% rename from doc/api/booking-custom-attributes.md rename to legacy/doc/api/booking-custom-attributes.md diff --git a/doc/api/bookings.md b/legacy/doc/api/bookings.md similarity index 100% rename from doc/api/bookings.md rename to legacy/doc/api/bookings.md diff --git a/doc/api/cards.md b/legacy/doc/api/cards.md similarity index 100% rename from doc/api/cards.md rename to legacy/doc/api/cards.md diff --git a/doc/api/cash-drawers.md b/legacy/doc/api/cash-drawers.md similarity index 100% rename from doc/api/cash-drawers.md rename to legacy/doc/api/cash-drawers.md diff --git a/doc/api/catalog.md b/legacy/doc/api/catalog.md similarity index 100% rename from doc/api/catalog.md rename to legacy/doc/api/catalog.md diff --git a/doc/api/checkout.md b/legacy/doc/api/checkout.md similarity index 100% rename from doc/api/checkout.md rename to legacy/doc/api/checkout.md diff --git a/doc/api/customer-custom-attributes.md b/legacy/doc/api/customer-custom-attributes.md similarity index 100% rename from doc/api/customer-custom-attributes.md rename to legacy/doc/api/customer-custom-attributes.md diff --git a/doc/api/customer-groups.md b/legacy/doc/api/customer-groups.md similarity index 100% rename from doc/api/customer-groups.md rename to legacy/doc/api/customer-groups.md diff --git a/doc/api/customer-segments.md b/legacy/doc/api/customer-segments.md similarity index 100% rename from doc/api/customer-segments.md rename to legacy/doc/api/customer-segments.md diff --git a/doc/api/customers.md b/legacy/doc/api/customers.md similarity index 100% rename from doc/api/customers.md rename to legacy/doc/api/customers.md diff --git a/doc/api/devices.md b/legacy/doc/api/devices.md similarity index 100% rename from doc/api/devices.md rename to legacy/doc/api/devices.md diff --git a/doc/api/disputes.md b/legacy/doc/api/disputes.md similarity index 100% rename from doc/api/disputes.md rename to legacy/doc/api/disputes.md diff --git a/doc/api/employees.md b/legacy/doc/api/employees.md similarity index 100% rename from doc/api/employees.md rename to legacy/doc/api/employees.md diff --git a/doc/api/events.md b/legacy/doc/api/events.md similarity index 100% rename from doc/api/events.md rename to legacy/doc/api/events.md diff --git a/doc/api/gift-card-activities.md b/legacy/doc/api/gift-card-activities.md similarity index 100% rename from doc/api/gift-card-activities.md rename to legacy/doc/api/gift-card-activities.md diff --git a/doc/api/gift-cards.md b/legacy/doc/api/gift-cards.md similarity index 100% rename from doc/api/gift-cards.md rename to legacy/doc/api/gift-cards.md diff --git a/doc/api/inventory.md b/legacy/doc/api/inventory.md similarity index 100% rename from doc/api/inventory.md rename to legacy/doc/api/inventory.md diff --git a/doc/api/invoices.md b/legacy/doc/api/invoices.md similarity index 100% rename from doc/api/invoices.md rename to legacy/doc/api/invoices.md diff --git a/doc/api/labor.md b/legacy/doc/api/labor.md similarity index 100% rename from doc/api/labor.md rename to legacy/doc/api/labor.md diff --git a/doc/api/location-custom-attributes.md b/legacy/doc/api/location-custom-attributes.md similarity index 100% rename from doc/api/location-custom-attributes.md rename to legacy/doc/api/location-custom-attributes.md diff --git a/doc/api/locations.md b/legacy/doc/api/locations.md similarity index 100% rename from doc/api/locations.md rename to legacy/doc/api/locations.md diff --git a/doc/api/loyalty.md b/legacy/doc/api/loyalty.md similarity index 100% rename from doc/api/loyalty.md rename to legacy/doc/api/loyalty.md diff --git a/doc/api/merchant-custom-attributes.md b/legacy/doc/api/merchant-custom-attributes.md similarity index 100% rename from doc/api/merchant-custom-attributes.md rename to legacy/doc/api/merchant-custom-attributes.md diff --git a/doc/api/merchants.md b/legacy/doc/api/merchants.md similarity index 100% rename from doc/api/merchants.md rename to legacy/doc/api/merchants.md diff --git a/doc/api/mobile-authorization.md b/legacy/doc/api/mobile-authorization.md similarity index 100% rename from doc/api/mobile-authorization.md rename to legacy/doc/api/mobile-authorization.md diff --git a/doc/api/o-auth.md b/legacy/doc/api/o-auth.md similarity index 100% rename from doc/api/o-auth.md rename to legacy/doc/api/o-auth.md diff --git a/doc/api/order-custom-attributes.md b/legacy/doc/api/order-custom-attributes.md similarity index 100% rename from doc/api/order-custom-attributes.md rename to legacy/doc/api/order-custom-attributes.md diff --git a/doc/api/orders.md b/legacy/doc/api/orders.md similarity index 100% rename from doc/api/orders.md rename to legacy/doc/api/orders.md diff --git a/doc/api/payments.md b/legacy/doc/api/payments.md similarity index 100% rename from doc/api/payments.md rename to legacy/doc/api/payments.md diff --git a/doc/api/payouts.md b/legacy/doc/api/payouts.md similarity index 100% rename from doc/api/payouts.md rename to legacy/doc/api/payouts.md diff --git a/doc/api/refunds.md b/legacy/doc/api/refunds.md similarity index 100% rename from doc/api/refunds.md rename to legacy/doc/api/refunds.md diff --git a/doc/api/sites.md b/legacy/doc/api/sites.md similarity index 100% rename from doc/api/sites.md rename to legacy/doc/api/sites.md diff --git a/doc/api/snippets.md b/legacy/doc/api/snippets.md similarity index 100% rename from doc/api/snippets.md rename to legacy/doc/api/snippets.md diff --git a/doc/api/subscriptions.md b/legacy/doc/api/subscriptions.md similarity index 100% rename from doc/api/subscriptions.md rename to legacy/doc/api/subscriptions.md diff --git a/doc/api/team.md b/legacy/doc/api/team.md similarity index 100% rename from doc/api/team.md rename to legacy/doc/api/team.md diff --git a/doc/api/terminal.md b/legacy/doc/api/terminal.md similarity index 100% rename from doc/api/terminal.md rename to legacy/doc/api/terminal.md diff --git a/doc/api/transactions.md b/legacy/doc/api/transactions.md similarity index 100% rename from doc/api/transactions.md rename to legacy/doc/api/transactions.md diff --git a/doc/api/v1-transactions.md b/legacy/doc/api/v1-transactions.md similarity index 100% rename from doc/api/v1-transactions.md rename to legacy/doc/api/v1-transactions.md diff --git a/doc/api/vendors.md b/legacy/doc/api/vendors.md similarity index 100% rename from doc/api/vendors.md rename to legacy/doc/api/vendors.md diff --git a/doc/api/webhook-subscriptions.md b/legacy/doc/api/webhook-subscriptions.md similarity index 100% rename from doc/api/webhook-subscriptions.md rename to legacy/doc/api/webhook-subscriptions.md diff --git a/doc/auth/oauth-2-bearer-token.md b/legacy/doc/auth/oauth-2-bearer-token.md similarity index 100% rename from doc/auth/oauth-2-bearer-token.md rename to legacy/doc/auth/oauth-2-bearer-token.md diff --git a/doc/client.md b/legacy/doc/client.md similarity index 97% rename from doc/client.md rename to legacy/doc/client.md index e4b3729b..31ed4757 100644 --- a/doc/client.md +++ b/legacy/doc/client.md @@ -49,8 +49,8 @@ API calls return an `ApiResponse` object that includes the following fields: ## Make Calls with the API Client ```python -from square.http.auth.o_auth_2 import BearerAuthCredentials -from square.client import Client +from square_legacy.http.auth.o_auth_2 import BearerAuthCredentials +from square_legacy.client import Client client = Client( square_version='2025-03-19', diff --git a/doc/http-request.md b/legacy/doc/http-request.md similarity index 100% rename from doc/http-request.md rename to legacy/doc/http-request.md diff --git a/doc/http-response.md b/legacy/doc/http-response.md similarity index 100% rename from doc/http-response.md rename to legacy/doc/http-response.md diff --git a/doc/models/accept-dispute-response.md b/legacy/doc/models/accept-dispute-response.md similarity index 100% rename from doc/models/accept-dispute-response.md rename to legacy/doc/models/accept-dispute-response.md diff --git a/doc/models/accepted-payment-methods.md b/legacy/doc/models/accepted-payment-methods.md similarity index 100% rename from doc/models/accepted-payment-methods.md rename to legacy/doc/models/accepted-payment-methods.md diff --git a/doc/models/accumulate-loyalty-points-request.md b/legacy/doc/models/accumulate-loyalty-points-request.md similarity index 100% rename from doc/models/accumulate-loyalty-points-request.md rename to legacy/doc/models/accumulate-loyalty-points-request.md diff --git a/doc/models/accumulate-loyalty-points-response.md b/legacy/doc/models/accumulate-loyalty-points-response.md similarity index 100% rename from doc/models/accumulate-loyalty-points-response.md rename to legacy/doc/models/accumulate-loyalty-points-response.md diff --git a/doc/models/ach-details.md b/legacy/doc/models/ach-details.md similarity index 100% rename from doc/models/ach-details.md rename to legacy/doc/models/ach-details.md diff --git a/doc/models/action-cancel-reason.md b/legacy/doc/models/action-cancel-reason.md similarity index 100% rename from doc/models/action-cancel-reason.md rename to legacy/doc/models/action-cancel-reason.md diff --git a/doc/models/activity-type.md b/legacy/doc/models/activity-type.md similarity index 100% rename from doc/models/activity-type.md rename to legacy/doc/models/activity-type.md diff --git a/doc/models/add-group-to-customer-response.md b/legacy/doc/models/add-group-to-customer-response.md similarity index 100% rename from doc/models/add-group-to-customer-response.md rename to legacy/doc/models/add-group-to-customer-response.md diff --git a/doc/models/additional-recipient.md b/legacy/doc/models/additional-recipient.md similarity index 100% rename from doc/models/additional-recipient.md rename to legacy/doc/models/additional-recipient.md diff --git a/doc/models/address.md b/legacy/doc/models/address.md similarity index 100% rename from doc/models/address.md rename to legacy/doc/models/address.md diff --git a/doc/models/adjust-loyalty-points-request.md b/legacy/doc/models/adjust-loyalty-points-request.md similarity index 100% rename from doc/models/adjust-loyalty-points-request.md rename to legacy/doc/models/adjust-loyalty-points-request.md diff --git a/doc/models/adjust-loyalty-points-response.md b/legacy/doc/models/adjust-loyalty-points-response.md similarity index 100% rename from doc/models/adjust-loyalty-points-response.md rename to legacy/doc/models/adjust-loyalty-points-response.md diff --git a/doc/models/afterpay-details.md b/legacy/doc/models/afterpay-details.md similarity index 100% rename from doc/models/afterpay-details.md rename to legacy/doc/models/afterpay-details.md diff --git a/doc/models/application-details-external-square-product.md b/legacy/doc/models/application-details-external-square-product.md similarity index 100% rename from doc/models/application-details-external-square-product.md rename to legacy/doc/models/application-details-external-square-product.md diff --git a/doc/models/application-details.md b/legacy/doc/models/application-details.md similarity index 100% rename from doc/models/application-details.md rename to legacy/doc/models/application-details.md diff --git a/doc/models/application-type.md b/legacy/doc/models/application-type.md similarity index 100% rename from doc/models/application-type.md rename to legacy/doc/models/application-type.md diff --git a/doc/models/appointment-segment.md b/legacy/doc/models/appointment-segment.md similarity index 100% rename from doc/models/appointment-segment.md rename to legacy/doc/models/appointment-segment.md diff --git a/doc/models/archived-state.md b/legacy/doc/models/archived-state.md similarity index 100% rename from doc/models/archived-state.md rename to legacy/doc/models/archived-state.md diff --git a/doc/models/availability.md b/legacy/doc/models/availability.md similarity index 100% rename from doc/models/availability.md rename to legacy/doc/models/availability.md diff --git a/doc/models/bank-account-payment-details.md b/legacy/doc/models/bank-account-payment-details.md similarity index 100% rename from doc/models/bank-account-payment-details.md rename to legacy/doc/models/bank-account-payment-details.md diff --git a/doc/models/bank-account-status.md b/legacy/doc/models/bank-account-status.md similarity index 100% rename from doc/models/bank-account-status.md rename to legacy/doc/models/bank-account-status.md diff --git a/doc/models/bank-account-type.md b/legacy/doc/models/bank-account-type.md similarity index 100% rename from doc/models/bank-account-type.md rename to legacy/doc/models/bank-account-type.md diff --git a/doc/models/bank-account.md b/legacy/doc/models/bank-account.md similarity index 100% rename from doc/models/bank-account.md rename to legacy/doc/models/bank-account.md diff --git a/doc/models/batch-change-inventory-request.md b/legacy/doc/models/batch-change-inventory-request.md similarity index 100% rename from doc/models/batch-change-inventory-request.md rename to legacy/doc/models/batch-change-inventory-request.md diff --git a/doc/models/batch-change-inventory-response.md b/legacy/doc/models/batch-change-inventory-response.md similarity index 100% rename from doc/models/batch-change-inventory-response.md rename to legacy/doc/models/batch-change-inventory-response.md diff --git a/doc/models/batch-delete-catalog-objects-request.md b/legacy/doc/models/batch-delete-catalog-objects-request.md similarity index 100% rename from doc/models/batch-delete-catalog-objects-request.md rename to legacy/doc/models/batch-delete-catalog-objects-request.md diff --git a/doc/models/batch-delete-catalog-objects-response.md b/legacy/doc/models/batch-delete-catalog-objects-response.md similarity index 100% rename from doc/models/batch-delete-catalog-objects-response.md rename to legacy/doc/models/batch-delete-catalog-objects-response.md diff --git a/doc/models/batch-retrieve-catalog-objects-request.md b/legacy/doc/models/batch-retrieve-catalog-objects-request.md similarity index 100% rename from doc/models/batch-retrieve-catalog-objects-request.md rename to legacy/doc/models/batch-retrieve-catalog-objects-request.md diff --git a/doc/models/batch-retrieve-catalog-objects-response.md b/legacy/doc/models/batch-retrieve-catalog-objects-response.md similarity index 100% rename from doc/models/batch-retrieve-catalog-objects-response.md rename to legacy/doc/models/batch-retrieve-catalog-objects-response.md diff --git a/doc/models/batch-retrieve-inventory-changes-request.md b/legacy/doc/models/batch-retrieve-inventory-changes-request.md similarity index 100% rename from doc/models/batch-retrieve-inventory-changes-request.md rename to legacy/doc/models/batch-retrieve-inventory-changes-request.md diff --git a/doc/models/batch-retrieve-inventory-changes-response.md b/legacy/doc/models/batch-retrieve-inventory-changes-response.md similarity index 100% rename from doc/models/batch-retrieve-inventory-changes-response.md rename to legacy/doc/models/batch-retrieve-inventory-changes-response.md diff --git a/doc/models/batch-retrieve-inventory-counts-request.md b/legacy/doc/models/batch-retrieve-inventory-counts-request.md similarity index 100% rename from doc/models/batch-retrieve-inventory-counts-request.md rename to legacy/doc/models/batch-retrieve-inventory-counts-request.md diff --git a/doc/models/batch-retrieve-inventory-counts-response.md b/legacy/doc/models/batch-retrieve-inventory-counts-response.md similarity index 100% rename from doc/models/batch-retrieve-inventory-counts-response.md rename to legacy/doc/models/batch-retrieve-inventory-counts-response.md diff --git a/doc/models/batch-retrieve-orders-request.md b/legacy/doc/models/batch-retrieve-orders-request.md similarity index 100% rename from doc/models/batch-retrieve-orders-request.md rename to legacy/doc/models/batch-retrieve-orders-request.md diff --git a/doc/models/batch-retrieve-orders-response.md b/legacy/doc/models/batch-retrieve-orders-response.md similarity index 100% rename from doc/models/batch-retrieve-orders-response.md rename to legacy/doc/models/batch-retrieve-orders-response.md diff --git a/doc/models/batch-upsert-catalog-objects-request.md b/legacy/doc/models/batch-upsert-catalog-objects-request.md similarity index 100% rename from doc/models/batch-upsert-catalog-objects-request.md rename to legacy/doc/models/batch-upsert-catalog-objects-request.md diff --git a/doc/models/batch-upsert-catalog-objects-response.md b/legacy/doc/models/batch-upsert-catalog-objects-response.md similarity index 100% rename from doc/models/batch-upsert-catalog-objects-response.md rename to legacy/doc/models/batch-upsert-catalog-objects-response.md diff --git a/doc/models/booking-booking-source.md b/legacy/doc/models/booking-booking-source.md similarity index 100% rename from doc/models/booking-booking-source.md rename to legacy/doc/models/booking-booking-source.md diff --git a/doc/models/booking-creator-details-creator-type.md b/legacy/doc/models/booking-creator-details-creator-type.md similarity index 100% rename from doc/models/booking-creator-details-creator-type.md rename to legacy/doc/models/booking-creator-details-creator-type.md diff --git a/doc/models/booking-creator-details.md b/legacy/doc/models/booking-creator-details.md similarity index 100% rename from doc/models/booking-creator-details.md rename to legacy/doc/models/booking-creator-details.md diff --git a/doc/models/booking-custom-attribute-delete-request.md b/legacy/doc/models/booking-custom-attribute-delete-request.md similarity index 100% rename from doc/models/booking-custom-attribute-delete-request.md rename to legacy/doc/models/booking-custom-attribute-delete-request.md diff --git a/doc/models/booking-custom-attribute-delete-response.md b/legacy/doc/models/booking-custom-attribute-delete-response.md similarity index 100% rename from doc/models/booking-custom-attribute-delete-response.md rename to legacy/doc/models/booking-custom-attribute-delete-response.md diff --git a/doc/models/booking-custom-attribute-upsert-request.md b/legacy/doc/models/booking-custom-attribute-upsert-request.md similarity index 100% rename from doc/models/booking-custom-attribute-upsert-request.md rename to legacy/doc/models/booking-custom-attribute-upsert-request.md diff --git a/doc/models/booking-custom-attribute-upsert-response.md b/legacy/doc/models/booking-custom-attribute-upsert-response.md similarity index 100% rename from doc/models/booking-custom-attribute-upsert-response.md rename to legacy/doc/models/booking-custom-attribute-upsert-response.md diff --git a/doc/models/booking-status.md b/legacy/doc/models/booking-status.md similarity index 100% rename from doc/models/booking-status.md rename to legacy/doc/models/booking-status.md diff --git a/doc/models/booking.md b/legacy/doc/models/booking.md similarity index 100% rename from doc/models/booking.md rename to legacy/doc/models/booking.md diff --git a/doc/models/break-type.md b/legacy/doc/models/break-type.md similarity index 100% rename from doc/models/break-type.md rename to legacy/doc/models/break-type.md diff --git a/doc/models/break.md b/legacy/doc/models/break.md similarity index 100% rename from doc/models/break.md rename to legacy/doc/models/break.md diff --git a/doc/models/bulk-create-customer-data.md b/legacy/doc/models/bulk-create-customer-data.md similarity index 100% rename from doc/models/bulk-create-customer-data.md rename to legacy/doc/models/bulk-create-customer-data.md diff --git a/doc/models/bulk-create-customers-request.md b/legacy/doc/models/bulk-create-customers-request.md similarity index 100% rename from doc/models/bulk-create-customers-request.md rename to legacy/doc/models/bulk-create-customers-request.md diff --git a/doc/models/bulk-create-customers-response.md b/legacy/doc/models/bulk-create-customers-response.md similarity index 100% rename from doc/models/bulk-create-customers-response.md rename to legacy/doc/models/bulk-create-customers-response.md diff --git a/doc/models/bulk-create-team-members-request.md b/legacy/doc/models/bulk-create-team-members-request.md similarity index 100% rename from doc/models/bulk-create-team-members-request.md rename to legacy/doc/models/bulk-create-team-members-request.md diff --git a/doc/models/bulk-create-team-members-response.md b/legacy/doc/models/bulk-create-team-members-response.md similarity index 100% rename from doc/models/bulk-create-team-members-response.md rename to legacy/doc/models/bulk-create-team-members-response.md diff --git a/doc/models/bulk-create-vendors-request.md b/legacy/doc/models/bulk-create-vendors-request.md similarity index 100% rename from doc/models/bulk-create-vendors-request.md rename to legacy/doc/models/bulk-create-vendors-request.md diff --git a/doc/models/bulk-create-vendors-response.md b/legacy/doc/models/bulk-create-vendors-response.md similarity index 100% rename from doc/models/bulk-create-vendors-response.md rename to legacy/doc/models/bulk-create-vendors-response.md diff --git a/doc/models/bulk-delete-booking-custom-attributes-request.md b/legacy/doc/models/bulk-delete-booking-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-delete-booking-custom-attributes-request.md rename to legacy/doc/models/bulk-delete-booking-custom-attributes-request.md diff --git a/doc/models/bulk-delete-booking-custom-attributes-response.md b/legacy/doc/models/bulk-delete-booking-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-delete-booking-custom-attributes-response.md rename to legacy/doc/models/bulk-delete-booking-custom-attributes-response.md diff --git a/doc/models/bulk-delete-customers-request.md b/legacy/doc/models/bulk-delete-customers-request.md similarity index 100% rename from doc/models/bulk-delete-customers-request.md rename to legacy/doc/models/bulk-delete-customers-request.md diff --git a/doc/models/bulk-delete-customers-response.md b/legacy/doc/models/bulk-delete-customers-response.md similarity index 100% rename from doc/models/bulk-delete-customers-response.md rename to legacy/doc/models/bulk-delete-customers-response.md diff --git a/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md b/legacy/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md similarity index 100% rename from doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md rename to legacy/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md diff --git a/doc/models/bulk-delete-location-custom-attributes-request.md b/legacy/doc/models/bulk-delete-location-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-delete-location-custom-attributes-request.md rename to legacy/doc/models/bulk-delete-location-custom-attributes-request.md diff --git a/doc/models/bulk-delete-location-custom-attributes-response-location-custom-attribute-delete-response.md b/legacy/doc/models/bulk-delete-location-custom-attributes-response-location-custom-attribute-delete-response.md similarity index 100% rename from doc/models/bulk-delete-location-custom-attributes-response-location-custom-attribute-delete-response.md rename to legacy/doc/models/bulk-delete-location-custom-attributes-response-location-custom-attribute-delete-response.md diff --git a/doc/models/bulk-delete-location-custom-attributes-response.md b/legacy/doc/models/bulk-delete-location-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-delete-location-custom-attributes-response.md rename to legacy/doc/models/bulk-delete-location-custom-attributes-response.md diff --git a/doc/models/bulk-delete-merchant-custom-attributes-request-merchant-custom-attribute-delete-request.md b/legacy/doc/models/bulk-delete-merchant-custom-attributes-request-merchant-custom-attribute-delete-request.md similarity index 100% rename from doc/models/bulk-delete-merchant-custom-attributes-request-merchant-custom-attribute-delete-request.md rename to legacy/doc/models/bulk-delete-merchant-custom-attributes-request-merchant-custom-attribute-delete-request.md diff --git a/doc/models/bulk-delete-merchant-custom-attributes-request.md b/legacy/doc/models/bulk-delete-merchant-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-delete-merchant-custom-attributes-request.md rename to legacy/doc/models/bulk-delete-merchant-custom-attributes-request.md diff --git a/doc/models/bulk-delete-merchant-custom-attributes-response-merchant-custom-attribute-delete-response.md b/legacy/doc/models/bulk-delete-merchant-custom-attributes-response-merchant-custom-attribute-delete-response.md similarity index 100% rename from doc/models/bulk-delete-merchant-custom-attributes-response-merchant-custom-attribute-delete-response.md rename to legacy/doc/models/bulk-delete-merchant-custom-attributes-response-merchant-custom-attribute-delete-response.md diff --git a/doc/models/bulk-delete-merchant-custom-attributes-response.md b/legacy/doc/models/bulk-delete-merchant-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-delete-merchant-custom-attributes-response.md rename to legacy/doc/models/bulk-delete-merchant-custom-attributes-response.md diff --git a/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md b/legacy/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md similarity index 100% rename from doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md rename to legacy/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md diff --git a/doc/models/bulk-delete-order-custom-attributes-request.md b/legacy/doc/models/bulk-delete-order-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-delete-order-custom-attributes-request.md rename to legacy/doc/models/bulk-delete-order-custom-attributes-request.md diff --git a/doc/models/bulk-delete-order-custom-attributes-response.md b/legacy/doc/models/bulk-delete-order-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-delete-order-custom-attributes-response.md rename to legacy/doc/models/bulk-delete-order-custom-attributes-response.md diff --git a/doc/models/bulk-retrieve-bookings-request.md b/legacy/doc/models/bulk-retrieve-bookings-request.md similarity index 100% rename from doc/models/bulk-retrieve-bookings-request.md rename to legacy/doc/models/bulk-retrieve-bookings-request.md diff --git a/doc/models/bulk-retrieve-bookings-response.md b/legacy/doc/models/bulk-retrieve-bookings-response.md similarity index 100% rename from doc/models/bulk-retrieve-bookings-response.md rename to legacy/doc/models/bulk-retrieve-bookings-response.md diff --git a/doc/models/bulk-retrieve-customers-request.md b/legacy/doc/models/bulk-retrieve-customers-request.md similarity index 100% rename from doc/models/bulk-retrieve-customers-request.md rename to legacy/doc/models/bulk-retrieve-customers-request.md diff --git a/doc/models/bulk-retrieve-customers-response.md b/legacy/doc/models/bulk-retrieve-customers-response.md similarity index 100% rename from doc/models/bulk-retrieve-customers-response.md rename to legacy/doc/models/bulk-retrieve-customers-response.md diff --git a/doc/models/bulk-retrieve-team-member-booking-profiles-request.md b/legacy/doc/models/bulk-retrieve-team-member-booking-profiles-request.md similarity index 100% rename from doc/models/bulk-retrieve-team-member-booking-profiles-request.md rename to legacy/doc/models/bulk-retrieve-team-member-booking-profiles-request.md diff --git a/doc/models/bulk-retrieve-team-member-booking-profiles-response.md b/legacy/doc/models/bulk-retrieve-team-member-booking-profiles-response.md similarity index 100% rename from doc/models/bulk-retrieve-team-member-booking-profiles-response.md rename to legacy/doc/models/bulk-retrieve-team-member-booking-profiles-response.md diff --git a/doc/models/bulk-retrieve-vendors-request.md b/legacy/doc/models/bulk-retrieve-vendors-request.md similarity index 100% rename from doc/models/bulk-retrieve-vendors-request.md rename to legacy/doc/models/bulk-retrieve-vendors-request.md diff --git a/doc/models/bulk-retrieve-vendors-response.md b/legacy/doc/models/bulk-retrieve-vendors-response.md similarity index 100% rename from doc/models/bulk-retrieve-vendors-response.md rename to legacy/doc/models/bulk-retrieve-vendors-response.md diff --git a/doc/models/bulk-swap-plan-request.md b/legacy/doc/models/bulk-swap-plan-request.md similarity index 100% rename from doc/models/bulk-swap-plan-request.md rename to legacy/doc/models/bulk-swap-plan-request.md diff --git a/doc/models/bulk-swap-plan-response.md b/legacy/doc/models/bulk-swap-plan-response.md similarity index 100% rename from doc/models/bulk-swap-plan-response.md rename to legacy/doc/models/bulk-swap-plan-response.md diff --git a/doc/models/bulk-update-customer-data.md b/legacy/doc/models/bulk-update-customer-data.md similarity index 100% rename from doc/models/bulk-update-customer-data.md rename to legacy/doc/models/bulk-update-customer-data.md diff --git a/doc/models/bulk-update-customers-request.md b/legacy/doc/models/bulk-update-customers-request.md similarity index 100% rename from doc/models/bulk-update-customers-request.md rename to legacy/doc/models/bulk-update-customers-request.md diff --git a/doc/models/bulk-update-customers-response.md b/legacy/doc/models/bulk-update-customers-response.md similarity index 100% rename from doc/models/bulk-update-customers-response.md rename to legacy/doc/models/bulk-update-customers-response.md diff --git a/doc/models/bulk-update-team-members-request.md b/legacy/doc/models/bulk-update-team-members-request.md similarity index 100% rename from doc/models/bulk-update-team-members-request.md rename to legacy/doc/models/bulk-update-team-members-request.md diff --git a/doc/models/bulk-update-team-members-response.md b/legacy/doc/models/bulk-update-team-members-response.md similarity index 100% rename from doc/models/bulk-update-team-members-response.md rename to legacy/doc/models/bulk-update-team-members-response.md diff --git a/doc/models/bulk-update-vendors-request.md b/legacy/doc/models/bulk-update-vendors-request.md similarity index 100% rename from doc/models/bulk-update-vendors-request.md rename to legacy/doc/models/bulk-update-vendors-request.md diff --git a/doc/models/bulk-update-vendors-response.md b/legacy/doc/models/bulk-update-vendors-response.md similarity index 100% rename from doc/models/bulk-update-vendors-response.md rename to legacy/doc/models/bulk-update-vendors-response.md diff --git a/doc/models/bulk-upsert-booking-custom-attributes-request.md b/legacy/doc/models/bulk-upsert-booking-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-upsert-booking-custom-attributes-request.md rename to legacy/doc/models/bulk-upsert-booking-custom-attributes-request.md diff --git a/doc/models/bulk-upsert-booking-custom-attributes-response.md b/legacy/doc/models/bulk-upsert-booking-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-upsert-booking-custom-attributes-response.md rename to legacy/doc/models/bulk-upsert-booking-custom-attributes-response.md diff --git a/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md b/legacy/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md similarity index 100% rename from doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md rename to legacy/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md diff --git a/doc/models/bulk-upsert-customer-custom-attributes-request.md b/legacy/doc/models/bulk-upsert-customer-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-upsert-customer-custom-attributes-request.md rename to legacy/doc/models/bulk-upsert-customer-custom-attributes-request.md diff --git a/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md b/legacy/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md similarity index 100% rename from doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md rename to legacy/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md diff --git a/doc/models/bulk-upsert-customer-custom-attributes-response.md b/legacy/doc/models/bulk-upsert-customer-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-upsert-customer-custom-attributes-response.md rename to legacy/doc/models/bulk-upsert-customer-custom-attributes-response.md diff --git a/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md b/legacy/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md similarity index 100% rename from doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md rename to legacy/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md diff --git a/doc/models/bulk-upsert-location-custom-attributes-request.md b/legacy/doc/models/bulk-upsert-location-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-upsert-location-custom-attributes-request.md rename to legacy/doc/models/bulk-upsert-location-custom-attributes-request.md diff --git a/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md b/legacy/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md similarity index 100% rename from doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md rename to legacy/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md diff --git a/doc/models/bulk-upsert-location-custom-attributes-response.md b/legacy/doc/models/bulk-upsert-location-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-upsert-location-custom-attributes-response.md rename to legacy/doc/models/bulk-upsert-location-custom-attributes-response.md diff --git a/doc/models/bulk-upsert-merchant-custom-attributes-request-merchant-custom-attribute-upsert-request.md b/legacy/doc/models/bulk-upsert-merchant-custom-attributes-request-merchant-custom-attribute-upsert-request.md similarity index 100% rename from doc/models/bulk-upsert-merchant-custom-attributes-request-merchant-custom-attribute-upsert-request.md rename to legacy/doc/models/bulk-upsert-merchant-custom-attributes-request-merchant-custom-attribute-upsert-request.md diff --git a/doc/models/bulk-upsert-merchant-custom-attributes-request.md b/legacy/doc/models/bulk-upsert-merchant-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-upsert-merchant-custom-attributes-request.md rename to legacy/doc/models/bulk-upsert-merchant-custom-attributes-request.md diff --git a/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md b/legacy/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md similarity index 100% rename from doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md rename to legacy/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md diff --git a/doc/models/bulk-upsert-merchant-custom-attributes-response.md b/legacy/doc/models/bulk-upsert-merchant-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-upsert-merchant-custom-attributes-response.md rename to legacy/doc/models/bulk-upsert-merchant-custom-attributes-response.md diff --git a/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md b/legacy/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md similarity index 100% rename from doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md rename to legacy/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md diff --git a/doc/models/bulk-upsert-order-custom-attributes-request.md b/legacy/doc/models/bulk-upsert-order-custom-attributes-request.md similarity index 100% rename from doc/models/bulk-upsert-order-custom-attributes-request.md rename to legacy/doc/models/bulk-upsert-order-custom-attributes-request.md diff --git a/doc/models/bulk-upsert-order-custom-attributes-response.md b/legacy/doc/models/bulk-upsert-order-custom-attributes-response.md similarity index 100% rename from doc/models/bulk-upsert-order-custom-attributes-response.md rename to legacy/doc/models/bulk-upsert-order-custom-attributes-response.md diff --git a/doc/models/business-appointment-settings-alignment-time.md b/legacy/doc/models/business-appointment-settings-alignment-time.md similarity index 100% rename from doc/models/business-appointment-settings-alignment-time.md rename to legacy/doc/models/business-appointment-settings-alignment-time.md diff --git a/doc/models/business-appointment-settings-booking-location-type.md b/legacy/doc/models/business-appointment-settings-booking-location-type.md similarity index 100% rename from doc/models/business-appointment-settings-booking-location-type.md rename to legacy/doc/models/business-appointment-settings-booking-location-type.md diff --git a/doc/models/business-appointment-settings-cancellation-policy.md b/legacy/doc/models/business-appointment-settings-cancellation-policy.md similarity index 100% rename from doc/models/business-appointment-settings-cancellation-policy.md rename to legacy/doc/models/business-appointment-settings-cancellation-policy.md diff --git a/doc/models/business-appointment-settings-max-appointments-per-day-limit-type.md b/legacy/doc/models/business-appointment-settings-max-appointments-per-day-limit-type.md similarity index 100% rename from doc/models/business-appointment-settings-max-appointments-per-day-limit-type.md rename to legacy/doc/models/business-appointment-settings-max-appointments-per-day-limit-type.md diff --git a/doc/models/business-appointment-settings.md b/legacy/doc/models/business-appointment-settings.md similarity index 100% rename from doc/models/business-appointment-settings.md rename to legacy/doc/models/business-appointment-settings.md diff --git a/doc/models/business-booking-profile-booking-policy.md b/legacy/doc/models/business-booking-profile-booking-policy.md similarity index 100% rename from doc/models/business-booking-profile-booking-policy.md rename to legacy/doc/models/business-booking-profile-booking-policy.md diff --git a/doc/models/business-booking-profile-customer-timezone-choice.md b/legacy/doc/models/business-booking-profile-customer-timezone-choice.md similarity index 100% rename from doc/models/business-booking-profile-customer-timezone-choice.md rename to legacy/doc/models/business-booking-profile-customer-timezone-choice.md diff --git a/doc/models/business-booking-profile.md b/legacy/doc/models/business-booking-profile.md similarity index 100% rename from doc/models/business-booking-profile.md rename to legacy/doc/models/business-booking-profile.md diff --git a/doc/models/business-hours-period.md b/legacy/doc/models/business-hours-period.md similarity index 100% rename from doc/models/business-hours-period.md rename to legacy/doc/models/business-hours-period.md diff --git a/doc/models/business-hours.md b/legacy/doc/models/business-hours.md similarity index 100% rename from doc/models/business-hours.md rename to legacy/doc/models/business-hours.md diff --git a/doc/models/buy-now-pay-later-details.md b/legacy/doc/models/buy-now-pay-later-details.md similarity index 100% rename from doc/models/buy-now-pay-later-details.md rename to legacy/doc/models/buy-now-pay-later-details.md diff --git a/doc/models/calculate-loyalty-points-request.md b/legacy/doc/models/calculate-loyalty-points-request.md similarity index 100% rename from doc/models/calculate-loyalty-points-request.md rename to legacy/doc/models/calculate-loyalty-points-request.md diff --git a/doc/models/calculate-loyalty-points-response.md b/legacy/doc/models/calculate-loyalty-points-response.md similarity index 100% rename from doc/models/calculate-loyalty-points-response.md rename to legacy/doc/models/calculate-loyalty-points-response.md diff --git a/doc/models/calculate-order-request.md b/legacy/doc/models/calculate-order-request.md similarity index 100% rename from doc/models/calculate-order-request.md rename to legacy/doc/models/calculate-order-request.md diff --git a/doc/models/calculate-order-response.md b/legacy/doc/models/calculate-order-response.md similarity index 100% rename from doc/models/calculate-order-response.md rename to legacy/doc/models/calculate-order-response.md diff --git a/doc/models/cancel-booking-request.md b/legacy/doc/models/cancel-booking-request.md similarity index 100% rename from doc/models/cancel-booking-request.md rename to legacy/doc/models/cancel-booking-request.md diff --git a/doc/models/cancel-booking-response.md b/legacy/doc/models/cancel-booking-response.md similarity index 100% rename from doc/models/cancel-booking-response.md rename to legacy/doc/models/cancel-booking-response.md diff --git a/doc/models/cancel-invoice-request.md b/legacy/doc/models/cancel-invoice-request.md similarity index 100% rename from doc/models/cancel-invoice-request.md rename to legacy/doc/models/cancel-invoice-request.md diff --git a/doc/models/cancel-invoice-response.md b/legacy/doc/models/cancel-invoice-response.md similarity index 100% rename from doc/models/cancel-invoice-response.md rename to legacy/doc/models/cancel-invoice-response.md diff --git a/doc/models/cancel-loyalty-promotion-response.md b/legacy/doc/models/cancel-loyalty-promotion-response.md similarity index 100% rename from doc/models/cancel-loyalty-promotion-response.md rename to legacy/doc/models/cancel-loyalty-promotion-response.md diff --git a/doc/models/cancel-payment-by-idempotency-key-request.md b/legacy/doc/models/cancel-payment-by-idempotency-key-request.md similarity index 100% rename from doc/models/cancel-payment-by-idempotency-key-request.md rename to legacy/doc/models/cancel-payment-by-idempotency-key-request.md diff --git a/doc/models/cancel-payment-by-idempotency-key-response.md b/legacy/doc/models/cancel-payment-by-idempotency-key-response.md similarity index 100% rename from doc/models/cancel-payment-by-idempotency-key-response.md rename to legacy/doc/models/cancel-payment-by-idempotency-key-response.md diff --git a/doc/models/cancel-payment-response.md b/legacy/doc/models/cancel-payment-response.md similarity index 100% rename from doc/models/cancel-payment-response.md rename to legacy/doc/models/cancel-payment-response.md diff --git a/doc/models/cancel-subscription-response.md b/legacy/doc/models/cancel-subscription-response.md similarity index 100% rename from doc/models/cancel-subscription-response.md rename to legacy/doc/models/cancel-subscription-response.md diff --git a/doc/models/cancel-terminal-action-response.md b/legacy/doc/models/cancel-terminal-action-response.md similarity index 100% rename from doc/models/cancel-terminal-action-response.md rename to legacy/doc/models/cancel-terminal-action-response.md diff --git a/doc/models/cancel-terminal-checkout-response.md b/legacy/doc/models/cancel-terminal-checkout-response.md similarity index 100% rename from doc/models/cancel-terminal-checkout-response.md rename to legacy/doc/models/cancel-terminal-checkout-response.md diff --git a/doc/models/cancel-terminal-refund-response.md b/legacy/doc/models/cancel-terminal-refund-response.md similarity index 100% rename from doc/models/cancel-terminal-refund-response.md rename to legacy/doc/models/cancel-terminal-refund-response.md diff --git a/doc/models/capture-transaction-response.md b/legacy/doc/models/capture-transaction-response.md similarity index 100% rename from doc/models/capture-transaction-response.md rename to legacy/doc/models/capture-transaction-response.md diff --git a/doc/models/card-brand.md b/legacy/doc/models/card-brand.md similarity index 100% rename from doc/models/card-brand.md rename to legacy/doc/models/card-brand.md diff --git a/doc/models/card-co-brand.md b/legacy/doc/models/card-co-brand.md similarity index 100% rename from doc/models/card-co-brand.md rename to legacy/doc/models/card-co-brand.md diff --git a/doc/models/card-payment-details.md b/legacy/doc/models/card-payment-details.md similarity index 100% rename from doc/models/card-payment-details.md rename to legacy/doc/models/card-payment-details.md diff --git a/doc/models/card-payment-timeline.md b/legacy/doc/models/card-payment-timeline.md similarity index 100% rename from doc/models/card-payment-timeline.md rename to legacy/doc/models/card-payment-timeline.md diff --git a/doc/models/card-prepaid-type.md b/legacy/doc/models/card-prepaid-type.md similarity index 100% rename from doc/models/card-prepaid-type.md rename to legacy/doc/models/card-prepaid-type.md diff --git a/doc/models/card-type.md b/legacy/doc/models/card-type.md similarity index 100% rename from doc/models/card-type.md rename to legacy/doc/models/card-type.md diff --git a/doc/models/card.md b/legacy/doc/models/card.md similarity index 100% rename from doc/models/card.md rename to legacy/doc/models/card.md diff --git a/doc/models/cash-app-details.md b/legacy/doc/models/cash-app-details.md similarity index 100% rename from doc/models/cash-app-details.md rename to legacy/doc/models/cash-app-details.md diff --git a/doc/models/cash-drawer-device.md b/legacy/doc/models/cash-drawer-device.md similarity index 100% rename from doc/models/cash-drawer-device.md rename to legacy/doc/models/cash-drawer-device.md diff --git a/doc/models/cash-drawer-event-type.md b/legacy/doc/models/cash-drawer-event-type.md similarity index 100% rename from doc/models/cash-drawer-event-type.md rename to legacy/doc/models/cash-drawer-event-type.md diff --git a/doc/models/cash-drawer-shift-event.md b/legacy/doc/models/cash-drawer-shift-event.md similarity index 100% rename from doc/models/cash-drawer-shift-event.md rename to legacy/doc/models/cash-drawer-shift-event.md diff --git a/doc/models/cash-drawer-shift-state.md b/legacy/doc/models/cash-drawer-shift-state.md similarity index 100% rename from doc/models/cash-drawer-shift-state.md rename to legacy/doc/models/cash-drawer-shift-state.md diff --git a/doc/models/cash-drawer-shift-summary.md b/legacy/doc/models/cash-drawer-shift-summary.md similarity index 100% rename from doc/models/cash-drawer-shift-summary.md rename to legacy/doc/models/cash-drawer-shift-summary.md diff --git a/doc/models/cash-drawer-shift.md b/legacy/doc/models/cash-drawer-shift.md similarity index 100% rename from doc/models/cash-drawer-shift.md rename to legacy/doc/models/cash-drawer-shift.md diff --git a/doc/models/cash-payment-details.md b/legacy/doc/models/cash-payment-details.md similarity index 100% rename from doc/models/cash-payment-details.md rename to legacy/doc/models/cash-payment-details.md diff --git a/doc/models/catalog-availability-period.md b/legacy/doc/models/catalog-availability-period.md similarity index 100% rename from doc/models/catalog-availability-period.md rename to legacy/doc/models/catalog-availability-period.md diff --git a/doc/models/catalog-category-type.md b/legacy/doc/models/catalog-category-type.md similarity index 100% rename from doc/models/catalog-category-type.md rename to legacy/doc/models/catalog-category-type.md diff --git a/doc/models/catalog-category.md b/legacy/doc/models/catalog-category.md similarity index 100% rename from doc/models/catalog-category.md rename to legacy/doc/models/catalog-category.md diff --git a/doc/models/catalog-custom-attribute-definition-app-visibility.md b/legacy/doc/models/catalog-custom-attribute-definition-app-visibility.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-app-visibility.md rename to legacy/doc/models/catalog-custom-attribute-definition-app-visibility.md diff --git a/doc/models/catalog-custom-attribute-definition-number-config.md b/legacy/doc/models/catalog-custom-attribute-definition-number-config.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-number-config.md rename to legacy/doc/models/catalog-custom-attribute-definition-number-config.md diff --git a/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md b/legacy/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md rename to legacy/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md diff --git a/doc/models/catalog-custom-attribute-definition-selection-config.md b/legacy/doc/models/catalog-custom-attribute-definition-selection-config.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-selection-config.md rename to legacy/doc/models/catalog-custom-attribute-definition-selection-config.md diff --git a/doc/models/catalog-custom-attribute-definition-seller-visibility.md b/legacy/doc/models/catalog-custom-attribute-definition-seller-visibility.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-seller-visibility.md rename to legacy/doc/models/catalog-custom-attribute-definition-seller-visibility.md diff --git a/doc/models/catalog-custom-attribute-definition-string-config.md b/legacy/doc/models/catalog-custom-attribute-definition-string-config.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-string-config.md rename to legacy/doc/models/catalog-custom-attribute-definition-string-config.md diff --git a/doc/models/catalog-custom-attribute-definition-type.md b/legacy/doc/models/catalog-custom-attribute-definition-type.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition-type.md rename to legacy/doc/models/catalog-custom-attribute-definition-type.md diff --git a/doc/models/catalog-custom-attribute-definition.md b/legacy/doc/models/catalog-custom-attribute-definition.md similarity index 100% rename from doc/models/catalog-custom-attribute-definition.md rename to legacy/doc/models/catalog-custom-attribute-definition.md diff --git a/doc/models/catalog-custom-attribute-value.md b/legacy/doc/models/catalog-custom-attribute-value.md similarity index 100% rename from doc/models/catalog-custom-attribute-value.md rename to legacy/doc/models/catalog-custom-attribute-value.md diff --git a/doc/models/catalog-discount-modify-tax-basis.md b/legacy/doc/models/catalog-discount-modify-tax-basis.md similarity index 100% rename from doc/models/catalog-discount-modify-tax-basis.md rename to legacy/doc/models/catalog-discount-modify-tax-basis.md diff --git a/doc/models/catalog-discount-type.md b/legacy/doc/models/catalog-discount-type.md similarity index 100% rename from doc/models/catalog-discount-type.md rename to legacy/doc/models/catalog-discount-type.md diff --git a/doc/models/catalog-discount.md b/legacy/doc/models/catalog-discount.md similarity index 100% rename from doc/models/catalog-discount.md rename to legacy/doc/models/catalog-discount.md diff --git a/doc/models/catalog-ecom-seo-data.md b/legacy/doc/models/catalog-ecom-seo-data.md similarity index 100% rename from doc/models/catalog-ecom-seo-data.md rename to legacy/doc/models/catalog-ecom-seo-data.md diff --git a/doc/models/catalog-id-mapping.md b/legacy/doc/models/catalog-id-mapping.md similarity index 100% rename from doc/models/catalog-id-mapping.md rename to legacy/doc/models/catalog-id-mapping.md diff --git a/doc/models/catalog-image.md b/legacy/doc/models/catalog-image.md similarity index 100% rename from doc/models/catalog-image.md rename to legacy/doc/models/catalog-image.md diff --git a/doc/models/catalog-info-response-limits.md b/legacy/doc/models/catalog-info-response-limits.md similarity index 100% rename from doc/models/catalog-info-response-limits.md rename to legacy/doc/models/catalog-info-response-limits.md diff --git a/doc/models/catalog-info-response.md b/legacy/doc/models/catalog-info-response.md similarity index 100% rename from doc/models/catalog-info-response.md rename to legacy/doc/models/catalog-info-response.md diff --git a/doc/models/catalog-item-food-and-beverage-details-dietary-preference-standard-dietary-preference.md b/legacy/doc/models/catalog-item-food-and-beverage-details-dietary-preference-standard-dietary-preference.md similarity index 100% rename from doc/models/catalog-item-food-and-beverage-details-dietary-preference-standard-dietary-preference.md rename to legacy/doc/models/catalog-item-food-and-beverage-details-dietary-preference-standard-dietary-preference.md diff --git a/doc/models/catalog-item-food-and-beverage-details-dietary-preference-type.md b/legacy/doc/models/catalog-item-food-and-beverage-details-dietary-preference-type.md similarity index 100% rename from doc/models/catalog-item-food-and-beverage-details-dietary-preference-type.md rename to legacy/doc/models/catalog-item-food-and-beverage-details-dietary-preference-type.md diff --git a/doc/models/catalog-item-food-and-beverage-details-dietary-preference.md b/legacy/doc/models/catalog-item-food-and-beverage-details-dietary-preference.md similarity index 100% rename from doc/models/catalog-item-food-and-beverage-details-dietary-preference.md rename to legacy/doc/models/catalog-item-food-and-beverage-details-dietary-preference.md diff --git a/doc/models/catalog-item-food-and-beverage-details-ingredient-standard-ingredient.md b/legacy/doc/models/catalog-item-food-and-beverage-details-ingredient-standard-ingredient.md similarity index 100% rename from doc/models/catalog-item-food-and-beverage-details-ingredient-standard-ingredient.md rename to legacy/doc/models/catalog-item-food-and-beverage-details-ingredient-standard-ingredient.md diff --git a/doc/models/catalog-item-food-and-beverage-details-ingredient.md b/legacy/doc/models/catalog-item-food-and-beverage-details-ingredient.md similarity index 100% rename from doc/models/catalog-item-food-and-beverage-details-ingredient.md rename to legacy/doc/models/catalog-item-food-and-beverage-details-ingredient.md diff --git a/doc/models/catalog-item-food-and-beverage-details.md b/legacy/doc/models/catalog-item-food-and-beverage-details.md similarity index 100% rename from doc/models/catalog-item-food-and-beverage-details.md rename to legacy/doc/models/catalog-item-food-and-beverage-details.md diff --git a/doc/models/catalog-item-modifier-list-info.md b/legacy/doc/models/catalog-item-modifier-list-info.md similarity index 100% rename from doc/models/catalog-item-modifier-list-info.md rename to legacy/doc/models/catalog-item-modifier-list-info.md diff --git a/doc/models/catalog-item-option-for-item.md b/legacy/doc/models/catalog-item-option-for-item.md similarity index 100% rename from doc/models/catalog-item-option-for-item.md rename to legacy/doc/models/catalog-item-option-for-item.md diff --git a/doc/models/catalog-item-option-value-for-item-variation.md b/legacy/doc/models/catalog-item-option-value-for-item-variation.md similarity index 100% rename from doc/models/catalog-item-option-value-for-item-variation.md rename to legacy/doc/models/catalog-item-option-value-for-item-variation.md diff --git a/doc/models/catalog-item-option-value.md b/legacy/doc/models/catalog-item-option-value.md similarity index 100% rename from doc/models/catalog-item-option-value.md rename to legacy/doc/models/catalog-item-option-value.md diff --git a/doc/models/catalog-item-option.md b/legacy/doc/models/catalog-item-option.md similarity index 100% rename from doc/models/catalog-item-option.md rename to legacy/doc/models/catalog-item-option.md diff --git a/doc/models/catalog-item-product-type.md b/legacy/doc/models/catalog-item-product-type.md similarity index 100% rename from doc/models/catalog-item-product-type.md rename to legacy/doc/models/catalog-item-product-type.md diff --git a/doc/models/catalog-item-variation.md b/legacy/doc/models/catalog-item-variation.md similarity index 100% rename from doc/models/catalog-item-variation.md rename to legacy/doc/models/catalog-item-variation.md diff --git a/doc/models/catalog-item.md b/legacy/doc/models/catalog-item.md similarity index 100% rename from doc/models/catalog-item.md rename to legacy/doc/models/catalog-item.md diff --git a/doc/models/catalog-measurement-unit.md b/legacy/doc/models/catalog-measurement-unit.md similarity index 100% rename from doc/models/catalog-measurement-unit.md rename to legacy/doc/models/catalog-measurement-unit.md diff --git a/doc/models/catalog-modifier-list-modifier-type.md b/legacy/doc/models/catalog-modifier-list-modifier-type.md similarity index 100% rename from doc/models/catalog-modifier-list-modifier-type.md rename to legacy/doc/models/catalog-modifier-list-modifier-type.md diff --git a/doc/models/catalog-modifier-list-selection-type.md b/legacy/doc/models/catalog-modifier-list-selection-type.md similarity index 100% rename from doc/models/catalog-modifier-list-selection-type.md rename to legacy/doc/models/catalog-modifier-list-selection-type.md diff --git a/doc/models/catalog-modifier-list.md b/legacy/doc/models/catalog-modifier-list.md similarity index 100% rename from doc/models/catalog-modifier-list.md rename to legacy/doc/models/catalog-modifier-list.md diff --git a/doc/models/catalog-modifier-override.md b/legacy/doc/models/catalog-modifier-override.md similarity index 100% rename from doc/models/catalog-modifier-override.md rename to legacy/doc/models/catalog-modifier-override.md diff --git a/doc/models/catalog-modifier.md b/legacy/doc/models/catalog-modifier.md similarity index 100% rename from doc/models/catalog-modifier.md rename to legacy/doc/models/catalog-modifier.md diff --git a/doc/models/catalog-object-batch.md b/legacy/doc/models/catalog-object-batch.md similarity index 100% rename from doc/models/catalog-object-batch.md rename to legacy/doc/models/catalog-object-batch.md diff --git a/doc/models/catalog-object-category.md b/legacy/doc/models/catalog-object-category.md similarity index 100% rename from doc/models/catalog-object-category.md rename to legacy/doc/models/catalog-object-category.md diff --git a/doc/models/catalog-object-reference.md b/legacy/doc/models/catalog-object-reference.md similarity index 100% rename from doc/models/catalog-object-reference.md rename to legacy/doc/models/catalog-object-reference.md diff --git a/doc/models/catalog-object-type.md b/legacy/doc/models/catalog-object-type.md similarity index 100% rename from doc/models/catalog-object-type.md rename to legacy/doc/models/catalog-object-type.md diff --git a/doc/models/catalog-object.md b/legacy/doc/models/catalog-object.md similarity index 100% rename from doc/models/catalog-object.md rename to legacy/doc/models/catalog-object.md diff --git a/doc/models/catalog-pricing-rule.md b/legacy/doc/models/catalog-pricing-rule.md similarity index 100% rename from doc/models/catalog-pricing-rule.md rename to legacy/doc/models/catalog-pricing-rule.md diff --git a/doc/models/catalog-pricing-type.md b/legacy/doc/models/catalog-pricing-type.md similarity index 100% rename from doc/models/catalog-pricing-type.md rename to legacy/doc/models/catalog-pricing-type.md diff --git a/doc/models/catalog-product-set.md b/legacy/doc/models/catalog-product-set.md similarity index 100% rename from doc/models/catalog-product-set.md rename to legacy/doc/models/catalog-product-set.md diff --git a/doc/models/catalog-query-exact.md b/legacy/doc/models/catalog-query-exact.md similarity index 100% rename from doc/models/catalog-query-exact.md rename to legacy/doc/models/catalog-query-exact.md diff --git a/doc/models/catalog-query-item-variations-for-item-option-values.md b/legacy/doc/models/catalog-query-item-variations-for-item-option-values.md similarity index 100% rename from doc/models/catalog-query-item-variations-for-item-option-values.md rename to legacy/doc/models/catalog-query-item-variations-for-item-option-values.md diff --git a/doc/models/catalog-query-items-for-item-options.md b/legacy/doc/models/catalog-query-items-for-item-options.md similarity index 100% rename from doc/models/catalog-query-items-for-item-options.md rename to legacy/doc/models/catalog-query-items-for-item-options.md diff --git a/doc/models/catalog-query-items-for-modifier-list.md b/legacy/doc/models/catalog-query-items-for-modifier-list.md similarity index 100% rename from doc/models/catalog-query-items-for-modifier-list.md rename to legacy/doc/models/catalog-query-items-for-modifier-list.md diff --git a/doc/models/catalog-query-items-for-tax.md b/legacy/doc/models/catalog-query-items-for-tax.md similarity index 100% rename from doc/models/catalog-query-items-for-tax.md rename to legacy/doc/models/catalog-query-items-for-tax.md diff --git a/doc/models/catalog-query-prefix.md b/legacy/doc/models/catalog-query-prefix.md similarity index 100% rename from doc/models/catalog-query-prefix.md rename to legacy/doc/models/catalog-query-prefix.md diff --git a/doc/models/catalog-query-range.md b/legacy/doc/models/catalog-query-range.md similarity index 100% rename from doc/models/catalog-query-range.md rename to legacy/doc/models/catalog-query-range.md diff --git a/doc/models/catalog-query-set.md b/legacy/doc/models/catalog-query-set.md similarity index 100% rename from doc/models/catalog-query-set.md rename to legacy/doc/models/catalog-query-set.md diff --git a/doc/models/catalog-query-sorted-attribute.md b/legacy/doc/models/catalog-query-sorted-attribute.md similarity index 100% rename from doc/models/catalog-query-sorted-attribute.md rename to legacy/doc/models/catalog-query-sorted-attribute.md diff --git a/doc/models/catalog-query-text.md b/legacy/doc/models/catalog-query-text.md similarity index 100% rename from doc/models/catalog-query-text.md rename to legacy/doc/models/catalog-query-text.md diff --git a/doc/models/catalog-query.md b/legacy/doc/models/catalog-query.md similarity index 100% rename from doc/models/catalog-query.md rename to legacy/doc/models/catalog-query.md diff --git a/doc/models/catalog-quick-amount-type.md b/legacy/doc/models/catalog-quick-amount-type.md similarity index 100% rename from doc/models/catalog-quick-amount-type.md rename to legacy/doc/models/catalog-quick-amount-type.md diff --git a/doc/models/catalog-quick-amount.md b/legacy/doc/models/catalog-quick-amount.md similarity index 100% rename from doc/models/catalog-quick-amount.md rename to legacy/doc/models/catalog-quick-amount.md diff --git a/doc/models/catalog-quick-amounts-settings-option.md b/legacy/doc/models/catalog-quick-amounts-settings-option.md similarity index 100% rename from doc/models/catalog-quick-amounts-settings-option.md rename to legacy/doc/models/catalog-quick-amounts-settings-option.md diff --git a/doc/models/catalog-quick-amounts-settings.md b/legacy/doc/models/catalog-quick-amounts-settings.md similarity index 100% rename from doc/models/catalog-quick-amounts-settings.md rename to legacy/doc/models/catalog-quick-amounts-settings.md diff --git a/doc/models/catalog-stock-conversion.md b/legacy/doc/models/catalog-stock-conversion.md similarity index 100% rename from doc/models/catalog-stock-conversion.md rename to legacy/doc/models/catalog-stock-conversion.md diff --git a/doc/models/catalog-subscription-plan-variation.md b/legacy/doc/models/catalog-subscription-plan-variation.md similarity index 100% rename from doc/models/catalog-subscription-plan-variation.md rename to legacy/doc/models/catalog-subscription-plan-variation.md diff --git a/doc/models/catalog-subscription-plan.md b/legacy/doc/models/catalog-subscription-plan.md similarity index 100% rename from doc/models/catalog-subscription-plan.md rename to legacy/doc/models/catalog-subscription-plan.md diff --git a/doc/models/catalog-tax.md b/legacy/doc/models/catalog-tax.md similarity index 100% rename from doc/models/catalog-tax.md rename to legacy/doc/models/catalog-tax.md diff --git a/doc/models/catalog-time-period.md b/legacy/doc/models/catalog-time-period.md similarity index 100% rename from doc/models/catalog-time-period.md rename to legacy/doc/models/catalog-time-period.md diff --git a/doc/models/catalog-v1-id.md b/legacy/doc/models/catalog-v1-id.md similarity index 100% rename from doc/models/catalog-v1-id.md rename to legacy/doc/models/catalog-v1-id.md diff --git a/doc/models/category-path-to-root-node.md b/legacy/doc/models/category-path-to-root-node.md similarity index 100% rename from doc/models/category-path-to-root-node.md rename to legacy/doc/models/category-path-to-root-node.md diff --git a/doc/models/change-billing-anchor-date-request.md b/legacy/doc/models/change-billing-anchor-date-request.md similarity index 100% rename from doc/models/change-billing-anchor-date-request.md rename to legacy/doc/models/change-billing-anchor-date-request.md diff --git a/doc/models/change-billing-anchor-date-response.md b/legacy/doc/models/change-billing-anchor-date-response.md similarity index 100% rename from doc/models/change-billing-anchor-date-response.md rename to legacy/doc/models/change-billing-anchor-date-response.md diff --git a/doc/models/change-timing.md b/legacy/doc/models/change-timing.md similarity index 100% rename from doc/models/change-timing.md rename to legacy/doc/models/change-timing.md diff --git a/doc/models/charge-request-additional-recipient.md b/legacy/doc/models/charge-request-additional-recipient.md similarity index 100% rename from doc/models/charge-request-additional-recipient.md rename to legacy/doc/models/charge-request-additional-recipient.md diff --git a/doc/models/charge-request.md b/legacy/doc/models/charge-request.md similarity index 100% rename from doc/models/charge-request.md rename to legacy/doc/models/charge-request.md diff --git a/doc/models/charge-response.md b/legacy/doc/models/charge-response.md similarity index 100% rename from doc/models/charge-response.md rename to legacy/doc/models/charge-response.md diff --git a/doc/models/checkout-location-settings-branding-button-shape.md b/legacy/doc/models/checkout-location-settings-branding-button-shape.md similarity index 100% rename from doc/models/checkout-location-settings-branding-button-shape.md rename to legacy/doc/models/checkout-location-settings-branding-button-shape.md diff --git a/doc/models/checkout-location-settings-branding-header-type.md b/legacy/doc/models/checkout-location-settings-branding-header-type.md similarity index 100% rename from doc/models/checkout-location-settings-branding-header-type.md rename to legacy/doc/models/checkout-location-settings-branding-header-type.md diff --git a/doc/models/checkout-location-settings-branding.md b/legacy/doc/models/checkout-location-settings-branding.md similarity index 100% rename from doc/models/checkout-location-settings-branding.md rename to legacy/doc/models/checkout-location-settings-branding.md diff --git a/doc/models/checkout-location-settings-coupons.md b/legacy/doc/models/checkout-location-settings-coupons.md similarity index 100% rename from doc/models/checkout-location-settings-coupons.md rename to legacy/doc/models/checkout-location-settings-coupons.md diff --git a/doc/models/checkout-location-settings-policy.md b/legacy/doc/models/checkout-location-settings-policy.md similarity index 100% rename from doc/models/checkout-location-settings-policy.md rename to legacy/doc/models/checkout-location-settings-policy.md diff --git a/doc/models/checkout-location-settings-tipping.md b/legacy/doc/models/checkout-location-settings-tipping.md similarity index 100% rename from doc/models/checkout-location-settings-tipping.md rename to legacy/doc/models/checkout-location-settings-tipping.md diff --git a/doc/models/checkout-location-settings.md b/legacy/doc/models/checkout-location-settings.md similarity index 100% rename from doc/models/checkout-location-settings.md rename to legacy/doc/models/checkout-location-settings.md diff --git a/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md b/legacy/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md similarity index 100% rename from doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md rename to legacy/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md diff --git a/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md b/legacy/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md similarity index 100% rename from doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md rename to legacy/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md diff --git a/doc/models/checkout-merchant-settings-payment-methods-payment-method.md b/legacy/doc/models/checkout-merchant-settings-payment-methods-payment-method.md similarity index 100% rename from doc/models/checkout-merchant-settings-payment-methods-payment-method.md rename to legacy/doc/models/checkout-merchant-settings-payment-methods-payment-method.md diff --git a/doc/models/checkout-merchant-settings-payment-methods.md b/legacy/doc/models/checkout-merchant-settings-payment-methods.md similarity index 100% rename from doc/models/checkout-merchant-settings-payment-methods.md rename to legacy/doc/models/checkout-merchant-settings-payment-methods.md diff --git a/doc/models/checkout-merchant-settings.md b/legacy/doc/models/checkout-merchant-settings.md similarity index 100% rename from doc/models/checkout-merchant-settings.md rename to legacy/doc/models/checkout-merchant-settings.md diff --git a/doc/models/checkout-options-payment-type.md b/legacy/doc/models/checkout-options-payment-type.md similarity index 100% rename from doc/models/checkout-options-payment-type.md rename to legacy/doc/models/checkout-options-payment-type.md diff --git a/doc/models/checkout-options.md b/legacy/doc/models/checkout-options.md similarity index 100% rename from doc/models/checkout-options.md rename to legacy/doc/models/checkout-options.md diff --git a/doc/models/checkout.md b/legacy/doc/models/checkout.md similarity index 100% rename from doc/models/checkout.md rename to legacy/doc/models/checkout.md diff --git a/doc/models/clearpay-details.md b/legacy/doc/models/clearpay-details.md similarity index 100% rename from doc/models/clearpay-details.md rename to legacy/doc/models/clearpay-details.md diff --git a/doc/models/clone-order-request.md b/legacy/doc/models/clone-order-request.md similarity index 100% rename from doc/models/clone-order-request.md rename to legacy/doc/models/clone-order-request.md diff --git a/doc/models/clone-order-response.md b/legacy/doc/models/clone-order-response.md similarity index 100% rename from doc/models/clone-order-response.md rename to legacy/doc/models/clone-order-response.md diff --git a/doc/models/collected-data.md b/legacy/doc/models/collected-data.md similarity index 100% rename from doc/models/collected-data.md rename to legacy/doc/models/collected-data.md diff --git a/doc/models/complete-payment-request.md b/legacy/doc/models/complete-payment-request.md similarity index 100% rename from doc/models/complete-payment-request.md rename to legacy/doc/models/complete-payment-request.md diff --git a/doc/models/complete-payment-response.md b/legacy/doc/models/complete-payment-response.md similarity index 100% rename from doc/models/complete-payment-response.md rename to legacy/doc/models/complete-payment-response.md diff --git a/doc/models/component-component-type.md b/legacy/doc/models/component-component-type.md similarity index 100% rename from doc/models/component-component-type.md rename to legacy/doc/models/component-component-type.md diff --git a/doc/models/component.md b/legacy/doc/models/component.md similarity index 100% rename from doc/models/component.md rename to legacy/doc/models/component.md diff --git a/doc/models/confirmation-decision.md b/legacy/doc/models/confirmation-decision.md similarity index 100% rename from doc/models/confirmation-decision.md rename to legacy/doc/models/confirmation-decision.md diff --git a/doc/models/confirmation-options.md b/legacy/doc/models/confirmation-options.md similarity index 100% rename from doc/models/confirmation-options.md rename to legacy/doc/models/confirmation-options.md diff --git a/doc/models/coordinates.md b/legacy/doc/models/coordinates.md similarity index 100% rename from doc/models/coordinates.md rename to legacy/doc/models/coordinates.md diff --git a/doc/models/country.md b/legacy/doc/models/country.md similarity index 100% rename from doc/models/country.md rename to legacy/doc/models/country.md diff --git a/doc/models/create-booking-custom-attribute-definition-request.md b/legacy/doc/models/create-booking-custom-attribute-definition-request.md similarity index 100% rename from doc/models/create-booking-custom-attribute-definition-request.md rename to legacy/doc/models/create-booking-custom-attribute-definition-request.md diff --git a/doc/models/create-booking-custom-attribute-definition-response.md b/legacy/doc/models/create-booking-custom-attribute-definition-response.md similarity index 100% rename from doc/models/create-booking-custom-attribute-definition-response.md rename to legacy/doc/models/create-booking-custom-attribute-definition-response.md diff --git a/doc/models/create-booking-request.md b/legacy/doc/models/create-booking-request.md similarity index 100% rename from doc/models/create-booking-request.md rename to legacy/doc/models/create-booking-request.md diff --git a/doc/models/create-booking-response.md b/legacy/doc/models/create-booking-response.md similarity index 100% rename from doc/models/create-booking-response.md rename to legacy/doc/models/create-booking-response.md diff --git a/doc/models/create-break-type-request.md b/legacy/doc/models/create-break-type-request.md similarity index 100% rename from doc/models/create-break-type-request.md rename to legacy/doc/models/create-break-type-request.md diff --git a/doc/models/create-break-type-response.md b/legacy/doc/models/create-break-type-response.md similarity index 100% rename from doc/models/create-break-type-response.md rename to legacy/doc/models/create-break-type-response.md diff --git a/doc/models/create-card-request.md b/legacy/doc/models/create-card-request.md similarity index 100% rename from doc/models/create-card-request.md rename to legacy/doc/models/create-card-request.md diff --git a/doc/models/create-card-response.md b/legacy/doc/models/create-card-response.md similarity index 100% rename from doc/models/create-card-response.md rename to legacy/doc/models/create-card-response.md diff --git a/doc/models/create-catalog-image-request.md b/legacy/doc/models/create-catalog-image-request.md similarity index 100% rename from doc/models/create-catalog-image-request.md rename to legacy/doc/models/create-catalog-image-request.md diff --git a/doc/models/create-catalog-image-response.md b/legacy/doc/models/create-catalog-image-response.md similarity index 100% rename from doc/models/create-catalog-image-response.md rename to legacy/doc/models/create-catalog-image-response.md diff --git a/doc/models/create-checkout-request.md b/legacy/doc/models/create-checkout-request.md similarity index 100% rename from doc/models/create-checkout-request.md rename to legacy/doc/models/create-checkout-request.md diff --git a/doc/models/create-checkout-response.md b/legacy/doc/models/create-checkout-response.md similarity index 100% rename from doc/models/create-checkout-response.md rename to legacy/doc/models/create-checkout-response.md diff --git a/doc/models/create-customer-card-request.md b/legacy/doc/models/create-customer-card-request.md similarity index 100% rename from doc/models/create-customer-card-request.md rename to legacy/doc/models/create-customer-card-request.md diff --git a/doc/models/create-customer-card-response.md b/legacy/doc/models/create-customer-card-response.md similarity index 100% rename from doc/models/create-customer-card-response.md rename to legacy/doc/models/create-customer-card-response.md diff --git a/doc/models/create-customer-custom-attribute-definition-request.md b/legacy/doc/models/create-customer-custom-attribute-definition-request.md similarity index 100% rename from doc/models/create-customer-custom-attribute-definition-request.md rename to legacy/doc/models/create-customer-custom-attribute-definition-request.md diff --git a/doc/models/create-customer-custom-attribute-definition-response.md b/legacy/doc/models/create-customer-custom-attribute-definition-response.md similarity index 100% rename from doc/models/create-customer-custom-attribute-definition-response.md rename to legacy/doc/models/create-customer-custom-attribute-definition-response.md diff --git a/doc/models/create-customer-group-request.md b/legacy/doc/models/create-customer-group-request.md similarity index 100% rename from doc/models/create-customer-group-request.md rename to legacy/doc/models/create-customer-group-request.md diff --git a/doc/models/create-customer-group-response.md b/legacy/doc/models/create-customer-group-response.md similarity index 100% rename from doc/models/create-customer-group-response.md rename to legacy/doc/models/create-customer-group-response.md diff --git a/doc/models/create-customer-request.md b/legacy/doc/models/create-customer-request.md similarity index 100% rename from doc/models/create-customer-request.md rename to legacy/doc/models/create-customer-request.md diff --git a/doc/models/create-customer-response.md b/legacy/doc/models/create-customer-response.md similarity index 100% rename from doc/models/create-customer-response.md rename to legacy/doc/models/create-customer-response.md diff --git a/doc/models/create-device-code-request.md b/legacy/doc/models/create-device-code-request.md similarity index 100% rename from doc/models/create-device-code-request.md rename to legacy/doc/models/create-device-code-request.md diff --git a/doc/models/create-device-code-response.md b/legacy/doc/models/create-device-code-response.md similarity index 100% rename from doc/models/create-device-code-response.md rename to legacy/doc/models/create-device-code-response.md diff --git a/doc/models/create-dispute-evidence-file-request.md b/legacy/doc/models/create-dispute-evidence-file-request.md similarity index 100% rename from doc/models/create-dispute-evidence-file-request.md rename to legacy/doc/models/create-dispute-evidence-file-request.md diff --git a/doc/models/create-dispute-evidence-file-response.md b/legacy/doc/models/create-dispute-evidence-file-response.md similarity index 100% rename from doc/models/create-dispute-evidence-file-response.md rename to legacy/doc/models/create-dispute-evidence-file-response.md diff --git a/doc/models/create-dispute-evidence-text-request.md b/legacy/doc/models/create-dispute-evidence-text-request.md similarity index 100% rename from doc/models/create-dispute-evidence-text-request.md rename to legacy/doc/models/create-dispute-evidence-text-request.md diff --git a/doc/models/create-dispute-evidence-text-response.md b/legacy/doc/models/create-dispute-evidence-text-response.md similarity index 100% rename from doc/models/create-dispute-evidence-text-response.md rename to legacy/doc/models/create-dispute-evidence-text-response.md diff --git a/doc/models/create-gift-card-activity-request.md b/legacy/doc/models/create-gift-card-activity-request.md similarity index 100% rename from doc/models/create-gift-card-activity-request.md rename to legacy/doc/models/create-gift-card-activity-request.md diff --git a/doc/models/create-gift-card-activity-response.md b/legacy/doc/models/create-gift-card-activity-response.md similarity index 100% rename from doc/models/create-gift-card-activity-response.md rename to legacy/doc/models/create-gift-card-activity-response.md diff --git a/doc/models/create-gift-card-request.md b/legacy/doc/models/create-gift-card-request.md similarity index 100% rename from doc/models/create-gift-card-request.md rename to legacy/doc/models/create-gift-card-request.md diff --git a/doc/models/create-gift-card-response.md b/legacy/doc/models/create-gift-card-response.md similarity index 100% rename from doc/models/create-gift-card-response.md rename to legacy/doc/models/create-gift-card-response.md diff --git a/doc/models/create-invoice-attachment-request.md b/legacy/doc/models/create-invoice-attachment-request.md similarity index 100% rename from doc/models/create-invoice-attachment-request.md rename to legacy/doc/models/create-invoice-attachment-request.md diff --git a/doc/models/create-invoice-attachment-response.md b/legacy/doc/models/create-invoice-attachment-response.md similarity index 100% rename from doc/models/create-invoice-attachment-response.md rename to legacy/doc/models/create-invoice-attachment-response.md diff --git a/doc/models/create-invoice-request.md b/legacy/doc/models/create-invoice-request.md similarity index 100% rename from doc/models/create-invoice-request.md rename to legacy/doc/models/create-invoice-request.md diff --git a/doc/models/create-invoice-response.md b/legacy/doc/models/create-invoice-response.md similarity index 100% rename from doc/models/create-invoice-response.md rename to legacy/doc/models/create-invoice-response.md diff --git a/doc/models/create-job-request.md b/legacy/doc/models/create-job-request.md similarity index 100% rename from doc/models/create-job-request.md rename to legacy/doc/models/create-job-request.md diff --git a/doc/models/create-job-response.md b/legacy/doc/models/create-job-response.md similarity index 100% rename from doc/models/create-job-response.md rename to legacy/doc/models/create-job-response.md diff --git a/doc/models/create-location-custom-attribute-definition-request.md b/legacy/doc/models/create-location-custom-attribute-definition-request.md similarity index 100% rename from doc/models/create-location-custom-attribute-definition-request.md rename to legacy/doc/models/create-location-custom-attribute-definition-request.md diff --git a/doc/models/create-location-custom-attribute-definition-response.md b/legacy/doc/models/create-location-custom-attribute-definition-response.md similarity index 100% rename from doc/models/create-location-custom-attribute-definition-response.md rename to legacy/doc/models/create-location-custom-attribute-definition-response.md diff --git a/doc/models/create-location-request.md b/legacy/doc/models/create-location-request.md similarity index 100% rename from doc/models/create-location-request.md rename to legacy/doc/models/create-location-request.md diff --git a/doc/models/create-location-response.md b/legacy/doc/models/create-location-response.md similarity index 100% rename from doc/models/create-location-response.md rename to legacy/doc/models/create-location-response.md diff --git a/doc/models/create-loyalty-account-request.md b/legacy/doc/models/create-loyalty-account-request.md similarity index 100% rename from doc/models/create-loyalty-account-request.md rename to legacy/doc/models/create-loyalty-account-request.md diff --git a/doc/models/create-loyalty-account-response.md b/legacy/doc/models/create-loyalty-account-response.md similarity index 100% rename from doc/models/create-loyalty-account-response.md rename to legacy/doc/models/create-loyalty-account-response.md diff --git a/doc/models/create-loyalty-promotion-request.md b/legacy/doc/models/create-loyalty-promotion-request.md similarity index 100% rename from doc/models/create-loyalty-promotion-request.md rename to legacy/doc/models/create-loyalty-promotion-request.md diff --git a/doc/models/create-loyalty-promotion-response.md b/legacy/doc/models/create-loyalty-promotion-response.md similarity index 100% rename from doc/models/create-loyalty-promotion-response.md rename to legacy/doc/models/create-loyalty-promotion-response.md diff --git a/doc/models/create-loyalty-reward-request.md b/legacy/doc/models/create-loyalty-reward-request.md similarity index 100% rename from doc/models/create-loyalty-reward-request.md rename to legacy/doc/models/create-loyalty-reward-request.md diff --git a/doc/models/create-loyalty-reward-response.md b/legacy/doc/models/create-loyalty-reward-response.md similarity index 100% rename from doc/models/create-loyalty-reward-response.md rename to legacy/doc/models/create-loyalty-reward-response.md diff --git a/doc/models/create-merchant-custom-attribute-definition-request.md b/legacy/doc/models/create-merchant-custom-attribute-definition-request.md similarity index 100% rename from doc/models/create-merchant-custom-attribute-definition-request.md rename to legacy/doc/models/create-merchant-custom-attribute-definition-request.md diff --git a/doc/models/create-merchant-custom-attribute-definition-response.md b/legacy/doc/models/create-merchant-custom-attribute-definition-response.md similarity index 100% rename from doc/models/create-merchant-custom-attribute-definition-response.md rename to legacy/doc/models/create-merchant-custom-attribute-definition-response.md diff --git a/doc/models/create-mobile-authorization-code-request.md b/legacy/doc/models/create-mobile-authorization-code-request.md similarity index 100% rename from doc/models/create-mobile-authorization-code-request.md rename to legacy/doc/models/create-mobile-authorization-code-request.md diff --git a/doc/models/create-mobile-authorization-code-response.md b/legacy/doc/models/create-mobile-authorization-code-response.md similarity index 100% rename from doc/models/create-mobile-authorization-code-response.md rename to legacy/doc/models/create-mobile-authorization-code-response.md diff --git a/doc/models/create-order-custom-attribute-definition-request.md b/legacy/doc/models/create-order-custom-attribute-definition-request.md similarity index 100% rename from doc/models/create-order-custom-attribute-definition-request.md rename to legacy/doc/models/create-order-custom-attribute-definition-request.md diff --git a/doc/models/create-order-custom-attribute-definition-response.md b/legacy/doc/models/create-order-custom-attribute-definition-response.md similarity index 100% rename from doc/models/create-order-custom-attribute-definition-response.md rename to legacy/doc/models/create-order-custom-attribute-definition-response.md diff --git a/doc/models/create-order-request.md b/legacy/doc/models/create-order-request.md similarity index 100% rename from doc/models/create-order-request.md rename to legacy/doc/models/create-order-request.md diff --git a/doc/models/create-order-response.md b/legacy/doc/models/create-order-response.md similarity index 100% rename from doc/models/create-order-response.md rename to legacy/doc/models/create-order-response.md diff --git a/doc/models/create-payment-link-request.md b/legacy/doc/models/create-payment-link-request.md similarity index 100% rename from doc/models/create-payment-link-request.md rename to legacy/doc/models/create-payment-link-request.md diff --git a/doc/models/create-payment-link-response.md b/legacy/doc/models/create-payment-link-response.md similarity index 100% rename from doc/models/create-payment-link-response.md rename to legacy/doc/models/create-payment-link-response.md diff --git a/doc/models/create-payment-request.md b/legacy/doc/models/create-payment-request.md similarity index 100% rename from doc/models/create-payment-request.md rename to legacy/doc/models/create-payment-request.md diff --git a/doc/models/create-payment-response.md b/legacy/doc/models/create-payment-response.md similarity index 100% rename from doc/models/create-payment-response.md rename to legacy/doc/models/create-payment-response.md diff --git a/doc/models/create-refund-request.md b/legacy/doc/models/create-refund-request.md similarity index 100% rename from doc/models/create-refund-request.md rename to legacy/doc/models/create-refund-request.md diff --git a/doc/models/create-refund-response.md b/legacy/doc/models/create-refund-response.md similarity index 100% rename from doc/models/create-refund-response.md rename to legacy/doc/models/create-refund-response.md diff --git a/doc/models/create-shift-request.md b/legacy/doc/models/create-shift-request.md similarity index 100% rename from doc/models/create-shift-request.md rename to legacy/doc/models/create-shift-request.md diff --git a/doc/models/create-shift-response.md b/legacy/doc/models/create-shift-response.md similarity index 100% rename from doc/models/create-shift-response.md rename to legacy/doc/models/create-shift-response.md diff --git a/doc/models/create-subscription-request.md b/legacy/doc/models/create-subscription-request.md similarity index 100% rename from doc/models/create-subscription-request.md rename to legacy/doc/models/create-subscription-request.md diff --git a/doc/models/create-subscription-response.md b/legacy/doc/models/create-subscription-response.md similarity index 100% rename from doc/models/create-subscription-response.md rename to legacy/doc/models/create-subscription-response.md diff --git a/doc/models/create-team-member-request.md b/legacy/doc/models/create-team-member-request.md similarity index 100% rename from doc/models/create-team-member-request.md rename to legacy/doc/models/create-team-member-request.md diff --git a/doc/models/create-team-member-response.md b/legacy/doc/models/create-team-member-response.md similarity index 100% rename from doc/models/create-team-member-response.md rename to legacy/doc/models/create-team-member-response.md diff --git a/doc/models/create-terminal-action-request.md b/legacy/doc/models/create-terminal-action-request.md similarity index 100% rename from doc/models/create-terminal-action-request.md rename to legacy/doc/models/create-terminal-action-request.md diff --git a/doc/models/create-terminal-action-response.md b/legacy/doc/models/create-terminal-action-response.md similarity index 100% rename from doc/models/create-terminal-action-response.md rename to legacy/doc/models/create-terminal-action-response.md diff --git a/doc/models/create-terminal-checkout-request.md b/legacy/doc/models/create-terminal-checkout-request.md similarity index 100% rename from doc/models/create-terminal-checkout-request.md rename to legacy/doc/models/create-terminal-checkout-request.md diff --git a/doc/models/create-terminal-checkout-response.md b/legacy/doc/models/create-terminal-checkout-response.md similarity index 100% rename from doc/models/create-terminal-checkout-response.md rename to legacy/doc/models/create-terminal-checkout-response.md diff --git a/doc/models/create-terminal-refund-request.md b/legacy/doc/models/create-terminal-refund-request.md similarity index 100% rename from doc/models/create-terminal-refund-request.md rename to legacy/doc/models/create-terminal-refund-request.md diff --git a/doc/models/create-terminal-refund-response.md b/legacy/doc/models/create-terminal-refund-response.md similarity index 100% rename from doc/models/create-terminal-refund-response.md rename to legacy/doc/models/create-terminal-refund-response.md diff --git a/doc/models/create-vendor-request.md b/legacy/doc/models/create-vendor-request.md similarity index 100% rename from doc/models/create-vendor-request.md rename to legacy/doc/models/create-vendor-request.md diff --git a/doc/models/create-vendor-response.md b/legacy/doc/models/create-vendor-response.md similarity index 100% rename from doc/models/create-vendor-response.md rename to legacy/doc/models/create-vendor-response.md diff --git a/doc/models/create-webhook-subscription-request.md b/legacy/doc/models/create-webhook-subscription-request.md similarity index 100% rename from doc/models/create-webhook-subscription-request.md rename to legacy/doc/models/create-webhook-subscription-request.md diff --git a/doc/models/create-webhook-subscription-response.md b/legacy/doc/models/create-webhook-subscription-response.md similarity index 100% rename from doc/models/create-webhook-subscription-response.md rename to legacy/doc/models/create-webhook-subscription-response.md diff --git a/doc/models/currency.md b/legacy/doc/models/currency.md similarity index 100% rename from doc/models/currency.md rename to legacy/doc/models/currency.md diff --git a/doc/models/custom-attribute-definition-visibility.md b/legacy/doc/models/custom-attribute-definition-visibility.md similarity index 100% rename from doc/models/custom-attribute-definition-visibility.md rename to legacy/doc/models/custom-attribute-definition-visibility.md diff --git a/doc/models/custom-attribute-definition.md b/legacy/doc/models/custom-attribute-definition.md similarity index 100% rename from doc/models/custom-attribute-definition.md rename to legacy/doc/models/custom-attribute-definition.md diff --git a/doc/models/custom-attribute-filter.md b/legacy/doc/models/custom-attribute-filter.md similarity index 100% rename from doc/models/custom-attribute-filter.md rename to legacy/doc/models/custom-attribute-filter.md diff --git a/doc/models/custom-attribute.md b/legacy/doc/models/custom-attribute.md similarity index 100% rename from doc/models/custom-attribute.md rename to legacy/doc/models/custom-attribute.md diff --git a/doc/models/custom-field.md b/legacy/doc/models/custom-field.md similarity index 100% rename from doc/models/custom-field.md rename to legacy/doc/models/custom-field.md diff --git a/doc/models/customer-address-filter.md b/legacy/doc/models/customer-address-filter.md similarity index 100% rename from doc/models/customer-address-filter.md rename to legacy/doc/models/customer-address-filter.md diff --git a/doc/models/customer-creation-source-filter.md b/legacy/doc/models/customer-creation-source-filter.md similarity index 100% rename from doc/models/customer-creation-source-filter.md rename to legacy/doc/models/customer-creation-source-filter.md diff --git a/doc/models/customer-creation-source.md b/legacy/doc/models/customer-creation-source.md similarity index 100% rename from doc/models/customer-creation-source.md rename to legacy/doc/models/customer-creation-source.md diff --git a/doc/models/customer-custom-attribute-filter-value.md b/legacy/doc/models/customer-custom-attribute-filter-value.md similarity index 100% rename from doc/models/customer-custom-attribute-filter-value.md rename to legacy/doc/models/customer-custom-attribute-filter-value.md diff --git a/doc/models/customer-custom-attribute-filter.md b/legacy/doc/models/customer-custom-attribute-filter.md similarity index 100% rename from doc/models/customer-custom-attribute-filter.md rename to legacy/doc/models/customer-custom-attribute-filter.md diff --git a/doc/models/customer-custom-attribute-filters.md b/legacy/doc/models/customer-custom-attribute-filters.md similarity index 100% rename from doc/models/customer-custom-attribute-filters.md rename to legacy/doc/models/customer-custom-attribute-filters.md diff --git a/doc/models/customer-details.md b/legacy/doc/models/customer-details.md similarity index 100% rename from doc/models/customer-details.md rename to legacy/doc/models/customer-details.md diff --git a/doc/models/customer-filter.md b/legacy/doc/models/customer-filter.md similarity index 100% rename from doc/models/customer-filter.md rename to legacy/doc/models/customer-filter.md diff --git a/doc/models/customer-group.md b/legacy/doc/models/customer-group.md similarity index 100% rename from doc/models/customer-group.md rename to legacy/doc/models/customer-group.md diff --git a/doc/models/customer-inclusion-exclusion.md b/legacy/doc/models/customer-inclusion-exclusion.md similarity index 100% rename from doc/models/customer-inclusion-exclusion.md rename to legacy/doc/models/customer-inclusion-exclusion.md diff --git a/doc/models/customer-preferences.md b/legacy/doc/models/customer-preferences.md similarity index 100% rename from doc/models/customer-preferences.md rename to legacy/doc/models/customer-preferences.md diff --git a/doc/models/customer-query.md b/legacy/doc/models/customer-query.md similarity index 100% rename from doc/models/customer-query.md rename to legacy/doc/models/customer-query.md diff --git a/doc/models/customer-segment.md b/legacy/doc/models/customer-segment.md similarity index 100% rename from doc/models/customer-segment.md rename to legacy/doc/models/customer-segment.md diff --git a/doc/models/customer-sort-field.md b/legacy/doc/models/customer-sort-field.md similarity index 100% rename from doc/models/customer-sort-field.md rename to legacy/doc/models/customer-sort-field.md diff --git a/doc/models/customer-sort.md b/legacy/doc/models/customer-sort.md similarity index 100% rename from doc/models/customer-sort.md rename to legacy/doc/models/customer-sort.md diff --git a/doc/models/customer-tax-ids.md b/legacy/doc/models/customer-tax-ids.md similarity index 100% rename from doc/models/customer-tax-ids.md rename to legacy/doc/models/customer-tax-ids.md diff --git a/doc/models/customer-text-filter.md b/legacy/doc/models/customer-text-filter.md similarity index 100% rename from doc/models/customer-text-filter.md rename to legacy/doc/models/customer-text-filter.md diff --git a/doc/models/customer.md b/legacy/doc/models/customer.md similarity index 100% rename from doc/models/customer.md rename to legacy/doc/models/customer.md diff --git a/doc/models/data-collection-options-input-type.md b/legacy/doc/models/data-collection-options-input-type.md similarity index 100% rename from doc/models/data-collection-options-input-type.md rename to legacy/doc/models/data-collection-options-input-type.md diff --git a/doc/models/data-collection-options.md b/legacy/doc/models/data-collection-options.md similarity index 100% rename from doc/models/data-collection-options.md rename to legacy/doc/models/data-collection-options.md diff --git a/doc/models/date-range.md b/legacy/doc/models/date-range.md similarity index 100% rename from doc/models/date-range.md rename to legacy/doc/models/date-range.md diff --git a/doc/models/day-of-week.md b/legacy/doc/models/day-of-week.md similarity index 100% rename from doc/models/day-of-week.md rename to legacy/doc/models/day-of-week.md diff --git a/doc/models/delete-booking-custom-attribute-definition-response.md b/legacy/doc/models/delete-booking-custom-attribute-definition-response.md similarity index 100% rename from doc/models/delete-booking-custom-attribute-definition-response.md rename to legacy/doc/models/delete-booking-custom-attribute-definition-response.md diff --git a/doc/models/delete-booking-custom-attribute-response.md b/legacy/doc/models/delete-booking-custom-attribute-response.md similarity index 100% rename from doc/models/delete-booking-custom-attribute-response.md rename to legacy/doc/models/delete-booking-custom-attribute-response.md diff --git a/doc/models/delete-break-type-response.md b/legacy/doc/models/delete-break-type-response.md similarity index 100% rename from doc/models/delete-break-type-response.md rename to legacy/doc/models/delete-break-type-response.md diff --git a/doc/models/delete-catalog-object-response.md b/legacy/doc/models/delete-catalog-object-response.md similarity index 100% rename from doc/models/delete-catalog-object-response.md rename to legacy/doc/models/delete-catalog-object-response.md diff --git a/doc/models/delete-customer-card-response.md b/legacy/doc/models/delete-customer-card-response.md similarity index 100% rename from doc/models/delete-customer-card-response.md rename to legacy/doc/models/delete-customer-card-response.md diff --git a/doc/models/delete-customer-custom-attribute-definition-response.md b/legacy/doc/models/delete-customer-custom-attribute-definition-response.md similarity index 100% rename from doc/models/delete-customer-custom-attribute-definition-response.md rename to legacy/doc/models/delete-customer-custom-attribute-definition-response.md diff --git a/doc/models/delete-customer-custom-attribute-response.md b/legacy/doc/models/delete-customer-custom-attribute-response.md similarity index 100% rename from doc/models/delete-customer-custom-attribute-response.md rename to legacy/doc/models/delete-customer-custom-attribute-response.md diff --git a/doc/models/delete-customer-group-response.md b/legacy/doc/models/delete-customer-group-response.md similarity index 100% rename from doc/models/delete-customer-group-response.md rename to legacy/doc/models/delete-customer-group-response.md diff --git a/doc/models/delete-customer-request.md b/legacy/doc/models/delete-customer-request.md similarity index 100% rename from doc/models/delete-customer-request.md rename to legacy/doc/models/delete-customer-request.md diff --git a/doc/models/delete-customer-response.md b/legacy/doc/models/delete-customer-response.md similarity index 100% rename from doc/models/delete-customer-response.md rename to legacy/doc/models/delete-customer-response.md diff --git a/doc/models/delete-dispute-evidence-response.md b/legacy/doc/models/delete-dispute-evidence-response.md similarity index 100% rename from doc/models/delete-dispute-evidence-response.md rename to legacy/doc/models/delete-dispute-evidence-response.md diff --git a/doc/models/delete-invoice-attachment-response.md b/legacy/doc/models/delete-invoice-attachment-response.md similarity index 100% rename from doc/models/delete-invoice-attachment-response.md rename to legacy/doc/models/delete-invoice-attachment-response.md diff --git a/doc/models/delete-invoice-request.md b/legacy/doc/models/delete-invoice-request.md similarity index 100% rename from doc/models/delete-invoice-request.md rename to legacy/doc/models/delete-invoice-request.md diff --git a/doc/models/delete-invoice-response.md b/legacy/doc/models/delete-invoice-response.md similarity index 100% rename from doc/models/delete-invoice-response.md rename to legacy/doc/models/delete-invoice-response.md diff --git a/doc/models/delete-location-custom-attribute-definition-response.md b/legacy/doc/models/delete-location-custom-attribute-definition-response.md similarity index 100% rename from doc/models/delete-location-custom-attribute-definition-response.md rename to legacy/doc/models/delete-location-custom-attribute-definition-response.md diff --git a/doc/models/delete-location-custom-attribute-response.md b/legacy/doc/models/delete-location-custom-attribute-response.md similarity index 100% rename from doc/models/delete-location-custom-attribute-response.md rename to legacy/doc/models/delete-location-custom-attribute-response.md diff --git a/doc/models/delete-loyalty-reward-response.md b/legacy/doc/models/delete-loyalty-reward-response.md similarity index 100% rename from doc/models/delete-loyalty-reward-response.md rename to legacy/doc/models/delete-loyalty-reward-response.md diff --git a/doc/models/delete-merchant-custom-attribute-definition-response.md b/legacy/doc/models/delete-merchant-custom-attribute-definition-response.md similarity index 100% rename from doc/models/delete-merchant-custom-attribute-definition-response.md rename to legacy/doc/models/delete-merchant-custom-attribute-definition-response.md diff --git a/doc/models/delete-merchant-custom-attribute-response.md b/legacy/doc/models/delete-merchant-custom-attribute-response.md similarity index 100% rename from doc/models/delete-merchant-custom-attribute-response.md rename to legacy/doc/models/delete-merchant-custom-attribute-response.md diff --git a/doc/models/delete-order-custom-attribute-definition-response.md b/legacy/doc/models/delete-order-custom-attribute-definition-response.md similarity index 100% rename from doc/models/delete-order-custom-attribute-definition-response.md rename to legacy/doc/models/delete-order-custom-attribute-definition-response.md diff --git a/doc/models/delete-order-custom-attribute-response.md b/legacy/doc/models/delete-order-custom-attribute-response.md similarity index 100% rename from doc/models/delete-order-custom-attribute-response.md rename to legacy/doc/models/delete-order-custom-attribute-response.md diff --git a/doc/models/delete-payment-link-response.md b/legacy/doc/models/delete-payment-link-response.md similarity index 100% rename from doc/models/delete-payment-link-response.md rename to legacy/doc/models/delete-payment-link-response.md diff --git a/doc/models/delete-shift-response.md b/legacy/doc/models/delete-shift-response.md similarity index 100% rename from doc/models/delete-shift-response.md rename to legacy/doc/models/delete-shift-response.md diff --git a/doc/models/delete-snippet-response.md b/legacy/doc/models/delete-snippet-response.md similarity index 100% rename from doc/models/delete-snippet-response.md rename to legacy/doc/models/delete-snippet-response.md diff --git a/doc/models/delete-subscription-action-response.md b/legacy/doc/models/delete-subscription-action-response.md similarity index 100% rename from doc/models/delete-subscription-action-response.md rename to legacy/doc/models/delete-subscription-action-response.md diff --git a/doc/models/delete-webhook-subscription-response.md b/legacy/doc/models/delete-webhook-subscription-response.md similarity index 100% rename from doc/models/delete-webhook-subscription-response.md rename to legacy/doc/models/delete-webhook-subscription-response.md diff --git a/doc/models/deprecated-create-dispute-evidence-file-request.md b/legacy/doc/models/deprecated-create-dispute-evidence-file-request.md similarity index 100% rename from doc/models/deprecated-create-dispute-evidence-file-request.md rename to legacy/doc/models/deprecated-create-dispute-evidence-file-request.md diff --git a/doc/models/deprecated-create-dispute-evidence-file-response.md b/legacy/doc/models/deprecated-create-dispute-evidence-file-response.md similarity index 100% rename from doc/models/deprecated-create-dispute-evidence-file-response.md rename to legacy/doc/models/deprecated-create-dispute-evidence-file-response.md diff --git a/doc/models/deprecated-create-dispute-evidence-text-request.md b/legacy/doc/models/deprecated-create-dispute-evidence-text-request.md similarity index 100% rename from doc/models/deprecated-create-dispute-evidence-text-request.md rename to legacy/doc/models/deprecated-create-dispute-evidence-text-request.md diff --git a/doc/models/deprecated-create-dispute-evidence-text-response.md b/legacy/doc/models/deprecated-create-dispute-evidence-text-response.md similarity index 100% rename from doc/models/deprecated-create-dispute-evidence-text-response.md rename to legacy/doc/models/deprecated-create-dispute-evidence-text-response.md diff --git a/doc/models/destination-details-card-refund-details.md b/legacy/doc/models/destination-details-card-refund-details.md similarity index 100% rename from doc/models/destination-details-card-refund-details.md rename to legacy/doc/models/destination-details-card-refund-details.md diff --git a/doc/models/destination-details-cash-refund-details.md b/legacy/doc/models/destination-details-cash-refund-details.md similarity index 100% rename from doc/models/destination-details-cash-refund-details.md rename to legacy/doc/models/destination-details-cash-refund-details.md diff --git a/doc/models/destination-details-external-refund-details.md b/legacy/doc/models/destination-details-external-refund-details.md similarity index 100% rename from doc/models/destination-details-external-refund-details.md rename to legacy/doc/models/destination-details-external-refund-details.md diff --git a/doc/models/destination-details.md b/legacy/doc/models/destination-details.md similarity index 100% rename from doc/models/destination-details.md rename to legacy/doc/models/destination-details.md diff --git a/doc/models/destination-type.md b/legacy/doc/models/destination-type.md similarity index 100% rename from doc/models/destination-type.md rename to legacy/doc/models/destination-type.md diff --git a/doc/models/destination.md b/legacy/doc/models/destination.md similarity index 100% rename from doc/models/destination.md rename to legacy/doc/models/destination.md diff --git a/doc/models/device-attributes-device-type.md b/legacy/doc/models/device-attributes-device-type.md similarity index 100% rename from doc/models/device-attributes-device-type.md rename to legacy/doc/models/device-attributes-device-type.md diff --git a/doc/models/device-attributes.md b/legacy/doc/models/device-attributes.md similarity index 100% rename from doc/models/device-attributes.md rename to legacy/doc/models/device-attributes.md diff --git a/doc/models/device-checkout-options.md b/legacy/doc/models/device-checkout-options.md similarity index 100% rename from doc/models/device-checkout-options.md rename to legacy/doc/models/device-checkout-options.md diff --git a/doc/models/device-code-status.md b/legacy/doc/models/device-code-status.md similarity index 100% rename from doc/models/device-code-status.md rename to legacy/doc/models/device-code-status.md diff --git a/doc/models/device-code.md b/legacy/doc/models/device-code.md similarity index 100% rename from doc/models/device-code.md rename to legacy/doc/models/device-code.md diff --git a/doc/models/device-component-details-application-details.md b/legacy/doc/models/device-component-details-application-details.md similarity index 100% rename from doc/models/device-component-details-application-details.md rename to legacy/doc/models/device-component-details-application-details.md diff --git a/doc/models/device-component-details-battery-details.md b/legacy/doc/models/device-component-details-battery-details.md similarity index 100% rename from doc/models/device-component-details-battery-details.md rename to legacy/doc/models/device-component-details-battery-details.md diff --git a/doc/models/device-component-details-card-reader-details.md b/legacy/doc/models/device-component-details-card-reader-details.md similarity index 100% rename from doc/models/device-component-details-card-reader-details.md rename to legacy/doc/models/device-component-details-card-reader-details.md diff --git a/doc/models/device-component-details-ethernet-details.md b/legacy/doc/models/device-component-details-ethernet-details.md similarity index 100% rename from doc/models/device-component-details-ethernet-details.md rename to legacy/doc/models/device-component-details-ethernet-details.md diff --git a/doc/models/device-component-details-external-power.md b/legacy/doc/models/device-component-details-external-power.md similarity index 100% rename from doc/models/device-component-details-external-power.md rename to legacy/doc/models/device-component-details-external-power.md diff --git a/doc/models/device-component-details-measurement.md b/legacy/doc/models/device-component-details-measurement.md similarity index 100% rename from doc/models/device-component-details-measurement.md rename to legacy/doc/models/device-component-details-measurement.md diff --git a/doc/models/device-component-details-network-interface-details.md b/legacy/doc/models/device-component-details-network-interface-details.md similarity index 100% rename from doc/models/device-component-details-network-interface-details.md rename to legacy/doc/models/device-component-details-network-interface-details.md diff --git a/doc/models/device-component-details-wi-fi-details.md b/legacy/doc/models/device-component-details-wi-fi-details.md similarity index 100% rename from doc/models/device-component-details-wi-fi-details.md rename to legacy/doc/models/device-component-details-wi-fi-details.md diff --git a/doc/models/device-details.md b/legacy/doc/models/device-details.md similarity index 100% rename from doc/models/device-details.md rename to legacy/doc/models/device-details.md diff --git a/doc/models/device-metadata.md b/legacy/doc/models/device-metadata.md similarity index 100% rename from doc/models/device-metadata.md rename to legacy/doc/models/device-metadata.md diff --git a/doc/models/device-status-category.md b/legacy/doc/models/device-status-category.md similarity index 100% rename from doc/models/device-status-category.md rename to legacy/doc/models/device-status-category.md diff --git a/doc/models/device-status.md b/legacy/doc/models/device-status.md similarity index 100% rename from doc/models/device-status.md rename to legacy/doc/models/device-status.md diff --git a/doc/models/device.md b/legacy/doc/models/device.md similarity index 100% rename from doc/models/device.md rename to legacy/doc/models/device.md diff --git a/doc/models/digital-wallet-details.md b/legacy/doc/models/digital-wallet-details.md similarity index 100% rename from doc/models/digital-wallet-details.md rename to legacy/doc/models/digital-wallet-details.md diff --git a/doc/models/disable-card-response.md b/legacy/doc/models/disable-card-response.md similarity index 100% rename from doc/models/disable-card-response.md rename to legacy/doc/models/disable-card-response.md diff --git a/doc/models/disable-events-response.md b/legacy/doc/models/disable-events-response.md similarity index 100% rename from doc/models/disable-events-response.md rename to legacy/doc/models/disable-events-response.md diff --git a/doc/models/dismiss-terminal-action-response.md b/legacy/doc/models/dismiss-terminal-action-response.md similarity index 100% rename from doc/models/dismiss-terminal-action-response.md rename to legacy/doc/models/dismiss-terminal-action-response.md diff --git a/doc/models/dismiss-terminal-checkout-response.md b/legacy/doc/models/dismiss-terminal-checkout-response.md similarity index 100% rename from doc/models/dismiss-terminal-checkout-response.md rename to legacy/doc/models/dismiss-terminal-checkout-response.md diff --git a/doc/models/dismiss-terminal-refund-response.md b/legacy/doc/models/dismiss-terminal-refund-response.md similarity index 100% rename from doc/models/dismiss-terminal-refund-response.md rename to legacy/doc/models/dismiss-terminal-refund-response.md diff --git a/doc/models/dispute-evidence-file.md b/legacy/doc/models/dispute-evidence-file.md similarity index 100% rename from doc/models/dispute-evidence-file.md rename to legacy/doc/models/dispute-evidence-file.md diff --git a/doc/models/dispute-evidence-type.md b/legacy/doc/models/dispute-evidence-type.md similarity index 100% rename from doc/models/dispute-evidence-type.md rename to legacy/doc/models/dispute-evidence-type.md diff --git a/doc/models/dispute-evidence.md b/legacy/doc/models/dispute-evidence.md similarity index 100% rename from doc/models/dispute-evidence.md rename to legacy/doc/models/dispute-evidence.md diff --git a/doc/models/dispute-reason.md b/legacy/doc/models/dispute-reason.md similarity index 100% rename from doc/models/dispute-reason.md rename to legacy/doc/models/dispute-reason.md diff --git a/doc/models/dispute-state.md b/legacy/doc/models/dispute-state.md similarity index 100% rename from doc/models/dispute-state.md rename to legacy/doc/models/dispute-state.md diff --git a/doc/models/dispute.md b/legacy/doc/models/dispute.md similarity index 100% rename from doc/models/dispute.md rename to legacy/doc/models/dispute.md diff --git a/doc/models/disputed-payment.md b/legacy/doc/models/disputed-payment.md similarity index 100% rename from doc/models/disputed-payment.md rename to legacy/doc/models/disputed-payment.md diff --git a/doc/models/ecom-visibility.md b/legacy/doc/models/ecom-visibility.md similarity index 100% rename from doc/models/ecom-visibility.md rename to legacy/doc/models/ecom-visibility.md diff --git a/doc/models/employee-status.md b/legacy/doc/models/employee-status.md similarity index 100% rename from doc/models/employee-status.md rename to legacy/doc/models/employee-status.md diff --git a/doc/models/employee-wage.md b/legacy/doc/models/employee-wage.md similarity index 100% rename from doc/models/employee-wage.md rename to legacy/doc/models/employee-wage.md diff --git a/doc/models/employee.md b/legacy/doc/models/employee.md similarity index 100% rename from doc/models/employee.md rename to legacy/doc/models/employee.md diff --git a/doc/models/enable-events-response.md b/legacy/doc/models/enable-events-response.md similarity index 100% rename from doc/models/enable-events-response.md rename to legacy/doc/models/enable-events-response.md diff --git a/doc/models/error-category.md b/legacy/doc/models/error-category.md similarity index 100% rename from doc/models/error-category.md rename to legacy/doc/models/error-category.md diff --git a/doc/models/error-code.md b/legacy/doc/models/error-code.md similarity index 100% rename from doc/models/error-code.md rename to legacy/doc/models/error-code.md diff --git a/doc/models/error.md b/legacy/doc/models/error.md similarity index 100% rename from doc/models/error.md rename to legacy/doc/models/error.md diff --git a/doc/models/event-data.md b/legacy/doc/models/event-data.md similarity index 100% rename from doc/models/event-data.md rename to legacy/doc/models/event-data.md diff --git a/doc/models/event-metadata.md b/legacy/doc/models/event-metadata.md similarity index 100% rename from doc/models/event-metadata.md rename to legacy/doc/models/event-metadata.md diff --git a/doc/models/event-type-metadata.md b/legacy/doc/models/event-type-metadata.md similarity index 100% rename from doc/models/event-type-metadata.md rename to legacy/doc/models/event-type-metadata.md diff --git a/doc/models/event.md b/legacy/doc/models/event.md similarity index 100% rename from doc/models/event.md rename to legacy/doc/models/event.md diff --git a/doc/models/exclude-strategy.md b/legacy/doc/models/exclude-strategy.md similarity index 100% rename from doc/models/exclude-strategy.md rename to legacy/doc/models/exclude-strategy.md diff --git a/doc/models/external-payment-details.md b/legacy/doc/models/external-payment-details.md similarity index 100% rename from doc/models/external-payment-details.md rename to legacy/doc/models/external-payment-details.md diff --git a/doc/models/filter-value.md b/legacy/doc/models/filter-value.md similarity index 100% rename from doc/models/filter-value.md rename to legacy/doc/models/filter-value.md diff --git a/doc/models/float-number-range.md b/legacy/doc/models/float-number-range.md similarity index 100% rename from doc/models/float-number-range.md rename to legacy/doc/models/float-number-range.md diff --git a/doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md b/legacy/doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md similarity index 100% rename from doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md rename to legacy/doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md diff --git a/doc/models/fulfillment-delivery-details.md b/legacy/doc/models/fulfillment-delivery-details.md similarity index 100% rename from doc/models/fulfillment-delivery-details.md rename to legacy/doc/models/fulfillment-delivery-details.md diff --git a/doc/models/fulfillment-fulfillment-entry.md b/legacy/doc/models/fulfillment-fulfillment-entry.md similarity index 100% rename from doc/models/fulfillment-fulfillment-entry.md rename to legacy/doc/models/fulfillment-fulfillment-entry.md diff --git a/doc/models/fulfillment-fulfillment-line-item-application.md b/legacy/doc/models/fulfillment-fulfillment-line-item-application.md similarity index 100% rename from doc/models/fulfillment-fulfillment-line-item-application.md rename to legacy/doc/models/fulfillment-fulfillment-line-item-application.md diff --git a/doc/models/fulfillment-pickup-details-curbside-pickup-details.md b/legacy/doc/models/fulfillment-pickup-details-curbside-pickup-details.md similarity index 100% rename from doc/models/fulfillment-pickup-details-curbside-pickup-details.md rename to legacy/doc/models/fulfillment-pickup-details-curbside-pickup-details.md diff --git a/doc/models/fulfillment-pickup-details-schedule-type.md b/legacy/doc/models/fulfillment-pickup-details-schedule-type.md similarity index 100% rename from doc/models/fulfillment-pickup-details-schedule-type.md rename to legacy/doc/models/fulfillment-pickup-details-schedule-type.md diff --git a/doc/models/fulfillment-pickup-details.md b/legacy/doc/models/fulfillment-pickup-details.md similarity index 100% rename from doc/models/fulfillment-pickup-details.md rename to legacy/doc/models/fulfillment-pickup-details.md diff --git a/doc/models/fulfillment-recipient.md b/legacy/doc/models/fulfillment-recipient.md similarity index 100% rename from doc/models/fulfillment-recipient.md rename to legacy/doc/models/fulfillment-recipient.md diff --git a/doc/models/fulfillment-shipment-details.md b/legacy/doc/models/fulfillment-shipment-details.md similarity index 100% rename from doc/models/fulfillment-shipment-details.md rename to legacy/doc/models/fulfillment-shipment-details.md diff --git a/doc/models/fulfillment-state.md b/legacy/doc/models/fulfillment-state.md similarity index 100% rename from doc/models/fulfillment-state.md rename to legacy/doc/models/fulfillment-state.md diff --git a/doc/models/fulfillment-type.md b/legacy/doc/models/fulfillment-type.md similarity index 100% rename from doc/models/fulfillment-type.md rename to legacy/doc/models/fulfillment-type.md diff --git a/doc/models/fulfillment.md b/legacy/doc/models/fulfillment.md similarity index 100% rename from doc/models/fulfillment.md rename to legacy/doc/models/fulfillment.md diff --git a/doc/models/get-bank-account-by-v1-id-response.md b/legacy/doc/models/get-bank-account-by-v1-id-response.md similarity index 100% rename from doc/models/get-bank-account-by-v1-id-response.md rename to legacy/doc/models/get-bank-account-by-v1-id-response.md diff --git a/doc/models/get-bank-account-response.md b/legacy/doc/models/get-bank-account-response.md similarity index 100% rename from doc/models/get-bank-account-response.md rename to legacy/doc/models/get-bank-account-response.md diff --git a/doc/models/get-break-type-response.md b/legacy/doc/models/get-break-type-response.md similarity index 100% rename from doc/models/get-break-type-response.md rename to legacy/doc/models/get-break-type-response.md diff --git a/doc/models/get-device-code-response.md b/legacy/doc/models/get-device-code-response.md similarity index 100% rename from doc/models/get-device-code-response.md rename to legacy/doc/models/get-device-code-response.md diff --git a/doc/models/get-device-response.md b/legacy/doc/models/get-device-response.md similarity index 100% rename from doc/models/get-device-response.md rename to legacy/doc/models/get-device-response.md diff --git a/doc/models/get-employee-wage-response.md b/legacy/doc/models/get-employee-wage-response.md similarity index 100% rename from doc/models/get-employee-wage-response.md rename to legacy/doc/models/get-employee-wage-response.md diff --git a/doc/models/get-invoice-response.md b/legacy/doc/models/get-invoice-response.md similarity index 100% rename from doc/models/get-invoice-response.md rename to legacy/doc/models/get-invoice-response.md diff --git a/doc/models/get-payment-refund-response.md b/legacy/doc/models/get-payment-refund-response.md similarity index 100% rename from doc/models/get-payment-refund-response.md rename to legacy/doc/models/get-payment-refund-response.md diff --git a/doc/models/get-payment-response.md b/legacy/doc/models/get-payment-response.md similarity index 100% rename from doc/models/get-payment-response.md rename to legacy/doc/models/get-payment-response.md diff --git a/doc/models/get-payout-response.md b/legacy/doc/models/get-payout-response.md similarity index 100% rename from doc/models/get-payout-response.md rename to legacy/doc/models/get-payout-response.md diff --git a/doc/models/get-shift-response.md b/legacy/doc/models/get-shift-response.md similarity index 100% rename from doc/models/get-shift-response.md rename to legacy/doc/models/get-shift-response.md diff --git a/doc/models/get-team-member-wage-response.md b/legacy/doc/models/get-team-member-wage-response.md similarity index 100% rename from doc/models/get-team-member-wage-response.md rename to legacy/doc/models/get-team-member-wage-response.md diff --git a/doc/models/get-terminal-action-response.md b/legacy/doc/models/get-terminal-action-response.md similarity index 100% rename from doc/models/get-terminal-action-response.md rename to legacy/doc/models/get-terminal-action-response.md diff --git a/doc/models/get-terminal-checkout-response.md b/legacy/doc/models/get-terminal-checkout-response.md similarity index 100% rename from doc/models/get-terminal-checkout-response.md rename to legacy/doc/models/get-terminal-checkout-response.md diff --git a/doc/models/get-terminal-refund-response.md b/legacy/doc/models/get-terminal-refund-response.md similarity index 100% rename from doc/models/get-terminal-refund-response.md rename to legacy/doc/models/get-terminal-refund-response.md diff --git a/doc/models/gift-card-activity-activate.md b/legacy/doc/models/gift-card-activity-activate.md similarity index 100% rename from doc/models/gift-card-activity-activate.md rename to legacy/doc/models/gift-card-activity-activate.md diff --git a/doc/models/gift-card-activity-adjust-decrement-reason.md b/legacy/doc/models/gift-card-activity-adjust-decrement-reason.md similarity index 100% rename from doc/models/gift-card-activity-adjust-decrement-reason.md rename to legacy/doc/models/gift-card-activity-adjust-decrement-reason.md diff --git a/doc/models/gift-card-activity-adjust-decrement.md b/legacy/doc/models/gift-card-activity-adjust-decrement.md similarity index 100% rename from doc/models/gift-card-activity-adjust-decrement.md rename to legacy/doc/models/gift-card-activity-adjust-decrement.md diff --git a/doc/models/gift-card-activity-adjust-increment-reason.md b/legacy/doc/models/gift-card-activity-adjust-increment-reason.md similarity index 100% rename from doc/models/gift-card-activity-adjust-increment-reason.md rename to legacy/doc/models/gift-card-activity-adjust-increment-reason.md diff --git a/doc/models/gift-card-activity-adjust-increment.md b/legacy/doc/models/gift-card-activity-adjust-increment.md similarity index 100% rename from doc/models/gift-card-activity-adjust-increment.md rename to legacy/doc/models/gift-card-activity-adjust-increment.md diff --git a/doc/models/gift-card-activity-block-reason.md b/legacy/doc/models/gift-card-activity-block-reason.md similarity index 100% rename from doc/models/gift-card-activity-block-reason.md rename to legacy/doc/models/gift-card-activity-block-reason.md diff --git a/doc/models/gift-card-activity-block.md b/legacy/doc/models/gift-card-activity-block.md similarity index 100% rename from doc/models/gift-card-activity-block.md rename to legacy/doc/models/gift-card-activity-block.md diff --git a/doc/models/gift-card-activity-clear-balance-reason.md b/legacy/doc/models/gift-card-activity-clear-balance-reason.md similarity index 100% rename from doc/models/gift-card-activity-clear-balance-reason.md rename to legacy/doc/models/gift-card-activity-clear-balance-reason.md diff --git a/doc/models/gift-card-activity-clear-balance.md b/legacy/doc/models/gift-card-activity-clear-balance.md similarity index 100% rename from doc/models/gift-card-activity-clear-balance.md rename to legacy/doc/models/gift-card-activity-clear-balance.md diff --git a/doc/models/gift-card-activity-deactivate-reason.md b/legacy/doc/models/gift-card-activity-deactivate-reason.md similarity index 100% rename from doc/models/gift-card-activity-deactivate-reason.md rename to legacy/doc/models/gift-card-activity-deactivate-reason.md diff --git a/doc/models/gift-card-activity-deactivate.md b/legacy/doc/models/gift-card-activity-deactivate.md similarity index 100% rename from doc/models/gift-card-activity-deactivate.md rename to legacy/doc/models/gift-card-activity-deactivate.md diff --git a/doc/models/gift-card-activity-import-reversal.md b/legacy/doc/models/gift-card-activity-import-reversal.md similarity index 100% rename from doc/models/gift-card-activity-import-reversal.md rename to legacy/doc/models/gift-card-activity-import-reversal.md diff --git a/doc/models/gift-card-activity-import.md b/legacy/doc/models/gift-card-activity-import.md similarity index 100% rename from doc/models/gift-card-activity-import.md rename to legacy/doc/models/gift-card-activity-import.md diff --git a/doc/models/gift-card-activity-load.md b/legacy/doc/models/gift-card-activity-load.md similarity index 100% rename from doc/models/gift-card-activity-load.md rename to legacy/doc/models/gift-card-activity-load.md diff --git a/doc/models/gift-card-activity-redeem-status.md b/legacy/doc/models/gift-card-activity-redeem-status.md similarity index 100% rename from doc/models/gift-card-activity-redeem-status.md rename to legacy/doc/models/gift-card-activity-redeem-status.md diff --git a/doc/models/gift-card-activity-redeem.md b/legacy/doc/models/gift-card-activity-redeem.md similarity index 100% rename from doc/models/gift-card-activity-redeem.md rename to legacy/doc/models/gift-card-activity-redeem.md diff --git a/doc/models/gift-card-activity-refund.md b/legacy/doc/models/gift-card-activity-refund.md similarity index 100% rename from doc/models/gift-card-activity-refund.md rename to legacy/doc/models/gift-card-activity-refund.md diff --git a/doc/models/gift-card-activity-transfer-balance-from.md b/legacy/doc/models/gift-card-activity-transfer-balance-from.md similarity index 100% rename from doc/models/gift-card-activity-transfer-balance-from.md rename to legacy/doc/models/gift-card-activity-transfer-balance-from.md diff --git a/doc/models/gift-card-activity-transfer-balance-to.md b/legacy/doc/models/gift-card-activity-transfer-balance-to.md similarity index 100% rename from doc/models/gift-card-activity-transfer-balance-to.md rename to legacy/doc/models/gift-card-activity-transfer-balance-to.md diff --git a/doc/models/gift-card-activity-type.md b/legacy/doc/models/gift-card-activity-type.md similarity index 100% rename from doc/models/gift-card-activity-type.md rename to legacy/doc/models/gift-card-activity-type.md diff --git a/doc/models/gift-card-activity-unblock-reason.md b/legacy/doc/models/gift-card-activity-unblock-reason.md similarity index 100% rename from doc/models/gift-card-activity-unblock-reason.md rename to legacy/doc/models/gift-card-activity-unblock-reason.md diff --git a/doc/models/gift-card-activity-unblock.md b/legacy/doc/models/gift-card-activity-unblock.md similarity index 100% rename from doc/models/gift-card-activity-unblock.md rename to legacy/doc/models/gift-card-activity-unblock.md diff --git a/doc/models/gift-card-activity-unlinked-activity-refund.md b/legacy/doc/models/gift-card-activity-unlinked-activity-refund.md similarity index 100% rename from doc/models/gift-card-activity-unlinked-activity-refund.md rename to legacy/doc/models/gift-card-activity-unlinked-activity-refund.md diff --git a/doc/models/gift-card-activity.md b/legacy/doc/models/gift-card-activity.md similarity index 100% rename from doc/models/gift-card-activity.md rename to legacy/doc/models/gift-card-activity.md diff --git a/doc/models/gift-card-gan-source.md b/legacy/doc/models/gift-card-gan-source.md similarity index 100% rename from doc/models/gift-card-gan-source.md rename to legacy/doc/models/gift-card-gan-source.md diff --git a/doc/models/gift-card-status.md b/legacy/doc/models/gift-card-status.md similarity index 100% rename from doc/models/gift-card-status.md rename to legacy/doc/models/gift-card-status.md diff --git a/doc/models/gift-card-type.md b/legacy/doc/models/gift-card-type.md similarity index 100% rename from doc/models/gift-card-type.md rename to legacy/doc/models/gift-card-type.md diff --git a/doc/models/gift-card.md b/legacy/doc/models/gift-card.md similarity index 100% rename from doc/models/gift-card.md rename to legacy/doc/models/gift-card.md diff --git a/doc/models/inventory-adjustment-group.md b/legacy/doc/models/inventory-adjustment-group.md similarity index 100% rename from doc/models/inventory-adjustment-group.md rename to legacy/doc/models/inventory-adjustment-group.md diff --git a/doc/models/inventory-adjustment.md b/legacy/doc/models/inventory-adjustment.md similarity index 100% rename from doc/models/inventory-adjustment.md rename to legacy/doc/models/inventory-adjustment.md diff --git a/doc/models/inventory-alert-type.md b/legacy/doc/models/inventory-alert-type.md similarity index 100% rename from doc/models/inventory-alert-type.md rename to legacy/doc/models/inventory-alert-type.md diff --git a/doc/models/inventory-change-type.md b/legacy/doc/models/inventory-change-type.md similarity index 100% rename from doc/models/inventory-change-type.md rename to legacy/doc/models/inventory-change-type.md diff --git a/doc/models/inventory-change.md b/legacy/doc/models/inventory-change.md similarity index 100% rename from doc/models/inventory-change.md rename to legacy/doc/models/inventory-change.md diff --git a/doc/models/inventory-count.md b/legacy/doc/models/inventory-count.md similarity index 100% rename from doc/models/inventory-count.md rename to legacy/doc/models/inventory-count.md diff --git a/doc/models/inventory-physical-count.md b/legacy/doc/models/inventory-physical-count.md similarity index 100% rename from doc/models/inventory-physical-count.md rename to legacy/doc/models/inventory-physical-count.md diff --git a/doc/models/inventory-state.md b/legacy/doc/models/inventory-state.md similarity index 100% rename from doc/models/inventory-state.md rename to legacy/doc/models/inventory-state.md diff --git a/doc/models/inventory-transfer.md b/legacy/doc/models/inventory-transfer.md similarity index 100% rename from doc/models/inventory-transfer.md rename to legacy/doc/models/inventory-transfer.md diff --git a/doc/models/invoice-accepted-payment-methods.md b/legacy/doc/models/invoice-accepted-payment-methods.md similarity index 100% rename from doc/models/invoice-accepted-payment-methods.md rename to legacy/doc/models/invoice-accepted-payment-methods.md diff --git a/doc/models/invoice-attachment.md b/legacy/doc/models/invoice-attachment.md similarity index 100% rename from doc/models/invoice-attachment.md rename to legacy/doc/models/invoice-attachment.md diff --git a/doc/models/invoice-automatic-payment-source.md b/legacy/doc/models/invoice-automatic-payment-source.md similarity index 100% rename from doc/models/invoice-automatic-payment-source.md rename to legacy/doc/models/invoice-automatic-payment-source.md diff --git a/doc/models/invoice-custom-field-placement.md b/legacy/doc/models/invoice-custom-field-placement.md similarity index 100% rename from doc/models/invoice-custom-field-placement.md rename to legacy/doc/models/invoice-custom-field-placement.md diff --git a/doc/models/invoice-custom-field.md b/legacy/doc/models/invoice-custom-field.md similarity index 100% rename from doc/models/invoice-custom-field.md rename to legacy/doc/models/invoice-custom-field.md diff --git a/doc/models/invoice-delivery-method.md b/legacy/doc/models/invoice-delivery-method.md similarity index 100% rename from doc/models/invoice-delivery-method.md rename to legacy/doc/models/invoice-delivery-method.md diff --git a/doc/models/invoice-filter.md b/legacy/doc/models/invoice-filter.md similarity index 100% rename from doc/models/invoice-filter.md rename to legacy/doc/models/invoice-filter.md diff --git a/doc/models/invoice-payment-reminder-status.md b/legacy/doc/models/invoice-payment-reminder-status.md similarity index 100% rename from doc/models/invoice-payment-reminder-status.md rename to legacy/doc/models/invoice-payment-reminder-status.md diff --git a/doc/models/invoice-payment-reminder.md b/legacy/doc/models/invoice-payment-reminder.md similarity index 100% rename from doc/models/invoice-payment-reminder.md rename to legacy/doc/models/invoice-payment-reminder.md diff --git a/doc/models/invoice-payment-request.md b/legacy/doc/models/invoice-payment-request.md similarity index 100% rename from doc/models/invoice-payment-request.md rename to legacy/doc/models/invoice-payment-request.md diff --git a/doc/models/invoice-query.md b/legacy/doc/models/invoice-query.md similarity index 100% rename from doc/models/invoice-query.md rename to legacy/doc/models/invoice-query.md diff --git a/doc/models/invoice-recipient-tax-ids.md b/legacy/doc/models/invoice-recipient-tax-ids.md similarity index 100% rename from doc/models/invoice-recipient-tax-ids.md rename to legacy/doc/models/invoice-recipient-tax-ids.md diff --git a/doc/models/invoice-recipient.md b/legacy/doc/models/invoice-recipient.md similarity index 100% rename from doc/models/invoice-recipient.md rename to legacy/doc/models/invoice-recipient.md diff --git a/doc/models/invoice-request-method.md b/legacy/doc/models/invoice-request-method.md similarity index 100% rename from doc/models/invoice-request-method.md rename to legacy/doc/models/invoice-request-method.md diff --git a/doc/models/invoice-request-type.md b/legacy/doc/models/invoice-request-type.md similarity index 100% rename from doc/models/invoice-request-type.md rename to legacy/doc/models/invoice-request-type.md diff --git a/doc/models/invoice-sort-field.md b/legacy/doc/models/invoice-sort-field.md similarity index 100% rename from doc/models/invoice-sort-field.md rename to legacy/doc/models/invoice-sort-field.md diff --git a/doc/models/invoice-sort.md b/legacy/doc/models/invoice-sort.md similarity index 100% rename from doc/models/invoice-sort.md rename to legacy/doc/models/invoice-sort.md diff --git a/doc/models/invoice-status.md b/legacy/doc/models/invoice-status.md similarity index 100% rename from doc/models/invoice-status.md rename to legacy/doc/models/invoice-status.md diff --git a/doc/models/invoice.md b/legacy/doc/models/invoice.md similarity index 100% rename from doc/models/invoice.md rename to legacy/doc/models/invoice.md diff --git a/doc/models/item-variation-location-overrides.md b/legacy/doc/models/item-variation-location-overrides.md similarity index 100% rename from doc/models/item-variation-location-overrides.md rename to legacy/doc/models/item-variation-location-overrides.md diff --git a/doc/models/job-assignment-pay-type.md b/legacy/doc/models/job-assignment-pay-type.md similarity index 100% rename from doc/models/job-assignment-pay-type.md rename to legacy/doc/models/job-assignment-pay-type.md diff --git a/doc/models/job-assignment.md b/legacy/doc/models/job-assignment.md similarity index 100% rename from doc/models/job-assignment.md rename to legacy/doc/models/job-assignment.md diff --git a/doc/models/job.md b/legacy/doc/models/job.md similarity index 100% rename from doc/models/job.md rename to legacy/doc/models/job.md diff --git a/doc/models/link-customer-to-gift-card-request.md b/legacy/doc/models/link-customer-to-gift-card-request.md similarity index 100% rename from doc/models/link-customer-to-gift-card-request.md rename to legacy/doc/models/link-customer-to-gift-card-request.md diff --git a/doc/models/link-customer-to-gift-card-response.md b/legacy/doc/models/link-customer-to-gift-card-response.md similarity index 100% rename from doc/models/link-customer-to-gift-card-response.md rename to legacy/doc/models/link-customer-to-gift-card-response.md diff --git a/doc/models/list-bank-accounts-request.md b/legacy/doc/models/list-bank-accounts-request.md similarity index 100% rename from doc/models/list-bank-accounts-request.md rename to legacy/doc/models/list-bank-accounts-request.md diff --git a/doc/models/list-bank-accounts-response.md b/legacy/doc/models/list-bank-accounts-response.md similarity index 100% rename from doc/models/list-bank-accounts-response.md rename to legacy/doc/models/list-bank-accounts-response.md diff --git a/doc/models/list-booking-custom-attribute-definitions-request.md b/legacy/doc/models/list-booking-custom-attribute-definitions-request.md similarity index 100% rename from doc/models/list-booking-custom-attribute-definitions-request.md rename to legacy/doc/models/list-booking-custom-attribute-definitions-request.md diff --git a/doc/models/list-booking-custom-attribute-definitions-response.md b/legacy/doc/models/list-booking-custom-attribute-definitions-response.md similarity index 100% rename from doc/models/list-booking-custom-attribute-definitions-response.md rename to legacy/doc/models/list-booking-custom-attribute-definitions-response.md diff --git a/doc/models/list-booking-custom-attributes-request.md b/legacy/doc/models/list-booking-custom-attributes-request.md similarity index 100% rename from doc/models/list-booking-custom-attributes-request.md rename to legacy/doc/models/list-booking-custom-attributes-request.md diff --git a/doc/models/list-booking-custom-attributes-response.md b/legacy/doc/models/list-booking-custom-attributes-response.md similarity index 100% rename from doc/models/list-booking-custom-attributes-response.md rename to legacy/doc/models/list-booking-custom-attributes-response.md diff --git a/doc/models/list-bookings-request.md b/legacy/doc/models/list-bookings-request.md similarity index 100% rename from doc/models/list-bookings-request.md rename to legacy/doc/models/list-bookings-request.md diff --git a/doc/models/list-bookings-response.md b/legacy/doc/models/list-bookings-response.md similarity index 100% rename from doc/models/list-bookings-response.md rename to legacy/doc/models/list-bookings-response.md diff --git a/doc/models/list-break-types-request.md b/legacy/doc/models/list-break-types-request.md similarity index 100% rename from doc/models/list-break-types-request.md rename to legacy/doc/models/list-break-types-request.md diff --git a/doc/models/list-break-types-response.md b/legacy/doc/models/list-break-types-response.md similarity index 100% rename from doc/models/list-break-types-response.md rename to legacy/doc/models/list-break-types-response.md diff --git a/doc/models/list-cards-request.md b/legacy/doc/models/list-cards-request.md similarity index 100% rename from doc/models/list-cards-request.md rename to legacy/doc/models/list-cards-request.md diff --git a/doc/models/list-cards-response.md b/legacy/doc/models/list-cards-response.md similarity index 100% rename from doc/models/list-cards-response.md rename to legacy/doc/models/list-cards-response.md diff --git a/doc/models/list-cash-drawer-shift-events-request.md b/legacy/doc/models/list-cash-drawer-shift-events-request.md similarity index 100% rename from doc/models/list-cash-drawer-shift-events-request.md rename to legacy/doc/models/list-cash-drawer-shift-events-request.md diff --git a/doc/models/list-cash-drawer-shift-events-response.md b/legacy/doc/models/list-cash-drawer-shift-events-response.md similarity index 100% rename from doc/models/list-cash-drawer-shift-events-response.md rename to legacy/doc/models/list-cash-drawer-shift-events-response.md diff --git a/doc/models/list-cash-drawer-shifts-request.md b/legacy/doc/models/list-cash-drawer-shifts-request.md similarity index 100% rename from doc/models/list-cash-drawer-shifts-request.md rename to legacy/doc/models/list-cash-drawer-shifts-request.md diff --git a/doc/models/list-cash-drawer-shifts-response.md b/legacy/doc/models/list-cash-drawer-shifts-response.md similarity index 100% rename from doc/models/list-cash-drawer-shifts-response.md rename to legacy/doc/models/list-cash-drawer-shifts-response.md diff --git a/doc/models/list-catalog-request.md b/legacy/doc/models/list-catalog-request.md similarity index 100% rename from doc/models/list-catalog-request.md rename to legacy/doc/models/list-catalog-request.md diff --git a/doc/models/list-catalog-response.md b/legacy/doc/models/list-catalog-response.md similarity index 100% rename from doc/models/list-catalog-response.md rename to legacy/doc/models/list-catalog-response.md diff --git a/doc/models/list-customer-custom-attribute-definitions-request.md b/legacy/doc/models/list-customer-custom-attribute-definitions-request.md similarity index 100% rename from doc/models/list-customer-custom-attribute-definitions-request.md rename to legacy/doc/models/list-customer-custom-attribute-definitions-request.md diff --git a/doc/models/list-customer-custom-attribute-definitions-response.md b/legacy/doc/models/list-customer-custom-attribute-definitions-response.md similarity index 100% rename from doc/models/list-customer-custom-attribute-definitions-response.md rename to legacy/doc/models/list-customer-custom-attribute-definitions-response.md diff --git a/doc/models/list-customer-custom-attributes-request.md b/legacy/doc/models/list-customer-custom-attributes-request.md similarity index 100% rename from doc/models/list-customer-custom-attributes-request.md rename to legacy/doc/models/list-customer-custom-attributes-request.md diff --git a/doc/models/list-customer-custom-attributes-response.md b/legacy/doc/models/list-customer-custom-attributes-response.md similarity index 100% rename from doc/models/list-customer-custom-attributes-response.md rename to legacy/doc/models/list-customer-custom-attributes-response.md diff --git a/doc/models/list-customer-groups-request.md b/legacy/doc/models/list-customer-groups-request.md similarity index 100% rename from doc/models/list-customer-groups-request.md rename to legacy/doc/models/list-customer-groups-request.md diff --git a/doc/models/list-customer-groups-response.md b/legacy/doc/models/list-customer-groups-response.md similarity index 100% rename from doc/models/list-customer-groups-response.md rename to legacy/doc/models/list-customer-groups-response.md diff --git a/doc/models/list-customer-segments-request.md b/legacy/doc/models/list-customer-segments-request.md similarity index 100% rename from doc/models/list-customer-segments-request.md rename to legacy/doc/models/list-customer-segments-request.md diff --git a/doc/models/list-customer-segments-response.md b/legacy/doc/models/list-customer-segments-response.md similarity index 100% rename from doc/models/list-customer-segments-response.md rename to legacy/doc/models/list-customer-segments-response.md diff --git a/doc/models/list-customers-request.md b/legacy/doc/models/list-customers-request.md similarity index 100% rename from doc/models/list-customers-request.md rename to legacy/doc/models/list-customers-request.md diff --git a/doc/models/list-customers-response.md b/legacy/doc/models/list-customers-response.md similarity index 100% rename from doc/models/list-customers-response.md rename to legacy/doc/models/list-customers-response.md diff --git a/doc/models/list-device-codes-request.md b/legacy/doc/models/list-device-codes-request.md similarity index 100% rename from doc/models/list-device-codes-request.md rename to legacy/doc/models/list-device-codes-request.md diff --git a/doc/models/list-device-codes-response.md b/legacy/doc/models/list-device-codes-response.md similarity index 100% rename from doc/models/list-device-codes-response.md rename to legacy/doc/models/list-device-codes-response.md diff --git a/doc/models/list-devices-request.md b/legacy/doc/models/list-devices-request.md similarity index 100% rename from doc/models/list-devices-request.md rename to legacy/doc/models/list-devices-request.md diff --git a/doc/models/list-devices-response.md b/legacy/doc/models/list-devices-response.md similarity index 100% rename from doc/models/list-devices-response.md rename to legacy/doc/models/list-devices-response.md diff --git a/doc/models/list-dispute-evidence-request.md b/legacy/doc/models/list-dispute-evidence-request.md similarity index 100% rename from doc/models/list-dispute-evidence-request.md rename to legacy/doc/models/list-dispute-evidence-request.md diff --git a/doc/models/list-dispute-evidence-response.md b/legacy/doc/models/list-dispute-evidence-response.md similarity index 100% rename from doc/models/list-dispute-evidence-response.md rename to legacy/doc/models/list-dispute-evidence-response.md diff --git a/doc/models/list-disputes-request.md b/legacy/doc/models/list-disputes-request.md similarity index 100% rename from doc/models/list-disputes-request.md rename to legacy/doc/models/list-disputes-request.md diff --git a/doc/models/list-disputes-response.md b/legacy/doc/models/list-disputes-response.md similarity index 100% rename from doc/models/list-disputes-response.md rename to legacy/doc/models/list-disputes-response.md diff --git a/doc/models/list-employee-wages-request.md b/legacy/doc/models/list-employee-wages-request.md similarity index 100% rename from doc/models/list-employee-wages-request.md rename to legacy/doc/models/list-employee-wages-request.md diff --git a/doc/models/list-employee-wages-response.md b/legacy/doc/models/list-employee-wages-response.md similarity index 100% rename from doc/models/list-employee-wages-response.md rename to legacy/doc/models/list-employee-wages-response.md diff --git a/doc/models/list-employees-request.md b/legacy/doc/models/list-employees-request.md similarity index 100% rename from doc/models/list-employees-request.md rename to legacy/doc/models/list-employees-request.md diff --git a/doc/models/list-employees-response.md b/legacy/doc/models/list-employees-response.md similarity index 100% rename from doc/models/list-employees-response.md rename to legacy/doc/models/list-employees-response.md diff --git a/doc/models/list-event-types-request.md b/legacy/doc/models/list-event-types-request.md similarity index 100% rename from doc/models/list-event-types-request.md rename to legacy/doc/models/list-event-types-request.md diff --git a/doc/models/list-event-types-response.md b/legacy/doc/models/list-event-types-response.md similarity index 100% rename from doc/models/list-event-types-response.md rename to legacy/doc/models/list-event-types-response.md diff --git a/doc/models/list-gift-card-activities-request.md b/legacy/doc/models/list-gift-card-activities-request.md similarity index 100% rename from doc/models/list-gift-card-activities-request.md rename to legacy/doc/models/list-gift-card-activities-request.md diff --git a/doc/models/list-gift-card-activities-response.md b/legacy/doc/models/list-gift-card-activities-response.md similarity index 100% rename from doc/models/list-gift-card-activities-response.md rename to legacy/doc/models/list-gift-card-activities-response.md diff --git a/doc/models/list-gift-cards-request.md b/legacy/doc/models/list-gift-cards-request.md similarity index 100% rename from doc/models/list-gift-cards-request.md rename to legacy/doc/models/list-gift-cards-request.md diff --git a/doc/models/list-gift-cards-response.md b/legacy/doc/models/list-gift-cards-response.md similarity index 100% rename from doc/models/list-gift-cards-response.md rename to legacy/doc/models/list-gift-cards-response.md diff --git a/doc/models/list-invoices-request.md b/legacy/doc/models/list-invoices-request.md similarity index 100% rename from doc/models/list-invoices-request.md rename to legacy/doc/models/list-invoices-request.md diff --git a/doc/models/list-invoices-response.md b/legacy/doc/models/list-invoices-response.md similarity index 100% rename from doc/models/list-invoices-response.md rename to legacy/doc/models/list-invoices-response.md diff --git a/doc/models/list-jobs-request.md b/legacy/doc/models/list-jobs-request.md similarity index 100% rename from doc/models/list-jobs-request.md rename to legacy/doc/models/list-jobs-request.md diff --git a/doc/models/list-jobs-response.md b/legacy/doc/models/list-jobs-response.md similarity index 100% rename from doc/models/list-jobs-response.md rename to legacy/doc/models/list-jobs-response.md diff --git a/doc/models/list-location-booking-profiles-request.md b/legacy/doc/models/list-location-booking-profiles-request.md similarity index 100% rename from doc/models/list-location-booking-profiles-request.md rename to legacy/doc/models/list-location-booking-profiles-request.md diff --git a/doc/models/list-location-booking-profiles-response.md b/legacy/doc/models/list-location-booking-profiles-response.md similarity index 100% rename from doc/models/list-location-booking-profiles-response.md rename to legacy/doc/models/list-location-booking-profiles-response.md diff --git a/doc/models/list-location-custom-attribute-definitions-request.md b/legacy/doc/models/list-location-custom-attribute-definitions-request.md similarity index 100% rename from doc/models/list-location-custom-attribute-definitions-request.md rename to legacy/doc/models/list-location-custom-attribute-definitions-request.md diff --git a/doc/models/list-location-custom-attribute-definitions-response.md b/legacy/doc/models/list-location-custom-attribute-definitions-response.md similarity index 100% rename from doc/models/list-location-custom-attribute-definitions-response.md rename to legacy/doc/models/list-location-custom-attribute-definitions-response.md diff --git a/doc/models/list-location-custom-attributes-request.md b/legacy/doc/models/list-location-custom-attributes-request.md similarity index 100% rename from doc/models/list-location-custom-attributes-request.md rename to legacy/doc/models/list-location-custom-attributes-request.md diff --git a/doc/models/list-location-custom-attributes-response.md b/legacy/doc/models/list-location-custom-attributes-response.md similarity index 100% rename from doc/models/list-location-custom-attributes-response.md rename to legacy/doc/models/list-location-custom-attributes-response.md diff --git a/doc/models/list-locations-response.md b/legacy/doc/models/list-locations-response.md similarity index 100% rename from doc/models/list-locations-response.md rename to legacy/doc/models/list-locations-response.md diff --git a/doc/models/list-loyalty-programs-response.md b/legacy/doc/models/list-loyalty-programs-response.md similarity index 100% rename from doc/models/list-loyalty-programs-response.md rename to legacy/doc/models/list-loyalty-programs-response.md diff --git a/doc/models/list-loyalty-promotions-request.md b/legacy/doc/models/list-loyalty-promotions-request.md similarity index 100% rename from doc/models/list-loyalty-promotions-request.md rename to legacy/doc/models/list-loyalty-promotions-request.md diff --git a/doc/models/list-loyalty-promotions-response.md b/legacy/doc/models/list-loyalty-promotions-response.md similarity index 100% rename from doc/models/list-loyalty-promotions-response.md rename to legacy/doc/models/list-loyalty-promotions-response.md diff --git a/doc/models/list-merchant-custom-attribute-definitions-request.md b/legacy/doc/models/list-merchant-custom-attribute-definitions-request.md similarity index 100% rename from doc/models/list-merchant-custom-attribute-definitions-request.md rename to legacy/doc/models/list-merchant-custom-attribute-definitions-request.md diff --git a/doc/models/list-merchant-custom-attribute-definitions-response.md b/legacy/doc/models/list-merchant-custom-attribute-definitions-response.md similarity index 100% rename from doc/models/list-merchant-custom-attribute-definitions-response.md rename to legacy/doc/models/list-merchant-custom-attribute-definitions-response.md diff --git a/doc/models/list-merchant-custom-attributes-request.md b/legacy/doc/models/list-merchant-custom-attributes-request.md similarity index 100% rename from doc/models/list-merchant-custom-attributes-request.md rename to legacy/doc/models/list-merchant-custom-attributes-request.md diff --git a/doc/models/list-merchant-custom-attributes-response.md b/legacy/doc/models/list-merchant-custom-attributes-response.md similarity index 100% rename from doc/models/list-merchant-custom-attributes-response.md rename to legacy/doc/models/list-merchant-custom-attributes-response.md diff --git a/doc/models/list-merchants-request.md b/legacy/doc/models/list-merchants-request.md similarity index 100% rename from doc/models/list-merchants-request.md rename to legacy/doc/models/list-merchants-request.md diff --git a/doc/models/list-merchants-response.md b/legacy/doc/models/list-merchants-response.md similarity index 100% rename from doc/models/list-merchants-response.md rename to legacy/doc/models/list-merchants-response.md diff --git a/doc/models/list-order-custom-attribute-definitions-request.md b/legacy/doc/models/list-order-custom-attribute-definitions-request.md similarity index 100% rename from doc/models/list-order-custom-attribute-definitions-request.md rename to legacy/doc/models/list-order-custom-attribute-definitions-request.md diff --git a/doc/models/list-order-custom-attribute-definitions-response.md b/legacy/doc/models/list-order-custom-attribute-definitions-response.md similarity index 100% rename from doc/models/list-order-custom-attribute-definitions-response.md rename to legacy/doc/models/list-order-custom-attribute-definitions-response.md diff --git a/doc/models/list-order-custom-attributes-request.md b/legacy/doc/models/list-order-custom-attributes-request.md similarity index 100% rename from doc/models/list-order-custom-attributes-request.md rename to legacy/doc/models/list-order-custom-attributes-request.md diff --git a/doc/models/list-order-custom-attributes-response.md b/legacy/doc/models/list-order-custom-attributes-response.md similarity index 100% rename from doc/models/list-order-custom-attributes-response.md rename to legacy/doc/models/list-order-custom-attributes-response.md diff --git a/doc/models/list-payment-links-request.md b/legacy/doc/models/list-payment-links-request.md similarity index 100% rename from doc/models/list-payment-links-request.md rename to legacy/doc/models/list-payment-links-request.md diff --git a/doc/models/list-payment-links-response.md b/legacy/doc/models/list-payment-links-response.md similarity index 100% rename from doc/models/list-payment-links-response.md rename to legacy/doc/models/list-payment-links-response.md diff --git a/doc/models/list-payment-refunds-request.md b/legacy/doc/models/list-payment-refunds-request.md similarity index 100% rename from doc/models/list-payment-refunds-request.md rename to legacy/doc/models/list-payment-refunds-request.md diff --git a/doc/models/list-payment-refunds-response.md b/legacy/doc/models/list-payment-refunds-response.md similarity index 100% rename from doc/models/list-payment-refunds-response.md rename to legacy/doc/models/list-payment-refunds-response.md diff --git a/doc/models/list-payments-request.md b/legacy/doc/models/list-payments-request.md similarity index 100% rename from doc/models/list-payments-request.md rename to legacy/doc/models/list-payments-request.md diff --git a/doc/models/list-payments-response.md b/legacy/doc/models/list-payments-response.md similarity index 100% rename from doc/models/list-payments-response.md rename to legacy/doc/models/list-payments-response.md diff --git a/doc/models/list-payout-entries-request.md b/legacy/doc/models/list-payout-entries-request.md similarity index 100% rename from doc/models/list-payout-entries-request.md rename to legacy/doc/models/list-payout-entries-request.md diff --git a/doc/models/list-payout-entries-response.md b/legacy/doc/models/list-payout-entries-response.md similarity index 100% rename from doc/models/list-payout-entries-response.md rename to legacy/doc/models/list-payout-entries-response.md diff --git a/doc/models/list-payouts-request.md b/legacy/doc/models/list-payouts-request.md similarity index 100% rename from doc/models/list-payouts-request.md rename to legacy/doc/models/list-payouts-request.md diff --git a/doc/models/list-payouts-response.md b/legacy/doc/models/list-payouts-response.md similarity index 100% rename from doc/models/list-payouts-response.md rename to legacy/doc/models/list-payouts-response.md diff --git a/doc/models/list-refunds-request.md b/legacy/doc/models/list-refunds-request.md similarity index 100% rename from doc/models/list-refunds-request.md rename to legacy/doc/models/list-refunds-request.md diff --git a/doc/models/list-refunds-response.md b/legacy/doc/models/list-refunds-response.md similarity index 100% rename from doc/models/list-refunds-response.md rename to legacy/doc/models/list-refunds-response.md diff --git a/doc/models/list-sites-response.md b/legacy/doc/models/list-sites-response.md similarity index 100% rename from doc/models/list-sites-response.md rename to legacy/doc/models/list-sites-response.md diff --git a/doc/models/list-subscription-events-request.md b/legacy/doc/models/list-subscription-events-request.md similarity index 100% rename from doc/models/list-subscription-events-request.md rename to legacy/doc/models/list-subscription-events-request.md diff --git a/doc/models/list-subscription-events-response.md b/legacy/doc/models/list-subscription-events-response.md similarity index 100% rename from doc/models/list-subscription-events-response.md rename to legacy/doc/models/list-subscription-events-response.md diff --git a/doc/models/list-team-member-booking-profiles-request.md b/legacy/doc/models/list-team-member-booking-profiles-request.md similarity index 100% rename from doc/models/list-team-member-booking-profiles-request.md rename to legacy/doc/models/list-team-member-booking-profiles-request.md diff --git a/doc/models/list-team-member-booking-profiles-response.md b/legacy/doc/models/list-team-member-booking-profiles-response.md similarity index 100% rename from doc/models/list-team-member-booking-profiles-response.md rename to legacy/doc/models/list-team-member-booking-profiles-response.md diff --git a/doc/models/list-team-member-wages-request.md b/legacy/doc/models/list-team-member-wages-request.md similarity index 100% rename from doc/models/list-team-member-wages-request.md rename to legacy/doc/models/list-team-member-wages-request.md diff --git a/doc/models/list-team-member-wages-response.md b/legacy/doc/models/list-team-member-wages-response.md similarity index 100% rename from doc/models/list-team-member-wages-response.md rename to legacy/doc/models/list-team-member-wages-response.md diff --git a/doc/models/list-transactions-request.md b/legacy/doc/models/list-transactions-request.md similarity index 100% rename from doc/models/list-transactions-request.md rename to legacy/doc/models/list-transactions-request.md diff --git a/doc/models/list-transactions-response.md b/legacy/doc/models/list-transactions-response.md similarity index 100% rename from doc/models/list-transactions-response.md rename to legacy/doc/models/list-transactions-response.md diff --git a/doc/models/list-webhook-event-types-request.md b/legacy/doc/models/list-webhook-event-types-request.md similarity index 100% rename from doc/models/list-webhook-event-types-request.md rename to legacy/doc/models/list-webhook-event-types-request.md diff --git a/doc/models/list-webhook-event-types-response.md b/legacy/doc/models/list-webhook-event-types-response.md similarity index 100% rename from doc/models/list-webhook-event-types-response.md rename to legacy/doc/models/list-webhook-event-types-response.md diff --git a/doc/models/list-webhook-subscriptions-request.md b/legacy/doc/models/list-webhook-subscriptions-request.md similarity index 100% rename from doc/models/list-webhook-subscriptions-request.md rename to legacy/doc/models/list-webhook-subscriptions-request.md diff --git a/doc/models/list-webhook-subscriptions-response.md b/legacy/doc/models/list-webhook-subscriptions-response.md similarity index 100% rename from doc/models/list-webhook-subscriptions-response.md rename to legacy/doc/models/list-webhook-subscriptions-response.md diff --git a/doc/models/list-workweek-configs-request.md b/legacy/doc/models/list-workweek-configs-request.md similarity index 100% rename from doc/models/list-workweek-configs-request.md rename to legacy/doc/models/list-workweek-configs-request.md diff --git a/doc/models/list-workweek-configs-response.md b/legacy/doc/models/list-workweek-configs-response.md similarity index 100% rename from doc/models/list-workweek-configs-response.md rename to legacy/doc/models/list-workweek-configs-response.md diff --git a/doc/models/location-booking-profile.md b/legacy/doc/models/location-booking-profile.md similarity index 100% rename from doc/models/location-booking-profile.md rename to legacy/doc/models/location-booking-profile.md diff --git a/doc/models/location-capability.md b/legacy/doc/models/location-capability.md similarity index 100% rename from doc/models/location-capability.md rename to legacy/doc/models/location-capability.md diff --git a/doc/models/location-status.md b/legacy/doc/models/location-status.md similarity index 100% rename from doc/models/location-status.md rename to legacy/doc/models/location-status.md diff --git a/doc/models/location-type.md b/legacy/doc/models/location-type.md similarity index 100% rename from doc/models/location-type.md rename to legacy/doc/models/location-type.md diff --git a/doc/models/location.md b/legacy/doc/models/location.md similarity index 100% rename from doc/models/location.md rename to legacy/doc/models/location.md diff --git a/doc/models/loyalty-account-expiring-point-deadline.md b/legacy/doc/models/loyalty-account-expiring-point-deadline.md similarity index 100% rename from doc/models/loyalty-account-expiring-point-deadline.md rename to legacy/doc/models/loyalty-account-expiring-point-deadline.md diff --git a/doc/models/loyalty-account-mapping-type.md b/legacy/doc/models/loyalty-account-mapping-type.md similarity index 100% rename from doc/models/loyalty-account-mapping-type.md rename to legacy/doc/models/loyalty-account-mapping-type.md diff --git a/doc/models/loyalty-account-mapping.md b/legacy/doc/models/loyalty-account-mapping.md similarity index 100% rename from doc/models/loyalty-account-mapping.md rename to legacy/doc/models/loyalty-account-mapping.md diff --git a/doc/models/loyalty-account.md b/legacy/doc/models/loyalty-account.md similarity index 100% rename from doc/models/loyalty-account.md rename to legacy/doc/models/loyalty-account.md diff --git a/doc/models/loyalty-event-accumulate-points.md b/legacy/doc/models/loyalty-event-accumulate-points.md similarity index 100% rename from doc/models/loyalty-event-accumulate-points.md rename to legacy/doc/models/loyalty-event-accumulate-points.md diff --git a/doc/models/loyalty-event-accumulate-promotion-points.md b/legacy/doc/models/loyalty-event-accumulate-promotion-points.md similarity index 100% rename from doc/models/loyalty-event-accumulate-promotion-points.md rename to legacy/doc/models/loyalty-event-accumulate-promotion-points.md diff --git a/doc/models/loyalty-event-adjust-points.md b/legacy/doc/models/loyalty-event-adjust-points.md similarity index 100% rename from doc/models/loyalty-event-adjust-points.md rename to legacy/doc/models/loyalty-event-adjust-points.md diff --git a/doc/models/loyalty-event-create-reward.md b/legacy/doc/models/loyalty-event-create-reward.md similarity index 100% rename from doc/models/loyalty-event-create-reward.md rename to legacy/doc/models/loyalty-event-create-reward.md diff --git a/doc/models/loyalty-event-date-time-filter.md b/legacy/doc/models/loyalty-event-date-time-filter.md similarity index 100% rename from doc/models/loyalty-event-date-time-filter.md rename to legacy/doc/models/loyalty-event-date-time-filter.md diff --git a/doc/models/loyalty-event-delete-reward.md b/legacy/doc/models/loyalty-event-delete-reward.md similarity index 100% rename from doc/models/loyalty-event-delete-reward.md rename to legacy/doc/models/loyalty-event-delete-reward.md diff --git a/doc/models/loyalty-event-expire-points.md b/legacy/doc/models/loyalty-event-expire-points.md similarity index 100% rename from doc/models/loyalty-event-expire-points.md rename to legacy/doc/models/loyalty-event-expire-points.md diff --git a/doc/models/loyalty-event-filter.md b/legacy/doc/models/loyalty-event-filter.md similarity index 100% rename from doc/models/loyalty-event-filter.md rename to legacy/doc/models/loyalty-event-filter.md diff --git a/doc/models/loyalty-event-location-filter.md b/legacy/doc/models/loyalty-event-location-filter.md similarity index 100% rename from doc/models/loyalty-event-location-filter.md rename to legacy/doc/models/loyalty-event-location-filter.md diff --git a/doc/models/loyalty-event-loyalty-account-filter.md b/legacy/doc/models/loyalty-event-loyalty-account-filter.md similarity index 100% rename from doc/models/loyalty-event-loyalty-account-filter.md rename to legacy/doc/models/loyalty-event-loyalty-account-filter.md diff --git a/doc/models/loyalty-event-order-filter.md b/legacy/doc/models/loyalty-event-order-filter.md similarity index 100% rename from doc/models/loyalty-event-order-filter.md rename to legacy/doc/models/loyalty-event-order-filter.md diff --git a/doc/models/loyalty-event-other.md b/legacy/doc/models/loyalty-event-other.md similarity index 100% rename from doc/models/loyalty-event-other.md rename to legacy/doc/models/loyalty-event-other.md diff --git a/doc/models/loyalty-event-query.md b/legacy/doc/models/loyalty-event-query.md similarity index 100% rename from doc/models/loyalty-event-query.md rename to legacy/doc/models/loyalty-event-query.md diff --git a/doc/models/loyalty-event-redeem-reward.md b/legacy/doc/models/loyalty-event-redeem-reward.md similarity index 100% rename from doc/models/loyalty-event-redeem-reward.md rename to legacy/doc/models/loyalty-event-redeem-reward.md diff --git a/doc/models/loyalty-event-source.md b/legacy/doc/models/loyalty-event-source.md similarity index 100% rename from doc/models/loyalty-event-source.md rename to legacy/doc/models/loyalty-event-source.md diff --git a/doc/models/loyalty-event-type-filter.md b/legacy/doc/models/loyalty-event-type-filter.md similarity index 100% rename from doc/models/loyalty-event-type-filter.md rename to legacy/doc/models/loyalty-event-type-filter.md diff --git a/doc/models/loyalty-event-type.md b/legacy/doc/models/loyalty-event-type.md similarity index 100% rename from doc/models/loyalty-event-type.md rename to legacy/doc/models/loyalty-event-type.md diff --git a/doc/models/loyalty-event.md b/legacy/doc/models/loyalty-event.md similarity index 100% rename from doc/models/loyalty-event.md rename to legacy/doc/models/loyalty-event.md diff --git a/doc/models/loyalty-program-accrual-rule-category-data.md b/legacy/doc/models/loyalty-program-accrual-rule-category-data.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule-category-data.md rename to legacy/doc/models/loyalty-program-accrual-rule-category-data.md diff --git a/doc/models/loyalty-program-accrual-rule-item-variation-data.md b/legacy/doc/models/loyalty-program-accrual-rule-item-variation-data.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule-item-variation-data.md rename to legacy/doc/models/loyalty-program-accrual-rule-item-variation-data.md diff --git a/doc/models/loyalty-program-accrual-rule-spend-data.md b/legacy/doc/models/loyalty-program-accrual-rule-spend-data.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule-spend-data.md rename to legacy/doc/models/loyalty-program-accrual-rule-spend-data.md diff --git a/doc/models/loyalty-program-accrual-rule-tax-mode.md b/legacy/doc/models/loyalty-program-accrual-rule-tax-mode.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule-tax-mode.md rename to legacy/doc/models/loyalty-program-accrual-rule-tax-mode.md diff --git a/doc/models/loyalty-program-accrual-rule-type.md b/legacy/doc/models/loyalty-program-accrual-rule-type.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule-type.md rename to legacy/doc/models/loyalty-program-accrual-rule-type.md diff --git a/doc/models/loyalty-program-accrual-rule-visit-data.md b/legacy/doc/models/loyalty-program-accrual-rule-visit-data.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule-visit-data.md rename to legacy/doc/models/loyalty-program-accrual-rule-visit-data.md diff --git a/doc/models/loyalty-program-accrual-rule.md b/legacy/doc/models/loyalty-program-accrual-rule.md similarity index 100% rename from doc/models/loyalty-program-accrual-rule.md rename to legacy/doc/models/loyalty-program-accrual-rule.md diff --git a/doc/models/loyalty-program-expiration-policy.md b/legacy/doc/models/loyalty-program-expiration-policy.md similarity index 100% rename from doc/models/loyalty-program-expiration-policy.md rename to legacy/doc/models/loyalty-program-expiration-policy.md diff --git a/doc/models/loyalty-program-reward-definition-scope.md b/legacy/doc/models/loyalty-program-reward-definition-scope.md similarity index 100% rename from doc/models/loyalty-program-reward-definition-scope.md rename to legacy/doc/models/loyalty-program-reward-definition-scope.md diff --git a/doc/models/loyalty-program-reward-definition-type.md b/legacy/doc/models/loyalty-program-reward-definition-type.md similarity index 100% rename from doc/models/loyalty-program-reward-definition-type.md rename to legacy/doc/models/loyalty-program-reward-definition-type.md diff --git a/doc/models/loyalty-program-reward-definition.md b/legacy/doc/models/loyalty-program-reward-definition.md similarity index 100% rename from doc/models/loyalty-program-reward-definition.md rename to legacy/doc/models/loyalty-program-reward-definition.md diff --git a/doc/models/loyalty-program-reward-tier.md b/legacy/doc/models/loyalty-program-reward-tier.md similarity index 100% rename from doc/models/loyalty-program-reward-tier.md rename to legacy/doc/models/loyalty-program-reward-tier.md diff --git a/doc/models/loyalty-program-status.md b/legacy/doc/models/loyalty-program-status.md similarity index 100% rename from doc/models/loyalty-program-status.md rename to legacy/doc/models/loyalty-program-status.md diff --git a/doc/models/loyalty-program-terminology.md b/legacy/doc/models/loyalty-program-terminology.md similarity index 100% rename from doc/models/loyalty-program-terminology.md rename to legacy/doc/models/loyalty-program-terminology.md diff --git a/doc/models/loyalty-program.md b/legacy/doc/models/loyalty-program.md similarity index 100% rename from doc/models/loyalty-program.md rename to legacy/doc/models/loyalty-program.md diff --git a/doc/models/loyalty-promotion-available-time-data.md b/legacy/doc/models/loyalty-promotion-available-time-data.md similarity index 100% rename from doc/models/loyalty-promotion-available-time-data.md rename to legacy/doc/models/loyalty-promotion-available-time-data.md diff --git a/doc/models/loyalty-promotion-incentive-points-addition-data.md b/legacy/doc/models/loyalty-promotion-incentive-points-addition-data.md similarity index 100% rename from doc/models/loyalty-promotion-incentive-points-addition-data.md rename to legacy/doc/models/loyalty-promotion-incentive-points-addition-data.md diff --git a/doc/models/loyalty-promotion-incentive-points-multiplier-data.md b/legacy/doc/models/loyalty-promotion-incentive-points-multiplier-data.md similarity index 100% rename from doc/models/loyalty-promotion-incentive-points-multiplier-data.md rename to legacy/doc/models/loyalty-promotion-incentive-points-multiplier-data.md diff --git a/doc/models/loyalty-promotion-incentive-type.md b/legacy/doc/models/loyalty-promotion-incentive-type.md similarity index 100% rename from doc/models/loyalty-promotion-incentive-type.md rename to legacy/doc/models/loyalty-promotion-incentive-type.md diff --git a/doc/models/loyalty-promotion-incentive.md b/legacy/doc/models/loyalty-promotion-incentive.md similarity index 100% rename from doc/models/loyalty-promotion-incentive.md rename to legacy/doc/models/loyalty-promotion-incentive.md diff --git a/doc/models/loyalty-promotion-status.md b/legacy/doc/models/loyalty-promotion-status.md similarity index 100% rename from doc/models/loyalty-promotion-status.md rename to legacy/doc/models/loyalty-promotion-status.md diff --git a/doc/models/loyalty-promotion-trigger-limit-interval.md b/legacy/doc/models/loyalty-promotion-trigger-limit-interval.md similarity index 100% rename from doc/models/loyalty-promotion-trigger-limit-interval.md rename to legacy/doc/models/loyalty-promotion-trigger-limit-interval.md diff --git a/doc/models/loyalty-promotion-trigger-limit.md b/legacy/doc/models/loyalty-promotion-trigger-limit.md similarity index 100% rename from doc/models/loyalty-promotion-trigger-limit.md rename to legacy/doc/models/loyalty-promotion-trigger-limit.md diff --git a/doc/models/loyalty-promotion.md b/legacy/doc/models/loyalty-promotion.md similarity index 100% rename from doc/models/loyalty-promotion.md rename to legacy/doc/models/loyalty-promotion.md diff --git a/doc/models/loyalty-reward-status.md b/legacy/doc/models/loyalty-reward-status.md similarity index 100% rename from doc/models/loyalty-reward-status.md rename to legacy/doc/models/loyalty-reward-status.md diff --git a/doc/models/loyalty-reward.md b/legacy/doc/models/loyalty-reward.md similarity index 100% rename from doc/models/loyalty-reward.md rename to legacy/doc/models/loyalty-reward.md diff --git a/doc/models/measurement-unit-area.md b/legacy/doc/models/measurement-unit-area.md similarity index 100% rename from doc/models/measurement-unit-area.md rename to legacy/doc/models/measurement-unit-area.md diff --git a/doc/models/measurement-unit-custom.md b/legacy/doc/models/measurement-unit-custom.md similarity index 100% rename from doc/models/measurement-unit-custom.md rename to legacy/doc/models/measurement-unit-custom.md diff --git a/doc/models/measurement-unit-generic.md b/legacy/doc/models/measurement-unit-generic.md similarity index 100% rename from doc/models/measurement-unit-generic.md rename to legacy/doc/models/measurement-unit-generic.md diff --git a/doc/models/measurement-unit-length.md b/legacy/doc/models/measurement-unit-length.md similarity index 100% rename from doc/models/measurement-unit-length.md rename to legacy/doc/models/measurement-unit-length.md diff --git a/doc/models/measurement-unit-time.md b/legacy/doc/models/measurement-unit-time.md similarity index 100% rename from doc/models/measurement-unit-time.md rename to legacy/doc/models/measurement-unit-time.md diff --git a/doc/models/measurement-unit-unit-type.md b/legacy/doc/models/measurement-unit-unit-type.md similarity index 100% rename from doc/models/measurement-unit-unit-type.md rename to legacy/doc/models/measurement-unit-unit-type.md diff --git a/doc/models/measurement-unit-volume.md b/legacy/doc/models/measurement-unit-volume.md similarity index 100% rename from doc/models/measurement-unit-volume.md rename to legacy/doc/models/measurement-unit-volume.md diff --git a/doc/models/measurement-unit-weight.md b/legacy/doc/models/measurement-unit-weight.md similarity index 100% rename from doc/models/measurement-unit-weight.md rename to legacy/doc/models/measurement-unit-weight.md diff --git a/doc/models/measurement-unit.md b/legacy/doc/models/measurement-unit.md similarity index 100% rename from doc/models/measurement-unit.md rename to legacy/doc/models/measurement-unit.md diff --git a/doc/models/merchant-status.md b/legacy/doc/models/merchant-status.md similarity index 100% rename from doc/models/merchant-status.md rename to legacy/doc/models/merchant-status.md diff --git a/doc/models/merchant.md b/legacy/doc/models/merchant.md similarity index 100% rename from doc/models/merchant.md rename to legacy/doc/models/merchant.md diff --git a/doc/models/modifier-location-overrides.md b/legacy/doc/models/modifier-location-overrides.md similarity index 100% rename from doc/models/modifier-location-overrides.md rename to legacy/doc/models/modifier-location-overrides.md diff --git a/doc/models/money.md b/legacy/doc/models/money.md similarity index 100% rename from doc/models/money.md rename to legacy/doc/models/money.md diff --git a/doc/models/obtain-token-request.md b/legacy/doc/models/obtain-token-request.md similarity index 100% rename from doc/models/obtain-token-request.md rename to legacy/doc/models/obtain-token-request.md diff --git a/doc/models/obtain-token-response.md b/legacy/doc/models/obtain-token-response.md similarity index 100% rename from doc/models/obtain-token-response.md rename to legacy/doc/models/obtain-token-response.md diff --git a/doc/models/offline-payment-details.md b/legacy/doc/models/offline-payment-details.md similarity index 100% rename from doc/models/offline-payment-details.md rename to legacy/doc/models/offline-payment-details.md diff --git a/doc/models/order-created-object.md b/legacy/doc/models/order-created-object.md similarity index 100% rename from doc/models/order-created-object.md rename to legacy/doc/models/order-created-object.md diff --git a/doc/models/order-created.md b/legacy/doc/models/order-created.md similarity index 100% rename from doc/models/order-created.md rename to legacy/doc/models/order-created.md diff --git a/doc/models/order-entry.md b/legacy/doc/models/order-entry.md similarity index 100% rename from doc/models/order-entry.md rename to legacy/doc/models/order-entry.md diff --git a/doc/models/order-fulfillment-delivery-details-schedule-type.md b/legacy/doc/models/order-fulfillment-delivery-details-schedule-type.md similarity index 100% rename from doc/models/order-fulfillment-delivery-details-schedule-type.md rename to legacy/doc/models/order-fulfillment-delivery-details-schedule-type.md diff --git a/doc/models/order-fulfillment-delivery-details.md b/legacy/doc/models/order-fulfillment-delivery-details.md similarity index 100% rename from doc/models/order-fulfillment-delivery-details.md rename to legacy/doc/models/order-fulfillment-delivery-details.md diff --git a/doc/models/order-fulfillment-fulfillment-entry.md b/legacy/doc/models/order-fulfillment-fulfillment-entry.md similarity index 100% rename from doc/models/order-fulfillment-fulfillment-entry.md rename to legacy/doc/models/order-fulfillment-fulfillment-entry.md diff --git a/doc/models/order-fulfillment-fulfillment-line-item-application.md b/legacy/doc/models/order-fulfillment-fulfillment-line-item-application.md similarity index 100% rename from doc/models/order-fulfillment-fulfillment-line-item-application.md rename to legacy/doc/models/order-fulfillment-fulfillment-line-item-application.md diff --git a/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md b/legacy/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md similarity index 100% rename from doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md rename to legacy/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md diff --git a/doc/models/order-fulfillment-pickup-details-schedule-type.md b/legacy/doc/models/order-fulfillment-pickup-details-schedule-type.md similarity index 100% rename from doc/models/order-fulfillment-pickup-details-schedule-type.md rename to legacy/doc/models/order-fulfillment-pickup-details-schedule-type.md diff --git a/doc/models/order-fulfillment-pickup-details.md b/legacy/doc/models/order-fulfillment-pickup-details.md similarity index 100% rename from doc/models/order-fulfillment-pickup-details.md rename to legacy/doc/models/order-fulfillment-pickup-details.md diff --git a/doc/models/order-fulfillment-recipient.md b/legacy/doc/models/order-fulfillment-recipient.md similarity index 100% rename from doc/models/order-fulfillment-recipient.md rename to legacy/doc/models/order-fulfillment-recipient.md diff --git a/doc/models/order-fulfillment-shipment-details.md b/legacy/doc/models/order-fulfillment-shipment-details.md similarity index 100% rename from doc/models/order-fulfillment-shipment-details.md rename to legacy/doc/models/order-fulfillment-shipment-details.md diff --git a/doc/models/order-fulfillment-state.md b/legacy/doc/models/order-fulfillment-state.md similarity index 100% rename from doc/models/order-fulfillment-state.md rename to legacy/doc/models/order-fulfillment-state.md diff --git a/doc/models/order-fulfillment-type.md b/legacy/doc/models/order-fulfillment-type.md similarity index 100% rename from doc/models/order-fulfillment-type.md rename to legacy/doc/models/order-fulfillment-type.md diff --git a/doc/models/order-fulfillment-updated-object.md b/legacy/doc/models/order-fulfillment-updated-object.md similarity index 100% rename from doc/models/order-fulfillment-updated-object.md rename to legacy/doc/models/order-fulfillment-updated-object.md diff --git a/doc/models/order-fulfillment-updated-update.md b/legacy/doc/models/order-fulfillment-updated-update.md similarity index 100% rename from doc/models/order-fulfillment-updated-update.md rename to legacy/doc/models/order-fulfillment-updated-update.md diff --git a/doc/models/order-fulfillment-updated.md b/legacy/doc/models/order-fulfillment-updated.md similarity index 100% rename from doc/models/order-fulfillment-updated.md rename to legacy/doc/models/order-fulfillment-updated.md diff --git a/doc/models/order-fulfillment.md b/legacy/doc/models/order-fulfillment.md similarity index 100% rename from doc/models/order-fulfillment.md rename to legacy/doc/models/order-fulfillment.md diff --git a/doc/models/order-line-item-applied-discount.md b/legacy/doc/models/order-line-item-applied-discount.md similarity index 100% rename from doc/models/order-line-item-applied-discount.md rename to legacy/doc/models/order-line-item-applied-discount.md diff --git a/doc/models/order-line-item-applied-service-charge.md b/legacy/doc/models/order-line-item-applied-service-charge.md similarity index 100% rename from doc/models/order-line-item-applied-service-charge.md rename to legacy/doc/models/order-line-item-applied-service-charge.md diff --git a/doc/models/order-line-item-applied-tax.md b/legacy/doc/models/order-line-item-applied-tax.md similarity index 100% rename from doc/models/order-line-item-applied-tax.md rename to legacy/doc/models/order-line-item-applied-tax.md diff --git a/doc/models/order-line-item-discount-scope.md b/legacy/doc/models/order-line-item-discount-scope.md similarity index 100% rename from doc/models/order-line-item-discount-scope.md rename to legacy/doc/models/order-line-item-discount-scope.md diff --git a/doc/models/order-line-item-discount-type.md b/legacy/doc/models/order-line-item-discount-type.md similarity index 100% rename from doc/models/order-line-item-discount-type.md rename to legacy/doc/models/order-line-item-discount-type.md diff --git a/doc/models/order-line-item-discount.md b/legacy/doc/models/order-line-item-discount.md similarity index 100% rename from doc/models/order-line-item-discount.md rename to legacy/doc/models/order-line-item-discount.md diff --git a/doc/models/order-line-item-item-type.md b/legacy/doc/models/order-line-item-item-type.md similarity index 100% rename from doc/models/order-line-item-item-type.md rename to legacy/doc/models/order-line-item-item-type.md diff --git a/doc/models/order-line-item-modifier.md b/legacy/doc/models/order-line-item-modifier.md similarity index 100% rename from doc/models/order-line-item-modifier.md rename to legacy/doc/models/order-line-item-modifier.md diff --git a/doc/models/order-line-item-pricing-blocklists-blocked-discount.md b/legacy/doc/models/order-line-item-pricing-blocklists-blocked-discount.md similarity index 100% rename from doc/models/order-line-item-pricing-blocklists-blocked-discount.md rename to legacy/doc/models/order-line-item-pricing-blocklists-blocked-discount.md diff --git a/doc/models/order-line-item-pricing-blocklists-blocked-tax.md b/legacy/doc/models/order-line-item-pricing-blocklists-blocked-tax.md similarity index 100% rename from doc/models/order-line-item-pricing-blocklists-blocked-tax.md rename to legacy/doc/models/order-line-item-pricing-blocklists-blocked-tax.md diff --git a/doc/models/order-line-item-pricing-blocklists.md b/legacy/doc/models/order-line-item-pricing-blocklists.md similarity index 100% rename from doc/models/order-line-item-pricing-blocklists.md rename to legacy/doc/models/order-line-item-pricing-blocklists.md diff --git a/doc/models/order-line-item-tax-scope.md b/legacy/doc/models/order-line-item-tax-scope.md similarity index 100% rename from doc/models/order-line-item-tax-scope.md rename to legacy/doc/models/order-line-item-tax-scope.md diff --git a/doc/models/order-line-item-tax-type.md b/legacy/doc/models/order-line-item-tax-type.md similarity index 100% rename from doc/models/order-line-item-tax-type.md rename to legacy/doc/models/order-line-item-tax-type.md diff --git a/doc/models/order-line-item-tax.md b/legacy/doc/models/order-line-item-tax.md similarity index 100% rename from doc/models/order-line-item-tax.md rename to legacy/doc/models/order-line-item-tax.md diff --git a/doc/models/order-line-item.md b/legacy/doc/models/order-line-item.md similarity index 100% rename from doc/models/order-line-item.md rename to legacy/doc/models/order-line-item.md diff --git a/doc/models/order-money-amounts.md b/legacy/doc/models/order-money-amounts.md similarity index 100% rename from doc/models/order-money-amounts.md rename to legacy/doc/models/order-money-amounts.md diff --git a/doc/models/order-pricing-options.md b/legacy/doc/models/order-pricing-options.md similarity index 100% rename from doc/models/order-pricing-options.md rename to legacy/doc/models/order-pricing-options.md diff --git a/doc/models/order-quantity-unit.md b/legacy/doc/models/order-quantity-unit.md similarity index 100% rename from doc/models/order-quantity-unit.md rename to legacy/doc/models/order-quantity-unit.md diff --git a/doc/models/order-return-discount.md b/legacy/doc/models/order-return-discount.md similarity index 100% rename from doc/models/order-return-discount.md rename to legacy/doc/models/order-return-discount.md diff --git a/doc/models/order-return-line-item-modifier.md b/legacy/doc/models/order-return-line-item-modifier.md similarity index 100% rename from doc/models/order-return-line-item-modifier.md rename to legacy/doc/models/order-return-line-item-modifier.md diff --git a/doc/models/order-return-line-item.md b/legacy/doc/models/order-return-line-item.md similarity index 100% rename from doc/models/order-return-line-item.md rename to legacy/doc/models/order-return-line-item.md diff --git a/doc/models/order-return-service-charge.md b/legacy/doc/models/order-return-service-charge.md similarity index 100% rename from doc/models/order-return-service-charge.md rename to legacy/doc/models/order-return-service-charge.md diff --git a/doc/models/order-return-tax.md b/legacy/doc/models/order-return-tax.md similarity index 100% rename from doc/models/order-return-tax.md rename to legacy/doc/models/order-return-tax.md diff --git a/doc/models/order-return-tip.md b/legacy/doc/models/order-return-tip.md similarity index 100% rename from doc/models/order-return-tip.md rename to legacy/doc/models/order-return-tip.md diff --git a/doc/models/order-return.md b/legacy/doc/models/order-return.md similarity index 100% rename from doc/models/order-return.md rename to legacy/doc/models/order-return.md diff --git a/doc/models/order-reward.md b/legacy/doc/models/order-reward.md similarity index 100% rename from doc/models/order-reward.md rename to legacy/doc/models/order-reward.md diff --git a/doc/models/order-rounding-adjustment.md b/legacy/doc/models/order-rounding-adjustment.md similarity index 100% rename from doc/models/order-rounding-adjustment.md rename to legacy/doc/models/order-rounding-adjustment.md diff --git a/doc/models/order-service-charge-calculation-phase.md b/legacy/doc/models/order-service-charge-calculation-phase.md similarity index 100% rename from doc/models/order-service-charge-calculation-phase.md rename to legacy/doc/models/order-service-charge-calculation-phase.md diff --git a/doc/models/order-service-charge-scope.md b/legacy/doc/models/order-service-charge-scope.md similarity index 100% rename from doc/models/order-service-charge-scope.md rename to legacy/doc/models/order-service-charge-scope.md diff --git a/doc/models/order-service-charge-treatment-type.md b/legacy/doc/models/order-service-charge-treatment-type.md similarity index 100% rename from doc/models/order-service-charge-treatment-type.md rename to legacy/doc/models/order-service-charge-treatment-type.md diff --git a/doc/models/order-service-charge-type.md b/legacy/doc/models/order-service-charge-type.md similarity index 100% rename from doc/models/order-service-charge-type.md rename to legacy/doc/models/order-service-charge-type.md diff --git a/doc/models/order-service-charge.md b/legacy/doc/models/order-service-charge.md similarity index 100% rename from doc/models/order-service-charge.md rename to legacy/doc/models/order-service-charge.md diff --git a/doc/models/order-source.md b/legacy/doc/models/order-source.md similarity index 100% rename from doc/models/order-source.md rename to legacy/doc/models/order-source.md diff --git a/doc/models/order-state.md b/legacy/doc/models/order-state.md similarity index 100% rename from doc/models/order-state.md rename to legacy/doc/models/order-state.md diff --git a/doc/models/order-updated-object.md b/legacy/doc/models/order-updated-object.md similarity index 100% rename from doc/models/order-updated-object.md rename to legacy/doc/models/order-updated-object.md diff --git a/doc/models/order-updated.md b/legacy/doc/models/order-updated.md similarity index 100% rename from doc/models/order-updated.md rename to legacy/doc/models/order-updated.md diff --git a/doc/models/order.md b/legacy/doc/models/order.md similarity index 100% rename from doc/models/order.md rename to legacy/doc/models/order.md diff --git a/doc/models/pagination-cursor.md b/legacy/doc/models/pagination-cursor.md similarity index 100% rename from doc/models/pagination-cursor.md rename to legacy/doc/models/pagination-cursor.md diff --git a/doc/models/pause-subscription-request.md b/legacy/doc/models/pause-subscription-request.md similarity index 100% rename from doc/models/pause-subscription-request.md rename to legacy/doc/models/pause-subscription-request.md diff --git a/doc/models/pause-subscription-response.md b/legacy/doc/models/pause-subscription-response.md similarity index 100% rename from doc/models/pause-subscription-response.md rename to legacy/doc/models/pause-subscription-response.md diff --git a/doc/models/pay-order-request.md b/legacy/doc/models/pay-order-request.md similarity index 100% rename from doc/models/pay-order-request.md rename to legacy/doc/models/pay-order-request.md diff --git a/doc/models/pay-order-response.md b/legacy/doc/models/pay-order-response.md similarity index 100% rename from doc/models/pay-order-response.md rename to legacy/doc/models/pay-order-response.md diff --git a/doc/models/payment-balance-activity-app-fee-refund-detail.md b/legacy/doc/models/payment-balance-activity-app-fee-refund-detail.md similarity index 100% rename from doc/models/payment-balance-activity-app-fee-refund-detail.md rename to legacy/doc/models/payment-balance-activity-app-fee-refund-detail.md diff --git a/doc/models/payment-balance-activity-app-fee-revenue-detail.md b/legacy/doc/models/payment-balance-activity-app-fee-revenue-detail.md similarity index 100% rename from doc/models/payment-balance-activity-app-fee-revenue-detail.md rename to legacy/doc/models/payment-balance-activity-app-fee-revenue-detail.md diff --git a/doc/models/payment-balance-activity-automatic-savings-detail.md b/legacy/doc/models/payment-balance-activity-automatic-savings-detail.md similarity index 100% rename from doc/models/payment-balance-activity-automatic-savings-detail.md rename to legacy/doc/models/payment-balance-activity-automatic-savings-detail.md diff --git a/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md b/legacy/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md similarity index 100% rename from doc/models/payment-balance-activity-automatic-savings-reversed-detail.md rename to legacy/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md diff --git a/doc/models/payment-balance-activity-charge-detail.md b/legacy/doc/models/payment-balance-activity-charge-detail.md similarity index 100% rename from doc/models/payment-balance-activity-charge-detail.md rename to legacy/doc/models/payment-balance-activity-charge-detail.md diff --git a/doc/models/payment-balance-activity-deposit-fee-detail.md b/legacy/doc/models/payment-balance-activity-deposit-fee-detail.md similarity index 100% rename from doc/models/payment-balance-activity-deposit-fee-detail.md rename to legacy/doc/models/payment-balance-activity-deposit-fee-detail.md diff --git a/doc/models/payment-balance-activity-deposit-fee-reversed-detail.md b/legacy/doc/models/payment-balance-activity-deposit-fee-reversed-detail.md similarity index 100% rename from doc/models/payment-balance-activity-deposit-fee-reversed-detail.md rename to legacy/doc/models/payment-balance-activity-deposit-fee-reversed-detail.md diff --git a/doc/models/payment-balance-activity-dispute-detail.md b/legacy/doc/models/payment-balance-activity-dispute-detail.md similarity index 100% rename from doc/models/payment-balance-activity-dispute-detail.md rename to legacy/doc/models/payment-balance-activity-dispute-detail.md diff --git a/doc/models/payment-balance-activity-fee-detail.md b/legacy/doc/models/payment-balance-activity-fee-detail.md similarity index 100% rename from doc/models/payment-balance-activity-fee-detail.md rename to legacy/doc/models/payment-balance-activity-fee-detail.md diff --git a/doc/models/payment-balance-activity-free-processing-detail.md b/legacy/doc/models/payment-balance-activity-free-processing-detail.md similarity index 100% rename from doc/models/payment-balance-activity-free-processing-detail.md rename to legacy/doc/models/payment-balance-activity-free-processing-detail.md diff --git a/doc/models/payment-balance-activity-hold-adjustment-detail.md b/legacy/doc/models/payment-balance-activity-hold-adjustment-detail.md similarity index 100% rename from doc/models/payment-balance-activity-hold-adjustment-detail.md rename to legacy/doc/models/payment-balance-activity-hold-adjustment-detail.md diff --git a/doc/models/payment-balance-activity-open-dispute-detail.md b/legacy/doc/models/payment-balance-activity-open-dispute-detail.md similarity index 100% rename from doc/models/payment-balance-activity-open-dispute-detail.md rename to legacy/doc/models/payment-balance-activity-open-dispute-detail.md diff --git a/doc/models/payment-balance-activity-other-adjustment-detail.md b/legacy/doc/models/payment-balance-activity-other-adjustment-detail.md similarity index 100% rename from doc/models/payment-balance-activity-other-adjustment-detail.md rename to legacy/doc/models/payment-balance-activity-other-adjustment-detail.md diff --git a/doc/models/payment-balance-activity-other-detail.md b/legacy/doc/models/payment-balance-activity-other-detail.md similarity index 100% rename from doc/models/payment-balance-activity-other-detail.md rename to legacy/doc/models/payment-balance-activity-other-detail.md diff --git a/doc/models/payment-balance-activity-refund-detail.md b/legacy/doc/models/payment-balance-activity-refund-detail.md similarity index 100% rename from doc/models/payment-balance-activity-refund-detail.md rename to legacy/doc/models/payment-balance-activity-refund-detail.md diff --git a/doc/models/payment-balance-activity-release-adjustment-detail.md b/legacy/doc/models/payment-balance-activity-release-adjustment-detail.md similarity index 100% rename from doc/models/payment-balance-activity-release-adjustment-detail.md rename to legacy/doc/models/payment-balance-activity-release-adjustment-detail.md diff --git a/doc/models/payment-balance-activity-reserve-hold-detail.md b/legacy/doc/models/payment-balance-activity-reserve-hold-detail.md similarity index 100% rename from doc/models/payment-balance-activity-reserve-hold-detail.md rename to legacy/doc/models/payment-balance-activity-reserve-hold-detail.md diff --git a/doc/models/payment-balance-activity-reserve-release-detail.md b/legacy/doc/models/payment-balance-activity-reserve-release-detail.md similarity index 100% rename from doc/models/payment-balance-activity-reserve-release-detail.md rename to legacy/doc/models/payment-balance-activity-reserve-release-detail.md diff --git a/doc/models/payment-balance-activity-square-capital-payment-detail.md b/legacy/doc/models/payment-balance-activity-square-capital-payment-detail.md similarity index 100% rename from doc/models/payment-balance-activity-square-capital-payment-detail.md rename to legacy/doc/models/payment-balance-activity-square-capital-payment-detail.md diff --git a/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md b/legacy/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md similarity index 100% rename from doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md rename to legacy/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md diff --git a/doc/models/payment-balance-activity-square-payroll-transfer-detail.md b/legacy/doc/models/payment-balance-activity-square-payroll-transfer-detail.md similarity index 100% rename from doc/models/payment-balance-activity-square-payroll-transfer-detail.md rename to legacy/doc/models/payment-balance-activity-square-payroll-transfer-detail.md diff --git a/doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md b/legacy/doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md similarity index 100% rename from doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md rename to legacy/doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md diff --git a/doc/models/payment-balance-activity-tax-on-fee-detail.md b/legacy/doc/models/payment-balance-activity-tax-on-fee-detail.md similarity index 100% rename from doc/models/payment-balance-activity-tax-on-fee-detail.md rename to legacy/doc/models/payment-balance-activity-tax-on-fee-detail.md diff --git a/doc/models/payment-balance-activity-third-party-fee-detail.md b/legacy/doc/models/payment-balance-activity-third-party-fee-detail.md similarity index 100% rename from doc/models/payment-balance-activity-third-party-fee-detail.md rename to legacy/doc/models/payment-balance-activity-third-party-fee-detail.md diff --git a/doc/models/payment-balance-activity-third-party-fee-refund-detail.md b/legacy/doc/models/payment-balance-activity-third-party-fee-refund-detail.md similarity index 100% rename from doc/models/payment-balance-activity-third-party-fee-refund-detail.md rename to legacy/doc/models/payment-balance-activity-third-party-fee-refund-detail.md diff --git a/doc/models/payment-link-related-resources.md b/legacy/doc/models/payment-link-related-resources.md similarity index 100% rename from doc/models/payment-link-related-resources.md rename to legacy/doc/models/payment-link-related-resources.md diff --git a/doc/models/payment-link.md b/legacy/doc/models/payment-link.md similarity index 100% rename from doc/models/payment-link.md rename to legacy/doc/models/payment-link.md diff --git a/doc/models/payment-options-delay-action.md b/legacy/doc/models/payment-options-delay-action.md similarity index 100% rename from doc/models/payment-options-delay-action.md rename to legacy/doc/models/payment-options-delay-action.md diff --git a/doc/models/payment-options.md b/legacy/doc/models/payment-options.md similarity index 100% rename from doc/models/payment-options.md rename to legacy/doc/models/payment-options.md diff --git a/doc/models/payment-refund.md b/legacy/doc/models/payment-refund.md similarity index 100% rename from doc/models/payment-refund.md rename to legacy/doc/models/payment-refund.md diff --git a/doc/models/payment-sort-field.md b/legacy/doc/models/payment-sort-field.md similarity index 100% rename from doc/models/payment-sort-field.md rename to legacy/doc/models/payment-sort-field.md diff --git a/doc/models/payment.md b/legacy/doc/models/payment.md similarity index 100% rename from doc/models/payment.md rename to legacy/doc/models/payment.md diff --git a/doc/models/payout-entry.md b/legacy/doc/models/payout-entry.md similarity index 100% rename from doc/models/payout-entry.md rename to legacy/doc/models/payout-entry.md diff --git a/doc/models/payout-fee-type.md b/legacy/doc/models/payout-fee-type.md similarity index 100% rename from doc/models/payout-fee-type.md rename to legacy/doc/models/payout-fee-type.md diff --git a/doc/models/payout-fee.md b/legacy/doc/models/payout-fee.md similarity index 100% rename from doc/models/payout-fee.md rename to legacy/doc/models/payout-fee.md diff --git a/doc/models/payout-status.md b/legacy/doc/models/payout-status.md similarity index 100% rename from doc/models/payout-status.md rename to legacy/doc/models/payout-status.md diff --git a/doc/models/payout-type.md b/legacy/doc/models/payout-type.md similarity index 100% rename from doc/models/payout-type.md rename to legacy/doc/models/payout-type.md diff --git a/doc/models/payout.md b/legacy/doc/models/payout.md similarity index 100% rename from doc/models/payout.md rename to legacy/doc/models/payout.md diff --git a/doc/models/phase-input.md b/legacy/doc/models/phase-input.md similarity index 100% rename from doc/models/phase-input.md rename to legacy/doc/models/phase-input.md diff --git a/doc/models/phase.md b/legacy/doc/models/phase.md similarity index 100% rename from doc/models/phase.md rename to legacy/doc/models/phase.md diff --git a/doc/models/pre-populated-data.md b/legacy/doc/models/pre-populated-data.md similarity index 100% rename from doc/models/pre-populated-data.md rename to legacy/doc/models/pre-populated-data.md diff --git a/doc/models/processing-fee.md b/legacy/doc/models/processing-fee.md similarity index 100% rename from doc/models/processing-fee.md rename to legacy/doc/models/processing-fee.md diff --git a/doc/models/product-type.md b/legacy/doc/models/product-type.md similarity index 100% rename from doc/models/product-type.md rename to legacy/doc/models/product-type.md diff --git a/doc/models/product.md b/legacy/doc/models/product.md similarity index 100% rename from doc/models/product.md rename to legacy/doc/models/product.md diff --git a/doc/models/publish-invoice-request.md b/legacy/doc/models/publish-invoice-request.md similarity index 100% rename from doc/models/publish-invoice-request.md rename to legacy/doc/models/publish-invoice-request.md diff --git a/doc/models/publish-invoice-response.md b/legacy/doc/models/publish-invoice-response.md similarity index 100% rename from doc/models/publish-invoice-response.md rename to legacy/doc/models/publish-invoice-response.md diff --git a/doc/models/qr-code-options.md b/legacy/doc/models/qr-code-options.md similarity index 100% rename from doc/models/qr-code-options.md rename to legacy/doc/models/qr-code-options.md diff --git a/doc/models/quantity-ratio.md b/legacy/doc/models/quantity-ratio.md similarity index 100% rename from doc/models/quantity-ratio.md rename to legacy/doc/models/quantity-ratio.md diff --git a/doc/models/quick-pay.md b/legacy/doc/models/quick-pay.md similarity index 100% rename from doc/models/quick-pay.md rename to legacy/doc/models/quick-pay.md diff --git a/doc/models/range.md b/legacy/doc/models/range.md similarity index 100% rename from doc/models/range.md rename to legacy/doc/models/range.md diff --git a/doc/models/receipt-options.md b/legacy/doc/models/receipt-options.md similarity index 100% rename from doc/models/receipt-options.md rename to legacy/doc/models/receipt-options.md diff --git a/doc/models/redeem-loyalty-reward-request.md b/legacy/doc/models/redeem-loyalty-reward-request.md similarity index 100% rename from doc/models/redeem-loyalty-reward-request.md rename to legacy/doc/models/redeem-loyalty-reward-request.md diff --git a/doc/models/redeem-loyalty-reward-response.md b/legacy/doc/models/redeem-loyalty-reward-response.md similarity index 100% rename from doc/models/redeem-loyalty-reward-response.md rename to legacy/doc/models/redeem-loyalty-reward-response.md diff --git a/doc/models/refund-payment-request.md b/legacy/doc/models/refund-payment-request.md similarity index 100% rename from doc/models/refund-payment-request.md rename to legacy/doc/models/refund-payment-request.md diff --git a/doc/models/refund-payment-response.md b/legacy/doc/models/refund-payment-response.md similarity index 100% rename from doc/models/refund-payment-response.md rename to legacy/doc/models/refund-payment-response.md diff --git a/doc/models/refund-status.md b/legacy/doc/models/refund-status.md similarity index 100% rename from doc/models/refund-status.md rename to legacy/doc/models/refund-status.md diff --git a/doc/models/refund.md b/legacy/doc/models/refund.md similarity index 100% rename from doc/models/refund.md rename to legacy/doc/models/refund.md diff --git a/doc/models/register-domain-request.md b/legacy/doc/models/register-domain-request.md similarity index 100% rename from doc/models/register-domain-request.md rename to legacy/doc/models/register-domain-request.md diff --git a/doc/models/register-domain-response-status.md b/legacy/doc/models/register-domain-response-status.md similarity index 100% rename from doc/models/register-domain-response-status.md rename to legacy/doc/models/register-domain-response-status.md diff --git a/doc/models/register-domain-response.md b/legacy/doc/models/register-domain-response.md similarity index 100% rename from doc/models/register-domain-response.md rename to legacy/doc/models/register-domain-response.md diff --git a/doc/models/remove-group-from-customer-response.md b/legacy/doc/models/remove-group-from-customer-response.md similarity index 100% rename from doc/models/remove-group-from-customer-response.md rename to legacy/doc/models/remove-group-from-customer-response.md diff --git a/doc/models/resume-subscription-request.md b/legacy/doc/models/resume-subscription-request.md similarity index 100% rename from doc/models/resume-subscription-request.md rename to legacy/doc/models/resume-subscription-request.md diff --git a/doc/models/resume-subscription-response.md b/legacy/doc/models/resume-subscription-response.md similarity index 100% rename from doc/models/resume-subscription-response.md rename to legacy/doc/models/resume-subscription-response.md diff --git a/doc/models/retrieve-booking-custom-attribute-definition-request.md b/legacy/doc/models/retrieve-booking-custom-attribute-definition-request.md similarity index 100% rename from doc/models/retrieve-booking-custom-attribute-definition-request.md rename to legacy/doc/models/retrieve-booking-custom-attribute-definition-request.md diff --git a/doc/models/retrieve-booking-custom-attribute-definition-response.md b/legacy/doc/models/retrieve-booking-custom-attribute-definition-response.md similarity index 100% rename from doc/models/retrieve-booking-custom-attribute-definition-response.md rename to legacy/doc/models/retrieve-booking-custom-attribute-definition-response.md diff --git a/doc/models/retrieve-booking-custom-attribute-request.md b/legacy/doc/models/retrieve-booking-custom-attribute-request.md similarity index 100% rename from doc/models/retrieve-booking-custom-attribute-request.md rename to legacy/doc/models/retrieve-booking-custom-attribute-request.md diff --git a/doc/models/retrieve-booking-custom-attribute-response.md b/legacy/doc/models/retrieve-booking-custom-attribute-response.md similarity index 100% rename from doc/models/retrieve-booking-custom-attribute-response.md rename to legacy/doc/models/retrieve-booking-custom-attribute-response.md diff --git a/doc/models/retrieve-booking-response.md b/legacy/doc/models/retrieve-booking-response.md similarity index 100% rename from doc/models/retrieve-booking-response.md rename to legacy/doc/models/retrieve-booking-response.md diff --git a/doc/models/retrieve-business-booking-profile-response.md b/legacy/doc/models/retrieve-business-booking-profile-response.md similarity index 100% rename from doc/models/retrieve-business-booking-profile-response.md rename to legacy/doc/models/retrieve-business-booking-profile-response.md diff --git a/doc/models/retrieve-card-response.md b/legacy/doc/models/retrieve-card-response.md similarity index 100% rename from doc/models/retrieve-card-response.md rename to legacy/doc/models/retrieve-card-response.md diff --git a/doc/models/retrieve-cash-drawer-shift-request.md b/legacy/doc/models/retrieve-cash-drawer-shift-request.md similarity index 100% rename from doc/models/retrieve-cash-drawer-shift-request.md rename to legacy/doc/models/retrieve-cash-drawer-shift-request.md diff --git a/doc/models/retrieve-cash-drawer-shift-response.md b/legacy/doc/models/retrieve-cash-drawer-shift-response.md similarity index 100% rename from doc/models/retrieve-cash-drawer-shift-response.md rename to legacy/doc/models/retrieve-cash-drawer-shift-response.md diff --git a/doc/models/retrieve-catalog-object-request.md b/legacy/doc/models/retrieve-catalog-object-request.md similarity index 100% rename from doc/models/retrieve-catalog-object-request.md rename to legacy/doc/models/retrieve-catalog-object-request.md diff --git a/doc/models/retrieve-catalog-object-response.md b/legacy/doc/models/retrieve-catalog-object-response.md similarity index 100% rename from doc/models/retrieve-catalog-object-response.md rename to legacy/doc/models/retrieve-catalog-object-response.md diff --git a/doc/models/retrieve-customer-custom-attribute-definition-request.md b/legacy/doc/models/retrieve-customer-custom-attribute-definition-request.md similarity index 100% rename from doc/models/retrieve-customer-custom-attribute-definition-request.md rename to legacy/doc/models/retrieve-customer-custom-attribute-definition-request.md diff --git a/doc/models/retrieve-customer-custom-attribute-definition-response.md b/legacy/doc/models/retrieve-customer-custom-attribute-definition-response.md similarity index 100% rename from doc/models/retrieve-customer-custom-attribute-definition-response.md rename to legacy/doc/models/retrieve-customer-custom-attribute-definition-response.md diff --git a/doc/models/retrieve-customer-custom-attribute-request.md b/legacy/doc/models/retrieve-customer-custom-attribute-request.md similarity index 100% rename from doc/models/retrieve-customer-custom-attribute-request.md rename to legacy/doc/models/retrieve-customer-custom-attribute-request.md diff --git a/doc/models/retrieve-customer-custom-attribute-response.md b/legacy/doc/models/retrieve-customer-custom-attribute-response.md similarity index 100% rename from doc/models/retrieve-customer-custom-attribute-response.md rename to legacy/doc/models/retrieve-customer-custom-attribute-response.md diff --git a/doc/models/retrieve-customer-group-response.md b/legacy/doc/models/retrieve-customer-group-response.md similarity index 100% rename from doc/models/retrieve-customer-group-response.md rename to legacy/doc/models/retrieve-customer-group-response.md diff --git a/doc/models/retrieve-customer-response.md b/legacy/doc/models/retrieve-customer-response.md similarity index 100% rename from doc/models/retrieve-customer-response.md rename to legacy/doc/models/retrieve-customer-response.md diff --git a/doc/models/retrieve-customer-segment-response.md b/legacy/doc/models/retrieve-customer-segment-response.md similarity index 100% rename from doc/models/retrieve-customer-segment-response.md rename to legacy/doc/models/retrieve-customer-segment-response.md diff --git a/doc/models/retrieve-dispute-evidence-response.md b/legacy/doc/models/retrieve-dispute-evidence-response.md similarity index 100% rename from doc/models/retrieve-dispute-evidence-response.md rename to legacy/doc/models/retrieve-dispute-evidence-response.md diff --git a/doc/models/retrieve-dispute-response.md b/legacy/doc/models/retrieve-dispute-response.md similarity index 100% rename from doc/models/retrieve-dispute-response.md rename to legacy/doc/models/retrieve-dispute-response.md diff --git a/doc/models/retrieve-employee-response.md b/legacy/doc/models/retrieve-employee-response.md similarity index 100% rename from doc/models/retrieve-employee-response.md rename to legacy/doc/models/retrieve-employee-response.md diff --git a/doc/models/retrieve-gift-card-from-gan-request.md b/legacy/doc/models/retrieve-gift-card-from-gan-request.md similarity index 100% rename from doc/models/retrieve-gift-card-from-gan-request.md rename to legacy/doc/models/retrieve-gift-card-from-gan-request.md diff --git a/doc/models/retrieve-gift-card-from-gan-response.md b/legacy/doc/models/retrieve-gift-card-from-gan-response.md similarity index 100% rename from doc/models/retrieve-gift-card-from-gan-response.md rename to legacy/doc/models/retrieve-gift-card-from-gan-response.md diff --git a/doc/models/retrieve-gift-card-from-nonce-request.md b/legacy/doc/models/retrieve-gift-card-from-nonce-request.md similarity index 100% rename from doc/models/retrieve-gift-card-from-nonce-request.md rename to legacy/doc/models/retrieve-gift-card-from-nonce-request.md diff --git a/doc/models/retrieve-gift-card-from-nonce-response.md b/legacy/doc/models/retrieve-gift-card-from-nonce-response.md similarity index 100% rename from doc/models/retrieve-gift-card-from-nonce-response.md rename to legacy/doc/models/retrieve-gift-card-from-nonce-response.md diff --git a/doc/models/retrieve-gift-card-response.md b/legacy/doc/models/retrieve-gift-card-response.md similarity index 100% rename from doc/models/retrieve-gift-card-response.md rename to legacy/doc/models/retrieve-gift-card-response.md diff --git a/doc/models/retrieve-inventory-adjustment-response.md b/legacy/doc/models/retrieve-inventory-adjustment-response.md similarity index 100% rename from doc/models/retrieve-inventory-adjustment-response.md rename to legacy/doc/models/retrieve-inventory-adjustment-response.md diff --git a/doc/models/retrieve-inventory-changes-request.md b/legacy/doc/models/retrieve-inventory-changes-request.md similarity index 100% rename from doc/models/retrieve-inventory-changes-request.md rename to legacy/doc/models/retrieve-inventory-changes-request.md diff --git a/doc/models/retrieve-inventory-changes-response.md b/legacy/doc/models/retrieve-inventory-changes-response.md similarity index 100% rename from doc/models/retrieve-inventory-changes-response.md rename to legacy/doc/models/retrieve-inventory-changes-response.md diff --git a/doc/models/retrieve-inventory-count-request.md b/legacy/doc/models/retrieve-inventory-count-request.md similarity index 100% rename from doc/models/retrieve-inventory-count-request.md rename to legacy/doc/models/retrieve-inventory-count-request.md diff --git a/doc/models/retrieve-inventory-count-response.md b/legacy/doc/models/retrieve-inventory-count-response.md similarity index 100% rename from doc/models/retrieve-inventory-count-response.md rename to legacy/doc/models/retrieve-inventory-count-response.md diff --git a/doc/models/retrieve-inventory-physical-count-response.md b/legacy/doc/models/retrieve-inventory-physical-count-response.md similarity index 100% rename from doc/models/retrieve-inventory-physical-count-response.md rename to legacy/doc/models/retrieve-inventory-physical-count-response.md diff --git a/doc/models/retrieve-inventory-transfer-response.md b/legacy/doc/models/retrieve-inventory-transfer-response.md similarity index 100% rename from doc/models/retrieve-inventory-transfer-response.md rename to legacy/doc/models/retrieve-inventory-transfer-response.md diff --git a/doc/models/retrieve-job-response.md b/legacy/doc/models/retrieve-job-response.md similarity index 100% rename from doc/models/retrieve-job-response.md rename to legacy/doc/models/retrieve-job-response.md diff --git a/doc/models/retrieve-location-booking-profile-response.md b/legacy/doc/models/retrieve-location-booking-profile-response.md similarity index 100% rename from doc/models/retrieve-location-booking-profile-response.md rename to legacy/doc/models/retrieve-location-booking-profile-response.md diff --git a/doc/models/retrieve-location-custom-attribute-definition-request.md b/legacy/doc/models/retrieve-location-custom-attribute-definition-request.md similarity index 100% rename from doc/models/retrieve-location-custom-attribute-definition-request.md rename to legacy/doc/models/retrieve-location-custom-attribute-definition-request.md diff --git a/doc/models/retrieve-location-custom-attribute-definition-response.md b/legacy/doc/models/retrieve-location-custom-attribute-definition-response.md similarity index 100% rename from doc/models/retrieve-location-custom-attribute-definition-response.md rename to legacy/doc/models/retrieve-location-custom-attribute-definition-response.md diff --git a/doc/models/retrieve-location-custom-attribute-request.md b/legacy/doc/models/retrieve-location-custom-attribute-request.md similarity index 100% rename from doc/models/retrieve-location-custom-attribute-request.md rename to legacy/doc/models/retrieve-location-custom-attribute-request.md diff --git a/doc/models/retrieve-location-custom-attribute-response.md b/legacy/doc/models/retrieve-location-custom-attribute-response.md similarity index 100% rename from doc/models/retrieve-location-custom-attribute-response.md rename to legacy/doc/models/retrieve-location-custom-attribute-response.md diff --git a/doc/models/retrieve-location-response.md b/legacy/doc/models/retrieve-location-response.md similarity index 100% rename from doc/models/retrieve-location-response.md rename to legacy/doc/models/retrieve-location-response.md diff --git a/doc/models/retrieve-location-settings-response.md b/legacy/doc/models/retrieve-location-settings-response.md similarity index 100% rename from doc/models/retrieve-location-settings-response.md rename to legacy/doc/models/retrieve-location-settings-response.md diff --git a/doc/models/retrieve-loyalty-account-response.md b/legacy/doc/models/retrieve-loyalty-account-response.md similarity index 100% rename from doc/models/retrieve-loyalty-account-response.md rename to legacy/doc/models/retrieve-loyalty-account-response.md diff --git a/doc/models/retrieve-loyalty-program-response.md b/legacy/doc/models/retrieve-loyalty-program-response.md similarity index 100% rename from doc/models/retrieve-loyalty-program-response.md rename to legacy/doc/models/retrieve-loyalty-program-response.md diff --git a/doc/models/retrieve-loyalty-promotion-response.md b/legacy/doc/models/retrieve-loyalty-promotion-response.md similarity index 100% rename from doc/models/retrieve-loyalty-promotion-response.md rename to legacy/doc/models/retrieve-loyalty-promotion-response.md diff --git a/doc/models/retrieve-loyalty-reward-response.md b/legacy/doc/models/retrieve-loyalty-reward-response.md similarity index 100% rename from doc/models/retrieve-loyalty-reward-response.md rename to legacy/doc/models/retrieve-loyalty-reward-response.md diff --git a/doc/models/retrieve-merchant-custom-attribute-definition-request.md b/legacy/doc/models/retrieve-merchant-custom-attribute-definition-request.md similarity index 100% rename from doc/models/retrieve-merchant-custom-attribute-definition-request.md rename to legacy/doc/models/retrieve-merchant-custom-attribute-definition-request.md diff --git a/doc/models/retrieve-merchant-custom-attribute-definition-response.md b/legacy/doc/models/retrieve-merchant-custom-attribute-definition-response.md similarity index 100% rename from doc/models/retrieve-merchant-custom-attribute-definition-response.md rename to legacy/doc/models/retrieve-merchant-custom-attribute-definition-response.md diff --git a/doc/models/retrieve-merchant-custom-attribute-request.md b/legacy/doc/models/retrieve-merchant-custom-attribute-request.md similarity index 100% rename from doc/models/retrieve-merchant-custom-attribute-request.md rename to legacy/doc/models/retrieve-merchant-custom-attribute-request.md diff --git a/doc/models/retrieve-merchant-custom-attribute-response.md b/legacy/doc/models/retrieve-merchant-custom-attribute-response.md similarity index 100% rename from doc/models/retrieve-merchant-custom-attribute-response.md rename to legacy/doc/models/retrieve-merchant-custom-attribute-response.md diff --git a/doc/models/retrieve-merchant-response.md b/legacy/doc/models/retrieve-merchant-response.md similarity index 100% rename from doc/models/retrieve-merchant-response.md rename to legacy/doc/models/retrieve-merchant-response.md diff --git a/doc/models/retrieve-merchant-settings-response.md b/legacy/doc/models/retrieve-merchant-settings-response.md similarity index 100% rename from doc/models/retrieve-merchant-settings-response.md rename to legacy/doc/models/retrieve-merchant-settings-response.md diff --git a/doc/models/retrieve-order-custom-attribute-definition-request.md b/legacy/doc/models/retrieve-order-custom-attribute-definition-request.md similarity index 100% rename from doc/models/retrieve-order-custom-attribute-definition-request.md rename to legacy/doc/models/retrieve-order-custom-attribute-definition-request.md diff --git a/doc/models/retrieve-order-custom-attribute-definition-response.md b/legacy/doc/models/retrieve-order-custom-attribute-definition-response.md similarity index 100% rename from doc/models/retrieve-order-custom-attribute-definition-response.md rename to legacy/doc/models/retrieve-order-custom-attribute-definition-response.md diff --git a/doc/models/retrieve-order-custom-attribute-request.md b/legacy/doc/models/retrieve-order-custom-attribute-request.md similarity index 100% rename from doc/models/retrieve-order-custom-attribute-request.md rename to legacy/doc/models/retrieve-order-custom-attribute-request.md diff --git a/doc/models/retrieve-order-custom-attribute-response.md b/legacy/doc/models/retrieve-order-custom-attribute-response.md similarity index 100% rename from doc/models/retrieve-order-custom-attribute-response.md rename to legacy/doc/models/retrieve-order-custom-attribute-response.md diff --git a/doc/models/retrieve-order-response.md b/legacy/doc/models/retrieve-order-response.md similarity index 100% rename from doc/models/retrieve-order-response.md rename to legacy/doc/models/retrieve-order-response.md diff --git a/doc/models/retrieve-payment-link-response.md b/legacy/doc/models/retrieve-payment-link-response.md similarity index 100% rename from doc/models/retrieve-payment-link-response.md rename to legacy/doc/models/retrieve-payment-link-response.md diff --git a/doc/models/retrieve-snippet-response.md b/legacy/doc/models/retrieve-snippet-response.md similarity index 100% rename from doc/models/retrieve-snippet-response.md rename to legacy/doc/models/retrieve-snippet-response.md diff --git a/doc/models/retrieve-subscription-request.md b/legacy/doc/models/retrieve-subscription-request.md similarity index 100% rename from doc/models/retrieve-subscription-request.md rename to legacy/doc/models/retrieve-subscription-request.md diff --git a/doc/models/retrieve-subscription-response.md b/legacy/doc/models/retrieve-subscription-response.md similarity index 100% rename from doc/models/retrieve-subscription-response.md rename to legacy/doc/models/retrieve-subscription-response.md diff --git a/doc/models/retrieve-team-member-booking-profile-response.md b/legacy/doc/models/retrieve-team-member-booking-profile-response.md similarity index 100% rename from doc/models/retrieve-team-member-booking-profile-response.md rename to legacy/doc/models/retrieve-team-member-booking-profile-response.md diff --git a/doc/models/retrieve-team-member-response.md b/legacy/doc/models/retrieve-team-member-response.md similarity index 100% rename from doc/models/retrieve-team-member-response.md rename to legacy/doc/models/retrieve-team-member-response.md diff --git a/doc/models/retrieve-token-status-response.md b/legacy/doc/models/retrieve-token-status-response.md similarity index 100% rename from doc/models/retrieve-token-status-response.md rename to legacy/doc/models/retrieve-token-status-response.md diff --git a/doc/models/retrieve-transaction-response.md b/legacy/doc/models/retrieve-transaction-response.md similarity index 100% rename from doc/models/retrieve-transaction-response.md rename to legacy/doc/models/retrieve-transaction-response.md diff --git a/doc/models/retrieve-vendor-response.md b/legacy/doc/models/retrieve-vendor-response.md similarity index 100% rename from doc/models/retrieve-vendor-response.md rename to legacy/doc/models/retrieve-vendor-response.md diff --git a/doc/models/retrieve-wage-setting-response.md b/legacy/doc/models/retrieve-wage-setting-response.md similarity index 100% rename from doc/models/retrieve-wage-setting-response.md rename to legacy/doc/models/retrieve-wage-setting-response.md diff --git a/doc/models/retrieve-webhook-subscription-response.md b/legacy/doc/models/retrieve-webhook-subscription-response.md similarity index 100% rename from doc/models/retrieve-webhook-subscription-response.md rename to legacy/doc/models/retrieve-webhook-subscription-response.md diff --git a/doc/models/revoke-token-request.md b/legacy/doc/models/revoke-token-request.md similarity index 100% rename from doc/models/revoke-token-request.md rename to legacy/doc/models/revoke-token-request.md diff --git a/doc/models/revoke-token-response.md b/legacy/doc/models/revoke-token-response.md similarity index 100% rename from doc/models/revoke-token-response.md rename to legacy/doc/models/revoke-token-response.md diff --git a/doc/models/risk-evaluation-risk-level.md b/legacy/doc/models/risk-evaluation-risk-level.md similarity index 100% rename from doc/models/risk-evaluation-risk-level.md rename to legacy/doc/models/risk-evaluation-risk-level.md diff --git a/doc/models/risk-evaluation.md b/legacy/doc/models/risk-evaluation.md similarity index 100% rename from doc/models/risk-evaluation.md rename to legacy/doc/models/risk-evaluation.md diff --git a/doc/models/save-card-options.md b/legacy/doc/models/save-card-options.md similarity index 100% rename from doc/models/save-card-options.md rename to legacy/doc/models/save-card-options.md diff --git a/doc/models/search-availability-filter.md b/legacy/doc/models/search-availability-filter.md similarity index 100% rename from doc/models/search-availability-filter.md rename to legacy/doc/models/search-availability-filter.md diff --git a/doc/models/search-availability-query.md b/legacy/doc/models/search-availability-query.md similarity index 100% rename from doc/models/search-availability-query.md rename to legacy/doc/models/search-availability-query.md diff --git a/doc/models/search-availability-request.md b/legacy/doc/models/search-availability-request.md similarity index 100% rename from doc/models/search-availability-request.md rename to legacy/doc/models/search-availability-request.md diff --git a/doc/models/search-availability-response.md b/legacy/doc/models/search-availability-response.md similarity index 100% rename from doc/models/search-availability-response.md rename to legacy/doc/models/search-availability-response.md diff --git a/doc/models/search-catalog-items-request-stock-level.md b/legacy/doc/models/search-catalog-items-request-stock-level.md similarity index 100% rename from doc/models/search-catalog-items-request-stock-level.md rename to legacy/doc/models/search-catalog-items-request-stock-level.md diff --git a/doc/models/search-catalog-items-request.md b/legacy/doc/models/search-catalog-items-request.md similarity index 100% rename from doc/models/search-catalog-items-request.md rename to legacy/doc/models/search-catalog-items-request.md diff --git a/doc/models/search-catalog-items-response.md b/legacy/doc/models/search-catalog-items-response.md similarity index 100% rename from doc/models/search-catalog-items-response.md rename to legacy/doc/models/search-catalog-items-response.md diff --git a/doc/models/search-catalog-objects-request.md b/legacy/doc/models/search-catalog-objects-request.md similarity index 100% rename from doc/models/search-catalog-objects-request.md rename to legacy/doc/models/search-catalog-objects-request.md diff --git a/doc/models/search-catalog-objects-response.md b/legacy/doc/models/search-catalog-objects-response.md similarity index 100% rename from doc/models/search-catalog-objects-response.md rename to legacy/doc/models/search-catalog-objects-response.md diff --git a/doc/models/search-customers-request.md b/legacy/doc/models/search-customers-request.md similarity index 100% rename from doc/models/search-customers-request.md rename to legacy/doc/models/search-customers-request.md diff --git a/doc/models/search-customers-response.md b/legacy/doc/models/search-customers-response.md similarity index 100% rename from doc/models/search-customers-response.md rename to legacy/doc/models/search-customers-response.md diff --git a/doc/models/search-events-filter.md b/legacy/doc/models/search-events-filter.md similarity index 100% rename from doc/models/search-events-filter.md rename to legacy/doc/models/search-events-filter.md diff --git a/doc/models/search-events-query.md b/legacy/doc/models/search-events-query.md similarity index 100% rename from doc/models/search-events-query.md rename to legacy/doc/models/search-events-query.md diff --git a/doc/models/search-events-request.md b/legacy/doc/models/search-events-request.md similarity index 100% rename from doc/models/search-events-request.md rename to legacy/doc/models/search-events-request.md diff --git a/doc/models/search-events-response.md b/legacy/doc/models/search-events-response.md similarity index 100% rename from doc/models/search-events-response.md rename to legacy/doc/models/search-events-response.md diff --git a/doc/models/search-events-sort-field.md b/legacy/doc/models/search-events-sort-field.md similarity index 100% rename from doc/models/search-events-sort-field.md rename to legacy/doc/models/search-events-sort-field.md diff --git a/doc/models/search-events-sort.md b/legacy/doc/models/search-events-sort.md similarity index 100% rename from doc/models/search-events-sort.md rename to legacy/doc/models/search-events-sort.md diff --git a/doc/models/search-invoices-request.md b/legacy/doc/models/search-invoices-request.md similarity index 100% rename from doc/models/search-invoices-request.md rename to legacy/doc/models/search-invoices-request.md diff --git a/doc/models/search-invoices-response.md b/legacy/doc/models/search-invoices-response.md similarity index 100% rename from doc/models/search-invoices-response.md rename to legacy/doc/models/search-invoices-response.md diff --git a/doc/models/search-loyalty-accounts-request-loyalty-account-query.md b/legacy/doc/models/search-loyalty-accounts-request-loyalty-account-query.md similarity index 100% rename from doc/models/search-loyalty-accounts-request-loyalty-account-query.md rename to legacy/doc/models/search-loyalty-accounts-request-loyalty-account-query.md diff --git a/doc/models/search-loyalty-accounts-request.md b/legacy/doc/models/search-loyalty-accounts-request.md similarity index 100% rename from doc/models/search-loyalty-accounts-request.md rename to legacy/doc/models/search-loyalty-accounts-request.md diff --git a/doc/models/search-loyalty-accounts-response.md b/legacy/doc/models/search-loyalty-accounts-response.md similarity index 100% rename from doc/models/search-loyalty-accounts-response.md rename to legacy/doc/models/search-loyalty-accounts-response.md diff --git a/doc/models/search-loyalty-events-request.md b/legacy/doc/models/search-loyalty-events-request.md similarity index 100% rename from doc/models/search-loyalty-events-request.md rename to legacy/doc/models/search-loyalty-events-request.md diff --git a/doc/models/search-loyalty-events-response.md b/legacy/doc/models/search-loyalty-events-response.md similarity index 100% rename from doc/models/search-loyalty-events-response.md rename to legacy/doc/models/search-loyalty-events-response.md diff --git a/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md b/legacy/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md similarity index 100% rename from doc/models/search-loyalty-rewards-request-loyalty-reward-query.md rename to legacy/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md diff --git a/doc/models/search-loyalty-rewards-request.md b/legacy/doc/models/search-loyalty-rewards-request.md similarity index 100% rename from doc/models/search-loyalty-rewards-request.md rename to legacy/doc/models/search-loyalty-rewards-request.md diff --git a/doc/models/search-loyalty-rewards-response.md b/legacy/doc/models/search-loyalty-rewards-response.md similarity index 100% rename from doc/models/search-loyalty-rewards-response.md rename to legacy/doc/models/search-loyalty-rewards-response.md diff --git a/doc/models/search-orders-customer-filter.md b/legacy/doc/models/search-orders-customer-filter.md similarity index 100% rename from doc/models/search-orders-customer-filter.md rename to legacy/doc/models/search-orders-customer-filter.md diff --git a/doc/models/search-orders-date-time-filter.md b/legacy/doc/models/search-orders-date-time-filter.md similarity index 100% rename from doc/models/search-orders-date-time-filter.md rename to legacy/doc/models/search-orders-date-time-filter.md diff --git a/doc/models/search-orders-filter.md b/legacy/doc/models/search-orders-filter.md similarity index 100% rename from doc/models/search-orders-filter.md rename to legacy/doc/models/search-orders-filter.md diff --git a/doc/models/search-orders-fulfillment-filter.md b/legacy/doc/models/search-orders-fulfillment-filter.md similarity index 100% rename from doc/models/search-orders-fulfillment-filter.md rename to legacy/doc/models/search-orders-fulfillment-filter.md diff --git a/doc/models/search-orders-query.md b/legacy/doc/models/search-orders-query.md similarity index 100% rename from doc/models/search-orders-query.md rename to legacy/doc/models/search-orders-query.md diff --git a/doc/models/search-orders-request.md b/legacy/doc/models/search-orders-request.md similarity index 100% rename from doc/models/search-orders-request.md rename to legacy/doc/models/search-orders-request.md diff --git a/doc/models/search-orders-response.md b/legacy/doc/models/search-orders-response.md similarity index 100% rename from doc/models/search-orders-response.md rename to legacy/doc/models/search-orders-response.md diff --git a/doc/models/search-orders-sort-field.md b/legacy/doc/models/search-orders-sort-field.md similarity index 100% rename from doc/models/search-orders-sort-field.md rename to legacy/doc/models/search-orders-sort-field.md diff --git a/doc/models/search-orders-sort.md b/legacy/doc/models/search-orders-sort.md similarity index 100% rename from doc/models/search-orders-sort.md rename to legacy/doc/models/search-orders-sort.md diff --git a/doc/models/search-orders-source-filter.md b/legacy/doc/models/search-orders-source-filter.md similarity index 100% rename from doc/models/search-orders-source-filter.md rename to legacy/doc/models/search-orders-source-filter.md diff --git a/doc/models/search-orders-state-filter.md b/legacy/doc/models/search-orders-state-filter.md similarity index 100% rename from doc/models/search-orders-state-filter.md rename to legacy/doc/models/search-orders-state-filter.md diff --git a/doc/models/search-shifts-request.md b/legacy/doc/models/search-shifts-request.md similarity index 100% rename from doc/models/search-shifts-request.md rename to legacy/doc/models/search-shifts-request.md diff --git a/doc/models/search-shifts-response.md b/legacy/doc/models/search-shifts-response.md similarity index 100% rename from doc/models/search-shifts-response.md rename to legacy/doc/models/search-shifts-response.md diff --git a/doc/models/search-subscriptions-filter.md b/legacy/doc/models/search-subscriptions-filter.md similarity index 100% rename from doc/models/search-subscriptions-filter.md rename to legacy/doc/models/search-subscriptions-filter.md diff --git a/doc/models/search-subscriptions-query.md b/legacy/doc/models/search-subscriptions-query.md similarity index 100% rename from doc/models/search-subscriptions-query.md rename to legacy/doc/models/search-subscriptions-query.md diff --git a/doc/models/search-subscriptions-request.md b/legacy/doc/models/search-subscriptions-request.md similarity index 100% rename from doc/models/search-subscriptions-request.md rename to legacy/doc/models/search-subscriptions-request.md diff --git a/doc/models/search-subscriptions-response.md b/legacy/doc/models/search-subscriptions-response.md similarity index 100% rename from doc/models/search-subscriptions-response.md rename to legacy/doc/models/search-subscriptions-response.md diff --git a/doc/models/search-team-members-filter.md b/legacy/doc/models/search-team-members-filter.md similarity index 100% rename from doc/models/search-team-members-filter.md rename to legacy/doc/models/search-team-members-filter.md diff --git a/doc/models/search-team-members-query.md b/legacy/doc/models/search-team-members-query.md similarity index 100% rename from doc/models/search-team-members-query.md rename to legacy/doc/models/search-team-members-query.md diff --git a/doc/models/search-team-members-request.md b/legacy/doc/models/search-team-members-request.md similarity index 100% rename from doc/models/search-team-members-request.md rename to legacy/doc/models/search-team-members-request.md diff --git a/doc/models/search-team-members-response.md b/legacy/doc/models/search-team-members-response.md similarity index 100% rename from doc/models/search-team-members-response.md rename to legacy/doc/models/search-team-members-response.md diff --git a/doc/models/search-terminal-actions-request.md b/legacy/doc/models/search-terminal-actions-request.md similarity index 100% rename from doc/models/search-terminal-actions-request.md rename to legacy/doc/models/search-terminal-actions-request.md diff --git a/doc/models/search-terminal-actions-response.md b/legacy/doc/models/search-terminal-actions-response.md similarity index 100% rename from doc/models/search-terminal-actions-response.md rename to legacy/doc/models/search-terminal-actions-response.md diff --git a/doc/models/search-terminal-checkouts-request.md b/legacy/doc/models/search-terminal-checkouts-request.md similarity index 100% rename from doc/models/search-terminal-checkouts-request.md rename to legacy/doc/models/search-terminal-checkouts-request.md diff --git a/doc/models/search-terminal-checkouts-response.md b/legacy/doc/models/search-terminal-checkouts-response.md similarity index 100% rename from doc/models/search-terminal-checkouts-response.md rename to legacy/doc/models/search-terminal-checkouts-response.md diff --git a/doc/models/search-terminal-refunds-request.md b/legacy/doc/models/search-terminal-refunds-request.md similarity index 100% rename from doc/models/search-terminal-refunds-request.md rename to legacy/doc/models/search-terminal-refunds-request.md diff --git a/doc/models/search-terminal-refunds-response.md b/legacy/doc/models/search-terminal-refunds-response.md similarity index 100% rename from doc/models/search-terminal-refunds-response.md rename to legacy/doc/models/search-terminal-refunds-response.md diff --git a/doc/models/search-vendors-request-filter.md b/legacy/doc/models/search-vendors-request-filter.md similarity index 100% rename from doc/models/search-vendors-request-filter.md rename to legacy/doc/models/search-vendors-request-filter.md diff --git a/doc/models/search-vendors-request-sort-field.md b/legacy/doc/models/search-vendors-request-sort-field.md similarity index 100% rename from doc/models/search-vendors-request-sort-field.md rename to legacy/doc/models/search-vendors-request-sort-field.md diff --git a/doc/models/search-vendors-request-sort.md b/legacy/doc/models/search-vendors-request-sort.md similarity index 100% rename from doc/models/search-vendors-request-sort.md rename to legacy/doc/models/search-vendors-request-sort.md diff --git a/doc/models/search-vendors-request.md b/legacy/doc/models/search-vendors-request.md similarity index 100% rename from doc/models/search-vendors-request.md rename to legacy/doc/models/search-vendors-request.md diff --git a/doc/models/search-vendors-response.md b/legacy/doc/models/search-vendors-response.md similarity index 100% rename from doc/models/search-vendors-response.md rename to legacy/doc/models/search-vendors-response.md diff --git a/doc/models/segment-filter.md b/legacy/doc/models/segment-filter.md similarity index 100% rename from doc/models/segment-filter.md rename to legacy/doc/models/segment-filter.md diff --git a/doc/models/select-option.md b/legacy/doc/models/select-option.md similarity index 100% rename from doc/models/select-option.md rename to legacy/doc/models/select-option.md diff --git a/doc/models/select-options.md b/legacy/doc/models/select-options.md similarity index 100% rename from doc/models/select-options.md rename to legacy/doc/models/select-options.md diff --git a/doc/models/shift-filter-status.md b/legacy/doc/models/shift-filter-status.md similarity index 100% rename from doc/models/shift-filter-status.md rename to legacy/doc/models/shift-filter-status.md diff --git a/doc/models/shift-filter.md b/legacy/doc/models/shift-filter.md similarity index 100% rename from doc/models/shift-filter.md rename to legacy/doc/models/shift-filter.md diff --git a/doc/models/shift-query.md b/legacy/doc/models/shift-query.md similarity index 100% rename from doc/models/shift-query.md rename to legacy/doc/models/shift-query.md diff --git a/doc/models/shift-sort-field.md b/legacy/doc/models/shift-sort-field.md similarity index 100% rename from doc/models/shift-sort-field.md rename to legacy/doc/models/shift-sort-field.md diff --git a/doc/models/shift-sort.md b/legacy/doc/models/shift-sort.md similarity index 100% rename from doc/models/shift-sort.md rename to legacy/doc/models/shift-sort.md diff --git a/doc/models/shift-status.md b/legacy/doc/models/shift-status.md similarity index 100% rename from doc/models/shift-status.md rename to legacy/doc/models/shift-status.md diff --git a/doc/models/shift-wage.md b/legacy/doc/models/shift-wage.md similarity index 100% rename from doc/models/shift-wage.md rename to legacy/doc/models/shift-wage.md diff --git a/doc/models/shift-workday-matcher.md b/legacy/doc/models/shift-workday-matcher.md similarity index 100% rename from doc/models/shift-workday-matcher.md rename to legacy/doc/models/shift-workday-matcher.md diff --git a/doc/models/shift-workday.md b/legacy/doc/models/shift-workday.md similarity index 100% rename from doc/models/shift-workday.md rename to legacy/doc/models/shift-workday.md diff --git a/doc/models/shift.md b/legacy/doc/models/shift.md similarity index 100% rename from doc/models/shift.md rename to legacy/doc/models/shift.md diff --git a/doc/models/shipping-fee.md b/legacy/doc/models/shipping-fee.md similarity index 100% rename from doc/models/shipping-fee.md rename to legacy/doc/models/shipping-fee.md diff --git a/doc/models/signature-image.md b/legacy/doc/models/signature-image.md similarity index 100% rename from doc/models/signature-image.md rename to legacy/doc/models/signature-image.md diff --git a/doc/models/signature-options.md b/legacy/doc/models/signature-options.md similarity index 100% rename from doc/models/signature-options.md rename to legacy/doc/models/signature-options.md diff --git a/doc/models/site.md b/legacy/doc/models/site.md similarity index 100% rename from doc/models/site.md rename to legacy/doc/models/site.md diff --git a/doc/models/snippet-response.md b/legacy/doc/models/snippet-response.md similarity index 100% rename from doc/models/snippet-response.md rename to legacy/doc/models/snippet-response.md diff --git a/doc/models/snippet.md b/legacy/doc/models/snippet.md similarity index 100% rename from doc/models/snippet.md rename to legacy/doc/models/snippet.md diff --git a/doc/models/sort-order.md b/legacy/doc/models/sort-order.md similarity index 100% rename from doc/models/sort-order.md rename to legacy/doc/models/sort-order.md diff --git a/doc/models/source-application.md b/legacy/doc/models/source-application.md similarity index 100% rename from doc/models/source-application.md rename to legacy/doc/models/source-application.md diff --git a/doc/models/square-account-details.md b/legacy/doc/models/square-account-details.md similarity index 100% rename from doc/models/square-account-details.md rename to legacy/doc/models/square-account-details.md diff --git a/doc/models/standard-unit-description-group.md b/legacy/doc/models/standard-unit-description-group.md similarity index 100% rename from doc/models/standard-unit-description-group.md rename to legacy/doc/models/standard-unit-description-group.md diff --git a/doc/models/standard-unit-description.md b/legacy/doc/models/standard-unit-description.md similarity index 100% rename from doc/models/standard-unit-description.md rename to legacy/doc/models/standard-unit-description.md diff --git a/doc/models/submit-evidence-response.md b/legacy/doc/models/submit-evidence-response.md similarity index 100% rename from doc/models/submit-evidence-response.md rename to legacy/doc/models/submit-evidence-response.md diff --git a/doc/models/subscription-action-type.md b/legacy/doc/models/subscription-action-type.md similarity index 100% rename from doc/models/subscription-action-type.md rename to legacy/doc/models/subscription-action-type.md diff --git a/doc/models/subscription-action.md b/legacy/doc/models/subscription-action.md similarity index 100% rename from doc/models/subscription-action.md rename to legacy/doc/models/subscription-action.md diff --git a/doc/models/subscription-cadence.md b/legacy/doc/models/subscription-cadence.md similarity index 100% rename from doc/models/subscription-cadence.md rename to legacy/doc/models/subscription-cadence.md diff --git a/doc/models/subscription-event-info-code.md b/legacy/doc/models/subscription-event-info-code.md similarity index 100% rename from doc/models/subscription-event-info-code.md rename to legacy/doc/models/subscription-event-info-code.md diff --git a/doc/models/subscription-event-info.md b/legacy/doc/models/subscription-event-info.md similarity index 100% rename from doc/models/subscription-event-info.md rename to legacy/doc/models/subscription-event-info.md diff --git a/doc/models/subscription-event-subscription-event-type.md b/legacy/doc/models/subscription-event-subscription-event-type.md similarity index 100% rename from doc/models/subscription-event-subscription-event-type.md rename to legacy/doc/models/subscription-event-subscription-event-type.md diff --git a/doc/models/subscription-event.md b/legacy/doc/models/subscription-event.md similarity index 100% rename from doc/models/subscription-event.md rename to legacy/doc/models/subscription-event.md diff --git a/doc/models/subscription-phase.md b/legacy/doc/models/subscription-phase.md similarity index 100% rename from doc/models/subscription-phase.md rename to legacy/doc/models/subscription-phase.md diff --git a/doc/models/subscription-pricing-type.md b/legacy/doc/models/subscription-pricing-type.md similarity index 100% rename from doc/models/subscription-pricing-type.md rename to legacy/doc/models/subscription-pricing-type.md diff --git a/doc/models/subscription-pricing.md b/legacy/doc/models/subscription-pricing.md similarity index 100% rename from doc/models/subscription-pricing.md rename to legacy/doc/models/subscription-pricing.md diff --git a/doc/models/subscription-source.md b/legacy/doc/models/subscription-source.md similarity index 100% rename from doc/models/subscription-source.md rename to legacy/doc/models/subscription-source.md diff --git a/doc/models/subscription-status.md b/legacy/doc/models/subscription-status.md similarity index 100% rename from doc/models/subscription-status.md rename to legacy/doc/models/subscription-status.md diff --git a/doc/models/subscription-test-result.md b/legacy/doc/models/subscription-test-result.md similarity index 100% rename from doc/models/subscription-test-result.md rename to legacy/doc/models/subscription-test-result.md diff --git a/doc/models/subscription.md b/legacy/doc/models/subscription.md similarity index 100% rename from doc/models/subscription.md rename to legacy/doc/models/subscription.md diff --git a/doc/models/swap-plan-request.md b/legacy/doc/models/swap-plan-request.md similarity index 100% rename from doc/models/swap-plan-request.md rename to legacy/doc/models/swap-plan-request.md diff --git a/doc/models/swap-plan-response.md b/legacy/doc/models/swap-plan-response.md similarity index 100% rename from doc/models/swap-plan-response.md rename to legacy/doc/models/swap-plan-response.md diff --git a/doc/models/tax-calculation-phase.md b/legacy/doc/models/tax-calculation-phase.md similarity index 100% rename from doc/models/tax-calculation-phase.md rename to legacy/doc/models/tax-calculation-phase.md diff --git a/doc/models/tax-ids.md b/legacy/doc/models/tax-ids.md similarity index 100% rename from doc/models/tax-ids.md rename to legacy/doc/models/tax-ids.md diff --git a/doc/models/tax-inclusion-type.md b/legacy/doc/models/tax-inclusion-type.md similarity index 100% rename from doc/models/tax-inclusion-type.md rename to legacy/doc/models/tax-inclusion-type.md diff --git a/doc/models/team-member-assigned-locations-assignment-type.md b/legacy/doc/models/team-member-assigned-locations-assignment-type.md similarity index 100% rename from doc/models/team-member-assigned-locations-assignment-type.md rename to legacy/doc/models/team-member-assigned-locations-assignment-type.md diff --git a/doc/models/team-member-assigned-locations.md b/legacy/doc/models/team-member-assigned-locations.md similarity index 100% rename from doc/models/team-member-assigned-locations.md rename to legacy/doc/models/team-member-assigned-locations.md diff --git a/doc/models/team-member-booking-profile.md b/legacy/doc/models/team-member-booking-profile.md similarity index 100% rename from doc/models/team-member-booking-profile.md rename to legacy/doc/models/team-member-booking-profile.md diff --git a/doc/models/team-member-invitation-status.md b/legacy/doc/models/team-member-invitation-status.md similarity index 100% rename from doc/models/team-member-invitation-status.md rename to legacy/doc/models/team-member-invitation-status.md diff --git a/doc/models/team-member-status.md b/legacy/doc/models/team-member-status.md similarity index 100% rename from doc/models/team-member-status.md rename to legacy/doc/models/team-member-status.md diff --git a/doc/models/team-member-wage.md b/legacy/doc/models/team-member-wage.md similarity index 100% rename from doc/models/team-member-wage.md rename to legacy/doc/models/team-member-wage.md diff --git a/doc/models/team-member.md b/legacy/doc/models/team-member.md similarity index 100% rename from doc/models/team-member.md rename to legacy/doc/models/team-member.md diff --git a/doc/models/tender-bank-account-details-status.md b/legacy/doc/models/tender-bank-account-details-status.md similarity index 100% rename from doc/models/tender-bank-account-details-status.md rename to legacy/doc/models/tender-bank-account-details-status.md diff --git a/doc/models/tender-bank-account-details.md b/legacy/doc/models/tender-bank-account-details.md similarity index 100% rename from doc/models/tender-bank-account-details.md rename to legacy/doc/models/tender-bank-account-details.md diff --git a/doc/models/tender-buy-now-pay-later-details-brand.md b/legacy/doc/models/tender-buy-now-pay-later-details-brand.md similarity index 100% rename from doc/models/tender-buy-now-pay-later-details-brand.md rename to legacy/doc/models/tender-buy-now-pay-later-details-brand.md diff --git a/doc/models/tender-buy-now-pay-later-details-status.md b/legacy/doc/models/tender-buy-now-pay-later-details-status.md similarity index 100% rename from doc/models/tender-buy-now-pay-later-details-status.md rename to legacy/doc/models/tender-buy-now-pay-later-details-status.md diff --git a/doc/models/tender-buy-now-pay-later-details.md b/legacy/doc/models/tender-buy-now-pay-later-details.md similarity index 100% rename from doc/models/tender-buy-now-pay-later-details.md rename to legacy/doc/models/tender-buy-now-pay-later-details.md diff --git a/doc/models/tender-card-details-entry-method.md b/legacy/doc/models/tender-card-details-entry-method.md similarity index 100% rename from doc/models/tender-card-details-entry-method.md rename to legacy/doc/models/tender-card-details-entry-method.md diff --git a/doc/models/tender-card-details-status.md b/legacy/doc/models/tender-card-details-status.md similarity index 100% rename from doc/models/tender-card-details-status.md rename to legacy/doc/models/tender-card-details-status.md diff --git a/doc/models/tender-card-details.md b/legacy/doc/models/tender-card-details.md similarity index 100% rename from doc/models/tender-card-details.md rename to legacy/doc/models/tender-card-details.md diff --git a/doc/models/tender-cash-details.md b/legacy/doc/models/tender-cash-details.md similarity index 100% rename from doc/models/tender-cash-details.md rename to legacy/doc/models/tender-cash-details.md diff --git a/doc/models/tender-square-account-details-status.md b/legacy/doc/models/tender-square-account-details-status.md similarity index 100% rename from doc/models/tender-square-account-details-status.md rename to legacy/doc/models/tender-square-account-details-status.md diff --git a/doc/models/tender-square-account-details.md b/legacy/doc/models/tender-square-account-details.md similarity index 100% rename from doc/models/tender-square-account-details.md rename to legacy/doc/models/tender-square-account-details.md diff --git a/doc/models/tender-type.md b/legacy/doc/models/tender-type.md similarity index 100% rename from doc/models/tender-type.md rename to legacy/doc/models/tender-type.md diff --git a/doc/models/tender.md b/legacy/doc/models/tender.md similarity index 100% rename from doc/models/tender.md rename to legacy/doc/models/tender.md diff --git a/doc/models/terminal-action-action-type.md b/legacy/doc/models/terminal-action-action-type.md similarity index 100% rename from doc/models/terminal-action-action-type.md rename to legacy/doc/models/terminal-action-action-type.md diff --git a/doc/models/terminal-action-query-filter.md b/legacy/doc/models/terminal-action-query-filter.md similarity index 100% rename from doc/models/terminal-action-query-filter.md rename to legacy/doc/models/terminal-action-query-filter.md diff --git a/doc/models/terminal-action-query-sort.md b/legacy/doc/models/terminal-action-query-sort.md similarity index 100% rename from doc/models/terminal-action-query-sort.md rename to legacy/doc/models/terminal-action-query-sort.md diff --git a/doc/models/terminal-action-query.md b/legacy/doc/models/terminal-action-query.md similarity index 100% rename from doc/models/terminal-action-query.md rename to legacy/doc/models/terminal-action-query.md diff --git a/doc/models/terminal-action.md b/legacy/doc/models/terminal-action.md similarity index 100% rename from doc/models/terminal-action.md rename to legacy/doc/models/terminal-action.md diff --git a/doc/models/terminal-checkout-query-filter.md b/legacy/doc/models/terminal-checkout-query-filter.md similarity index 100% rename from doc/models/terminal-checkout-query-filter.md rename to legacy/doc/models/terminal-checkout-query-filter.md diff --git a/doc/models/terminal-checkout-query-sort.md b/legacy/doc/models/terminal-checkout-query-sort.md similarity index 100% rename from doc/models/terminal-checkout-query-sort.md rename to legacy/doc/models/terminal-checkout-query-sort.md diff --git a/doc/models/terminal-checkout-query.md b/legacy/doc/models/terminal-checkout-query.md similarity index 100% rename from doc/models/terminal-checkout-query.md rename to legacy/doc/models/terminal-checkout-query.md diff --git a/doc/models/terminal-checkout.md b/legacy/doc/models/terminal-checkout.md similarity index 100% rename from doc/models/terminal-checkout.md rename to legacy/doc/models/terminal-checkout.md diff --git a/doc/models/terminal-refund-query-filter.md b/legacy/doc/models/terminal-refund-query-filter.md similarity index 100% rename from doc/models/terminal-refund-query-filter.md rename to legacy/doc/models/terminal-refund-query-filter.md diff --git a/doc/models/terminal-refund-query-sort.md b/legacy/doc/models/terminal-refund-query-sort.md similarity index 100% rename from doc/models/terminal-refund-query-sort.md rename to legacy/doc/models/terminal-refund-query-sort.md diff --git a/doc/models/terminal-refund-query.md b/legacy/doc/models/terminal-refund-query.md similarity index 100% rename from doc/models/terminal-refund-query.md rename to legacy/doc/models/terminal-refund-query.md diff --git a/doc/models/terminal-refund.md b/legacy/doc/models/terminal-refund.md similarity index 100% rename from doc/models/terminal-refund.md rename to legacy/doc/models/terminal-refund.md diff --git a/doc/models/test-webhook-subscription-request.md b/legacy/doc/models/test-webhook-subscription-request.md similarity index 100% rename from doc/models/test-webhook-subscription-request.md rename to legacy/doc/models/test-webhook-subscription-request.md diff --git a/doc/models/test-webhook-subscription-response.md b/legacy/doc/models/test-webhook-subscription-response.md similarity index 100% rename from doc/models/test-webhook-subscription-response.md rename to legacy/doc/models/test-webhook-subscription-response.md diff --git a/doc/models/time-range.md b/legacy/doc/models/time-range.md similarity index 100% rename from doc/models/time-range.md rename to legacy/doc/models/time-range.md diff --git a/doc/models/tip-settings.md b/legacy/doc/models/tip-settings.md similarity index 100% rename from doc/models/tip-settings.md rename to legacy/doc/models/tip-settings.md diff --git a/doc/models/transaction-product.md b/legacy/doc/models/transaction-product.md similarity index 100% rename from doc/models/transaction-product.md rename to legacy/doc/models/transaction-product.md diff --git a/doc/models/transaction-type.md b/legacy/doc/models/transaction-type.md similarity index 100% rename from doc/models/transaction-type.md rename to legacy/doc/models/transaction-type.md diff --git a/doc/models/transaction.md b/legacy/doc/models/transaction.md similarity index 100% rename from doc/models/transaction.md rename to legacy/doc/models/transaction.md diff --git a/doc/models/unlink-customer-from-gift-card-request.md b/legacy/doc/models/unlink-customer-from-gift-card-request.md similarity index 100% rename from doc/models/unlink-customer-from-gift-card-request.md rename to legacy/doc/models/unlink-customer-from-gift-card-request.md diff --git a/doc/models/unlink-customer-from-gift-card-response.md b/legacy/doc/models/unlink-customer-from-gift-card-response.md similarity index 100% rename from doc/models/unlink-customer-from-gift-card-response.md rename to legacy/doc/models/unlink-customer-from-gift-card-response.md diff --git a/doc/models/update-booking-custom-attribute-definition-request.md b/legacy/doc/models/update-booking-custom-attribute-definition-request.md similarity index 100% rename from doc/models/update-booking-custom-attribute-definition-request.md rename to legacy/doc/models/update-booking-custom-attribute-definition-request.md diff --git a/doc/models/update-booking-custom-attribute-definition-response.md b/legacy/doc/models/update-booking-custom-attribute-definition-response.md similarity index 100% rename from doc/models/update-booking-custom-attribute-definition-response.md rename to legacy/doc/models/update-booking-custom-attribute-definition-response.md diff --git a/doc/models/update-booking-request.md b/legacy/doc/models/update-booking-request.md similarity index 100% rename from doc/models/update-booking-request.md rename to legacy/doc/models/update-booking-request.md diff --git a/doc/models/update-booking-response.md b/legacy/doc/models/update-booking-response.md similarity index 100% rename from doc/models/update-booking-response.md rename to legacy/doc/models/update-booking-response.md diff --git a/doc/models/update-break-type-request.md b/legacy/doc/models/update-break-type-request.md similarity index 100% rename from doc/models/update-break-type-request.md rename to legacy/doc/models/update-break-type-request.md diff --git a/doc/models/update-break-type-response.md b/legacy/doc/models/update-break-type-response.md similarity index 100% rename from doc/models/update-break-type-response.md rename to legacy/doc/models/update-break-type-response.md diff --git a/doc/models/update-catalog-image-request.md b/legacy/doc/models/update-catalog-image-request.md similarity index 100% rename from doc/models/update-catalog-image-request.md rename to legacy/doc/models/update-catalog-image-request.md diff --git a/doc/models/update-catalog-image-response.md b/legacy/doc/models/update-catalog-image-response.md similarity index 100% rename from doc/models/update-catalog-image-response.md rename to legacy/doc/models/update-catalog-image-response.md diff --git a/doc/models/update-customer-custom-attribute-definition-request.md b/legacy/doc/models/update-customer-custom-attribute-definition-request.md similarity index 100% rename from doc/models/update-customer-custom-attribute-definition-request.md rename to legacy/doc/models/update-customer-custom-attribute-definition-request.md diff --git a/doc/models/update-customer-custom-attribute-definition-response.md b/legacy/doc/models/update-customer-custom-attribute-definition-response.md similarity index 100% rename from doc/models/update-customer-custom-attribute-definition-response.md rename to legacy/doc/models/update-customer-custom-attribute-definition-response.md diff --git a/doc/models/update-customer-group-request.md b/legacy/doc/models/update-customer-group-request.md similarity index 100% rename from doc/models/update-customer-group-request.md rename to legacy/doc/models/update-customer-group-request.md diff --git a/doc/models/update-customer-group-response.md b/legacy/doc/models/update-customer-group-response.md similarity index 100% rename from doc/models/update-customer-group-response.md rename to legacy/doc/models/update-customer-group-response.md diff --git a/doc/models/update-customer-request.md b/legacy/doc/models/update-customer-request.md similarity index 100% rename from doc/models/update-customer-request.md rename to legacy/doc/models/update-customer-request.md diff --git a/doc/models/update-customer-response.md b/legacy/doc/models/update-customer-response.md similarity index 100% rename from doc/models/update-customer-response.md rename to legacy/doc/models/update-customer-response.md diff --git a/doc/models/update-invoice-request.md b/legacy/doc/models/update-invoice-request.md similarity index 100% rename from doc/models/update-invoice-request.md rename to legacy/doc/models/update-invoice-request.md diff --git a/doc/models/update-invoice-response.md b/legacy/doc/models/update-invoice-response.md similarity index 100% rename from doc/models/update-invoice-response.md rename to legacy/doc/models/update-invoice-response.md diff --git a/doc/models/update-item-modifier-lists-request.md b/legacy/doc/models/update-item-modifier-lists-request.md similarity index 100% rename from doc/models/update-item-modifier-lists-request.md rename to legacy/doc/models/update-item-modifier-lists-request.md diff --git a/doc/models/update-item-modifier-lists-response.md b/legacy/doc/models/update-item-modifier-lists-response.md similarity index 100% rename from doc/models/update-item-modifier-lists-response.md rename to legacy/doc/models/update-item-modifier-lists-response.md diff --git a/doc/models/update-item-taxes-request.md b/legacy/doc/models/update-item-taxes-request.md similarity index 100% rename from doc/models/update-item-taxes-request.md rename to legacy/doc/models/update-item-taxes-request.md diff --git a/doc/models/update-item-taxes-response.md b/legacy/doc/models/update-item-taxes-response.md similarity index 100% rename from doc/models/update-item-taxes-response.md rename to legacy/doc/models/update-item-taxes-response.md diff --git a/doc/models/update-job-request.md b/legacy/doc/models/update-job-request.md similarity index 100% rename from doc/models/update-job-request.md rename to legacy/doc/models/update-job-request.md diff --git a/doc/models/update-job-response.md b/legacy/doc/models/update-job-response.md similarity index 100% rename from doc/models/update-job-response.md rename to legacy/doc/models/update-job-response.md diff --git a/doc/models/update-location-custom-attribute-definition-request.md b/legacy/doc/models/update-location-custom-attribute-definition-request.md similarity index 100% rename from doc/models/update-location-custom-attribute-definition-request.md rename to legacy/doc/models/update-location-custom-attribute-definition-request.md diff --git a/doc/models/update-location-custom-attribute-definition-response.md b/legacy/doc/models/update-location-custom-attribute-definition-response.md similarity index 100% rename from doc/models/update-location-custom-attribute-definition-response.md rename to legacy/doc/models/update-location-custom-attribute-definition-response.md diff --git a/doc/models/update-location-request.md b/legacy/doc/models/update-location-request.md similarity index 100% rename from doc/models/update-location-request.md rename to legacy/doc/models/update-location-request.md diff --git a/doc/models/update-location-response.md b/legacy/doc/models/update-location-response.md similarity index 100% rename from doc/models/update-location-response.md rename to legacy/doc/models/update-location-response.md diff --git a/doc/models/update-location-settings-request.md b/legacy/doc/models/update-location-settings-request.md similarity index 100% rename from doc/models/update-location-settings-request.md rename to legacy/doc/models/update-location-settings-request.md diff --git a/doc/models/update-location-settings-response.md b/legacy/doc/models/update-location-settings-response.md similarity index 100% rename from doc/models/update-location-settings-response.md rename to legacy/doc/models/update-location-settings-response.md diff --git a/doc/models/update-merchant-custom-attribute-definition-request.md b/legacy/doc/models/update-merchant-custom-attribute-definition-request.md similarity index 100% rename from doc/models/update-merchant-custom-attribute-definition-request.md rename to legacy/doc/models/update-merchant-custom-attribute-definition-request.md diff --git a/doc/models/update-merchant-custom-attribute-definition-response.md b/legacy/doc/models/update-merchant-custom-attribute-definition-response.md similarity index 100% rename from doc/models/update-merchant-custom-attribute-definition-response.md rename to legacy/doc/models/update-merchant-custom-attribute-definition-response.md diff --git a/doc/models/update-merchant-settings-request.md b/legacy/doc/models/update-merchant-settings-request.md similarity index 100% rename from doc/models/update-merchant-settings-request.md rename to legacy/doc/models/update-merchant-settings-request.md diff --git a/doc/models/update-merchant-settings-response.md b/legacy/doc/models/update-merchant-settings-response.md similarity index 100% rename from doc/models/update-merchant-settings-response.md rename to legacy/doc/models/update-merchant-settings-response.md diff --git a/doc/models/update-order-custom-attribute-definition-request.md b/legacy/doc/models/update-order-custom-attribute-definition-request.md similarity index 100% rename from doc/models/update-order-custom-attribute-definition-request.md rename to legacy/doc/models/update-order-custom-attribute-definition-request.md diff --git a/doc/models/update-order-custom-attribute-definition-response.md b/legacy/doc/models/update-order-custom-attribute-definition-response.md similarity index 100% rename from doc/models/update-order-custom-attribute-definition-response.md rename to legacy/doc/models/update-order-custom-attribute-definition-response.md diff --git a/doc/models/update-order-request.md b/legacy/doc/models/update-order-request.md similarity index 100% rename from doc/models/update-order-request.md rename to legacy/doc/models/update-order-request.md diff --git a/doc/models/update-order-response.md b/legacy/doc/models/update-order-response.md similarity index 100% rename from doc/models/update-order-response.md rename to legacy/doc/models/update-order-response.md diff --git a/doc/models/update-payment-link-request.md b/legacy/doc/models/update-payment-link-request.md similarity index 100% rename from doc/models/update-payment-link-request.md rename to legacy/doc/models/update-payment-link-request.md diff --git a/doc/models/update-payment-link-response.md b/legacy/doc/models/update-payment-link-response.md similarity index 100% rename from doc/models/update-payment-link-response.md rename to legacy/doc/models/update-payment-link-response.md diff --git a/doc/models/update-payment-request.md b/legacy/doc/models/update-payment-request.md similarity index 100% rename from doc/models/update-payment-request.md rename to legacy/doc/models/update-payment-request.md diff --git a/doc/models/update-payment-response.md b/legacy/doc/models/update-payment-response.md similarity index 100% rename from doc/models/update-payment-response.md rename to legacy/doc/models/update-payment-response.md diff --git a/doc/models/update-shift-request.md b/legacy/doc/models/update-shift-request.md similarity index 100% rename from doc/models/update-shift-request.md rename to legacy/doc/models/update-shift-request.md diff --git a/doc/models/update-shift-response.md b/legacy/doc/models/update-shift-response.md similarity index 100% rename from doc/models/update-shift-response.md rename to legacy/doc/models/update-shift-response.md diff --git a/doc/models/update-subscription-request.md b/legacy/doc/models/update-subscription-request.md similarity index 100% rename from doc/models/update-subscription-request.md rename to legacy/doc/models/update-subscription-request.md diff --git a/doc/models/update-subscription-response.md b/legacy/doc/models/update-subscription-response.md similarity index 100% rename from doc/models/update-subscription-response.md rename to legacy/doc/models/update-subscription-response.md diff --git a/doc/models/update-team-member-request.md b/legacy/doc/models/update-team-member-request.md similarity index 100% rename from doc/models/update-team-member-request.md rename to legacy/doc/models/update-team-member-request.md diff --git a/doc/models/update-team-member-response.md b/legacy/doc/models/update-team-member-response.md similarity index 100% rename from doc/models/update-team-member-response.md rename to legacy/doc/models/update-team-member-response.md diff --git a/doc/models/update-vendor-request.md b/legacy/doc/models/update-vendor-request.md similarity index 100% rename from doc/models/update-vendor-request.md rename to legacy/doc/models/update-vendor-request.md diff --git a/doc/models/update-vendor-response.md b/legacy/doc/models/update-vendor-response.md similarity index 100% rename from doc/models/update-vendor-response.md rename to legacy/doc/models/update-vendor-response.md diff --git a/doc/models/update-wage-setting-request.md b/legacy/doc/models/update-wage-setting-request.md similarity index 100% rename from doc/models/update-wage-setting-request.md rename to legacy/doc/models/update-wage-setting-request.md diff --git a/doc/models/update-wage-setting-response.md b/legacy/doc/models/update-wage-setting-response.md similarity index 100% rename from doc/models/update-wage-setting-response.md rename to legacy/doc/models/update-wage-setting-response.md diff --git a/doc/models/update-webhook-subscription-request.md b/legacy/doc/models/update-webhook-subscription-request.md similarity index 100% rename from doc/models/update-webhook-subscription-request.md rename to legacy/doc/models/update-webhook-subscription-request.md diff --git a/doc/models/update-webhook-subscription-response.md b/legacy/doc/models/update-webhook-subscription-response.md similarity index 100% rename from doc/models/update-webhook-subscription-response.md rename to legacy/doc/models/update-webhook-subscription-response.md diff --git a/doc/models/update-webhook-subscription-signature-key-request.md b/legacy/doc/models/update-webhook-subscription-signature-key-request.md similarity index 100% rename from doc/models/update-webhook-subscription-signature-key-request.md rename to legacy/doc/models/update-webhook-subscription-signature-key-request.md diff --git a/doc/models/update-webhook-subscription-signature-key-response.md b/legacy/doc/models/update-webhook-subscription-signature-key-response.md similarity index 100% rename from doc/models/update-webhook-subscription-signature-key-response.md rename to legacy/doc/models/update-webhook-subscription-signature-key-response.md diff --git a/doc/models/update-workweek-config-request.md b/legacy/doc/models/update-workweek-config-request.md similarity index 100% rename from doc/models/update-workweek-config-request.md rename to legacy/doc/models/update-workweek-config-request.md diff --git a/doc/models/update-workweek-config-response.md b/legacy/doc/models/update-workweek-config-response.md similarity index 100% rename from doc/models/update-workweek-config-response.md rename to legacy/doc/models/update-workweek-config-response.md diff --git a/doc/models/upsert-booking-custom-attribute-request.md b/legacy/doc/models/upsert-booking-custom-attribute-request.md similarity index 100% rename from doc/models/upsert-booking-custom-attribute-request.md rename to legacy/doc/models/upsert-booking-custom-attribute-request.md diff --git a/doc/models/upsert-booking-custom-attribute-response.md b/legacy/doc/models/upsert-booking-custom-attribute-response.md similarity index 100% rename from doc/models/upsert-booking-custom-attribute-response.md rename to legacy/doc/models/upsert-booking-custom-attribute-response.md diff --git a/doc/models/upsert-catalog-object-request.md b/legacy/doc/models/upsert-catalog-object-request.md similarity index 100% rename from doc/models/upsert-catalog-object-request.md rename to legacy/doc/models/upsert-catalog-object-request.md diff --git a/doc/models/upsert-catalog-object-response.md b/legacy/doc/models/upsert-catalog-object-response.md similarity index 100% rename from doc/models/upsert-catalog-object-response.md rename to legacy/doc/models/upsert-catalog-object-response.md diff --git a/doc/models/upsert-customer-custom-attribute-request.md b/legacy/doc/models/upsert-customer-custom-attribute-request.md similarity index 100% rename from doc/models/upsert-customer-custom-attribute-request.md rename to legacy/doc/models/upsert-customer-custom-attribute-request.md diff --git a/doc/models/upsert-customer-custom-attribute-response.md b/legacy/doc/models/upsert-customer-custom-attribute-response.md similarity index 100% rename from doc/models/upsert-customer-custom-attribute-response.md rename to legacy/doc/models/upsert-customer-custom-attribute-response.md diff --git a/doc/models/upsert-location-custom-attribute-request.md b/legacy/doc/models/upsert-location-custom-attribute-request.md similarity index 100% rename from doc/models/upsert-location-custom-attribute-request.md rename to legacy/doc/models/upsert-location-custom-attribute-request.md diff --git a/doc/models/upsert-location-custom-attribute-response.md b/legacy/doc/models/upsert-location-custom-attribute-response.md similarity index 100% rename from doc/models/upsert-location-custom-attribute-response.md rename to legacy/doc/models/upsert-location-custom-attribute-response.md diff --git a/doc/models/upsert-merchant-custom-attribute-request.md b/legacy/doc/models/upsert-merchant-custom-attribute-request.md similarity index 100% rename from doc/models/upsert-merchant-custom-attribute-request.md rename to legacy/doc/models/upsert-merchant-custom-attribute-request.md diff --git a/doc/models/upsert-merchant-custom-attribute-response.md b/legacy/doc/models/upsert-merchant-custom-attribute-response.md similarity index 100% rename from doc/models/upsert-merchant-custom-attribute-response.md rename to legacy/doc/models/upsert-merchant-custom-attribute-response.md diff --git a/doc/models/upsert-order-custom-attribute-request.md b/legacy/doc/models/upsert-order-custom-attribute-request.md similarity index 100% rename from doc/models/upsert-order-custom-attribute-request.md rename to legacy/doc/models/upsert-order-custom-attribute-request.md diff --git a/doc/models/upsert-order-custom-attribute-response.md b/legacy/doc/models/upsert-order-custom-attribute-response.md similarity index 100% rename from doc/models/upsert-order-custom-attribute-response.md rename to legacy/doc/models/upsert-order-custom-attribute-response.md diff --git a/doc/models/upsert-snippet-request.md b/legacy/doc/models/upsert-snippet-request.md similarity index 100% rename from doc/models/upsert-snippet-request.md rename to legacy/doc/models/upsert-snippet-request.md diff --git a/doc/models/upsert-snippet-response.md b/legacy/doc/models/upsert-snippet-response.md similarity index 100% rename from doc/models/upsert-snippet-response.md rename to legacy/doc/models/upsert-snippet-response.md diff --git a/doc/models/v1-device.md b/legacy/doc/models/v1-device.md similarity index 100% rename from doc/models/v1-device.md rename to legacy/doc/models/v1-device.md diff --git a/doc/models/v1-list-orders-request.md b/legacy/doc/models/v1-list-orders-request.md similarity index 100% rename from doc/models/v1-list-orders-request.md rename to legacy/doc/models/v1-list-orders-request.md diff --git a/doc/models/v1-list-orders-response.md b/legacy/doc/models/v1-list-orders-response.md similarity index 100% rename from doc/models/v1-list-orders-response.md rename to legacy/doc/models/v1-list-orders-response.md diff --git a/doc/models/v1-money.md b/legacy/doc/models/v1-money.md similarity index 100% rename from doc/models/v1-money.md rename to legacy/doc/models/v1-money.md diff --git a/doc/models/v1-order-history-entry-action.md b/legacy/doc/models/v1-order-history-entry-action.md similarity index 100% rename from doc/models/v1-order-history-entry-action.md rename to legacy/doc/models/v1-order-history-entry-action.md diff --git a/doc/models/v1-order-history-entry.md b/legacy/doc/models/v1-order-history-entry.md similarity index 100% rename from doc/models/v1-order-history-entry.md rename to legacy/doc/models/v1-order-history-entry.md diff --git a/doc/models/v1-order-state.md b/legacy/doc/models/v1-order-state.md similarity index 100% rename from doc/models/v1-order-state.md rename to legacy/doc/models/v1-order-state.md diff --git a/doc/models/v1-order.md b/legacy/doc/models/v1-order.md similarity index 100% rename from doc/models/v1-order.md rename to legacy/doc/models/v1-order.md diff --git a/doc/models/v1-phone-number.md b/legacy/doc/models/v1-phone-number.md similarity index 100% rename from doc/models/v1-phone-number.md rename to legacy/doc/models/v1-phone-number.md diff --git a/doc/models/v1-tender-card-brand.md b/legacy/doc/models/v1-tender-card-brand.md similarity index 100% rename from doc/models/v1-tender-card-brand.md rename to legacy/doc/models/v1-tender-card-brand.md diff --git a/doc/models/v1-tender-entry-method.md b/legacy/doc/models/v1-tender-entry-method.md similarity index 100% rename from doc/models/v1-tender-entry-method.md rename to legacy/doc/models/v1-tender-entry-method.md diff --git a/doc/models/v1-tender-type.md b/legacy/doc/models/v1-tender-type.md similarity index 100% rename from doc/models/v1-tender-type.md rename to legacy/doc/models/v1-tender-type.md diff --git a/doc/models/v1-tender.md b/legacy/doc/models/v1-tender.md similarity index 100% rename from doc/models/v1-tender.md rename to legacy/doc/models/v1-tender.md diff --git a/doc/models/v1-update-order-request-action.md b/legacy/doc/models/v1-update-order-request-action.md similarity index 100% rename from doc/models/v1-update-order-request-action.md rename to legacy/doc/models/v1-update-order-request-action.md diff --git a/doc/models/v1-update-order-request.md b/legacy/doc/models/v1-update-order-request.md similarity index 100% rename from doc/models/v1-update-order-request.md rename to legacy/doc/models/v1-update-order-request.md diff --git a/doc/models/vendor-contact.md b/legacy/doc/models/vendor-contact.md similarity index 100% rename from doc/models/vendor-contact.md rename to legacy/doc/models/vendor-contact.md diff --git a/doc/models/vendor-status.md b/legacy/doc/models/vendor-status.md similarity index 100% rename from doc/models/vendor-status.md rename to legacy/doc/models/vendor-status.md diff --git a/doc/models/vendor.md b/legacy/doc/models/vendor.md similarity index 100% rename from doc/models/vendor.md rename to legacy/doc/models/vendor.md diff --git a/doc/models/visibility-filter.md b/legacy/doc/models/visibility-filter.md similarity index 100% rename from doc/models/visibility-filter.md rename to legacy/doc/models/visibility-filter.md diff --git a/doc/models/void-transaction-response.md b/legacy/doc/models/void-transaction-response.md similarity index 100% rename from doc/models/void-transaction-response.md rename to legacy/doc/models/void-transaction-response.md diff --git a/doc/models/wage-setting.md b/legacy/doc/models/wage-setting.md similarity index 100% rename from doc/models/wage-setting.md rename to legacy/doc/models/wage-setting.md diff --git a/doc/models/webhook-subscription.md b/legacy/doc/models/webhook-subscription.md similarity index 100% rename from doc/models/webhook-subscription.md rename to legacy/doc/models/webhook-subscription.md diff --git a/doc/models/weekday.md b/legacy/doc/models/weekday.md similarity index 100% rename from doc/models/weekday.md rename to legacy/doc/models/weekday.md diff --git a/doc/models/workweek-config.md b/legacy/doc/models/workweek-config.md similarity index 100% rename from doc/models/workweek-config.md rename to legacy/doc/models/workweek-config.md diff --git a/doc/utility-classes.md b/legacy/doc/utility-classes.md similarity index 100% rename from doc/utility-classes.md rename to legacy/doc/utility-classes.md diff --git a/examples/customers_delete.py b/legacy/examples/customers_delete.py similarity index 74% rename from examples/customers_delete.py rename to legacy/examples/customers_delete.py index 35a3f70a..3c82291f 100644 --- a/examples/customers_delete.py +++ b/legacy/examples/customers_delete.py @@ -1,5 +1,5 @@ -from square.client import Client -from square.configuration import Configuration +from square_legacy.client import Client +from square_legacy.configuration import Configuration client = Client( diff --git a/examples/customers_list.py b/legacy/examples/customers_list.py similarity index 68% rename from examples/customers_list.py rename to legacy/examples/customers_list.py index 1740e929..1f0a954c 100644 --- a/examples/customers_list.py +++ b/legacy/examples/customers_list.py @@ -1,5 +1,5 @@ -from square.client import Client -from square.configuration import Configuration +from square_legacy.client import Client +from square_legacy.configuration import Configuration client = Client( diff --git a/legacy/poetry.lock b/legacy/poetry.lock new file mode 100644 index 00000000..ef812de4 --- /dev/null +++ b/legacy/poetry.lock @@ -0,0 +1,645 @@ +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. + +[[package]] +name = "apimatic-core" +version = "0.2.19" +description = "A library that contains core logic and utilities for consuming REST APIs using Python SDKs generated by APIMatic." +optional = false +python-versions = "*" +files = [ + {file = "apimatic_core-0.2.19-py3-none-any.whl", hash = "sha256:9f9f2c15ee290a3fc81939b40b4a96648358787feab003212ec80c1f100dbcd8"}, + {file = "apimatic_core-0.2.19.tar.gz", hash = "sha256:42aab56a20ab6dc5d33f5343f77b3ab7849d765520363451a114e842080a7266"}, +] + +[package.dependencies] +apimatic-core-interfaces = ">=0.1.0,<0.2.0" +jsonpickle = ">=3.3.0,<3.4.0" +jsonpointer = ">=2.3,<3.0" +python-dateutil = ">=2.8,<3.0" +requests = ">=2.31,<3.0" +setuptools = ">=68.0.0" + +[[package]] +name = "apimatic-core-interfaces" +version = "0.1.6" +description = "An abstract layer of the functionalities provided by apimatic-core-library, requests-client-adapter and APIMatic SDKs." +optional = false +python-versions = "*" +files = [ + {file = "apimatic_core_interfaces-0.1.6-py3-none-any.whl", hash = "sha256:c739222f562b477d5ae0d41ba85c3622325cf6720593b95b8242fa1596a63afe"}, + {file = "apimatic_core_interfaces-0.1.6.tar.gz", hash = "sha256:786b6a564d6005b0040581dba2c8e28286c19e29096970dfcac025c0e12327c8"}, +] + +[[package]] +name = "apimatic-requests-client-adapter" +version = "0.1.7" +description = "An adapter for requests client library consumed by the SDKs generated with APIMatic" +optional = false +python-versions = "*" +files = [ + {file = "apimatic_requests_client_adapter-0.1.7-py3-none-any.whl", hash = "sha256:47e1fa946f14d4cdd029b8a66d2a4abcbd8fd1fda5355eb8e702be8e105523f1"}, + {file = "apimatic_requests_client_adapter-0.1.7.tar.gz", hash = "sha256:a6215a63c39885f390c0c91f1ac023e60f0c8ae958f72ba903ede5ed2bcf4a2e"}, +] + +[package.dependencies] +apimatic-core-interfaces = ">=0.1.0,<0.2.0" +cachecontrol = ">=0.12.6,<0.13.0" +requests = ">=2.31,<3.0" + +[[package]] +name = "cachecontrol" +version = "0.12.14" +description = "httplib2 caching for requests" +optional = false +python-versions = ">=3.6" +files = [ + {file = "CacheControl-0.12.14-py2.py3-none-any.whl", hash = "sha256:1c2939be362a70c4e5f02c6249462b3b7a24441e4f1ced5e9ef028172edf356a"}, + {file = "CacheControl-0.12.14.tar.gz", hash = "sha256:d1087f45781c0e00616479bfd282c78504371ca71da017b49df9f5365a95feba"}, +] + +[package.dependencies] +msgpack = ">=0.5.2" +requests = "*" + +[package.extras] +filecache = ["lockfile (>=0.9)"] +redis = ["redis (>=2.10.5)"] + +[[package]] +name = "certifi" +version = "2025.1.31" +description = "Python package for providing Mozilla's CA Bundle." +optional = false +python-versions = ">=3.6" +files = [ + {file = "certifi-2025.1.31-py3-none-any.whl", hash = "sha256:ca78db4565a652026a4db2bcdf68f2fb589ea80d0be70e03929ed730746b84fe"}, + {file = "certifi-2025.1.31.tar.gz", hash = "sha256:3d5da6925056f6f18f119200434a4780a94263f10d1c21d032a6f6b2baa20651"}, +] + +[[package]] +name = "charset-normalizer" +version = "3.4.1" +description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." +optional = false +python-versions = ">=3.7" +files = [ + {file = "charset_normalizer-3.4.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:91b36a978b5ae0ee86c394f5a54d6ef44db1de0815eb43de826d41d21e4af3de"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7461baadb4dc00fd9e0acbe254e3d7d2112e7f92ced2adc96e54ef6501c5f176"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e218488cd232553829be0664c2292d3af2eeeb94b32bea483cf79ac6a694e037"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:80ed5e856eb7f30115aaf94e4a08114ccc8813e6ed1b5efa74f9f82e8509858f"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b010a7a4fd316c3c484d482922d13044979e78d1861f0e0650423144c616a46a"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4532bff1b8421fd0a320463030c7520f56a79c9024a4e88f01c537316019005a"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:d973f03c0cb71c5ed99037b870f2be986c3c05e63622c017ea9816881d2dd247"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:3a3bd0dcd373514dcec91c411ddb9632c0d7d92aed7093b8c3bbb6d69ca74408"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:d9c3cdf5390dcd29aa8056d13e8e99526cda0305acc038b96b30352aff5ff2bb"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:2bdfe3ac2e1bbe5b59a1a63721eb3b95fc9b6817ae4a46debbb4e11f6232428d"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:eab677309cdb30d047996b36d34caeda1dc91149e4fdca0b1a039b3f79d9a807"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-win32.whl", hash = "sha256:c0429126cf75e16c4f0ad00ee0eae4242dc652290f940152ca8c75c3a4b6ee8f"}, + {file = "charset_normalizer-3.4.1-cp310-cp310-win_amd64.whl", hash = "sha256:9f0b8b1c6d84c8034a44893aba5e767bf9c7a211e313a9605d9c617d7083829f"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:8bfa33f4f2672964266e940dd22a195989ba31669bd84629f05fab3ef4e2d125"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:28bf57629c75e810b6ae989f03c0828d64d6b26a5e205535585f96093e405ed1"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f08ff5e948271dc7e18a35641d2f11a4cd8dfd5634f55228b691e62b37125eb3"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:234ac59ea147c59ee4da87a0c0f098e9c8d169f4dc2a159ef720f1a61bbe27cd"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fd4ec41f914fa74ad1b8304bbc634b3de73d2a0889bd32076342a573e0779e00"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eea6ee1db730b3483adf394ea72f808b6e18cf3cb6454b4d86e04fa8c4327a12"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:c96836c97b1238e9c9e3fe90844c947d5afbf4f4c92762679acfe19927d81d77"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:4d86f7aff21ee58f26dcf5ae81a9addbd914115cdebcbb2217e4f0ed8982e146"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:09b5e6733cbd160dcc09589227187e242a30a49ca5cefa5a7edd3f9d19ed53fd"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:5777ee0881f9499ed0f71cc82cf873d9a0ca8af166dfa0af8ec4e675b7df48e6"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:237bdbe6159cff53b4f24f397d43c6336c6b0b42affbe857970cefbb620911c8"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-win32.whl", hash = "sha256:8417cb1f36cc0bc7eaba8ccb0e04d55f0ee52df06df3ad55259b9a323555fc8b"}, + {file = "charset_normalizer-3.4.1-cp311-cp311-win_amd64.whl", hash = "sha256:d7f50a1f8c450f3925cb367d011448c39239bb3eb4117c36a6d354794de4ce76"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:73d94b58ec7fecbc7366247d3b0b10a21681004153238750bb67bd9012414545"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dad3e487649f498dd991eeb901125411559b22e8d7ab25d3aeb1af367df5efd7"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c30197aa96e8eed02200a83fba2657b4c3acd0f0aa4bdc9f6c1af8e8962e0757"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2369eea1ee4a7610a860d88f268eb39b95cb588acd7235e02fd5a5601773d4fa"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc2722592d8998c870fa4e290c2eec2c1569b87fe58618e67d38b4665dfa680d"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffc9202a29ab3920fa812879e95a9e78b2465fd10be7fcbd042899695d75e616"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:804a4d582ba6e5b747c625bf1255e6b1507465494a40a2130978bda7b932c90b"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0f55e69f030f7163dffe9fd0752b32f070566451afe180f99dbeeb81f511ad8d"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c4c3e6da02df6fa1410a7680bd3f63d4f710232d3139089536310d027950696a"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:5df196eb874dae23dcfb968c83d4f8fdccb333330fe1fc278ac5ceeb101003a9"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e358e64305fe12299a08e08978f51fc21fac060dcfcddd95453eabe5b93ed0e1"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-win32.whl", hash = "sha256:9b23ca7ef998bc739bf6ffc077c2116917eabcc901f88da1b9856b210ef63f35"}, + {file = "charset_normalizer-3.4.1-cp312-cp312-win_amd64.whl", hash = "sha256:6ff8a4a60c227ad87030d76e99cd1698345d4491638dfa6673027c48b3cd395f"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:aabfa34badd18f1da5ec1bc2715cadc8dca465868a4e73a0173466b688f29dda"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22e14b5d70560b8dd51ec22863f370d1e595ac3d024cb8ad7d308b4cd95f8313"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8436c508b408b82d87dc5f62496973a1805cd46727c34440b0d29d8a2f50a6c9"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2d074908e1aecee37a7635990b2c6d504cd4766c7bc9fc86d63f9c09af3fa11b"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:955f8851919303c92343d2f66165294848d57e9bba6cf6e3625485a70a038d11"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:44ecbf16649486d4aebafeaa7ec4c9fed8b88101f4dd612dcaf65d5e815f837f"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:0924e81d3d5e70f8126529951dac65c1010cdf117bb75eb02dd12339b57749dd"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:2967f74ad52c3b98de4c3b32e1a44e32975e008a9cd2a8cc8966d6a5218c5cb2"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:c75cb2a3e389853835e84a2d8fb2b81a10645b503eca9bcb98df6b5a43eb8886"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:09b26ae6b1abf0d27570633b2b078a2a20419c99d66fb2823173d73f188ce601"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:fa88b843d6e211393a37219e6a1c1df99d35e8fd90446f1118f4216e307e48cd"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-win32.whl", hash = "sha256:eb8178fe3dba6450a3e024e95ac49ed3400e506fd4e9e5c32d30adda88cbd407"}, + {file = "charset_normalizer-3.4.1-cp313-cp313-win_amd64.whl", hash = "sha256:b1ac5992a838106edb89654e0aebfc24f5848ae2547d22c2c3f66454daa11971"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f30bf9fd9be89ecb2360c7d94a711f00c09b976258846efe40db3d05828e8089"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:97f68b8d6831127e4787ad15e6757232e14e12060bec17091b85eb1486b91d8d"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7974a0b5ecd505609e3b19742b60cee7aa2aa2fb3151bc917e6e2646d7667dcf"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fc54db6c8593ef7d4b2a331b58653356cf04f67c960f584edb7c3d8c97e8f39e"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:311f30128d7d333eebd7896965bfcfbd0065f1716ec92bd5638d7748eb6f936a"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_aarch64.whl", hash = "sha256:7d053096f67cd1241601111b698f5cad775f97ab25d81567d3f59219b5f1adbd"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_i686.whl", hash = "sha256:807f52c1f798eef6cf26beb819eeb8819b1622ddfeef9d0977a8502d4db6d534"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_ppc64le.whl", hash = "sha256:dccbe65bd2f7f7ec22c4ff99ed56faa1e9f785482b9bbd7c717e26fd723a1d1e"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_s390x.whl", hash = "sha256:2fb9bd477fdea8684f78791a6de97a953c51831ee2981f8e4f583ff3b9d9687e"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-musllinux_1_2_x86_64.whl", hash = "sha256:01732659ba9b5b873fc117534143e4feefecf3b2078b0a6a2e925271bb6f4cfa"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-win32.whl", hash = "sha256:7a4f97a081603d2050bfaffdefa5b02a9ec823f8348a572e39032caa8404a487"}, + {file = "charset_normalizer-3.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:7b1bef6280950ee6c177b326508f86cad7ad4dff12454483b51d8b7d673a2c5d"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:ecddf25bee22fe4fe3737a399d0d177d72bc22be6913acfab364b40bce1ba83c"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c60ca7339acd497a55b0ea5d506b2a2612afb2826560416f6894e8b5770d4a9"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b7b2d86dd06bfc2ade3312a83a5c364c7ec2e3498f8734282c6c3d4b07b346b8"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dd78cfcda14a1ef52584dbb008f7ac81c1328c0f58184bf9a84c49c605002da6"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e27f48bcd0957c6d4cb9d6fa6b61d192d0b13d5ef563e5f2ae35feafc0d179c"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:01ad647cdd609225c5350561d084b42ddf732f4eeefe6e678765636791e78b9a"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:619a609aa74ae43d90ed2e89bdd784765de0a25ca761b93e196d938b8fd1dbbd"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:89149166622f4db9b4b6a449256291dc87a99ee53151c74cbd82a53c8c2f6ccd"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:7709f51f5f7c853f0fb938bcd3bc59cdfdc5203635ffd18bf354f6967ea0f824"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:345b0426edd4e18138d6528aed636de7a9ed169b4aaf9d61a8c19e39d26838ca"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:0907f11d019260cdc3f94fbdb23ff9125f6b5d1039b76003b5b0ac9d6a6c9d5b"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-win32.whl", hash = "sha256:ea0d8d539afa5eb2728aa1932a988a9a7af94f18582ffae4bc10b3fbdad0626e"}, + {file = "charset_normalizer-3.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:329ce159e82018d646c7ac45b01a430369d526569ec08516081727a20e9e4af4"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:b97e690a2118911e39b4042088092771b4ae3fc3aa86518f84b8cf6888dbdb41"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:78baa6d91634dfb69ec52a463534bc0df05dbd546209b79a3880a34487f4b84f"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1a2bc9f351a75ef49d664206d51f8e5ede9da246602dc2d2726837620ea034b2"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:75832c08354f595c760a804588b9357d34ec00ba1c940c15e31e96d902093770"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0af291f4fe114be0280cdd29d533696a77b5b49cfde5467176ecab32353395c4"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0167ddc8ab6508fe81860a57dd472b2ef4060e8d378f0cc555707126830f2537"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:2a75d49014d118e4198bcee5ee0a6f25856b29b12dbf7cd012791f8a6cc5c496"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:363e2f92b0f0174b2f8238240a1a30142e3db7b957a5dd5689b0e75fb717cc78"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:ab36c8eb7e454e34e60eb55ca5d241a5d18b2c6244f6827a30e451c42410b5f7"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:4c0907b1928a36d5a998d72d64d8eaa7244989f7aaaf947500d3a800c83a3fd6"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:04432ad9479fa40ec0f387795ddad4437a2b50417c69fa275e212933519ff294"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-win32.whl", hash = "sha256:3bed14e9c89dcb10e8f3a29f9ccac4955aebe93c71ae803af79265c9ca5644c5"}, + {file = "charset_normalizer-3.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:49402233c892a461407c512a19435d1ce275543138294f7ef013f0b63d5d3765"}, + {file = "charset_normalizer-3.4.1-py3-none-any.whl", hash = "sha256:d98b1668f06378c6dbefec3b92299716b931cd4e6061f3c875a71ced1780ab85"}, + {file = "charset_normalizer-3.4.1.tar.gz", hash = "sha256:44251f18cd68a75b56585dd00dae26183e102cd5e0f9f1466e6df5da2ed64ea3"}, +] + +[[package]] +name = "colorama" +version = "0.4.6" +description = "Cross-platform colored terminal text." +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +files = [ + {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, + {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, +] + +[[package]] +name = "deprecation" +version = "2.1.0" +description = "A library to handle automated deprecations" +optional = false +python-versions = "*" +files = [ + {file = "deprecation-2.1.0-py2.py3-none-any.whl", hash = "sha256:a10811591210e1fb0e768a8c25517cabeabcba6f0bf96564f8ff45189f90b14a"}, + {file = "deprecation-2.1.0.tar.gz", hash = "sha256:72b3bde64e5d778694b0cf68178aed03d15e15477116add3fb773e581f9518ff"}, +] + +[package.dependencies] +packaging = "*" + +[[package]] +name = "exceptiongroup" +version = "1.2.2" +description = "Backport of PEP 654 (exception groups)" +optional = false +python-versions = ">=3.7" +files = [ + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, +] + +[package.extras] +test = ["pytest (>=6)"] + +[[package]] +name = "idna" +version = "3.10" +description = "Internationalized Domain Names in Applications (IDNA)" +optional = false +python-versions = ">=3.6" +files = [ + {file = "idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3"}, + {file = "idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9"}, +] + +[package.extras] +all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"] + +[[package]] +name = "importlib-metadata" +version = "6.7.0" +description = "Read metadata from Python packages" +optional = false +python-versions = ">=3.7" +files = [ + {file = "importlib_metadata-6.7.0-py3-none-any.whl", hash = "sha256:cb52082e659e97afc5dac71e79de97d8681de3aa07ff18578330904a9d18e5b5"}, + {file = "importlib_metadata-6.7.0.tar.gz", hash = "sha256:1aaf550d4f73e5d6783e7acb77aec43d49da8017410afae93822cc9cca98c4d4"}, +] + +[package.dependencies] +typing-extensions = {version = ">=3.6.4", markers = "python_version < \"3.8\""} +zipp = ">=0.5" + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] +perf = ["ipython"] +testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] + +[[package]] +name = "iniconfig" +version = "2.0.0" +description = "brain-dead simple config-ini parsing" +optional = false +python-versions = ">=3.7" +files = [ + {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, + {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, +] + +[[package]] +name = "jsonpickle" +version = "3.3.0" +description = "Python library for serializing arbitrary object graphs into JSON" +optional = false +python-versions = ">=3.7" +files = [ + {file = "jsonpickle-3.3.0-py3-none-any.whl", hash = "sha256:287c12143f35571ab00e224fa323aa4b090d5a7f086f5f494d7ee9c7eb1a380a"}, + {file = "jsonpickle-3.3.0.tar.gz", hash = "sha256:ab467e601e5b1a1cd76f1819d014795165da071744ef30bf3786e9bc549de25a"}, +] + +[package.dependencies] +importlib-metadata = {version = "*", markers = "python_version < \"3.8\""} + +[package.extras] +docs = ["furo", "rst.linker (>=1.9)", "sphinx"] +packaging = ["build", "twine"] +testing = ["bson", "ecdsa", "feedparser", "gmpy2", "numpy", "pandas", "pymongo", "pytest (>=3.5,!=3.7.3)", "pytest-benchmark", "pytest-benchmark[histogram]", "pytest-checkdocs (>=1.2.3)", "pytest-cov", "pytest-enabler (>=1.0.1)", "pytest-ruff (>=0.2.1)", "scikit-learn", "scipy", "scipy (>=1.9.3)", "simplejson", "sqlalchemy", "ujson"] + +[[package]] +name = "jsonpointer" +version = "2.4" +description = "Identify specific nodes in a JSON document (RFC 6901)" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*" +files = [ + {file = "jsonpointer-2.4-py2.py3-none-any.whl", hash = "sha256:15d51bba20eea3165644553647711d150376234112651b4f1811022aecad7d7a"}, + {file = "jsonpointer-2.4.tar.gz", hash = "sha256:585cee82b70211fa9e6043b7bb89db6e1aa49524340dde8ad6b63206ea689d88"}, +] + +[[package]] +name = "msgpack" +version = "1.0.5" +description = "MessagePack serializer" +optional = false +python-versions = "*" +files = [ + {file = "msgpack-1.0.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:525228efd79bb831cf6830a732e2e80bc1b05436b086d4264814b4b2955b2fa9"}, + {file = "msgpack-1.0.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:4f8d8b3bf1ff2672567d6b5c725a1b347fe838b912772aa8ae2bf70338d5a198"}, + {file = "msgpack-1.0.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:cdc793c50be3f01106245a61b739328f7dccc2c648b501e237f0699fe1395b81"}, + {file = "msgpack-1.0.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5cb47c21a8a65b165ce29f2bec852790cbc04936f502966768e4aae9fa763cb7"}, + {file = "msgpack-1.0.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e42b9594cc3bf4d838d67d6ed62b9e59e201862a25e9a157019e171fbe672dd3"}, + {file = "msgpack-1.0.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:55b56a24893105dc52c1253649b60f475f36b3aa0fc66115bffafb624d7cb30b"}, + {file = "msgpack-1.0.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:1967f6129fc50a43bfe0951c35acbb729be89a55d849fab7686004da85103f1c"}, + {file = "msgpack-1.0.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:20a97bf595a232c3ee6d57ddaadd5453d174a52594bf9c21d10407e2a2d9b3bd"}, + {file = "msgpack-1.0.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:d25dd59bbbbb996eacf7be6b4ad082ed7eacc4e8f3d2df1ba43822da9bfa122a"}, + {file = "msgpack-1.0.5-cp310-cp310-win32.whl", hash = "sha256:382b2c77589331f2cb80b67cc058c00f225e19827dbc818d700f61513ab47bea"}, + {file = "msgpack-1.0.5-cp310-cp310-win_amd64.whl", hash = "sha256:4867aa2df9e2a5fa5f76d7d5565d25ec76e84c106b55509e78c1ede0f152659a"}, + {file = "msgpack-1.0.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:9f5ae84c5c8a857ec44dc180a8b0cc08238e021f57abdf51a8182e915e6299f0"}, + {file = "msgpack-1.0.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:9e6ca5d5699bcd89ae605c150aee83b5321f2115695e741b99618f4856c50898"}, + {file = "msgpack-1.0.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5494ea30d517a3576749cad32fa27f7585c65f5f38309c88c6d137877fa28a5a"}, + {file = "msgpack-1.0.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1ab2f3331cb1b54165976a9d976cb251a83183631c88076613c6c780f0d6e45a"}, + {file = "msgpack-1.0.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:28592e20bbb1620848256ebc105fc420436af59515793ed27d5c77a217477705"}, + {file = "msgpack-1.0.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fe5c63197c55bce6385d9aee16c4d0641684628f63ace85f73571e65ad1c1e8d"}, + {file = "msgpack-1.0.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:ed40e926fa2f297e8a653c954b732f125ef97bdd4c889f243182299de27e2aa9"}, + {file = "msgpack-1.0.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:b2de4c1c0538dcb7010902a2b97f4e00fc4ddf2c8cda9749af0e594d3b7fa3d7"}, + {file = "msgpack-1.0.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:bf22a83f973b50f9d38e55c6aade04c41ddda19b00c4ebc558930d78eecc64ed"}, + {file = "msgpack-1.0.5-cp311-cp311-win32.whl", hash = "sha256:c396e2cc213d12ce017b686e0f53497f94f8ba2b24799c25d913d46c08ec422c"}, + {file = "msgpack-1.0.5-cp311-cp311-win_amd64.whl", hash = "sha256:6c4c68d87497f66f96d50142a2b73b97972130d93677ce930718f68828b382e2"}, + {file = "msgpack-1.0.5-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:a2b031c2e9b9af485d5e3c4520f4220d74f4d222a5b8dc8c1a3ab9448ca79c57"}, + {file = "msgpack-1.0.5-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4f837b93669ce4336e24d08286c38761132bc7ab29782727f8557e1eb21b2080"}, + {file = "msgpack-1.0.5-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b1d46dfe3832660f53b13b925d4e0fa1432b00f5f7210eb3ad3bb9a13c6204a6"}, + {file = "msgpack-1.0.5-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:366c9a7b9057e1547f4ad51d8facad8b406bab69c7d72c0eb6f529cf76d4b85f"}, + {file = "msgpack-1.0.5-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:4c075728a1095efd0634a7dccb06204919a2f67d1893b6aa8e00497258bf926c"}, + {file = "msgpack-1.0.5-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:f933bbda5a3ee63b8834179096923b094b76f0c7a73c1cfe8f07ad608c58844b"}, + {file = "msgpack-1.0.5-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:36961b0568c36027c76e2ae3ca1132e35123dcec0706c4b7992683cc26c1320c"}, + {file = "msgpack-1.0.5-cp36-cp36m-win32.whl", hash = "sha256:b5ef2f015b95f912c2fcab19c36814963b5463f1fb9049846994b007962743e9"}, + {file = "msgpack-1.0.5-cp36-cp36m-win_amd64.whl", hash = "sha256:288e32b47e67f7b171f86b030e527e302c91bd3f40fd9033483f2cacc37f327a"}, + {file = "msgpack-1.0.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:137850656634abddfb88236008339fdaba3178f4751b28f270d2ebe77a563b6c"}, + {file = "msgpack-1.0.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0c05a4a96585525916b109bb85f8cb6511db1c6f5b9d9cbcbc940dc6b4be944b"}, + {file = "msgpack-1.0.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:56a62ec00b636583e5cb6ad313bbed36bb7ead5fa3a3e38938503142c72cba4f"}, + {file = "msgpack-1.0.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ef8108f8dedf204bb7b42994abf93882da1159728a2d4c5e82012edd92c9da9f"}, + {file = "msgpack-1.0.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:1835c84d65f46900920b3708f5ba829fb19b1096c1800ad60bae8418652a951d"}, + {file = "msgpack-1.0.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:e57916ef1bd0fee4f21c4600e9d1da352d8816b52a599c46460e93a6e9f17086"}, + {file = "msgpack-1.0.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:17358523b85973e5f242ad74aa4712b7ee560715562554aa2134d96e7aa4cbbf"}, + {file = "msgpack-1.0.5-cp37-cp37m-win32.whl", hash = "sha256:cb5aaa8c17760909ec6cb15e744c3ebc2ca8918e727216e79607b7bbce9c8f77"}, + {file = "msgpack-1.0.5-cp37-cp37m-win_amd64.whl", hash = "sha256:ab31e908d8424d55601ad7075e471b7d0140d4d3dd3272daf39c5c19d936bd82"}, + {file = "msgpack-1.0.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:b72d0698f86e8d9ddf9442bdedec15b71df3598199ba33322d9711a19f08145c"}, + {file = "msgpack-1.0.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:379026812e49258016dd84ad79ac8446922234d498058ae1d415f04b522d5b2d"}, + {file = "msgpack-1.0.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:332360ff25469c346a1c5e47cbe2a725517919892eda5cfaffe6046656f0b7bb"}, + {file = "msgpack-1.0.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:476a8fe8fae289fdf273d6d2a6cb6e35b5a58541693e8f9f019bfe990a51e4ba"}, + {file = "msgpack-1.0.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a9985b214f33311df47e274eb788a5893a761d025e2b92c723ba4c63936b69b1"}, + {file = "msgpack-1.0.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:48296af57cdb1d885843afd73c4656be5c76c0c6328db3440c9601a98f303d87"}, + {file = "msgpack-1.0.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:addab7e2e1fcc04bd08e4eb631c2a90960c340e40dfc4a5e24d2ff0d5a3b3edb"}, + {file = "msgpack-1.0.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:916723458c25dfb77ff07f4c66aed34e47503b2eb3188b3adbec8d8aa6e00f48"}, + {file = "msgpack-1.0.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:821c7e677cc6acf0fd3f7ac664c98803827ae6de594a9f99563e48c5a2f27eb0"}, + {file = "msgpack-1.0.5-cp38-cp38-win32.whl", hash = "sha256:1c0f7c47f0087ffda62961d425e4407961a7ffd2aa004c81b9c07d9269512f6e"}, + {file = "msgpack-1.0.5-cp38-cp38-win_amd64.whl", hash = "sha256:bae7de2026cbfe3782c8b78b0db9cbfc5455e079f1937cb0ab8d133496ac55e1"}, + {file = "msgpack-1.0.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:20c784e66b613c7f16f632e7b5e8a1651aa5702463d61394671ba07b2fc9e025"}, + {file = "msgpack-1.0.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:266fa4202c0eb94d26822d9bfd7af25d1e2c088927fe8de9033d929dd5ba24c5"}, + {file = "msgpack-1.0.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:18334484eafc2b1aa47a6d42427da7fa8f2ab3d60b674120bce7a895a0a85bdd"}, + {file = "msgpack-1.0.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:57e1f3528bd95cc44684beda696f74d3aaa8a5e58c816214b9046512240ef437"}, + {file = "msgpack-1.0.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:586d0d636f9a628ddc6a17bfd45aa5b5efaf1606d2b60fa5d87b8986326e933f"}, + {file = "msgpack-1.0.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a740fa0e4087a734455f0fc3abf5e746004c9da72fbd541e9b113013c8dc3282"}, + {file = "msgpack-1.0.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:3055b0455e45810820db1f29d900bf39466df96ddca11dfa6d074fa47054376d"}, + {file = "msgpack-1.0.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:a61215eac016f391129a013c9e46f3ab308db5f5ec9f25811e811f96962599a8"}, + {file = "msgpack-1.0.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:362d9655cd369b08fda06b6657a303eb7172d5279997abe094512e919cf74b11"}, + {file = "msgpack-1.0.5-cp39-cp39-win32.whl", hash = "sha256:ac9dd47af78cae935901a9a500104e2dea2e253207c924cc95de149606dc43cc"}, + {file = "msgpack-1.0.5-cp39-cp39-win_amd64.whl", hash = "sha256:06f5174b5f8ed0ed919da0e62cbd4ffde676a374aba4020034da05fab67b9164"}, + {file = "msgpack-1.0.5.tar.gz", hash = "sha256:c075544284eadc5cddc70f4757331d99dcbc16b2bbd4849d15f8aae4cf36d31c"}, +] + +[[package]] +name = "mypy" +version = "1.0.1" +description = "Optional static typing for Python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "mypy-1.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:71a808334d3f41ef011faa5a5cd8153606df5fc0b56de5b2e89566c8093a0c9a"}, + {file = "mypy-1.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:920169f0184215eef19294fa86ea49ffd4635dedfdea2b57e45cb4ee85d5ccaf"}, + {file = "mypy-1.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:27a0f74a298769d9fdc8498fcb4f2beb86f0564bcdb1a37b58cbbe78e55cf8c0"}, + {file = "mypy-1.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:65b122a993d9c81ea0bfde7689b3365318a88bde952e4dfa1b3a8b4ac05d168b"}, + {file = "mypy-1.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:5deb252fd42a77add936b463033a59b8e48eb2eaec2976d76b6878d031933fe4"}, + {file = "mypy-1.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:2013226d17f20468f34feddd6aae4635a55f79626549099354ce641bc7d40262"}, + {file = "mypy-1.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:48525aec92b47baed9b3380371ab8ab6e63a5aab317347dfe9e55e02aaad22e8"}, + {file = "mypy-1.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c96b8a0c019fe29040d520d9257d8c8f122a7343a8307bf8d6d4a43f5c5bfcc8"}, + {file = "mypy-1.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:448de661536d270ce04f2d7dddaa49b2fdba6e3bd8a83212164d4174ff43aa65"}, + {file = "mypy-1.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:d42a98e76070a365a1d1c220fcac8aa4ada12ae0db679cb4d910fabefc88b994"}, + {file = "mypy-1.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e64f48c6176e243ad015e995de05af7f22bbe370dbb5b32bd6988438ec873919"}, + {file = "mypy-1.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5fdd63e4f50e3538617887e9aee91855368d9fc1dea30da743837b0df7373bc4"}, + {file = "mypy-1.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:dbeb24514c4acbc78d205f85dd0e800f34062efcc1f4a4857c57e4b4b8712bff"}, + {file = "mypy-1.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:a2948c40a7dd46c1c33765718936669dc1f628f134013b02ff5ac6c7ef6942bf"}, + {file = "mypy-1.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:5bc8d6bd3b274dd3846597855d96d38d947aedba18776aa998a8d46fabdaed76"}, + {file = "mypy-1.0.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:17455cda53eeee0a4adb6371a21dd3dbf465897de82843751cf822605d152c8c"}, + {file = "mypy-1.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e831662208055b006eef68392a768ff83596035ffd6d846786578ba1714ba8f6"}, + {file = "mypy-1.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:e60d0b09f62ae97a94605c3f73fd952395286cf3e3b9e7b97f60b01ddfbbda88"}, + {file = "mypy-1.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:0af4f0e20706aadf4e6f8f8dc5ab739089146b83fd53cb4a7e0e850ef3de0bb6"}, + {file = "mypy-1.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:24189f23dc66f83b839bd1cce2dfc356020dfc9a8bae03978477b15be61b062e"}, + {file = "mypy-1.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:93a85495fb13dc484251b4c1fd7a5ac370cd0d812bbfc3b39c1bafefe95275d5"}, + {file = "mypy-1.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5f546ac34093c6ce33f6278f7c88f0f147a4849386d3bf3ae193702f4fe31407"}, + {file = "mypy-1.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:c6c2ccb7af7154673c591189c3687b013122c5a891bb5651eca3db8e6c6c55bd"}, + {file = "mypy-1.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:15b5a824b58c7c822c51bc66308e759243c32631896743f030daf449fe3677f3"}, + {file = "mypy-1.0.1-py3-none-any.whl", hash = "sha256:eda5c8b9949ed411ff752b9a01adda31afe7eae1e53e946dbdf9db23865e66c4"}, + {file = "mypy-1.0.1.tar.gz", hash = "sha256:28cea5a6392bb43d266782983b5a4216c25544cd7d80be681a155ddcdafd152d"}, +] + +[package.dependencies] +mypy-extensions = ">=0.4.3" +tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} +typed-ast = {version = ">=1.4.0,<2", markers = "python_version < \"3.8\""} +typing-extensions = ">=3.10" + +[package.extras] +dmypy = ["psutil (>=4.0)"] +install-types = ["pip"] +python2 = ["typed-ast (>=1.4.0,<2)"] +reports = ["lxml"] + +[[package]] +name = "mypy-extensions" +version = "1.0.0" +description = "Type system extensions for programs checked with the mypy type checker." +optional = false +python-versions = ">=3.5" +files = [ + {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, + {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, +] + +[[package]] +name = "packaging" +version = "24.0" +description = "Core utilities for Python packages" +optional = false +python-versions = ">=3.7" +files = [ + {file = "packaging-24.0-py3-none-any.whl", hash = "sha256:2ddfb553fdf02fb784c234c7ba6ccc288296ceabec964ad2eae3777778130bc5"}, + {file = "packaging-24.0.tar.gz", hash = "sha256:eb82c5e3e56209074766e6885bb04b8c38a0c015d0a30036ebe7ece34c9989e9"}, +] + +[[package]] +name = "pluggy" +version = "1.2.0" +description = "plugin and hook calling mechanisms for python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pluggy-1.2.0-py3-none-any.whl", hash = "sha256:c2fd55a7d7a3863cba1a013e4e2414658b1d07b6bc57b3919e0c63c9abb99849"}, + {file = "pluggy-1.2.0.tar.gz", hash = "sha256:d12f0c4b579b15f5e054301bb226ee85eeeba08ffec228092f8defbaa3a4c4b3"}, +] + +[package.dependencies] +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} + +[package.extras] +dev = ["pre-commit", "tox"] +testing = ["pytest", "pytest-benchmark"] + +[[package]] +name = "pytest" +version = "7.4.4" +description = "pytest: simple powerful testing with Python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"}, + {file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "sys_platform == \"win32\""} +exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""} +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} +iniconfig = "*" +packaging = "*" +pluggy = ">=0.12,<2.0" +tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""} + +[package.extras] +testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] + +[[package]] +name = "python-dateutil" +version = "2.9.0.post0" +description = "Extensions to the standard Python datetime module" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, + {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, +] + +[package.dependencies] +six = ">=1.5" + +[[package]] +name = "requests" +version = "2.31.0" +description = "Python HTTP for Humans." +optional = false +python-versions = ">=3.7" +files = [ + {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, + {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, +] + +[package.dependencies] +certifi = ">=2017.4.17" +charset-normalizer = ">=2,<4" +idna = ">=2.5,<4" +urllib3 = ">=1.21.1,<3" + +[package.extras] +socks = ["PySocks (>=1.5.6,!=1.5.7)"] +use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] + +[[package]] +name = "setuptools" +version = "68.0.0" +description = "Easily download, build, install, upgrade, and uninstall Python packages" +optional = false +python-versions = ">=3.7" +files = [ + {file = "setuptools-68.0.0-py3-none-any.whl", hash = "sha256:11e52c67415a381d10d6b462ced9cfb97066179f0e871399e006c4ab101fc85f"}, + {file = "setuptools-68.0.0.tar.gz", hash = "sha256:baf1fdb41c6da4cd2eae722e135500da913332ab3f2f5c7d33af9b492acb5235"}, +] + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-hoverxref (<2)", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (==0.8.3)", "sphinx-reredirects", "sphinxcontrib-towncrier"] +testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pip (>=19.1)", "pip-run (>=8.8)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] +testing-integration = ["build[virtualenv]", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] + +[[package]] +name = "six" +version = "1.17.0" +description = "Python 2 and 3 compatibility utilities" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274"}, + {file = "six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81"}, +] + +[[package]] +name = "tomli" +version = "2.0.1" +description = "A lil' TOML parser" +optional = false +python-versions = ">=3.7" +files = [ + {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"}, + {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"}, +] + +[[package]] +name = "typed-ast" +version = "1.5.5" +description = "a fork of Python 2 and 3 ast modules with type comment support" +optional = false +python-versions = ">=3.6" +files = [ + {file = "typed_ast-1.5.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:4bc1efe0ce3ffb74784e06460f01a223ac1f6ab31c6bc0376a21184bf5aabe3b"}, + {file = "typed_ast-1.5.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:5f7a8c46a8b333f71abd61d7ab9255440d4a588f34a21f126bbfc95f6049e686"}, + {file = "typed_ast-1.5.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:597fc66b4162f959ee6a96b978c0435bd63791e31e4f410622d19f1686d5e769"}, + {file = "typed_ast-1.5.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d41b7a686ce653e06c2609075d397ebd5b969d821b9797d029fccd71fdec8e04"}, + {file = "typed_ast-1.5.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:5fe83a9a44c4ce67c796a1b466c270c1272e176603d5e06f6afbc101a572859d"}, + {file = "typed_ast-1.5.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:d5c0c112a74c0e5db2c75882a0adf3133adedcdbfd8cf7c9d6ed77365ab90a1d"}, + {file = "typed_ast-1.5.5-cp310-cp310-win_amd64.whl", hash = "sha256:e1a976ed4cc2d71bb073e1b2a250892a6e968ff02aa14c1f40eba4f365ffec02"}, + {file = "typed_ast-1.5.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c631da9710271cb67b08bd3f3813b7af7f4c69c319b75475436fcab8c3d21bee"}, + {file = "typed_ast-1.5.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:b445c2abfecab89a932b20bd8261488d574591173d07827c1eda32c457358b18"}, + {file = "typed_ast-1.5.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cc95ffaaab2be3b25eb938779e43f513e0e538a84dd14a5d844b8f2932593d88"}, + {file = "typed_ast-1.5.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:61443214d9b4c660dcf4b5307f15c12cb30bdfe9588ce6158f4a005baeb167b2"}, + {file = "typed_ast-1.5.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:6eb936d107e4d474940469e8ec5b380c9b329b5f08b78282d46baeebd3692dc9"}, + {file = "typed_ast-1.5.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e48bf27022897577d8479eaed64701ecaf0467182448bd95759883300ca818c8"}, + {file = "typed_ast-1.5.5-cp311-cp311-win_amd64.whl", hash = "sha256:83509f9324011c9a39faaef0922c6f720f9623afe3fe220b6d0b15638247206b"}, + {file = "typed_ast-1.5.5-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:44f214394fc1af23ca6d4e9e744804d890045d1643dd7e8229951e0ef39429b5"}, + {file = "typed_ast-1.5.5-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:118c1ce46ce58fda78503eae14b7664163aa735b620b64b5b725453696f2a35c"}, + {file = "typed_ast-1.5.5-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:be4919b808efa61101456e87f2d4c75b228f4e52618621c77f1ddcaae15904fa"}, + {file = "typed_ast-1.5.5-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:fc2b8c4e1bc5cd96c1a823a885e6b158f8451cf6f5530e1829390b4d27d0807f"}, + {file = "typed_ast-1.5.5-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:16f7313e0a08c7de57f2998c85e2a69a642e97cb32f87eb65fbfe88381a5e44d"}, + {file = "typed_ast-1.5.5-cp36-cp36m-win_amd64.whl", hash = "sha256:2b946ef8c04f77230489f75b4b5a4a6f24c078be4aed241cfabe9cbf4156e7e5"}, + {file = "typed_ast-1.5.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:2188bc33d85951ea4ddad55d2b35598b2709d122c11c75cffd529fbc9965508e"}, + {file = "typed_ast-1.5.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0635900d16ae133cab3b26c607586131269f88266954eb04ec31535c9a12ef1e"}, + {file = "typed_ast-1.5.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:57bfc3cf35a0f2fdf0a88a3044aafaec1d2f24d8ae8cd87c4f58d615fb5b6311"}, + {file = "typed_ast-1.5.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:fe58ef6a764de7b4b36edfc8592641f56e69b7163bba9f9c8089838ee596bfb2"}, + {file = "typed_ast-1.5.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:d09d930c2d1d621f717bb217bf1fe2584616febb5138d9b3e8cdd26506c3f6d4"}, + {file = "typed_ast-1.5.5-cp37-cp37m-win_amd64.whl", hash = "sha256:d40c10326893ecab8a80a53039164a224984339b2c32a6baf55ecbd5b1df6431"}, + {file = "typed_ast-1.5.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:fd946abf3c31fb50eee07451a6aedbfff912fcd13cf357363f5b4e834cc5e71a"}, + {file = "typed_ast-1.5.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:ed4a1a42df8a3dfb6b40c3d2de109e935949f2f66b19703eafade03173f8f437"}, + {file = "typed_ast-1.5.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:045f9930a1550d9352464e5149710d56a2aed23a2ffe78946478f7b5416f1ede"}, + {file = "typed_ast-1.5.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:381eed9c95484ceef5ced626355fdc0765ab51d8553fec08661dce654a935db4"}, + {file = "typed_ast-1.5.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:bfd39a41c0ef6f31684daff53befddae608f9daf6957140228a08e51f312d7e6"}, + {file = "typed_ast-1.5.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8c524eb3024edcc04e288db9541fe1f438f82d281e591c548903d5b77ad1ddd4"}, + {file = "typed_ast-1.5.5-cp38-cp38-win_amd64.whl", hash = "sha256:7f58fabdde8dcbe764cef5e1a7fcb440f2463c1bbbec1cf2a86ca7bc1f95184b"}, + {file = "typed_ast-1.5.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:042eb665ff6bf020dd2243307d11ed626306b82812aba21836096d229fdc6a10"}, + {file = "typed_ast-1.5.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:622e4a006472b05cf6ef7f9f2636edc51bda670b7bbffa18d26b255269d3d814"}, + {file = "typed_ast-1.5.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1efebbbf4604ad1283e963e8915daa240cb4bf5067053cf2f0baadc4d4fb51b8"}, + {file = "typed_ast-1.5.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f0aefdd66f1784c58f65b502b6cf8b121544680456d1cebbd300c2c813899274"}, + {file = "typed_ast-1.5.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:48074261a842acf825af1968cd912f6f21357316080ebaca5f19abbb11690c8a"}, + {file = "typed_ast-1.5.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:429ae404f69dc94b9361bb62291885894b7c6fb4640d561179548c849f8492ba"}, + {file = "typed_ast-1.5.5-cp39-cp39-win_amd64.whl", hash = "sha256:335f22ccb244da2b5c296e6f96b06ee9bed46526db0de38d2f0e5a6597b81155"}, + {file = "typed_ast-1.5.5.tar.gz", hash = "sha256:94282f7a354f36ef5dbce0ef3467ebf6a258e370ab33d5b40c249fa996e590dd"}, +] + +[[package]] +name = "typing-extensions" +version = "4.7.1" +description = "Backported and Experimental Type Hints for Python 3.7+" +optional = false +python-versions = ">=3.7" +files = [ + {file = "typing_extensions-4.7.1-py3-none-any.whl", hash = "sha256:440d5dd3af93b060174bf433bccd69b0babc3b15b1a8dca43789fd7f61514b36"}, + {file = "typing_extensions-4.7.1.tar.gz", hash = "sha256:b75ddc264f0ba5615db7ba217daeb99701ad295353c45f9e95963337ceeeffb2"}, +] + +[[package]] +name = "urllib3" +version = "2.0.7" +description = "HTTP library with thread-safe connection pooling, file post, and more." +optional = false +python-versions = ">=3.7" +files = [ + {file = "urllib3-2.0.7-py3-none-any.whl", hash = "sha256:fdb6d215c776278489906c2f8916e6e7d4f5a9b602ccbcfdf7f016fc8da0596e"}, + {file = "urllib3-2.0.7.tar.gz", hash = "sha256:c97dfde1f7bd43a71c8d2a58e369e9b2bf692d1334ea9f9cae55add7d0dd0f84"}, +] + +[package.extras] +brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"] +secure = ["certifi", "cryptography (>=1.9)", "idna (>=2.0.0)", "pyopenssl (>=17.1.0)", "urllib3-secure-extra"] +socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] +zstd = ["zstandard (>=0.18.0)"] + +[[package]] +name = "zipp" +version = "3.15.0" +description = "Backport of pathlib-compatible object wrapper for zip files" +optional = false +python-versions = ">=3.7" +files = [ + {file = "zipp-3.15.0-py3-none-any.whl", hash = "sha256:48904fc76a60e542af151aded95726c1a5c34ed43ab4134b597665c86d7ad556"}, + {file = "zipp-3.15.0.tar.gz", hash = "sha256:112929ad649da941c23de50f356a2b5570c954b65150642bccdd66bf194d224b"}, +] + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] +testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)"] + +[metadata] +lock-version = "2.0" +python-versions = "^3.7" +content-hash = "4bcf11f1e022d3d50716182d480e49d4673ccd0a73aa695dd151e5e5de27e25d" diff --git a/legacy/pyproject.toml b/legacy/pyproject.toml new file mode 100644 index 00000000..fd695408 --- /dev/null +++ b/legacy/pyproject.toml @@ -0,0 +1,31 @@ +[project] +name = "squareup_legacy" + +[tool.poetry] +name = "squareup_legacy" +version = "41.0.0.20250319" +description = "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management." +readme = "../README.md" +authors = [] +keywords = [] +packages = [ + { include = "square_legacy", from = "src"} +] + +[tool.poetry.dependencies] +python = "^3.7" +apimatic-core = "~=0.2.0, >= 0.2.17" +apimatic-core-interfaces = "~=0.1.0, >= 0.1.5" +apimatic-requests-client-adapter = "~=0.1.0, >= 0.1.6" +deprecation = "~=2.1" + +[tool.poetry.dev-dependencies] +mypy = "1.0.1" +pytest = "^7.4.0" + +[tool.mypy] +plugins = ["pydantic.mypy"] + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" \ No newline at end of file diff --git a/legacy/requirements.txt b/legacy/requirements.txt new file mode 100644 index 00000000..c6c51b54 --- /dev/null +++ b/legacy/requirements.txt @@ -0,0 +1,4 @@ +apimatic-core~=0.2.0, >= 0.2.17 +apimatic-core-interfaces~=0.1.0, >= 0.1.5 +apimatic-requests-client-adapter~=0.1.0, >= 0.1.6 +deprecation~=2.1 diff --git a/square/__init__.py b/legacy/src/square_legacy/__init__.py similarity index 100% rename from square/__init__.py rename to legacy/src/square_legacy/__init__.py diff --git a/square/api/__init__.py b/legacy/src/square_legacy/api/__init__.py similarity index 100% rename from square/api/__init__.py rename to legacy/src/square_legacy/api/__init__.py diff --git a/square/api/apple_pay_api.py b/legacy/src/square_legacy/api/apple_pay_api.py similarity index 93% rename from square/api/apple_pay_api.py rename to legacy/src/square_legacy/api/apple_pay_api.py index be4d013a..6c3ee291 100644 --- a/square/api/apple_pay_api.py +++ b/legacy/src/square_legacy/api/apple_pay_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/bank_accounts_api.py b/legacy/src/square_legacy/api/bank_accounts_api.py similarity index 96% rename from square/api/bank_accounts_api.py rename to legacy/src/square_legacy/api/bank_accounts_api.py index ff2ec5d1..ab850c13 100644 --- a/square/api/bank_accounts_api.py +++ b/legacy/src/square_legacy/api/bank_accounts_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/base_api.py b/legacy/src/square_legacy/api/base_api.py similarity index 100% rename from square/api/base_api.py rename to legacy/src/square_legacy/api/base_api.py diff --git a/square/api/booking_custom_attributes_api.py b/legacy/src/square_legacy/api/booking_custom_attributes_api.py similarity index 99% rename from square/api/booking_custom_attributes_api.py rename to legacy/src/square_legacy/api/booking_custom_attributes_api.py index 6ac0735a..0ec10d35 100644 --- a/square/api/booking_custom_attributes_api.py +++ b/legacy/src/square_legacy/api/booking_custom_attributes_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/bookings_api.py b/legacy/src/square_legacy/api/bookings_api.py similarity index 99% rename from square/api/bookings_api.py rename to legacy/src/square_legacy/api/bookings_api.py index 783c6aee..f8dddb8c 100644 --- a/square/api/bookings_api.py +++ b/legacy/src/square_legacy/api/bookings_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/cards_api.py b/legacy/src/square_legacy/api/cards_api.py similarity index 97% rename from square/api/cards_api.py rename to legacy/src/square_legacy/api/cards_api.py index d9fca9e1..fdcd1ebe 100644 --- a/square/api/cards_api.py +++ b/legacy/src/square_legacy/api/cards_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/cash_drawers_api.py b/legacy/src/square_legacy/api/cash_drawers_api.py similarity index 97% rename from square/api/cash_drawers_api.py rename to legacy/src/square_legacy/api/cash_drawers_api.py index ec8b656d..11c2af8e 100644 --- a/square/api/cash_drawers_api.py +++ b/legacy/src/square_legacy/api/cash_drawers_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/catalog_api.py b/legacy/src/square_legacy/api/catalog_api.py similarity index 99% rename from square/api/catalog_api.py rename to legacy/src/square_legacy/api/catalog_api.py index 2a57fcc6..5746f813 100644 --- a/square/api/catalog_api.py +++ b/legacy/src/square_legacy/api/catalog_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.utilities.file_wrapper import FileWrapper -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.utilities.file_wrapper import FileWrapper +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/checkout_api.py b/legacy/src/square_legacy/api/checkout_api.py similarity index 98% rename from square/api/checkout_api.py rename to legacy/src/square_legacy/api/checkout_api.py index 0aa0f327..a1714ed0 100644 --- a/square/api/checkout_api.py +++ b/legacy/src/square_legacy/api/checkout_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/customer_custom_attributes_api.py b/legacy/src/square_legacy/api/customer_custom_attributes_api.py similarity index 99% rename from square/api/customer_custom_attributes_api.py rename to legacy/src/square_legacy/api/customer_custom_attributes_api.py index 91ea3c10..6ede456c 100644 --- a/square/api/customer_custom_attributes_api.py +++ b/legacy/src/square_legacy/api/customer_custom_attributes_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/customer_groups_api.py b/legacy/src/square_legacy/api/customer_groups_api.py similarity index 97% rename from square/api/customer_groups_api.py rename to legacy/src/square_legacy/api/customer_groups_api.py index b68b89d3..b3ff96cd 100644 --- a/square/api/customer_groups_api.py +++ b/legacy/src/square_legacy/api/customer_groups_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/customer_segments_api.py b/legacy/src/square_legacy/api/customer_segments_api.py similarity index 95% rename from square/api/customer_segments_api.py rename to legacy/src/square_legacy/api/customer_segments_api.py index 7acbb3e5..babcdea1 100644 --- a/square/api/customer_segments_api.py +++ b/legacy/src/square_legacy/api/customer_segments_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/customers_api.py b/legacy/src/square_legacy/api/customers_api.py similarity index 99% rename from square/api/customers_api.py rename to legacy/src/square_legacy/api/customers_api.py index d39eca37..9837dfe9 100644 --- a/square/api/customers_api.py +++ b/legacy/src/square_legacy/api/customers_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/devices_api.py b/legacy/src/square_legacy/api/devices_api.py similarity index 98% rename from square/api/devices_api.py rename to legacy/src/square_legacy/api/devices_api.py index ed653b74..2a35154e 100644 --- a/square/api/devices_api.py +++ b/legacy/src/square_legacy/api/devices_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/disputes_api.py b/legacy/src/square_legacy/api/disputes_api.py similarity index 98% rename from square/api/disputes_api.py rename to legacy/src/square_legacy/api/disputes_api.py index d069baf1..c9a62571 100644 --- a/square/api/disputes_api.py +++ b/legacy/src/square_legacy/api/disputes_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.utilities.file_wrapper import FileWrapper -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.utilities.file_wrapper import FileWrapper +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/employees_api.py b/legacy/src/square_legacy/api/employees_api.py similarity index 95% rename from square/api/employees_api.py rename to legacy/src/square_legacy/api/employees_api.py index da56b9ce..e40be791 100644 --- a/square/api/employees_api.py +++ b/legacy/src/square_legacy/api/employees_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/events_api.py b/legacy/src/square_legacy/api/events_api.py similarity index 96% rename from square/api/events_api.py rename to legacy/src/square_legacy/api/events_api.py index cde4a62d..dd7f39fb 100644 --- a/square/api/events_api.py +++ b/legacy/src/square_legacy/api/events_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/gift_card_activities_api.py b/legacy/src/square_legacy/api/gift_card_activities_api.py similarity index 97% rename from square/api/gift_card_activities_api.py rename to legacy/src/square_legacy/api/gift_card_activities_api.py index 0162ce20..ba247b99 100644 --- a/square/api/gift_card_activities_api.py +++ b/legacy/src/square_legacy/api/gift_card_activities_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/gift_cards_api.py b/legacy/src/square_legacy/api/gift_cards_api.py similarity index 98% rename from square/api/gift_cards_api.py rename to legacy/src/square_legacy/api/gift_cards_api.py index 1ed9545e..3f6bed1f 100644 --- a/square/api/gift_cards_api.py +++ b/legacy/src/square_legacy/api/gift_cards_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/inventory_api.py b/legacy/src/square_legacy/api/inventory_api.py similarity index 99% rename from square/api/inventory_api.py rename to legacy/src/square_legacy/api/inventory_api.py index e3cda8ee..b7cd8753 100644 --- a/square/api/inventory_api.py +++ b/legacy/src/square_legacy/api/inventory_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/invoices_api.py b/legacy/src/square_legacy/api/invoices_api.py similarity index 98% rename from square/api/invoices_api.py rename to legacy/src/square_legacy/api/invoices_api.py index 093f19ef..e7b73bfe 100644 --- a/square/api/invoices_api.py +++ b/legacy/src/square_legacy/api/invoices_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.utilities.file_wrapper import FileWrapper -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.utilities.file_wrapper import FileWrapper +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/labor_api.py b/legacy/src/square_legacy/api/labor_api.py similarity index 99% rename from square/api/labor_api.py rename to legacy/src/square_legacy/api/labor_api.py index 6e95096d..8ed2b75e 100644 --- a/square/api/labor_api.py +++ b/legacy/src/square_legacy/api/labor_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/location_custom_attributes_api.py b/legacy/src/square_legacy/api/location_custom_attributes_api.py similarity index 99% rename from square/api/location_custom_attributes_api.py rename to legacy/src/square_legacy/api/location_custom_attributes_api.py index 9252cdda..d79ad09d 100644 --- a/square/api/location_custom_attributes_api.py +++ b/legacy/src/square_legacy/api/location_custom_attributes_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/locations_api.py b/legacy/src/square_legacy/api/locations_api.py similarity index 97% rename from square/api/locations_api.py rename to legacy/src/square_legacy/api/locations_api.py index 65109064..2f96ae62 100644 --- a/square/api/locations_api.py +++ b/legacy/src/square_legacy/api/locations_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/loyalty_api.py b/legacy/src/square_legacy/api/loyalty_api.py similarity index 99% rename from square/api/loyalty_api.py rename to legacy/src/square_legacy/api/loyalty_api.py index 4d8c7ba4..e221cf00 100644 --- a/square/api/loyalty_api.py +++ b/legacy/src/square_legacy/api/loyalty_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/merchant_custom_attributes_api.py b/legacy/src/square_legacy/api/merchant_custom_attributes_api.py similarity index 99% rename from square/api/merchant_custom_attributes_api.py rename to legacy/src/square_legacy/api/merchant_custom_attributes_api.py index 595d1d76..14ec8e91 100644 --- a/square/api/merchant_custom_attributes_api.py +++ b/legacy/src/square_legacy/api/merchant_custom_attributes_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/merchants_api.py b/legacy/src/square_legacy/api/merchants_api.py similarity index 95% rename from square/api/merchants_api.py rename to legacy/src/square_legacy/api/merchants_api.py index 764aa6e8..e97fb20d 100644 --- a/square/api/merchants_api.py +++ b/legacy/src/square_legacy/api/merchants_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/mobile_authorization_api.py b/legacy/src/square_legacy/api/mobile_authorization_api.py similarity index 92% rename from square/api/mobile_authorization_api.py rename to legacy/src/square_legacy/api/mobile_authorization_api.py index 056f2ef9..df7b12cb 100644 --- a/square/api/mobile_authorization_api.py +++ b/legacy/src/square_legacy/api/mobile_authorization_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/o_auth_api.py b/legacy/src/square_legacy/api/o_auth_api.py similarity index 97% rename from square/api/o_auth_api.py rename to legacy/src/square_legacy/api/o_auth_api.py index a907fb90..632ac699 100644 --- a/square/api/o_auth_api.py +++ b/legacy/src/square_legacy/api/o_auth_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/order_custom_attributes_api.py b/legacy/src/square_legacy/api/order_custom_attributes_api.py similarity index 99% rename from square/api/order_custom_attributes_api.py rename to legacy/src/square_legacy/api/order_custom_attributes_api.py index a9c5507e..9c6054ba 100644 --- a/square/api/order_custom_attributes_api.py +++ b/legacy/src/square_legacy/api/order_custom_attributes_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/orders_api.py b/legacy/src/square_legacy/api/orders_api.py similarity index 98% rename from square/api/orders_api.py rename to legacy/src/square_legacy/api/orders_api.py index 84e7f6e1..e1a618c5 100644 --- a/square/api/orders_api.py +++ b/legacy/src/square_legacy/api/orders_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/payments_api.py b/legacy/src/square_legacy/api/payments_api.py similarity index 98% rename from square/api/payments_api.py rename to legacy/src/square_legacy/api/payments_api.py index 67bb06cf..51044fba 100644 --- a/square/api/payments_api.py +++ b/legacy/src/square_legacy/api/payments_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/payouts_api.py b/legacy/src/square_legacy/api/payouts_api.py similarity index 97% rename from square/api/payouts_api.py rename to legacy/src/square_legacy/api/payouts_api.py index ae21bcf3..035fa990 100644 --- a/square/api/payouts_api.py +++ b/legacy/src/square_legacy/api/payouts_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/refunds_api.py b/legacy/src/square_legacy/api/refunds_api.py similarity index 98% rename from square/api/refunds_api.py rename to legacy/src/square_legacy/api/refunds_api.py index da0d28de..fc72be23 100644 --- a/square/api/refunds_api.py +++ b/legacy/src/square_legacy/api/refunds_api.py @@ -5,10 +5,10 @@ from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.api.base_api import BaseApi -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.http.http_method_enum import HttpMethodEnum class RefundsApi(BaseApi): diff --git a/square/api/sites_api.py b/legacy/src/square_legacy/api/sites_api.py similarity index 90% rename from square/api/sites_api.py rename to legacy/src/square_legacy/api/sites_api.py index 28528f93..ecff2601 100644 --- a/square/api/sites_api.py +++ b/legacy/src/square_legacy/api/sites_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/snippets_api.py b/legacy/src/square_legacy/api/snippets_api.py similarity index 97% rename from square/api/snippets_api.py rename to legacy/src/square_legacy/api/snippets_api.py index 1c01c488..14bda0b6 100644 --- a/square/api/snippets_api.py +++ b/legacy/src/square_legacy/api/snippets_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/subscriptions_api.py b/legacy/src/square_legacy/api/subscriptions_api.py similarity index 99% rename from square/api/subscriptions_api.py rename to legacy/src/square_legacy/api/subscriptions_api.py index 8cd4d948..7b6e5db3 100644 --- a/square/api/subscriptions_api.py +++ b/legacy/src/square_legacy/api/subscriptions_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/team_api.py b/legacy/src/square_legacy/api/team_api.py similarity index 99% rename from square/api/team_api.py rename to legacy/src/square_legacy/api/team_api.py index 55bc46ce..66a02514 100644 --- a/square/api/team_api.py +++ b/legacy/src/square_legacy/api/team_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/terminal_api.py b/legacy/src/square_legacy/api/terminal_api.py similarity index 99% rename from square/api/terminal_api.py rename to legacy/src/square_legacy/api/terminal_api.py index ff978047..c5516a13 100644 --- a/square/api/terminal_api.py +++ b/legacy/src/square_legacy/api/terminal_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/transactions_api.py b/legacy/src/square_legacy/api/transactions_api.py similarity index 97% rename from square/api/transactions_api.py rename to legacy/src/square_legacy/api/transactions_api.py index 8ff95a92..50609893 100644 --- a/square/api/transactions_api.py +++ b/legacy/src/square_legacy/api/transactions_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/v1_transactions_api.py b/legacy/src/square_legacy/api/v1_transactions_api.py similarity index 97% rename from square/api/v1_transactions_api.py rename to legacy/src/square_legacy/api/v1_transactions_api.py index 381810a8..60ec68a8 100644 --- a/square/api/v1_transactions_api.py +++ b/legacy/src/square_legacy/api/v1_transactions_api.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- from deprecation import deprecated -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/vendors_api.py b/legacy/src/square_legacy/api/vendors_api.py similarity index 98% rename from square/api/vendors_api.py rename to legacy/src/square_legacy/api/vendors_api.py index 0b3e1d87..8ba58827 100644 --- a/square/api/vendors_api.py +++ b/legacy/src/square_legacy/api/vendors_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api/webhook_subscriptions_api.py b/legacy/src/square_legacy/api/webhook_subscriptions_api.py similarity index 98% rename from square/api/webhook_subscriptions_api.py rename to legacy/src/square_legacy/api/webhook_subscriptions_api.py index a665c80a..e1902edd 100644 --- a/square/api/webhook_subscriptions_api.py +++ b/legacy/src/square_legacy/api/webhook_subscriptions_api.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- -from square.api_helper import APIHelper -from square.http.api_response import ApiResponse -from square.api.base_api import BaseApi +from square_legacy.api_helper import APIHelper +from square_legacy.http.api_response import ApiResponse +from square_legacy.api.base_api import BaseApi from apimatic_core.request_builder import RequestBuilder from apimatic_core.response_handler import ResponseHandler from apimatic_core.types.parameter import Parameter -from square.http.http_method_enum import HttpMethodEnum +from square_legacy.http.http_method_enum import HttpMethodEnum from apimatic_core.authentication.multiple.single_auth import Single diff --git a/square/api_helper.py b/legacy/src/square_legacy/api_helper.py similarity index 100% rename from square/api_helper.py rename to legacy/src/square_legacy/api_helper.py diff --git a/square/client.py b/legacy/src/square_legacy/client.py similarity index 72% rename from square/client.py rename to legacy/src/square_legacy/client.py index 8eb2d398..e44a3069 100644 --- a/square/client.py +++ b/legacy/src/square_legacy/client.py @@ -2,54 +2,54 @@ from apimatic_core.configurations.global_configuration import GlobalConfiguration from apimatic_core.decorators.lazy_property import LazyProperty -from square.configuration import Configuration -from square.api.base_api import BaseApi -from square.http.auth.o_auth_2 import OAuth2 -from square.api.mobile_authorization_api import MobileAuthorizationApi -from square.api.o_auth_api import OAuthApi -from square.api.v1_transactions_api import V1TransactionsApi -from square.api.apple_pay_api import ApplePayApi -from square.api.bank_accounts_api import BankAccountsApi -from square.api.bookings_api import BookingsApi -from square.api.booking_custom_attributes_api import BookingCustomAttributesApi -from square.api.cards_api import CardsApi -from square.api.cash_drawers_api import CashDrawersApi -from square.api.catalog_api import CatalogApi -from square.api.customers_api import CustomersApi -from square.api.customer_custom_attributes_api\ +from square_legacy.configuration import Configuration +from square_legacy.api.base_api import BaseApi +from square_legacy.http.auth.o_auth_2 import OAuth2 +from square_legacy.api.mobile_authorization_api import MobileAuthorizationApi +from square_legacy.api.o_auth_api import OAuthApi +from square_legacy.api.v1_transactions_api import V1TransactionsApi +from square_legacy.api.apple_pay_api import ApplePayApi +from square_legacy.api.bank_accounts_api import BankAccountsApi +from square_legacy.api.bookings_api import BookingsApi +from square_legacy.api.booking_custom_attributes_api import BookingCustomAttributesApi +from square_legacy.api.cards_api import CardsApi +from square_legacy.api.cash_drawers_api import CashDrawersApi +from square_legacy.api.catalog_api import CatalogApi +from square_legacy.api.customers_api import CustomersApi +from square_legacy.api.customer_custom_attributes_api\ import CustomerCustomAttributesApi -from square.api.customer_groups_api import CustomerGroupsApi -from square.api.customer_segments_api import CustomerSegmentsApi -from square.api.devices_api import DevicesApi -from square.api.disputes_api import DisputesApi -from square.api.employees_api import EmployeesApi -from square.api.events_api import EventsApi -from square.api.gift_cards_api import GiftCardsApi -from square.api.gift_card_activities_api import GiftCardActivitiesApi -from square.api.inventory_api import InventoryApi -from square.api.invoices_api import InvoicesApi -from square.api.labor_api import LaborApi -from square.api.locations_api import LocationsApi -from square.api.location_custom_attributes_api\ +from square_legacy.api.customer_groups_api import CustomerGroupsApi +from square_legacy.api.customer_segments_api import CustomerSegmentsApi +from square_legacy.api.devices_api import DevicesApi +from square_legacy.api.disputes_api import DisputesApi +from square_legacy.api.employees_api import EmployeesApi +from square_legacy.api.events_api import EventsApi +from square_legacy.api.gift_cards_api import GiftCardsApi +from square_legacy.api.gift_card_activities_api import GiftCardActivitiesApi +from square_legacy.api.inventory_api import InventoryApi +from square_legacy.api.invoices_api import InvoicesApi +from square_legacy.api.labor_api import LaborApi +from square_legacy.api.locations_api import LocationsApi +from square_legacy.api.location_custom_attributes_api\ import LocationCustomAttributesApi -from square.api.checkout_api import CheckoutApi -from square.api.transactions_api import TransactionsApi -from square.api.loyalty_api import LoyaltyApi -from square.api.merchants_api import MerchantsApi -from square.api.merchant_custom_attributes_api\ +from square_legacy.api.checkout_api import CheckoutApi +from square_legacy.api.transactions_api import TransactionsApi +from square_legacy.api.loyalty_api import LoyaltyApi +from square_legacy.api.merchants_api import MerchantsApi +from square_legacy.api.merchant_custom_attributes_api\ import MerchantCustomAttributesApi -from square.api.orders_api import OrdersApi -from square.api.order_custom_attributes_api import OrderCustomAttributesApi -from square.api.payments_api import PaymentsApi -from square.api.payouts_api import PayoutsApi -from square.api.refunds_api import RefundsApi -from square.api.sites_api import SitesApi -from square.api.snippets_api import SnippetsApi -from square.api.subscriptions_api import SubscriptionsApi -from square.api.team_api import TeamApi -from square.api.terminal_api import TerminalApi -from square.api.vendors_api import VendorsApi -from square.api.webhook_subscriptions_api import WebhookSubscriptionsApi +from square_legacy.api.orders_api import OrdersApi +from square_legacy.api.order_custom_attributes_api import OrderCustomAttributesApi +from square_legacy.api.payments_api import PaymentsApi +from square_legacy.api.payouts_api import PayoutsApi +from square_legacy.api.refunds_api import RefundsApi +from square_legacy.api.sites_api import SitesApi +from square_legacy.api.snippets_api import SnippetsApi +from square_legacy.api.subscriptions_api import SubscriptionsApi +from square_legacy.api.team_api import TeamApi +from square_legacy.api.terminal_api import TerminalApi +from square_legacy.api.vendors_api import VendorsApi +from square_legacy.api.webhook_subscriptions_api import WebhookSubscriptionsApi class Client(object): diff --git a/square/configuration.py b/legacy/src/square_legacy/configuration.py similarity index 98% rename from square/configuration.py rename to legacy/src/square_legacy/configuration.py index 5f734c57..38426edf 100644 --- a/square/configuration.py +++ b/legacy/src/square_legacy/configuration.py @@ -2,7 +2,7 @@ import warnings from copy import deepcopy -from square.api_helper import APIHelper +from square_legacy.api_helper import APIHelper from apimatic_core.http.configurations.http_client_configuration import HttpClientConfiguration from apimatic_requests_client_adapter.requests_client import RequestsClient @@ -178,5 +178,5 @@ def create_auth_credentials_object(access_token, bearer_auth_credentials, if bearer_auth_credentials is not None: return bearer_auth_credentials.clone_with(access_token) - from square.http.auth.o_auth_2 import BearerAuthCredentials + from square_legacy.http.auth.o_auth_2 import BearerAuthCredentials return BearerAuthCredentials(access_token) diff --git a/square/exceptions/__init__.py b/legacy/src/square_legacy/exceptions/__init__.py similarity index 100% rename from square/exceptions/__init__.py rename to legacy/src/square_legacy/exceptions/__init__.py diff --git a/square/exceptions/api_exception.py b/legacy/src/square_legacy/exceptions/api_exception.py similarity index 100% rename from square/exceptions/api_exception.py rename to legacy/src/square_legacy/exceptions/api_exception.py diff --git a/square/http/__init__.py b/legacy/src/square_legacy/http/__init__.py similarity index 100% rename from square/http/__init__.py rename to legacy/src/square_legacy/http/__init__.py diff --git a/square/http/api_response.py b/legacy/src/square_legacy/http/api_response.py similarity index 100% rename from square/http/api_response.py rename to legacy/src/square_legacy/http/api_response.py diff --git a/square/http/auth/__init__.py b/legacy/src/square_legacy/http/auth/__init__.py similarity index 100% rename from square/http/auth/__init__.py rename to legacy/src/square_legacy/http/auth/__init__.py diff --git a/square/http/auth/o_auth_2.py b/legacy/src/square_legacy/http/auth/o_auth_2.py similarity index 100% rename from square/http/auth/o_auth_2.py rename to legacy/src/square_legacy/http/auth/o_auth_2.py diff --git a/square/http/http_call_back.py b/legacy/src/square_legacy/http/http_call_back.py similarity index 100% rename from square/http/http_call_back.py rename to legacy/src/square_legacy/http/http_call_back.py diff --git a/square/http/http_method_enum.py b/legacy/src/square_legacy/http/http_method_enum.py similarity index 100% rename from square/http/http_method_enum.py rename to legacy/src/square_legacy/http/http_method_enum.py diff --git a/square/http/http_request.py b/legacy/src/square_legacy/http/http_request.py similarity index 100% rename from square/http/http_request.py rename to legacy/src/square_legacy/http/http_request.py diff --git a/square/http/http_response.py b/legacy/src/square_legacy/http/http_response.py similarity index 100% rename from square/http/http_response.py rename to legacy/src/square_legacy/http/http_response.py diff --git a/square/utilities/__init__.py b/legacy/src/square_legacy/utilities/__init__.py similarity index 100% rename from square/utilities/__init__.py rename to legacy/src/square_legacy/utilities/__init__.py diff --git a/square/utilities/file_wrapper.py b/legacy/src/square_legacy/utilities/file_wrapper.py similarity index 100% rename from square/utilities/file_wrapper.py rename to legacy/src/square_legacy/utilities/file_wrapper.py diff --git a/square/utilities/webhooks_helper.py b/legacy/src/square_legacy/utilities/webhooks_helper.py similarity index 100% rename from square/utilities/webhooks_helper.py rename to legacy/src/square_legacy/utilities/webhooks_helper.py diff --git a/test-requirements.txt b/legacy/test-requirements.txt similarity index 100% rename from test-requirements.txt rename to legacy/test-requirements.txt diff --git a/tests/__init__.py b/legacy/tests/__init__.py similarity index 100% rename from tests/__init__.py rename to legacy/tests/__init__.py diff --git a/tests/api/__init__.py b/legacy/tests/api/__init__.py similarity index 100% rename from tests/api/__init__.py rename to legacy/tests/api/__init__.py diff --git a/tests/api/api_test_base.py b/legacy/tests/api/api_test_base.py similarity index 90% rename from tests/api/api_test_base.py rename to legacy/tests/api/api_test_base.py index 664bd208..c7f8d644 100644 --- a/tests/api/api_test_base.py +++ b/legacy/tests/api/api_test_base.py @@ -3,8 +3,8 @@ import os import unittest from tests.http_response_catcher import HttpResponseCatcher -from square.configuration import Configuration -from square.client import Client +from square_legacy.configuration import Configuration +from square_legacy.client import Client class ApiTestBase(unittest.TestCase): diff --git a/tests/api/test_catalog_api.py b/legacy/tests/api/test_catalog_api.py similarity index 100% rename from tests/api/test_catalog_api.py rename to legacy/tests/api/test_catalog_api.py diff --git a/tests/api/test_customers_api.py b/legacy/tests/api/test_customers_api.py similarity index 96% rename from tests/api/test_customers_api.py rename to legacy/tests/api/test_customers_api.py index f2e50310..3992a480 100644 --- a/tests/api/test_customers_api.py +++ b/legacy/tests/api/test_customers_api.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- from tests.api.api_test_base import ApiTestBase -from square.api_helper import APIHelper +from square_legacy.api_helper import APIHelper class CustomersApiTests(ApiTestBase): diff --git a/tests/api/test_employees_api.py b/legacy/tests/api/test_employees_api.py similarity index 100% rename from tests/api/test_employees_api.py rename to legacy/tests/api/test_employees_api.py diff --git a/tests/api/test_labor_api.py b/legacy/tests/api/test_labor_api.py similarity index 100% rename from tests/api/test_labor_api.py rename to legacy/tests/api/test_labor_api.py diff --git a/tests/api/test_locations_api.py b/legacy/tests/api/test_locations_api.py similarity index 94% rename from tests/api/test_locations_api.py rename to legacy/tests/api/test_locations_api.py index 31d979f5..d7b0b808 100644 --- a/tests/api/test_locations_api.py +++ b/legacy/tests/api/test_locations_api.py @@ -4,7 +4,7 @@ from tests.api.api_test_base import ApiTestBase from apimatic_core.utilities.comparison_helper import ComparisonHelper -from square.api_helper import APIHelper +from square_legacy.api_helper import APIHelper class LocationsApiTests(ApiTestBase): diff --git a/tests/api/test_merchants_api.py b/legacy/tests/api/test_merchants_api.py similarity index 100% rename from tests/api/test_merchants_api.py rename to legacy/tests/api/test_merchants_api.py diff --git a/tests/api/test_payments_api.py b/legacy/tests/api/test_payments_api.py similarity index 100% rename from tests/api/test_payments_api.py rename to legacy/tests/api/test_payments_api.py diff --git a/tests/api/test_refunds_api.py b/legacy/tests/api/test_refunds_api.py similarity index 100% rename from tests/api/test_refunds_api.py rename to legacy/tests/api/test_refunds_api.py diff --git a/tests/api/v2_endpoints_tests.py b/legacy/tests/api/v2_endpoints_tests.py similarity index 100% rename from tests/api/v2_endpoints_tests.py rename to legacy/tests/api/v2_endpoints_tests.py diff --git a/tests/http_response_catcher.py b/legacy/tests/http_response_catcher.py similarity index 88% rename from tests/http_response_catcher.py rename to legacy/tests/http_response_catcher.py index 36529b8a..5adcf3f1 100644 --- a/tests/http_response_catcher.py +++ b/legacy/tests/http_response_catcher.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- -from square.http.http_call_back import HttpCallBack +from square_legacy.http.http_call_back import HttpCallBack class HttpResponseCatcher(HttpCallBack): diff --git a/tests/test_helper.py b/legacy/tests/test_helper.py similarity index 100% rename from tests/test_helper.py rename to legacy/tests/test_helper.py diff --git a/tests/utilities/test_webhooks_helper.py b/legacy/tests/utilities/test_webhooks_helper.py similarity index 98% rename from tests/utilities/test_webhooks_helper.py rename to legacy/tests/utilities/test_webhooks_helper.py index 388b003f..d572ecc5 100644 --- a/tests/utilities/test_webhooks_helper.py +++ b/legacy/tests/utilities/test_webhooks_helper.py @@ -1,6 +1,6 @@ from unittest import TestCase -from square.utilities.webhooks_helper import is_valid_webhook_event_signature +from square_legacy.utilities.webhooks_helper import is_valid_webhook_event_signature class TestWebhooksHelper(TestCase): diff --git a/tox.ini b/legacy/tox.ini similarity index 100% rename from tox.ini rename to legacy/tox.ini diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 00000000..b284569a --- /dev/null +++ b/poetry.lock @@ -0,0 +1,540 @@ +# This file is automatically @generated by Poetry 1.8.5 and should not be changed by hand. + +[[package]] +name = "annotated-types" +version = "0.7.0" +description = "Reusable constraint types to use with typing.Annotated" +optional = false +python-versions = ">=3.8" +files = [ + {file = "annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53"}, + {file = "annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89"}, +] + +[package.dependencies] +typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.9\""} + +[[package]] +name = "anyio" +version = "4.5.2" +description = "High level compatibility layer for multiple asynchronous event loop implementations" +optional = false +python-versions = ">=3.8" +files = [ + {file = "anyio-4.5.2-py3-none-any.whl", hash = "sha256:c011ee36bc1e8ba40e5a81cb9df91925c218fe9b778554e0b56a21e1b5d4716f"}, + {file = "anyio-4.5.2.tar.gz", hash = "sha256:23009af4ed04ce05991845451e11ef02fc7c5ed29179ac9a420e5ad0ac7ddc5b"}, +] + +[package.dependencies] +exceptiongroup = {version = ">=1.0.2", markers = "python_version < \"3.11\""} +idna = ">=2.8" +sniffio = ">=1.1" +typing-extensions = {version = ">=4.1", markers = "python_version < \"3.11\""} + +[package.extras] +doc = ["Sphinx (>=7.4,<8.0)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd-theme"] +test = ["anyio[trio]", "coverage[toml] (>=7)", "exceptiongroup (>=1.2.0)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "truststore (>=0.9.1)", "uvloop (>=0.21.0b1)"] +trio = ["trio (>=0.26.1)"] + +[[package]] +name = "certifi" +version = "2025.1.31" +description = "Python package for providing Mozilla's CA Bundle." +optional = false +python-versions = ">=3.6" +files = [ + {file = "certifi-2025.1.31-py3-none-any.whl", hash = "sha256:ca78db4565a652026a4db2bcdf68f2fb589ea80d0be70e03929ed730746b84fe"}, + {file = "certifi-2025.1.31.tar.gz", hash = "sha256:3d5da6925056f6f18f119200434a4780a94263f10d1c21d032a6f6b2baa20651"}, +] + +[[package]] +name = "colorama" +version = "0.4.6" +description = "Cross-platform colored terminal text." +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +files = [ + {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, + {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, +] + +[[package]] +name = "exceptiongroup" +version = "1.2.2" +description = "Backport of PEP 654 (exception groups)" +optional = false +python-versions = ">=3.7" +files = [ + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, +] + +[package.extras] +test = ["pytest (>=6)"] + +[[package]] +name = "h11" +version = "0.14.0" +description = "A pure-Python, bring-your-own-I/O implementation of HTTP/1.1" +optional = false +python-versions = ">=3.7" +files = [ + {file = "h11-0.14.0-py3-none-any.whl", hash = "sha256:e3fe4ac4b851c468cc8363d500db52c2ead036020723024a109d37346efaa761"}, + {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"}, +] + +[[package]] +name = "httpcore" +version = "1.0.8" +description = "A minimal low-level HTTP client." +optional = false +python-versions = ">=3.8" +files = [ + {file = "httpcore-1.0.8-py3-none-any.whl", hash = "sha256:5254cf149bcb5f75e9d1b2b9f729ea4a4b883d1ad7379fc632b727cec23674be"}, + {file = "httpcore-1.0.8.tar.gz", hash = "sha256:86e94505ed24ea06514883fd44d2bc02d90e77e7979c8eb71b90f41d364a1bad"}, +] + +[package.dependencies] +certifi = "*" +h11 = ">=0.13,<0.15" + +[package.extras] +asyncio = ["anyio (>=4.0,<5.0)"] +http2 = ["h2 (>=3,<5)"] +socks = ["socksio (==1.*)"] +trio = ["trio (>=0.22.0,<1.0)"] + +[[package]] +name = "httpx" +version = "0.28.1" +description = "The next generation HTTP client." +optional = false +python-versions = ">=3.8" +files = [ + {file = "httpx-0.28.1-py3-none-any.whl", hash = "sha256:d909fcccc110f8c7faf814ca82a9a4d816bc5a6dbfea25d6591d6985b8ba59ad"}, + {file = "httpx-0.28.1.tar.gz", hash = "sha256:75e98c5f16b0f35b567856f597f06ff2270a374470a5c2392242528e3e3e42fc"}, +] + +[package.dependencies] +anyio = "*" +certifi = "*" +httpcore = "==1.*" +idna = "*" + +[package.extras] +brotli = ["brotli", "brotlicffi"] +cli = ["click (==8.*)", "pygments (==2.*)", "rich (>=10,<14)"] +http2 = ["h2 (>=3,<5)"] +socks = ["socksio (==1.*)"] +zstd = ["zstandard (>=0.18.0)"] + +[[package]] +name = "idna" +version = "3.10" +description = "Internationalized Domain Names in Applications (IDNA)" +optional = false +python-versions = ">=3.6" +files = [ + {file = "idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3"}, + {file = "idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9"}, +] + +[package.extras] +all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"] + +[[package]] +name = "iniconfig" +version = "2.1.0" +description = "brain-dead simple config-ini parsing" +optional = false +python-versions = ">=3.8" +files = [ + {file = "iniconfig-2.1.0-py3-none-any.whl", hash = "sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760"}, + {file = "iniconfig-2.1.0.tar.gz", hash = "sha256:3abbd2e30b36733fee78f9c7f7308f2d0050e88f0087fd25c2645f63c773e1c7"}, +] + +[[package]] +name = "mypy" +version = "1.0.1" +description = "Optional static typing for Python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "mypy-1.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:71a808334d3f41ef011faa5a5cd8153606df5fc0b56de5b2e89566c8093a0c9a"}, + {file = "mypy-1.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:920169f0184215eef19294fa86ea49ffd4635dedfdea2b57e45cb4ee85d5ccaf"}, + {file = "mypy-1.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:27a0f74a298769d9fdc8498fcb4f2beb86f0564bcdb1a37b58cbbe78e55cf8c0"}, + {file = "mypy-1.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:65b122a993d9c81ea0bfde7689b3365318a88bde952e4dfa1b3a8b4ac05d168b"}, + {file = "mypy-1.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:5deb252fd42a77add936b463033a59b8e48eb2eaec2976d76b6878d031933fe4"}, + {file = "mypy-1.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:2013226d17f20468f34feddd6aae4635a55f79626549099354ce641bc7d40262"}, + {file = "mypy-1.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:48525aec92b47baed9b3380371ab8ab6e63a5aab317347dfe9e55e02aaad22e8"}, + {file = "mypy-1.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c96b8a0c019fe29040d520d9257d8c8f122a7343a8307bf8d6d4a43f5c5bfcc8"}, + {file = "mypy-1.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:448de661536d270ce04f2d7dddaa49b2fdba6e3bd8a83212164d4174ff43aa65"}, + {file = "mypy-1.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:d42a98e76070a365a1d1c220fcac8aa4ada12ae0db679cb4d910fabefc88b994"}, + {file = "mypy-1.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e64f48c6176e243ad015e995de05af7f22bbe370dbb5b32bd6988438ec873919"}, + {file = "mypy-1.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5fdd63e4f50e3538617887e9aee91855368d9fc1dea30da743837b0df7373bc4"}, + {file = "mypy-1.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:dbeb24514c4acbc78d205f85dd0e800f34062efcc1f4a4857c57e4b4b8712bff"}, + {file = "mypy-1.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:a2948c40a7dd46c1c33765718936669dc1f628f134013b02ff5ac6c7ef6942bf"}, + {file = "mypy-1.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:5bc8d6bd3b274dd3846597855d96d38d947aedba18776aa998a8d46fabdaed76"}, + {file = "mypy-1.0.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:17455cda53eeee0a4adb6371a21dd3dbf465897de82843751cf822605d152c8c"}, + {file = "mypy-1.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e831662208055b006eef68392a768ff83596035ffd6d846786578ba1714ba8f6"}, + {file = "mypy-1.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:e60d0b09f62ae97a94605c3f73fd952395286cf3e3b9e7b97f60b01ddfbbda88"}, + {file = "mypy-1.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:0af4f0e20706aadf4e6f8f8dc5ab739089146b83fd53cb4a7e0e850ef3de0bb6"}, + {file = "mypy-1.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:24189f23dc66f83b839bd1cce2dfc356020dfc9a8bae03978477b15be61b062e"}, + {file = "mypy-1.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:93a85495fb13dc484251b4c1fd7a5ac370cd0d812bbfc3b39c1bafefe95275d5"}, + {file = "mypy-1.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5f546ac34093c6ce33f6278f7c88f0f147a4849386d3bf3ae193702f4fe31407"}, + {file = "mypy-1.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:c6c2ccb7af7154673c591189c3687b013122c5a891bb5651eca3db8e6c6c55bd"}, + {file = "mypy-1.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:15b5a824b58c7c822c51bc66308e759243c32631896743f030daf449fe3677f3"}, + {file = "mypy-1.0.1-py3-none-any.whl", hash = "sha256:eda5c8b9949ed411ff752b9a01adda31afe7eae1e53e946dbdf9db23865e66c4"}, + {file = "mypy-1.0.1.tar.gz", hash = "sha256:28cea5a6392bb43d266782983b5a4216c25544cd7d80be681a155ddcdafd152d"}, +] + +[package.dependencies] +mypy-extensions = ">=0.4.3" +tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} +typing-extensions = ">=3.10" + +[package.extras] +dmypy = ["psutil (>=4.0)"] +install-types = ["pip"] +python2 = ["typed-ast (>=1.4.0,<2)"] +reports = ["lxml"] + +[[package]] +name = "mypy-extensions" +version = "1.0.0" +description = "Type system extensions for programs checked with the mypy type checker." +optional = false +python-versions = ">=3.5" +files = [ + {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, + {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, +] + +[[package]] +name = "packaging" +version = "24.2" +description = "Core utilities for Python packages" +optional = false +python-versions = ">=3.8" +files = [ + {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"}, + {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"}, +] + +[[package]] +name = "pluggy" +version = "1.5.0" +description = "plugin and hook calling mechanisms for python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"}, + {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"}, +] + +[package.extras] +dev = ["pre-commit", "tox"] +testing = ["pytest", "pytest-benchmark"] + +[[package]] +name = "pydantic" +version = "2.10.6" +description = "Data validation using Python type hints" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pydantic-2.10.6-py3-none-any.whl", hash = "sha256:427d664bf0b8a2b34ff5dd0f5a18df00591adcee7198fbd71981054cef37b584"}, + {file = "pydantic-2.10.6.tar.gz", hash = "sha256:ca5daa827cce33de7a42be142548b0096bf05a7e7b365aebfa5f8eeec7128236"}, +] + +[package.dependencies] +annotated-types = ">=0.6.0" +pydantic-core = "2.27.2" +typing-extensions = ">=4.12.2" + +[package.extras] +email = ["email-validator (>=2.0.0)"] +timezone = ["tzdata"] + +[[package]] +name = "pydantic-core" +version = "2.27.2" +description = "Core functionality for Pydantic validation and serialization" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pydantic_core-2.27.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2d367ca20b2f14095a8f4fa1210f5a7b78b8a20009ecced6b12818f455b1e9fa"}, + {file = "pydantic_core-2.27.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:491a2b73db93fab69731eaee494f320faa4e093dbed776be1a829c2eb222c34c"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7969e133a6f183be60e9f6f56bfae753585680f3b7307a8e555a948d443cc05a"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:3de9961f2a346257caf0aa508a4da705467f53778e9ef6fe744c038119737ef5"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e2bb4d3e5873c37bb3dd58714d4cd0b0e6238cebc4177ac8fe878f8b3aa8e74c"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:280d219beebb0752699480fe8f1dc61ab6615c2046d76b7ab7ee38858de0a4e7"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47956ae78b6422cbd46f772f1746799cbb862de838fd8d1fbd34a82e05b0983a"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:14d4a5c49d2f009d62a2a7140d3064f686d17a5d1a268bc641954ba181880236"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:337b443af21d488716f8d0b6164de833e788aa6bd7e3a39c005febc1284f4962"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_armv7l.whl", hash = "sha256:03d0f86ea3184a12f41a2d23f7ccb79cdb5a18e06993f8a45baa8dfec746f0e9"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7041c36f5680c6e0f08d922aed302e98b3745d97fe1589db0a3eebf6624523af"}, + {file = "pydantic_core-2.27.2-cp310-cp310-win32.whl", hash = "sha256:50a68f3e3819077be2c98110c1f9dcb3817e93f267ba80a2c05bb4f8799e2ff4"}, + {file = "pydantic_core-2.27.2-cp310-cp310-win_amd64.whl", hash = "sha256:e0fd26b16394ead34a424eecf8a31a1f5137094cabe84a1bcb10fa6ba39d3d31"}, + {file = "pydantic_core-2.27.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:8e10c99ef58cfdf2a66fc15d66b16c4a04f62bca39db589ae8cba08bc55331bc"}, + {file = "pydantic_core-2.27.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:26f32e0adf166a84d0cb63be85c562ca8a6fa8de28e5f0d92250c6b7e9e2aff7"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c19d1ea0673cd13cc2f872f6c9ab42acc4e4f492a7ca9d3795ce2b112dd7e15"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5e68c4446fe0810e959cdff46ab0a41ce2f2c86d227d96dc3847af0ba7def306"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d9640b0059ff4f14d1f37321b94061c6db164fbe49b334b31643e0528d100d99"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:40d02e7d45c9f8af700f3452f329ead92da4c5f4317ca9b896de7ce7199ea459"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1c1fd185014191700554795c99b347d64f2bb637966c4cfc16998a0ca700d048"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d81d2068e1c1228a565af076598f9e7451712700b673de8f502f0334f281387d"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:1a4207639fb02ec2dbb76227d7c751a20b1a6b4bc52850568e52260cae64ca3b"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_armv7l.whl", hash = "sha256:3de3ce3c9ddc8bbd88f6e0e304dea0e66d843ec9de1b0042b0911c1663ffd474"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:30c5f68ded0c36466acede341551106821043e9afaad516adfb6e8fa80a4e6a6"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win32.whl", hash = "sha256:c70c26d2c99f78b125a3459f8afe1aed4d9687c24fd677c6a4436bc042e50d6c"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win_amd64.whl", hash = "sha256:08e125dbdc505fa69ca7d9c499639ab6407cfa909214d500897d02afb816e7cc"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win_arm64.whl", hash = "sha256:26f0d68d4b235a2bae0c3fc585c585b4ecc51382db0e3ba402a22cbc440915e4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:9e0c8cfefa0ef83b4da9588448b6d8d2a2bf1a53c3f1ae5fca39eb3061e2f0b0"}, + {file = "pydantic_core-2.27.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:83097677b8e3bd7eaa6775720ec8e0405f1575015a463285a92bfdfe254529ef"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:172fce187655fece0c90d90a678424b013f8fbb0ca8b036ac266749c09438cb7"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:519f29f5213271eeeeb3093f662ba2fd512b91c5f188f3bb7b27bc5973816934"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:05e3a55d124407fffba0dd6b0c0cd056d10e983ceb4e5dbd10dda135c31071d6"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9c3ed807c7b91de05e63930188f19e921d1fe90de6b4f5cd43ee7fcc3525cb8c"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6fb4aadc0b9a0c063206846d603b92030eb6f03069151a625667f982887153e2"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:28ccb213807e037460326424ceb8b5245acb88f32f3d2777427476e1b32c48c4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:de3cd1899e2c279b140adde9357c4495ed9d47131b4a4eaff9052f23398076b3"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:220f892729375e2d736b97d0e51466252ad84c51857d4d15f5e9692f9ef12be4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a0fcd29cd6b4e74fe8ddd2c90330fd8edf2e30cb52acda47f06dd615ae72da57"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win32.whl", hash = "sha256:1e2cb691ed9834cd6a8be61228471d0a503731abfb42f82458ff27be7b2186fc"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win_amd64.whl", hash = "sha256:cc3f1a99a4f4f9dd1de4fe0312c114e740b5ddead65bb4102884b384c15d8bc9"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win_arm64.whl", hash = "sha256:3911ac9284cd8a1792d3cb26a2da18f3ca26c6908cc434a18f730dc0db7bfa3b"}, + {file = "pydantic_core-2.27.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:7d14bd329640e63852364c306f4d23eb744e0f8193148d4044dd3dacdaacbd8b"}, + {file = "pydantic_core-2.27.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:82f91663004eb8ed30ff478d77c4d1179b3563df6cdb15c0817cd1cdaf34d154"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:71b24c7d61131bb83df10cc7e687433609963a944ccf45190cfc21e0887b08c9"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa8e459d4954f608fa26116118bb67f56b93b209c39b008277ace29937453dc9"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ce8918cbebc8da707ba805b7fd0b382816858728ae7fe19a942080c24e5b7cd1"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:eda3f5c2a021bbc5d976107bb302e0131351c2ba54343f8a496dc8783d3d3a6a"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bd8086fa684c4775c27f03f062cbb9eaa6e17f064307e86b21b9e0abc9c0f02e"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:8d9b3388db186ba0c099a6d20f0604a44eabdeef1777ddd94786cdae158729e4"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:7a66efda2387de898c8f38c0cf7f14fca0b51a8ef0b24bfea5849f1b3c95af27"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:18a101c168e4e092ab40dbc2503bdc0f62010e95d292b27827871dc85450d7ee"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:ba5dd002f88b78a4215ed2f8ddbdf85e8513382820ba15ad5ad8955ce0ca19a1"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win32.whl", hash = "sha256:1ebaf1d0481914d004a573394f4be3a7616334be70261007e47c2a6fe7e50130"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win_amd64.whl", hash = "sha256:953101387ecf2f5652883208769a79e48db18c6df442568a0b5ccd8c2723abee"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win_arm64.whl", hash = "sha256:ac4dbfd1691affb8f48c2c13241a2e3b60ff23247cbcf981759c768b6633cf8b"}, + {file = "pydantic_core-2.27.2-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:d3e8d504bdd3f10835468f29008d72fc8359d95c9c415ce6e767203db6127506"}, + {file = "pydantic_core-2.27.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:521eb9b7f036c9b6187f0b47318ab0d7ca14bd87f776240b90b21c1f4f149320"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85210c4d99a0114f5a9481b44560d7d1e35e32cc5634c656bc48e590b669b145"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d716e2e30c6f140d7560ef1538953a5cd1a87264c737643d481f2779fc247fe1"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f66d89ba397d92f840f8654756196d93804278457b5fbede59598a1f9f90b228"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:669e193c1c576a58f132e3158f9dfa9662969edb1a250c54d8fa52590045f046"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9fdbe7629b996647b99c01b37f11170a57ae675375b14b8c13b8518b8320ced5"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d262606bf386a5ba0b0af3b97f37c83d7011439e3dc1a9298f21efb292e42f1a"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:cabb9bcb7e0d97f74df8646f34fc76fbf793b7f6dc2438517d7a9e50eee4f14d"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_armv7l.whl", hash = "sha256:d2d63f1215638d28221f664596b1ccb3944f6e25dd18cd3b86b0a4c408d5ebb9"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:bca101c00bff0adb45a833f8451b9105d9df18accb8743b08107d7ada14bd7da"}, + {file = "pydantic_core-2.27.2-cp38-cp38-win32.whl", hash = "sha256:f6f8e111843bbb0dee4cb6594cdc73e79b3329b526037ec242a3e49012495b3b"}, + {file = "pydantic_core-2.27.2-cp38-cp38-win_amd64.whl", hash = "sha256:fd1aea04935a508f62e0d0ef1f5ae968774a32afc306fb8545e06f5ff5cdf3ad"}, + {file = "pydantic_core-2.27.2-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:c10eb4f1659290b523af58fa7cffb452a61ad6ae5613404519aee4bfbf1df993"}, + {file = "pydantic_core-2.27.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ef592d4bad47296fb11f96cd7dc898b92e795032b4894dfb4076cfccd43a9308"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c61709a844acc6bf0b7dce7daae75195a10aac96a596ea1b776996414791ede4"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:42c5f762659e47fdb7b16956c71598292f60a03aa92f8b6351504359dbdba6cf"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4c9775e339e42e79ec99c441d9730fccf07414af63eac2f0e48e08fd38a64d76"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:57762139821c31847cfb2df63c12f725788bd9f04bc2fb392790959b8f70f118"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0d1e85068e818c73e048fe28cfc769040bb1f475524f4745a5dc621f75ac7630"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:097830ed52fd9e427942ff3b9bc17fab52913b2f50f2880dc4a5611446606a54"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:044a50963a614ecfae59bb1eaf7ea7efc4bc62f49ed594e18fa1e5d953c40e9f"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_armv7l.whl", hash = "sha256:4e0b4220ba5b40d727c7f879eac379b822eee5d8fff418e9d3381ee45b3b0362"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5e4f4bb20d75e9325cc9696c6802657b58bc1dbbe3022f32cc2b2b632c3fbb96"}, + {file = "pydantic_core-2.27.2-cp39-cp39-win32.whl", hash = "sha256:cca63613e90d001b9f2f9a9ceb276c308bfa2a43fafb75c8031c4f66039e8c6e"}, + {file = "pydantic_core-2.27.2-cp39-cp39-win_amd64.whl", hash = "sha256:77d1bca19b0f7021b3a982e6f903dcd5b2b06076def36a652e3907f596e29f67"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:2bf14caea37e91198329b828eae1618c068dfb8ef17bb33287a7ad4b61ac314e"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:b0cb791f5b45307caae8810c2023a184c74605ec3bcbb67d13846c28ff731ff8"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:688d3fd9fcb71f41c4c015c023d12a79d1c4c0732ec9eb35d96e3388a120dcf3"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3d591580c34f4d731592f0e9fe40f9cc1b430d297eecc70b962e93c5c668f15f"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:82f986faf4e644ffc189a7f1aafc86e46ef70372bb153e7001e8afccc6e54133"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:bec317a27290e2537f922639cafd54990551725fc844249e64c523301d0822fc"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:0296abcb83a797db256b773f45773da397da75a08f5fcaef41f2044adec05f50"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:0d75070718e369e452075a6017fbf187f788e17ed67a3abd47fa934d001863d9"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:7e17b560be3c98a8e3aa66ce828bdebb9e9ac6ad5466fba92eb74c4c95cb1151"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:c33939a82924da9ed65dab5a65d427205a73181d8098e79b6b426bdf8ad4e656"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:00bad2484fa6bda1e216e7345a798bd37c68fb2d97558edd584942aa41b7d278"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c817e2b40aba42bac6f457498dacabc568c3b7a986fc9ba7c8d9d260b71485fb"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:251136cdad0cb722e93732cb45ca5299fb56e1344a833640bf93b2803f8d1bfd"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d2088237af596f0a524d3afc39ab3b036e8adb054ee57cbb1dcf8e09da5b29cc"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:d4041c0b966a84b4ae7a09832eb691a35aec90910cd2dbe7a208de59be77965b"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:8083d4e875ebe0b864ffef72a4304827015cff328a1be6e22cc850753bfb122b"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f141ee28a0ad2123b6611b6ceff018039df17f32ada8b534e6aa039545a3efb2"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7d0c8399fcc1848491f00e0314bd59fb34a9c008761bcb422a057670c3f65e35"}, + {file = "pydantic_core-2.27.2.tar.gz", hash = "sha256:eb026e5a4c1fee05726072337ff51d1efb6f59090b7da90d30ea58625b1ffb39"}, +] + +[package.dependencies] +typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0" + +[[package]] +name = "pytest" +version = "7.4.4" +description = "pytest: simple powerful testing with Python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"}, + {file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "sys_platform == \"win32\""} +exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""} +iniconfig = "*" +packaging = "*" +pluggy = ">=0.12,<2.0" +tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""} + +[package.extras] +testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] + +[[package]] +name = "pytest-asyncio" +version = "0.23.8" +description = "Pytest support for asyncio" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pytest_asyncio-0.23.8-py3-none-any.whl", hash = "sha256:50265d892689a5faefb84df80819d1ecef566eb3549cf915dfb33569359d1ce2"}, + {file = "pytest_asyncio-0.23.8.tar.gz", hash = "sha256:759b10b33a6dc61cce40a8bd5205e302978bbbcc00e279a8b61d9a6a3c82e4d3"}, +] + +[package.dependencies] +pytest = ">=7.0.0,<9" + +[package.extras] +docs = ["sphinx (>=5.3)", "sphinx-rtd-theme (>=1.0)"] +testing = ["coverage (>=6.2)", "hypothesis (>=5.7.1)"] + +[[package]] +name = "python-dateutil" +version = "2.9.0.post0" +description = "Extensions to the standard Python datetime module" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, + {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, +] + +[package.dependencies] +six = ">=1.5" + +[[package]] +name = "ruff" +version = "0.5.7" +description = "An extremely fast Python linter and code formatter, written in Rust." +optional = false +python-versions = ">=3.7" +files = [ + {file = "ruff-0.5.7-py3-none-linux_armv6l.whl", hash = "sha256:548992d342fc404ee2e15a242cdbea4f8e39a52f2e7752d0e4cbe88d2d2f416a"}, + {file = "ruff-0.5.7-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:00cc8872331055ee017c4f1071a8a31ca0809ccc0657da1d154a1d2abac5c0be"}, + {file = "ruff-0.5.7-py3-none-macosx_11_0_arm64.whl", hash = "sha256:eaf3d86a1fdac1aec8a3417a63587d93f906c678bb9ed0b796da7b59c1114a1e"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a01c34400097b06cf8a6e61b35d6d456d5bd1ae6961542de18ec81eaf33b4cb8"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fcc8054f1a717e2213500edaddcf1dbb0abad40d98e1bd9d0ad364f75c763eea"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7f70284e73f36558ef51602254451e50dd6cc479f8b6f8413a95fcb5db4a55fc"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:a78ad870ae3c460394fc95437d43deb5c04b5c29297815a2a1de028903f19692"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9ccd078c66a8e419475174bfe60a69adb36ce04f8d4e91b006f1329d5cd44bcf"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7e31c9bad4ebf8fdb77b59cae75814440731060a09a0e0077d559a556453acbb"}, + {file = "ruff-0.5.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8d796327eed8e168164346b769dd9a27a70e0298d667b4ecee6877ce8095ec8e"}, + {file = "ruff-0.5.7-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:4a09ea2c3f7778cc635e7f6edf57d566a8ee8f485f3c4454db7771efb692c499"}, + {file = "ruff-0.5.7-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:a36d8dcf55b3a3bc353270d544fb170d75d2dff41eba5df57b4e0b67a95bb64e"}, + {file = "ruff-0.5.7-py3-none-musllinux_1_2_i686.whl", hash = "sha256:9369c218f789eefbd1b8d82a8cf25017b523ac47d96b2f531eba73770971c9e5"}, + {file = "ruff-0.5.7-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:b88ca3db7eb377eb24fb7c82840546fb7acef75af4a74bd36e9ceb37a890257e"}, + {file = "ruff-0.5.7-py3-none-win32.whl", hash = "sha256:33d61fc0e902198a3e55719f4be6b375b28f860b09c281e4bdbf783c0566576a"}, + {file = "ruff-0.5.7-py3-none-win_amd64.whl", hash = "sha256:083bbcbe6fadb93cd86709037acc510f86eed5a314203079df174c40bbbca6b3"}, + {file = "ruff-0.5.7-py3-none-win_arm64.whl", hash = "sha256:2dca26154ff9571995107221d0aeaad0e75a77b5a682d6236cf89a58c70b76f4"}, + {file = "ruff-0.5.7.tar.gz", hash = "sha256:8dfc0a458797f5d9fb622dd0efc52d796f23f0a1493a9527f4e49a550ae9a7e5"}, +] + +[[package]] +name = "six" +version = "1.17.0" +description = "Python 2 and 3 compatibility utilities" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274"}, + {file = "six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81"}, +] + +[[package]] +name = "sniffio" +version = "1.3.1" +description = "Sniff out which async library your code is running under" +optional = false +python-versions = ">=3.7" +files = [ + {file = "sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2"}, + {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"}, +] + +[[package]] +name = "tomli" +version = "2.2.1" +description = "A lil' TOML parser" +optional = false +python-versions = ">=3.8" +files = [ + {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"}, + {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"}, + {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a"}, + {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee"}, + {file = "tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e"}, + {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4"}, + {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106"}, + {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8"}, + {file = "tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff"}, + {file = "tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b"}, + {file = "tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea"}, + {file = "tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8"}, + {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192"}, + {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222"}, + {file = "tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77"}, + {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6"}, + {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd"}, + {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e"}, + {file = "tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98"}, + {file = "tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4"}, + {file = "tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7"}, + {file = "tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c"}, + {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13"}, + {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281"}, + {file = "tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272"}, + {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140"}, + {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2"}, + {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744"}, + {file = "tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec"}, + {file = "tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69"}, + {file = "tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc"}, + {file = "tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff"}, +] + +[[package]] +name = "types-python-dateutil" +version = "2.9.0.20241206" +description = "Typing stubs for python-dateutil" +optional = false +python-versions = ">=3.8" +files = [ + {file = "types_python_dateutil-2.9.0.20241206-py3-none-any.whl", hash = "sha256:e248a4bc70a486d3e3ec84d0dc30eec3a5f979d6e7ee4123ae043eedbb987f53"}, + {file = "types_python_dateutil-2.9.0.20241206.tar.gz", hash = "sha256:18f493414c26ffba692a72369fea7a154c502646301ebfe3d56a04b3767284cb"}, +] + +[[package]] +name = "typing-extensions" +version = "4.13.2" +description = "Backported and Experimental Type Hints for Python 3.8+" +optional = false +python-versions = ">=3.8" +files = [ + {file = "typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c"}, + {file = "typing_extensions-4.13.2.tar.gz", hash = "sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef"}, +] + +[metadata] +lock-version = "2.0" +python-versions = "^3.8" +content-hash = "6f6c191c1028d17a97fdfa84cedfd3cef94b5d63d98b8c1d333b3398eeea9055" diff --git a/pyproject.toml b/pyproject.toml index 340b9c48..2c294cf5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,15 +1,65 @@ -[build-system] -build-backend = "setuptools.build_meta" -requires = ["setuptools>=61.0"] [project] name = "squareup" -description = "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management." -version = "41.0.0.20250319" + +[tool.poetry] +name = "squareup" +version = "42.0.0.20250416" +description = "" readme = "README.md" -requires-python = ">=3.7" -authors = [{name = "Square Developer Platform", email = "developers@squareup.com"}] -dependencies = ["apimatic-core~=0.2.0, >= 0.2.17", "apimatic-core-interfaces~=0.1.0, >= 0.1.5", "apimatic-requests-client-adapter~=0.1.0, >= 0.1.6", "deprecation~=2.1"] -[project.optional-dependencies] -testutils = ["pytest>=7.2.2"] -[tool.setuptools.packages.find] -exclude = ["tests", "tests.*"] +authors = [] +keywords = [] +license = "MIT" +classifiers = [ + "Intended Audience :: Developers", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Operating System :: OS Independent", + "Operating System :: POSIX", + "Operating System :: MacOS", + "Operating System :: POSIX :: Linux", + "Operating System :: Microsoft :: Windows", + "Topic :: Software Development :: Libraries :: Python Modules", + "Typing :: Typed", + "License :: OSI Approved :: MIT License" +] +packages = [ + { include = "square", from = "src"} +] + +[project.urls] +Repository = 'https://github.com/square/square-python-sdk' + +[tool.poetry.dependencies] +python = "^3.8" +httpx = ">=0.21.2" +pydantic = ">= 1.9.2" +pydantic-core = "^2.18.2" +typing_extensions = ">= 4.0.0" + +[tool.poetry.dev-dependencies] +mypy = "1.0.1" +pytest = "^7.4.0" +pytest-asyncio = "^0.23.5" +python-dateutil = "^2.9.0" +types-python-dateutil = "^2.9.0.20240316" +ruff = "^0.5.6" + +[tool.pytest.ini_options] +testpaths = [ "tests" ] +asyncio_mode = "auto" + +[tool.mypy] +plugins = ["pydantic.mypy"] + +[tool.ruff] +line-length = 120 + + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" diff --git a/python-migration-guide.md b/python-migration-guide.md deleted file mode 100644 index 5bb15ed2..00000000 --- a/python-migration-guide.md +++ /dev/null @@ -1,110 +0,0 @@ -## Migration guide - -Follow the instructions below to migrate your apps from the deprecated `squareconnect` library to the new `square`library. - -### Install the new library - -Install the [latest SDK](https://github.com/square/square-python-sdk) using pip: -```python -pip install squareup -``` - - -### Update your code - -1. Change all instances of `import 'squareconnect'` to `import 'square'`. -1. Replace models with plain Python dictionary equivalents. -1. Update client instantiation to follow the method outlined below. -1. Update code for accessing response data to follow the method outlined below. -1. Check `response.is_success` or `response.is_error` rather than rescuing - exceptions for flow control. - -We also recommend that you use method chaining to access APIs instead of explicitly instantiating them to simplify your code. - -#### Client instantiation - -```python -from square.client import Client - -square = Client( - access_token='YOUR ACCESS TOKEN' -) - -response = square.API.ENDPOINT(body=BODY) -``` - -#### Accessing response data - -```python -if response.is_success(): - print({response.body}) -elif response.is_error(): - print({response.errors}) -``` - -### An example code migration - -As a specific example, consider the following code for creating a new customer from this dictionary: - -```python -new_customer = { - 'given_name': 'Ava', - 'address': { - 'address_line_1': '555 Electric Ave', - 'locality': 'Los Angeles', - 'country': 'US' - } -} -``` - -With the deprecated `squareconnect` library, this is how you instantiate a client for the Customers API, format the request, and call the endpoint: -```python -from squareconnect import ApiClient -from squareconnect.rest import ApiException -from squareconnect.apis.customers_api import CustomersApi -from squareconnect.models.create_customer_request import CreateCustomerRequest - -# Instantiate the client -api_client = ApiClient() -api_client.configuration.access_token = 'YOUR ACCESS TOKEN' -api_instance = CustomersApi(api_client) -create_customer_request = CreateCustomerRequest( - given_name=new_customer['given_name'], - address=new_customer['address'], -) - -try: - api_response = api_instance.create_customer(create_customer_request) - print(f"Success: {api_response.customer}") -except ApiException as err: - print(f"Exception when calling CustomersApi->create_customer: {err}") -``` - -Now consider equivalent code using the new `square` library: - -```python -from square.client import Client -# Initialize client -client = Client( - access_token='YOUR ACCESS TOKEN', -) - -# Get an instance of the Square API you want call -api_customers = client.customers - -# Call create_customer method to create a new customer -result = api_customers.create_customer(new_customer) -if result.is_success(): - # Display the response as text - print(f"Success: {result.text}") -# Call the error method to see if the call failed -elif result.is_error(): - print(f"Errors: {result.errors}") -``` - -That's it! What was once a multi-block process can be handled in 2 lines of code and an `if/elif` block. Migrating to the `square` library reduces boilerplate and lets you can focus on the parts of your code that really matter. - -### Ask the Community - -Please join us in our [Square developer community](https://discord.com/invite/squaredev) if you -have any questions! diff --git a/reference.md b/reference.md new file mode 100644 index 00000000..1c65cbfb --- /dev/null +++ b/reference.md @@ -0,0 +1,29934 @@ +# Reference +## Mobile +
client.mobile.authorization_code(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +__Note:__ This endpoint is used by the deprecated Reader SDK. +Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. + +Generates code to authorize a mobile application to connect to a Square card reader. + +Authorization codes are one-time-use codes and expire 60 minutes after being issued. + +The `Authorization` header you provide to this endpoint must have the following format: + +``` +Authorization: Bearer ACCESS_TOKEN +``` + +Replace `ACCESS_TOKEN` with a +[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.mobile.authorization_code( + location_id="YOUR_LOCATION_ID", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` — The Square location ID that the authorization code should be tied to. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## OAuth +
client.o_auth.revoke_token(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Revokes an access token generated with the OAuth flow. + +If an account has more than one OAuth access token for your application, this +endpoint revokes all of them, regardless of which token you specify. + +__Important:__ The `Authorization` header for this endpoint must have the +following format: + +``` +Authorization: Client APPLICATION_SECRET +``` + +Replace `APPLICATION_SECRET` with the application secret on the **OAuth** +page for your application in the Developer Dashboard. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.o_auth.revoke_token( + client_id="CLIENT_ID", + access_token="ACCESS_TOKEN", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**client_id:** `typing.Optional[str]` + +The Square-issued ID for your application, which is available on the **OAuth** page in the +[Developer Dashboard](https://developer.squareup.com/apps). + +
+
+ +
+
+ +**access_token:** `typing.Optional[str]` + +The access token of the merchant whose token you want to revoke. +Do not provide a value for `merchant_id` if you provide this parameter. + +
+
+ +
+
+ +**merchant_id:** `typing.Optional[str]` + +The ID of the merchant whose token you want to revoke. +Do not provide a value for `access_token` if you provide this parameter. + +
+
+ +
+
+ +**revoke_only_access_token:** `typing.Optional[bool]` + +If `true`, terminate the given single access token, but do not +terminate the entire authorization. +Default: `false` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.o_auth.obtain_token(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns an OAuth access token and refresh token using the `authorization_code` +or `refresh_token` grant type. + +When `grant_type` is `authorization_code`: +- With the [code flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow), +provide `code`, `client_id`, and `client_secret`. +- With the [PKCE flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow), +provide `code`, `client_id`, and `code_verifier`. + +When `grant_type` is `refresh_token`: +- With the code flow, provide `refresh_token`, `client_id`, and `client_secret`. +The response returns the same refresh token provided in the request. +- With the PKCE flow, provide `refresh_token` and `client_id`. The response returns +a new refresh token. + +You can use the `scopes` parameter to limit the set of permissions authorized by the +access token. You can use the `short_lived` parameter to create an access token that +expires in 24 hours. + +__Important:__ OAuth tokens should be encrypted and stored on a secure server. +Application clients should never interact directly with OAuth tokens. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.o_auth.obtain_token( + client_id="sq0idp-uaPHILoPzWZk3tlJqlML0g", + client_secret="sq0csp-30a-4C_tVOnTh14Piza2BfTPBXyLafLPWSzY1qAjeBfM", + code="sq0cgb-l0SBqxs4uwxErTVyYOdemg", + grant_type="authorization_code", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**client_id:** `str` + +The Square-issued ID of your application, which is available as the **Application ID** +on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + +Required for the code flow and PKCE flow for any grant type. + +
+
+ +
+
+ +**grant_type:** `str` + +The method used to obtain an OAuth access token. The request must include the +credential that corresponds to the specified grant type. Valid values are: +- `authorization_code` - Requires the `code` field. +- `refresh_token` - Requires the `refresh_token` field. +- `migration_token` - LEGACY for access tokens obtained using a Square API version prior +to 2019-03-13. Requires the `migration_token` field. + +
+
+ +
+
+ +**client_secret:** `typing.Optional[str]` + +The secret key for your application, which is available as the **Application secret** +on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + +Required for the code flow for any grant type. Don't confuse your client secret with your +personal access token. + +
+
+ +
+
+ +**code:** `typing.Optional[str]` + +The authorization code to exchange for an OAuth access token. This is the `code` +value that Square sent to your redirect URL in the authorization response. + +Required for the code flow and PKCE flow if `grant_type` is `authorization_code`. + +
+
+ +
+
+ +**redirect_uri:** `typing.Optional[str]` + +The redirect URL for your application, which you registered as the **Redirect URL** +on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + +Required for the code flow and PKCE flow if `grant_type` is `authorization_code` and +you provided the `redirect_uri` parameter in your authorization URL. + +
+
+ +
+
+ +**refresh_token:** `typing.Optional[str]` + +A valid refresh token used to generate a new OAuth access token. This is a +refresh token that was returned in a previous `ObtainToken` response. + +Required for the code flow and PKCE flow if `grant_type` is `refresh_token`. + +
+
+ +
+
+ +**migration_token:** `typing.Optional[str]` + +__LEGACY__ A valid access token (obtained using a Square API version prior to 2019-03-13) +used to generate a new OAuth access token. + +Required if `grant_type` is `migration_token`. For more information, see +[Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). + +
+
+ +
+
+ +**scopes:** `typing.Optional[typing.Sequence[str]]` + +The list of permissions that are explicitly requested for the access token. +For example, ["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]. + +The returned access token is limited to the permissions that are the intersection +of these requested permissions and those authorized by the provided `refresh_token`. + +Optional for the code flow and PKCE flow if `grant_type` is `refresh_token`. + +
+
+ +
+
+ +**short_lived:** `typing.Optional[bool]` + +Indicates whether the returned access token should expire in 24 hours. + +Optional for the code flow and PKCE flow for any grant type. The default value is `false`. + +
+
+ +
+
+ +**code_verifier:** `typing.Optional[str]` + +The secret your application generated for the authorization request used to +obtain the authorization code. This is the source of the `code_challenge` hash you +provided in your authorization URL. + +Required for the PKCE flow if `grant_type` is `authorization_code`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.o_auth.retrieve_token_status() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token). + +Add the access token to the Authorization header of the request. + +__Important:__ The `Authorization` header you provide to this endpoint must have the following format: + +``` +Authorization: Bearer ACCESS_TOKEN +``` + +where `ACCESS_TOKEN` is a +[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + +If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.o_auth.retrieve_token_status() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.o_auth.authorize() +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.o_auth.authorize() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## V1Transactions +
client.v1transactions.v1list_orders(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides summary information for a merchant's online store orders. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.v1transactions.v1list_orders( + location_id="location_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to list online store orders for. + +
+
+ +
+
+ +**order:** `typing.Optional[SortOrder]` — The order in which payments are listed in the response. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of payments to return in a single response. This value cannot exceed 200. + +
+
+ +
+
+ +**batch_token:** `typing.Optional[str]` + +A pagination cursor to retrieve the next set of results for your +original query to the endpoint. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.v1transactions.v1retrieve_order(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides comprehensive information for a single online store order, including the order's history. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.v1transactions.v1retrieve_order( + location_id="location_id", + order_id="order_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the order's associated location. + +
+
+ +
+
+ +**order_id:** `str` — The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.v1transactions.v1update_order(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.v1transactions.v1update_order( + location_id="location_id", + order_id="order_id", + action="COMPLETE", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the order's associated location. + +
+
+ +
+
+ +**order_id:** `str` — The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + +
+
+ +
+
+ +**action:** `V1UpdateOrderRequestAction` + +The action to perform on the order (COMPLETE, CANCEL, or REFUND). +See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values + +
+
+ +
+
+ +**shipped_tracking_number:** `typing.Optional[str]` — The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. + +
+
+ +
+
+ +**completed_note:** `typing.Optional[str]` — A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. + +
+
+ +
+
+ +**refunded_note:** `typing.Optional[str]` — A merchant-specified note about the refunding of the order. Only valid if action is REFUND. + +
+
+ +
+
+ +**canceled_note:** `typing.Optional[str]` — A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## ApplePay +
client.apple_pay.register_domain(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Activates a domain for use with Apple Pay on the Web and Square. A validation +is performed on this domain by Apple to ensure that it is properly set up as +an Apple Pay enabled domain. + +This endpoint provides an easy way for platform developers to bulk activate +Apple Pay on the Web with Square for merchants using their platform. + +Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The +current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, +and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your +domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding +long-lived caches that might not keep in sync with the correct file version. + +To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.apple_pay.register_domain( + domain_name="example.com", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**domain_name:** `str` — A domain name as described in RFC-1034 that will be registered with ApplePay. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## BankAccounts +
client.bank_accounts.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.bank_accounts.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The pagination cursor returned by a previous call to this endpoint. +Use it in the next `ListBankAccounts` request to retrieve the next set +of results. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +Upper limit on the number of bank accounts to return in the response. +Currently, 1000 is the largest supported limit. You can specify a limit +of up to 1000 bank accounts. This is also the default limit. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +Location ID. You can specify this optional filter +to retrieve only the linked bank accounts belonging to a specific location. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bank_accounts.get_by_v1id(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bank_accounts.get_by_v1id( + v1bank_account_id="v1_bank_account_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**v1bank_account_id:** `str` + +Connect V1 ID of the desired `BankAccount`. For more information, see +[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bank_accounts.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns details of a [BankAccount](entity:BankAccount) +linked to a Square account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bank_accounts.get( + bank_account_id="bank_account_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**bank_account_id:** `str` — Square-issued ID of the desired `BankAccount`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Bookings +
client.bookings.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a collection of bookings. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.bookings.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of results per page to return in a paged response. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + +
+
+ +
+
+ +**customer_id:** `typing.Optional[str]` — The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved. + +
+
+ +
+
+ +**team_member_id:** `typing.Optional[str]` — The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` — The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved. + +
+
+ +
+
+ +**start_at_min:** `typing.Optional[str]` — The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used. + +
+
+ +
+
+ +**start_at_max:** `typing.Optional[str]` — The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a booking. + +The required input must include the following: +- `Booking.location_id` +- `Booking.start_at` +- `Booking.AppointmentSegment.team_member_id` +- `Booking.AppointmentSegment.service_variation_id` +- `Booking.AppointmentSegment.service_variation_version` + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.create( + booking={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking:** `BookingParams` — The details of the booking to be created. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique key to make this request an idempotent operation. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.search_availability(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for availabilities for booking. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.search_availability( + query={"filter": {"start_at_range": {}}}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `SearchAvailabilityQueryParams` — Query conditions used to filter buyer-accessible booking availabilities. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.bulk_retrieve_bookings(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Bulk-Retrieves a list of bookings by booking IDs. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.bulk_retrieve_bookings( + booking_ids=["booking_ids"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_ids:** `typing.Sequence[str]` — A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.get_business_profile() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a seller's booking profile. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.get_business_profile() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.retrieve_location_booking_profile(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a seller's location booking profile. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.retrieve_location_booking_profile( + location_id="location_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to retrieve the booking profile. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.bulk_retrieve_team_member_booking_profiles(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves one or more team members' booking profiles. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.bulk_retrieve_team_member_booking_profiles( + team_member_ids=["team_member_ids"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_ids:** `typing.Sequence[str]` — A non-empty list of IDs of team members whose booking profiles you want to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a booking. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.get( + booking_id="booking_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a booking. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.update( + booking_id="booking_id", + booking={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the [Booking](entity:Booking) object representing the to-be-updated booking. + +
+
+ +
+
+ +**booking:** `BookingParams` — The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique key to make this request an idempotent operation. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels an existing booking. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.cancel( + booking_id="booking_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique key to make this request an idempotent operation. + +
+
+ +
+
+ +**booking_version:** `typing.Optional[int]` — The revision number for the booking used for optimistic concurrency. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Cards +
client.cards.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a list of cards owned by the account making the request. +A max of 25 cards will be returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.cards.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for your original query. + +See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + +
+
+ +
+
+ +**customer_id:** `typing.Optional[str]` + +Limit results to cards associated with the customer supplied. +By default, all cards owned by the merchant are returned. + +
+
+ +
+
+ +**include_disabled:** `typing.Optional[bool]` + +Includes disabled cards. +By default, all enabled cards owned by the merchant are returned. + +
+
+ +
+
+ +**reference_id:** `typing.Optional[str]` — Limit results to cards associated with the reference_id supplied. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +Sorts the returned list by when the card was created with the specified order. +This field defaults to ASC. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.cards.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Adds a card on file to an existing merchant. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.cards.create( + idempotency_key="4935a656-a929-4792-b97c-8848be85c27c", + source_id="cnon:uIbfJXhXETSP197M3GB", + card={ + "cardholder_name": "Amelia Earhart", + "billing_address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "reference_id": "user-id-1", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this CreateCard request. Keys can be +any valid string and must be unique for every request. + +Max: 45 characters + +See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + +
+
+ +
+
+ +**source_id:** `str` — The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. + +
+
+ +
+
+ +**card:** `CardParams` — Payment details associated with the card to be stored. + +
+
+ +
+
+ +**verification_token:** `typing.Optional[str]` + +An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). +Verification tokens encapsulate customer device information and 3-D Secure +challenge results to indicate that Square has verified the buyer identity. + +See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.cards.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves details for a specific Card. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.cards.get( + card_id="card_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**card_id:** `str` — Unique ID for the desired Card. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.cards.disable(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Disables the card, preventing any further updates or charges. +Disabling an already disabled card is allowed but has no effect. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.cards.disable( + card_id="card_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**card_id:** `str` — Unique ID for the desired Card. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Catalog +
client.catalog.batch_delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a set of [CatalogItem](entity:CatalogItem)s based on the +provided list of target IDs and returns a set of successfully deleted IDs in +the response. Deletion is a cascading event such that all children of the +targeted object are also deleted. For example, deleting a CatalogItem will +also delete all of its [CatalogItemVariation](entity:CatalogItemVariation) +children. + +`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted +IDs can be deleted. The response will only include IDs that were +actually deleted. + +To ensure consistency, only one delete request is processed at a time per seller account. +While one (batch or non-batch) delete request is being processed, other (batched and non-batched) +delete requests are rejected with the `429` error code. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.batch_delete( + object_ids=["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**object_ids:** `typing.Sequence[str]` + +The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects +in the graph that depend on that object will be deleted as well (for example, deleting a +CatalogItem will delete its CatalogItemVariation. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.batch_get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a set of objects based on the provided ID. +Each [CatalogItem](entity:CatalogItem) returned in the set includes all of its +child information including: all of its +[CatalogItemVariation](entity:CatalogItemVariation) objects, references to +its [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of +any [CatalogTax](entity:CatalogTax) objects that apply to it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.batch_get( + object_ids=["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"], + include_related_objects=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**object_ids:** `typing.Sequence[str]` — The IDs of the CatalogObjects to be retrieved. + +
+
+ +
+
+ +**include_related_objects:** `typing.Optional[bool]` + +If `true`, the response will include additional objects that are related to the +requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field +of the response. These objects are put in the `related_objects` field. Setting this to `true` is +helpful when the objects are needed for immediate display to a user. +This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + +if the `objects` field of the response contains a CatalogItem, its associated +CatalogCategory objects, CatalogTax objects, CatalogImage objects and +CatalogModifierLists will be returned in the `related_objects` field of the +response. If the `objects` field of the response contains a CatalogItemVariation, +its parent CatalogItem will be returned in the `related_objects` field of +the response. + +Default value: `false` + +
+
+ +
+
+ +**catalog_version:** `typing.Optional[int]` + +The specific version of the catalog objects to be included in the response. +This allows you to retrieve historical versions of objects. The specified version value is matched against +the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will +be from the current version of the catalog. + +
+
+ +
+
+ +**include_deleted_objects:** `typing.Optional[bool]` — Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. + +
+
+ +
+
+ +**include_category_path_to_root:** `typing.Optional[bool]` + +Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists +of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category +and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned +in the response payload. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.batch_upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates up to 10,000 target objects based on the provided +list of objects. The target objects are grouped into batches and each batch is +inserted/updated in an all-or-nothing manner. If an object within a batch is +malformed in some way, or violates a database constraint, the entire batch +containing that item will be disregarded. However, other batches in the same +request may still succeed. Each batch may contain up to 1,000 objects, and +batches will be processed in order as long as the total object count for the +request (items, variations, modifier lists, discounts, and taxes) is no more +than 10,000. + +To ensure consistency, only one update request is processed at a time per seller account. +While one (batch or non-batch) update request is being processed, other (batched and non-batched) +update requests are rejected with the `429` error code. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.batch_upsert( + idempotency_key="789ff020-f723-43a9-b4b5-43b5dc1fa3dc", + batches=[ + { + "objects": [ + { + "type": "ITEM", + "id": "#Tea", + "present_at_all_locations": True, + }, + { + "type": "ITEM", + "id": "#Coffee", + "present_at_all_locations": True, + }, + { + "type": "CATEGORY", + "id": "#Beverages", + "present_at_all_locations": True, + }, + { + "type": "TAX", + "id": "#SalesTax", + "present_at_all_locations": True, + "tax_data": { + "name": "Sales Tax", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "5.0", + "applies_to_custom_amounts": True, + "enabled": True, + }, + }, + ] + } + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A value you specify that uniquely identifies this +request among all your requests. A common way to create +a valid idempotency key is to use a Universally unique +identifier (UUID). + +If you're unsure whether a particular request was successful, +you can reattempt it with the same idempotency key without +worrying about creating duplicate objects. + +See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + +
+
+ +
+
+ +**batches:** `typing.Sequence[CatalogObjectBatchParams]` + +A batch of CatalogObjects to be inserted/updated atomically. +The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs +attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error +in one batch will not affect other batches within the same request. + +For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its +`is_deleted` field must not be set to `true`. + +To modify an existing object, supply its ID. To create a new object, use an ID starting +with `#`. These IDs may be used to create relationships between an object and attributes of +other objects that reference it. For example, you can create a CatalogItem with +ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to +`#ABC` in order to associate the CatalogItemVariation with its parent +CatalogItem. + +Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. + +Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request +may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will +be inserted or updated. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.info() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves information about the Square Catalog API, such as batch size +limits that can be used by the `BatchUpsertCatalogObjects` endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.info() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified types in the catalog. + +The `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values, +for example, "`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`". + +__Important:__ ListCatalog does not return deleted catalog items. To retrieve +deleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) +and set the `include_deleted_objects` attribute value to `true`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.catalog.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The pagination cursor returned in the previous response. Leave unset for an initial request. +The page size is currently set to be 100. +See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + +
+
+ +
+
+ +**types:** `typing.Optional[str]` + +An optional case-insensitive, comma-separated list of object types to retrieve. + +The valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example, +`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, +`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. + +If this is unspecified, the operation returns objects of all the top level types at the version +of the Square API used to make the request. Object types that are nested onto other object types +are not included in the defaults. + +At the current API version the default object types are: +ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, +PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, +SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + +
+
+ +
+
+ +**catalog_version:** `typing.Optional[int]` + +The specific version of the catalog objects to be included in the response. +This allows you to retrieve historical versions of objects. The specified version value is matched against +the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the +current version of the catalog. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values, +excluding custom attribute values on items or item variations, against one or more of the specified query filters. + +This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) +endpoint in the following aspects: + +- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. +- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. +- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. +- The both endpoints have different call conventions, including the query filter formats. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.search( + object_types=["ITEM"], + query={ + "prefix_query": {"attribute_name": "name", "attribute_prefix": "tea"} + }, + limit=100, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The pagination cursor returned in the previous response. Leave unset for an initial request. +See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + +
+
+ +
+
+ +**object_types:** `typing.Optional[typing.Sequence[CatalogObjectType]]` + +The desired set of object types to appear in the search results. + +If this is unspecified, the operation returns objects of all the top level types at the version +of the Square API used to make the request. Object types that are nested onto other object types +are not included in the defaults. + +At the current API version the default object types are: +ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, +PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, +SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + +Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, +ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest +in this field. + +
+
+ +
+
+ +**include_deleted_objects:** `typing.Optional[bool]` — If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time. + +
+
+ +
+
+ +**include_related_objects:** `typing.Optional[bool]` + +If `true`, the response will include additional objects that are related to the +requested objects. Related objects are objects that are referenced by object ID by the objects +in the response. This is helpful if the objects are being fetched for immediate display to a user. +This process only goes one level deep. Objects referenced by the related objects will not be included. +For example: + +If the `objects` field of the response contains a CatalogItem, its associated +CatalogCategory objects, CatalogTax objects, CatalogImage objects and +CatalogModifierLists will be returned in the `related_objects` field of the +response. If the `objects` field of the response contains a CatalogItemVariation, +its parent CatalogItem will be returned in the `related_objects` field of +the response. + +Default value: `false` + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` + +Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 +format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a +timestamp equal to `begin_time` will not be included in the response. + +
+
+ +
+
+ +**query:** `typing.Optional[CatalogQueryParams]` — A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +A limit on the number of results to be returned in a single page. The limit is advisory - +the implementation may return more or fewer results. If the supplied limit is negative, zero, or +is higher than the maximum limit of 1,000, it will be ignored. + +
+
+ +
+
+ +**include_category_path_to_root:** `typing.Optional[bool]` — Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.search_items(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for catalog items or item variations by matching supported search attribute values, including +custom attribute values, against one or more of the specified query filters. + +This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) +endpoint in the following aspects: + +- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. +- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. +- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. +- The both endpoints use different call conventions, including the query filter formats. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.search_items( + text_filter="red", + category_ids=["WINE_CATEGORY_ID"], + stock_levels=["OUT", "LOW"], + enabled_location_ids=["ATL_LOCATION_ID"], + limit=100, + sort_order="ASC", + product_types=["REGULAR"], + custom_attribute_filters=[ + { + "custom_attribute_definition_id": "VEGAN_DEFINITION_ID", + "bool_filter": True, + }, + { + "custom_attribute_definition_id": "BRAND_DEFINITION_ID", + "string_filter": "Dark Horse", + }, + {"key": "VINTAGE", "number_filter": {"min": "min", "max": "max"}}, + {"custom_attribute_definition_id": "VARIETAL_DEFINITION_ID"}, + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**text_filter:** `typing.Optional[str]` + +The text filter expression to return items or item variations containing specified text in +the `name`, `description`, or `abbreviation` attribute value of an item, or in +the `name`, `sku`, or `upc` attribute value of an item variation. + +
+
+ +
+
+ +**category_ids:** `typing.Optional[typing.Sequence[str]]` — The category id query expression to return items containing the specified category IDs. + +
+
+ +
+
+ +**stock_levels:** `typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]]` + +The stock-level query expression to return item variations with the specified stock levels. +See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values + +
+
+ +
+
+ +**enabled_location_ids:** `typing.Optional[typing.Sequence[str]]` — The enabled-location query expression to return items and item variations having specified enabled locations. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination token, returned in the previous response, used to fetch the next batch of pending results. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of results to return per page. The default value is 100. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +The order to sort the results by item names. The default sort order is ascending (`ASC`). +See [SortOrder](#type-sortorder) for possible values + +
+
+ +
+
+ +**product_types:** `typing.Optional[typing.Sequence[CatalogItemProductType]]` — The product types query expression to return items or item variations having the specified product types. + +
+
+ +
+
+ +**custom_attribute_filters:** `typing.Optional[typing.Sequence[CustomAttributeFilterParams]]` + +The customer-attribute filter to return items or item variations matching the specified +custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in +a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + +
+
+ +
+
+ +**archived_state:** `typing.Optional[ArchivedState]` — The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.update_item_modifier_lists(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the [CatalogModifierList](entity:CatalogModifierList) objects +that apply to the targeted [CatalogItem](entity:CatalogItem) without having +to perform an upsert on the entire item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.update_item_modifier_lists( + item_ids=["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"], + modifier_lists_to_enable=[ + "H42BRLUJ5KTZTTMPVSLFAACQ", + "2JXOBJIHCWBQ4NZ3RIXQGJA6", + ], + modifier_lists_to_disable=["7WRC16CJZDVLSNDQ35PP6YAD"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**item_ids:** `typing.Sequence[str]` — The IDs of the catalog items associated with the CatalogModifierList objects being updated. + +
+
+ +
+
+ +**modifier_lists_to_enable:** `typing.Optional[typing.Sequence[str]]` + +The IDs of the CatalogModifierList objects to enable for the CatalogItem. +At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + +
+
+ +
+
+ +**modifier_lists_to_disable:** `typing.Optional[typing.Sequence[str]]` + +The IDs of the CatalogModifierList objects to disable for the CatalogItem. +At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.update_item_taxes(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the [CatalogTax](entity:CatalogTax) objects that apply to the +targeted [CatalogItem](entity:CatalogItem) without having to perform an +upsert on the entire item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.update_item_taxes( + item_ids=["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"], + taxes_to_enable=["4WRCNHCJZDVLSNDQ35PP6YAD"], + taxes_to_disable=["AQCEGCEBBQONINDOHRGZISEX"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**item_ids:** `typing.Sequence[str]` + +IDs for the CatalogItems associated with the CatalogTax objects being updated. +No more than 1,000 IDs may be provided. + +
+
+ +
+
+ +**taxes_to_enable:** `typing.Optional[typing.Sequence[str]]` + +IDs of the CatalogTax objects to enable. +At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + +
+
+ +
+
+ +**taxes_to_disable:** `typing.Optional[typing.Sequence[str]]` + +IDs of the CatalogTax objects to disable. +At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Customers +
client.customers.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists customer profiles associated with a Square account. + +Under normal operating conditions, newly created or updated customer profiles become available +for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated +profiles can take closer to one minute or longer, especially during network incidents and outages. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.customers.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for your original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. +If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**sort_field:** `typing.Optional[CustomerSortField]` + +Indicates how customers should be sorted. + +The default value is `DEFAULT`. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +Indicates whether customers should be sorted in ascending (`ASC`) or +descending (`DESC`) order. + +The default value is `ASC`. + +
+
+ +
+
+ +**count:** `typing.Optional[bool]` + +Indicates whether to return the total count of customers in the `count` field of the response. + +The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new customer for a business. + +You must provide at least one of the following values in your request to this +endpoint: + +- `given_name` +- `family_name` +- `company_name` +- `email_address` +- `phone_number` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.create( + given_name="Amelia", + family_name="Earhart", + email_address="Amelia.Earhart@example.com", + address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + phone_number="+1-212-555-4240", + reference_id="YOUR_REFERENCE_ID", + note="a customer", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +The idempotency key for the request. For more information, see +[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**given_name:** `typing.Optional[str]` + +The given name (that is, the first name) associated with the customer profile. + +The maximum length for this value is 300 characters. + +
+
+ +
+
+ +**family_name:** `typing.Optional[str]` + +The family name (that is, the last name) associated with the customer profile. + +The maximum length for this value is 300 characters. + +
+
+ +
+
+ +**company_name:** `typing.Optional[str]` + +A business name associated with the customer profile. + +The maximum length for this value is 500 characters. + +
+
+ +
+
+ +**nickname:** `typing.Optional[str]` + +A nickname for the customer profile. + +The maximum length for this value is 100 characters. + +
+
+ +
+
+ +**email_address:** `typing.Optional[str]` + +The email address associated with the customer profile. + +The maximum length for this value is 254 characters. + +
+
+ +
+
+ +**address:** `typing.Optional[AddressParams]` + +The physical address associated with the customer profile. For maximum length constraints, see +[Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). +The `first_name` and `last_name` fields are ignored if they are present in the request. + +
+
+ +
+
+ +**phone_number:** `typing.Optional[str]` + +The phone number associated with the customer profile. The phone number must be valid and can contain +9–16 digits, with an optional `+` prefix and country code. For more information, see +[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + +
+
+ +
+
+ +**reference_id:** `typing.Optional[str]` + +An optional second ID used to associate the customer profile with an +entity in another system. + +The maximum length for this value is 100 characters. + +
+
+ +
+
+ +**note:** `typing.Optional[str]` — A custom note associated with the customer profile. + +
+
+ +
+
+ +**birthday:** `typing.Optional[str]` + +The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, +specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` +format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + +
+
+ +
+
+ +**tax_ids:** `typing.Optional[CustomerTaxIdsParams]` + +The tax ID associated with the customer profile. This field is available only for customers of sellers +in EU countries or the United Kingdom. For more information, +see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.batch_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates multiple [customer profiles](entity:Customer) for a business. + +This endpoint takes a map of individual create requests and returns a map of responses. + +You must provide at least one of the following values in each create request: + +- `given_name` +- `family_name` +- `company_name` +- `email_address` +- `phone_number` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.batch_create( + customers={ + "8bb76c4f-e35d-4c5b-90de-1194cd9179f0": { + "given_name": "Amelia", + "family_name": "Earhart", + "email_address": "Amelia.Earhart@example.com", + "address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "phone_number": "+1-212-555-4240", + "reference_id": "YOUR_REFERENCE_ID", + "note": "a customer", + }, + "d1689f23-b25d-4932-b2f0-aed00f5e2029": { + "given_name": "Marie", + "family_name": "Curie", + "email_address": "Marie.Curie@example.com", + "address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 601", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "phone_number": "+1-212-444-4240", + "reference_id": "YOUR_REFERENCE_ID", + "note": "another customer", + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customers:** `typing.Dict[str, BulkCreateCustomerDataParams]` + +A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }` +key-value pairs. + +Each key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) +that uniquely identifies the create request. Each value contains the customer data used to create the +customer profile. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.bulk_delete_customers(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes multiple customer profiles. + +The endpoint takes a list of customer IDs and returns a map of responses. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.bulk_delete_customers( + customer_ids=[ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8", + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_ids:** `typing.Sequence[str]` — The IDs of the [customer profiles](entity:Customer) to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.bulk_retrieve_customers(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves multiple customer profiles. + +This endpoint takes a list of customer IDs and returns a map of responses. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.bulk_retrieve_customers( + customer_ids=[ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8", + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_ids:** `typing.Sequence[str]` — The IDs of the [customer profiles](entity:Customer) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.bulk_update_customers(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates multiple customer profiles. + +This endpoint takes a map of individual update requests and returns a map of responses. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.bulk_update_customers( + customers={ + "8DDA5NZVBZFGAX0V3HPF81HHE0": { + "email_address": "New.Amelia.Earhart@example.com", + "note": "updated customer note", + "version": 2, + }, + "N18CPRVXR5214XPBBA6BZQWF3C": { + "given_name": "Marie", + "family_name": "Curie", + "version": 0, + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customers:** `typing.Dict[str, BulkUpdateCustomerDataParams]` + +A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }` +key-value pairs. + +Each key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile +that was created by merging existing profiles, provide the ID of the newly created profile. + +Each value contains the updated customer data. Only new or changed fields are required. To add or +update a field, specify the new value. To remove a field, specify `null`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches the customer profiles associated with a Square account using one or more supported query filters. + +Calling `SearchCustomers` without any explicit query filter returns all +customer profiles ordered alphabetically based on `given_name` and +`family_name`. + +Under normal operating conditions, newly created or updated customer profiles become available +for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated +profiles can take closer to one minute or longer, especially during network incidents and outages. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.search( + limit=2, + query={ + "filter": { + "creation_source": {"values": ["THIRD_PARTY"], "rule": "INCLUDE"}, + "created_at": { + "start_at": "2018-01-01T00:00:00-00:00", + "end_at": "2018-02-01T00:00:00-00:00", + }, + "email_address": {"fuzzy": "example.com"}, + "group_ids": {"all_": ["545AXB44B4XXWMVQ4W8SBT3HHF"]}, + }, + "sort": {"field": "CREATED_AT", "order": "ASC"}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +Include the pagination cursor in subsequent calls to this endpoint to retrieve +the next set of results associated with the original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. +If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**query:** `typing.Optional[CustomerQueryParams]` + +The filtering and sorting criteria for the search request. If a query is not specified, +Square returns all customer profiles ordered alphabetically by `given_name` and `family_name`. + +
+
+ +
+
+ +**count:** `typing.Optional[bool]` + +Indicates whether to return the total count of matching customers in the `count` field of the response. + +The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns details for a single customer. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.get( + customer_id="customer_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. +To add or update a field, specify the new value. To remove a field, specify `null`. + +To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.update( + customer_id="customer_id", + email_address="New.Amelia.Earhart@example.com", + note="updated customer note", + version=2, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to update. + +
+
+ +
+
+ +**given_name:** `typing.Optional[str]` + +The given name (that is, the first name) associated with the customer profile. + +The maximum length for this value is 300 characters. + +
+
+ +
+
+ +**family_name:** `typing.Optional[str]` + +The family name (that is, the last name) associated with the customer profile. + +The maximum length for this value is 300 characters. + +
+
+ +
+
+ +**company_name:** `typing.Optional[str]` + +A business name associated with the customer profile. + +The maximum length for this value is 500 characters. + +
+
+ +
+
+ +**nickname:** `typing.Optional[str]` + +A nickname for the customer profile. + +The maximum length for this value is 100 characters. + +
+
+ +
+
+ +**email_address:** `typing.Optional[str]` + +The email address associated with the customer profile. + +The maximum length for this value is 254 characters. + +
+
+ +
+
+ +**address:** `typing.Optional[AddressParams]` + +The physical address associated with the customer profile. Only new or changed fields are required in the request. + +For maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). +The `first_name` and `last_name` fields are ignored if they are present in the request. + +
+
+ +
+
+ +**phone_number:** `typing.Optional[str]` + +The phone number associated with the customer profile. The phone number must be valid and can contain +9–16 digits, with an optional `+` prefix and country code. For more information, see +[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + +
+
+ +
+
+ +**reference_id:** `typing.Optional[str]` + +An optional second ID used to associate the customer profile with an +entity in another system. + +The maximum length for this value is 100 characters. + +
+
+ +
+
+ +**note:** `typing.Optional[str]` — A custom note associated with the customer profile. + +
+
+ +
+
+ +**birthday:** `typing.Optional[str]` + +The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, +specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` +format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the customer profile. + +As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). + +
+
+ +
+
+ +**tax_ids:** `typing.Optional[CustomerTaxIdsParams]` + +The tax ID associated with the customer profile. This field is available only for customers of sellers +in EU countries or the United Kingdom. For more information, +see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a customer profile from a business. + +To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.delete( + customer_id="customer_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to delete. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the customer profile. + +As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Devices +
client.devices.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List devices associated with the merchant. Currently, only Terminal API +devices are supported. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.devices.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +The order in which results are listed. +- `ASC` - Oldest to newest. +- `DESC` - Newest to oldest (default). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of results to return in a single page. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` — If present, only returns devices at the target location. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.devices.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves Device with the associated `device_id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.devices.get( + device_id="device_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**device_id:** `str` — The unique ID for the desired `Device`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Disputes +
client.disputes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of disputes associated with a particular account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.disputes.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**states:** `typing.Optional[DisputeState]` — The dispute states used to filter the result. If not specified, the endpoint returns all disputes. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +The ID of the location for which to return a list of disputes. +If not specified, the endpoint returns disputes associated with all locations. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns details about a specific dispute. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.get( + dispute_id="dispute_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute you want more details about. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.accept(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and +updates the dispute state to ACCEPTED. + +Square debits the disputed amount from the seller’s Square account. If the Square account +does not have sufficient funds, Square debits the associated bank account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.accept( + dispute_id="dispute_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute you want to accept. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.create_evidence_file(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP +multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.create_evidence_file( + dispute_id="dispute_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute for which you want to upload evidence. + +
+
+ +
+
+ +**request:** `typing.Optional[CreateDisputeEvidenceFileRequestParams]` + +
+
+ +
+
+ +**image_file:** `from __future__ import annotations + +typing.Optional[core.File]` — See core.File for more documentation + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.create_evidence_text(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Uploads text to use as evidence for a dispute challenge. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.create_evidence_text( + dispute_id="dispute_id", + idempotency_key="ed3ee3933d946f1514d505d173c82648", + evidence_type="TRACKING_NUMBER", + evidence_text="1Z8888888888888888", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute for which you want to upload evidence. + +
+
+ +
+
+ +**idempotency_key:** `str` — A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + +
+
+ +
+
+ +**evidence_text:** `str` — The evidence string. + +
+
+ +
+
+ +**evidence_type:** `typing.Optional[DisputeEvidenceType]` + +The type of evidence you are uploading. +See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.submit_evidence(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Submits evidence to the cardholder's bank. + +The evidence submitted by this endpoint includes evidence uploaded +using the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and +[CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and +evidence automatically provided by Square, when available. Evidence cannot be removed from +a dispute after submission. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.submit_evidence( + dispute_id="dispute_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute for which you want to submit evidence. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Employees +
client.employees.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.employees.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` — + +
+
+ +
+
+ +**status:** `typing.Optional[EmployeeStatus]` — Specifies the EmployeeStatus to filter the employee by. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of employees to be returned on each page. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The token required to retrieve the specified page of results. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.employees.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.employees.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — UUID for the employee that was requested. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Events +
client.events.search_events(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Search for Square API events that occur within a 28-day timeframe. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.events.search_events() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +Default: 100 + +
+
+ +
+
+ +**query:** `typing.Optional[SearchEventsQueryParams]` — The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.events.disable_events() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Disables events to prevent them from being searchable. +All events are disabled by default. You must enable events to make them searchable. +Disabling events for a specific time period prevents them from being searchable, even if you re-enable them later. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.events.disable_events() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.events.enable_events() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Enables events to make them searchable. Only events that occur while in the enabled state are searchable. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.events.enable_events() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.events.list_event_types(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all event types that you can subscribe to as webhooks or query using the Events API. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.events.list_event_types() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**api_version:** `typing.Optional[str]` — The API version for which to list event types. Setting this field overrides the default version used by the application. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## GiftCards +
client.gift_cards.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all gift cards. You can specify optional filters to retrieve +a subset of the gift cards. Results are sorted by `created_at` in ascending order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.gift_cards.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**type:** `typing.Optional[str]` + +If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type. +Otherwise, the endpoint returns gift cards of all types. + +
+
+ +
+
+ +**state:** `typing.Optional[str]` + +If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. +Otherwise, the endpoint returns the gift cards of all states. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +If a limit is provided, the endpoint returns only the specified number of results per page. +The maximum value is 200. The default value is 30. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +If a cursor is not provided, the endpoint returns the first page of the results. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**customer_id:** `typing.Optional[str]` — If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card +has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call +[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` +activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) +to refund a payment to the new gift card. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.create( + idempotency_key="NC9Tm69EjbjtConu", + location_id="81FN9BNFZTKS4", + gift_card={"type": "DIGITAL"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**location_id:** `str` + +The ID of the [location](entity:Location) where the gift card should be registered for +reporting purposes. Gift cards can be redeemed at any of the seller's locations. + +
+
+ +
+
+ +**gift_card:** `GiftCardParams` + +The gift card to create. The `type` field is required for this request. The `gan_source` +and `gan` fields are included as follows: + +To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`. + +To provide a custom GAN, include `gan_source` and `gan`. +- For `gan_source`, specify `OTHER`. +- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be +unique for the seller and cannot start with the same bank identification number (BIN) as major +credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly +increase the risk of fraud. It is the responsibility of the developer to ensure the security +of their custom GANs. For more information, see +[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). + +To register an unused, physical gift card that the seller previously ordered from Square, +include `gan` and provide the GAN that is printed on the gift card. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.get_from_gan(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a gift card using the gift card account number (GAN). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.get_from_gan( + gan="7783320001001635", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**gan:** `str` + +The gift card account number (GAN) of the gift card to retrieve. +The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. +Square-issued gift cards have 16-digit GANs. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.get_from_nonce(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a gift card using a secure payment token that represents the gift card. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.get_from_nonce( + nonce="cnon:7783322135245171", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**nonce:** `str` + +The payment token of the gift card to retrieve. Payment tokens are generated by the +Web Payments SDK or In-App Payments SDK. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.link_customer(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Links a customer to a gift card, which is also referred to as adding a card on file. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.link_customer( + gift_card_id="gift_card_id", + customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**gift_card_id:** `str` — The ID of the gift card to be linked. + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to link to the gift card. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.unlink_customer(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Unlinks a customer from a gift card, which is also referred to as removing a card on file. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.unlink_customer( + gift_card_id="gift_card_id", + customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**gift_card_id:** `str` — The ID of the gift card to be unlinked. + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to unlink from the gift card. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a gift card using the gift card ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The ID of the gift card to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Inventory +
client.inventory.deprecated_get_adjustment(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL +is updated to conform to the standard convention. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.deprecated_get_adjustment( + adjustment_id="adjustment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**adjustment_id:** `str` — ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.get_adjustment(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the [InventoryAdjustment](entity:InventoryAdjustment) object +with the provided `adjustment_id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.get_adjustment( + adjustment_id="adjustment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**adjustment_id:** `str` — ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.deprecated_batch_change(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL +is updated to conform to the standard convention. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.deprecated_batch_change( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "state": "IN_STOCK", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "team_member_id": "LRK57NSQ5X7PUD05", + "occurred_at": "2016-11-16T22:25:24.878Z", + }, + } + ], + ignore_unchanged_counts=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A client-supplied, universally unique identifier (UUID) for the +request. + +See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the +[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more +information. + +
+
+ +
+
+ +**changes:** `typing.Optional[typing.Sequence[InventoryChangeParams]]` + +The set of physical counts and inventory adjustments to be made. +Changes are applied based on the client-supplied timestamp and may be sent +out of order. + +
+
+ +
+
+ +**ignore_unchanged_counts:** `typing.Optional[bool]` + +Indicates whether the current physical count should be ignored if +the quantity is unchanged since the last physical count. Default: `true`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.deprecated_batch_get_changes(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL +is updated to conform to the standard convention. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.deprecated_batch_get_changes( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["C6W5YS5QM06F5"], + types=["PHYSICAL_COUNT"], + states=["IN_STOCK"], + updated_after="2016-11-01T00:00:00.000Z", + updated_before="2016-12-01T00:00:00.000Z", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**catalog_object_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `CatalogObject` ID. +The filter is only applicable when set. The default value is null. + +
+
+ +
+
+ +**location_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `Location` ID. +The filter is only applicable when set. The default value is null. + +
+
+ +
+
+ +**types:** `typing.Optional[typing.Sequence[InventoryChangeType]]` + +The filter to return results by `InventoryChangeType` values other than `TRANSFER`. +The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + +
+
+ +
+
+ +**states:** `typing.Optional[typing.Sequence[InventoryState]]` + +The filter to return `ADJUSTMENT` query results by +`InventoryState`. This filter is only applied when set. +The default value is null. + +
+
+ +
+
+ +**updated_after:** `typing.Optional[str]` + +The filter to return results with their `calculated_at` value +after the given time as specified in an RFC 3339 timestamp. +The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + +
+
+ +
+
+ +**updated_before:** `typing.Optional[str]` + +The filter to return results with their `created_at` or `calculated_at` value +strictly before the given time as specified in an RFC 3339 timestamp. +The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of [records](entity:InventoryChange) to return. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.deprecated_batch_get_counts(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL +is updated to conform to the standard convention. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.deprecated_batch_get_counts( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["59TNP9SA8VGDA"], + updated_after="2016-11-16T00:00:00.000Z", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**catalog_object_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `CatalogObject` ID. +The filter is applicable only when set. The default is null. + +
+
+ +
+
+ +**location_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `Location` ID. +This filter is applicable only when set. The default is null. + +
+
+ +
+
+ +**updated_after:** `typing.Optional[str]` + +The filter to return results with their `calculated_at` value +after the given time as specified in an RFC 3339 timestamp. +The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**states:** `typing.Optional[typing.Sequence[InventoryState]]` + +The filter to return results by `InventoryState`. The filter is only applicable when set. +Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. +The default is null. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of [records](entity:InventoryCount) to return. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.batch_create_changes(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Applies adjustments and counts to the provided item quantities. + +On success: returns the current calculated counts for all objects +referenced in the request. +On failure: returns a list of related errors. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.batch_create_changes( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "state": "IN_STOCK", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "team_member_id": "LRK57NSQ5X7PUD05", + "occurred_at": "2016-11-16T22:25:24.878Z", + }, + } + ], + ignore_unchanged_counts=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A client-supplied, universally unique identifier (UUID) for the +request. + +See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the +[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more +information. + +
+
+ +
+
+ +**changes:** `typing.Optional[typing.Sequence[InventoryChangeParams]]` + +The set of physical counts and inventory adjustments to be made. +Changes are applied based on the client-supplied timestamp and may be sent +out of order. + +
+
+ +
+
+ +**ignore_unchanged_counts:** `typing.Optional[bool]` + +Indicates whether the current physical count should be ignored if +the quantity is unchanged since the last physical count. Default: `true`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.batch_get_changes(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns historical physical counts and adjustments based on the +provided filter criteria. + +Results are paginated and sorted in ascending order according their +`occurred_at` timestamp (oldest first). + +BatchRetrieveInventoryChanges is a catch-all query endpoint for queries +that cannot be handled by other, simpler endpoints. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.inventory.batch_get_changes( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["C6W5YS5QM06F5"], + types=["PHYSICAL_COUNT"], + states=["IN_STOCK"], + updated_after="2016-11-01T00:00:00.000Z", + updated_before="2016-12-01T00:00:00.000Z", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**catalog_object_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `CatalogObject` ID. +The filter is only applicable when set. The default value is null. + +
+
+ +
+
+ +**location_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `Location` ID. +The filter is only applicable when set. The default value is null. + +
+
+ +
+
+ +**types:** `typing.Optional[typing.Sequence[InventoryChangeType]]` + +The filter to return results by `InventoryChangeType` values other than `TRANSFER`. +The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + +
+
+ +
+
+ +**states:** `typing.Optional[typing.Sequence[InventoryState]]` + +The filter to return `ADJUSTMENT` query results by +`InventoryState`. This filter is only applied when set. +The default value is null. + +
+
+ +
+
+ +**updated_after:** `typing.Optional[str]` + +The filter to return results with their `calculated_at` value +after the given time as specified in an RFC 3339 timestamp. +The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + +
+
+ +
+
+ +**updated_before:** `typing.Optional[str]` + +The filter to return results with their `created_at` or `calculated_at` value +strictly before the given time as specified in an RFC 3339 timestamp. +The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of [records](entity:InventoryChange) to return. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.batch_get_counts(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns current counts for the provided +[CatalogObject](entity:CatalogObject)s at the requested +[Location](entity:Location)s. + +Results are paginated and sorted in descending order according to their +`calculated_at` timestamp (newest first). + +When `updated_after` is specified, only counts that have changed since that +time (based on the server timestamp for the most recent change) are +returned. This allows clients to perform a "sync" operation, for example +in response to receiving a Webhook notification. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.inventory.batch_get_counts( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["59TNP9SA8VGDA"], + updated_after="2016-11-16T00:00:00.000Z", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**catalog_object_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `CatalogObject` ID. +The filter is applicable only when set. The default is null. + +
+
+ +
+
+ +**location_ids:** `typing.Optional[typing.Sequence[str]]` + +The filter to return results by `Location` ID. +This filter is applicable only when set. The default is null. + +
+
+ +
+
+ +**updated_after:** `typing.Optional[str]` + +The filter to return results with their `calculated_at` value +after the given time as specified in an RFC 3339 timestamp. +The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**states:** `typing.Optional[typing.Sequence[InventoryState]]` + +The filter to return results by `InventoryState`. The filter is only applicable when set. +Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. +The default is null. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of [records](entity:InventoryCount) to return. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.deprecated_get_physical_count(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL +is updated to conform to the standard convention. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.deprecated_get_physical_count( + physical_count_id="physical_count_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**physical_count_id:** `str` + +ID of the +[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.get_physical_count(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount) +object with the provided `physical_count_id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.get_physical_count( + physical_count_id="physical_count_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**physical_count_id:** `str` + +ID of the +[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.get_transfer(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the [InventoryTransfer](entity:InventoryTransfer) object +with the provided `transfer_id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.inventory.get_transfer( + transfer_id="transfer_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**transfer_id:** `str` — ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the current calculated stock count for a given +[CatalogObject](entity:CatalogObject) at a given set of +[Location](entity:Location)s. Responses are paginated and unsorted. +For more sophisticated queries, use a batch endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.inventory.get( + catalog_object_id="catalog_object_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**catalog_object_id:** `str` — ID of the [CatalogObject](entity:CatalogObject) to retrieve. + +
+
+ +
+
+ +**location_ids:** `typing.Optional[str]` + +The [Location](entity:Location) IDs to look up as a comma-separated +list. An empty list queries all locations. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.inventory.changes(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a set of physical counts and inventory adjustments for the +provided [CatalogObject](entity:CatalogObject) at the requested +[Location](entity:Location)s. + +You can achieve the same result by calling [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) +and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID. + +Results are paginated and sorted in descending order according to their +`occurred_at` timestamp (newest first). + +There are no limits on how far back the caller can page. This endpoint can be +used to display recent changes for a specific item. For more +sophisticated queries, use a batch endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.inventory.changes( + catalog_object_id="catalog_object_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**catalog_object_id:** `str` — ID of the [CatalogObject](entity:CatalogObject) to retrieve. + +
+
+ +
+
+ +**location_ids:** `typing.Optional[str]` + +The [Location](entity:Location) IDs to look up as a comma-separated +list. An empty list queries all locations. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Invoices +
client.invoices.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of invoices for a given location. The response +is paginated. If truncated, the response includes a `cursor` that you +use in a subsequent request to retrieve the next set of invoices. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.invoices.list( + location_id="location_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location for which to list invoices. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for your original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of invoices to return (200 is the maximum `limit`). +If not provided, the server uses a default limit of 100 invoices. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a draft [invoice](entity:Invoice) +for an order created using the Orders API. + +A draft invoice remains in your account and no action is taken. +You must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.create( + invoice={ + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "primary_recipient": {"customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4"}, + "payment_requests": [ + { + "request_type": "BALANCE", + "due_date": "2030-01-24", + "tipping_enabled": True, + "automatic_payment_source": "NONE", + "reminders": [ + { + "relative_scheduled_days": -1, + "message": "Your invoice is due tomorrow", + } + ], + } + ], + "delivery_method": "EMAIL", + "invoice_number": "inv-100", + "title": "Event Planning Services", + "description": "We appreciate your business!", + "scheduled_at": "2030-01-13T10:00:00Z", + "accepted_payment_methods": { + "card": True, + "square_gift_card": False, + "bank_account": False, + "buy_now_pay_later": False, + "cash_app_pay": False, + }, + "custom_fields": [ + { + "label": "Event Reference Number", + "value": "Ref. #1234", + "placement": "ABOVE_LINE_ITEMS", + }, + { + "label": "Terms of Service", + "value": "The terms of service are...", + "placement": "BELOW_LINE_ITEMS", + }, + ], + "sale_or_service_date": "2030-01-24", + "store_payment_method_enabled": False, + }, + idempotency_key="ce3748f9-5fc1-4762-aa12-aae5e843f1f4", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice:** `InvoiceParams` — The invoice to create. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique string that identifies the `CreateInvoice` request. If you do not +provide `idempotency_key` (or provide an empty string as the value), the endpoint +treats each request as independent. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for invoices from a location specified in +the filter. You can optionally specify customers in the filter for whom to +retrieve invoices. In the current implementation, you can only specify one location and +optionally one customer. + +The response is paginated. If truncated, the response includes a `cursor` +that you use in a subsequent request to retrieve the next set of invoices. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.search( + query={ + "filter": { + "location_ids": ["ES0RJRZYEC39A"], + "customer_ids": ["JDKYHBWT1D4F8MFH63DBMEN8Y4"], + }, + "sort": {"field": "INVOICE_SORT_DATE", "order": "DESC"}, + }, + limit=100, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `InvoiceQueryParams` — Describes the query criteria for searching invoices. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of invoices to return (200 is the maximum `limit`). +If not provided, the server uses a default limit of 100 invoices. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for your original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves an invoice by invoice ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.get( + invoice_id="invoice_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the invoice to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates an invoice. This endpoint supports sparse updates, so you only need +to specify the fields you want to change along with the required `version` field. +Some restrictions apply to updating invoices. For example, you cannot change the +`order_id` or `location_id` field. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.update( + invoice_id="invoice_id", + invoice={ + "version": 1, + "payment_requests": [ + { + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355", + "tipping_enabled": False, + } + ], + }, + idempotency_key="4ee82288-0910-499e-ab4c-5d0071dad1be", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the invoice to update. + +
+
+ +
+
+ +**invoice:** `InvoiceParams` + +The invoice fields to add, change, or clear. Fields can be cleared using +null values or the `remove` field (for individual payment requests or reminders). +The current invoice `version` is also required. For more information, including requirements, +limitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique string that identifies the `UpdateInvoice` request. If you do not +provide `idempotency_key` (or provide an empty string as the value), the endpoint +treats each request as independent. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**fields_to_clear:** `typing.Optional[typing.Sequence[str]]` + +The list of fields to clear. Although this field is currently supported, we +recommend using null values or the `remove` field when possible. For examples, see +[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the specified invoice. When an invoice is deleted, the +associated order status changes to CANCELED. You can only delete a draft +invoice (you cannot delete a published invoice, including one that is scheduled for processing). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.delete( + invoice_id="invoice_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the invoice to delete. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The version of the [invoice](entity:Invoice) to delete. +If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or +[ListInvoices](api-endpoint:Invoices-ListInvoices). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.create_invoice_attachment(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads +with a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file +in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF. + +Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices +in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + +__NOTE:__ When testing in the Sandbox environment, the total file size is limited to 1 KB. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.create_invoice_attachment( + invoice_id="invoice_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the [invoice](entity:Invoice) to attach the file to. + +
+
+ +
+
+ +**request:** `typing.Optional[typing.Optional[typing.Any]]` + +
+
+ +
+
+ +**image_file:** `from __future__ import annotations + +typing.Optional[core.File]` — See core.File for more documentation + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.delete_invoice_attachment(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only +from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.delete_invoice_attachment( + invoice_id="invoice_id", + attachment_id="attachment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the [invoice](entity:Invoice) to delete the attachment from. + +
+
+ +
+
+ +**attachment_id:** `str` — The ID of the [attachment](entity:InvoiceAttachment) to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels an invoice. The seller cannot collect payments for +the canceled invoice. + +You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.cancel( + invoice_id="invoice_id", + version=0, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the [invoice](entity:Invoice) to cancel. + +
+
+ +
+
+ +**version:** `int` + +The version of the [invoice](entity:Invoice) to cancel. +If you do not know the version, you can call +[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.invoices.publish(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Publishes the specified draft invoice. + +After an invoice is published, Square +follows up based on the invoice configuration. For example, Square +sends the invoice to the customer's email address, charges the customer's card on file, or does +nothing. Square also makes the invoice available on a Square-hosted invoice page. + +The invoice `status` also changes from `DRAFT` to a status +based on the invoice configuration. For example, the status changes to `UNPAID` if +Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the +invoice amount. + +In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ` +and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.invoices.publish( + invoice_id="invoice_id", + version=1, + idempotency_key="32da42d0-1997-41b0-826b-f09464fc2c2e", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**invoice_id:** `str` — The ID of the invoice to publish. + +
+
+ +
+
+ +**version:** `int` + +The version of the [invoice](entity:Invoice) to publish. +This must match the current version of the invoice; otherwise, the request is rejected. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique string that identifies the `PublishInvoice` request. If you do not +provide `idempotency_key` (or provide an empty string as the value), the endpoint +treats each request as independent. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Locations +
client.locations.list() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), +including those with an inactive status. Locations are listed alphabetically by `name`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.list() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a [location](https://developer.squareup.com/docs/locations-api). +Creating new locations allows for separate configuration of receipt layouts, item prices, +and sales reports. Developers can use locations to separate sales activity through applications +that integrate with Square from sales activity elsewhere in a seller's account. +Locations created programmatically with the Locations API last forever and +are visible to the seller for their own management. Therefore, ensure that +each location has a sensible and unique name. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.create( + location={ + "name": "Midtown", + "address": { + "address_line1": "1234 Peachtree St. NE", + "locality": "Atlanta", + "administrative_district_level1": "GA", + "postal_code": "30309", + }, + "description": "Midtown Atlanta store", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location:** `typing.Optional[LocationParams]` + +The initial values of the location being created. The `name` field is required and must be unique within a seller account. +All other fields are optional, but any information you care about for the location should be included. +The remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves details of a single location. Specify "main" +as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.get( + location_id="location_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` + +The ID of the location to retrieve. Specify the string +"main" to return the main location. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a [location](https://developer.squareup.com/docs/locations-api). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.update( + location_id="location_id", + location={ + "business_hours": { + "periods": [ + { + "day_of_week": "FRI", + "start_local_time": "07:00", + "end_local_time": "18:00", + }, + { + "day_of_week": "SAT", + "start_local_time": "07:00", + "end_local_time": "18:00", + }, + { + "day_of_week": "SUN", + "start_local_time": "09:00", + "end_local_time": "15:00", + }, + ] + }, + "description": "Midtown Atlanta store - Open weekends", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to update. + +
+
+ +
+
+ +**location:** `typing.Optional[LocationParams]` — The `Location` object with only the fields to update. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.checkouts(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Links a `checkoutId` to a `checkout_page_url` that customers are +directed to in order to provide their payment information using a +payment processing workflow hosted on connect.squareup.com. + + +NOTE: The Checkout API has been updated with new features. +For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.checkouts( + location_id="location_id", + idempotency_key="86ae1696-b1e3-4328-af6d-f1e04d947ad6", + order={ + "order": { + "location_id": "location_id", + "reference_id": "reference_id", + "customer_id": "customer_id", + "line_items": [ + { + "name": "Printed T Shirt", + "quantity": "2", + "applied_taxes": [ + {"tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"} + ], + "applied_discounts": [ + {"discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4"} + ], + "base_price_money": {"amount": 1500, "currency": "USD"}, + }, + { + "name": "Slim Jeans", + "quantity": "1", + "base_price_money": {"amount": 2500, "currency": "USD"}, + }, + { + "name": "Woven Sweater", + "quantity": "3", + "base_price_money": {"amount": 3500, "currency": "USD"}, + }, + ], + "taxes": [ + { + "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3", + "type": "INCLUSIVE", + "percentage": "7.75", + "scope": "LINE_ITEM", + } + ], + "discounts": [ + { + "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4", + "type": "FIXED_AMOUNT", + "amount_money": {"amount": 100, "currency": "USD"}, + "scope": "LINE_ITEM", + } + ], + }, + "idempotency_key": "12ae1696-z1e3-4328-af6d-f1e04d947gd4", + }, + ask_for_shipping_address=True, + merchant_support_email="merchant+support@website.com", + pre_populate_buyer_email="example@email.com", + pre_populate_shipping_address={ + "address_line1": "1455 Market St.", + "address_line2": "Suite 600", + "locality": "San Francisco", + "administrative_district_level1": "CA", + "postal_code": "94103", + "country": "US", + "first_name": "Jane", + "last_name": "Doe", + }, + redirect_url="https://merchant.website.com/order-confirm", + additional_recipients=[ + { + "location_id": "057P5VYJ4A5X1", + "description": "Application fees", + "amount_money": {"amount": 60, "currency": "USD"}, + } + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the business location to associate the checkout with. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this checkout among others you have created. It can be +any valid string but must be unique for every order sent to Square Checkout for a given location ID. + +The idempotency key is used to avoid processing the same order more than once. If you are +unsure whether a particular checkout was created successfully, you can attempt it again with +the same idempotency key and all the same other parameters without worrying about creating duplicates. + +You should use a random number/string generator native to the language +you are working in to generate strings for your idempotency keys. + +For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + +
+
+ +
+
+ +**order:** `CreateOrderRequestParams` — The order including line items to be checked out. + +
+
+ +
+
+ +**ask_for_shipping_address:** `typing.Optional[bool]` + +If `true`, Square Checkout collects shipping information on your behalf and stores +that information with the transaction information in the Square Seller Dashboard. + +Default: `false`. + +
+
+ +
+
+ +**merchant_support_email:** `typing.Optional[str]` + +The email address to display on the Square Checkout confirmation page +and confirmation email that the buyer can use to contact the seller. + +If this value is not set, the confirmation page and email display the +primary email address associated with the seller's Square account. + +Default: none; only exists if explicitly set. + +
+
+ +
+
+ +**pre_populate_buyer_email:** `typing.Optional[str]` + +If provided, the buyer's email is prepopulated on the checkout page +as an editable text field. + +Default: none; only exists if explicitly set. + +
+
+ +
+
+ +**pre_populate_shipping_address:** `typing.Optional[AddressParams]` + +If provided, the buyer's shipping information is prepopulated on the +checkout page as editable text fields. + +Default: none; only exists if explicitly set. + +
+
+ +
+
+ +**redirect_url:** `typing.Optional[str]` + +The URL to redirect to after the checkout is completed with `checkoutId`, +`transactionId`, and `referenceId` appended as URL parameters. For example, +if the provided redirect URL is `http://www.example.com/order-complete`, a +successful transaction redirects the customer to: + +`http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` + +If you do not provide a redirect URL, Square Checkout displays an order +confirmation page on your behalf; however, it is strongly recommended that +you provide a redirect URL so you can verify the transaction results and +finalize the order through your existing/normal confirmation workflow. + +Default: none; only exists if explicitly set. + +
+
+ +
+
+ +**additional_recipients:** `typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]]` + +The basic primitive of a multi-party transaction. The value is optional. +The transaction facilitated by you can be split from here. + +If you provide this value, the `amount_money` value in your `additional_recipients` field +cannot be more than 90% of the `total_money` calculated by Square for your order. +The `location_id` must be a valid seller location where the checkout is occurring. + +This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. + +This field is currently not supported in the Square Sandbox. + +
+
+ +
+
+ +**note:** `typing.Optional[str]` + +An optional note to associate with the `checkout` object. + +This value cannot exceed 60 characters. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Loyalty +
client.loyalty.search_events(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for loyalty events. + +A Square loyalty program maintains a ledger of events that occur during the lifetime of a +buyer's loyalty account. Each change in the point balance +(for example, points earned, points redeemed, and points expired) is +recorded in the ledger. Using this endpoint, you can search the ledger for events. + +Search results are sorted by `created_at` in descending order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.search_events( + query={ + "filter": { + "order_filter": {"order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY"} + } + }, + limit=30, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[LoyaltyEventQueryParams]` + +A set of one or more predefined query filters to apply when +searching for loyalty events. The endpoint performs a logical AND to +evaluate multiple filters and performs a logical OR on arrays +that specifies multiple field values. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to include in the response. +The last page might contain fewer events. +The default is 30 events. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for your original query. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Merchants +
client.merchants.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides details about the merchant associated with a given access token. + +The access token used to connect your application to a Square seller is associated +with a single merchant. That means that `ListMerchants` returns a list +with a single `Merchant` object. You can specify your personal access token +to get your own merchant information or specify an OAuth token to get the +information for the merchant that granted your application access. + +If you know the merchant ID, you can also use the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) +endpoint to retrieve the merchant information. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.merchants.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[int]` — The cursor generated by the previous response. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the `Merchant` object for the given `merchant_id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.get( + merchant_id="merchant_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**merchant_id:** `str` + +The ID of the merchant to retrieve. If the string "me" is supplied as the ID, +then retrieve the merchant that is currently accessible to this call. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Checkout +
client.checkout.retrieve_location_settings(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the location-level settings for a Square-hosted checkout page. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.retrieve_location_settings( + location_id="location_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location for which to retrieve settings. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.update_location_settings(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the location-level settings for a Square-hosted checkout page. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.update_location_settings( + location_id="location_id", + location_settings={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location for which to retrieve settings. + +
+
+ +
+
+ +**location_settings:** `CheckoutLocationSettingsParams` — Describe your updates using the `location_settings` object. Make sure it contains only the fields that have changed. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.retrieve_merchant_settings() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the merchant-level settings for a Square-hosted checkout page. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.retrieve_merchant_settings() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.update_merchant_settings(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the merchant-level settings for a Square-hosted checkout page. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.update_merchant_settings( + merchant_settings={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**merchant_settings:** `CheckoutMerchantSettingsParams` — Describe your updates using the `merchant_settings` object. Make sure it contains only the fields that have changed. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Orders +
client.orders.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new [order](entity:Order) that can include information about products for +purchase and settings to apply to the purchase. + +To pay for a created order, see +[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + +You can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.create( + order={ + "location_id": "057P5VYJ4A5X1", + "reference_id": "my-order-001", + "line_items": [ + { + "name": "New York Strip Steak", + "quantity": "1", + "base_price_money": {"amount": 1599, "currency": "USD"}, + }, + { + "quantity": "2", + "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", + "modifiers": [ + {"catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ"} + ], + "applied_discounts": [{"discount_uid": "one-dollar-off"}], + }, + ], + "taxes": [ + { + "uid": "state-sales-tax", + "name": "State Sales Tax", + "percentage": "9", + "scope": "ORDER", + } + ], + "discounts": [ + { + "uid": "labor-day-sale", + "name": "Labor Day Sale", + "percentage": "5", + "scope": "ORDER", + }, + { + "uid": "membership-discount", + "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", + "scope": "ORDER", + }, + { + "uid": "one-dollar-off", + "name": "Sale - $1.00 off", + "amount_money": {"amount": 100, "currency": "USD"}, + "scope": "LINE_ITEM", + }, + ], + }, + idempotency_key="8193148c-9586-11e6-99f9-28cfe92138cf", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order:** `typing.Optional[OrderParams]` + +The order to create. If this field is set, the only other top-level field that can be +set is the `idempotency_key`. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A value you specify that uniquely identifies this +order among orders you have created. + +If you are unsure whether a particular order was created successfully, +you can try it again with the same idempotency key without +worrying about creating duplicate orders. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.batch_get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a set of [orders](entity:Order) by their IDs. + +If a given order ID does not exist, the ID is ignored instead of generating an error. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.batch_get( + location_id="057P5VYJ4A5X1", + order_ids=["CAISEM82RcpmcFBM0TfOyiHV3es", "CAISENgvlJ6jLWAzERDzjyHVybY"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_ids:** `typing.Sequence[str]` — The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +The ID of the location for these orders. This field is optional: omit it to retrieve +orders within the scope of the current authorization's merchant ID. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.calculate(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Enables applications to preview order pricing without creating an order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.calculate( + order={ + "location_id": "D7AVYMEAPJ3A3", + "line_items": [ + { + "name": "Item 1", + "quantity": "1", + "base_price_money": {"amount": 500, "currency": "USD"}, + }, + { + "name": "Item 2", + "quantity": "2", + "base_price_money": {"amount": 300, "currency": "USD"}, + }, + ], + "discounts": [ + {"name": "50% Off", "percentage": "50", "scope": "ORDER"} + ], + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order:** `OrderParams` — The order to be calculated. Expects the entire order, not a sparse update. + +
+
+ +
+
+ +**proposed_rewards:** `typing.Optional[typing.Sequence[OrderRewardParams]]` + +Identifies one or more loyalty reward tiers to apply during the order calculation. +The discounts defined by the reward tiers are added to the order only to preview the +effect of applying the specified rewards. The rewards do not correspond to actual +redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are +random strings used only to reference the reward tier. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.clone(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has +only the core fields (such as line items, taxes, and discounts) copied from the original order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.clone( + order_id="ZAISEM52YcpmcWAzERDOyiWS123", + version=3, + idempotency_key="UNIQUE_STRING", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the order to clone. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +An optional order version for concurrency protection. + +If a version is provided, it must match the latest stored version of the order to clone. +If a version is not provided, the API clones the latest version. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A value you specify that uniquely identifies this clone request. + +If you are unsure whether a particular order was cloned successfully, +you can reattempt the call with the same idempotency key without +worrying about creating duplicate cloned orders. +The originally cloned order is returned. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Search all orders for one or more locations. Orders include all sales, +returns, and exchanges regardless of how or when they entered the Square +ecosystem (such as Point of Sale, Invoices, and Connect APIs). + +`SearchOrders` requests need to specify which locations to search and define a +[SearchOrdersQuery](entity:SearchOrdersQuery) object that controls +how to sort or filter the results. Your `SearchOrdersQuery` can: + + Set filter criteria. + Set the sort order. + Determine whether to return results as complete `Order` objects or as +[OrderEntry](entity:OrderEntry) objects. + +Note that details for orders processed with Square Point of Sale while in +offline mode might not be transmitted to Square for up to 72 hours. Offline +orders have a `created_at` value that reflects the time the order was created, +not the time it was subsequently transmitted to Square. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.search( + location_ids=["057P5VYJ4A5X1", "18YC4JDH91E1H"], + query={ + "filter": { + "state_filter": {"states": ["COMPLETED"]}, + "date_time_filter": { + "closed_at": { + "start_at": "2018-03-03T20:00:00+00:00", + "end_at": "2019-03-04T21:54:45+00:00", + } + }, + }, + "sort": {"sort_field": "CLOSED_AT", "sort_order": "DESC"}, + }, + limit=3, + return_entries=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_ids:** `typing.Optional[typing.Sequence[str]]` + +The location IDs for the orders to query. All locations must belong to +the same merchant. + +Max: 10 location IDs. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for your original query. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**query:** `typing.Optional[SearchOrdersQueryParams]` + +Query conditions used to filter or sort the results. Note that when +retrieving additional pages using a cursor, you must use the original query. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to be returned in a single page. + +Default: `500` +Max: `1000` + +
+
+ +
+
+ +**return_entries:** `typing.Optional[bool]` + +A Boolean that controls the format of the search results. If `true`, +`SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders` +returns complete order objects. + +Default: `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves an [Order](entity:Order) by ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.get( + order_id="order_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the order to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates an open [order](entity:Order) by adding, replacing, or deleting +fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. + +An `UpdateOrder` request requires the following: + +- The `order_id` in the endpoint path, identifying the order to update. +- The latest `version` of the order to update. +- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) +containing only the fields to update and the version to which the update is +being applied. +- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) +identifying the fields to clear. + +To pay for an order, see +[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.update( + order_id="order_id", + order={ + "location_id": "location_id", + "line_items": [ + { + "uid": "cookie_uid", + "name": "COOKIE", + "quantity": "2", + "base_price_money": {"amount": 200, "currency": "USD"}, + } + ], + "version": 1, + }, + fields_to_clear=["discounts"], + idempotency_key="UNIQUE_STRING", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the order to update. + +
+
+ +
+
+ +**order:** `typing.Optional[OrderParams]` + +The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) +containing only the fields to update and the version to which the update is +being applied. + +
+
+ +
+
+ +**fields_to_clear:** `typing.Optional[typing.Sequence[str]]` + +The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) +fields to clear. For example, `line_items[uid].note`. +For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A value you specify that uniquely identifies this update request. + +If you are unsure whether a particular update was applied to an order successfully, +you can reattempt it with the same idempotency key without +worrying about creating duplicate updates to the order. +The latest order version is returned. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.pay(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment) +or settle an order with a total of `0`. + +The total of the `payment_ids` listed in the request must be equal to the order +total. Orders with a total amount of `0` can be marked as paid by specifying an empty +array of `payment_ids` in the request. + +To be used with `PayOrder`, a payment must: + +- Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment). +Any approved payments that reference the same `order_id` not specified in the +`payment_ids` is canceled. +- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). +Using a delayed capture payment with `PayOrder` completes the approved payment. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.pay( + order_id="order_id", + idempotency_key="c043a359-7ad9-4136-82a9-c3f1d66dcbff", + payment_ids=["EnZdNAlWCmfh6Mt5FMNST1o7taB", "0LRiVlbXVwe8ozu4KbZxd12mvaB"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the order being paid. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A value you specify that uniquely identifies this request among requests you have sent. If +you are unsure whether a particular payment request was completed successfully, you can reattempt +it with the same idempotency key without worrying about duplicate payments. + +For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + +
+
+ +
+
+ +**order_version:** `typing.Optional[int]` — The version of the order being paid. If not supplied, the latest version will be paid. + +
+
+ +
+
+ +**payment_ids:** `typing.Optional[typing.Sequence[str]]` + +The IDs of the [payments](entity:Payment) to collect. +The payment total must match the order total. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Payments +
client.payments.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a list of payments taken by the account making the request. + +Results are eventually consistent, and new payments or changes to payments might take several +seconds to appear. + +The maximum results per page is 100. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.payments.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` + +Indicates the start of the time range to retrieve payments for, in RFC 3339 format. +The range is determined using the `created_at` field for each Payment. +Inclusive. Default: The current time minus one year. + +
+
+ +
+
+ +**end_time:** `typing.Optional[str]` + +Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The +range is determined using the `created_at` field for each Payment. + +Default: The current time. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[str]` + +The order in which results are listed by `ListPaymentsRequest.sort_field`: +- `ASC` - Oldest to newest. +- `DESC` - Newest to oldest (default). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +Limit results to the location supplied. By default, results are returned +for the default (main) location associated with the seller. + +
+
+ +
+
+ +**total:** `typing.Optional[int]` — The exact amount in the `total_money` for a payment. + +
+
+ +
+
+ +**last4:** `typing.Optional[str]` — The last four digits of a payment card. + +
+
+ +
+
+ +**card_brand:** `typing.Optional[str]` — The brand of the payment card (for example, VISA). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to be returned in a single page. +It is possible to receive fewer results than the specified limit on a given page. + +The default value of 100 is also the maximum allowed value. If the provided value is +greater than 100, it is ignored and the default value is used instead. + +Default: `100` + +
+
+ +
+
+ +**is_offline_payment:** `typing.Optional[bool]` — Whether the payment was taken offline or not. + +
+
+ +
+
+ +**offline_begin_time:** `typing.Optional[str]` + +Indicates the start of the time range for which to retrieve offline payments, in RFC 3339 +format for timestamps. The range is determined using the +`offline_payment_details.client_created_at` field for each Payment. If set, payments without a +value set in `offline_payment_details.client_created_at` will not be returned. + +Default: The current time. + +
+
+ +
+
+ +**offline_end_time:** `typing.Optional[str]` + +Indicates the end of the time range for which to retrieve offline payments, in RFC 3339 +format for timestamps. The range is determined using the +`offline_payment_details.client_created_at` field for each Payment. If set, payments without a +value set in `offline_payment_details.client_created_at` will not be returned. + +Default: The current time. + +
+
+ +
+
+ +**updated_at_begin_time:** `typing.Optional[str]` + +Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The +range is determined using the `updated_at` field for each Payment. + +
+
+ +
+
+ +**updated_at_end_time:** `typing.Optional[str]` + +Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The +range is determined using the `updated_at` field for each Payment. + +
+
+ +
+
+ +**sort_field:** `typing.Optional[ListPaymentsRequestSortField]` — The field used to sort results by. The default is `CREATED_AT`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payments.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a payment using the provided source. You can use this endpoint +to charge a card (credit/debit card or +Square gift card) or record a payment that the seller received outside of Square +(cash payment from a buyer or a payment that an external entity +processed on behalf of the seller). + +The endpoint creates a +`Payment` object and returns it in the response. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payments.create( + source_id="ccof:GaJGNaZa8x4OgDJn4GB", + idempotency_key="7b0f3ec5-086a-4871-8f13-3c81b3875218", + amount_money={"amount": 1000, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=True, + customer_id="W92WH6P11H4Z77CTET0RNTGFW8", + location_id="L88917AVBK2S5", + reference_id="123456", + note="Brief description", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**source_id:** `str` + +The ID for the source of funds for this payment. +This could be a payment token generated by the Web Payments SDK for any of its +[supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), +including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment +that the seller received outside of Square, specify either "CASH" or "EXTERNAL". +For more information, see +[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `CreatePayment` request. Keys can be any valid string +but must be unique for every `CreatePayment` request. + +Note: The number of allowed characters might be less than the stated maximum, if multi-byte +characters are used. + +For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + +
+
+ +
+
+ +**amount_money:** `typing.Optional[MoneyParams]` + +The amount of money to accept for this payment, not including `tip_money`. + +The amount must be specified in the smallest denomination of the applicable currency +(for example, US dollar amounts are specified in cents). For more information, see +[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + +The currency code must match the currency associated with the business +that is accepting the payment. + +
+
+ +
+
+ +**tip_money:** `typing.Optional[MoneyParams]` + +The amount designated as a tip, in addition to `amount_money`. + +The amount must be specified in the smallest denomination of the applicable currency +(for example, US dollar amounts are specified in cents). For more information, see +[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + +The currency code must match the currency associated with the business +that is accepting the payment. + +
+
+ +
+
+ +**app_fee_money:** `typing.Optional[MoneyParams]` + +The amount of money that the developer is taking as a fee +for facilitating the payment on behalf of the seller. + +The amount cannot be more than 90% of the total amount of the payment. + +The amount must be specified in the smallest denomination of the applicable currency +(for example, US dollar amounts are specified in cents). For more information, see +[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + +The fee currency code must match the currency associated with the seller +that is accepting the payment. The application must be from a developer +account in the same country and using the same currency code as the seller. + +For more information about the application fee scenario, see +[Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + +To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. +For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + +
+
+ +
+
+ +**delay_duration:** `typing.Optional[str]` + +The duration of time after the payment's creation when Square automatically +either completes or cancels the payment depending on the `delay_action` field value. +For more information, see +[Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + +This parameter should be specified as a time duration, in RFC 3339 format. + +Note: This feature is only supported for card payments. This parameter can only be set for a delayed +capture payment (`autocomplete=false`). + +Default: + +- Card-present payments: "PT36H" (36 hours) from the creation time. +- Card-not-present payments: "P7D" (7 days) from the creation time. + +
+
+ +
+
+ +**delay_action:** `typing.Optional[str]` + +The action to be applied to the payment when the `delay_duration` has elapsed. The action must be +CANCEL or COMPLETE. For more information, see +[Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + +Default: CANCEL + +
+
+ +
+
+ +**autocomplete:** `typing.Optional[bool]` + +If set to `true`, this payment will be completed when possible. If +set to `false`, this payment is held in an approved state until either +explicitly completed (captured) or canceled (voided). For more information, see +[Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). + +Default: true + +
+
+ +
+
+ +**order_id:** `typing.Optional[str]` — Associates a previously created order with this payment. + +
+
+ +
+
+ +**customer_id:** `typing.Optional[str]` + +The [Customer](entity:Customer) ID of the customer associated with the payment. + +This is required if the `source_id` refers to a card on file created using the Cards API. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is +used. + +
+
+ +
+
+ +**team_member_id:** `typing.Optional[str]` + +An optional [TeamMember](entity:TeamMember) ID to associate with +this payment. + +
+
+ +
+
+ +**reference_id:** `typing.Optional[str]` + +A user-defined ID to associate with the payment. + +You can use this field to associate the payment to an entity in an external system +(for example, you might specify an order ID that is generated by a third-party shopping cart). + +
+
+ +
+
+ +**verification_token:** `typing.Optional[str]` + +An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). +Verification tokens encapsulate customer device information and 3-D Secure +challenge results to indicate that Square has verified the buyer identity. + +For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). + +
+
+ +
+
+ +**accept_partial_authorization:** `typing.Optional[bool]` + +If set to `true` and charging a Square Gift Card, a payment might be returned with +`amount_money` equal to less than what was requested. For example, a request for $20 when charging +a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose +to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card +payment. This field cannot be `true` when `autocomplete = true`. + +For more information, see +[Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). + +Default: false + +
+
+ +
+
+ +**buyer_email_address:** `typing.Optional[str]` — The buyer's email address. + +
+
+ +
+
+ +**buyer_phone_number:** `typing.Optional[str]` + +The buyer's phone number. +Must follow the following format: +1. A leading + symbol (followed by a country code) +2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`. +Alphabetical characters aren't allowed. +3. The phone number must contain between 9 and 16 digits. + +
+
+ +
+
+ +**billing_address:** `typing.Optional[AddressParams]` — The buyer's billing address. + +
+
+ +
+
+ +**shipping_address:** `typing.Optional[AddressParams]` — The buyer's shipping address. + +
+
+ +
+
+ +**note:** `typing.Optional[str]` — An optional note to be entered by the developer when creating a payment. + +
+
+ +
+
+ +**statement_description_identifier:** `typing.Optional[str]` + +Optional additional payment information to include on the customer's card statement +as part of the statement description. This can be, for example, an invoice number, ticket number, +or short description that uniquely identifies the purchase. + +Note that the `statement_description_identifier` might get truncated on the statement description +to fit the required information including the Square identifier (SQ *) and name of the +seller taking the payment. + +
+
+ +
+
+ +**cash_details:** `typing.Optional[CashPaymentDetailsParams]` — Additional details required when recording a cash payment (`source_id` is CASH). + +
+
+ +
+
+ +**external_details:** `typing.Optional[ExternalPaymentDetailsParams]` — Additional details required when recording an external payment (`source_id` is EXTERNAL). + +
+
+ +
+
+ +**customer_details:** `typing.Optional[CustomerDetailsParams]` — Details about the customer making the payment. + +
+
+ +
+
+ +**offline_payment_details:** `typing.Optional[OfflinePaymentDetailsParams]` + +An optional field for specifying the offline payment details. This is intended for +internal 1st-party callers only. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payments.cancel_by_idempotency_key(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels (voids) a payment identified by the idempotency key that is specified in the +request. + +Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a +`CreatePayment` request, a network error occurs and you do not get a response). In this case, you can +direct Square to cancel the payment using this endpoint. In the request, you provide the same +idempotency key that you provided in your `CreatePayment` request that you want to cancel. After +canceling the payment, you can submit your `CreatePayment` request again. + +Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint +returns successfully. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payments.cancel_by_idempotency_key( + idempotency_key="a7e36d40-d24b-11e8-b568-0800200c9a66", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` — The `idempotency_key` identifying the payment to be canceled. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payments.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves details for a specific payment. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payments.get( + payment_id="payment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**payment_id:** `str` — A unique ID for the desired payment. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payments.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a payment with the APPROVED status. +You can update the `amount_money` and `tip_money` using this endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payments.update( + payment_id="payment_id", + payment={ + "amount_money": {"amount": 1000, "currency": "USD"}, + "tip_money": {"amount": 100, "currency": "USD"}, + "version_token": "ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o", + }, + idempotency_key="956f8b13-e4ec-45d6-85e8-d1d95ef0c5de", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**payment_id:** `str` — The ID of the payment to update. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `UpdatePayment` request. Keys can be any valid string +but must be unique for every `UpdatePayment` request. + +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**payment:** `typing.Optional[PaymentParams]` — The updated `Payment` object. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payments.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels (voids) a payment. You can use this endpoint to cancel a payment with +the APPROVED `status`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payments.cancel( + payment_id="payment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**payment_id:** `str` — The ID of the payment to cancel. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payments.complete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Completes (captures) a payment. +By default, payments are set to complete immediately after they are created. + +You can use this endpoint to complete a payment with the APPROVED `status`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payments.complete( + payment_id="payment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**payment_id:** `str` — The unique ID identifying the payment to be completed. + +
+
+ +
+
+ +**version_token:** `typing.Optional[str]` + +Used for optimistic concurrency. This opaque token identifies the current `Payment` +version that the caller expects. If the server has a different version of the Payment, +the update fails and a response with a VERSION_MISMATCH error is returned. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Payouts +
client.payouts.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a list of all payouts for the default location. +You can filter payouts by location ID, status, time range, and order them in ascending or descending order. +To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.payouts.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +The ID of the location for which to list the payouts. +By default, payouts are returned for the default (main) location associated with the seller. + +
+
+ +
+
+ +**status:** `typing.Optional[PayoutStatus]` — If provided, only payouts with the given status are returned. + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` + +The timestamp for the beginning of the payout creation time, in RFC 3339 format. +Inclusive. Default: The current time minus one year. + +
+
+ +
+
+ +**end_time:** `typing.Optional[str]` + +The timestamp for the end of the payout creation time, in RFC 3339 format. +Default: The current time. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` — The order in which payouts are listed. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). +If request parameters change between requests, subsequent results may contain duplicates or missing records. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to be returned in a single page. +It is possible to receive fewer results than the specified limit on a given page. +The default value of 100 is also the maximum allowed value. If the provided value is +greater than 100, it is ignored and the default value is used instead. +Default: `100` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payouts.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves details of a specific payout identified by a payout ID. +To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.payouts.get( + payout_id="payout_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**payout_id:** `str` — The ID of the payout to retrieve the information for. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.payouts.list_entries(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a list of all payout entries for a specific payout. +To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.payouts.list_entries( + payout_id="payout_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**payout_id:** `str` — The ID of the payout to retrieve the information for. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` — The order in which payout entries are listed. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). +If request parameters change between requests, subsequent results may contain duplicates or missing records. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to be returned in a single page. +It is possible to receive fewer results than the specified limit on a given page. +The default value of 100 is also the maximum allowed value. If the provided value is +greater than 100, it is ignored and the default value is used instead. +Default: `100` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Refunds +
client.refunds.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a list of refunds for the account making the request. + +Results are eventually consistent, and new refunds or changes to refunds might take several +seconds to appear. + +The maximum results per page is 100. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.refunds.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` + +Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 +format. The range is determined using the `created_at` field for each `PaymentRefund`. + +Default: The current time minus one year. + +
+
+ +
+
+ +**end_time:** `typing.Optional[str]` + +Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 +format. The range is determined using the `created_at` field for each `PaymentRefund`. + +Default: The current time. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[str]` + +The order in which results are listed by `PaymentRefund.created_at`: +- `ASC` - Oldest to newest. +- `DESC` - Newest to oldest (default). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +Limit results to the location supplied. By default, results are returned +for all locations associated with the seller. + +
+
+ +
+
+ +**status:** `typing.Optional[str]` + +If provided, only refunds with the given status are returned. +For a list of refund status values, see [PaymentRefund](entity:PaymentRefund). + +Default: If omitted, refunds are returned regardless of their status. + +
+
+ +
+
+ +**source_type:** `typing.Optional[str]` + +If provided, only returns refunds whose payments have the indicated source type. +Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. +For information about these payment source types, see +[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + +Default: If omitted, refunds are returned regardless of the source type. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to be returned in a single page. + +It is possible to receive fewer results than the specified limit on a given page. + +If the supplied value is greater than 100, no more than 100 results are returned. + +Default: 100 + +
+
+ +
+
+ +**updated_at_begin_time:** `typing.Optional[str]` + +Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 +format. The range is determined using the `updated_at` field for each `PaymentRefund`. + +Default: If omitted, the time range starts at `begin_time`. + +
+
+ +
+
+ +**updated_at_end_time:** `typing.Optional[str]` + +Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 +format. The range is determined using the `updated_at` field for each `PaymentRefund`. + +Default: The current time. + +
+
+ +
+
+ +**sort_field:** `typing.Optional[ListPaymentRefundsRequestSortField]` — The field used to sort results by. The default is `CREATED_AT`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.refunds.refund_payment(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Refunds a payment. You can refund the entire payment amount or a +portion of it. You can use this endpoint to refund a card payment or record a +refund of a cash or external payment. For more information, see +[Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.refunds.refund_payment( + idempotency_key="9b7f2dcf-49da-4411-b23e-a2d6af21333a", + amount_money={"amount": 1000, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + payment_id="R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", + reason="Example", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + + A unique string that identifies this `RefundPayment` request. The key can be any valid string +but must be unique for every `RefundPayment` request. + +Keys are limited to a max of 45 characters - however, the number of allowed characters might be +less than 45, if multi-byte characters are used. + +For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + +
+
+ +
+
+ +**amount_money:** `MoneyParams` + +The amount of money to refund. + +This amount cannot be more than the `total_money` value of the payment minus the total +amount of all previously completed refunds for this payment. + +This amount must be specified in the smallest denomination of the applicable currency +(for example, US dollar amounts are specified in cents). For more information, see +[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + +The currency code must match the currency associated with the business +that is charging the card. + +
+
+ +
+
+ +**app_fee_money:** `typing.Optional[MoneyParams]` + +The amount of money the developer contributes to help cover the refunded amount. +This amount is specified in the smallest denomination of the applicable currency (for example, +US dollar amounts are specified in cents). + +The value cannot be more than the `amount_money`. + +You can specify this parameter in a refund request only if the same parameter was also included +when taking the payment. This is part of the application fee scenario the API supports. For more +information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + +To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. +For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + +
+
+ +
+
+ +**payment_id:** `typing.Optional[str]` + +The unique ID of the payment being refunded. +Required when unlinked=false, otherwise must not be set. + +
+
+ +
+
+ +**destination_id:** `typing.Optional[str]` + +The ID indicating where funds will be refunded to. Required for unlinked refunds. For more +information, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds). + +For refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds +will be returned to the original payment source. The field may be specified in order to request +a cross-method refund to a gift card. For more information, +see [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). + +
+
+ +
+
+ +**unlinked:** `typing.Optional[bool]` + +Indicates that the refund is not linked to a Square payment. +If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not +be provided. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +The location ID associated with the unlinked refund. +Required for requests specifying `unlinked=true`. +Otherwise, if included when `unlinked=false`, will throw an error. + +
+
+ +
+
+ +**customer_id:** `typing.Optional[str]` + +The [Customer](entity:Customer) ID of the customer associated with the refund. +This is required if the `destination_id` refers to a card on file created using the Cards +API. Only allowed when `unlinked=true`. + +
+
+ +
+
+ +**reason:** `typing.Optional[str]` — A description of the reason for the refund. + +
+
+ +
+
+ +**payment_version_token:** `typing.Optional[str]` + + Used for optimistic concurrency. This opaque token identifies the current `Payment` +version that the caller expects. If the server has a different version of the Payment, +the update fails and a response with a VERSION_MISMATCH error is returned. +If the versions match, or the field is not provided, the refund proceeds as normal. + +
+
+ +
+
+ +**team_member_id:** `typing.Optional[str]` — An optional [TeamMember](entity:TeamMember) ID to associate with this refund. + +
+
+ +
+
+ +**cash_details:** `typing.Optional[DestinationDetailsCashRefundDetailsParams]` — Additional details required when recording an unlinked cash refund (`destination_id` is CASH). + +
+
+ +
+
+ +**external_details:** `typing.Optional[DestinationDetailsExternalRefundDetailsParams]` + +Additional details required when recording an unlinked external refund +(`destination_id` is EXTERNAL). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.refunds.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a specific refund using the `refund_id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.refunds.get( + refund_id="refund_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**refund_id:** `str` — The unique ID for the desired `PaymentRefund`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Sites +
client.sites.list() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. + + +__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.sites.list() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Snippets +
client.snippets.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. + +You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + +__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.snippets.get( + site_id="site_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — The ID of the site that contains the snippet. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.snippets.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Adds a snippet to a Square Online site or updates the existing snippet on the site. +The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. + +You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + +__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.snippets.upsert( + site_id="site_id", + snippet={"content": ""}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — The ID of the site where you want to add or update the snippet. + +
+
+ +
+
+ +**snippet:** `SnippetParams` — The snippet for the site. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.snippets.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Removes your snippet from a Square Online site. + +You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + +__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.snippets.delete( + site_id="site_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — The ID of the site that contains the snippet. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Subscriptions +
client.subscriptions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Enrolls a customer in a subscription. + +If you provide a card on file in the request, Square charges the card for +the subscription. Otherwise, Square sends an invoice to the customer's email +address. The subscription starts immediately, unless the request includes +the optional `start_date`. Each individual subscription is associated with a particular location. + +For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.create( + idempotency_key="8193148c-9586-11e6-99f9-28cfe92138cf", + location_id="S8GWD5R9QB376", + plan_variation_id="6JHXF3B2CW3YKHDV4XEM674H", + customer_id="CHFGVKYY8RSV93M5KCYTG4PN0G", + start_date="2023-06-20", + card_id="ccof:qy5x8hHGYsgLrp4Q4GB", + timezone="America/Los_Angeles", + source={"name": "My Application"}, + phases=[ + {"ordinal": 0, "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY"} + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location the subscription is associated with. + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the [customer](entity:Customer) subscribing to the subscription plan variation. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique string that identifies this `CreateSubscription` request. +If you do not provide a unique string (or provide an empty string as the value), +the endpoint treats each request as independent. + +For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**plan_variation_id:** `typing.Optional[str]` — The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. + +
+
+ +
+
+ +**start_date:** `typing.Optional[str]` + +The `YYYY-MM-DD`-formatted date to start the subscription. +If it is unspecified, the subscription starts immediately. + +
+
+ +
+
+ +**canceled_date:** `typing.Optional[str]` + +The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. + +This date overrides the cancellation date set in the plan variation configuration. +If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops +at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. + +When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` +occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription +stops through the end of the last cycle. + +
+
+ +
+
+ +**tax_percentage:** `typing.Optional[str]` + +The tax to add when billing the subscription. +The percentage is expressed in decimal form, using a `'.'` as the decimal +separator and without a `'%'` sign. For example, a value of 7.5 +corresponds to 7.5%. + +
+
+ +
+
+ +**price_override_money:** `typing.Optional[MoneyParams]` + +A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. +This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, +you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + +
+
+ +
+
+ +**card_id:** `typing.Optional[str]` + +The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge. +If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription. + +
+
+ +
+
+ +**timezone:** `typing.Optional[str]` + +The timezone that is used in date calculations for the subscription. If unset, defaults to +the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". +Format: the IANA Timezone Database identifier for the location timezone. For +a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + +
+
+ +
+
+ +**source:** `typing.Optional[SubscriptionSourceParams]` — The origination details of the subscription. + +
+
+ +
+
+ +**monthly_billing_anchor_date:** `typing.Optional[int]` — The day-of-the-month to change the billing date to. + +
+
+ +
+
+ +**phases:** `typing.Optional[typing.Sequence[PhaseParams]]` — array of phases for this subscription + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.bulk_swap_plan(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Schedules a plan variation change for all active subscriptions under a given plan +variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.bulk_swap_plan( + new_plan_variation_id="FQ7CDXXWSLUJRPM3GFJSJGZ7", + old_plan_variation_id="6JHXF3B2CW3YKHDV4XEM674H", + location_id="S8GWD5R9QB376", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**new_plan_variation_id:** `str` + +The ID of the new subscription plan variation. + +This field is required. + +
+
+ +
+
+ +**old_plan_variation_id:** `str` + +The ID of the plan variation whose subscriptions should be swapped. Active subscriptions +using this plan variation will be subscribed to the new plan variation on their next billing +day. + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to associate with the swapped subscriptions. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for subscriptions. + +Results are ordered chronologically by subscription creation date. If +the request specifies more than one location ID, +the endpoint orders the result +by location ID, and then by creation date within each location. If no locations are given +in the query, all locations are searched. + +You can also optionally specify `customer_ids` to search by customer. +If left unset, all customers +associated with the specified locations are returned. +If the request specifies customer IDs, the endpoint orders results +first by location, within location by customer ID, and within +customer by subscription creation date. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.search( + query={ + "filter": { + "customer_ids": ["CHFGVKYY8RSV93M5KCYTG4PN0G"], + "location_ids": ["S8GWD5R9QB376"], + "source_names": ["My App"], + } + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +When the total number of resulting subscriptions exceeds the limit of a paged response, +specify the cursor returned from a preceding response here to fetch the next set of results. +If the cursor is unset, the response contains the last page of the results. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The upper limit on the number of subscriptions to return +in a paged response. + +
+
+ +
+
+ +**query:** `typing.Optional[SearchSubscriptionsQueryParams]` + +A subscription query consisting of specified filtering conditions. + +If this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions. + +
+
+ +
+
+ +**include:** `typing.Optional[typing.Sequence[str]]` + +An option to include related information in the response. + +The supported values are: + +- `actions`: to include scheduled actions on the targeted subscriptions. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a specific subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.get( + subscription_id="subscription_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to retrieve. + +
+
+ +
+
+ +**include:** `typing.Optional[str]` + +A query parameter to specify related information to be included in the response. + +The supported query parameter values are: + +- `actions`: to include scheduled actions on the targeted subscription. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a subscription by modifying or clearing `subscription` field values. +To clear a field, set its value to `null`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.update( + subscription_id="subscription_id", + subscription={"card_id": "{NEW CARD ID}"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to update. + +
+
+ +
+
+ +**subscription:** `typing.Optional[SubscriptionParams]` + +The subscription object containing the current version, and fields to update. +Unset fields will be left at their current server values, and JSON `null` values will +be treated as a request to clear the relevant data. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.delete_action(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a scheduled action for a subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.delete_action( + subscription_id="subscription_id", + action_id="action_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription the targeted action is to act upon. + +
+
+ +
+
+ +**action_id:** `str` — The ID of the targeted action to be deleted. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.change_billing_anchor_date(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) +for a subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.change_billing_anchor_date( + subscription_id="subscription_id", + monthly_billing_anchor_date=1, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to update the billing anchor date. + +
+
+ +
+
+ +**monthly_billing_anchor_date:** `typing.Optional[int]` — The anchor day for the billing cycle. + +
+
+ +
+
+ +**effective_date:** `typing.Optional[str]` + +The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes +place on the subscription. + +When this date is unspecified or falls within the current billing cycle, the billing anchor date +is changed immediately. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Schedules a `CANCEL` action to cancel an active subscription. This +sets the `canceled_date` field to the end of the active billing period. After this date, +the subscription status changes from ACTIVE to CANCELED. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.cancel( + subscription_id="subscription_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to cancel. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.list_events(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.subscriptions.list_events( + subscription_id="subscription_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to retrieve the events for. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +When the total number of resulting subscription events exceeds the limit of a paged response, +specify the cursor returned from a preceding response here to fetch the next set of results. +If the cursor is unset, the response contains the last page of the results. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The upper limit on the number of subscription events to return +in a paged response. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.pause(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Schedules a `PAUSE` action to pause an active subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.pause( + subscription_id="subscription_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to pause. + +
+
+ +
+
+ +**pause_effective_date:** `typing.Optional[str]` + +The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. + +When this date is unspecified or falls within the current billing cycle, the subscription is paused +on the starting date of the next billing cycle. + +
+
+ +
+
+ +**pause_cycle_duration:** `typing.Optional[int]` + +The number of billing cycles the subscription will be paused before it is reactivated. + +When this is set, a `RESUME` action is also scheduled to take place on the subscription at +the end of the specified pause cycle duration. In this case, neither `resume_effective_date` +nor `resume_change_timing` may be specified. + +
+
+ +
+
+ +**resume_effective_date:** `typing.Optional[str]` + +The date when the subscription is reactivated by a scheduled `RESUME` action. +This date must be at least one billing cycle ahead of `pause_effective_date`. + +
+
+ +
+
+ +**resume_change_timing:** `typing.Optional[ChangeTiming]` + +The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to +`resume_effective_date`. +See [ChangeTiming](#type-changetiming) for possible values + +
+
+ +
+
+ +**pause_reason:** `typing.Optional[str]` — The user-provided reason to pause the subscription. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.resume(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Schedules a `RESUME` action to resume a paused or a deactivated subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.resume( + subscription_id="subscription_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to resume. + +
+
+ +
+
+ +**resume_effective_date:** `typing.Optional[str]` — The `YYYY-MM-DD`-formatted date when the subscription reactivated. + +
+
+ +
+
+ +**resume_change_timing:** `typing.Optional[ChangeTiming]` + +The timing to resume a subscription, relative to the specified +`resume_effective_date` attribute value. +See [ChangeTiming](#type-changetiming) for possible values + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.subscriptions.swap_plan(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. +For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.subscriptions.swap_plan( + subscription_id="subscription_id", + new_plan_variation_id="FQ7CDXXWSLUJRPM3GFJSJGZ7", + phases=[ + {"ordinal": 0, "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY"} + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — The ID of the subscription to swap the subscription plan for. + +
+
+ +
+
+ +**new_plan_variation_id:** `typing.Optional[str]` + +The ID of the new subscription plan variation. + +This field is required. + +
+
+ +
+
+ +**phases:** `typing.Optional[typing.Sequence[PhaseInputParams]]` — A list of PhaseInputs, to pass phase-specific information used in the swap. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## TeamMembers +
client.team_members.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates. +You must provide the following values in your request to this endpoint: +- `given_name` +- `family_name` + +Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.create( + idempotency_key="idempotency-key-0", + team_member={ + "reference_id": "reference_id_1", + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + "wage_setting": { + "job_assignments": [ + { + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + }, + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2000, "currency": "USD"}, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + }, + ], + "is_overtime_exempt": True, + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique string that identifies this `CreateTeamMember` request. +Keys can be any valid string, but must be unique for every request. +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +The minimum length is 1 and the maximum length is 45. + +
+
+ +
+
+ +**team_member:** `typing.Optional[TeamMemberParams]` + +**Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide +`job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team_members.batch_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates. +This process is non-transactional and processes as much of the request as possible. If one of the creates in +the request cannot be successfully processed, the request is not marked as failed, but the body of the response +contains explicit error information for the failed create. + +Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.batch_create( + team_members={ + "idempotency-key-1": { + "team_member": { + "reference_id": "reference_id_1", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + } + }, + "idempotency-key-2": { + "team_member": { + "reference_id": "reference_id_2", + "given_name": "Jane", + "family_name": "Smith", + "email_address": "jane_smith@gmail.com", + "phone_number": "+14159223334", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + } + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_members:** `typing.Dict[str, CreateTeamMemberRequestParams]` + +The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. +The maximum number of create objects is 25. + +If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, +call [ListJobs](api-endpoint:Team-ListJobs). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team_members.batch_update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates. +This process is non-transactional and processes as much of the request as possible. If one of the updates in +the request cannot be successfully processed, the request is not marked as failed, but the body of the response +contains explicit error information for the failed update. +Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.batch_update( + team_members={ + "AFMwA08kR-MIF-3Vs0OE": { + "team_member": { + "reference_id": "reference_id_2", + "is_owner": False, + "status": "ACTIVE", + "given_name": "Jane", + "family_name": "Smith", + "email_address": "jane_smith@gmail.com", + "phone_number": "+14159223334", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + } + }, + "fpgteZNMaf0qOK-a4t6P": { + "team_member": { + "reference_id": "reference_id_1", + "is_owner": False, + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + } + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_members:** `typing.Dict[str, UpdateTeamMemberRequestParams]` + +The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. +The maximum number of update objects is 25. + +For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. +To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, +call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team_members.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of `TeamMember` objects for a business. +The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether +the team member is the Square account owner. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.search( + query={"filter": {"location_ids": ["0G5P3VGACMMQZ"], "status": "ACTIVE"}}, + limit=10, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[SearchTeamMembersQueryParams]` — The query parameters. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of `TeamMember` objects in a page (100 by default). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The opaque cursor for fetching the next page. For more information, see +[pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team_members.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a `TeamMember` object for the given `TeamMember.id`. +Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.get( + team_member_id="team_member_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_id:** `str` — The ID of the team member to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team_members.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. +Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.update( + team_member_id="team_member_id", + team_member={ + "reference_id": "reference_id_1", + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + "wage_setting": { + "job_assignments": [ + { + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + }, + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 1200, "currency": "USD"}, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + }, + ], + "is_overtime_exempt": True, + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_id:** `str` — The ID of the team member to update. + +
+
+ +
+
+ +**team_member:** `typing.Optional[TeamMemberParams]` + +The team member fields to add, change, or clear. Fields can be cleared using a null value. To update +`wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call +[ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Team +
client.team.list_jobs(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists jobs in a seller account. Results are sorted by title in ascending order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team.list_jobs() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The pagination cursor returned by the previous call to this endpoint. Provide this +cursor to retrieve the next page of results for your original request. For more information, +see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team.create_job(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a job in a seller account. A job defines a title and tip eligibility. Note that +compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team.create_job( + job={"title": "Cashier", "is_tip_eligible": True}, + idempotency_key="idempotency-key-0", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**job:** `JobParams` — The job to create. The `title` field is required and `is_tip_eligible` defaults to true. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique identifier for the `CreateJob` request. Keys can be any valid string, +but must be unique for each request. For more information, see +[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team.retrieve_job(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a specified job. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team.retrieve_job( + job_id="job_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**job_id:** `str` — The ID of the job to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team.update_job(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the title or tip eligibility of a job. Changes to the title propagate to all +`JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to +tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team.update_job( + job_id="job_id", + job={"title": "Cashier 1", "is_tip_eligible": True}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**job_id:** `str` — The ID of the job to update. + +
+
+ +
+
+ +**job:** `JobParams` + +The job with the updated fields, either `title`, `is_tip_eligible`, or both. Only changed fields need +to be included in the request. Optionally include `version` to enable optimistic concurrency control. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Terminal +
client.terminal.dismiss_terminal_action(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Dismisses a Terminal action request if the status and type of the request permits it. + +See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.dismiss_terminal_action( + action_id="action_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**action_id:** `str` — Unique ID for the `TerminalAction` associated with the action to be dismissed. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.dismiss_terminal_checkout(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Dismisses a Terminal checkout request if the status and type of the request permits it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.dismiss_terminal_checkout( + checkout_id="checkout_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**checkout_id:** `str` — Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.dismiss_terminal_refund(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Dismisses a Terminal refund request if the status and type of the request permits it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.dismiss_terminal_refund( + terminal_refund_id="terminal_refund_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**terminal_refund_id:** `str` — Unique ID for the `TerminalRefund` associated with the refund to be dismissed. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Vendors +
client.vendors.batch_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.batch_create( + vendors={ + "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": { + "name": "Joe's Fresh Seafood", + "address": { + "address_line1": "505 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "contacts": [ + { + "name": "Joe Burrow", + "email_address": "joe@joesfreshseafood.com", + "phone_number": "1-212-555-4250", + "ordinal": 1, + } + ], + "account_number": "4025391", + "note": "a vendor", + } + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**vendors:** `typing.Dict[str, VendorParams]` — Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.vendors.batch_get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.batch_get( + vendor_ids=["INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4"], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**vendor_ids:** `typing.Optional[typing.Sequence[str]]` — IDs of the [Vendor](entity:Vendor) objects to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.vendors.batch_update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.batch_update( + vendors={ + "FMCYHBWT1TPL8MFH52PBMEN92A": {"vendor": {}}, + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {"vendor": {}}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**vendors:** `typing.Dict[str, UpdateVendorRequestParams]` + +A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) +objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.vendors.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.create( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + vendor={ + "name": "Joe's Fresh Seafood", + "address": { + "address_line1": "505 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "contacts": [ + { + "name": "Joe Burrow", + "email_address": "joe@joesfreshseafood.com", + "phone_number": "1-212-555-4250", + "ordinal": 1, + } + ], + "account_number": "4025391", + "note": "a vendor", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent. + +See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the +[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more +information. + +
+
+ +
+
+ +**vendor:** `typing.Optional[VendorParams]` — The requested [Vendor](entity:Vendor) to be created. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.vendors.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.search() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**filter:** `typing.Optional[SearchVendorsRequestFilterParams]` — Specifies a filter used to search for vendors. + +
+
+ +
+
+ +**sort:** `typing.Optional[SearchVendorsRequestSortParams]` — Specifies a sorter used to sort the returned vendors. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. + +See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.vendors.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the vendor of a specified [Vendor](entity:Vendor) ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.get( + vendor_id="vendor_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**vendor_id:** `str` — ID of the [Vendor](entity:Vendor) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.vendors.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.vendors.update( + vendor_id="vendor_id", + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + vendor={ + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Jack's Chicken Shack", + "version": 1, + "status": "ACTIVE", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**vendor_id:** `str` — ID of the [Vendor](entity:Vendor) to retrieve. + +
+
+ +
+
+ +**vendor:** `VendorParams` — The specified [Vendor](entity:Vendor) to be updated. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A client-supplied, universally unique identifier (UUID) for the +request. + +See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the +[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more +information. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Bookings CustomAttributeDefinitions +
client.bookings.custom_attribute_definitions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get all bookings custom attribute definitions. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.bookings.custom_attribute_definitions.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attribute_definitions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a bookings custom attribute definition. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attribute_definitions.create( + custom_attribute_definition={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition to create, with the following fields: + +- `key` + +- `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute +definitions for the seller. + +- `description` + +- `visibility`. Note that all custom attributes are visible in exported booking data, including those set to +`VISIBILITY_HIDDEN`. + +- `schema`. With the exception of the `Selection` data type, the `schema` is specified as a +simple URL to the JSON schema definition hosted on the Square CDN. For more information, see +[Specifying the schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema). + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attribute_definitions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a bookings custom attribute definition. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attribute_definitions.get( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute definition to retrieve. If the requesting application +is not the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute definition, which is used for strongly consistent +reads to guarantee that you receive the most up-to-date data. When included in the request, +Square returns the specified version or a higher version if one exists. If the specified version +is higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attribute_definitions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a bookings custom attribute definition. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to update. + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition that contains the fields to update. Only the following fields can be updated: +- `name` +- `description` +- `visibility` +- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed +selections are supported. + +For more information, see +[Updatable definition fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + +To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control, include the optional `version` field and specify the current version of the custom attribute definition. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attribute_definitions.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a bookings custom attribute definition. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attribute_definitions.delete( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Bookings CustomAttributes +
client.bookings.custom_attributes.batch_delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Bulk deletes bookings custom attributes. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attributes.batch_delete( + values={"key": {"booking_id": "booking_id", "key": "key"}}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[str, BookingCustomAttributeDeleteRequestParams]` + +A map containing 1 to 25 individual Delete requests. For each request, provide an +arbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the +information needed to delete a custom attribute. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attributes.batch_upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Bulk upserts bookings custom attributes. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attributes.batch_upsert( + values={"key": {"booking_id": "booking_id", "custom_attribute": {}}}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[str, BookingCustomAttributeUpsertRequestParams]` + +A map containing 1 to 25 individual upsert requests. For each request, provide an +arbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the +information needed to create or update a custom attribute. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attributes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists a booking's custom attributes. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.bookings.custom_attributes.list( + booking_id="booking_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the target [booking](entity:Booking). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. For more +information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**with_definitions:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each +custom attribute. Set this parameter to `true` to get the name and description of each custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attributes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a bookings custom attribute. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attributes.get( + booking_id="booking_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the target [booking](entity:Booking). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to retrieve. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**with_definition:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of +the custom attribute. Set this parameter to `true` to get the name and description of the custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute, which is used for strongly consistent reads to +guarantee that you receive the most up-to-date data. When included in the request, Square +returns the specified version or a higher version if one exists. If the specified version is +higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attributes.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Upserts a bookings custom attribute. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attributes.upsert( + booking_id="booking_id", + key="key", + custom_attribute={}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the target [booking](entity:Booking). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to create or update. This key must match the `key` of a +custom attribute definition in the Square seller account. If the requesting application is not +the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**custom_attribute:** `CustomAttributeParams` + +The custom attribute to create or update, with the following fields: + +- `value`. This value must conform to the `schema` specified by the definition. +For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + +- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control for an update operation, include this optional field and specify the current version +of the custom attribute. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.custom_attributes.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a bookings custom attribute. + +To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. +To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + +For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* +or *Appointments Premium*. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.custom_attributes.delete( + booking_id="booking_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**booking_id:** `str` — The ID of the target [booking](entity:Booking). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to delete. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Bookings LocationProfiles +
client.bookings.location_profiles.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists location booking profiles of a seller. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.bookings.location_profiles.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of results to return in a paged response. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Bookings TeamMemberProfiles +
client.bookings.team_member_profiles.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists booking profiles for team members. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.bookings.team_member_profiles.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**bookable_only:** `typing.Optional[bool]` — Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of results to return in a paged response. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` — Indicates whether to include only team members enabled at the given location in the returned result. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.bookings.team_member_profiles.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a team member's booking profile. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.bookings.team_member_profiles.get( + team_member_id="team_member_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_id:** `str` — The ID of the team member to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## CashDrawers Shifts +
client.cash_drawers.shifts.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides the details for all of the cash drawer shifts for a location +in a date range. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.cash_drawers.shifts.list( + location_id="location_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to query for a list of cash drawer shifts. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +The order in which cash drawer shifts are listed in the response, +based on their opened_at field. Default value: ASC + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` — The inclusive start time of the query on opened_at, in ISO 8601 format. + +
+
+ +
+
+ +**end_time:** `typing.Optional[str]` — The exclusive end date of the query on opened_at, in ISO 8601 format. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +Number of cash drawer shift events in a page of results (200 by +default, 1000 max). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — Opaque cursor for fetching the next page of results. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.cash_drawers.shifts.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides the summary details for a single cash drawer shift. See +[ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.cash_drawers.shifts.get( + shift_id="shift_id", + location_id="location_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**shift_id:** `str` — The shift ID. + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to retrieve cash drawer shifts from. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.cash_drawers.shifts.list_events(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Provides a paginated list of events for a single cash drawer shift. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.cash_drawers.shifts.list_events( + shift_id="shift_id", + location_id="location_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**shift_id:** `str` — The shift ID. + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to list cash drawer shifts for. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +Number of resources to be returned in a page of results (200 by +default, 1000 max). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — Opaque cursor for fetching the next page of results. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Catalog Images +
client.catalog.images.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing +[CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id` +is not specified. + +This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in +JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.images.create() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `typing.Optional[CreateCatalogImageRequestParams]` + +
+
+ +
+
+ +**image_file:** `from __future__ import annotations + +typing.Optional[core.File]` — See core.File for more documentation + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.images.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object. + +This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in +JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.images.update( + image_id="image_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**image_id:** `str` — The ID of the `CatalogImage` object to update the encapsulated image file. + +
+
+ +
+
+ +**request:** `typing.Optional[UpdateCatalogImageRequestParams]` + +
+
+ +
+
+ +**image_file:** `from __future__ import annotations + +typing.Optional[core.File]` — See core.File for more documentation + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Catalog Object +
client.catalog.object.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new or updates the specified [CatalogObject](entity:CatalogObject). + +To ensure consistency, only one update request is processed at a time per seller account. +While one (batch or non-batch) update request is being processed, other (batched and non-batched) +update requests are rejected with the `429` error code. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.object.upsert( + idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae", + object={"type": "ITEM", "id": "#Cocoa"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A value you specify that uniquely identifies this +request among all your requests. A common way to create +a valid idempotency key is to use a Universally unique +identifier (UUID). + +If you're unsure whether a particular request was successful, +you can reattempt it with the same idempotency key without +worrying about creating duplicate objects. + +See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + +
+
+ +
+
+ +**object:** `CatalogObjectParams` + +A CatalogObject to be created or updated. + +- For updates, the object must be active (the `is_deleted` field is not `true`). +- For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.object.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a single [CatalogItem](entity:CatalogItem) as a +[CatalogObject](entity:CatalogObject) based on the provided ID. The returned +object includes all of the relevant [CatalogItem](entity:CatalogItem) +information including: [CatalogItemVariation](entity:CatalogItemVariation) +children, references to its +[CatalogModifierList](entity:CatalogModifierList) objects, and the ids of +any [CatalogTax](entity:CatalogTax) objects that apply to it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.object.get( + object_id="object_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**object_id:** `str` — The object ID of any type of catalog objects to be retrieved. + +
+
+ +
+
+ +**include_related_objects:** `typing.Optional[bool]` + +If `true`, the response will include additional objects that are related to the +requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field +of the response. These objects are put in the `related_objects` field. Setting this to `true` is +helpful when the objects are needed for immediate display to a user. +This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + +if the `objects` field of the response contains a CatalogItem, its associated +CatalogCategory objects, CatalogTax objects, CatalogImage objects and +CatalogModifierLists will be returned in the `related_objects` field of the +response. If the `objects` field of the response contains a CatalogItemVariation, +its parent CatalogItem will be returned in the `related_objects` field of +the response. + +Default value: `false` + +
+
+ +
+
+ +**catalog_version:** `typing.Optional[int]` + +Requests objects as of a specific version of the catalog. This allows you to retrieve historical +versions of objects. The value to retrieve a specific version of an object can be found +in the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will +be from the current version of the catalog. + +
+
+ +
+
+ +**include_category_path_to_root:** `typing.Optional[bool]` + +Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists +of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category +and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned +in the response payload. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.catalog.object.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a single [CatalogObject](entity:CatalogObject) based on the +provided ID and returns the set of successfully deleted IDs in the response. +Deletion is a cascading event such that all children of the targeted object +are also deleted. For example, deleting a [CatalogItem](entity:CatalogItem) +will also delete all of its +[CatalogItemVariation](entity:CatalogItemVariation) children. + +To ensure consistency, only one delete request is processed at a time per seller account. +While one (batch or non-batch) delete request is being processed, other (batched and non-batched) +delete requests are rejected with the `429` error code. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.catalog.object.delete( + object_id="object_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**object_id:** `str` + +The ID of the catalog object to be deleted. When an object is deleted, other +objects in the graph that depend on that object will be deleted as well (for example, deleting a +catalog item will delete its catalog item variations). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Checkout PaymentLinks +
client.checkout.payment_links.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all payment links. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.checkout.payment_links.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +If a cursor is not provided, the endpoint returns the first page of the results. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +A limit on the number of results to return per page. The limit is advisory and +the implementation might return more or less results. If the supplied limit is negative, zero, or +greater than the maximum limit of 1000, it is ignored. + +Default value: `100` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.payment_links.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.payment_links.create( + idempotency_key="cd9e25dc-d9f2-4430-aedb-61605070e95f", + quick_pay={ + "name": "Auto Detailing", + "price_money": {"amount": 10000, "currency": "USD"}, + "location_id": "A9Y43N9ABXZBP", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique string that identifies this `CreatePaymentLinkRequest` request. +If you do not provide a unique string (or provide an empty string as the value), +the endpoint treats each request as independent. + +For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + +
+
+ +
+
+ +**description:** `typing.Optional[str]` + +A description of the payment link. You provide this optional description that is useful in your +application context. It is not used anywhere. + +
+
+ +
+
+ +**quick_pay:** `typing.Optional[QuickPayParams]` + +Describes an ad hoc item and price for which to generate a quick pay checkout link. +For more information, +see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + +
+
+ +
+
+ +**order:** `typing.Optional[OrderParams]` + +Describes the `Order` for which to create a checkout link. +For more information, +see [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). + +
+
+ +
+
+ +**checkout_options:** `typing.Optional[CheckoutOptionsParams]` + +Describes optional fields to add to the resulting checkout page. +For more information, +see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + +
+
+ +
+
+ +**pre_populated_data:** `typing.Optional[PrePopulatedDataParams]` + +Describes fields to prepopulate in the resulting checkout page. +For more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address). + +
+
+ +
+
+ +**payment_note:** `typing.Optional[str]` — A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.payment_links.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a payment link. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.payment_links.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The ID of link to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.payment_links.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a payment link. You can update the `payment_link` fields such as +`description`, `checkout_options`, and `pre_populated_data`. +You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.payment_links.update( + id="id", + payment_link={ + "version": 1, + "checkout_options": {"ask_for_shipping_address": True}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The ID of the payment link to update. + +
+
+ +
+
+ +**payment_link:** `PaymentLinkParams` + +The `payment_link` object describing the updates to apply. +For more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.checkout.payment_links.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a payment link. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.checkout.payment_links.delete( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The ID of the payment link to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Customers CustomAttributeDefinitions +
client.customers.custom_attribute_definitions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + +When all response pages are retrieved, the results include all custom attribute definitions +that are visible to the requesting application, including those that are created by other +applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that +seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.customers.custom_attribute_definitions.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attribute_definitions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. +Use this endpoint to define a custom attribute that can be associated with customer profiles. + +A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties +for a custom attribute. After the definition is created, you can call +[UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or +[BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) +to set the custom attribute for customer profiles in the seller's Customer Directory. + +Sellers can view all custom attributes in exported customer data, including those set to +`VISIBILITY_HIDDEN`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "favoritemovie", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Favorite Movie", + "description": "The favorite movie of the customer.", + "visibility": "VISIBILITY_HIDDEN", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition to create. Note the following: +- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema +definition hosted on the Square CDN. For more information, including supported values and constraints, see +[Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). +- If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. +- All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attribute_definitions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + +To retrieve a custom attribute definition created by another application, the `visibility` +setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attribute_definitions.get( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute definition to retrieve. If the requesting application +is not the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute definition, which is used for strongly consistent +reads to guarantee that you receive the most up-to-date data. When included in the request, +Square returns the specified version or a higher version if one exists. If the specified version +is higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attribute_definitions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + +Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the +`schema` for a `Selection` data type. + +Only the definition owner can update a custom attribute definition. Note that sellers can view +all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to update. + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition that contains the fields to update. This endpoint +supports sparse updates, so only new or changed fields need to be included in the request. +Only the following fields can be updated: + +- `name` +- `description` +- `visibility` +- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed +selections are supported. + +For more information, see +[Updatable definition fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + +To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control, include the optional `version` field and specify the current version of the custom attribute definition. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attribute_definitions.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + +Deleting a custom attribute definition also deletes the corresponding custom attribute from +all customer profiles in the seller's Customer Directory. + +Only the definition owner can delete a custom attribute definition. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attribute_definitions.delete( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attribute_definitions.batch_upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation. + +Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. +A custom attribute is based on a custom attribute definition in a Square seller account, which is +created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + +This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert +requests and returns a map of individual upsert responses. Each upsert request has a unique ID +and provides a customer ID and custom attribute. Each upsert response is returned with the ID +of the corresponding request. + +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attribute_definitions.batch_upsert( + values={ + "id1": { + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": {"key": "favoritemovie", "value": "Dune"}, + }, + "id2": { + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": {"key": "ownsmovie", "value": False}, + }, + "id3": { + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": {"key": "favoritemovie", "value": "Star Wars"}, + }, + "id4": { + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": { + "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808", + "value": "10.5", + }, + }, + "id5": { + "customer_id": "70548QG1HN43B05G0KCZ4MMC1G", + "custom_attribute": { + "key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail", + "value": "fake-email@squareup.com", + }, + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, + BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams, +]` + +A map containing 1 to 25 individual upsert requests. For each request, provide an +arbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the +information needed to create or update a custom attribute. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Customers Groups +
client.customers.groups.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the list of customer groups of a business. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.customers.groups.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for your original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. +If the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.groups.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new customer group for a business. + +The request must include the `name` value of the group. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.groups.create( + group={"name": "Loyal Customers"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**group:** `CustomerGroupParams` — The customer group to create. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.groups.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a specific customer group as identified by the `group_id` value. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.groups.get( + group_id="group_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**group_id:** `str` — The ID of the customer group to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.groups.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a customer group as identified by the `group_id` value. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.groups.update( + group_id="group_id", + group={"name": "Loyal Customers"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**group_id:** `str` — The ID of the customer group to update. + +
+
+ +
+
+ +**group:** `CustomerGroupParams` — The `CustomerGroup` object including all the updates you want to make. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.groups.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a customer group as identified by the `group_id` value. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.groups.delete( + group_id="group_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**group_id:** `str` — The ID of the customer group to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.groups.add(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Adds a group membership to a customer. + +The customer is identified by the `customer_id` value +and the customer group is identified by the `group_id` value. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.groups.add( + customer_id="customer_id", + group_id="group_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to add to a group. + +
+
+ +
+
+ +**group_id:** `str` — The ID of the customer group to add the customer to. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.groups.remove(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Removes a group membership from a customer. + +The customer is identified by the `customer_id` value +and the customer group is identified by the `group_id` value. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.groups.remove( + customer_id="customer_id", + group_id="group_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer to remove from the group. + +
+
+ +
+
+ +**group_id:** `str` — The ID of the customer group to remove the customer from. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Customers Segments +
client.customers.segments.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the list of customer segments of a business. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.customers.segments.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by previous calls to `ListCustomerSegments`. +This cursor is used to retrieve the next set of query results. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. +If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.segments.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a specific customer segment as identified by the `segment_id` value. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.segments.get( + segment_id="segment_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**segment_id:** `str` — The Square-issued ID of the customer segment. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Customers Cards +
client.customers.cards.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Adds a card on file to an existing customer. + +As with charges, calls to `CreateCustomerCard` are idempotent. Multiple +calls with the same card nonce return the same card record that was created +with the provided nonce during the _first_ call. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.cards.create( + customer_id="customer_id", + card_nonce="YOUR_CARD_NONCE", + billing_address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + cardholder_name="Amelia Earhart", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The Square ID of the customer profile the card is linked to. + +
+
+ +
+
+ +**card_nonce:** `str` + +A card nonce representing the credit card to link to the customer. + +Card nonces are generated by the Square payment form when customers enter +their card information. For more information, see +[Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment). + +__NOTE:__ Card nonces generated by digital wallets (such as Apple Pay) +cannot be used to create a customer card. + +
+
+ +
+
+ +**billing_address:** `typing.Optional[AddressParams]` + +Address information for the card on file. + +__NOTE:__ If a billing address is provided in the request, the +`CreateCustomerCardRequest.billing_address.postal_code` must match +the postal code encoded in the card nonce. + +
+
+ +
+
+ +**cardholder_name:** `typing.Optional[str]` — The full name printed on the credit card. + +
+
+ +
+
+ +**verification_token:** `typing.Optional[str]` + +An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). +Verification tokens encapsulate customer device information and 3-D Secure +challenge results to indicate that Square has verified the buyer identity. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.cards.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Removes a card on file from a customer. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.cards.delete( + customer_id="customer_id", + card_id="card_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the customer that the card on file belongs to. + +
+
+ +
+
+ +**card_id:** `str` — The ID of the card on file to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Customers CustomAttributes +
client.customers.custom_attributes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the [custom attributes](entity:CustomAttribute) associated with a customer profile. + +You can use the `with_definitions` query parameter to also retrieve custom attribute definitions +in the same call. + +When all response pages are retrieved, the results include all custom attributes that are +visible to the requesting application, including those that are owned by other applications +and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.customers.custom_attributes.list( + customer_id="customer_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the target [customer profile](entity:Customer). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. For more +information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**with_definitions:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each +custom attribute. Set this parameter to `true` to get the name and description of each custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attributes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile. + +You can use the `with_definition` query parameter to also retrieve the custom attribute definition +in the same call. + +To retrieve a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attributes.get( + customer_id="customer_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the target [customer profile](entity:Customer). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to retrieve. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**with_definition:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of +the custom attribute. Set this parameter to `true` to get the name and description of the custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute, which is used for strongly consistent reads to +guarantee that you receive the most up-to-date data. When included in the request, Square +returns the specified version or a higher version if one exists. If the specified version is +higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attributes.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile. + +Use this endpoint to set the value of a custom attribute for a specified customer profile. +A custom attribute is based on a custom attribute definition in a Square seller account, which +is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attributes.upsert( + customer_id="customer_id", + key="key", + custom_attribute={"value": "Dune"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the target [customer profile](entity:Customer). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to create or update. This key must match the `key` of a +custom attribute definition in the Square seller account. If the requesting application is not +the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**custom_attribute:** `CustomAttributeParams` + +The custom attribute to create or update, with the following fields: + +- `value`. This value must conform to the `schema` specified by the definition. +For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + +- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control for an update operation, include this optional field and specify the current version +of the custom attribute. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.customers.custom_attributes.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + +To delete a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.customers.custom_attributes.delete( + customer_id="customer_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customer_id:** `str` — The ID of the target [customer profile](entity:Customer). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to delete. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Devices Codes +
client.devices.codes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all DeviceCodes associated with the merchant. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.devices.codes.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for your original query. + +See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +If specified, only returns DeviceCodes of the specified location. +Returns DeviceCodes of all locations if empty. + +
+
+ +
+
+ +**product_type:** `typing.Optional[ProductType]` + +If specified, only returns DeviceCodes targeting the specified product type. +Returns DeviceCodes of all product types if empty. + +
+
+ +
+
+ +**status:** `typing.Optional[DeviceCodeStatus]` + +If specified, returns DeviceCodes with the specified statuses. +Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.devices.codes.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected +terminal mode. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.devices.codes.create( + idempotency_key="01bb00a6-0c86-4770-94ed-f5fca973cd56", + device_code={ + "name": "Counter 1", + "product_type": "TERMINAL_API", + "location_id": "B5E4484SHHNYH", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this CreateDeviceCode request. Keys can +be any valid string but must be unique for every CreateDeviceCode request. + +See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + +
+
+ +
+
+ +**device_code:** `DeviceCodeParams` — The device code to create. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.devices.codes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves DeviceCode with the associated ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.devices.codes.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The unique identifier for the device code. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Disputes Evidence +
client.disputes.evidence.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of evidence associated with a dispute. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.disputes.evidence.list( + dispute_id="dispute_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.evidence.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the metadata for the evidence specified in the request URL path. + +You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.evidence.get( + dispute_id="dispute_id", + evidence_id="evidence_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute from which you want to retrieve evidence metadata. + +
+
+ +
+
+ +**evidence_id:** `str` — The ID of the evidence to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.disputes.evidence.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Removes specified evidence from a dispute. +Square does not send the bank any evidence that is removed. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.disputes.evidence.delete( + dispute_id="dispute_id", + evidence_id="evidence_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dispute_id:** `str` — The ID of the dispute from which you want to remove evidence. + +
+
+ +
+
+ +**evidence_id:** `str` — The ID of the evidence you want to remove. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## GiftCards Activities +
client.gift_cards.activities.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists gift card activities. By default, you get gift card activities for all +gift cards in the seller's account. You can optionally specify query parameters to +filter the list. For example, you can get a list of gift card activities for a gift card, +for all gift cards in a specific region, or for activities within a time window. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.gift_cards.activities.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**gift_card_id:** `typing.Optional[str]` + +If a gift card ID is provided, the endpoint returns activities related +to the specified gift card. Otherwise, the endpoint returns all gift card activities for +the seller. + +
+
+ +
+
+ +**type:** `typing.Optional[str]` + +If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. +Otherwise, the endpoint returns all types of gift card activities. + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +If a location ID is provided, the endpoint returns gift card activities for the specified location. +Otherwise, the endpoint returns gift card activities for all locations. + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` + +The timestamp for the beginning of the reporting period, in RFC 3339 format. +This start time is inclusive. The default value is the current time minus one year. + +
+
+ +
+
+ +**end_time:** `typing.Optional[str]` + +The timestamp for the end of the reporting period, in RFC 3339 format. +This end time is inclusive. The default value is the current time. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +If a limit is provided, the endpoint returns the specified number +of results (or fewer) per page. The maximum value is 100. The default value is 50. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +If a cursor is not provided, the endpoint returns the first page of the results. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**sort_order:** `typing.Optional[str]` + +The order in which the endpoint returns the activities, based on `created_at`. +- `ASC` - Oldest to newest. +- `DESC` - Newest to oldest (default). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.gift_cards.activities.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard). +For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.gift_cards.activities.create( + idempotency_key="U16kfr-kA70er-q4Rsym-7U7NnY", + gift_card_activity={ + "type": "ACTIVATE", + "location_id": "81FN9BNFZTKS4", + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "activate_activity_details": { + "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY", + "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` — A unique string that identifies the `CreateGiftCardActivity` request. + +
+
+ +
+
+ +**gift_card_activity:** `GiftCardActivityParams` + +The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target +gift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Labor BreakTypes +
client.labor.break_types.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of `BreakType` instances for a business. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.labor.break_types.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `typing.Optional[str]` + +Filter the returned `BreakType` results to only those that are associated with the +specified location. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of `BreakType` results to return per page. The number can range between 1 +and 200. The default is 200. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — A pointer to the next page of `BreakType` results to fetch. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.break_types.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new `BreakType`. + +A `BreakType` is a template for creating `Break` objects. +You must provide the following values in your request to this +endpoint: + +- `location_id` +- `break_name` +- `expected_duration` +- `is_paid` + +You can only have three `BreakType` instances per location. If you attempt to add a fourth +`BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location." +is returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.break_types.create( + idempotency_key="PAD3NG5KSN2GL", + break_type={ + "location_id": "CGJN03P1D08GF", + "break_name": "Lunch Break", + "expected_duration": "PT30M", + "is_paid": True, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**break_type:** `BreakTypeParams` — The `BreakType` to be created. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique string value to ensure the idempotency of the operation. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.break_types.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a single `BreakType` specified by `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.break_types.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `BreakType` being retrieved. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.break_types.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates an existing `BreakType`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.break_types.update( + id="id", + break_type={ + "location_id": "26M7H24AZ9N6R", + "break_name": "Lunch", + "expected_duration": "PT50M", + "is_paid": True, + "version": 1, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `BreakType` being updated. + +
+
+ +
+
+ +**break_type:** `BreakTypeParams` — The updated `BreakType`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.break_types.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes an existing `BreakType`. + +A `BreakType` can be deleted even if it is referenced from a `Shift`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.break_types.delete( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `BreakType` being deleted. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Labor EmployeeWages +
client.labor.employee_wages.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of `EmployeeWage` instances for a business. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.labor.employee_wages.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**employee_id:** `typing.Optional[str]` — Filter the returned wages to only those that are associated with the specified employee. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of `EmployeeWage` results to return per page. The number can range between +1 and 200. The default is 200. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — A pointer to the next page of `EmployeeWage` results to fetch. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.employee_wages.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a single `EmployeeWage` specified by `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.employee_wages.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `EmployeeWage` being retrieved. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Labor Shifts +
client.labor.shifts.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a new `Shift`. + +A `Shift` represents a complete workday for a single team member. +You must provide the following values in your request to this +endpoint: + +- `location_id` +- `team_member_id` +- `start_at` + +An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: +- The `status` of the new `Shift` is `OPEN` and the team member has another +shift with an `OPEN` status. +- The `start_at` date is in the future. +- The `start_at` or `end_at` date overlaps another shift for the same team member. +- The `Break` instances are set in the request and a break `start_at` +is before the `Shift.start_at`, a break `end_at` is after +the `Shift.end_at`, or both. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.shifts.create( + idempotency_key="HIDSNG5KS478L", + shift={ + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "end_at": "2019-01-25T13:11:00-05:00", + "wage": { + "title": "Barista", + "hourly_rate": {"amount": 1100, "currency": "USD"}, + "tip_eligible": True, + }, + "breaks": [ + { + "start_at": "2019-01-25T06:11:00-05:00", + "end_at": "2019-01-25T06:16:00-05:00", + "break_type_id": "REGS1EQR1TPZ5", + "name": "Tea Break", + "expected_duration": "PT5M", + "is_paid": True, + } + ], + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**shift:** `ShiftParams` — The `Shift` to be created. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique string value to ensure the idempotency of the operation. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.shifts.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of `Shift` records for a business. +The list to be returned can be filtered by: +- Location IDs +- Team member IDs +- Shift status (`OPEN` or `CLOSED`) +- Shift start +- Shift end +- Workday details + +The list can be sorted by: +- `START_AT` +- `END_AT` +- `CREATED_AT` +- `UPDATED_AT` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.shifts.search( + query={ + "filter": { + "workday": { + "date_range": { + "start_date": "2019-01-20", + "end_date": "2019-02-03", + }, + "match_shifts_by": "START_AT", + "default_timezone": "America/Los_Angeles", + } + } + }, + limit=100, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[ShiftQueryParams]` — Query filters. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The number of resources in a page (200 by default). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — An opaque cursor for fetching the next page. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.shifts.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a single `Shift` specified by `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.shifts.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `Shift` being retrieved. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.shifts.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates an existing `Shift`. + +When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have +the `end_at` property set to a valid RFC-3339 datetime string. + +When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at` +set on each `Break`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.shifts.update( + id="id", + shift={ + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "end_at": "2019-01-25T13:11:00-05:00", + "wage": { + "title": "Bartender", + "hourly_rate": {"amount": 1500, "currency": "USD"}, + "tip_eligible": True, + }, + "breaks": [ + { + "id": "X7GAQYVVRRG6P", + "start_at": "2019-01-25T06:11:00-05:00", + "end_at": "2019-01-25T06:16:00-05:00", + "break_type_id": "REGS1EQR1TPZ5", + "name": "Tea Break", + "expected_duration": "PT5M", + "is_paid": True, + } + ], + "version": 1, + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The ID of the object being updated. + +
+
+ +
+
+ +**shift:** `ShiftParams` — The updated `Shift` object. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.shifts.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a `Shift`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.shifts.delete( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `Shift` being deleted. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Labor TeamMemberWages +
client.labor.team_member_wages.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of `TeamMemberWage` instances for a business. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.labor.team_member_wages.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_id:** `typing.Optional[str]` + +Filter the returned wages to only those that are associated with the +specified team member. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of `TeamMemberWage` results to return per page. The number can range between +1 and 200. The default is 200. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — A pointer to the next page of `EmployeeWage` results to fetch. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.team_member_wages.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a single `TeamMemberWage` specified by `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.team_member_wages.get( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `TeamMemberWage` being retrieved. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Labor WorkweekConfigs +
client.labor.workweek_configs.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `WorkweekConfig` instances for a business. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.labor.workweek_configs.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of `WorkweekConfigs` results to return per page. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — A pointer to the next page of `WorkweekConfig` results to fetch. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.labor.workweek_configs.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a `WorkweekConfig`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.labor.workweek_configs.get( + id="id", + workweek_config={ + "start_of_week": "MON", + "start_of_day_local_time": "10:00", + "version": 10, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` — The UUID for the `WorkweekConfig` object being updated. + +
+
+ +
+
+ +**workweek_config:** `WorkweekConfigParams` — The updated `WorkweekConfig` object. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Locations CustomAttributeDefinitions +
client.locations.custom_attribute_definitions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the location-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. +When all response pages are retrieved, the results include all custom attribute definitions +that are visible to the requesting application, including those that are created by other +applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.locations.custom_attribute_definitions.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**visibility_filter:** `typing.Optional[VisibilityFilter]` — Filters the `CustomAttributeDefinition` results by their `visibility` values. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attribute_definitions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. +Use this endpoint to define a custom attribute that can be associated with locations. +A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties +for a custom attribute. After the definition is created, you can call +[UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or +[BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) +to set the custom attribute for locations. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "bestseller", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Bestseller", + "description": "Bestselling item at location", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition to create. Note the following: +- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema +definition hosted on the Square CDN. For more information, including supported values and constraints, see +[Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). +- `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attribute_definitions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. +To retrieve a custom attribute definition created by another application, the `visibility` +setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attribute_definitions.get( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute definition to retrieve. If the requesting application +is not the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute definition, which is used for strongly consistent +reads to guarantee that you receive the most up-to-date data. When included in the request, +Square returns the specified version or a higher version if one exists. If the specified version +is higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attribute_definitions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. +Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the +`schema` for a `Selection` data type. +Only the definition owner can update a custom attribute definition. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to update. + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition that contains the fields to update. This endpoint +supports sparse updates, so only new or changed fields need to be included in the request. +Only the following fields can be updated: +- `name` +- `description` +- `visibility` +- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed +selections are supported. + +For more information, see +[Update a location custom attribute definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). +To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control, specify the current version of the custom attribute definition. +If this is not important for your application, `version` can be set to -1. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attribute_definitions.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. +Deleting a custom attribute definition also deletes the corresponding custom attribute from +all locations. +Only the definition owner can delete a custom attribute definition. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attribute_definitions.delete( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Locations CustomAttributes +
client.locations.custom_attributes.batch_delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation. +To delete a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attributes.batch_delete( + values={ + "id1": {"key": "bestseller"}, + "id2": {"key": "bestseller"}, + "id3": {"key": "phone-number"}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, + BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams, +]` + +The data used to update the `CustomAttribute` objects. +The keys must be unique and are used to map to the corresponding response. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attributes.batch_upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation. +Use this endpoint to set the value of one or more custom attributes for one or more locations. +A custom attribute is based on a custom attribute definition in a Square seller account, which is +created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. +This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert +requests and returns a map of individual upsert responses. Each upsert request has a unique ID +and provides a location ID and custom attribute. Each upsert response is returned with the ID +of the corresponding request. +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attributes.batch_upsert( + values={ + "id1": { + "location_id": "L0TBCBTB7P8RQ", + "custom_attribute": {"key": "bestseller", "value": "hot cocoa"}, + }, + "id2": { + "location_id": "L9XMD04V3STJX", + "custom_attribute": { + "key": "bestseller", + "value": "berry smoothie", + }, + }, + "id3": { + "location_id": "L0TBCBTB7P8RQ", + "custom_attribute": { + "key": "phone-number", + "value": "+12223334444", + }, + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, + BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams, +]` + +A map containing 1 to 25 individual upsert requests. For each request, provide an +arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the +information needed to create or update a custom attribute. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attributes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the [custom attributes](entity:CustomAttribute) associated with a location. +You can use the `with_definitions` query parameter to also retrieve custom attribute definitions +in the same call. +When all response pages are retrieved, the results include all custom attributes that are +visible to the requesting application, including those that are owned by other applications +and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.locations.custom_attributes.list( + location_id="location_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the target [location](entity:Location). + +
+
+ +
+
+ +**visibility_filter:** `typing.Optional[VisibilityFilter]` — Filters the `CustomAttributeDefinition` results by their `visibility` values. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. For more +information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**with_definitions:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each +custom attribute. Set this parameter to `true` to get the name and description of each custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attributes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a [custom attribute](entity:CustomAttribute) associated with a location. +You can use the `with_definition` query parameter to also retrieve the custom attribute definition +in the same call. +To retrieve a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attributes.get( + location_id="location_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the target [location](entity:Location). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to retrieve. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**with_definition:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of +the custom attribute. Set this parameter to `true` to get the name and description of the custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute, which is used for strongly consistent reads to +guarantee that you receive the most up-to-date data. When included in the request, Square +returns the specified version or a higher version if one exists. If the specified version is +higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attributes.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates a [custom attribute](entity:CustomAttribute) for a location. +Use this endpoint to set the value of a custom attribute for a specified location. +A custom attribute is based on a custom attribute definition in a Square seller account, which +is created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attributes.upsert( + location_id="location_id", + key="key", + custom_attribute={"value": "hot cocoa"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the target [location](entity:Location). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to create or update. This key must match the `key` of a +custom attribute definition in the Square seller account. If the requesting application is not +the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**custom_attribute:** `CustomAttributeParams` + +The custom attribute to create or update, with the following fields: +- `value`. This value must conform to the `schema` specified by the definition. +For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). +- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control for an update operation, include the current version of the custom attribute. +If this is not important for your application, version can be set to -1. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.custom_attributes.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a [custom attribute](entity:CustomAttribute) associated with a location. +To delete a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.custom_attributes.delete( + location_id="location_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the target [location](entity:Location). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to delete. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Locations Transactions +
client.locations.transactions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists transactions for a particular location. + +Transactions include payment information from sales and exchanges and refund +information from returns and exchanges. + +Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50 +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.transactions.list( + location_id="location_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the location to list transactions for. + +
+
+ +
+
+ +**begin_time:** `typing.Optional[str]` + +The beginning of the requested reporting period, in RFC 3339 format. + +See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + +Default value: The current time minus one year. + +
+
+ +
+
+ +**end_time:** `typing.Optional[str]` + +The end of the requested reporting period, in RFC 3339 format. + +See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + +Default value: The current time. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +The order in which results are listed in the response (`ASC` for +oldest first, `DESC` for newest first). + +Default value: `DESC` + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for your original query. + +See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.transactions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves details for a single transaction. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.transactions.get( + location_id="location_id", + transaction_id="transaction_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — The ID of the transaction's associated location. + +
+
+ +
+
+ +**transaction_id:** `str` — The ID of the transaction to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.transactions.capture(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) +endpoint with a `delay_capture` value of `true`. + + +See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) +for more information. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.transactions.capture( + location_id="location_id", + transaction_id="transaction_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — + +
+
+ +
+
+ +**transaction_id:** `str` — + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.locations.transactions.void(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) +endpoint with a `delay_capture` value of `true`. + + +See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) +for more information. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.locations.transactions.void( + location_id="location_id", + transaction_id="transaction_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**location_id:** `str` — + +
+
+ +
+
+ +**transaction_id:** `str` — + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Loyalty Accounts +
client.loyalty.accounts.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.accounts.create( + loyalty_account={ + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "mapping": {"phone_number": "+14155551234"}, + }, + idempotency_key="ec78c477-b1c3-4899-a209-a4e71337c996", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**loyalty_account:** `LoyaltyAccountParams` — The loyalty account to create. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `CreateLoyaltyAccount` request. +Keys can be any valid string, but must be unique for every request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.accounts.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for loyalty accounts in a loyalty program. + +You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. + +Search results are sorted by `created_at` in ascending order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.accounts.search( + query={"mappings": [{"phone_number": "+14155551234"}]}, + limit=10, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams]` — The search criteria for the request. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of results to include in the response. The default value is 30. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to +this endpoint. Provide this to retrieve the next set of +results for the original query. + +For more information, +see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.accounts.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a loyalty account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.accounts.get( + account_id="account_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**account_id:** `str` — The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.accounts.accumulate_points(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount). + +- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order +to compute the points earned from both the base loyalty program and an associated +[loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual +rules, Square computes points based on the accrual rule that grants the most points. +For purchases that qualify for multiple promotions, Square computes points based on the most +recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. + +- If you are not using the Orders API to manage orders, provide `points` with the number of points to add. +You must first perform a client-side computation of the points earned from the loyalty program and +loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) +to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see +[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.accounts.accumulate_points( + account_id="account_id", + accumulate_points={"order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY"}, + idempotency_key="58b90739-c3e8-4b11-85f7-e636d48d72cb", + location_id="P034NEENMD09F", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**account_id:** `str` — The ID of the target [loyalty account](entity:LoyaltyAccount). + +
+
+ +
+
+ +**accumulate_points:** `LoyaltyEventAccumulatePointsParams` + +The points to add to the account. +If you are using the Orders API to manage orders, specify the order ID. +Otherwise, specify the points to add. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies the `AccumulateLoyaltyPoints` request. +Keys can be any valid string but must be unique for every request. + +
+
+ +
+
+ +**location_id:** `str` — The [location](entity:Location) where the purchase was made. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.accounts.adjust(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Adds points to or subtracts points from a buyer's account. + +Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call +[AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) +to add points when a buyer pays for the purchase. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.accounts.adjust( + account_id="account_id", + idempotency_key="bc29a517-3dc9-450e-aa76-fae39ee849d1", + adjust_points={"points": 10, "reason": "Complimentary points"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**account_id:** `str` — The ID of the target [loyalty account](entity:LoyaltyAccount). + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `AdjustLoyaltyPoints` request. +Keys can be any valid string, but must be unique for every request. + +
+
+ +
+
+ +**adjust_points:** `LoyaltyEventAdjustPointsParams` + +The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. +To subtract points, specify a negative integer. + +
+
+ +
+
+ +**allow_negative_balance:** `typing.Optional[bool]` + +Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative +balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting +the specified number of points would result in a negative balance. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Loyalty Programs +
client.loyalty.programs.list() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of loyalty programs in the seller's account. +Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + +Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.programs.list() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.programs.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. + +Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.programs.get( + program_id="program_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**program_id:** `str` — The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.programs.calculate(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint +to display the points to the buyer. + +- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. +Square reads the order to compute the points earned from the base loyalty program and an associated +[loyalty promotion](entity:LoyaltyPromotion). + +- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the +purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, +but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` +setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. +If the purchase qualifies for program points, call +[ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation +to calculate whether the purchase also qualifies for promotion points. For more information, see +[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.programs.calculate( + program_id="program_id", + order_id="RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + loyalty_account_id="79b807d2-d786-46a9-933b-918028d7a8c5", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**program_id:** `str` — The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points. + +
+
+ +
+
+ +**order_id:** `typing.Optional[str]` + +The [order](entity:Order) ID for which to calculate the points. +Specify this field if your application uses the Orders API to process orders. +Otherwise, specify the `transaction_amount_money`. + +
+
+ +
+
+ +**transaction_amount_money:** `typing.Optional[MoneyParams]` + +The purchase amount for which to calculate the points. +Specify this field if your application does not use the Orders API to process orders. +Otherwise, specify the `order_id`. + +
+
+ +
+
+ +**loyalty_account_id:** `typing.Optional[str]` + +The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field +if your application uses the Orders API to process orders. + +If specified, the `promotion_points` field in the response shows the number of points the buyer would +earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's +`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. +If not specified, the `promotion_points` field shows the number of points the purchase qualifies +for regardless of the trigger limit. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Loyalty Rewards +
client.loyalty.rewards.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a loyalty reward. In the process, the endpoint does following: + +- Uses the `reward_tier_id` in the request to determine the number of points +to lock for this reward. +- If the request includes `order_id`, it adds the reward and related discount to the order. + +After a reward is created, the points are locked and +not available for the buyer to redeem another reward. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.rewards.create( + reward={ + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + }, + idempotency_key="18c2e5ea-a620-4b1f-ad60-7b167285e451", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**reward:** `LoyaltyRewardParams` — The reward to create. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `CreateLoyaltyReward` request. +Keys can be any valid string, but must be unique for every request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.rewards.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. +If you include a `query` object, `loyalty_account_id` is required and `status` is optional. + +If you know a reward ID, use the +[RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint. + +Search results are sorted by `updated_at` in descending order. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.rewards.search( + query={"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd"}, + limit=10, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams]` + +The search criteria for the request. +If empty, the endpoint retrieves all loyalty rewards in the loyalty program. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — The maximum number of results to return in the response. The default value is 30. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to +this endpoint. Provide this to retrieve the next set of +results for the original query. +For more information, +see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.rewards.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a loyalty reward. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.rewards.get( + reward_id="reward_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**reward_id:** `str` — The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.rewards.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a loyalty reward by doing the following: + +- Returns the loyalty points back to the loyalty account. +- If an order ID was specified when the reward was created +(see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)), +it updates the order by removing the reward and related +discounts. + +You cannot delete a reward that has reached the terminal state (REDEEMED). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.rewards.delete( + reward_id="reward_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**reward_id:** `str` — The ID of the [loyalty reward](entity:LoyaltyReward) to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.rewards.redeem(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Redeems a loyalty reward. + +The endpoint sets the reward to the `REDEEMED` terminal state. + +If you are using your own order processing system (not using the +Orders API), you call this endpoint after the buyer paid for the +purchase. + +After the reward reaches the terminal state, it cannot be deleted. +In other words, points used for the reward cannot be returned +to the account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.rewards.redeem( + reward_id="reward_id", + idempotency_key="98adc7f7-6963-473b-b29c-f3c9cdd7d994", + location_id="P034NEENMD09F", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**reward_id:** `str` — The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `RedeemLoyaltyReward` request. +Keys can be any valid string, but must be unique for every request. + +
+
+ +
+
+ +**location_id:** `str` — The ID of the [location](entity:Location) where the reward is redeemed. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Loyalty Programs Promotions +
client.loyalty.programs.promotions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the loyalty promotions associated with a [loyalty program](entity:LoyaltyProgram). +Results are sorted by the `created_at` date in descending order (newest to oldest). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.loyalty.programs.promotions.list( + program_id="program_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**program_id:** `str` + +The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, +call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + +
+
+ +
+
+ +**status:** `typing.Optional[LoyaltyPromotionStatus]` + +The status to filter the results by. If a status is provided, only loyalty promotions +with the specified status are returned. Otherwise, all loyalty promotions associated with +the loyalty program are returned. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. +The minimum value is 1 and the maximum value is 30. The default value is 30. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.programs.promotions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion +enables buyers to earn points in addition to those earned from the base loyalty program. + +This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the +`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an +`ACTIVE` or `SCHEDULED` status. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.programs.promotions.create( + program_id="program_id", + loyalty_promotion={ + "name": "Tuesday Happy Hour Promo", + "incentive": { + "type": "POINTS_MULTIPLIER", + "points_multiplier_data": {"multiplier": "3.0"}, + }, + "available_time": { + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "trigger_limit": {"times": 1, "interval": "DAY"}, + "minimum_spend_amount_money": {"amount": 2000, "currency": "USD"}, + "qualifying_category_ids": ["XTQPYLR3IIU9C44VRCB3XD12"], + }, + idempotency_key="ec78c477-b1c3-4899-a209-a4e71337c996", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**program_id:** `str` + +The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. +To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) +using the `main` keyword. + +
+
+ +
+
+ +**loyalty_promotion:** `LoyaltyPromotionParams` — The loyalty promotion to create. + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique identifier for this request, which is used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.programs.promotions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a loyalty promotion. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.programs.promotions.get( + promotion_id="promotion_id", + program_id="program_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**promotion_id:** `str` — The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. + +
+
+ +
+
+ +**program_id:** `str` + +The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, +call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.loyalty.programs.promotions.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the +end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. +Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before +you create a new one. + +This endpoint sets the loyalty promotion to the `CANCELED` state +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.loyalty.programs.promotions.cancel( + promotion_id="promotion_id", + program_id="program_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**promotion_id:** `str` + +The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a +promotion that has an `ACTIVE` or `SCHEDULED` status. + +
+
+ +
+
+ +**program_id:** `str` — The ID of the base [loyalty program](entity:LoyaltyProgram). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Merchants CustomAttributeDefinitions +
client.merchants.custom_attribute_definitions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the merchant-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. +When all response pages are retrieved, the results include all custom attribute definitions +that are visible to the requesting application, including those that are created by other +applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.merchants.custom_attribute_definitions.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**visibility_filter:** `typing.Optional[VisibilityFilter]` — Filters the `CustomAttributeDefinition` results by their `visibility` values. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attribute_definitions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. +Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. +A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties +for a custom attribute. After the definition is created, you can call +[UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) or +[BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) +to set the custom attribute for a merchant. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "alternative_seller_name", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Alternative Merchant Name", + "description": "This is the other name this merchant goes by.", + "visibility": "VISIBILITY_READ_ONLY", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition to create. Note the following: +- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema +definition hosted on the Square CDN. For more information, including supported values and constraints, see +[Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). +- `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attribute_definitions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. +To retrieve a custom attribute definition created by another application, the `visibility` +setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attribute_definitions.get( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute definition to retrieve. If the requesting application +is not the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute definition, which is used for strongly consistent +reads to guarantee that you receive the most up-to-date data. When included in the request, +Square returns the specified version or a higher version if one exists. If the specified version +is higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attribute_definitions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. +Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the +`schema` for a `Selection` data type. +Only the definition owner can update a custom attribute definition. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to update. + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition that contains the fields to update. This endpoint +supports sparse updates, so only new or changed fields need to be included in the request. +Only the following fields can be updated: +- `name` +- `description` +- `visibility` +- `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed +selections are supported. +For more information, see +[Update a merchant custom attribute definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). +The version field must match the current version of the custom attribute definition to enable +[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attribute_definitions.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. +Deleting a custom attribute definition also deletes the corresponding custom attribute from +the merchant. +Only the definition owner can delete a custom attribute definition. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attribute_definitions.delete( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Merchants CustomAttributes +
client.merchants.custom_attributes.batch_delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. +To delete a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attributes.batch_delete( + values={ + "id1": {"key": "alternative_seller_name"}, + "id2": {"key": "has_seen_tutorial"}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, + BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams, +]` + +The data used to update the `CustomAttribute` objects. +The keys must be unique and are used to map to the corresponding response. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attributes.batch_upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. +Use this endpoint to set the value of one or more custom attributes for a merchant. +A custom attribute is based on a custom attribute definition in a Square seller account, which is +created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. +This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert +requests and returns a map of individual upsert responses. Each upsert request has a unique ID +and provides a merchant ID and custom attribute. Each upsert response is returned with the ID +of the corresponding request. +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attributes.batch_upsert( + values={ + "id1": { + "merchant_id": "DM7VKY8Q63GNP", + "custom_attribute": { + "key": "alternative_seller_name", + "value": "Ultimate Sneaker Store", + }, + }, + "id2": { + "merchant_id": "DM7VKY8Q63GNP", + "custom_attribute": {"key": "has_seen_tutorial", "value": True}, + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, + BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams, +]` + +A map containing 1 to 25 individual upsert requests. For each request, provide an +arbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the +information needed to create or update a custom attribute. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attributes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the [custom attributes](entity:CustomAttribute) associated with a merchant. +You can use the `with_definitions` query parameter to also retrieve custom attribute definitions +in the same call. +When all response pages are retrieved, the results include all custom attributes that are +visible to the requesting application, including those that are owned by other applications +and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.merchants.custom_attributes.list( + merchant_id="merchant_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**merchant_id:** `str` — The ID of the target [merchant](entity:Merchant). + +
+
+ +
+
+ +**visibility_filter:** `typing.Optional[VisibilityFilter]` — Filters the `CustomAttributeDefinition` results by their `visibility` values. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. For more +information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**with_definitions:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each +custom attribute. Set this parameter to `true` to get the name and description of each custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attributes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant. +You can use the `with_definition` query parameter to also retrieve the custom attribute definition +in the same call. +To retrieve a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attributes.get( + merchant_id="merchant_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**merchant_id:** `str` — The ID of the target [merchant](entity:Merchant). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to retrieve. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**with_definition:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of +the custom attribute. Set this parameter to `true` to get the name and description of the custom +attribute, information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +The current version of the custom attribute, which is used for strongly consistent reads to +guarantee that you receive the most up-to-date data. When included in the request, Square +returns the specified version or a higher version if one exists. If the specified version is +higher than the current version, Square returns a `BAD_REQUEST` error. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attributes.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant. +Use this endpoint to set the value of a custom attribute for a specified merchant. +A custom attribute is based on a custom attribute definition in a Square seller account, which +is created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attributes.upsert( + merchant_id="merchant_id", + key="key", + custom_attribute={"value": "Ultimate Sneaker Store"}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**merchant_id:** `str` — The ID of the target [merchant](entity:Merchant). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to create or update. This key must match the `key` of a +custom attribute definition in the Square seller account. If the requesting application is not +the definition owner, you must use the qualified key. + +
+
+ +
+
+ +**custom_attribute:** `CustomAttributeParams` + +The custom attribute to create or update, with the following fields: +- `value`. This value must conform to the `schema` specified by the definition. +For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). +- The version field must match the current version of the custom attribute definition to enable +[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. For more information, +see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.merchants.custom_attributes.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant. +To delete a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.merchants.custom_attributes.delete( + merchant_id="merchant_id", + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**merchant_id:** `str` — The ID of the target [merchant](entity:Merchant). + +
+
+ +
+
+ +**key:** `str` + +The key of the custom attribute to delete. This key must match the `key` of a custom +attribute definition in the Square seller account. If the requesting application is not the +definition owner, you must use the qualified key. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Orders CustomAttributeDefinitions +
client.orders.custom_attribute_definitions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the order-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + +When all response pages are retrieved, the results include all custom attribute definitions +that are visible to the requesting application, including those that are created by other +applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that +seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.orders.custom_attribute_definitions.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**visibility_filter:** `typing.Optional[VisibilityFilter]` — Requests that all of the custom attributes be returned, or only those that are read-only or read-write. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attribute_definitions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates an order-related custom attribute definition. Use this endpoint to +define a custom attribute that can be associated with orders. + +After creating a custom attribute definition, you can set the custom attribute for orders +in the Square seller account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "cover-count", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "name": "Cover count", + "description": "The number of people seated at a table", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + }, + idempotency_key="IDEMPOTENCY_KEY", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition to create. Note the following: +- With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema +definition hosted on the Square CDN. For more information, including supported values and constraints, see +[Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). +- If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. +- All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attribute_definitions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + +To retrieve a custom attribute definition created by another application, the `visibility` +setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attribute_definitions.get( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to retrieve. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control, include this optional field and specify the current version of the custom attribute. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attribute_definitions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates an order-related custom attribute definition for a Square seller account. + +Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "key": "cover-count", + "visibility": "VISIBILITY_READ_ONLY", + "version": 1, + }, + idempotency_key="IDEMPOTENCY_KEY", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to update. + +
+
+ +
+
+ +**custom_attribute_definition:** `CustomAttributeDefinitionParams` + +The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, +so only new or changed fields need to be included in the request. For more information, see +[Updatable definition fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + +To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include the optional `version` field and specify the current version of the custom attribute definition. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attribute_definitions.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + +Only the definition owner can delete a custom attribute definition. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attribute_definitions.delete( + key="key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**key:** `str` — The key of the custom attribute definition to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Orders CustomAttributes +
client.orders.custom_attributes.batch_delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation. + +Use this endpoint to delete one or more custom attributes from one or more orders. +A custom attribute is based on a custom attribute definition in a Square seller account. (To create a +custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + +This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete +requests and returns a map of individual delete responses. Each delete request has a unique ID +and provides an order ID and custom attribute. Each delete response is returned with the ID +of the corresponding request. + +To delete a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attributes.batch_delete( + values={ + "cover-count": { + "key": "cover-count", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + "table-number": { + "key": "table-number", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams +]` — A map of requests that correspond to individual delete operations for custom attributes. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attributes.batch_upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation. + +Use this endpoint to delete one or more custom attributes from one or more orders. +A custom attribute is based on a custom attribute definition in a Square seller account. (To create a +custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + +This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert +requests and returns a map of individual upsert responses. Each upsert request has a unique ID +and provides an order ID and custom attribute. Each upsert response is returned with the ID +of the corresponding request. + +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attributes.batch_upsert( + values={ + "cover-count": { + "custom_attribute": { + "key": "cover-count", + "value": "6", + "version": 2, + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + "table-number": { + "custom_attribute": { + "key": "table-number", + "value": "11", + "version": 4, + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**values:** `typing.Dict[ + str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams +]` — A map of requests that correspond to individual upsert operations for custom attributes. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attributes.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists the [custom attributes](entity:CustomAttribute) associated with an order. + +You can use the `with_definitions` query parameter to also retrieve custom attribute definitions +in the same call. + +When all response pages are retrieved, the results include all custom attributes that are +visible to the requesting application, including those that are owned by other applications +and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.orders.custom_attributes.list( + order_id="order_id", +) +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the target [order](entity:Order). + +
+
+ +
+
+ +**visibility_filter:** `typing.Optional[VisibilityFilter]` — Requests that all of the custom attributes be returned, or only those that are read-only or read-write. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +The cursor returned in the paged response from the previous call to this endpoint. +Provide this cursor to retrieve the next page of results for your original request. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to return in a single paged response. This limit is advisory. +The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. +The default value is 20. +For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + +
+
+ +
+
+ +**with_definitions:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each +custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, +information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attributes.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a [custom attribute](entity:CustomAttribute) associated with an order. + +You can use the `with_definition` query parameter to also retrieve the custom attribute definition +in the same call. + +To retrieve a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attributes.get( + order_id="order_id", + custom_attribute_key="custom_attribute_key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the target [order](entity:Order). + +
+
+ +
+
+ +**custom_attribute_key:** `str` + +The key of the custom attribute to retrieve. This key must match the key of an +existing custom attribute definition. + +
+
+ +
+
+ +**version:** `typing.Optional[int]` + +To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control, include this optional field and specify the current version of the custom attribute. + +
+
+ +
+
+ +**with_definition:** `typing.Optional[bool]` + +Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each +custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, +information about the data type, or other definition details. The default value is `false`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attributes.upsert(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates a [custom attribute](entity:CustomAttribute) for an order. + +Use this endpoint to set the value of a custom attribute for a specific order. +A custom attribute is based on a custom attribute definition in a Square seller account. (To create a +custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + +To create or update a custom attribute owned by another application, the `visibility` setting +must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attributes.upsert( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + custom_attribute={"key": "table-number", "value": "42", "version": 1}, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the target [order](entity:Order). + +
+
+ +
+
+ +**custom_attribute_key:** `str` + +The key of the custom attribute to create or update. This key must match the key +of an existing custom attribute definition. + +
+
+ +
+
+ +**custom_attribute:** `CustomAttributeParams` + +The custom attribute to create or update, with the following fields: + +- `value`. This value must conform to the `schema` specified by the definition. +For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + +- `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) +control, include this optional field and specify the current version of the custom attribute. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` + +A unique identifier for this request, used to ensure idempotency. +For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.orders.custom_attributes.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + +To delete a custom attribute owned by another application, the `visibility` setting must be +`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes +(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.orders.custom_attributes.delete( + order_id="order_id", + custom_attribute_key="custom_attribute_key", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**order_id:** `str` — The ID of the target [order](entity:Order). + +
+
+ +
+
+ +**custom_attribute_key:** `str` + +The key of the custom attribute to delete. This key must match the key of an +existing custom attribute definition. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## TeamMembers WageSetting +
client.team_members.wage_setting.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a `WageSetting` object for a team member specified +by `TeamMember.id`. For more information, see +[Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). + +Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) +to get this information directly from the `TeamMember.wage_setting` field. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.wage_setting.get( + team_member_id="team_member_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_id:** `str` — The ID of the team member for which to retrieve the wage setting. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.team_members.wage_setting.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates or updates a `WageSetting` object. The object is created if a +`WageSetting` with the specified `team_member_id` doesn't exist. Otherwise, +it fully replaces the `WageSetting` object for the team member. +The `WageSetting` is returned on a successful update. For more information, see +[Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting). + +Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember) +to manage the `TeamMember.wage_setting` field directly. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.team_members.wage_setting.update( + team_member_id="team_member_id", + wage_setting={ + "job_assignments": [ + { + "job_title": "Manager", + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + }, + { + "job_title": "Cashier", + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2000, "currency": "USD"}, + }, + ], + "is_overtime_exempt": True, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**team_member_id:** `str` — The ID of the team member for which to update the `WageSetting` object. + +
+
+ +
+
+ +**wage_setting:** `WageSettingParams` + +The complete `WageSetting` object. For all job assignments, specify one of the following: +- `job_id` (recommended) - If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get a list of all jobs. +Requires Square API version 2024-12-18 or later. +- `job_title` - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job. +This value is ignored if `job_id` is also provided. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Terminal Actions +
client.terminal.actions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a Terminal action request and sends it to the specified device. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.actions.create( + idempotency_key="thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e", + action={ + "device_id": "{{DEVICE_ID}}", + "deadline_duration": "PT5M", + "type": "SAVE_CARD", + "save_card_options": { + "customer_id": "{{CUSTOMER_ID}}", + "reference_id": "user-id-1", + }, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `CreateAction` request. Keys can be any valid string +but must be unique for every `CreateAction` request. + +See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more +information. + +
+
+ +
+
+ +**action:** `TerminalActionParams` — The Action to create. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.actions.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.actions.search( + query={ + "filter": {"created_at": {"start_at": "2022-04-01T00:00:00.000Z"}}, + "sort": {"sort_order": "DESC"}, + }, + limit=2, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[TerminalActionQueryParams]` + +Queries terminal actions based on given conditions and sort order. +Leaving this unset will return all actions with the default sort order. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for the original query. +See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more +information. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Limit the number of results returned for a single request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.actions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.actions.get( + action_id="action_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**action_id:** `str` — Unique ID for the desired `TerminalAction`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.actions.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels a Terminal action request if the status of the request permits it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.actions.cancel( + action_id="action_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**action_id:** `str` — Unique ID for the desired `TerminalAction`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Terminal Checkouts +
client.terminal.checkouts.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a Terminal checkout request and sends it to the specified device to take a payment +for the requested amount. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.checkouts.create( + idempotency_key="28a0c3bc-7839-11ea-bc55-0242ac130003", + checkout={ + "amount_money": {"amount": 2610, "currency": "USD"}, + "reference_id": "id11572", + "note": "A brief note", + "device_options": {"device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003"}, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but +must be unique for every `CreateCheckout` request. + +See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + +
+
+ +
+
+ +**checkout:** `TerminalCheckoutParams` — The checkout to create. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.checkouts.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.checkouts.search( + query={"filter": {"status": "COMPLETED"}}, + limit=2, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[TerminalCheckoutQueryParams]` + +Queries Terminal checkouts based on given conditions and the sort order. +Leaving these unset returns all checkouts with the default sort order. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. +See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Limits the number of results returned for a single request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.checkouts.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.checkouts.get( + checkout_id="checkout_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**checkout_id:** `str` — The unique ID for the desired `TerminalCheckout`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.checkouts.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels a Terminal checkout request if the status of the request permits it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.checkouts.cancel( + checkout_id="checkout_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**checkout_id:** `str` — The unique ID for the desired `TerminalCheckout`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Terminal Refunds +
client.terminal.refunds.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.refunds.create( + idempotency_key="402a640b-b26f-401f-b406-46f839590c04", + refund={ + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "amount_money": {"amount": 111, "currency": "CAD"}, + "reason": "Returning items", + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**idempotency_key:** `str` + +A unique string that identifies this `CreateRefund` request. Keys can be any valid string but +must be unique for every `CreateRefund` request. + +See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + +
+
+ +
+
+ +**refund:** `typing.Optional[TerminalRefundParams]` — The refund to create. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.refunds.search(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.refunds.search( + query={"filter": {"status": "COMPLETED"}}, + limit=1, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `typing.Optional[TerminalRefundQueryParams]` + +Queries the Terminal refunds based on given conditions and the sort order. Calling +`SearchTerminalRefunds` without an explicit query parameter returns all available +refunds with the default sort order. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this cursor to retrieve the next set of results for the original query. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Limits the number of results returned for a single request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.refunds.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.refunds.get( + terminal_refund_id="terminal_refund_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**terminal_refund_id:** `str` — The unique ID for the desired `TerminalRefund`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.terminal.refunds.cancel(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.terminal.refunds.cancel( + terminal_refund_id="terminal_refund_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**terminal_refund_id:** `str` — The unique ID for the desired `TerminalRefund`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Webhooks EventTypes +
client.webhooks.event_types.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all webhook event types that can be subscribed to. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.event_types.list() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**api_version:** `typing.Optional[str]` — The API version for which to list event types. Setting this field overrides the default version used by the application. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Webhooks Subscriptions +
client.webhooks.subscriptions.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all webhook subscriptions owned by your application. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +response = client.webhooks.subscriptions.list() +for item in response: + yield item +# alternatively, you can paginate page-by-page +for page in response.iter_pages(): + yield page + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` + +A pagination cursor returned by a previous call to this endpoint. +Provide this to retrieve the next set of results for your original query. + +For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + +
+
+ +
+
+ +**include_disabled:** `typing.Optional[bool]` + +Includes disabled [Subscription](entity:WebhookSubscription)s. +By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[SortOrder]` + +Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order. +This field defaults to ASC. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` + +The maximum number of results to be returned in a single page. +It is possible to receive fewer results than the specified limit on a given page. +The default value of 100 is also the maximum allowed value. + +Default: 100 + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.webhooks.subscriptions.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a webhook subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.subscriptions.create( + idempotency_key="63f84c6c-2200-4c99-846c-2670a1311fbf", + subscription={ + "name": "Example Webhook Subscription", + "event_types": ["payment.created", "payment.updated"], + "notification_url": "https://example-webhook-url.com", + "api_version": "2021-12-15", + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription:** `WebhookSubscriptionParams` — The [Subscription](entity:WebhookSubscription) to create. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.webhooks.subscriptions.get(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a webhook subscription identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.subscriptions.get( + subscription_id="subscription_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.webhooks.subscriptions.update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a webhook subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.subscriptions.update( + subscription_id="subscription_id", + subscription={ + "name": "Updated Example Webhook Subscription", + "enabled": False, + }, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + +
+
+ +
+
+ +**subscription:** `typing.Optional[WebhookSubscriptionParams]` — The [Subscription](entity:WebhookSubscription) to update. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.webhooks.subscriptions.delete(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a webhook subscription. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.subscriptions.delete( + subscription_id="subscription_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.webhooks.subscriptions.update_signature_key(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a webhook subscription by replacing the existing signature key with a new one. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.subscriptions.update_signature_key( + subscription_id="subscription_id", + idempotency_key="ed80ae6b-0654-473b-bbab-a39aee89a60d", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + +
+
+ +
+
+ +**idempotency_key:** `typing.Optional[str]` — A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.webhooks.subscriptions.test(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Tests a webhook subscription by sending a test event to the notification URL. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from square import Square + +client = Square( + token="YOUR_TOKEN", +) +client.webhooks.subscriptions.test( + subscription_id="subscription_id", + event_type="payment.created", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**subscription_id:** `str` — [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test. + +
+
+ +
+
+ +**event_type:** `typing.Optional[str]` + +The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be +contained in the list of event types in the [Subscription](entity:WebhookSubscription). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ diff --git a/requirements.txt b/requirements.txt index c6c51b54..f502f1b0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -apimatic-core~=0.2.0, >= 0.2.17 -apimatic-core-interfaces~=0.1.0, >= 0.1.5 -apimatic-requests-client-adapter~=0.1.0, >= 0.1.6 -deprecation~=2.1 +httpx>=0.21.2 +pydantic>= 1.9.2 +pydantic-core==^2.18.2 +typing_extensions>= 4.0.0 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 206bc24e..00000000 --- a/setup.cfg +++ /dev/null @@ -1,10 +0,0 @@ -# -*- coding: utf-8 -*- -# Setuptools v62.6 doesn't support editable installs with just 'pyproject.toml' (PEP 660). -# Keep this file until it does! - -[meta-data] -# wheel doesn't yet read license_files from pyproject.toml - tools.setuptools -# Keep it here until it does! -license_files = - LICENSE - diff --git a/setup.py b/setup.py deleted file mode 100644 index 162796aa..00000000 --- a/setup.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- - -import sys -from setuptools import setup, find_packages - -if sys.version_info[0] < 3: - with open('README.md', 'r') as fh: - long_description = fh.read() -else: - with open('README.md', 'r', encoding='utf-8') as fh: - long_description = fh.read() - -setup( - name='squareup', - version='23.0.0.20221019', - description='Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.', - long_description=long_description, - long_description_content_type="text/markdown", - author='Square Developer Platform', - author_email='developers@squareup.com', - url='https://squareup.com/developers', - packages=find_packages(), - install_requires=[ - 'apimatic-core~=0.1.0', - 'apimatic-core-interfaces~=0.1.0', - 'apimatic-requests-client-adapter~=0.1.0', - 'python-dateutil~=2.8.1', - 'deprecation~=2.1' - ], - tests_require=[ - 'pytest>=7.1.3' - ], -) \ No newline at end of file diff --git a/src/square/__init__.py b/src/square/__init__.py new file mode 100644 index 00000000..33d63e6f --- /dev/null +++ b/src/square/__init__.py @@ -0,0 +1,80 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import ( + apple_pay, + bank_accounts, + bookings, + cards, + cash_drawers, + catalog, + checkout, + customers, + devices, + disputes, + employees, + events, + gift_cards, + inventory, + invoices, + labor, + locations, + loyalty, + merchants, + mobile, + o_auth, + orders, + payments, + payouts, + refunds, + sites, + snippets, + subscriptions, + team, + team_members, + terminal, + v1transactions, + vendors, + webhooks, +) +from .client import AsyncSquare, Square +from .version import __version__ + +__all__ = [ + "AsyncSquare", + "Square", + "__version__", + "apple_pay", + "bank_accounts", + "bookings", + "cards", + "cash_drawers", + "catalog", + "checkout", + "customers", + "devices", + "disputes", + "employees", + "events", + "gift_cards", + "inventory", + "invoices", + "labor", + "locations", + "loyalty", + "merchants", + "mobile", + "o_auth", + "orders", + "payments", + "payouts", + "refunds", + "sites", + "snippets", + "subscriptions", + "team", + "team_members", + "terminal", + "v1transactions", + "vendors", + "webhooks", +] diff --git a/src/square/apple_pay/__init__.py b/src/square/apple_pay/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/apple_pay/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/apple_pay/client.py b/src/square/apple_pay/client.py new file mode 100644 index 00000000..e2179ebc --- /dev/null +++ b/src/square/apple_pay/client.py @@ -0,0 +1,144 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawApplePayClient +from ..core.request_options import RequestOptions +from ..types.register_domain_response import RegisterDomainResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawApplePayClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ApplePayClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawApplePayClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawApplePayClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawApplePayClient + """ + return self._raw_client + + def register_domain( + self, *, domain_name: str, request_options: typing.Optional[RequestOptions] = None + ) -> RegisterDomainResponse: + """ + Activates a domain for use with Apple Pay on the Web and Square. A validation + is performed on this domain by Apple to ensure that it is properly set up as + an Apple Pay enabled domain. + + This endpoint provides an easy way for platform developers to bulk activate + Apple Pay on the Web with Square for merchants using their platform. + + Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The + current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, + and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your + domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding + long-lived caches that might not keep in sync with the correct file version. + + To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay). + + Parameters + ---------- + domain_name : str + A domain name as described in RFC-1034 that will be registered with ApplePay. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RegisterDomainResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.apple_pay.register_domain( + domain_name="example.com", + ) + """ + response = self._raw_client.register_domain(domain_name=domain_name, request_options=request_options) + return response.data + + +class AsyncApplePayClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawApplePayClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawApplePayClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawApplePayClient + """ + return self._raw_client + + async def register_domain( + self, *, domain_name: str, request_options: typing.Optional[RequestOptions] = None + ) -> RegisterDomainResponse: + """ + Activates a domain for use with Apple Pay on the Web and Square. A validation + is performed on this domain by Apple to ensure that it is properly set up as + an Apple Pay enabled domain. + + This endpoint provides an easy way for platform developers to bulk activate + Apple Pay on the Web with Square for merchants using their platform. + + Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The + current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, + and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your + domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding + long-lived caches that might not keep in sync with the correct file version. + + To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay). + + Parameters + ---------- + domain_name : str + A domain name as described in RFC-1034 that will be registered with ApplePay. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RegisterDomainResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.apple_pay.register_domain( + domain_name="example.com", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.register_domain(domain_name=domain_name, request_options=request_options) + return response.data diff --git a/src/square/apple_pay/raw_client.py b/src/square/apple_pay/raw_client.py new file mode 100644 index 00000000..a0afefc9 --- /dev/null +++ b/src/square/apple_pay/raw_client.py @@ -0,0 +1,143 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.register_domain_response import RegisterDomainResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawApplePayClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def register_domain( + self, *, domain_name: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RegisterDomainResponse]: + """ + Activates a domain for use with Apple Pay on the Web and Square. A validation + is performed on this domain by Apple to ensure that it is properly set up as + an Apple Pay enabled domain. + + This endpoint provides an easy way for platform developers to bulk activate + Apple Pay on the Web with Square for merchants using their platform. + + Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The + current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, + and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your + domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding + long-lived caches that might not keep in sync with the correct file version. + + To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay). + + Parameters + ---------- + domain_name : str + A domain name as described in RFC-1034 that will be registered with ApplePay. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RegisterDomainResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/apple-pay/domains", + method="POST", + json={ + "domain_name": domain_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RegisterDomainResponse, + construct_type( + type_=RegisterDomainResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawApplePayClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def register_domain( + self, *, domain_name: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RegisterDomainResponse]: + """ + Activates a domain for use with Apple Pay on the Web and Square. A validation + is performed on this domain by Apple to ensure that it is properly set up as + an Apple Pay enabled domain. + + This endpoint provides an easy way for platform developers to bulk activate + Apple Pay on the Web with Square for merchants using their platform. + + Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The + current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, + and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your + domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding + long-lived caches that might not keep in sync with the correct file version. + + To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay). + + Parameters + ---------- + domain_name : str + A domain name as described in RFC-1034 that will be registered with ApplePay. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RegisterDomainResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/apple-pay/domains", + method="POST", + json={ + "domain_name": domain_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RegisterDomainResponse, + construct_type( + type_=RegisterDomainResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/bank_accounts/__init__.py b/src/square/bank_accounts/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/bank_accounts/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/bank_accounts/client.py b/src/square/bank_accounts/client.py new file mode 100644 index 00000000..2a70599f --- /dev/null +++ b/src/square/bank_accounts/client.py @@ -0,0 +1,379 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawBankAccountsClient +import typing +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.bank_account import BankAccount +from ..types.list_bank_accounts_response import ListBankAccountsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_bank_account_by_v1id_response import GetBankAccountByV1IdResponse +from ..types.get_bank_account_response import GetBankAccountResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawBankAccountsClient +from ..core.pagination import AsyncPager + + +class BankAccountsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawBankAccountsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawBankAccountsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawBankAccountsClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[BankAccount]: + """ + Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned by a previous call to this endpoint. + Use it in the next `ListBankAccounts` request to retrieve the next set + of results. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + Upper limit on the number of bank accounts to return in the response. + Currently, 1000 is the largest supported limit. You can specify a limit + of up to 1000 bank accounts. This is also the default limit. + + location_id : typing.Optional[str] + Location ID. You can specify this optional filter + to retrieve only the linked bank accounts belonging to a specific location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[BankAccount] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.bank_accounts.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/bank-accounts", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBankAccountsResponse, + construct_type( + type_=ListBankAccountsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.bank_accounts + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_by_v1id( + self, v1bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBankAccountByV1IdResponse: + """ + Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID. + + Parameters + ---------- + v1bank_account_id : str + Connect V1 ID of the desired `BankAccount`. For more information, see + [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBankAccountByV1IdResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bank_accounts.get_by_v1id( + v1bank_account_id="v1_bank_account_id", + ) + """ + response = self._raw_client.get_by_v1id(v1bank_account_id, request_options=request_options) + return response.data + + def get( + self, bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBankAccountResponse: + """ + Returns details of a [BankAccount](entity:BankAccount) + linked to a Square account. + + Parameters + ---------- + bank_account_id : str + Square-issued ID of the desired `BankAccount`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBankAccountResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bank_accounts.get( + bank_account_id="bank_account_id", + ) + """ + response = self._raw_client.get(bank_account_id, request_options=request_options) + return response.data + + +class AsyncBankAccountsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawBankAccountsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawBankAccountsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawBankAccountsClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[BankAccount]: + """ + Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned by a previous call to this endpoint. + Use it in the next `ListBankAccounts` request to retrieve the next set + of results. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + Upper limit on the number of bank accounts to return in the response. + Currently, 1000 is the largest supported limit. You can specify a limit + of up to 1000 bank accounts. This is also the default limit. + + location_id : typing.Optional[str] + Location ID. You can specify this optional filter + to retrieve only the linked bank accounts belonging to a specific location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[BankAccount] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.bank_accounts.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/bank-accounts", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBankAccountsResponse, + construct_type( + type_=ListBankAccountsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.bank_accounts + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_by_v1id( + self, v1bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBankAccountByV1IdResponse: + """ + Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID. + + Parameters + ---------- + v1bank_account_id : str + Connect V1 ID of the desired `BankAccount`. For more information, see + [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBankAccountByV1IdResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bank_accounts.get_by_v1id( + v1bank_account_id="v1_bank_account_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get_by_v1id(v1bank_account_id, request_options=request_options) + return response.data + + async def get( + self, bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBankAccountResponse: + """ + Returns details of a [BankAccount](entity:BankAccount) + linked to a Square account. + + Parameters + ---------- + bank_account_id : str + Square-issued ID of the desired `BankAccount`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBankAccountResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bank_accounts.get( + bank_account_id="bank_account_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(bank_account_id, request_options=request_options) + return response.data diff --git a/src/square/bank_accounts/raw_client.py b/src/square/bank_accounts/raw_client.py new file mode 100644 index 00000000..079fc0c0 --- /dev/null +++ b/src/square/bank_accounts/raw_client.py @@ -0,0 +1,184 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_bank_account_by_v1id_response import GetBankAccountByV1IdResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_bank_account_response import GetBankAccountResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawBankAccountsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get_by_v1id( + self, v1bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetBankAccountByV1IdResponse]: + """ + Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID. + + Parameters + ---------- + v1bank_account_id : str + Connect V1 ID of the desired `BankAccount`. For more information, see + [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetBankAccountByV1IdResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bank-accounts/by-v1-id/{jsonable_encoder(v1bank_account_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBankAccountByV1IdResponse, + construct_type( + type_=GetBankAccountByV1IdResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetBankAccountResponse]: + """ + Returns details of a [BankAccount](entity:BankAccount) + linked to a Square account. + + Parameters + ---------- + bank_account_id : str + Square-issued ID of the desired `BankAccount`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetBankAccountResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bank-accounts/{jsonable_encoder(bank_account_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBankAccountResponse, + construct_type( + type_=GetBankAccountResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawBankAccountsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get_by_v1id( + self, v1bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetBankAccountByV1IdResponse]: + """ + Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID. + + Parameters + ---------- + v1bank_account_id : str + Connect V1 ID of the desired `BankAccount`. For more information, see + [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetBankAccountByV1IdResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bank-accounts/by-v1-id/{jsonable_encoder(v1bank_account_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBankAccountByV1IdResponse, + construct_type( + type_=GetBankAccountByV1IdResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, bank_account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetBankAccountResponse]: + """ + Returns details of a [BankAccount](entity:BankAccount) + linked to a Square account. + + Parameters + ---------- + bank_account_id : str + Square-issued ID of the desired `BankAccount`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetBankAccountResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bank-accounts/{jsonable_encoder(bank_account_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBankAccountResponse, + construct_type( + type_=GetBankAccountResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/bookings/__init__.py b/src/square/bookings/__init__.py new file mode 100644 index 00000000..1dd96f75 --- /dev/null +++ b/src/square/bookings/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import custom_attribute_definitions, custom_attributes, location_profiles, team_member_profiles + +__all__ = ["custom_attribute_definitions", "custom_attributes", "location_profiles", "team_member_profiles"] diff --git a/src/square/bookings/client.py b/src/square/bookings/client.py new file mode 100644 index 00000000..c67ce3f4 --- /dev/null +++ b/src/square/bookings/client.py @@ -0,0 +1,1109 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawBookingsClient +from .custom_attribute_definitions.client import CustomAttributeDefinitionsClient +from .custom_attributes.client import CustomAttributesClient +from .location_profiles.client import LocationProfilesClient +from .team_member_profiles.client import TeamMemberProfilesClient +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.booking import Booking +from ..types.list_bookings_response import ListBookingsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.booking import BookingParams +from ..types.create_booking_response import CreateBookingResponse +from ..requests.search_availability_query import SearchAvailabilityQueryParams +from ..types.search_availability_response import SearchAvailabilityResponse +from ..types.bulk_retrieve_bookings_response import BulkRetrieveBookingsResponse +from ..types.get_business_booking_profile_response import GetBusinessBookingProfileResponse +from ..types.retrieve_location_booking_profile_response import RetrieveLocationBookingProfileResponse +from ..types.bulk_retrieve_team_member_booking_profiles_response import BulkRetrieveTeamMemberBookingProfilesResponse +from ..types.get_booking_response import GetBookingResponse +from ..types.update_booking_response import UpdateBookingResponse +from ..types.cancel_booking_response import CancelBookingResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawBookingsClient +from .custom_attribute_definitions.client import AsyncCustomAttributeDefinitionsClient +from .custom_attributes.client import AsyncCustomAttributesClient +from .location_profiles.client import AsyncLocationProfilesClient +from .team_member_profiles.client import AsyncTeamMemberProfilesClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class BookingsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawBookingsClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = CustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = CustomAttributesClient(client_wrapper=client_wrapper) + + self.location_profiles = LocationProfilesClient(client_wrapper=client_wrapper) + + self.team_member_profiles = TeamMemberProfilesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawBookingsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawBookingsClient + """ + return self._raw_client + + def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + customer_id: typing.Optional[str] = None, + team_member_id: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + start_at_min: typing.Optional[str] = None, + start_at_max: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Booking]: + """ + Retrieve a collection of bookings. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results per page to return in a paged response. + + cursor : typing.Optional[str] + The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + + customer_id : typing.Optional[str] + The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved. + + team_member_id : typing.Optional[str] + The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved. + + location_id : typing.Optional[str] + The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved. + + start_at_min : typing.Optional[str] + The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used. + + start_at_max : typing.Optional[str] + The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Booking] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.bookings.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + "customer_id": customer_id, + "team_member_id": team_member_id, + "location_id": location_id, + "start_at_min": start_at_min, + "start_at_max": start_at_max, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBookingsResponse, + construct_type( + type_=ListBookingsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + customer_id=customer_id, + team_member_id=team_member_id, + location_id=location_id, + start_at_min=start_at_min, + start_at_max=start_at_max, + request_options=request_options, + ) + _items = _parsed_response.bookings + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateBookingResponse: + """ + Creates a booking. + + The required input must include the following: + - `Booking.location_id` + - `Booking.start_at` + - `Booking.AppointmentSegment.team_member_id` + - `Booking.AppointmentSegment.service_variation_id` + - `Booking.AppointmentSegment.service_variation_version` + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking : BookingParams + The details of the booking to be created. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateBookingResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.create( + booking={}, + ) + """ + response = self._raw_client.create( + booking=booking, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def search_availability( + self, *, query: SearchAvailabilityQueryParams, request_options: typing.Optional[RequestOptions] = None + ) -> SearchAvailabilityResponse: + """ + Searches for availabilities for booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + query : SearchAvailabilityQueryParams + Query conditions used to filter buyer-accessible booking availabilities. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchAvailabilityResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.search_availability( + query={"filter": {"start_at_range": {}}}, + ) + """ + response = self._raw_client.search_availability(query=query, request_options=request_options) + return response.data + + def bulk_retrieve_bookings( + self, *, booking_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkRetrieveBookingsResponse: + """ + Bulk-Retrieves a list of bookings by booking IDs. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_ids : typing.Sequence[str] + A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkRetrieveBookingsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.bulk_retrieve_bookings( + booking_ids=["booking_ids"], + ) + """ + response = self._raw_client.bulk_retrieve_bookings(booking_ids=booking_ids, request_options=request_options) + return response.data + + def get_business_profile( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBusinessBookingProfileResponse: + """ + Retrieves a seller's booking profile. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBusinessBookingProfileResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.get_business_profile() + """ + response = self._raw_client.get_business_profile(request_options=request_options) + return response.data + + def retrieve_location_booking_profile( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveLocationBookingProfileResponse: + """ + Retrieves a seller's location booking profile. + + Parameters + ---------- + location_id : str + The ID of the location to retrieve the booking profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationBookingProfileResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.retrieve_location_booking_profile( + location_id="location_id", + ) + """ + response = self._raw_client.retrieve_location_booking_profile(location_id, request_options=request_options) + return response.data + + def bulk_retrieve_team_member_booking_profiles( + self, *, team_member_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkRetrieveTeamMemberBookingProfilesResponse: + """ + Retrieves one or more team members' booking profiles. + + Parameters + ---------- + team_member_ids : typing.Sequence[str] + A non-empty list of IDs of team members whose booking profiles you want to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkRetrieveTeamMemberBookingProfilesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.bulk_retrieve_team_member_booking_profiles( + team_member_ids=["team_member_ids"], + ) + """ + response = self._raw_client.bulk_retrieve_team_member_booking_profiles( + team_member_ids=team_member_ids, request_options=request_options + ) + return response.data + + def get(self, booking_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetBookingResponse: + """ + Retrieves a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBookingResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.get( + booking_id="booking_id", + ) + """ + response = self._raw_client.get(booking_id, request_options=request_options) + return response.data + + def update( + self, + booking_id: str, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateBookingResponse: + """ + Updates a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-updated booking. + + booking : BookingParams + The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateBookingResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.update( + booking_id="booking_id", + booking={}, + ) + """ + response = self._raw_client.update( + booking_id, booking=booking, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def cancel( + self, + booking_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + booking_version: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CancelBookingResponse: + """ + Cancels an existing booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + booking_version : typing.Optional[int] + The revision number for the booking used for optimistic concurrency. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelBookingResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.cancel( + booking_id="booking_id", + ) + """ + response = self._raw_client.cancel( + booking_id, + idempotency_key=idempotency_key, + booking_version=booking_version, + request_options=request_options, + ) + return response.data + + +class AsyncBookingsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawBookingsClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = AsyncCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = AsyncCustomAttributesClient(client_wrapper=client_wrapper) + + self.location_profiles = AsyncLocationProfilesClient(client_wrapper=client_wrapper) + + self.team_member_profiles = AsyncTeamMemberProfilesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawBookingsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawBookingsClient + """ + return self._raw_client + + async def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + customer_id: typing.Optional[str] = None, + team_member_id: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + start_at_min: typing.Optional[str] = None, + start_at_max: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Booking]: + """ + Retrieve a collection of bookings. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results per page to return in a paged response. + + cursor : typing.Optional[str] + The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + + customer_id : typing.Optional[str] + The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved. + + team_member_id : typing.Optional[str] + The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved. + + location_id : typing.Optional[str] + The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved. + + start_at_min : typing.Optional[str] + The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used. + + start_at_max : typing.Optional[str] + The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Booking] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.bookings.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + "customer_id": customer_id, + "team_member_id": team_member_id, + "location_id": location_id, + "start_at_min": start_at_min, + "start_at_max": start_at_max, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBookingsResponse, + construct_type( + type_=ListBookingsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + customer_id=customer_id, + team_member_id=team_member_id, + location_id=location_id, + start_at_min=start_at_min, + start_at_max=start_at_max, + request_options=request_options, + ) + _items = _parsed_response.bookings + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateBookingResponse: + """ + Creates a booking. + + The required input must include the following: + - `Booking.location_id` + - `Booking.start_at` + - `Booking.AppointmentSegment.team_member_id` + - `Booking.AppointmentSegment.service_variation_id` + - `Booking.AppointmentSegment.service_variation_version` + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking : BookingParams + The details of the booking to be created. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateBookingResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.create( + booking={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + booking=booking, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def search_availability( + self, *, query: SearchAvailabilityQueryParams, request_options: typing.Optional[RequestOptions] = None + ) -> SearchAvailabilityResponse: + """ + Searches for availabilities for booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + query : SearchAvailabilityQueryParams + Query conditions used to filter buyer-accessible booking availabilities. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchAvailabilityResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.search_availability( + query={"filter": {"start_at_range": {}}}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search_availability(query=query, request_options=request_options) + return response.data + + async def bulk_retrieve_bookings( + self, *, booking_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkRetrieveBookingsResponse: + """ + Bulk-Retrieves a list of bookings by booking IDs. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_ids : typing.Sequence[str] + A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkRetrieveBookingsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.bulk_retrieve_bookings( + booking_ids=["booking_ids"], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.bulk_retrieve_bookings( + booking_ids=booking_ids, request_options=request_options + ) + return response.data + + async def get_business_profile( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBusinessBookingProfileResponse: + """ + Retrieves a seller's booking profile. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBusinessBookingProfileResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.get_business_profile() + + + asyncio.run(main()) + """ + response = await self._raw_client.get_business_profile(request_options=request_options) + return response.data + + async def retrieve_location_booking_profile( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveLocationBookingProfileResponse: + """ + Retrieves a seller's location booking profile. + + Parameters + ---------- + location_id : str + The ID of the location to retrieve the booking profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationBookingProfileResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.retrieve_location_booking_profile( + location_id="location_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.retrieve_location_booking_profile( + location_id, request_options=request_options + ) + return response.data + + async def bulk_retrieve_team_member_booking_profiles( + self, *, team_member_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkRetrieveTeamMemberBookingProfilesResponse: + """ + Retrieves one or more team members' booking profiles. + + Parameters + ---------- + team_member_ids : typing.Sequence[str] + A non-empty list of IDs of team members whose booking profiles you want to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkRetrieveTeamMemberBookingProfilesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.bulk_retrieve_team_member_booking_profiles( + team_member_ids=["team_member_ids"], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.bulk_retrieve_team_member_booking_profiles( + team_member_ids=team_member_ids, request_options=request_options + ) + return response.data + + async def get( + self, booking_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetBookingResponse: + """ + Retrieves a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBookingResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.get( + booking_id="booking_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(booking_id, request_options=request_options) + return response.data + + async def update( + self, + booking_id: str, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateBookingResponse: + """ + Updates a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-updated booking. + + booking : BookingParams + The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateBookingResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.update( + booking_id="booking_id", + booking={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + booking_id, booking=booking, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def cancel( + self, + booking_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + booking_version: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CancelBookingResponse: + """ + Cancels an existing booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + booking_version : typing.Optional[int] + The revision number for the booking used for optimistic concurrency. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelBookingResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.cancel( + booking_id="booking_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel( + booking_id, + idempotency_key=idempotency_key, + booking_version=booking_version, + request_options=request_options, + ) + return response.data diff --git a/src/square/bookings/custom_attribute_definitions/__init__.py b/src/square/bookings/custom_attribute_definitions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/bookings/custom_attribute_definitions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/bookings/custom_attribute_definitions/client.py b/src/square/bookings/custom_attribute_definitions/client.py new file mode 100644 index 00000000..f11d269b --- /dev/null +++ b/src/square/bookings/custom_attribute_definitions/client.py @@ -0,0 +1,685 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributeDefinitionsClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.custom_attribute_definition import CustomAttributeDefinition +from ...types.list_booking_custom_attribute_definitions_response import ListBookingCustomAttributeDefinitionsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...types.create_booking_custom_attribute_definition_response import CreateBookingCustomAttributeDefinitionResponse +from ...types.retrieve_booking_custom_attribute_definition_response import ( + RetrieveBookingCustomAttributeDefinitionResponse, +) +from ...types.update_booking_custom_attribute_definition_response import UpdateBookingCustomAttributeDefinitionResponse +from ...types.delete_booking_custom_attribute_definition_response import DeleteBookingCustomAttributeDefinitionResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributeDefinitionsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributeDefinitionsClient + """ + return self._raw_client + + def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttributeDefinition]: + """ + Get all bookings custom attribute definitions. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.bookings.custom_attribute_definitions.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings/custom-attribute-definitions", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBookingCustomAttributeDefinitionsResponse, + construct_type( + type_=ListBookingCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateBookingCustomAttributeDefinitionResponse: + """ + Creates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create, with the following fields: + + - `key` + + - `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute + definitions for the seller. + + - `description` + + - `visibility`. Note that all custom attributes are visible in exported booking data, including those set to + `VISIBILITY_HIDDEN`. + + - `schema`. With the exception of the `Selection` data type, the `schema` is specified as a + simple URL to the JSON schema definition hosted on the Square CDN. For more information, see + [Specifying the schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema). + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attribute_definitions.create( + custom_attribute_definition={}, + ) + """ + response = self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveBookingCustomAttributeDefinitionResponse: + """ + Retrieves a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attribute_definitions.get( + key="key", + ) + """ + response = self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateBookingCustomAttributeDefinitionResponse: + """ + Updates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={}, + ) + """ + response = self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteBookingCustomAttributeDefinitionResponse: + """ + Deletes a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attribute_definitions.delete( + key="key", + ) + """ + response = self._raw_client.delete(key, request_options=request_options) + return response.data + + +class AsyncCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributeDefinitionsClient + """ + return self._raw_client + + async def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttributeDefinition]: + """ + Get all bookings custom attribute definitions. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.bookings.custom_attribute_definitions.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings/custom-attribute-definitions", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBookingCustomAttributeDefinitionsResponse, + construct_type( + type_=ListBookingCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateBookingCustomAttributeDefinitionResponse: + """ + Creates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create, with the following fields: + + - `key` + + - `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute + definitions for the seller. + + - `description` + + - `visibility`. Note that all custom attributes are visible in exported booking data, including those set to + `VISIBILITY_HIDDEN`. + + - `schema`. With the exception of the `Selection` data type, the `schema` is specified as a + simple URL to the JSON schema definition hosted on the Square CDN. For more information, see + [Specifying the schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema). + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attribute_definitions.create( + custom_attribute_definition={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveBookingCustomAttributeDefinitionResponse: + """ + Retrieves a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attribute_definitions.get( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateBookingCustomAttributeDefinitionResponse: + """ + Updates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteBookingCustomAttributeDefinitionResponse: + """ + Deletes a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteBookingCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attribute_definitions.delete( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(key, request_options=request_options) + return response.data diff --git a/src/square/bookings/custom_attribute_definitions/raw_client.py b/src/square/bookings/custom_attribute_definitions/raw_client.py new file mode 100644 index 00000000..72eb0db3 --- /dev/null +++ b/src/square/bookings/custom_attribute_definitions/raw_client.py @@ -0,0 +1,537 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_booking_custom_attribute_definition_response import CreateBookingCustomAttributeDefinitionResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_booking_custom_attribute_definition_response import ( + RetrieveBookingCustomAttributeDefinitionResponse, +) +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_booking_custom_attribute_definition_response import UpdateBookingCustomAttributeDefinitionResponse +from ...types.delete_booking_custom_attribute_definition_response import DeleteBookingCustomAttributeDefinitionResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateBookingCustomAttributeDefinitionResponse]: + """ + Creates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create, with the following fields: + + - `key` + + - `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute + definitions for the seller. + + - `description` + + - `visibility`. Note that all custom attributes are visible in exported booking data, including those set to + `VISIBILITY_HIDDEN`. + + - `schema`. With the exception of the `Selection` data type, the `schema` is specified as a + simple URL to the JSON schema definition hosted on the Square CDN. For more information, see + [Specifying the schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema). + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateBookingCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateBookingCustomAttributeDefinitionResponse, + construct_type( + type_=CreateBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveBookingCustomAttributeDefinitionResponse]: + """ + Retrieves a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveBookingCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveBookingCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateBookingCustomAttributeDefinitionResponse]: + """ + Updates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateBookingCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateBookingCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteBookingCustomAttributeDefinitionResponse]: + """ + Deletes a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteBookingCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteBookingCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateBookingCustomAttributeDefinitionResponse]: + """ + Creates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create, with the following fields: + + - `key` + + - `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute + definitions for the seller. + + - `description` + + - `visibility`. Note that all custom attributes are visible in exported booking data, including those set to + `VISIBILITY_HIDDEN`. + + - `schema`. With the exception of the `Selection` data type, the `schema` is specified as a + simple URL to the JSON schema definition hosted on the Square CDN. For more information, see + [Specifying the schema](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#specify-schema). + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateBookingCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateBookingCustomAttributeDefinitionResponse, + construct_type( + type_=CreateBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveBookingCustomAttributeDefinitionResponse]: + """ + Retrieves a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveBookingCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveBookingCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateBookingCustomAttributeDefinitionResponse]: + """ + Updates a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateBookingCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateBookingCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteBookingCustomAttributeDefinitionResponse]: + """ + Deletes a bookings custom attribute definition. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteBookingCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteBookingCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteBookingCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/bookings/custom_attributes/__init__.py b/src/square/bookings/custom_attributes/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/bookings/custom_attributes/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/bookings/custom_attributes/client.py b/src/square/bookings/custom_attributes/client.py new file mode 100644 index 00000000..9b66e8b2 --- /dev/null +++ b/src/square/bookings/custom_attributes/client.py @@ -0,0 +1,827 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributesClient +from ...requests.booking_custom_attribute_delete_request import BookingCustomAttributeDeleteRequestParams +from ...core.request_options import RequestOptions +from ...types.bulk_delete_booking_custom_attributes_response import BulkDeleteBookingCustomAttributesResponse +from ...requests.booking_custom_attribute_upsert_request import BookingCustomAttributeUpsertRequestParams +from ...types.bulk_upsert_booking_custom_attributes_response import BulkUpsertBookingCustomAttributesResponse +from ...core.pagination import SyncPager +from ...types.custom_attribute import CustomAttribute +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_booking_custom_attributes_response import ListBookingCustomAttributesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_booking_custom_attribute_response import RetrieveBookingCustomAttributeResponse +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_booking_custom_attribute_response import UpsertBookingCustomAttributeResponse +from ...types.delete_booking_custom_attribute_response import DeleteBookingCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributesClient + """ + return self._raw_client + + def batch_delete( + self, + *, + values: typing.Dict[str, BookingCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteBookingCustomAttributesResponse: + """ + Bulk deletes bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeDeleteRequestParams] + A map containing 1 to 25 individual Delete requests. For each request, provide an + arbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the + information needed to delete a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteBookingCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attributes.batch_delete( + values={"key": {"booking_id": "booking_id", "key": "key"}}, + ) + """ + response = self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + def batch_upsert( + self, + *, + values: typing.Dict[str, BookingCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertBookingCustomAttributesResponse: + """ + Bulk upserts bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertBookingCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attributes.batch_upsert( + values={"key": {"booking_id": "booking_id", "custom_attribute": {}}}, + ) + """ + response = self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + def list( + self, + booking_id: str, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttribute]: + """ + Lists a booking's custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttribute] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.bookings.custom_attributes.list( + booking_id="booking_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBookingCustomAttributesResponse, + construct_type( + type_=ListBookingCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + booking_id, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + booking_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveBookingCustomAttributeResponse: + """ + Retrieves a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveBookingCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attributes.get( + booking_id="booking_id", + key="key", + ) + """ + response = self._raw_client.get( + booking_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + def upsert( + self, + booking_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertBookingCustomAttributeResponse: + """ + Upserts a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertBookingCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attributes.upsert( + booking_id="booking_id", + key="key", + custom_attribute={}, + ) + """ + response = self._raw_client.upsert( + booking_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, booking_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteBookingCustomAttributeResponse: + """ + Deletes a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteBookingCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.custom_attributes.delete( + booking_id="booking_id", + key="key", + ) + """ + response = self._raw_client.delete(booking_id, key, request_options=request_options) + return response.data + + +class AsyncCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributesClient + """ + return self._raw_client + + async def batch_delete( + self, + *, + values: typing.Dict[str, BookingCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteBookingCustomAttributesResponse: + """ + Bulk deletes bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeDeleteRequestParams] + A map containing 1 to 25 individual Delete requests. For each request, provide an + arbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the + information needed to delete a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteBookingCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attributes.batch_delete( + values={"key": {"booking_id": "booking_id", "key": "key"}}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BookingCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertBookingCustomAttributesResponse: + """ + Bulk upserts bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertBookingCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attributes.batch_upsert( + values={"key": {"booking_id": "booking_id", "custom_attribute": {}}}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + async def list( + self, + booking_id: str, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttribute]: + """ + Lists a booking's custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttribute] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.bookings.custom_attributes.list( + booking_id="booking_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBookingCustomAttributesResponse, + construct_type( + type_=ListBookingCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + booking_id, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + booking_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveBookingCustomAttributeResponse: + """ + Retrieves a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveBookingCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attributes.get( + booking_id="booking_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get( + booking_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + async def upsert( + self, + booking_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertBookingCustomAttributeResponse: + """ + Upserts a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertBookingCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attributes.upsert( + booking_id="booking_id", + key="key", + custom_attribute={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert( + booking_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, booking_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteBookingCustomAttributeResponse: + """ + Deletes a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteBookingCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.custom_attributes.delete( + booking_id="booking_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(booking_id, key, request_options=request_options) + return response.data diff --git a/src/square/bookings/custom_attributes/raw_client.py b/src/square/bookings/custom_attributes/raw_client.py new file mode 100644 index 00000000..3e61fa87 --- /dev/null +++ b/src/square/bookings/custom_attributes/raw_client.py @@ -0,0 +1,674 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.booking_custom_attribute_delete_request import BookingCustomAttributeDeleteRequestParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.bulk_delete_booking_custom_attributes_response import BulkDeleteBookingCustomAttributesResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.booking_custom_attribute_upsert_request import BookingCustomAttributeUpsertRequestParams +from ...types.bulk_upsert_booking_custom_attributes_response import BulkUpsertBookingCustomAttributesResponse +from ...types.retrieve_booking_custom_attribute_response import RetrieveBookingCustomAttributeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_booking_custom_attribute_response import UpsertBookingCustomAttributeResponse +from ...types.delete_booking_custom_attribute_response import DeleteBookingCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def batch_delete( + self, + *, + values: typing.Dict[str, BookingCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkDeleteBookingCustomAttributesResponse]: + """ + Bulk deletes bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeDeleteRequestParams] + A map containing 1 to 25 individual Delete requests. For each request, provide an + arbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the + information needed to delete a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkDeleteBookingCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BookingCustomAttributeDeleteRequestParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteBookingCustomAttributesResponse, + construct_type( + type_=BulkDeleteBookingCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_upsert( + self, + *, + values: typing.Dict[str, BookingCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkUpsertBookingCustomAttributesResponse]: + """ + Bulk upserts bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkUpsertBookingCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BookingCustomAttributeUpsertRequestParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertBookingCustomAttributesResponse, + construct_type( + type_=BulkUpsertBookingCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + booking_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RetrieveBookingCustomAttributeResponse]: + """ + Retrieves a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveBookingCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveBookingCustomAttributeResponse, + construct_type( + type_=RetrieveBookingCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def upsert( + self, + booking_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpsertBookingCustomAttributeResponse]: + """ + Upserts a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertBookingCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertBookingCustomAttributeResponse, + construct_type( + type_=UpsertBookingCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, booking_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteBookingCustomAttributeResponse]: + """ + Deletes a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteBookingCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteBookingCustomAttributeResponse, + construct_type( + type_=DeleteBookingCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def batch_delete( + self, + *, + values: typing.Dict[str, BookingCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkDeleteBookingCustomAttributesResponse]: + """ + Bulk deletes bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeDeleteRequestParams] + A map containing 1 to 25 individual Delete requests. For each request, provide an + arbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the + information needed to delete a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkDeleteBookingCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BookingCustomAttributeDeleteRequestParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteBookingCustomAttributesResponse, + construct_type( + type_=BulkDeleteBookingCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BookingCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkUpsertBookingCustomAttributesResponse]: + """ + Bulk upserts bookings custom attributes. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + values : typing.Dict[str, BookingCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkUpsertBookingCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BookingCustomAttributeUpsertRequestParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertBookingCustomAttributesResponse, + construct_type( + type_=BulkUpsertBookingCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + booking_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RetrieveBookingCustomAttributeResponse]: + """ + Retrieves a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveBookingCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveBookingCustomAttributeResponse, + construct_type( + type_=RetrieveBookingCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def upsert( + self, + booking_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpsertBookingCustomAttributeResponse]: + """ + Upserts a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertBookingCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertBookingCustomAttributeResponse, + construct_type( + type_=UpsertBookingCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, booking_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteBookingCustomAttributeResponse]: + """ + Deletes a bookings custom attribute. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the target [booking](entity:Booking). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteBookingCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteBookingCustomAttributeResponse, + construct_type( + type_=DeleteBookingCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/bookings/location_profiles/__init__.py b/src/square/bookings/location_profiles/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/bookings/location_profiles/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/bookings/location_profiles/client.py b/src/square/bookings/location_profiles/client.py new file mode 100644 index 00000000..35da0863 --- /dev/null +++ b/src/square/bookings/location_profiles/client.py @@ -0,0 +1,199 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawLocationProfilesClient +import typing +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.location_booking_profile import LocationBookingProfile +from ...types.list_location_booking_profiles_response import ListLocationBookingProfilesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawLocationProfilesClient +from ...core.pagination import AsyncPager + + +class LocationProfilesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawLocationProfilesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawLocationProfilesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawLocationProfilesClient + """ + return self._raw_client + + def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[LocationBookingProfile]: + """ + Lists location booking profiles of a seller. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results to return in a paged response. + + cursor : typing.Optional[str] + The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[LocationBookingProfile] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.bookings.location_profiles.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings/location-booking-profiles", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLocationBookingProfilesResponse, + construct_type( + type_=ListLocationBookingProfilesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.location_booking_profiles + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncLocationProfilesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawLocationProfilesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawLocationProfilesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawLocationProfilesClient + """ + return self._raw_client + + async def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[LocationBookingProfile]: + """ + Lists location booking profiles of a seller. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results to return in a paged response. + + cursor : typing.Optional[str] + The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[LocationBookingProfile] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.bookings.location_profiles.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings/location-booking-profiles", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLocationBookingProfilesResponse, + construct_type( + type_=ListLocationBookingProfilesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.location_booking_profiles + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/bookings/location_profiles/raw_client.py b/src/square/bookings/location_profiles/raw_client.py new file mode 100644 index 00000000..58a7ab18 --- /dev/null +++ b/src/square/bookings/location_profiles/raw_client.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from ...core.client_wrapper import AsyncClientWrapper + + +class RawLocationProfilesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + +class AsyncRawLocationProfilesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper diff --git a/src/square/bookings/raw_client.py b/src/square/bookings/raw_client.py new file mode 100644 index 00000000..c1cd027a --- /dev/null +++ b/src/square/bookings/raw_client.py @@ -0,0 +1,961 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.booking import BookingParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_booking_response import CreateBookingResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.search_availability_query import SearchAvailabilityQueryParams +from ..types.search_availability_response import SearchAvailabilityResponse +from ..types.bulk_retrieve_bookings_response import BulkRetrieveBookingsResponse +from ..types.get_business_booking_profile_response import GetBusinessBookingProfileResponse +from ..types.retrieve_location_booking_profile_response import RetrieveLocationBookingProfileResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.bulk_retrieve_team_member_booking_profiles_response import BulkRetrieveTeamMemberBookingProfilesResponse +from ..types.get_booking_response import GetBookingResponse +from ..types.update_booking_response import UpdateBookingResponse +from ..types.cancel_booking_response import CancelBookingResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawBookingsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateBookingResponse]: + """ + Creates a booking. + + The required input must include the following: + - `Booking.location_id` + - `Booking.start_at` + - `Booking.AppointmentSegment.team_member_id` + - `Booking.AppointmentSegment.service_variation_id` + - `Booking.AppointmentSegment.service_variation_version` + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking : BookingParams + The details of the booking to be created. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateBookingResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings", + method="POST", + json={ + "idempotency_key": idempotency_key, + "booking": convert_and_respect_annotation_metadata( + object_=booking, annotation=BookingParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateBookingResponse, + construct_type( + type_=CreateBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search_availability( + self, *, query: SearchAvailabilityQueryParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[SearchAvailabilityResponse]: + """ + Searches for availabilities for booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + query : SearchAvailabilityQueryParams + Query conditions used to filter buyer-accessible booking availabilities. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchAvailabilityResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/availability/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchAvailabilityQueryParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchAvailabilityResponse, + construct_type( + type_=SearchAvailabilityResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def bulk_retrieve_bookings( + self, *, booking_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[BulkRetrieveBookingsResponse]: + """ + Bulk-Retrieves a list of bookings by booking IDs. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_ids : typing.Sequence[str] + A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkRetrieveBookingsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/bulk-retrieve", + method="POST", + json={ + "booking_ids": booking_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkRetrieveBookingsResponse, + construct_type( + type_=BulkRetrieveBookingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_business_profile( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetBusinessBookingProfileResponse]: + """ + Retrieves a seller's booking profile. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetBusinessBookingProfileResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/business-booking-profile", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBusinessBookingProfileResponse, + construct_type( + type_=GetBusinessBookingProfileResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def retrieve_location_booking_profile( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveLocationBookingProfileResponse]: + """ + Retrieves a seller's location booking profile. + + Parameters + ---------- + location_id : str + The ID of the location to retrieve the booking profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveLocationBookingProfileResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/location-booking-profiles/{jsonable_encoder(location_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationBookingProfileResponse, + construct_type( + type_=RetrieveLocationBookingProfileResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def bulk_retrieve_team_member_booking_profiles( + self, *, team_member_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[BulkRetrieveTeamMemberBookingProfilesResponse]: + """ + Retrieves one or more team members' booking profiles. + + Parameters + ---------- + team_member_ids : typing.Sequence[str] + A non-empty list of IDs of team members whose booking profiles you want to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkRetrieveTeamMemberBookingProfilesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/bookings/team-member-booking-profiles/bulk-retrieve", + method="POST", + json={ + "team_member_ids": team_member_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkRetrieveTeamMemberBookingProfilesResponse, + construct_type( + type_=BulkRetrieveTeamMemberBookingProfilesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, booking_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetBookingResponse]: + """ + Retrieves a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetBookingResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBookingResponse, + construct_type( + type_=GetBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + booking_id: str, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateBookingResponse]: + """ + Updates a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-updated booking. + + booking : BookingParams + The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateBookingResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}", + method="PUT", + json={ + "idempotency_key": idempotency_key, + "booking": convert_and_respect_annotation_metadata( + object_=booking, annotation=BookingParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateBookingResponse, + construct_type( + type_=UpdateBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, + booking_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + booking_version: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CancelBookingResponse]: + """ + Cancels an existing booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + booking_version : typing.Optional[int] + The revision number for the booking used for optimistic concurrency. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelBookingResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/cancel", + method="POST", + json={ + "idempotency_key": idempotency_key, + "booking_version": booking_version, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelBookingResponse, + construct_type( + type_=CancelBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawBookingsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateBookingResponse]: + """ + Creates a booking. + + The required input must include the following: + - `Booking.location_id` + - `Booking.start_at` + - `Booking.AppointmentSegment.team_member_id` + - `Booking.AppointmentSegment.service_variation_id` + - `Booking.AppointmentSegment.service_variation_version` + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking : BookingParams + The details of the booking to be created. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateBookingResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings", + method="POST", + json={ + "idempotency_key": idempotency_key, + "booking": convert_and_respect_annotation_metadata( + object_=booking, annotation=BookingParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateBookingResponse, + construct_type( + type_=CreateBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search_availability( + self, *, query: SearchAvailabilityQueryParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[SearchAvailabilityResponse]: + """ + Searches for availabilities for booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + query : SearchAvailabilityQueryParams + Query conditions used to filter buyer-accessible booking availabilities. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchAvailabilityResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/availability/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchAvailabilityQueryParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchAvailabilityResponse, + construct_type( + type_=SearchAvailabilityResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def bulk_retrieve_bookings( + self, *, booking_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[BulkRetrieveBookingsResponse]: + """ + Bulk-Retrieves a list of bookings by booking IDs. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_ids : typing.Sequence[str] + A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkRetrieveBookingsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/bulk-retrieve", + method="POST", + json={ + "booking_ids": booking_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkRetrieveBookingsResponse, + construct_type( + type_=BulkRetrieveBookingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_business_profile( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetBusinessBookingProfileResponse]: + """ + Retrieves a seller's booking profile. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetBusinessBookingProfileResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/business-booking-profile", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBusinessBookingProfileResponse, + construct_type( + type_=GetBusinessBookingProfileResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def retrieve_location_booking_profile( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveLocationBookingProfileResponse]: + """ + Retrieves a seller's location booking profile. + + Parameters + ---------- + location_id : str + The ID of the location to retrieve the booking profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveLocationBookingProfileResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/location-booking-profiles/{jsonable_encoder(location_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationBookingProfileResponse, + construct_type( + type_=RetrieveLocationBookingProfileResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def bulk_retrieve_team_member_booking_profiles( + self, *, team_member_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[BulkRetrieveTeamMemberBookingProfilesResponse]: + """ + Retrieves one or more team members' booking profiles. + + Parameters + ---------- + team_member_ids : typing.Sequence[str] + A non-empty list of IDs of team members whose booking profiles you want to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkRetrieveTeamMemberBookingProfilesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/bookings/team-member-booking-profiles/bulk-retrieve", + method="POST", + json={ + "team_member_ids": team_member_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkRetrieveTeamMemberBookingProfilesResponse, + construct_type( + type_=BulkRetrieveTeamMemberBookingProfilesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, booking_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetBookingResponse]: + """ + Retrieves a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetBookingResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBookingResponse, + construct_type( + type_=GetBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + booking_id: str, + *, + booking: BookingParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateBookingResponse]: + """ + Updates a booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-updated booking. + + booking : BookingParams + The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateBookingResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}", + method="PUT", + json={ + "idempotency_key": idempotency_key, + "booking": convert_and_respect_annotation_metadata( + object_=booking, annotation=BookingParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateBookingResponse, + construct_type( + type_=UpdateBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, + booking_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + booking_version: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CancelBookingResponse]: + """ + Cancels an existing booking. + + To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. + To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. + + For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* + or *Appointments Premium*. + + Parameters + ---------- + booking_id : str + The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking. + + idempotency_key : typing.Optional[str] + A unique key to make this request an idempotent operation. + + booking_version : typing.Optional[int] + The revision number for the booking used for optimistic concurrency. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelBookingResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/{jsonable_encoder(booking_id)}/cancel", + method="POST", + json={ + "idempotency_key": idempotency_key, + "booking_version": booking_version, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelBookingResponse, + construct_type( + type_=CancelBookingResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/bookings/team_member_profiles/__init__.py b/src/square/bookings/team_member_profiles/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/bookings/team_member_profiles/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/bookings/team_member_profiles/client.py b/src/square/bookings/team_member_profiles/client.py new file mode 100644 index 00000000..64328e88 --- /dev/null +++ b/src/square/bookings/team_member_profiles/client.py @@ -0,0 +1,298 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawTeamMemberProfilesClient +import typing +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.team_member_booking_profile import TeamMemberBookingProfile +from ...types.list_team_member_booking_profiles_response import ListTeamMemberBookingProfilesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_team_member_booking_profile_response import GetTeamMemberBookingProfileResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawTeamMemberProfilesClient +from ...core.pagination import AsyncPager + + +class TeamMemberProfilesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTeamMemberProfilesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTeamMemberProfilesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTeamMemberProfilesClient + """ + return self._raw_client + + def list( + self, + *, + bookable_only: typing.Optional[bool] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[TeamMemberBookingProfile]: + """ + Lists booking profiles for team members. + + Parameters + ---------- + bookable_only : typing.Optional[bool] + Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + + limit : typing.Optional[int] + The maximum number of results to return in a paged response. + + cursor : typing.Optional[str] + The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + + location_id : typing.Optional[str] + Indicates whether to include only team members enabled at the given location in the returned result. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[TeamMemberBookingProfile] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.bookings.team_member_profiles.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings/team-member-booking-profiles", + method="GET", + params={ + "bookable_only": bookable_only, + "limit": limit, + "cursor": cursor, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListTeamMemberBookingProfilesResponse, + construct_type( + type_=ListTeamMemberBookingProfilesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + bookable_only=bookable_only, + limit=limit, + cursor=_parsed_next, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.team_member_booking_profiles + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTeamMemberBookingProfileResponse: + """ + Retrieves a team member's booking profile. + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTeamMemberBookingProfileResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.bookings.team_member_profiles.get( + team_member_id="team_member_id", + ) + """ + response = self._raw_client.get(team_member_id, request_options=request_options) + return response.data + + +class AsyncTeamMemberProfilesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTeamMemberProfilesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTeamMemberProfilesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTeamMemberProfilesClient + """ + return self._raw_client + + async def list( + self, + *, + bookable_only: typing.Optional[bool] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[TeamMemberBookingProfile]: + """ + Lists booking profiles for team members. + + Parameters + ---------- + bookable_only : typing.Optional[bool] + Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + + limit : typing.Optional[int] + The maximum number of results to return in a paged response. + + cursor : typing.Optional[str] + The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. + + location_id : typing.Optional[str] + Indicates whether to include only team members enabled at the given location in the returned result. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[TeamMemberBookingProfile] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.bookings.team_member_profiles.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/bookings/team-member-booking-profiles", + method="GET", + params={ + "bookable_only": bookable_only, + "limit": limit, + "cursor": cursor, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListTeamMemberBookingProfilesResponse, + construct_type( + type_=ListTeamMemberBookingProfilesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + bookable_only=bookable_only, + limit=limit, + cursor=_parsed_next, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.team_member_booking_profiles + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTeamMemberBookingProfileResponse: + """ + Retrieves a team member's booking profile. + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTeamMemberBookingProfileResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.bookings.team_member_profiles.get( + team_member_id="team_member_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(team_member_id, request_options=request_options) + return response.data diff --git a/src/square/bookings/team_member_profiles/raw_client.py b/src/square/bookings/team_member_profiles/raw_client.py new file mode 100644 index 00000000..5c127ca7 --- /dev/null +++ b/src/square/bookings/team_member_profiles/raw_client.py @@ -0,0 +1,101 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_team_member_booking_profile_response import GetTeamMemberBookingProfileResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawTeamMemberProfilesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTeamMemberBookingProfileResponse]: + """ + Retrieves a team member's booking profile. + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTeamMemberBookingProfileResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/bookings/team-member-booking-profiles/{jsonable_encoder(team_member_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTeamMemberBookingProfileResponse, + construct_type( + type_=GetTeamMemberBookingProfileResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawTeamMemberProfilesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTeamMemberBookingProfileResponse]: + """ + Retrieves a team member's booking profile. + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTeamMemberBookingProfileResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/bookings/team-member-booking-profiles/{jsonable_encoder(team_member_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTeamMemberBookingProfileResponse, + construct_type( + type_=GetTeamMemberBookingProfileResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/cards/__init__.py b/src/square/cards/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/cards/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/cards/client.py b/src/square/cards/client.py new file mode 100644 index 00000000..27502298 --- /dev/null +++ b/src/square/cards/client.py @@ -0,0 +1,563 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawCardsClient +from ..types.sort_order import SortOrder +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.card import Card +from ..types.list_cards_response import ListCardsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.card import CardParams +from ..types.create_card_response import CreateCardResponse +from ..types.get_card_response import GetCardResponse +from ..types.disable_card_response import DisableCardResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCardsClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCardsClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + customer_id: typing.Optional[str] = None, + include_disabled: typing.Optional[bool] = None, + reference_id: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Card]: + """ + Retrieves a list of cards owned by the account making the request. + A max of 25 cards will be returned. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + customer_id : typing.Optional[str] + Limit results to cards associated with the customer supplied. + By default, all cards owned by the merchant are returned. + + include_disabled : typing.Optional[bool] + Includes disabled cards. + By default, all enabled cards owned by the merchant are returned. + + reference_id : typing.Optional[str] + Limit results to cards associated with the reference_id supplied. + + sort_order : typing.Optional[SortOrder] + Sorts the returned list by when the card was created with the specified order. + This field defaults to ASC. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Card] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.cards.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/cards", + method="GET", + params={ + "cursor": cursor, + "customer_id": customer_id, + "include_disabled": include_disabled, + "reference_id": reference_id, + "sort_order": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCardsResponse, + construct_type( + type_=ListCardsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + customer_id=customer_id, + include_disabled=include_disabled, + reference_id=reference_id, + sort_order=sort_order, + request_options=request_options, + ) + _items = _parsed_response.cards + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: str, + source_id: str, + card: CardParams, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCardResponse: + """ + Adds a card on file to an existing merchant. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateCard request. Keys can be + any valid string and must be unique for every request. + + Max: 45 characters + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + source_id : str + The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. + + card : CardParams + Payment details associated with the card to be stored. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.cards.create( + idempotency_key="4935a656-a929-4792-b97c-8848be85c27c", + source_id="cnon:uIbfJXhXETSP197M3GB", + card={ + "cardholder_name": "Amelia Earhart", + "billing_address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "reference_id": "user-id-1", + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, + source_id=source_id, + card=card, + verification_token=verification_token, + request_options=request_options, + ) + return response.data + + def get(self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetCardResponse: + """ + Retrieves details for a specific Card. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.cards.get( + card_id="card_id", + ) + """ + response = self._raw_client.get(card_id, request_options=request_options) + return response.data + + def disable(self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DisableCardResponse: + """ + Disables the card, preventing any further updates or charges. + Disabling an already disabled card is allowed but has no effect. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DisableCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.cards.disable( + card_id="card_id", + ) + """ + response = self._raw_client.disable(card_id, request_options=request_options) + return response.data + + +class AsyncCardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCardsClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + customer_id: typing.Optional[str] = None, + include_disabled: typing.Optional[bool] = None, + reference_id: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Card]: + """ + Retrieves a list of cards owned by the account making the request. + A max of 25 cards will be returned. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + customer_id : typing.Optional[str] + Limit results to cards associated with the customer supplied. + By default, all cards owned by the merchant are returned. + + include_disabled : typing.Optional[bool] + Includes disabled cards. + By default, all enabled cards owned by the merchant are returned. + + reference_id : typing.Optional[str] + Limit results to cards associated with the reference_id supplied. + + sort_order : typing.Optional[SortOrder] + Sorts the returned list by when the card was created with the specified order. + This field defaults to ASC. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Card] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.cards.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/cards", + method="GET", + params={ + "cursor": cursor, + "customer_id": customer_id, + "include_disabled": include_disabled, + "reference_id": reference_id, + "sort_order": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCardsResponse, + construct_type( + type_=ListCardsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + customer_id=customer_id, + include_disabled=include_disabled, + reference_id=reference_id, + sort_order=sort_order, + request_options=request_options, + ) + _items = _parsed_response.cards + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: str, + source_id: str, + card: CardParams, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCardResponse: + """ + Adds a card on file to an existing merchant. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateCard request. Keys can be + any valid string and must be unique for every request. + + Max: 45 characters + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + source_id : str + The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. + + card : CardParams + Payment details associated with the card to be stored. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.cards.create( + idempotency_key="4935a656-a929-4792-b97c-8848be85c27c", + source_id="cnon:uIbfJXhXETSP197M3GB", + card={ + "cardholder_name": "Amelia Earhart", + "billing_address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", + "reference_id": "user-id-1", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, + source_id=source_id, + card=card, + verification_token=verification_token, + request_options=request_options, + ) + return response.data + + async def get(self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetCardResponse: + """ + Retrieves details for a specific Card. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.cards.get( + card_id="card_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(card_id, request_options=request_options) + return response.data + + async def disable( + self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DisableCardResponse: + """ + Disables the card, preventing any further updates or charges. + Disabling an already disabled card is allowed but has no effect. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DisableCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.cards.disable( + card_id="card_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.disable(card_id, request_options=request_options) + return response.data diff --git a/src/square/cards/raw_client.py b/src/square/cards/raw_client.py new file mode 100644 index 00000000..50b5ac26 --- /dev/null +++ b/src/square/cards/raw_client.py @@ -0,0 +1,334 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.card import CardParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_card_response import CreateCardResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_card_response import GetCardResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.disable_card_response import DisableCardResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + source_id: str, + card: CardParams, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCardResponse]: + """ + Adds a card on file to an existing merchant. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateCard request. Keys can be + any valid string and must be unique for every request. + + Max: 45 characters + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + source_id : str + The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. + + card : CardParams + Payment details associated with the card to be stored. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/cards", + method="POST", + json={ + "idempotency_key": idempotency_key, + "source_id": source_id, + "verification_token": verification_token, + "card": convert_and_respect_annotation_metadata(object_=card, annotation=CardParams, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCardResponse, + construct_type( + type_=CreateCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetCardResponse]: + """ + Retrieves details for a specific Card. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/cards/{jsonable_encoder(card_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCardResponse, + construct_type( + type_=GetCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def disable( + self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DisableCardResponse]: + """ + Disables the card, preventing any further updates or charges. + Disabling an already disabled card is allowed but has no effect. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DisableCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/cards/{jsonable_encoder(card_id)}/disable", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DisableCardResponse, + construct_type( + type_=DisableCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + source_id: str, + card: CardParams, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCardResponse]: + """ + Adds a card on file to an existing merchant. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateCard request. Keys can be + any valid string and must be unique for every request. + + Max: 45 characters + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + source_id : str + The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. + + card : CardParams + Payment details associated with the card to be stored. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/cards", + method="POST", + json={ + "idempotency_key": idempotency_key, + "source_id": source_id, + "verification_token": verification_token, + "card": convert_and_respect_annotation_metadata(object_=card, annotation=CardParams, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCardResponse, + construct_type( + type_=CreateCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetCardResponse]: + """ + Retrieves details for a specific Card. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/cards/{jsonable_encoder(card_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCardResponse, + construct_type( + type_=GetCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def disable( + self, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DisableCardResponse]: + """ + Disables the card, preventing any further updates or charges. + Disabling an already disabled card is allowed but has no effect. + + Parameters + ---------- + card_id : str + Unique ID for the desired Card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DisableCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/cards/{jsonable_encoder(card_id)}/disable", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DisableCardResponse, + construct_type( + type_=DisableCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/cash_drawers/__init__.py b/src/square/cash_drawers/__init__.py new file mode 100644 index 00000000..284e922e --- /dev/null +++ b/src/square/cash_drawers/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import shifts + +__all__ = ["shifts"] diff --git a/src/square/cash_drawers/client.py b/src/square/cash_drawers/client.py new file mode 100644 index 00000000..2f057c5c --- /dev/null +++ b/src/square/cash_drawers/client.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawCashDrawersClient +from .shifts.client import ShiftsClient +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCashDrawersClient +from .shifts.client import AsyncShiftsClient + + +class CashDrawersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCashDrawersClient(client_wrapper=client_wrapper) + self.shifts = ShiftsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCashDrawersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCashDrawersClient + """ + return self._raw_client + + +class AsyncCashDrawersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCashDrawersClient(client_wrapper=client_wrapper) + self.shifts = AsyncShiftsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCashDrawersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCashDrawersClient + """ + return self._raw_client diff --git a/src/square/cash_drawers/raw_client.py b/src/square/cash_drawers/raw_client.py new file mode 100644 index 00000000..04b334d5 --- /dev/null +++ b/src/square/cash_drawers/raw_client.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from ..core.client_wrapper import AsyncClientWrapper + + +class RawCashDrawersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + +class AsyncRawCashDrawersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper diff --git a/src/square/cash_drawers/shifts/__init__.py b/src/square/cash_drawers/shifts/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/cash_drawers/shifts/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/cash_drawers/shifts/client.py b/src/square/cash_drawers/shifts/client.py new file mode 100644 index 00000000..05dcdf70 --- /dev/null +++ b/src/square/cash_drawers/shifts/client.py @@ -0,0 +1,528 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawShiftsClient +import typing +from ...types.sort_order import SortOrder +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.cash_drawer_shift_summary import CashDrawerShiftSummary +from ...types.list_cash_drawer_shifts_response import ListCashDrawerShiftsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_cash_drawer_shift_response import GetCashDrawerShiftResponse +from ...types.cash_drawer_shift_event import CashDrawerShiftEvent +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_cash_drawer_shift_events_response import ListCashDrawerShiftEventsResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawShiftsClient +from ...core.pagination import AsyncPager + + +class ShiftsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawShiftsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawShiftsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawShiftsClient + """ + return self._raw_client + + def list( + self, + *, + location_id: str, + sort_order: typing.Optional[SortOrder] = None, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CashDrawerShiftSummary]: + """ + Provides the details for all of the cash drawer shifts for a location + in a date range. + + Parameters + ---------- + location_id : str + The ID of the location to query for a list of cash drawer shifts. + + sort_order : typing.Optional[SortOrder] + The order in which cash drawer shifts are listed in the response, + based on their opened_at field. Default value: ASC + + begin_time : typing.Optional[str] + The inclusive start time of the query on opened_at, in ISO 8601 format. + + end_time : typing.Optional[str] + The exclusive end date of the query on opened_at, in ISO 8601 format. + + limit : typing.Optional[int] + Number of cash drawer shift events in a page of results (200 by + default, 1000 max). + + cursor : typing.Optional[str] + Opaque cursor for fetching the next page of results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CashDrawerShiftSummary] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.cash_drawers.shifts.list( + location_id="location_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/cash-drawers/shifts", + method="GET", + params={ + "location_id": location_id, + "sort_order": sort_order, + "begin_time": begin_time, + "end_time": end_time, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCashDrawerShiftsResponse, + construct_type( + type_=ListCashDrawerShiftsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + sort_order=sort_order, + begin_time=begin_time, + end_time=end_time, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.cash_drawer_shifts + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, shift_id: str, *, location_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> GetCashDrawerShiftResponse: + """ + Provides the summary details for a single cash drawer shift. See + [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. + + Parameters + ---------- + shift_id : str + The shift ID. + + location_id : str + The ID of the location to retrieve cash drawer shifts from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCashDrawerShiftResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.cash_drawers.shifts.get( + shift_id="shift_id", + location_id="location_id", + ) + """ + response = self._raw_client.get(shift_id, location_id=location_id, request_options=request_options) + return response.data + + def list_events( + self, + shift_id: str, + *, + location_id: str, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CashDrawerShiftEvent]: + """ + Provides a paginated list of events for a single cash drawer shift. + + Parameters + ---------- + shift_id : str + The shift ID. + + location_id : str + The ID of the location to list cash drawer shifts for. + + limit : typing.Optional[int] + Number of resources to be returned in a page of results (200 by + default, 1000 max). + + cursor : typing.Optional[str] + Opaque cursor for fetching the next page of results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CashDrawerShiftEvent] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.cash_drawers.shifts.list_events( + shift_id="shift_id", + location_id="location_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/cash-drawers/shifts/{jsonable_encoder(shift_id)}/events", + method="GET", + params={ + "location_id": location_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCashDrawerShiftEventsResponse, + construct_type( + type_=ListCashDrawerShiftEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list_events( + shift_id, + location_id=location_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.cash_drawer_shift_events + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncShiftsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawShiftsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawShiftsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawShiftsClient + """ + return self._raw_client + + async def list( + self, + *, + location_id: str, + sort_order: typing.Optional[SortOrder] = None, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CashDrawerShiftSummary]: + """ + Provides the details for all of the cash drawer shifts for a location + in a date range. + + Parameters + ---------- + location_id : str + The ID of the location to query for a list of cash drawer shifts. + + sort_order : typing.Optional[SortOrder] + The order in which cash drawer shifts are listed in the response, + based on their opened_at field. Default value: ASC + + begin_time : typing.Optional[str] + The inclusive start time of the query on opened_at, in ISO 8601 format. + + end_time : typing.Optional[str] + The exclusive end date of the query on opened_at, in ISO 8601 format. + + limit : typing.Optional[int] + Number of cash drawer shift events in a page of results (200 by + default, 1000 max). + + cursor : typing.Optional[str] + Opaque cursor for fetching the next page of results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CashDrawerShiftSummary] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.cash_drawers.shifts.list( + location_id="location_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/cash-drawers/shifts", + method="GET", + params={ + "location_id": location_id, + "sort_order": sort_order, + "begin_time": begin_time, + "end_time": end_time, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCashDrawerShiftsResponse, + construct_type( + type_=ListCashDrawerShiftsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + sort_order=sort_order, + begin_time=begin_time, + end_time=end_time, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.cash_drawer_shifts + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, shift_id: str, *, location_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> GetCashDrawerShiftResponse: + """ + Provides the summary details for a single cash drawer shift. See + [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. + + Parameters + ---------- + shift_id : str + The shift ID. + + location_id : str + The ID of the location to retrieve cash drawer shifts from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCashDrawerShiftResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.cash_drawers.shifts.get( + shift_id="shift_id", + location_id="location_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(shift_id, location_id=location_id, request_options=request_options) + return response.data + + async def list_events( + self, + shift_id: str, + *, + location_id: str, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CashDrawerShiftEvent]: + """ + Provides a paginated list of events for a single cash drawer shift. + + Parameters + ---------- + shift_id : str + The shift ID. + + location_id : str + The ID of the location to list cash drawer shifts for. + + limit : typing.Optional[int] + Number of resources to be returned in a page of results (200 by + default, 1000 max). + + cursor : typing.Optional[str] + Opaque cursor for fetching the next page of results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CashDrawerShiftEvent] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.cash_drawers.shifts.list_events( + shift_id="shift_id", + location_id="location_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/cash-drawers/shifts/{jsonable_encoder(shift_id)}/events", + method="GET", + params={ + "location_id": location_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCashDrawerShiftEventsResponse, + construct_type( + type_=ListCashDrawerShiftEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list_events( + shift_id, + location_id=location_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.cash_drawer_shift_events + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/cash_drawers/shifts/raw_client.py b/src/square/cash_drawers/shifts/raw_client.py new file mode 100644 index 00000000..82391a83 --- /dev/null +++ b/src/square/cash_drawers/shifts/raw_client.py @@ -0,0 +1,115 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_cash_drawer_shift_response import GetCashDrawerShiftResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawShiftsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, shift_id: str, *, location_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetCashDrawerShiftResponse]: + """ + Provides the summary details for a single cash drawer shift. See + [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. + + Parameters + ---------- + shift_id : str + The shift ID. + + location_id : str + The ID of the location to retrieve cash drawer shifts from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCashDrawerShiftResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/cash-drawers/shifts/{jsonable_encoder(shift_id)}", + method="GET", + params={ + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCashDrawerShiftResponse, + construct_type( + type_=GetCashDrawerShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawShiftsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, shift_id: str, *, location_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetCashDrawerShiftResponse]: + """ + Provides the summary details for a single cash drawer shift. See + [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. + + Parameters + ---------- + shift_id : str + The shift ID. + + location_id : str + The ID of the location to retrieve cash drawer shifts from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCashDrawerShiftResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/cash-drawers/shifts/{jsonable_encoder(shift_id)}", + method="GET", + params={ + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCashDrawerShiftResponse, + construct_type( + type_=GetCashDrawerShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/catalog/__init__.py b/src/square/catalog/__init__.py new file mode 100644 index 00000000..cc665ef2 --- /dev/null +++ b/src/square/catalog/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import images, object + +__all__ = ["images", "object"] diff --git a/src/square/catalog/client.py b/src/square/catalog/client.py new file mode 100644 index 00000000..ef1eb13b --- /dev/null +++ b/src/square/catalog/client.py @@ -0,0 +1,1605 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawCatalogClient +from .images.client import ImagesClient +from .object.client import ObjectClient +from ..core.request_options import RequestOptions +from ..types.batch_delete_catalog_objects_response import BatchDeleteCatalogObjectsResponse +from ..types.batch_get_catalog_objects_response import BatchGetCatalogObjectsResponse +from ..requests.catalog_object_batch import CatalogObjectBatchParams +from ..types.batch_upsert_catalog_objects_response import BatchUpsertCatalogObjectsResponse +from ..types.catalog_info_response import CatalogInfoResponse +from ..core.pagination import SyncPager +from ..types.catalog_object import CatalogObject +from ..types.list_catalog_response import ListCatalogResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.catalog_object_type import CatalogObjectType +from ..requests.catalog_query import CatalogQueryParams +from ..types.search_catalog_objects_response import SearchCatalogObjectsResponse +from ..types.search_catalog_items_request_stock_level import SearchCatalogItemsRequestStockLevel +from ..types.sort_order import SortOrder +from ..types.catalog_item_product_type import CatalogItemProductType +from ..requests.custom_attribute_filter import CustomAttributeFilterParams +from ..types.archived_state import ArchivedState +from ..types.search_catalog_items_response import SearchCatalogItemsResponse +from ..types.update_item_modifier_lists_response import UpdateItemModifierListsResponse +from ..types.update_item_taxes_response import UpdateItemTaxesResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCatalogClient +from .images.client import AsyncImagesClient +from .object.client import AsyncObjectClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CatalogClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCatalogClient(client_wrapper=client_wrapper) + self.images = ImagesClient(client_wrapper=client_wrapper) + + self.object = ObjectClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCatalogClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCatalogClient + """ + return self._raw_client + + def batch_delete( + self, *, object_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BatchDeleteCatalogObjectsResponse: + """ + Deletes a set of [CatalogItem](entity:CatalogItem)s based on the + provided list of target IDs and returns a set of successfully deleted IDs in + the response. Deletion is a cascading event such that all children of the + targeted object are also deleted. For example, deleting a CatalogItem will + also delete all of its [CatalogItemVariation](entity:CatalogItemVariation) + children. + + `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted + IDs can be deleted. The response will only include IDs that were + actually deleted. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects + in the graph that depend on that object will be deleted as well (for example, deleting a + CatalogItem will delete its CatalogItemVariation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchDeleteCatalogObjectsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.batch_delete( + object_ids=["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"], + ) + """ + response = self._raw_client.batch_delete(object_ids=object_ids, request_options=request_options) + return response.data + + def batch_get( + self, + *, + object_ids: typing.Sequence[str], + include_related_objects: typing.Optional[bool] = OMIT, + catalog_version: typing.Optional[int] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetCatalogObjectsResponse: + """ + Returns a set of objects based on the provided ID. + Each [CatalogItem](entity:CatalogItem) returned in the set includes all of its + child information including: all of its + [CatalogItemVariation](entity:CatalogItemVariation) objects, references to + its [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + The specific version of the catalog objects to be included in the response. + This allows you to retrieve historical versions of objects. The specified version value is matched against + the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will + be from the current version of the catalog. + + include_deleted_objects : typing.Optional[bool] + Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetCatalogObjectsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.batch_get( + object_ids=["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"], + include_related_objects=True, + ) + """ + response = self._raw_client.batch_get( + object_ids=object_ids, + include_related_objects=include_related_objects, + catalog_version=catalog_version, + include_deleted_objects=include_deleted_objects, + include_category_path_to_root=include_category_path_to_root, + request_options=request_options, + ) + return response.data + + def batch_upsert( + self, + *, + idempotency_key: str, + batches: typing.Sequence[CatalogObjectBatchParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpsertCatalogObjectsResponse: + """ + Creates or updates up to 10,000 target objects based on the provided + list of objects. The target objects are grouped into batches and each batch is + inserted/updated in an all-or-nothing manner. If an object within a batch is + malformed in some way, or violates a database constraint, the entire batch + containing that item will be disregarded. However, other batches in the same + request may still succeed. Each batch may contain up to 1,000 objects, and + batches will be processed in order as long as the total object count for the + request (items, variations, modifier lists, discounts, and taxes) is no more + than 10,000. + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + batches : typing.Sequence[CatalogObjectBatchParams] + A batch of CatalogObjects to be inserted/updated atomically. + The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs + attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error + in one batch will not affect other batches within the same request. + + For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its + `is_deleted` field must not be set to `true`. + + To modify an existing object, supply its ID. To create a new object, use an ID starting + with `#`. These IDs may be used to create relationships between an object and attributes of + other objects that reference it. For example, you can create a CatalogItem with + ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to + `#ABC` in order to associate the CatalogItemVariation with its parent + CatalogItem. + + Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. + + Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request + may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will + be inserted or updated. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpsertCatalogObjectsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.batch_upsert( + idempotency_key="789ff020-f723-43a9-b4b5-43b5dc1fa3dc", + batches=[ + { + "objects": [ + { + "type": "ITEM", + "id": "#Tea", + "present_at_all_locations": True, + }, + { + "type": "ITEM", + "id": "#Coffee", + "present_at_all_locations": True, + }, + { + "type": "CATEGORY", + "id": "#Beverages", + "present_at_all_locations": True, + }, + { + "type": "TAX", + "id": "#SalesTax", + "present_at_all_locations": True, + "tax_data": { + "name": "Sales Tax", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "5.0", + "applies_to_custom_amounts": True, + "enabled": True, + }, + }, + ] + } + ], + ) + """ + response = self._raw_client.batch_upsert( + idempotency_key=idempotency_key, batches=batches, request_options=request_options + ) + return response.data + + def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> CatalogInfoResponse: + """ + Retrieves information about the Square Catalog API, such as batch size + limits that can be used by the `BatchUpsertCatalogObjects` endpoint. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CatalogInfoResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.info() + """ + response = self._raw_client.info(request_options=request_options) + return response.data + + def list( + self, + *, + cursor: typing.Optional[str] = None, + types: typing.Optional[str] = None, + catalog_version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CatalogObject]: + """ + Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified types in the catalog. + + The `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values, + for example, "`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`". + + __Important:__ ListCatalog does not return deleted catalog items. To retrieve + deleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + and set the `include_deleted_objects` attribute value to `true`. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned in the previous response. Leave unset for an initial request. + The page size is currently set to be 100. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + types : typing.Optional[str] + An optional case-insensitive, comma-separated list of object types to retrieve. + + The valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example, + `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, + `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. + + If this is unspecified, the operation returns objects of all the top level types at the version + of the Square API used to make the request. Object types that are nested onto other object types + are not included in the defaults. + + At the current API version the default object types are: + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + + catalog_version : typing.Optional[int] + The specific version of the catalog objects to be included in the response. + This allows you to retrieve historical versions of objects. The specified version value is matched against + the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the + current version of the catalog. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CatalogObject] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.catalog.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/catalog/list", + method="GET", + params={ + "cursor": cursor, + "types": types, + "catalog_version": catalog_version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCatalogResponse, + construct_type( + type_=ListCatalogResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + types=types, + catalog_version=catalog_version, + request_options=request_options, + ) + _items = _parsed_response.objects + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + object_types: typing.Optional[typing.Sequence[CatalogObjectType]] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_related_objects: typing.Optional[bool] = OMIT, + begin_time: typing.Optional[str] = OMIT, + query: typing.Optional[CatalogQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchCatalogObjectsResponse: + """ + Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values, + excluding custom attribute values on items or item variations, against one or more of the specified query filters. + + This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints have different call conventions, including the query filter formats. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned in the previous response. Leave unset for an initial request. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + object_types : typing.Optional[typing.Sequence[CatalogObjectType]] + The desired set of object types to appear in the search results. + + If this is unspecified, the operation returns objects of all the top level types at the version + of the Square API used to make the request. Object types that are nested onto other object types + are not included in the defaults. + + At the current API version the default object types are: + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + + Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, + ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest + in this field. + + include_deleted_objects : typing.Optional[bool] + If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are objects that are referenced by object ID by the objects + in the response. This is helpful if the objects are being fetched for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. + For example: + + If the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + begin_time : typing.Optional[str] + Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 + format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a + timestamp equal to `begin_time` will not be included in the response. + + query : typing.Optional[CatalogQueryParams] + A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. + + limit : typing.Optional[int] + A limit on the number of results to be returned in a single page. The limit is advisory - + the implementation may return more or fewer results. If the supplied limit is negative, zero, or + is higher than the maximum limit of 1,000, it will be ignored. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchCatalogObjectsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.search( + object_types=["ITEM"], + query={ + "prefix_query": {"attribute_name": "name", "attribute_prefix": "tea"} + }, + limit=100, + ) + """ + response = self._raw_client.search( + cursor=cursor, + object_types=object_types, + include_deleted_objects=include_deleted_objects, + include_related_objects=include_related_objects, + begin_time=begin_time, + query=query, + limit=limit, + include_category_path_to_root=include_category_path_to_root, + request_options=request_options, + ) + return response.data + + def search_items( + self, + *, + text_filter: typing.Optional[str] = OMIT, + category_ids: typing.Optional[typing.Sequence[str]] = OMIT, + stock_levels: typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] = OMIT, + enabled_location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + sort_order: typing.Optional[SortOrder] = OMIT, + product_types: typing.Optional[typing.Sequence[CatalogItemProductType]] = OMIT, + custom_attribute_filters: typing.Optional[typing.Sequence[CustomAttributeFilterParams]] = OMIT, + archived_state: typing.Optional[ArchivedState] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchCatalogItemsResponse: + """ + Searches for catalog items or item variations by matching supported search attribute values, including + custom attribute values, against one or more of the specified query filters. + + This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints use different call conventions, including the query filter formats. + + Parameters + ---------- + text_filter : typing.Optional[str] + The text filter expression to return items or item variations containing specified text in + the `name`, `description`, or `abbreviation` attribute value of an item, or in + the `name`, `sku`, or `upc` attribute value of an item variation. + + category_ids : typing.Optional[typing.Sequence[str]] + The category id query expression to return items containing the specified category IDs. + + stock_levels : typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] + The stock-level query expression to return item variations with the specified stock levels. + See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values + + enabled_location_ids : typing.Optional[typing.Sequence[str]] + The enabled-location query expression to return items and item variations having specified enabled locations. + + cursor : typing.Optional[str] + The pagination token, returned in the previous response, used to fetch the next batch of pending results. + + limit : typing.Optional[int] + The maximum number of results to return per page. The default value is 100. + + sort_order : typing.Optional[SortOrder] + The order to sort the results by item names. The default sort order is ascending (`ASC`). + See [SortOrder](#type-sortorder) for possible values + + product_types : typing.Optional[typing.Sequence[CatalogItemProductType]] + The product types query expression to return items or item variations having the specified product types. + + custom_attribute_filters : typing.Optional[typing.Sequence[CustomAttributeFilterParams]] + The customer-attribute filter to return items or item variations matching the specified + custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in + a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + + archived_state : typing.Optional[ArchivedState] + The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchCatalogItemsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.search_items( + text_filter="red", + category_ids=["WINE_CATEGORY_ID"], + stock_levels=["OUT", "LOW"], + enabled_location_ids=["ATL_LOCATION_ID"], + limit=100, + sort_order="ASC", + product_types=["REGULAR"], + custom_attribute_filters=[ + { + "custom_attribute_definition_id": "VEGAN_DEFINITION_ID", + "bool_filter": True, + }, + { + "custom_attribute_definition_id": "BRAND_DEFINITION_ID", + "string_filter": "Dark Horse", + }, + {"key": "VINTAGE", "number_filter": {"min": "min", "max": "max"}}, + {"custom_attribute_definition_id": "VARIETAL_DEFINITION_ID"}, + ], + ) + """ + response = self._raw_client.search_items( + text_filter=text_filter, + category_ids=category_ids, + stock_levels=stock_levels, + enabled_location_ids=enabled_location_ids, + cursor=cursor, + limit=limit, + sort_order=sort_order, + product_types=product_types, + custom_attribute_filters=custom_attribute_filters, + archived_state=archived_state, + request_options=request_options, + ) + return response.data + + def update_item_modifier_lists( + self, + *, + item_ids: typing.Sequence[str], + modifier_lists_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + modifier_lists_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateItemModifierListsResponse: + """ + Updates the [CatalogModifierList](entity:CatalogModifierList) objects + that apply to the targeted [CatalogItem](entity:CatalogItem) without having + to perform an upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + The IDs of the catalog items associated with the CatalogModifierList objects being updated. + + modifier_lists_to_enable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to enable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + modifier_lists_to_disable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to disable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateItemModifierListsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.update_item_modifier_lists( + item_ids=["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"], + modifier_lists_to_enable=[ + "H42BRLUJ5KTZTTMPVSLFAACQ", + "2JXOBJIHCWBQ4NZ3RIXQGJA6", + ], + modifier_lists_to_disable=["7WRC16CJZDVLSNDQ35PP6YAD"], + ) + """ + response = self._raw_client.update_item_modifier_lists( + item_ids=item_ids, + modifier_lists_to_enable=modifier_lists_to_enable, + modifier_lists_to_disable=modifier_lists_to_disable, + request_options=request_options, + ) + return response.data + + def update_item_taxes( + self, + *, + item_ids: typing.Sequence[str], + taxes_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + taxes_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateItemTaxesResponse: + """ + Updates the [CatalogTax](entity:CatalogTax) objects that apply to the + targeted [CatalogItem](entity:CatalogItem) without having to perform an + upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + IDs for the CatalogItems associated with the CatalogTax objects being updated. + No more than 1,000 IDs may be provided. + + taxes_to_enable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to enable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + taxes_to_disable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to disable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateItemTaxesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.update_item_taxes( + item_ids=["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"], + taxes_to_enable=["4WRCNHCJZDVLSNDQ35PP6YAD"], + taxes_to_disable=["AQCEGCEBBQONINDOHRGZISEX"], + ) + """ + response = self._raw_client.update_item_taxes( + item_ids=item_ids, + taxes_to_enable=taxes_to_enable, + taxes_to_disable=taxes_to_disable, + request_options=request_options, + ) + return response.data + + +class AsyncCatalogClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCatalogClient(client_wrapper=client_wrapper) + self.images = AsyncImagesClient(client_wrapper=client_wrapper) + + self.object = AsyncObjectClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCatalogClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCatalogClient + """ + return self._raw_client + + async def batch_delete( + self, *, object_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BatchDeleteCatalogObjectsResponse: + """ + Deletes a set of [CatalogItem](entity:CatalogItem)s based on the + provided list of target IDs and returns a set of successfully deleted IDs in + the response. Deletion is a cascading event such that all children of the + targeted object are also deleted. For example, deleting a CatalogItem will + also delete all of its [CatalogItemVariation](entity:CatalogItemVariation) + children. + + `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted + IDs can be deleted. The response will only include IDs that were + actually deleted. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects + in the graph that depend on that object will be deleted as well (for example, deleting a + CatalogItem will delete its CatalogItemVariation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchDeleteCatalogObjectsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.batch_delete( + object_ids=["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_delete(object_ids=object_ids, request_options=request_options) + return response.data + + async def batch_get( + self, + *, + object_ids: typing.Sequence[str], + include_related_objects: typing.Optional[bool] = OMIT, + catalog_version: typing.Optional[int] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetCatalogObjectsResponse: + """ + Returns a set of objects based on the provided ID. + Each [CatalogItem](entity:CatalogItem) returned in the set includes all of its + child information including: all of its + [CatalogItemVariation](entity:CatalogItemVariation) objects, references to + its [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + The specific version of the catalog objects to be included in the response. + This allows you to retrieve historical versions of objects. The specified version value is matched against + the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will + be from the current version of the catalog. + + include_deleted_objects : typing.Optional[bool] + Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetCatalogObjectsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.batch_get( + object_ids=["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"], + include_related_objects=True, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_get( + object_ids=object_ids, + include_related_objects=include_related_objects, + catalog_version=catalog_version, + include_deleted_objects=include_deleted_objects, + include_category_path_to_root=include_category_path_to_root, + request_options=request_options, + ) + return response.data + + async def batch_upsert( + self, + *, + idempotency_key: str, + batches: typing.Sequence[CatalogObjectBatchParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpsertCatalogObjectsResponse: + """ + Creates or updates up to 10,000 target objects based on the provided + list of objects. The target objects are grouped into batches and each batch is + inserted/updated in an all-or-nothing manner. If an object within a batch is + malformed in some way, or violates a database constraint, the entire batch + containing that item will be disregarded. However, other batches in the same + request may still succeed. Each batch may contain up to 1,000 objects, and + batches will be processed in order as long as the total object count for the + request (items, variations, modifier lists, discounts, and taxes) is no more + than 10,000. + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + batches : typing.Sequence[CatalogObjectBatchParams] + A batch of CatalogObjects to be inserted/updated atomically. + The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs + attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error + in one batch will not affect other batches within the same request. + + For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its + `is_deleted` field must not be set to `true`. + + To modify an existing object, supply its ID. To create a new object, use an ID starting + with `#`. These IDs may be used to create relationships between an object and attributes of + other objects that reference it. For example, you can create a CatalogItem with + ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to + `#ABC` in order to associate the CatalogItemVariation with its parent + CatalogItem. + + Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. + + Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request + may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will + be inserted or updated. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpsertCatalogObjectsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.batch_upsert( + idempotency_key="789ff020-f723-43a9-b4b5-43b5dc1fa3dc", + batches=[ + { + "objects": [ + { + "type": "ITEM", + "id": "#Tea", + "present_at_all_locations": True, + }, + { + "type": "ITEM", + "id": "#Coffee", + "present_at_all_locations": True, + }, + { + "type": "CATEGORY", + "id": "#Beverages", + "present_at_all_locations": True, + }, + { + "type": "TAX", + "id": "#SalesTax", + "present_at_all_locations": True, + "tax_data": { + "name": "Sales Tax", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "5.0", + "applies_to_custom_amounts": True, + "enabled": True, + }, + }, + ] + } + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_upsert( + idempotency_key=idempotency_key, batches=batches, request_options=request_options + ) + return response.data + + async def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> CatalogInfoResponse: + """ + Retrieves information about the Square Catalog API, such as batch size + limits that can be used by the `BatchUpsertCatalogObjects` endpoint. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CatalogInfoResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.info() + + + asyncio.run(main()) + """ + response = await self._raw_client.info(request_options=request_options) + return response.data + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + types: typing.Optional[str] = None, + catalog_version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CatalogObject]: + """ + Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified types in the catalog. + + The `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values, + for example, "`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`". + + __Important:__ ListCatalog does not return deleted catalog items. To retrieve + deleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + and set the `include_deleted_objects` attribute value to `true`. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned in the previous response. Leave unset for an initial request. + The page size is currently set to be 100. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + types : typing.Optional[str] + An optional case-insensitive, comma-separated list of object types to retrieve. + + The valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example, + `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, + `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. + + If this is unspecified, the operation returns objects of all the top level types at the version + of the Square API used to make the request. Object types that are nested onto other object types + are not included in the defaults. + + At the current API version the default object types are: + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + + catalog_version : typing.Optional[int] + The specific version of the catalog objects to be included in the response. + This allows you to retrieve historical versions of objects. The specified version value is matched against + the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the + current version of the catalog. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CatalogObject] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.catalog.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/catalog/list", + method="GET", + params={ + "cursor": cursor, + "types": types, + "catalog_version": catalog_version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCatalogResponse, + construct_type( + type_=ListCatalogResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + types=types, + catalog_version=catalog_version, + request_options=request_options, + ) + _items = _parsed_response.objects + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + object_types: typing.Optional[typing.Sequence[CatalogObjectType]] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_related_objects: typing.Optional[bool] = OMIT, + begin_time: typing.Optional[str] = OMIT, + query: typing.Optional[CatalogQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchCatalogObjectsResponse: + """ + Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values, + excluding custom attribute values on items or item variations, against one or more of the specified query filters. + + This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints have different call conventions, including the query filter formats. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned in the previous response. Leave unset for an initial request. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + object_types : typing.Optional[typing.Sequence[CatalogObjectType]] + The desired set of object types to appear in the search results. + + If this is unspecified, the operation returns objects of all the top level types at the version + of the Square API used to make the request. Object types that are nested onto other object types + are not included in the defaults. + + At the current API version the default object types are: + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + + Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, + ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest + in this field. + + include_deleted_objects : typing.Optional[bool] + If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are objects that are referenced by object ID by the objects + in the response. This is helpful if the objects are being fetched for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. + For example: + + If the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + begin_time : typing.Optional[str] + Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 + format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a + timestamp equal to `begin_time` will not be included in the response. + + query : typing.Optional[CatalogQueryParams] + A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. + + limit : typing.Optional[int] + A limit on the number of results to be returned in a single page. The limit is advisory - + the implementation may return more or fewer results. If the supplied limit is negative, zero, or + is higher than the maximum limit of 1,000, it will be ignored. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchCatalogObjectsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.search( + object_types=["ITEM"], + query={ + "prefix_query": { + "attribute_name": "name", + "attribute_prefix": "tea", + } + }, + limit=100, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + cursor=cursor, + object_types=object_types, + include_deleted_objects=include_deleted_objects, + include_related_objects=include_related_objects, + begin_time=begin_time, + query=query, + limit=limit, + include_category_path_to_root=include_category_path_to_root, + request_options=request_options, + ) + return response.data + + async def search_items( + self, + *, + text_filter: typing.Optional[str] = OMIT, + category_ids: typing.Optional[typing.Sequence[str]] = OMIT, + stock_levels: typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] = OMIT, + enabled_location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + sort_order: typing.Optional[SortOrder] = OMIT, + product_types: typing.Optional[typing.Sequence[CatalogItemProductType]] = OMIT, + custom_attribute_filters: typing.Optional[typing.Sequence[CustomAttributeFilterParams]] = OMIT, + archived_state: typing.Optional[ArchivedState] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchCatalogItemsResponse: + """ + Searches for catalog items or item variations by matching supported search attribute values, including + custom attribute values, against one or more of the specified query filters. + + This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints use different call conventions, including the query filter formats. + + Parameters + ---------- + text_filter : typing.Optional[str] + The text filter expression to return items or item variations containing specified text in + the `name`, `description`, or `abbreviation` attribute value of an item, or in + the `name`, `sku`, or `upc` attribute value of an item variation. + + category_ids : typing.Optional[typing.Sequence[str]] + The category id query expression to return items containing the specified category IDs. + + stock_levels : typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] + The stock-level query expression to return item variations with the specified stock levels. + See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values + + enabled_location_ids : typing.Optional[typing.Sequence[str]] + The enabled-location query expression to return items and item variations having specified enabled locations. + + cursor : typing.Optional[str] + The pagination token, returned in the previous response, used to fetch the next batch of pending results. + + limit : typing.Optional[int] + The maximum number of results to return per page. The default value is 100. + + sort_order : typing.Optional[SortOrder] + The order to sort the results by item names. The default sort order is ascending (`ASC`). + See [SortOrder](#type-sortorder) for possible values + + product_types : typing.Optional[typing.Sequence[CatalogItemProductType]] + The product types query expression to return items or item variations having the specified product types. + + custom_attribute_filters : typing.Optional[typing.Sequence[CustomAttributeFilterParams]] + The customer-attribute filter to return items or item variations matching the specified + custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in + a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + + archived_state : typing.Optional[ArchivedState] + The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchCatalogItemsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.search_items( + text_filter="red", + category_ids=["WINE_CATEGORY_ID"], + stock_levels=["OUT", "LOW"], + enabled_location_ids=["ATL_LOCATION_ID"], + limit=100, + sort_order="ASC", + product_types=["REGULAR"], + custom_attribute_filters=[ + { + "custom_attribute_definition_id": "VEGAN_DEFINITION_ID", + "bool_filter": True, + }, + { + "custom_attribute_definition_id": "BRAND_DEFINITION_ID", + "string_filter": "Dark Horse", + }, + {"key": "VINTAGE", "number_filter": {"min": "min", "max": "max"}}, + {"custom_attribute_definition_id": "VARIETAL_DEFINITION_ID"}, + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search_items( + text_filter=text_filter, + category_ids=category_ids, + stock_levels=stock_levels, + enabled_location_ids=enabled_location_ids, + cursor=cursor, + limit=limit, + sort_order=sort_order, + product_types=product_types, + custom_attribute_filters=custom_attribute_filters, + archived_state=archived_state, + request_options=request_options, + ) + return response.data + + async def update_item_modifier_lists( + self, + *, + item_ids: typing.Sequence[str], + modifier_lists_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + modifier_lists_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateItemModifierListsResponse: + """ + Updates the [CatalogModifierList](entity:CatalogModifierList) objects + that apply to the targeted [CatalogItem](entity:CatalogItem) without having + to perform an upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + The IDs of the catalog items associated with the CatalogModifierList objects being updated. + + modifier_lists_to_enable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to enable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + modifier_lists_to_disable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to disable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateItemModifierListsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.update_item_modifier_lists( + item_ids=["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"], + modifier_lists_to_enable=[ + "H42BRLUJ5KTZTTMPVSLFAACQ", + "2JXOBJIHCWBQ4NZ3RIXQGJA6", + ], + modifier_lists_to_disable=["7WRC16CJZDVLSNDQ35PP6YAD"], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update_item_modifier_lists( + item_ids=item_ids, + modifier_lists_to_enable=modifier_lists_to_enable, + modifier_lists_to_disable=modifier_lists_to_disable, + request_options=request_options, + ) + return response.data + + async def update_item_taxes( + self, + *, + item_ids: typing.Sequence[str], + taxes_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + taxes_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateItemTaxesResponse: + """ + Updates the [CatalogTax](entity:CatalogTax) objects that apply to the + targeted [CatalogItem](entity:CatalogItem) without having to perform an + upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + IDs for the CatalogItems associated with the CatalogTax objects being updated. + No more than 1,000 IDs may be provided. + + taxes_to_enable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to enable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + taxes_to_disable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to disable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateItemTaxesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.update_item_taxes( + item_ids=["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"], + taxes_to_enable=["4WRCNHCJZDVLSNDQ35PP6YAD"], + taxes_to_disable=["AQCEGCEBBQONINDOHRGZISEX"], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update_item_taxes( + item_ids=item_ids, + taxes_to_enable=taxes_to_enable, + taxes_to_disable=taxes_to_disable, + request_options=request_options, + ) + return response.data diff --git a/src/square/catalog/images/__init__.py b/src/square/catalog/images/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/catalog/images/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/catalog/images/client.py b/src/square/catalog/images/client.py new file mode 100644 index 00000000..9f4f1d77 --- /dev/null +++ b/src/square/catalog/images/client.py @@ -0,0 +1,246 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawImagesClient +from ...requests.create_catalog_image_request import CreateCatalogImageRequestParams +from ... import core +from ...core.request_options import RequestOptions +from ...types.create_catalog_image_response import CreateCatalogImageResponse +from ...requests.update_catalog_image_request import UpdateCatalogImageRequestParams +from ...types.update_catalog_image_response import UpdateCatalogImageResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawImagesClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ImagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawImagesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawImagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawImagesClient + """ + return self._raw_client + + def create( + self, + *, + request: typing.Optional[CreateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCatalogImageResponse: + """ + Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing + [CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id` + is not specified. + + This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + request : typing.Optional[CreateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCatalogImageResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.images.create() + """ + response = self._raw_client.create(request=request, image_file=image_file, request_options=request_options) + return response.data + + def update( + self, + image_id: str, + *, + request: typing.Optional[UpdateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateCatalogImageResponse: + """ + Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object. + + This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + image_id : str + The ID of the `CatalogImage` object to update the encapsulated image file. + + request : typing.Optional[UpdateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCatalogImageResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.images.update( + image_id="image_id", + ) + """ + response = self._raw_client.update( + image_id, request=request, image_file=image_file, request_options=request_options + ) + return response.data + + +class AsyncImagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawImagesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawImagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawImagesClient + """ + return self._raw_client + + async def create( + self, + *, + request: typing.Optional[CreateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCatalogImageResponse: + """ + Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing + [CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id` + is not specified. + + This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + request : typing.Optional[CreateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCatalogImageResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.images.create() + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + request=request, image_file=image_file, request_options=request_options + ) + return response.data + + async def update( + self, + image_id: str, + *, + request: typing.Optional[UpdateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateCatalogImageResponse: + """ + Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object. + + This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + image_id : str + The ID of the `CatalogImage` object to update the encapsulated image file. + + request : typing.Optional[UpdateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCatalogImageResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.images.update( + image_id="image_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + image_id, request=request, image_file=image_file, request_options=request_options + ) + return response.data diff --git a/src/square/catalog/images/raw_client.py b/src/square/catalog/images/raw_client.py new file mode 100644 index 00000000..41b2bac1 --- /dev/null +++ b/src/square/catalog/images/raw_client.py @@ -0,0 +1,291 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.create_catalog_image_request import CreateCatalogImageRequestParams +from ... import core +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_catalog_image_response import CreateCatalogImageResponse +import json +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.update_catalog_image_request import UpdateCatalogImageRequestParams +from ...types.update_catalog_image_response import UpdateCatalogImageResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawImagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + request: typing.Optional[CreateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCatalogImageResponse]: + """ + Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing + [CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id` + is not specified. + + This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + request : typing.Optional[CreateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCatalogImageResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/images", + method="POST", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCatalogImageResponse, + construct_type( + type_=CreateCatalogImageResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + image_id: str, + *, + request: typing.Optional[UpdateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateCatalogImageResponse]: + """ + Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object. + + This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + image_id : str + The ID of the `CatalogImage` object to update the encapsulated image file. + + request : typing.Optional[UpdateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateCatalogImageResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/catalog/images/{jsonable_encoder(image_id)}", + method="PUT", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCatalogImageResponse, + construct_type( + type_=UpdateCatalogImageResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawImagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + request: typing.Optional[CreateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCatalogImageResponse]: + """ + Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing + [CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id` + is not specified. + + This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + request : typing.Optional[CreateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCatalogImageResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/images", + method="POST", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCatalogImageResponse, + construct_type( + type_=CreateCatalogImageResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + image_id: str, + *, + request: typing.Optional[UpdateCatalogImageRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateCatalogImageResponse]: + """ + Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object. + + This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in + JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. + + Parameters + ---------- + image_id : str + The ID of the `CatalogImage` object to update the encapsulated image file. + + request : typing.Optional[UpdateCatalogImageRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateCatalogImageResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/catalog/images/{jsonable_encoder(image_id)}", + method="PUT", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCatalogImageResponse, + construct_type( + type_=UpdateCatalogImageResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/catalog/object/__init__.py b/src/square/catalog/object/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/catalog/object/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/catalog/object/client.py b/src/square/catalog/object/client.py new file mode 100644 index 00000000..e75d9131 --- /dev/null +++ b/src/square/catalog/object/client.py @@ -0,0 +1,435 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawObjectClient +from ...requests.catalog_object import CatalogObjectParams +from ...core.request_options import RequestOptions +from ...types.upsert_catalog_object_response import UpsertCatalogObjectResponse +from ...types.get_catalog_object_response import GetCatalogObjectResponse +from ...types.delete_catalog_object_response import DeleteCatalogObjectResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawObjectClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ObjectClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawObjectClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawObjectClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawObjectClient + """ + return self._raw_client + + def upsert( + self, + *, + idempotency_key: str, + object: CatalogObjectParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertCatalogObjectResponse: + """ + Creates a new or updates the specified [CatalogObject](entity:CatalogObject). + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + object : CatalogObjectParams + A CatalogObject to be created or updated. + + - For updates, the object must be active (the `is_deleted` field is not `true`). + - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertCatalogObjectResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.object.upsert( + idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae", + object={"type": "ITEM", "id": "#Cocoa"}, + ) + """ + response = self._raw_client.upsert( + idempotency_key=idempotency_key, object=object, request_options=request_options + ) + return response.data + + def get( + self, + object_id: str, + *, + include_related_objects: typing.Optional[bool] = None, + catalog_version: typing.Optional[int] = None, + include_category_path_to_root: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> GetCatalogObjectResponse: + """ + Returns a single [CatalogItem](entity:CatalogItem) as a + [CatalogObject](entity:CatalogObject) based on the provided ID. The returned + object includes all of the relevant [CatalogItem](entity:CatalogItem) + information including: [CatalogItemVariation](entity:CatalogItemVariation) + children, references to its + [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_id : str + The object ID of any type of catalog objects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + Requests objects as of a specific version of the catalog. This allows you to retrieve historical + versions of objects. The value to retrieve a specific version of an object can be found + in the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will + be from the current version of the catalog. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCatalogObjectResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.object.get( + object_id="object_id", + ) + """ + response = self._raw_client.get( + object_id, + include_related_objects=include_related_objects, + catalog_version=catalog_version, + include_category_path_to_root=include_category_path_to_root, + request_options=request_options, + ) + return response.data + + def delete( + self, object_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCatalogObjectResponse: + """ + Deletes a single [CatalogObject](entity:CatalogObject) based on the + provided ID and returns the set of successfully deleted IDs in the response. + Deletion is a cascading event such that all children of the targeted object + are also deleted. For example, deleting a [CatalogItem](entity:CatalogItem) + will also delete all of its + [CatalogItemVariation](entity:CatalogItemVariation) children. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_id : str + The ID of the catalog object to be deleted. When an object is deleted, other + objects in the graph that depend on that object will be deleted as well (for example, deleting a + catalog item will delete its catalog item variations). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCatalogObjectResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.catalog.object.delete( + object_id="object_id", + ) + """ + response = self._raw_client.delete(object_id, request_options=request_options) + return response.data + + +class AsyncObjectClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawObjectClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawObjectClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawObjectClient + """ + return self._raw_client + + async def upsert( + self, + *, + idempotency_key: str, + object: CatalogObjectParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertCatalogObjectResponse: + """ + Creates a new or updates the specified [CatalogObject](entity:CatalogObject). + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + object : CatalogObjectParams + A CatalogObject to be created or updated. + + - For updates, the object must be active (the `is_deleted` field is not `true`). + - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertCatalogObjectResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.object.upsert( + idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae", + object={"type": "ITEM", "id": "#Cocoa"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert( + idempotency_key=idempotency_key, object=object, request_options=request_options + ) + return response.data + + async def get( + self, + object_id: str, + *, + include_related_objects: typing.Optional[bool] = None, + catalog_version: typing.Optional[int] = None, + include_category_path_to_root: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> GetCatalogObjectResponse: + """ + Returns a single [CatalogItem](entity:CatalogItem) as a + [CatalogObject](entity:CatalogObject) based on the provided ID. The returned + object includes all of the relevant [CatalogItem](entity:CatalogItem) + information including: [CatalogItemVariation](entity:CatalogItemVariation) + children, references to its + [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_id : str + The object ID of any type of catalog objects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + Requests objects as of a specific version of the catalog. This allows you to retrieve historical + versions of objects. The value to retrieve a specific version of an object can be found + in the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will + be from the current version of the catalog. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCatalogObjectResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.object.get( + object_id="object_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get( + object_id, + include_related_objects=include_related_objects, + catalog_version=catalog_version, + include_category_path_to_root=include_category_path_to_root, + request_options=request_options, + ) + return response.data + + async def delete( + self, object_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCatalogObjectResponse: + """ + Deletes a single [CatalogObject](entity:CatalogObject) based on the + provided ID and returns the set of successfully deleted IDs in the response. + Deletion is a cascading event such that all children of the targeted object + are also deleted. For example, deleting a [CatalogItem](entity:CatalogItem) + will also delete all of its + [CatalogItemVariation](entity:CatalogItemVariation) children. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_id : str + The ID of the catalog object to be deleted. When an object is deleted, other + objects in the graph that depend on that object will be deleted as well (for example, deleting a + catalog item will delete its catalog item variations). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCatalogObjectResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.catalog.object.delete( + object_id="object_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(object_id, request_options=request_options) + return response.data diff --git a/src/square/catalog/object/raw_client.py b/src/square/catalog/object/raw_client.py new file mode 100644 index 00000000..af5011ae --- /dev/null +++ b/src/square/catalog/object/raw_client.py @@ -0,0 +1,442 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.catalog_object import CatalogObjectParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.upsert_catalog_object_response import UpsertCatalogObjectResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_catalog_object_response import GetCatalogObjectResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.delete_catalog_object_response import DeleteCatalogObjectResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawObjectClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def upsert( + self, + *, + idempotency_key: str, + object: CatalogObjectParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpsertCatalogObjectResponse]: + """ + Creates a new or updates the specified [CatalogObject](entity:CatalogObject). + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + object : CatalogObjectParams + A CatalogObject to be created or updated. + + - For updates, the object must be active (the `is_deleted` field is not `true`). + - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertCatalogObjectResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/object", + method="POST", + json={ + "idempotency_key": idempotency_key, + "object": convert_and_respect_annotation_metadata( + object_=object, annotation=CatalogObjectParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertCatalogObjectResponse, + construct_type( + type_=UpsertCatalogObjectResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + object_id: str, + *, + include_related_objects: typing.Optional[bool] = None, + catalog_version: typing.Optional[int] = None, + include_category_path_to_root: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[GetCatalogObjectResponse]: + """ + Returns a single [CatalogItem](entity:CatalogItem) as a + [CatalogObject](entity:CatalogObject) based on the provided ID. The returned + object includes all of the relevant [CatalogItem](entity:CatalogItem) + information including: [CatalogItemVariation](entity:CatalogItemVariation) + children, references to its + [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_id : str + The object ID of any type of catalog objects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + Requests objects as of a specific version of the catalog. This allows you to retrieve historical + versions of objects. The value to retrieve a specific version of an object can be found + in the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will + be from the current version of the catalog. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCatalogObjectResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/catalog/object/{jsonable_encoder(object_id)}", + method="GET", + params={ + "include_related_objects": include_related_objects, + "catalog_version": catalog_version, + "include_category_path_to_root": include_category_path_to_root, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCatalogObjectResponse, + construct_type( + type_=GetCatalogObjectResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, object_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteCatalogObjectResponse]: + """ + Deletes a single [CatalogObject](entity:CatalogObject) based on the + provided ID and returns the set of successfully deleted IDs in the response. + Deletion is a cascading event such that all children of the targeted object + are also deleted. For example, deleting a [CatalogItem](entity:CatalogItem) + will also delete all of its + [CatalogItemVariation](entity:CatalogItemVariation) children. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_id : str + The ID of the catalog object to be deleted. When an object is deleted, other + objects in the graph that depend on that object will be deleted as well (for example, deleting a + catalog item will delete its catalog item variations). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteCatalogObjectResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/catalog/object/{jsonable_encoder(object_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCatalogObjectResponse, + construct_type( + type_=DeleteCatalogObjectResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawObjectClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def upsert( + self, + *, + idempotency_key: str, + object: CatalogObjectParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpsertCatalogObjectResponse]: + """ + Creates a new or updates the specified [CatalogObject](entity:CatalogObject). + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + object : CatalogObjectParams + A CatalogObject to be created or updated. + + - For updates, the object must be active (the `is_deleted` field is not `true`). + - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertCatalogObjectResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/object", + method="POST", + json={ + "idempotency_key": idempotency_key, + "object": convert_and_respect_annotation_metadata( + object_=object, annotation=CatalogObjectParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertCatalogObjectResponse, + construct_type( + type_=UpsertCatalogObjectResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + object_id: str, + *, + include_related_objects: typing.Optional[bool] = None, + catalog_version: typing.Optional[int] = None, + include_category_path_to_root: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[GetCatalogObjectResponse]: + """ + Returns a single [CatalogItem](entity:CatalogItem) as a + [CatalogObject](entity:CatalogObject) based on the provided ID. The returned + object includes all of the relevant [CatalogItem](entity:CatalogItem) + information including: [CatalogItemVariation](entity:CatalogItemVariation) + children, references to its + [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_id : str + The object ID of any type of catalog objects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + Requests objects as of a specific version of the catalog. This allows you to retrieve historical + versions of objects. The value to retrieve a specific version of an object can be found + in the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will + be from the current version of the catalog. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCatalogObjectResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/catalog/object/{jsonable_encoder(object_id)}", + method="GET", + params={ + "include_related_objects": include_related_objects, + "catalog_version": catalog_version, + "include_category_path_to_root": include_category_path_to_root, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCatalogObjectResponse, + construct_type( + type_=GetCatalogObjectResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, object_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteCatalogObjectResponse]: + """ + Deletes a single [CatalogObject](entity:CatalogObject) based on the + provided ID and returns the set of successfully deleted IDs in the response. + Deletion is a cascading event such that all children of the targeted object + are also deleted. For example, deleting a [CatalogItem](entity:CatalogItem) + will also delete all of its + [CatalogItemVariation](entity:CatalogItemVariation) children. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_id : str + The ID of the catalog object to be deleted. When an object is deleted, other + objects in the graph that depend on that object will be deleted as well (for example, deleting a + catalog item will delete its catalog item variations). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteCatalogObjectResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/catalog/object/{jsonable_encoder(object_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCatalogObjectResponse, + construct_type( + type_=DeleteCatalogObjectResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/catalog/raw_client.py b/src/square/catalog/raw_client.py new file mode 100644 index 00000000..88473d77 --- /dev/null +++ b/src/square/catalog/raw_client.py @@ -0,0 +1,1345 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.batch_delete_catalog_objects_response import BatchDeleteCatalogObjectsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.batch_get_catalog_objects_response import BatchGetCatalogObjectsResponse +from ..requests.catalog_object_batch import CatalogObjectBatchParams +from ..types.batch_upsert_catalog_objects_response import BatchUpsertCatalogObjectsResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..types.catalog_info_response import CatalogInfoResponse +from ..types.catalog_object_type import CatalogObjectType +from ..requests.catalog_query import CatalogQueryParams +from ..types.search_catalog_objects_response import SearchCatalogObjectsResponse +from ..types.search_catalog_items_request_stock_level import SearchCatalogItemsRequestStockLevel +from ..types.sort_order import SortOrder +from ..types.catalog_item_product_type import CatalogItemProductType +from ..requests.custom_attribute_filter import CustomAttributeFilterParams +from ..types.archived_state import ArchivedState +from ..types.search_catalog_items_response import SearchCatalogItemsResponse +from ..types.update_item_modifier_lists_response import UpdateItemModifierListsResponse +from ..types.update_item_taxes_response import UpdateItemTaxesResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCatalogClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def batch_delete( + self, *, object_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[BatchDeleteCatalogObjectsResponse]: + """ + Deletes a set of [CatalogItem](entity:CatalogItem)s based on the + provided list of target IDs and returns a set of successfully deleted IDs in + the response. Deletion is a cascading event such that all children of the + targeted object are also deleted. For example, deleting a CatalogItem will + also delete all of its [CatalogItemVariation](entity:CatalogItemVariation) + children. + + `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted + IDs can be deleted. The response will only include IDs that were + actually deleted. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects + in the graph that depend on that object will be deleted as well (for example, deleting a + CatalogItem will delete its CatalogItemVariation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchDeleteCatalogObjectsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/batch-delete", + method="POST", + json={ + "object_ids": object_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchDeleteCatalogObjectsResponse, + construct_type( + type_=BatchDeleteCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_get( + self, + *, + object_ids: typing.Sequence[str], + include_related_objects: typing.Optional[bool] = OMIT, + catalog_version: typing.Optional[int] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchGetCatalogObjectsResponse]: + """ + Returns a set of objects based on the provided ID. + Each [CatalogItem](entity:CatalogItem) returned in the set includes all of its + child information including: all of its + [CatalogItemVariation](entity:CatalogItemVariation) objects, references to + its [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + The specific version of the catalog objects to be included in the response. + This allows you to retrieve historical versions of objects. The specified version value is matched against + the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will + be from the current version of the catalog. + + include_deleted_objects : typing.Optional[bool] + Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchGetCatalogObjectsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/batch-retrieve", + method="POST", + json={ + "object_ids": object_ids, + "include_related_objects": include_related_objects, + "catalog_version": catalog_version, + "include_deleted_objects": include_deleted_objects, + "include_category_path_to_root": include_category_path_to_root, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetCatalogObjectsResponse, + construct_type( + type_=BatchGetCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_upsert( + self, + *, + idempotency_key: str, + batches: typing.Sequence[CatalogObjectBatchParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchUpsertCatalogObjectsResponse]: + """ + Creates or updates up to 10,000 target objects based on the provided + list of objects. The target objects are grouped into batches and each batch is + inserted/updated in an all-or-nothing manner. If an object within a batch is + malformed in some way, or violates a database constraint, the entire batch + containing that item will be disregarded. However, other batches in the same + request may still succeed. Each batch may contain up to 1,000 objects, and + batches will be processed in order as long as the total object count for the + request (items, variations, modifier lists, discounts, and taxes) is no more + than 10,000. + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + batches : typing.Sequence[CatalogObjectBatchParams] + A batch of CatalogObjects to be inserted/updated atomically. + The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs + attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error + in one batch will not affect other batches within the same request. + + For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its + `is_deleted` field must not be set to `true`. + + To modify an existing object, supply its ID. To create a new object, use an ID starting + with `#`. These IDs may be used to create relationships between an object and attributes of + other objects that reference it. For example, you can create a CatalogItem with + ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to + `#ABC` in order to associate the CatalogItemVariation with its parent + CatalogItem. + + Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. + + Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request + may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will + be inserted or updated. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchUpsertCatalogObjectsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/batch-upsert", + method="POST", + json={ + "idempotency_key": idempotency_key, + "batches": convert_and_respect_annotation_metadata( + object_=batches, annotation=typing.Sequence[CatalogObjectBatchParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpsertCatalogObjectsResponse, + construct_type( + type_=BatchUpsertCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[CatalogInfoResponse]: + """ + Retrieves information about the Square Catalog API, such as batch size + limits that can be used by the `BatchUpsertCatalogObjects` endpoint. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CatalogInfoResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/info", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CatalogInfoResponse, + construct_type( + type_=CatalogInfoResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + object_types: typing.Optional[typing.Sequence[CatalogObjectType]] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_related_objects: typing.Optional[bool] = OMIT, + begin_time: typing.Optional[str] = OMIT, + query: typing.Optional[CatalogQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchCatalogObjectsResponse]: + """ + Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values, + excluding custom attribute values on items or item variations, against one or more of the specified query filters. + + This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints have different call conventions, including the query filter formats. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned in the previous response. Leave unset for an initial request. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + object_types : typing.Optional[typing.Sequence[CatalogObjectType]] + The desired set of object types to appear in the search results. + + If this is unspecified, the operation returns objects of all the top level types at the version + of the Square API used to make the request. Object types that are nested onto other object types + are not included in the defaults. + + At the current API version the default object types are: + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + + Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, + ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest + in this field. + + include_deleted_objects : typing.Optional[bool] + If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are objects that are referenced by object ID by the objects + in the response. This is helpful if the objects are being fetched for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. + For example: + + If the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + begin_time : typing.Optional[str] + Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 + format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a + timestamp equal to `begin_time` will not be included in the response. + + query : typing.Optional[CatalogQueryParams] + A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. + + limit : typing.Optional[int] + A limit on the number of results to be returned in a single page. The limit is advisory - + the implementation may return more or fewer results. If the supplied limit is negative, zero, or + is higher than the maximum limit of 1,000, it will be ignored. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchCatalogObjectsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/search", + method="POST", + json={ + "cursor": cursor, + "object_types": object_types, + "include_deleted_objects": include_deleted_objects, + "include_related_objects": include_related_objects, + "begin_time": begin_time, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=CatalogQueryParams, direction="write" + ), + "limit": limit, + "include_category_path_to_root": include_category_path_to_root, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchCatalogObjectsResponse, + construct_type( + type_=SearchCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search_items( + self, + *, + text_filter: typing.Optional[str] = OMIT, + category_ids: typing.Optional[typing.Sequence[str]] = OMIT, + stock_levels: typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] = OMIT, + enabled_location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + sort_order: typing.Optional[SortOrder] = OMIT, + product_types: typing.Optional[typing.Sequence[CatalogItemProductType]] = OMIT, + custom_attribute_filters: typing.Optional[typing.Sequence[CustomAttributeFilterParams]] = OMIT, + archived_state: typing.Optional[ArchivedState] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchCatalogItemsResponse]: + """ + Searches for catalog items or item variations by matching supported search attribute values, including + custom attribute values, against one or more of the specified query filters. + + This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints use different call conventions, including the query filter formats. + + Parameters + ---------- + text_filter : typing.Optional[str] + The text filter expression to return items or item variations containing specified text in + the `name`, `description`, or `abbreviation` attribute value of an item, or in + the `name`, `sku`, or `upc` attribute value of an item variation. + + category_ids : typing.Optional[typing.Sequence[str]] + The category id query expression to return items containing the specified category IDs. + + stock_levels : typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] + The stock-level query expression to return item variations with the specified stock levels. + See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values + + enabled_location_ids : typing.Optional[typing.Sequence[str]] + The enabled-location query expression to return items and item variations having specified enabled locations. + + cursor : typing.Optional[str] + The pagination token, returned in the previous response, used to fetch the next batch of pending results. + + limit : typing.Optional[int] + The maximum number of results to return per page. The default value is 100. + + sort_order : typing.Optional[SortOrder] + The order to sort the results by item names. The default sort order is ascending (`ASC`). + See [SortOrder](#type-sortorder) for possible values + + product_types : typing.Optional[typing.Sequence[CatalogItemProductType]] + The product types query expression to return items or item variations having the specified product types. + + custom_attribute_filters : typing.Optional[typing.Sequence[CustomAttributeFilterParams]] + The customer-attribute filter to return items or item variations matching the specified + custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in + a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + + archived_state : typing.Optional[ArchivedState] + The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchCatalogItemsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/search-catalog-items", + method="POST", + json={ + "text_filter": text_filter, + "category_ids": category_ids, + "stock_levels": stock_levels, + "enabled_location_ids": enabled_location_ids, + "cursor": cursor, + "limit": limit, + "sort_order": sort_order, + "product_types": product_types, + "custom_attribute_filters": convert_and_respect_annotation_metadata( + object_=custom_attribute_filters, + annotation=typing.Sequence[CustomAttributeFilterParams], + direction="write", + ), + "archived_state": archived_state, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchCatalogItemsResponse, + construct_type( + type_=SearchCatalogItemsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update_item_modifier_lists( + self, + *, + item_ids: typing.Sequence[str], + modifier_lists_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + modifier_lists_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateItemModifierListsResponse]: + """ + Updates the [CatalogModifierList](entity:CatalogModifierList) objects + that apply to the targeted [CatalogItem](entity:CatalogItem) without having + to perform an upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + The IDs of the catalog items associated with the CatalogModifierList objects being updated. + + modifier_lists_to_enable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to enable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + modifier_lists_to_disable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to disable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateItemModifierListsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/update-item-modifier-lists", + method="POST", + json={ + "item_ids": item_ids, + "modifier_lists_to_enable": modifier_lists_to_enable, + "modifier_lists_to_disable": modifier_lists_to_disable, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateItemModifierListsResponse, + construct_type( + type_=UpdateItemModifierListsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update_item_taxes( + self, + *, + item_ids: typing.Sequence[str], + taxes_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + taxes_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateItemTaxesResponse]: + """ + Updates the [CatalogTax](entity:CatalogTax) objects that apply to the + targeted [CatalogItem](entity:CatalogItem) without having to perform an + upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + IDs for the CatalogItems associated with the CatalogTax objects being updated. + No more than 1,000 IDs may be provided. + + taxes_to_enable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to enable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + taxes_to_disable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to disable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateItemTaxesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/catalog/update-item-taxes", + method="POST", + json={ + "item_ids": item_ids, + "taxes_to_enable": taxes_to_enable, + "taxes_to_disable": taxes_to_disable, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateItemTaxesResponse, + construct_type( + type_=UpdateItemTaxesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCatalogClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def batch_delete( + self, *, object_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[BatchDeleteCatalogObjectsResponse]: + """ + Deletes a set of [CatalogItem](entity:CatalogItem)s based on the + provided list of target IDs and returns a set of successfully deleted IDs in + the response. Deletion is a cascading event such that all children of the + targeted object are also deleted. For example, deleting a CatalogItem will + also delete all of its [CatalogItemVariation](entity:CatalogItemVariation) + children. + + `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted + IDs can be deleted. The response will only include IDs that were + actually deleted. + + To ensure consistency, only one delete request is processed at a time per seller account. + While one (batch or non-batch) delete request is being processed, other (batched and non-batched) + delete requests are rejected with the `429` error code. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects + in the graph that depend on that object will be deleted as well (for example, deleting a + CatalogItem will delete its CatalogItemVariation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchDeleteCatalogObjectsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/batch-delete", + method="POST", + json={ + "object_ids": object_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchDeleteCatalogObjectsResponse, + construct_type( + type_=BatchDeleteCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_get( + self, + *, + object_ids: typing.Sequence[str], + include_related_objects: typing.Optional[bool] = OMIT, + catalog_version: typing.Optional[int] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchGetCatalogObjectsResponse]: + """ + Returns a set of objects based on the provided ID. + Each [CatalogItem](entity:CatalogItem) returned in the set includes all of its + child information including: all of its + [CatalogItemVariation](entity:CatalogItemVariation) objects, references to + its [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of + any [CatalogTax](entity:CatalogTax) objects that apply to it. + + Parameters + ---------- + object_ids : typing.Sequence[str] + The IDs of the CatalogObjects to be retrieved. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field + of the response. These objects are put in the `related_objects` field. Setting this to `true` is + helpful when the objects are needed for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. For example, + + if the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + catalog_version : typing.Optional[int] + The specific version of the catalog objects to be included in the response. + This allows you to retrieve historical versions of objects. The specified version value is matched against + the [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will + be from the current version of the catalog. + + include_deleted_objects : typing.Optional[bool] + Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists + of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category + and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned + in the response payload. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchGetCatalogObjectsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/batch-retrieve", + method="POST", + json={ + "object_ids": object_ids, + "include_related_objects": include_related_objects, + "catalog_version": catalog_version, + "include_deleted_objects": include_deleted_objects, + "include_category_path_to_root": include_category_path_to_root, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetCatalogObjectsResponse, + construct_type( + type_=BatchGetCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_upsert( + self, + *, + idempotency_key: str, + batches: typing.Sequence[CatalogObjectBatchParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchUpsertCatalogObjectsResponse]: + """ + Creates or updates up to 10,000 target objects based on the provided + list of objects. The target objects are grouped into batches and each batch is + inserted/updated in an all-or-nothing manner. If an object within a batch is + malformed in some way, or violates a database constraint, the entire batch + containing that item will be disregarded. However, other batches in the same + request may still succeed. Each batch may contain up to 1,000 objects, and + batches will be processed in order as long as the total object count for the + request (items, variations, modifier lists, discounts, and taxes) is no more + than 10,000. + + To ensure consistency, only one update request is processed at a time per seller account. + While one (batch or non-batch) update request is being processed, other (batched and non-batched) + update requests are rejected with the `429` error code. + + Parameters + ---------- + idempotency_key : str + A value you specify that uniquely identifies this + request among all your requests. A common way to create + a valid idempotency key is to use a Universally unique + identifier (UUID). + + If you're unsure whether a particular request was successful, + you can reattempt it with the same idempotency key without + worrying about creating duplicate objects. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + batches : typing.Sequence[CatalogObjectBatchParams] + A batch of CatalogObjects to be inserted/updated atomically. + The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs + attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error + in one batch will not affect other batches within the same request. + + For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its + `is_deleted` field must not be set to `true`. + + To modify an existing object, supply its ID. To create a new object, use an ID starting + with `#`. These IDs may be used to create relationships between an object and attributes of + other objects that reference it. For example, you can create a CatalogItem with + ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to + `#ABC` in order to associate the CatalogItemVariation with its parent + CatalogItem. + + Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. + + Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request + may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will + be inserted or updated. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchUpsertCatalogObjectsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/batch-upsert", + method="POST", + json={ + "idempotency_key": idempotency_key, + "batches": convert_and_respect_annotation_metadata( + object_=batches, annotation=typing.Sequence[CatalogObjectBatchParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpsertCatalogObjectsResponse, + construct_type( + type_=BatchUpsertCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def info( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CatalogInfoResponse]: + """ + Retrieves information about the Square Catalog API, such as batch size + limits that can be used by the `BatchUpsertCatalogObjects` endpoint. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CatalogInfoResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/info", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CatalogInfoResponse, + construct_type( + type_=CatalogInfoResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + object_types: typing.Optional[typing.Sequence[CatalogObjectType]] = OMIT, + include_deleted_objects: typing.Optional[bool] = OMIT, + include_related_objects: typing.Optional[bool] = OMIT, + begin_time: typing.Optional[str] = OMIT, + query: typing.Optional[CatalogQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + include_category_path_to_root: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchCatalogObjectsResponse]: + """ + Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values, + excluding custom attribute values on items or item variations, against one or more of the specified query filters. + + This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints have different call conventions, including the query filter formats. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned in the previous response. Leave unset for an initial request. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + object_types : typing.Optional[typing.Sequence[CatalogObjectType]] + The desired set of object types to appear in the search results. + + If this is unspecified, the operation returns objects of all the top level types at the version + of the Square API used to make the request. Object types that are nested onto other object types + are not included in the defaults. + + At the current API version the default object types are: + ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, + PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, + SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. + + Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, + ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest + in this field. + + include_deleted_objects : typing.Optional[bool] + If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time. + + include_related_objects : typing.Optional[bool] + If `true`, the response will include additional objects that are related to the + requested objects. Related objects are objects that are referenced by object ID by the objects + in the response. This is helpful if the objects are being fetched for immediate display to a user. + This process only goes one level deep. Objects referenced by the related objects will not be included. + For example: + + If the `objects` field of the response contains a CatalogItem, its associated + CatalogCategory objects, CatalogTax objects, CatalogImage objects and + CatalogModifierLists will be returned in the `related_objects` field of the + response. If the `objects` field of the response contains a CatalogItemVariation, + its parent CatalogItem will be returned in the `related_objects` field of + the response. + + Default value: `false` + + begin_time : typing.Optional[str] + Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 + format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a + timestamp equal to `begin_time` will not be included in the response. + + query : typing.Optional[CatalogQueryParams] + A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. + + limit : typing.Optional[int] + A limit on the number of results to be returned in a single page. The limit is advisory - + the implementation may return more or fewer results. If the supplied limit is negative, zero, or + is higher than the maximum limit of 1,000, it will be ignored. + + include_category_path_to_root : typing.Optional[bool] + Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchCatalogObjectsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/search", + method="POST", + json={ + "cursor": cursor, + "object_types": object_types, + "include_deleted_objects": include_deleted_objects, + "include_related_objects": include_related_objects, + "begin_time": begin_time, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=CatalogQueryParams, direction="write" + ), + "limit": limit, + "include_category_path_to_root": include_category_path_to_root, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchCatalogObjectsResponse, + construct_type( + type_=SearchCatalogObjectsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search_items( + self, + *, + text_filter: typing.Optional[str] = OMIT, + category_ids: typing.Optional[typing.Sequence[str]] = OMIT, + stock_levels: typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] = OMIT, + enabled_location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + sort_order: typing.Optional[SortOrder] = OMIT, + product_types: typing.Optional[typing.Sequence[CatalogItemProductType]] = OMIT, + custom_attribute_filters: typing.Optional[typing.Sequence[CustomAttributeFilterParams]] = OMIT, + archived_state: typing.Optional[ArchivedState] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchCatalogItemsResponse]: + """ + Searches for catalog items or item variations by matching supported search attribute values, including + custom attribute values, against one or more of the specified query filters. + + This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects) + endpoint in the following aspects: + + - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. + - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. + - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. + - The both endpoints use different call conventions, including the query filter formats. + + Parameters + ---------- + text_filter : typing.Optional[str] + The text filter expression to return items or item variations containing specified text in + the `name`, `description`, or `abbreviation` attribute value of an item, or in + the `name`, `sku`, or `upc` attribute value of an item variation. + + category_ids : typing.Optional[typing.Sequence[str]] + The category id query expression to return items containing the specified category IDs. + + stock_levels : typing.Optional[typing.Sequence[SearchCatalogItemsRequestStockLevel]] + The stock-level query expression to return item variations with the specified stock levels. + See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values + + enabled_location_ids : typing.Optional[typing.Sequence[str]] + The enabled-location query expression to return items and item variations having specified enabled locations. + + cursor : typing.Optional[str] + The pagination token, returned in the previous response, used to fetch the next batch of pending results. + + limit : typing.Optional[int] + The maximum number of results to return per page. The default value is 100. + + sort_order : typing.Optional[SortOrder] + The order to sort the results by item names. The default sort order is ascending (`ASC`). + See [SortOrder](#type-sortorder) for possible values + + product_types : typing.Optional[typing.Sequence[CatalogItemProductType]] + The product types query expression to return items or item variations having the specified product types. + + custom_attribute_filters : typing.Optional[typing.Sequence[CustomAttributeFilterParams]] + The customer-attribute filter to return items or item variations matching the specified + custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in + a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + + archived_state : typing.Optional[ArchivedState] + The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchCatalogItemsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/search-catalog-items", + method="POST", + json={ + "text_filter": text_filter, + "category_ids": category_ids, + "stock_levels": stock_levels, + "enabled_location_ids": enabled_location_ids, + "cursor": cursor, + "limit": limit, + "sort_order": sort_order, + "product_types": product_types, + "custom_attribute_filters": convert_and_respect_annotation_metadata( + object_=custom_attribute_filters, + annotation=typing.Sequence[CustomAttributeFilterParams], + direction="write", + ), + "archived_state": archived_state, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchCatalogItemsResponse, + construct_type( + type_=SearchCatalogItemsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update_item_modifier_lists( + self, + *, + item_ids: typing.Sequence[str], + modifier_lists_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + modifier_lists_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateItemModifierListsResponse]: + """ + Updates the [CatalogModifierList](entity:CatalogModifierList) objects + that apply to the targeted [CatalogItem](entity:CatalogItem) without having + to perform an upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + The IDs of the catalog items associated with the CatalogModifierList objects being updated. + + modifier_lists_to_enable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to enable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + modifier_lists_to_disable : typing.Optional[typing.Sequence[str]] + The IDs of the CatalogModifierList objects to disable for the CatalogItem. + At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateItemModifierListsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/update-item-modifier-lists", + method="POST", + json={ + "item_ids": item_ids, + "modifier_lists_to_enable": modifier_lists_to_enable, + "modifier_lists_to_disable": modifier_lists_to_disable, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateItemModifierListsResponse, + construct_type( + type_=UpdateItemModifierListsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update_item_taxes( + self, + *, + item_ids: typing.Sequence[str], + taxes_to_enable: typing.Optional[typing.Sequence[str]] = OMIT, + taxes_to_disable: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateItemTaxesResponse]: + """ + Updates the [CatalogTax](entity:CatalogTax) objects that apply to the + targeted [CatalogItem](entity:CatalogItem) without having to perform an + upsert on the entire item. + + Parameters + ---------- + item_ids : typing.Sequence[str] + IDs for the CatalogItems associated with the CatalogTax objects being updated. + No more than 1,000 IDs may be provided. + + taxes_to_enable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to enable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + taxes_to_disable : typing.Optional[typing.Sequence[str]] + IDs of the CatalogTax objects to disable. + At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateItemTaxesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/catalog/update-item-taxes", + method="POST", + json={ + "item_ids": item_ids, + "taxes_to_enable": taxes_to_enable, + "taxes_to_disable": taxes_to_disable, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateItemTaxesResponse, + construct_type( + type_=UpdateItemTaxesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/checkout/__init__.py b/src/square/checkout/__init__.py new file mode 100644 index 00000000..0e857b81 --- /dev/null +++ b/src/square/checkout/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import payment_links + +__all__ = ["payment_links"] diff --git a/src/square/checkout/client.py b/src/square/checkout/client.py new file mode 100644 index 00000000..960fe5e6 --- /dev/null +++ b/src/square/checkout/client.py @@ -0,0 +1,369 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawCheckoutClient +from .payment_links.client import PaymentLinksClient +from ..core.request_options import RequestOptions +from ..types.retrieve_location_settings_response import RetrieveLocationSettingsResponse +from ..requests.checkout_location_settings import CheckoutLocationSettingsParams +from ..types.update_location_settings_response import UpdateLocationSettingsResponse +from ..types.retrieve_merchant_settings_response import RetrieveMerchantSettingsResponse +from ..requests.checkout_merchant_settings import CheckoutMerchantSettingsParams +from ..types.update_merchant_settings_response import UpdateMerchantSettingsResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCheckoutClient +from .payment_links.client import AsyncPaymentLinksClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CheckoutClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCheckoutClient(client_wrapper=client_wrapper) + self.payment_links = PaymentLinksClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCheckoutClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCheckoutClient + """ + return self._raw_client + + def retrieve_location_settings( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveLocationSettingsResponse: + """ + Retrieves the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationSettingsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.retrieve_location_settings( + location_id="location_id", + ) + """ + response = self._raw_client.retrieve_location_settings(location_id, request_options=request_options) + return response.data + + def update_location_settings( + self, + location_id: str, + *, + location_settings: CheckoutLocationSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateLocationSettingsResponse: + """ + Updates the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + location_settings : CheckoutLocationSettingsParams + Describe your updates using the `location_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateLocationSettingsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.update_location_settings( + location_id="location_id", + location_settings={}, + ) + """ + response = self._raw_client.update_location_settings( + location_id, location_settings=location_settings, request_options=request_options + ) + return response.data + + def retrieve_merchant_settings( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveMerchantSettingsResponse: + """ + Retrieves the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveMerchantSettingsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.retrieve_merchant_settings() + """ + response = self._raw_client.retrieve_merchant_settings(request_options=request_options) + return response.data + + def update_merchant_settings( + self, + *, + merchant_settings: CheckoutMerchantSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateMerchantSettingsResponse: + """ + Updates the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + merchant_settings : CheckoutMerchantSettingsParams + Describe your updates using the `merchant_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateMerchantSettingsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.update_merchant_settings( + merchant_settings={}, + ) + """ + response = self._raw_client.update_merchant_settings( + merchant_settings=merchant_settings, request_options=request_options + ) + return response.data + + +class AsyncCheckoutClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCheckoutClient(client_wrapper=client_wrapper) + self.payment_links = AsyncPaymentLinksClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCheckoutClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCheckoutClient + """ + return self._raw_client + + async def retrieve_location_settings( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveLocationSettingsResponse: + """ + Retrieves the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationSettingsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.retrieve_location_settings( + location_id="location_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.retrieve_location_settings(location_id, request_options=request_options) + return response.data + + async def update_location_settings( + self, + location_id: str, + *, + location_settings: CheckoutLocationSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateLocationSettingsResponse: + """ + Updates the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + location_settings : CheckoutLocationSettingsParams + Describe your updates using the `location_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateLocationSettingsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.update_location_settings( + location_id="location_id", + location_settings={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update_location_settings( + location_id, location_settings=location_settings, request_options=request_options + ) + return response.data + + async def retrieve_merchant_settings( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveMerchantSettingsResponse: + """ + Retrieves the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveMerchantSettingsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.retrieve_merchant_settings() + + + asyncio.run(main()) + """ + response = await self._raw_client.retrieve_merchant_settings(request_options=request_options) + return response.data + + async def update_merchant_settings( + self, + *, + merchant_settings: CheckoutMerchantSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateMerchantSettingsResponse: + """ + Updates the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + merchant_settings : CheckoutMerchantSettingsParams + Describe your updates using the `merchant_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateMerchantSettingsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.update_merchant_settings( + merchant_settings={}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update_merchant_settings( + merchant_settings=merchant_settings, request_options=request_options + ) + return response.data diff --git a/src/square/checkout/payment_links/__init__.py b/src/square/checkout/payment_links/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/checkout/payment_links/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/checkout/payment_links/client.py b/src/square/checkout/payment_links/client.py new file mode 100644 index 00000000..ca2bfacd --- /dev/null +++ b/src/square/checkout/payment_links/client.py @@ -0,0 +1,641 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawPaymentLinksClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.payment_link import PaymentLink +from ...types.list_payment_links_response import ListPaymentLinksResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.quick_pay import QuickPayParams +from ...requests.order import OrderParams +from ...requests.checkout_options import CheckoutOptionsParams +from ...requests.pre_populated_data import PrePopulatedDataParams +from ...types.create_payment_link_response import CreatePaymentLinkResponse +from ...types.get_payment_link_response import GetPaymentLinkResponse +from ...requests.payment_link import PaymentLinkParams +from ...types.update_payment_link_response import UpdatePaymentLinkResponse +from ...types.delete_payment_link_response import DeletePaymentLinkResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawPaymentLinksClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class PaymentLinksClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawPaymentLinksClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawPaymentLinksClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawPaymentLinksClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[PaymentLink]: + """ + Lists all payment links. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + If a cursor is not provided, the endpoint returns the first page of the results. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + A limit on the number of results to return per page. The limit is advisory and + the implementation might return more or less results. If the supplied limit is negative, zero, or + greater than the maximum limit of 1000, it is ignored. + + Default value: `100` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[PaymentLink] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.checkout.payment_links.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/online-checkout/payment-links", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPaymentLinksResponse, + construct_type( + type_=ListPaymentLinksResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.payment_links + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + description: typing.Optional[str] = OMIT, + quick_pay: typing.Optional[QuickPayParams] = OMIT, + order: typing.Optional[OrderParams] = OMIT, + checkout_options: typing.Optional[CheckoutOptionsParams] = OMIT, + pre_populated_data: typing.Optional[PrePopulatedDataParams] = OMIT, + payment_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreatePaymentLinkResponse: + """ + Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreatePaymentLinkRequest` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + description : typing.Optional[str] + A description of the payment link. You provide this optional description that is useful in your + application context. It is not used anywhere. + + quick_pay : typing.Optional[QuickPayParams] + Describes an ad hoc item and price for which to generate a quick pay checkout link. + For more information, + see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + + order : typing.Optional[OrderParams] + Describes the `Order` for which to create a checkout link. + For more information, + see [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). + + checkout_options : typing.Optional[CheckoutOptionsParams] + Describes optional fields to add to the resulting checkout page. + For more information, + see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + + pre_populated_data : typing.Optional[PrePopulatedDataParams] + Describes fields to prepopulate in the resulting checkout page. + For more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address). + + payment_note : typing.Optional[str] + A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreatePaymentLinkResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.payment_links.create( + idempotency_key="cd9e25dc-d9f2-4430-aedb-61605070e95f", + quick_pay={ + "name": "Auto Detailing", + "price_money": {"amount": 10000, "currency": "USD"}, + "location_id": "A9Y43N9ABXZBP", + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, + description=description, + quick_pay=quick_pay, + order=order, + checkout_options=checkout_options, + pre_populated_data=pre_populated_data, + payment_note=payment_note, + request_options=request_options, + ) + return response.data + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetPaymentLinkResponse: + """ + Retrieves a payment link. + + Parameters + ---------- + id : str + The ID of link to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPaymentLinkResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.payment_links.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + def update( + self, id: str, *, payment_link: PaymentLinkParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdatePaymentLinkResponse: + """ + Updates a payment link. You can update the `payment_link` fields such as + `description`, `checkout_options`, and `pre_populated_data`. + You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field. + + Parameters + ---------- + id : str + The ID of the payment link to update. + + payment_link : PaymentLinkParams + The `payment_link` object describing the updates to apply. + For more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdatePaymentLinkResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.payment_links.update( + id="id", + payment_link={ + "version": 1, + "checkout_options": {"ask_for_shipping_address": True}, + }, + ) + """ + response = self._raw_client.update(id, payment_link=payment_link, request_options=request_options) + return response.data + + def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeletePaymentLinkResponse: + """ + Deletes a payment link. + + Parameters + ---------- + id : str + The ID of the payment link to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeletePaymentLinkResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.checkout.payment_links.delete( + id="id", + ) + """ + response = self._raw_client.delete(id, request_options=request_options) + return response.data + + +class AsyncPaymentLinksClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawPaymentLinksClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawPaymentLinksClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawPaymentLinksClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[PaymentLink]: + """ + Lists all payment links. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + If a cursor is not provided, the endpoint returns the first page of the results. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + A limit on the number of results to return per page. The limit is advisory and + the implementation might return more or less results. If the supplied limit is negative, zero, or + greater than the maximum limit of 1000, it is ignored. + + Default value: `100` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[PaymentLink] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.checkout.payment_links.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/online-checkout/payment-links", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPaymentLinksResponse, + construct_type( + type_=ListPaymentLinksResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.payment_links + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + description: typing.Optional[str] = OMIT, + quick_pay: typing.Optional[QuickPayParams] = OMIT, + order: typing.Optional[OrderParams] = OMIT, + checkout_options: typing.Optional[CheckoutOptionsParams] = OMIT, + pre_populated_data: typing.Optional[PrePopulatedDataParams] = OMIT, + payment_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreatePaymentLinkResponse: + """ + Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreatePaymentLinkRequest` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + description : typing.Optional[str] + A description of the payment link. You provide this optional description that is useful in your + application context. It is not used anywhere. + + quick_pay : typing.Optional[QuickPayParams] + Describes an ad hoc item and price for which to generate a quick pay checkout link. + For more information, + see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + + order : typing.Optional[OrderParams] + Describes the `Order` for which to create a checkout link. + For more information, + see [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). + + checkout_options : typing.Optional[CheckoutOptionsParams] + Describes optional fields to add to the resulting checkout page. + For more information, + see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + + pre_populated_data : typing.Optional[PrePopulatedDataParams] + Describes fields to prepopulate in the resulting checkout page. + For more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address). + + payment_note : typing.Optional[str] + A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreatePaymentLinkResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.payment_links.create( + idempotency_key="cd9e25dc-d9f2-4430-aedb-61605070e95f", + quick_pay={ + "name": "Auto Detailing", + "price_money": {"amount": 10000, "currency": "USD"}, + "location_id": "A9Y43N9ABXZBP", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, + description=description, + quick_pay=quick_pay, + order=order, + checkout_options=checkout_options, + pre_populated_data=pre_populated_data, + payment_note=payment_note, + request_options=request_options, + ) + return response.data + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetPaymentLinkResponse: + """ + Retrieves a payment link. + + Parameters + ---------- + id : str + The ID of link to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPaymentLinkResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.payment_links.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data + + async def update( + self, id: str, *, payment_link: PaymentLinkParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdatePaymentLinkResponse: + """ + Updates a payment link. You can update the `payment_link` fields such as + `description`, `checkout_options`, and `pre_populated_data`. + You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field. + + Parameters + ---------- + id : str + The ID of the payment link to update. + + payment_link : PaymentLinkParams + The `payment_link` object describing the updates to apply. + For more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdatePaymentLinkResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.payment_links.update( + id="id", + payment_link={ + "version": 1, + "checkout_options": {"ask_for_shipping_address": True}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update(id, payment_link=payment_link, request_options=request_options) + return response.data + + async def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeletePaymentLinkResponse: + """ + Deletes a payment link. + + Parameters + ---------- + id : str + The ID of the payment link to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeletePaymentLinkResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.checkout.payment_links.delete( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(id, request_options=request_options) + return response.data diff --git a/src/square/checkout/payment_links/raw_client.py b/src/square/checkout/payment_links/raw_client.py new file mode 100644 index 00000000..bba44612 --- /dev/null +++ b/src/square/checkout/payment_links/raw_client.py @@ -0,0 +1,497 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.quick_pay import QuickPayParams +from ...requests.order import OrderParams +from ...requests.checkout_options import CheckoutOptionsParams +from ...requests.pre_populated_data import PrePopulatedDataParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_payment_link_response import CreatePaymentLinkResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_payment_link_response import GetPaymentLinkResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.payment_link import PaymentLinkParams +from ...types.update_payment_link_response import UpdatePaymentLinkResponse +from ...types.delete_payment_link_response import DeletePaymentLinkResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawPaymentLinksClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + description: typing.Optional[str] = OMIT, + quick_pay: typing.Optional[QuickPayParams] = OMIT, + order: typing.Optional[OrderParams] = OMIT, + checkout_options: typing.Optional[CheckoutOptionsParams] = OMIT, + pre_populated_data: typing.Optional[PrePopulatedDataParams] = OMIT, + payment_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreatePaymentLinkResponse]: + """ + Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreatePaymentLinkRequest` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + description : typing.Optional[str] + A description of the payment link. You provide this optional description that is useful in your + application context. It is not used anywhere. + + quick_pay : typing.Optional[QuickPayParams] + Describes an ad hoc item and price for which to generate a quick pay checkout link. + For more information, + see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + + order : typing.Optional[OrderParams] + Describes the `Order` for which to create a checkout link. + For more information, + see [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). + + checkout_options : typing.Optional[CheckoutOptionsParams] + Describes optional fields to add to the resulting checkout page. + For more information, + see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + + pre_populated_data : typing.Optional[PrePopulatedDataParams] + Describes fields to prepopulate in the resulting checkout page. + For more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address). + + payment_note : typing.Optional[str] + A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreatePaymentLinkResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/online-checkout/payment-links", + method="POST", + json={ + "idempotency_key": idempotency_key, + "description": description, + "quick_pay": convert_and_respect_annotation_metadata( + object_=quick_pay, annotation=QuickPayParams, direction="write" + ), + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "checkout_options": convert_and_respect_annotation_metadata( + object_=checkout_options, annotation=CheckoutOptionsParams, direction="write" + ), + "pre_populated_data": convert_and_respect_annotation_metadata( + object_=pre_populated_data, annotation=PrePopulatedDataParams, direction="write" + ), + "payment_note": payment_note, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreatePaymentLinkResponse, + construct_type( + type_=CreatePaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetPaymentLinkResponse]: + """ + Retrieves a payment link. + + Parameters + ---------- + id : str + The ID of link to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetPaymentLinkResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/online-checkout/payment-links/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPaymentLinkResponse, + construct_type( + type_=GetPaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, id: str, *, payment_link: PaymentLinkParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpdatePaymentLinkResponse]: + """ + Updates a payment link. You can update the `payment_link` fields such as + `description`, `checkout_options`, and `pre_populated_data`. + You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field. + + Parameters + ---------- + id : str + The ID of the payment link to update. + + payment_link : PaymentLinkParams + The `payment_link` object describing the updates to apply. + For more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdatePaymentLinkResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/online-checkout/payment-links/{jsonable_encoder(id)}", + method="PUT", + json={ + "payment_link": convert_and_respect_annotation_metadata( + object_=payment_link, annotation=PaymentLinkParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdatePaymentLinkResponse, + construct_type( + type_=UpdatePaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeletePaymentLinkResponse]: + """ + Deletes a payment link. + + Parameters + ---------- + id : str + The ID of the payment link to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeletePaymentLinkResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/online-checkout/payment-links/{jsonable_encoder(id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeletePaymentLinkResponse, + construct_type( + type_=DeletePaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawPaymentLinksClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + description: typing.Optional[str] = OMIT, + quick_pay: typing.Optional[QuickPayParams] = OMIT, + order: typing.Optional[OrderParams] = OMIT, + checkout_options: typing.Optional[CheckoutOptionsParams] = OMIT, + pre_populated_data: typing.Optional[PrePopulatedDataParams] = OMIT, + payment_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreatePaymentLinkResponse]: + """ + Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreatePaymentLinkRequest` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + description : typing.Optional[str] + A description of the payment link. You provide this optional description that is useful in your + application context. It is not used anywhere. + + quick_pay : typing.Optional[QuickPayParams] + Describes an ad hoc item and price for which to generate a quick pay checkout link. + For more information, + see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + + order : typing.Optional[OrderParams] + Describes the `Order` for which to create a checkout link. + For more information, + see [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). + + checkout_options : typing.Optional[CheckoutOptionsParams] + Describes optional fields to add to the resulting checkout page. + For more information, + see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + + pre_populated_data : typing.Optional[PrePopulatedDataParams] + Describes fields to prepopulate in the resulting checkout page. + For more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address). + + payment_note : typing.Optional[str] + A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreatePaymentLinkResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/online-checkout/payment-links", + method="POST", + json={ + "idempotency_key": idempotency_key, + "description": description, + "quick_pay": convert_and_respect_annotation_metadata( + object_=quick_pay, annotation=QuickPayParams, direction="write" + ), + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "checkout_options": convert_and_respect_annotation_metadata( + object_=checkout_options, annotation=CheckoutOptionsParams, direction="write" + ), + "pre_populated_data": convert_and_respect_annotation_metadata( + object_=pre_populated_data, annotation=PrePopulatedDataParams, direction="write" + ), + "payment_note": payment_note, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreatePaymentLinkResponse, + construct_type( + type_=CreatePaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetPaymentLinkResponse]: + """ + Retrieves a payment link. + + Parameters + ---------- + id : str + The ID of link to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetPaymentLinkResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/online-checkout/payment-links/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPaymentLinkResponse, + construct_type( + type_=GetPaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, id: str, *, payment_link: PaymentLinkParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpdatePaymentLinkResponse]: + """ + Updates a payment link. You can update the `payment_link` fields such as + `description`, `checkout_options`, and `pre_populated_data`. + You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field. + + Parameters + ---------- + id : str + The ID of the payment link to update. + + payment_link : PaymentLinkParams + The `payment_link` object describing the updates to apply. + For more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdatePaymentLinkResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/online-checkout/payment-links/{jsonable_encoder(id)}", + method="PUT", + json={ + "payment_link": convert_and_respect_annotation_metadata( + object_=payment_link, annotation=PaymentLinkParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdatePaymentLinkResponse, + construct_type( + type_=UpdatePaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeletePaymentLinkResponse]: + """ + Deletes a payment link. + + Parameters + ---------- + id : str + The ID of the payment link to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeletePaymentLinkResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/online-checkout/payment-links/{jsonable_encoder(id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeletePaymentLinkResponse, + construct_type( + type_=DeletePaymentLinkResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/checkout/raw_client.py b/src/square/checkout/raw_client.py new file mode 100644 index 00000000..753d0cee --- /dev/null +++ b/src/square/checkout/raw_client.py @@ -0,0 +1,394 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.retrieve_location_settings_response import RetrieveLocationSettingsResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.checkout_location_settings import CheckoutLocationSettingsParams +from ..types.update_location_settings_response import UpdateLocationSettingsResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..types.retrieve_merchant_settings_response import RetrieveMerchantSettingsResponse +from ..requests.checkout_merchant_settings import CheckoutMerchantSettingsParams +from ..types.update_merchant_settings_response import UpdateMerchantSettingsResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCheckoutClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def retrieve_location_settings( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveLocationSettingsResponse]: + """ + Retrieves the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveLocationSettingsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/online-checkout/location-settings/{jsonable_encoder(location_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationSettingsResponse, + construct_type( + type_=RetrieveLocationSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update_location_settings( + self, + location_id: str, + *, + location_settings: CheckoutLocationSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateLocationSettingsResponse]: + """ + Updates the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + location_settings : CheckoutLocationSettingsParams + Describe your updates using the `location_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateLocationSettingsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/online-checkout/location-settings/{jsonable_encoder(location_id)}", + method="PUT", + json={ + "location_settings": convert_and_respect_annotation_metadata( + object_=location_settings, annotation=CheckoutLocationSettingsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateLocationSettingsResponse, + construct_type( + type_=UpdateLocationSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def retrieve_merchant_settings( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveMerchantSettingsResponse]: + """ + Retrieves the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveMerchantSettingsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/online-checkout/merchant-settings", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveMerchantSettingsResponse, + construct_type( + type_=RetrieveMerchantSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update_merchant_settings( + self, + *, + merchant_settings: CheckoutMerchantSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateMerchantSettingsResponse]: + """ + Updates the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + merchant_settings : CheckoutMerchantSettingsParams + Describe your updates using the `merchant_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateMerchantSettingsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/online-checkout/merchant-settings", + method="PUT", + json={ + "merchant_settings": convert_and_respect_annotation_metadata( + object_=merchant_settings, annotation=CheckoutMerchantSettingsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateMerchantSettingsResponse, + construct_type( + type_=UpdateMerchantSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCheckoutClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def retrieve_location_settings( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveLocationSettingsResponse]: + """ + Retrieves the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveLocationSettingsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/online-checkout/location-settings/{jsonable_encoder(location_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationSettingsResponse, + construct_type( + type_=RetrieveLocationSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update_location_settings( + self, + location_id: str, + *, + location_settings: CheckoutLocationSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateLocationSettingsResponse]: + """ + Updates the location-level settings for a Square-hosted checkout page. + + Parameters + ---------- + location_id : str + The ID of the location for which to retrieve settings. + + location_settings : CheckoutLocationSettingsParams + Describe your updates using the `location_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateLocationSettingsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/online-checkout/location-settings/{jsonable_encoder(location_id)}", + method="PUT", + json={ + "location_settings": convert_and_respect_annotation_metadata( + object_=location_settings, annotation=CheckoutLocationSettingsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateLocationSettingsResponse, + construct_type( + type_=UpdateLocationSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def retrieve_merchant_settings( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveMerchantSettingsResponse]: + """ + Retrieves the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveMerchantSettingsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/online-checkout/merchant-settings", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveMerchantSettingsResponse, + construct_type( + type_=RetrieveMerchantSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update_merchant_settings( + self, + *, + merchant_settings: CheckoutMerchantSettingsParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateMerchantSettingsResponse]: + """ + Updates the merchant-level settings for a Square-hosted checkout page. + + Parameters + ---------- + merchant_settings : CheckoutMerchantSettingsParams + Describe your updates using the `merchant_settings` object. Make sure it contains only the fields that have changed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateMerchantSettingsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/online-checkout/merchant-settings", + method="PUT", + json={ + "merchant_settings": convert_and_respect_annotation_metadata( + object_=merchant_settings, annotation=CheckoutMerchantSettingsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateMerchantSettingsResponse, + construct_type( + type_=UpdateMerchantSettingsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/client.py b/src/square/client.py new file mode 100644 index 00000000..32f7873d --- /dev/null +++ b/src/square/client.py @@ -0,0 +1,283 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from .environment import SquareEnvironment +import os +import httpx +from .core.client_wrapper import SyncClientWrapper +from .mobile.client import MobileClient +from .o_auth.client import OAuthClient +from .v1transactions.client import V1TransactionsClient +from .apple_pay.client import ApplePayClient +from .bank_accounts.client import BankAccountsClient +from .bookings.client import BookingsClient +from .cards.client import CardsClient +from .catalog.client import CatalogClient +from .customers.client import CustomersClient +from .devices.client import DevicesClient +from .disputes.client import DisputesClient +from .employees.client import EmployeesClient +from .events.client import EventsClient +from .gift_cards.client import GiftCardsClient +from .inventory.client import InventoryClient +from .invoices.client import InvoicesClient +from .locations.client import LocationsClient +from .loyalty.client import LoyaltyClient +from .merchants.client import MerchantsClient +from .checkout.client import CheckoutClient +from .orders.client import OrdersClient +from .payments.client import PaymentsClient +from .payouts.client import PayoutsClient +from .refunds.client import RefundsClient +from .sites.client import SitesClient +from .snippets.client import SnippetsClient +from .subscriptions.client import SubscriptionsClient +from .team_members.client import TeamMembersClient +from .team.client import TeamClient +from .terminal.client import TerminalClient +from .vendors.client import VendorsClient +from .cash_drawers.client import CashDrawersClient +from .labor.client import LaborClient +from .webhooks.client import WebhooksClient +from .core.client_wrapper import AsyncClientWrapper +from .mobile.client import AsyncMobileClient +from .o_auth.client import AsyncOAuthClient +from .v1transactions.client import AsyncV1TransactionsClient +from .apple_pay.client import AsyncApplePayClient +from .bank_accounts.client import AsyncBankAccountsClient +from .bookings.client import AsyncBookingsClient +from .cards.client import AsyncCardsClient +from .catalog.client import AsyncCatalogClient +from .customers.client import AsyncCustomersClient +from .devices.client import AsyncDevicesClient +from .disputes.client import AsyncDisputesClient +from .employees.client import AsyncEmployeesClient +from .events.client import AsyncEventsClient +from .gift_cards.client import AsyncGiftCardsClient +from .inventory.client import AsyncInventoryClient +from .invoices.client import AsyncInvoicesClient +from .locations.client import AsyncLocationsClient +from .loyalty.client import AsyncLoyaltyClient +from .merchants.client import AsyncMerchantsClient +from .checkout.client import AsyncCheckoutClient +from .orders.client import AsyncOrdersClient +from .payments.client import AsyncPaymentsClient +from .payouts.client import AsyncPayoutsClient +from .refunds.client import AsyncRefundsClient +from .sites.client import AsyncSitesClient +from .snippets.client import AsyncSnippetsClient +from .subscriptions.client import AsyncSubscriptionsClient +from .team_members.client import AsyncTeamMembersClient +from .team.client import AsyncTeamClient +from .terminal.client import AsyncTerminalClient +from .vendors.client import AsyncVendorsClient +from .cash_drawers.client import AsyncCashDrawersClient +from .labor.client import AsyncLaborClient +from .webhooks.client import AsyncWebhooksClient + + +class Square: + """ + Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions. + + Parameters + ---------- + base_url : typing.Optional[str] + The base url to use for requests from the client. + + environment : SquareEnvironment + The environment to use for requests from the client. from .environment import SquareEnvironment + + + + Defaults to SquareEnvironment.PRODUCTION + + + + token : typing.Optional[typing.Union[str, typing.Callable[[], str]]] + timeout : typing.Optional[float] + The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced. + + follow_redirects : typing.Optional[bool] + Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in. + + httpx_client : typing.Optional[httpx.Client] + The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration. + + version : typing.Optional[str] + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + """ + + def __init__( + self, + *, + base_url: typing.Optional[str] = None, + environment: SquareEnvironment = SquareEnvironment.PRODUCTION, + token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = os.getenv("SQUARE_TOKEN"), + timeout: typing.Optional[float] = None, + follow_redirects: typing.Optional[bool] = True, + httpx_client: typing.Optional[httpx.Client] = None, + version: typing.Optional[str] = None, + ): + _defaulted_timeout = ( + timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read + ) + self._client_wrapper = SyncClientWrapper( + base_url=_get_base_url(base_url=base_url, environment=environment), + token=token, + httpx_client=httpx_client + if httpx_client is not None + else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects) + if follow_redirects is not None + else httpx.Client(timeout=_defaulted_timeout), + timeout=_defaulted_timeout, + version=version, + ) + self.mobile = MobileClient(client_wrapper=self._client_wrapper) + self.o_auth = OAuthClient(client_wrapper=self._client_wrapper) + self.v1transactions = V1TransactionsClient(client_wrapper=self._client_wrapper) + self.apple_pay = ApplePayClient(client_wrapper=self._client_wrapper) + self.bank_accounts = BankAccountsClient(client_wrapper=self._client_wrapper) + self.bookings = BookingsClient(client_wrapper=self._client_wrapper) + self.cards = CardsClient(client_wrapper=self._client_wrapper) + self.catalog = CatalogClient(client_wrapper=self._client_wrapper) + self.customers = CustomersClient(client_wrapper=self._client_wrapper) + self.devices = DevicesClient(client_wrapper=self._client_wrapper) + self.disputes = DisputesClient(client_wrapper=self._client_wrapper) + self.employees = EmployeesClient(client_wrapper=self._client_wrapper) + self.events = EventsClient(client_wrapper=self._client_wrapper) + self.gift_cards = GiftCardsClient(client_wrapper=self._client_wrapper) + self.inventory = InventoryClient(client_wrapper=self._client_wrapper) + self.invoices = InvoicesClient(client_wrapper=self._client_wrapper) + self.locations = LocationsClient(client_wrapper=self._client_wrapper) + self.loyalty = LoyaltyClient(client_wrapper=self._client_wrapper) + self.merchants = MerchantsClient(client_wrapper=self._client_wrapper) + self.checkout = CheckoutClient(client_wrapper=self._client_wrapper) + self.orders = OrdersClient(client_wrapper=self._client_wrapper) + self.payments = PaymentsClient(client_wrapper=self._client_wrapper) + self.payouts = PayoutsClient(client_wrapper=self._client_wrapper) + self.refunds = RefundsClient(client_wrapper=self._client_wrapper) + self.sites = SitesClient(client_wrapper=self._client_wrapper) + self.snippets = SnippetsClient(client_wrapper=self._client_wrapper) + self.subscriptions = SubscriptionsClient(client_wrapper=self._client_wrapper) + self.team_members = TeamMembersClient(client_wrapper=self._client_wrapper) + self.team = TeamClient(client_wrapper=self._client_wrapper) + self.terminal = TerminalClient(client_wrapper=self._client_wrapper) + self.vendors = VendorsClient(client_wrapper=self._client_wrapper) + self.cash_drawers = CashDrawersClient(client_wrapper=self._client_wrapper) + self.labor = LaborClient(client_wrapper=self._client_wrapper) + self.webhooks = WebhooksClient(client_wrapper=self._client_wrapper) + + +class AsyncSquare: + """ + Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions. + + Parameters + ---------- + base_url : typing.Optional[str] + The base url to use for requests from the client. + + environment : SquareEnvironment + The environment to use for requests from the client. from .environment import SquareEnvironment + + + + Defaults to SquareEnvironment.PRODUCTION + + + + token : typing.Optional[typing.Union[str, typing.Callable[[], str]]] + timeout : typing.Optional[float] + The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced. + + follow_redirects : typing.Optional[bool] + Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in. + + httpx_client : typing.Optional[httpx.AsyncClient] + The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration. + + version : typing.Optional[str] + Examples + -------- + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + """ + + def __init__( + self, + *, + base_url: typing.Optional[str] = None, + environment: SquareEnvironment = SquareEnvironment.PRODUCTION, + token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = os.getenv("SQUARE_TOKEN"), + timeout: typing.Optional[float] = None, + follow_redirects: typing.Optional[bool] = True, + httpx_client: typing.Optional[httpx.AsyncClient] = None, + version: typing.Optional[str] = None, + ): + _defaulted_timeout = ( + timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read + ) + self._client_wrapper = AsyncClientWrapper( + base_url=_get_base_url(base_url=base_url, environment=environment), + token=token, + httpx_client=httpx_client + if httpx_client is not None + else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects) + if follow_redirects is not None + else httpx.AsyncClient(timeout=_defaulted_timeout), + timeout=_defaulted_timeout, + version=version, + ) + self.mobile = AsyncMobileClient(client_wrapper=self._client_wrapper) + self.o_auth = AsyncOAuthClient(client_wrapper=self._client_wrapper) + self.v1transactions = AsyncV1TransactionsClient(client_wrapper=self._client_wrapper) + self.apple_pay = AsyncApplePayClient(client_wrapper=self._client_wrapper) + self.bank_accounts = AsyncBankAccountsClient(client_wrapper=self._client_wrapper) + self.bookings = AsyncBookingsClient(client_wrapper=self._client_wrapper) + self.cards = AsyncCardsClient(client_wrapper=self._client_wrapper) + self.catalog = AsyncCatalogClient(client_wrapper=self._client_wrapper) + self.customers = AsyncCustomersClient(client_wrapper=self._client_wrapper) + self.devices = AsyncDevicesClient(client_wrapper=self._client_wrapper) + self.disputes = AsyncDisputesClient(client_wrapper=self._client_wrapper) + self.employees = AsyncEmployeesClient(client_wrapper=self._client_wrapper) + self.events = AsyncEventsClient(client_wrapper=self._client_wrapper) + self.gift_cards = AsyncGiftCardsClient(client_wrapper=self._client_wrapper) + self.inventory = AsyncInventoryClient(client_wrapper=self._client_wrapper) + self.invoices = AsyncInvoicesClient(client_wrapper=self._client_wrapper) + self.locations = AsyncLocationsClient(client_wrapper=self._client_wrapper) + self.loyalty = AsyncLoyaltyClient(client_wrapper=self._client_wrapper) + self.merchants = AsyncMerchantsClient(client_wrapper=self._client_wrapper) + self.checkout = AsyncCheckoutClient(client_wrapper=self._client_wrapper) + self.orders = AsyncOrdersClient(client_wrapper=self._client_wrapper) + self.payments = AsyncPaymentsClient(client_wrapper=self._client_wrapper) + self.payouts = AsyncPayoutsClient(client_wrapper=self._client_wrapper) + self.refunds = AsyncRefundsClient(client_wrapper=self._client_wrapper) + self.sites = AsyncSitesClient(client_wrapper=self._client_wrapper) + self.snippets = AsyncSnippetsClient(client_wrapper=self._client_wrapper) + self.subscriptions = AsyncSubscriptionsClient(client_wrapper=self._client_wrapper) + self.team_members = AsyncTeamMembersClient(client_wrapper=self._client_wrapper) + self.team = AsyncTeamClient(client_wrapper=self._client_wrapper) + self.terminal = AsyncTerminalClient(client_wrapper=self._client_wrapper) + self.vendors = AsyncVendorsClient(client_wrapper=self._client_wrapper) + self.cash_drawers = AsyncCashDrawersClient(client_wrapper=self._client_wrapper) + self.labor = AsyncLaborClient(client_wrapper=self._client_wrapper) + self.webhooks = AsyncWebhooksClient(client_wrapper=self._client_wrapper) + + +def _get_base_url(*, base_url: typing.Optional[str] = None, environment: SquareEnvironment) -> str: + if base_url is not None: + return base_url + elif environment is not None: + return environment.value + else: + raise Exception("Please pass in either base_url or environment to construct the client") diff --git a/src/square/core/__init__.py b/src/square/core/__init__.py new file mode 100644 index 00000000..e1f8fa4c --- /dev/null +++ b/src/square/core/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from .file import File, with_content_type + +__all__ = ["File", "with_content_type"] diff --git a/src/square/core/api_error.py b/src/square/core/api_error.py new file mode 100644 index 00000000..59664655 --- /dev/null +++ b/src/square/core/api_error.py @@ -0,0 +1,123 @@ +# This file was auto-generated by Fern from our API Definition. + +import json +from typing import Any, Dict, List, Optional + +from square.types.error import Error + +FALLBACK_ERROR = Error( + category="API_ERROR", + code="Unknown", +) + + +class ApiError(Exception): + """Exception thrown for any non-2XX API responses.""" + + status_code: Optional[int] + body: Any + errors: List[Error] + + def __init__(self, *, status_code: Optional[int] = None, body: Any = None): + """ + Initialize an ApiError. + + Args: + status_code: HTTP status code + body: Response body + """ + message = "API Error" + self.status_code = status_code + self.body = body + self.errors = self._parse_errors(body) + + super().__init__(self._build_message(message, status_code, body)) + + def _build_message( + self, message: str, status_code: Optional[int], body: Any + ) -> str: + """ + Build a detailed error message. + + Args: + message: Base error message + status_code: HTTP status code + body: Response body + + Returns: + Formatted error message + """ + result = f"{message}\nStatus code: {status_code}" + + if body is None or body == "": + return result + + if isinstance(body, str): + return f"{result}\nBody: {body}" + + try: + return f"{result}\nBody: {json.dumps(body, indent=2)}" + except (TypeError, ValueError): + return f"{result}\nBody: {str(body)}" + + def _parse_errors(self, body: Any) -> List[Error]: + """ + Parse errors from the response body. + + Args: + body: Response body + + Returns: + List of Error objects + """ + + if body is None: + return [FALLBACK_ERROR] + + if isinstance(body, str): + try: + body = json.loads(body) + except json.JSONDecodeError: + return [FALLBACK_ERROR] + + if hasattr(body, "__dict__"): + try: + json_str = json.dumps(body, default=lambda o: o.__dict__) + body = json.loads(json_str) + except (TypeError, ValueError): + return [FALLBACK_ERROR] + + if not isinstance(body, dict): + return [FALLBACK_ERROR] + + if "errors" in body: + errors = body["errors"] + if isinstance(errors, list): + return [self._parse_error(error) for error in errors] + + return [self._parse_error(errors)] + + return [self._parse_error(body)] + + def _parse_error(self, data: Optional[Dict[str, Any]] = None) -> Error: + """ + Create an Error object from error data. + + Args: + error_data: Dictionary containing error information + + Returns: + Error object + """ + if not data: + return FALLBACK_ERROR + + return Error( + category=data.get("category", FALLBACK_ERROR.category), + code=data.get("code", data.get("type", FALLBACK_ERROR.code)), + detail=data.get("detail", data.get("message")), + field=data.get("field"), + ) + + def __str__(self) -> str: + return f"status_code: {self.status_code}, body: {self.body}" diff --git a/src/square/core/client_wrapper.py b/src/square/core/client_wrapper.py new file mode 100644 index 00000000..3ed6476d --- /dev/null +++ b/src/square/core/client_wrapper.py @@ -0,0 +1,84 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +import httpx +from .http_client import HttpClient +from .http_client import AsyncHttpClient + + +class BaseClientWrapper: + def __init__( + self, + *, + token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None, + base_url: str, + timeout: typing.Optional[float] = None, + version: typing.Optional[str] = None, + ): + self._token = token + self._base_url = base_url + self._timeout = timeout + self._version = version + + def get_headers(self) -> typing.Dict[str, str]: + headers: typing.Dict[str, str] = { + "User-Agent": "squareup/42.0.0.20250416", + "X-Fern-Language": "Python", + "X-Fern-SDK-Name": "squareup", + "X-Fern-SDK-Version": "42.0.0.20250416", + } + token = self._get_token() + if token is not None: + headers["Authorization"] = f"Bearer {token}" + headers["Square-Version"] = self._version if self._version is not None else "2025-04-16" + return headers + + def _get_token(self) -> typing.Optional[str]: + if isinstance(self._token, str) or self._token is None: + return self._token + else: + return self._token() + + def get_base_url(self) -> str: + return self._base_url + + def get_timeout(self) -> typing.Optional[float]: + return self._timeout + + +class SyncClientWrapper(BaseClientWrapper): + def __init__( + self, + *, + token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None, + base_url: str, + timeout: typing.Optional[float] = None, + version: typing.Optional[str] = None, + httpx_client: httpx.Client, + ): + super().__init__(token=token, base_url=base_url, timeout=timeout, version=version) + self.httpx_client = HttpClient( + httpx_client=httpx_client, + base_headers=self.get_headers, + base_timeout=self.get_timeout, + base_url=self.get_base_url, + ) + + +class AsyncClientWrapper(BaseClientWrapper): + def __init__( + self, + *, + token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None, + base_url: str, + timeout: typing.Optional[float] = None, + version: typing.Optional[str] = None, + httpx_client: httpx.AsyncClient, + ): + super().__init__(token=token, base_url=base_url, timeout=timeout, version=version) + self.httpx_client = AsyncHttpClient( + httpx_client=httpx_client, + base_headers=self.get_headers, + base_timeout=self.get_timeout, + base_url=self.get_base_url, + ) diff --git a/src/square/core/datetime_utils.py b/src/square/core/datetime_utils.py new file mode 100644 index 00000000..7c9864a9 --- /dev/null +++ b/src/square/core/datetime_utils.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt + + +def serialize_datetime(v: dt.datetime) -> str: + """ + Serialize a datetime including timezone info. + + Uses the timezone info provided if present, otherwise uses the current runtime's timezone info. + + UTC datetimes end in "Z" while all other timezones are represented as offset from UTC, e.g. +05:00. + """ + + def _serialize_zoned_datetime(v: dt.datetime) -> str: + if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(None): + # UTC is a special case where we use "Z" at the end instead of "+00:00" + return v.isoformat().replace("+00:00", "Z") + else: + # Delegate to the typical +/- offset format + return v.isoformat() + + if v.tzinfo is not None: + return _serialize_zoned_datetime(v) + else: + local_tz = dt.datetime.now().astimezone().tzinfo + localized_dt = v.replace(tzinfo=local_tz) + return _serialize_zoned_datetime(localized_dt) diff --git a/src/square/core/file.py b/src/square/core/file.py new file mode 100644 index 00000000..44b0d27c --- /dev/null +++ b/src/square/core/file.py @@ -0,0 +1,67 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import IO, Dict, List, Mapping, Optional, Tuple, Union, cast + +# File typing inspired by the flexibility of types within the httpx library +# https://github.com/encode/httpx/blob/master/httpx/_types.py +FileContent = Union[IO[bytes], bytes, str] +File = Union[ + # file (or bytes) + FileContent, + # (filename, file (or bytes)) + Tuple[Optional[str], FileContent], + # (filename, file (or bytes), content_type) + Tuple[Optional[str], FileContent, Optional[str]], + # (filename, file (or bytes), content_type, headers) + Tuple[ + Optional[str], + FileContent, + Optional[str], + Mapping[str, str], + ], +] + + +def convert_file_dict_to_httpx_tuples( + d: Dict[str, Union[File, List[File]]], +) -> List[Tuple[str, File]]: + """ + The format we use is a list of tuples, where the first element is the + name of the file and the second is the file object. Typically HTTPX wants + a dict, but to be able to send lists of files, you have to use the list + approach (which also works for non-lists) + https://github.com/encode/httpx/pull/1032 + """ + + httpx_tuples = [] + for key, file_like in d.items(): + if isinstance(file_like, list): + for file_like_item in file_like: + httpx_tuples.append((key, file_like_item)) + else: + httpx_tuples.append((key, file_like)) + return httpx_tuples + + +def with_content_type(*, file: File, default_content_type: str) -> File: + """ + This function resolves to the file's content type, if provided, and defaults + to the default_content_type value if not. + """ + if isinstance(file, tuple): + if len(file) == 2: + filename, content = cast(Tuple[Optional[str], FileContent], file) # type: ignore + return (filename, content, default_content_type) + elif len(file) == 3: + filename, content, file_content_type = cast(Tuple[Optional[str], FileContent, Optional[str]], file) # type: ignore + out_content_type = file_content_type or default_content_type + return (filename, content, out_content_type) + elif len(file) == 4: + filename, content, file_content_type, headers = cast( # type: ignore + Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]], file + ) + out_content_type = file_content_type or default_content_type + return (filename, content, out_content_type, headers) + else: + raise ValueError(f"Unexpected tuple length: {len(file)}") + return (None, file, default_content_type) diff --git a/src/square/core/http_client.py b/src/square/core/http_client.py new file mode 100644 index 00000000..e7bd4f79 --- /dev/null +++ b/src/square/core/http_client.py @@ -0,0 +1,497 @@ +# This file was auto-generated by Fern from our API Definition. + +import asyncio +import email.utils +import re +import time +import typing +import urllib.parse +from contextlib import asynccontextmanager, contextmanager +from random import random + +import httpx +from .file import File, convert_file_dict_to_httpx_tuples +from .jsonable_encoder import jsonable_encoder +from .query_encoder import encode_query +from .remove_none_from_dict import remove_none_from_dict +from .request_options import RequestOptions + +INITIAL_RETRY_DELAY_SECONDS = 0.5 +MAX_RETRY_DELAY_SECONDS = 10 +MAX_RETRY_DELAY_SECONDS_FROM_HEADER = 30 + + +def _parse_retry_after(response_headers: httpx.Headers) -> typing.Optional[float]: + """ + This function parses the `Retry-After` header in a HTTP response and returns the number of seconds to wait. + + Inspired by the urllib3 retry implementation. + """ + retry_after_ms = response_headers.get("retry-after-ms") + if retry_after_ms is not None: + try: + return int(retry_after_ms) / 1000 if retry_after_ms > 0 else 0 + except Exception: + pass + + retry_after = response_headers.get("retry-after") + if retry_after is None: + return None + + # Attempt to parse the header as an int. + if re.match(r"^\s*[0-9]+\s*$", retry_after): + seconds = float(retry_after) + # Fallback to parsing it as a date. + else: + retry_date_tuple = email.utils.parsedate_tz(retry_after) + if retry_date_tuple is None: + return None + if retry_date_tuple[9] is None: # Python 2 + # Assume UTC if no timezone was specified + # On Python2.7, parsedate_tz returns None for a timezone offset + # instead of 0 if no timezone is given, where mktime_tz treats + # a None timezone offset as local time. + retry_date_tuple = retry_date_tuple[:9] + (0,) + retry_date_tuple[10:] + + retry_date = email.utils.mktime_tz(retry_date_tuple) + seconds = retry_date - time.time() + + if seconds < 0: + seconds = 0 + + return seconds + + +def _retry_timeout(response: httpx.Response, retries: int) -> float: + """ + Determine the amount of time to wait before retrying a request. + This function begins by trying to parse a retry-after header from the response, and then proceeds to use exponential backoff + with a jitter to determine the number of seconds to wait. + """ + + # If the API asks us to wait a certain amount of time (and it's a reasonable amount), just do what it says. + retry_after = _parse_retry_after(response.headers) + if retry_after is not None and retry_after <= MAX_RETRY_DELAY_SECONDS_FROM_HEADER: + return retry_after + + # Apply exponential backoff, capped at MAX_RETRY_DELAY_SECONDS. + retry_delay = min(INITIAL_RETRY_DELAY_SECONDS * pow(2.0, retries), MAX_RETRY_DELAY_SECONDS) + + # Add a randomness / jitter to the retry delay to avoid overwhelming the server with retries. + timeout = retry_delay * (1 - 0.25 * random()) + return timeout if timeout >= 0 else 0 + + +def _should_retry(response: httpx.Response) -> bool: + retryable_400s = [429, 408, 409] + return response.status_code >= 500 or response.status_code in retryable_400s + + +def remove_omit_from_dict( + original: typing.Dict[str, typing.Optional[typing.Any]], + omit: typing.Optional[typing.Any], +) -> typing.Dict[str, typing.Any]: + if omit is None: + return original + new: typing.Dict[str, typing.Any] = {} + for key, value in original.items(): + if value is not omit: + new[key] = value + return new + + +def maybe_filter_request_body( + data: typing.Optional[typing.Any], + request_options: typing.Optional[RequestOptions], + omit: typing.Optional[typing.Any], +) -> typing.Optional[typing.Any]: + if data is None: + return ( + jsonable_encoder(request_options.get("additional_body_parameters", {})) or {} + if request_options is not None + else None + ) + elif not isinstance(data, typing.Mapping): + data_content = jsonable_encoder(data) + else: + data_content = { + **(jsonable_encoder(remove_omit_from_dict(data, omit))), # type: ignore + **( + jsonable_encoder(request_options.get("additional_body_parameters", {})) or {} + if request_options is not None + else {} + ), + } + return data_content + + +# Abstracted out for testing purposes +def get_request_body( + *, + json: typing.Optional[typing.Any], + data: typing.Optional[typing.Any], + request_options: typing.Optional[RequestOptions], + omit: typing.Optional[typing.Any], +) -> typing.Tuple[typing.Optional[typing.Any], typing.Optional[typing.Any]]: + json_body = None + data_body = None + if data is not None: + data_body = maybe_filter_request_body(data, request_options, omit) + else: + # If both data and json are None, we send json data in the event extra properties are specified + json_body = maybe_filter_request_body(json, request_options, omit) + + # If you have an empty JSON body, you should just send None + return (json_body if json_body != {} else None), data_body if data_body != {} else None + + +class HttpClient: + def __init__( + self, + *, + httpx_client: httpx.Client, + base_timeout: typing.Callable[[], typing.Optional[float]], + base_headers: typing.Callable[[], typing.Dict[str, str]], + base_url: typing.Optional[typing.Callable[[], str]] = None, + ): + self.base_url = base_url + self.base_timeout = base_timeout + self.base_headers = base_headers + self.httpx_client = httpx_client + + def get_base_url(self, maybe_base_url: typing.Optional[str]) -> str: + base_url = maybe_base_url + if self.base_url is not None and base_url is None: + base_url = self.base_url() + + if base_url is None: + raise ValueError("A base_url is required to make this request, please provide one and try again.") + return base_url + + def request( + self, + path: typing.Optional[str] = None, + *, + method: str, + base_url: typing.Optional[str] = None, + params: typing.Optional[typing.Dict[str, typing.Any]] = None, + json: typing.Optional[typing.Any] = None, + data: typing.Optional[typing.Any] = None, + content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, + files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + headers: typing.Optional[typing.Dict[str, typing.Any]] = None, + request_options: typing.Optional[RequestOptions] = None, + retries: int = 2, + omit: typing.Optional[typing.Any] = None, + ) -> httpx.Response: + base_url = self.get_base_url(base_url) + timeout = ( + request_options.get("timeout_in_seconds") + if request_options is not None and request_options.get("timeout_in_seconds") is not None + else self.base_timeout() + ) + + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) + + response = self.httpx_client.request( + method=method, + url=urllib.parse.urljoin(f"{base_url}/", path), + headers=jsonable_encoder( + remove_none_from_dict( + { + **self.base_headers(), + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}), + } + ) + ), + params=encode_query( + jsonable_encoder( + remove_none_from_dict( + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) or {} + if request_options is not None + else {} + ), + }, + omit, + ) + ) + ) + ), + json=json_body, + data=data_body, + content=content, + files=( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if (files is not None and files is not omit) + else None + ), + timeout=timeout, + ) + + max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0 + if _should_retry(response=response): + if max_retries > retries: + time.sleep(_retry_timeout(response=response, retries=retries)) + return self.request( + path=path, + method=method, + base_url=base_url, + params=params, + json=json, + content=content, + files=files, + headers=headers, + request_options=request_options, + retries=retries + 1, + omit=omit, + ) + + return response + + @contextmanager + def stream( + self, + path: typing.Optional[str] = None, + *, + method: str, + base_url: typing.Optional[str] = None, + params: typing.Optional[typing.Dict[str, typing.Any]] = None, + json: typing.Optional[typing.Any] = None, + data: typing.Optional[typing.Any] = None, + content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, + files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + headers: typing.Optional[typing.Dict[str, typing.Any]] = None, + request_options: typing.Optional[RequestOptions] = None, + retries: int = 2, + omit: typing.Optional[typing.Any] = None, + ) -> typing.Iterator[httpx.Response]: + base_url = self.get_base_url(base_url) + timeout = ( + request_options.get("timeout_in_seconds") + if request_options is not None and request_options.get("timeout_in_seconds") is not None + else self.base_timeout() + ) + + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) + + with self.httpx_client.stream( + method=method, + url=urllib.parse.urljoin(f"{base_url}/", path), + headers=jsonable_encoder( + remove_none_from_dict( + { + **self.base_headers(), + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) if request_options is not None else {}), + } + ) + ), + params=encode_query( + jsonable_encoder( + remove_none_from_dict( + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) + if request_options is not None + else {} + ), + }, + omit, + ) + ) + ) + ), + json=json_body, + data=data_body, + content=content, + files=( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if (files is not None and files is not omit) + else None + ), + timeout=timeout, + ) as stream: + yield stream + + +class AsyncHttpClient: + def __init__( + self, + *, + httpx_client: httpx.AsyncClient, + base_timeout: typing.Callable[[], typing.Optional[float]], + base_headers: typing.Callable[[], typing.Dict[str, str]], + base_url: typing.Optional[typing.Callable[[], str]] = None, + ): + self.base_url = base_url + self.base_timeout = base_timeout + self.base_headers = base_headers + self.httpx_client = httpx_client + + def get_base_url(self, maybe_base_url: typing.Optional[str]) -> str: + base_url = maybe_base_url + if self.base_url is not None and base_url is None: + base_url = self.base_url() + + if base_url is None: + raise ValueError("A base_url is required to make this request, please provide one and try again.") + return base_url + + async def request( + self, + path: typing.Optional[str] = None, + *, + method: str, + base_url: typing.Optional[str] = None, + params: typing.Optional[typing.Dict[str, typing.Any]] = None, + json: typing.Optional[typing.Any] = None, + data: typing.Optional[typing.Any] = None, + content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, + files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + headers: typing.Optional[typing.Dict[str, typing.Any]] = None, + request_options: typing.Optional[RequestOptions] = None, + retries: int = 2, + omit: typing.Optional[typing.Any] = None, + ) -> httpx.Response: + base_url = self.get_base_url(base_url) + timeout = ( + request_options.get("timeout_in_seconds") + if request_options is not None and request_options.get("timeout_in_seconds") is not None + else self.base_timeout() + ) + + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) + + # Add the input to each of these and do None-safety checks + response = await self.httpx_client.request( + method=method, + url=urllib.parse.urljoin(f"{base_url}/", path), + headers=jsonable_encoder( + remove_none_from_dict( + { + **self.base_headers(), + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}), + } + ) + ), + params=encode_query( + jsonable_encoder( + remove_none_from_dict( + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) or {} + if request_options is not None + else {} + ), + }, + omit, + ) + ) + ) + ), + json=json_body, + data=data_body, + content=content, + files=( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if files is not None + else None + ), + timeout=timeout, + ) + + max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0 + if _should_retry(response=response): + if max_retries > retries: + await asyncio.sleep(_retry_timeout(response=response, retries=retries)) + return await self.request( + path=path, + method=method, + base_url=base_url, + params=params, + json=json, + content=content, + files=files, + headers=headers, + request_options=request_options, + retries=retries + 1, + omit=omit, + ) + return response + + @asynccontextmanager + async def stream( + self, + path: typing.Optional[str] = None, + *, + method: str, + base_url: typing.Optional[str] = None, + params: typing.Optional[typing.Dict[str, typing.Any]] = None, + json: typing.Optional[typing.Any] = None, + data: typing.Optional[typing.Any] = None, + content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, + files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + headers: typing.Optional[typing.Dict[str, typing.Any]] = None, + request_options: typing.Optional[RequestOptions] = None, + retries: int = 2, + omit: typing.Optional[typing.Any] = None, + ) -> typing.AsyncIterator[httpx.Response]: + base_url = self.get_base_url(base_url) + timeout = ( + request_options.get("timeout_in_seconds") + if request_options is not None and request_options.get("timeout_in_seconds") is not None + else self.base_timeout() + ) + + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) + + async with self.httpx_client.stream( + method=method, + url=urllib.parse.urljoin(f"{base_url}/", path), + headers=jsonable_encoder( + remove_none_from_dict( + { + **self.base_headers(), + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) if request_options is not None else {}), + } + ) + ), + params=encode_query( + jsonable_encoder( + remove_none_from_dict( + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) + if request_options is not None + else {} + ), + }, + omit=omit, + ) + ) + ) + ), + json=json_body, + data=data_body, + content=content, + files=( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if files is not None + else None + ), + timeout=timeout, + ) as stream: + yield stream diff --git a/src/square/core/http_response.py b/src/square/core/http_response.py new file mode 100644 index 00000000..c72a9130 --- /dev/null +++ b/src/square/core/http_response.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import Dict, Generic, TypeVar + +import httpx + +T = TypeVar("T") + + +class HttpResponse(Generic[T]): + _response: httpx.Response + _data: T + + def __init__(self, response: httpx.Response, data: T): + self._response = response + self._data = data + + @property + def headers(self) -> Dict[str, str]: + return dict(self._response.headers) + + @property + def data(self) -> T: + return self._data + + def close(self) -> None: + self._response.close() + + +class AsyncHttpResponse(Generic[T]): + _response: httpx.Response + _data: T + + def __init__(self, response: httpx.Response, data: T): + self._response = response + self._data = data + + @property + def headers(self) -> Dict[str, str]: + return dict(self._response.headers) + + @property + def data(self) -> T: + return self._data + + async def close(self) -> None: + await self._response.aclose() diff --git a/src/square/core/jsonable_encoder.py b/src/square/core/jsonable_encoder.py new file mode 100644 index 00000000..afee3662 --- /dev/null +++ b/src/square/core/jsonable_encoder.py @@ -0,0 +1,100 @@ +# This file was auto-generated by Fern from our API Definition. + +""" +jsonable_encoder converts a Python object to a JSON-friendly dict +(e.g. datetimes to strings, Pydantic models to dicts). + +Taken from FastAPI, and made a bit simpler +https://github.com/tiangolo/fastapi/blob/master/fastapi/encoders.py +""" + +import base64 +import dataclasses +import datetime as dt +from enum import Enum +from pathlib import PurePath +from types import GeneratorType +from typing import Any, Callable, Dict, List, Optional, Set, Union + +import pydantic +from .datetime_utils import serialize_datetime +from .pydantic_utilities import ( + IS_PYDANTIC_V2, + encode_by_type, + to_jsonable_with_fallback, +) + +SetIntStr = Set[Union[int, str]] +DictIntStrAny = Dict[Union[int, str], Any] + + +def jsonable_encoder(obj: Any, custom_encoder: Optional[Dict[Any, Callable[[Any], Any]]] = None) -> Any: + custom_encoder = custom_encoder or {} + if custom_encoder: + if type(obj) in custom_encoder: + return custom_encoder[type(obj)](obj) + else: + for encoder_type, encoder_instance in custom_encoder.items(): + if isinstance(obj, encoder_type): + return encoder_instance(obj) + if isinstance(obj, pydantic.BaseModel): + if IS_PYDANTIC_V2: + encoder = getattr(obj.model_config, "json_encoders", {}) # type: ignore # Pydantic v2 + else: + encoder = getattr(obj.__config__, "json_encoders", {}) # type: ignore # Pydantic v1 + if custom_encoder: + encoder.update(custom_encoder) + obj_dict = obj.dict(by_alias=True) + if "__root__" in obj_dict: + obj_dict = obj_dict["__root__"] + if "root" in obj_dict: + obj_dict = obj_dict["root"] + return jsonable_encoder(obj_dict, custom_encoder=encoder) + if dataclasses.is_dataclass(obj): + obj_dict = dataclasses.asdict(obj) # type: ignore + return jsonable_encoder(obj_dict, custom_encoder=custom_encoder) + if isinstance(obj, bytes): + return base64.b64encode(obj).decode("utf-8") + if isinstance(obj, Enum): + return obj.value + if isinstance(obj, PurePath): + return str(obj) + if isinstance(obj, (str, int, float, type(None))): + return obj + if isinstance(obj, dt.datetime): + return serialize_datetime(obj) + if isinstance(obj, dt.date): + return str(obj) + if isinstance(obj, dict): + encoded_dict = {} + allowed_keys = set(obj.keys()) + for key, value in obj.items(): + if key in allowed_keys: + encoded_key = jsonable_encoder(key, custom_encoder=custom_encoder) + encoded_value = jsonable_encoder(value, custom_encoder=custom_encoder) + encoded_dict[encoded_key] = encoded_value + return encoded_dict + if isinstance(obj, (list, set, frozenset, GeneratorType, tuple)): + encoded_list = [] + for item in obj: + encoded_list.append(jsonable_encoder(item, custom_encoder=custom_encoder)) + return encoded_list + + def fallback_serializer(o: Any) -> Any: + attempt_encode = encode_by_type(o) + if attempt_encode is not None: + return attempt_encode + + try: + data = dict(o) + except Exception as e: + errors: List[Exception] = [] + errors.append(e) + try: + data = vars(o) + except Exception as e: + errors.append(e) + raise ValueError(errors) from e + return jsonable_encoder(data, custom_encoder=custom_encoder) + + return to_jsonable_with_fallback(obj, fallback_serializer) diff --git a/src/square/core/pagination.py b/src/square/core/pagination.py new file mode 100644 index 00000000..e7e31291 --- /dev/null +++ b/src/square/core/pagination.py @@ -0,0 +1,87 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from typing_extensions import Self + +# Generic to represent the underlying type of the results within a page +T = typing.TypeVar("T") + + +# SDKs implement a Page ABC per-pagination request, the endpoint then returns a pager that wraps this type +# for example, an endpoint will return SyncPager[UserPage] where UserPage implements the Page ABC. ex: +# +# SyncPager( +# has_next=response.list_metadata.after is not None, +# items=response.data, +# # This should be the outer function that returns the SyncPager again +# get_next=lambda: list(..., cursor: response.cursor) (or list(..., offset: offset + 1)) +# ) +class BasePage(pydantic.BaseModel, typing.Generic[T]): + has_next: bool + items: typing.Optional[typing.List[T]] + + +class SyncPage(BasePage[T], typing.Generic[T]): + get_next: typing.Optional[typing.Callable[[], typing.Optional[Self]]] + + +class AsyncPage(BasePage[T], typing.Generic[T]): + get_next: typing.Optional[typing.Callable[[], typing.Awaitable[typing.Optional[Self]]]] + + +# ---------------------------- + + +class SyncPager(SyncPage[T], typing.Generic[T]): + # Here we type ignore the iterator to avoid a mypy error + # caused by the type conflict with Pydanitc's __iter__ method + # brought in by extending the base model + def __iter__(self) -> typing.Iterator[T]: # type: ignore + for page in self.iter_pages(): + if page.items is not None: + for item in page.items: + yield item + + def iter_pages(self) -> typing.Iterator[SyncPage[T]]: + page: typing.Union[SyncPager[T], None] = self + while True: + if page is not None: + yield page + if page.has_next and page.get_next is not None: + page = page.get_next() + if page is None or page.items is None or len(page.items) == 0: + return + else: + return + else: + return + + def next_page(self) -> typing.Optional[SyncPage[T]]: + return self.get_next() if self.get_next is not None else None + + +class AsyncPager(AsyncPage[T], typing.Generic[T]): + async def __aiter__(self) -> typing.AsyncIterator[T]: # type: ignore + async for page in self.iter_pages(): + if page.items is not None: + for item in page.items: + yield item + + async def iter_pages(self) -> typing.AsyncIterator[AsyncPage[T]]: + page: typing.Union[AsyncPager[T], None] = self + while True: + if page is not None: + yield page + if page is not None and page.has_next and page.get_next is not None: + page = await page.get_next() + if page is None or page.items is None or len(page.items) == 0: + return + else: + return + else: + return + + async def next_page(self) -> typing.Optional[AsyncPage[T]]: + return await self.get_next() if self.get_next is not None else None diff --git a/src/square/core/pydantic_utilities.py b/src/square/core/pydantic_utilities.py new file mode 100644 index 00000000..f7467bcc --- /dev/null +++ b/src/square/core/pydantic_utilities.py @@ -0,0 +1,294 @@ +# This file was auto-generated by Fern from our API Definition. + +# nopycln: file +import datetime as dt +import typing +from collections import defaultdict + +import pydantic +import typing_extensions +from .datetime_utils import serialize_datetime +from .serialization import convert_and_respect_annotation_metadata + +IS_PYDANTIC_V2 = pydantic.VERSION.startswith("2.") + +if IS_PYDANTIC_V2: + # isort will try to reformat the comments on these imports, which breaks mypy + # isort: off + from pydantic.v1.datetime_parse import ( # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 + parse_date as parse_date, + ) + from pydantic.v1.datetime_parse import ( # pyright: ignore[reportMissingImports] # Pydantic v2 + parse_datetime as parse_datetime, + ) + from pydantic.v1.json import ( # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 + ENCODERS_BY_TYPE as encoders_by_type, + ) + from pydantic.v1.typing import ( # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 + get_args as get_args, + ) + from pydantic.v1.typing import ( # pyright: ignore[reportMissingImports] # Pydantic v2 + get_origin as get_origin, + ) + from pydantic.v1.typing import ( # pyright: ignore[reportMissingImports] # Pydantic v2 + is_literal_type as is_literal_type, + ) + from pydantic.v1.typing import ( # pyright: ignore[reportMissingImports] # Pydantic v2 + is_union as is_union, + ) + from pydantic.v1.fields import ModelField as ModelField # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 +else: + from pydantic.datetime_parse import parse_date as parse_date # type: ignore # Pydantic v1 + from pydantic.datetime_parse import parse_datetime as parse_datetime # type: ignore # Pydantic v1 + from pydantic.fields import ModelField as ModelField # type: ignore # Pydantic v1 + from pydantic.json import ENCODERS_BY_TYPE as encoders_by_type # type: ignore # Pydantic v1 + from pydantic.typing import get_args as get_args # type: ignore # Pydantic v1 + from pydantic.typing import get_origin as get_origin # type: ignore # Pydantic v1 + from pydantic.typing import is_literal_type as is_literal_type # type: ignore # Pydantic v1 + from pydantic.typing import is_union as is_union # type: ignore # Pydantic v1 + + # isort: on + + +T = typing.TypeVar("T") +Model = typing.TypeVar("Model", bound=pydantic.BaseModel) + + +def parse_obj_as(type_: typing.Type[T], object_: typing.Any) -> T: + dealiased_object = convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read") + if IS_PYDANTIC_V2: + adapter = pydantic.TypeAdapter(type_) # type: ignore # Pydantic v2 + return adapter.validate_python(dealiased_object) + else: + return pydantic.parse_obj_as(type_, dealiased_object) + + +def to_jsonable_with_fallback( + obj: typing.Any, fallback_serializer: typing.Callable[[typing.Any], typing.Any] +) -> typing.Any: + if IS_PYDANTIC_V2: + from pydantic_core import to_jsonable_python + + return to_jsonable_python(obj, fallback=fallback_serializer) + else: + return fallback_serializer(obj) + + +class UniversalBaseModel(pydantic.BaseModel): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict( + # Allow fields beginning with `model_` to be used in the model + protected_namespaces=(), + ) # type: ignore # Pydantic v2 + + @pydantic.model_serializer(mode="wrap", when_used="json") # type: ignore # Pydantic v2 + def serialize_model(self, handler: pydantic.SerializerFunctionWrapHandler) -> typing.Any: # type: ignore # Pydantic v2 + serialized = handler(self) + data = {k: serialize_datetime(v) if isinstance(v, dt.datetime) else v for k, v in serialized.items()} + return data + + else: + + class Config: + smart_union = True + json_encoders = {dt.datetime: serialize_datetime} + + @classmethod + def model_construct( + cls: typing.Type["Model"], _fields_set: typing.Optional[typing.Set[str]] = None, **values: typing.Any + ) -> "Model": + dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read") + return cls.construct(_fields_set, **dealiased_object) + + @classmethod + def construct( + cls: typing.Type["Model"], _fields_set: typing.Optional[typing.Set[str]] = None, **values: typing.Any + ) -> "Model": + dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read") + if IS_PYDANTIC_V2: + return super().model_construct(_fields_set, **dealiased_object) # type: ignore # Pydantic v2 + else: + return super().construct(_fields_set, **dealiased_object) + + def json(self, **kwargs: typing.Any) -> str: + kwargs_with_defaults: typing.Any = { + "by_alias": True, + "exclude_unset": True, + **kwargs, + } + if IS_PYDANTIC_V2: + return super().model_dump_json(**kwargs_with_defaults) # type: ignore # Pydantic v2 + else: + return super().json(**kwargs_with_defaults) + + def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: + """ + Override the default dict method to `exclude_unset` by default. This function patches + `exclude_unset` to work include fields within non-None default values. + """ + # Note: the logic here is multiplexed given the levers exposed in Pydantic V1 vs V2 + # Pydantic V1's .dict can be extremely slow, so we do not want to call it twice. + # + # We'd ideally do the same for Pydantic V2, but it shells out to a library to serialize models + # that we have less control over, and this is less intrusive than custom serializers for now. + if IS_PYDANTIC_V2: + kwargs_with_defaults_exclude_unset: typing.Any = { + **kwargs, + "by_alias": True, + "exclude_unset": True, + "exclude_none": False, + } + kwargs_with_defaults_exclude_none: typing.Any = { + **kwargs, + "by_alias": True, + "exclude_none": True, + "exclude_unset": False, + } + dict_dump = deep_union_pydantic_dicts( + super().model_dump(**kwargs_with_defaults_exclude_unset), # type: ignore # Pydantic v2 + super().model_dump(**kwargs_with_defaults_exclude_none), # type: ignore # Pydantic v2 + ) + + else: + _fields_set = self.__fields_set__.copy() + + fields = _get_model_fields(self.__class__) + for name, field in fields.items(): + if name not in _fields_set: + default = _get_field_default(field) + + # If the default values are non-null act like they've been set + # This effectively allows exclude_unset to work like exclude_none where + # the latter passes through intentionally set none values. + if default is not None or ("exclude_unset" in kwargs and not kwargs["exclude_unset"]): + _fields_set.add(name) + + if default is not None: + self.__fields_set__.add(name) + + kwargs_with_defaults_exclude_unset_include_fields: typing.Any = { + "by_alias": True, + "exclude_unset": True, + "include": _fields_set, + **kwargs, + } + + dict_dump = super().dict(**kwargs_with_defaults_exclude_unset_include_fields) + + return convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write") + + +def _union_list_of_pydantic_dicts( + source: typing.List[typing.Any], destination: typing.List[typing.Any] +) -> typing.List[typing.Any]: + converted_list: typing.List[typing.Any] = [] + for i, item in enumerate(source): + destination_value = destination[i] # type: ignore + if isinstance(item, dict): + converted_list.append(deep_union_pydantic_dicts(item, destination_value)) + elif isinstance(item, list): + converted_list.append(_union_list_of_pydantic_dicts(item, destination_value)) + else: + converted_list.append(item) + return converted_list + + +def deep_union_pydantic_dicts( + source: typing.Dict[str, typing.Any], destination: typing.Dict[str, typing.Any] +) -> typing.Dict[str, typing.Any]: + for key, value in source.items(): + node = destination.setdefault(key, {}) + if isinstance(value, dict): + deep_union_pydantic_dicts(value, node) + # Note: we do not do this same processing for sets given we do not have sets of models + # and given the sets are unordered, the processing of the set and matching objects would + # be non-trivial. + elif isinstance(value, list): + destination[key] = _union_list_of_pydantic_dicts(value, node) + else: + destination[key] = value + + return destination + + +if IS_PYDANTIC_V2: + + class V2RootModel(UniversalBaseModel, pydantic.RootModel): # type: ignore # Pydantic v2 + pass + + UniversalRootModel: typing_extensions.TypeAlias = V2RootModel # type: ignore +else: + UniversalRootModel: typing_extensions.TypeAlias = UniversalBaseModel # type: ignore + + +def encode_by_type(o: typing.Any) -> typing.Any: + encoders_by_class_tuples: typing.Dict[typing.Callable[[typing.Any], typing.Any], typing.Tuple[typing.Any, ...]] = ( + defaultdict(tuple) + ) + for type_, encoder in encoders_by_type.items(): + encoders_by_class_tuples[encoder] += (type_,) + + if type(o) in encoders_by_type: + return encoders_by_type[type(o)](o) + for encoder, classes_tuple in encoders_by_class_tuples.items(): + if isinstance(o, classes_tuple): + return encoder(o) + + +def update_forward_refs(model: typing.Type["Model"], **localns: typing.Any) -> None: + if IS_PYDANTIC_V2: + model.model_rebuild(raise_errors=False) # type: ignore # Pydantic v2 + else: + model.update_forward_refs(**localns) + + +# Mirrors Pydantic's internal typing +AnyCallable = typing.Callable[..., typing.Any] + + +def universal_root_validator( + pre: bool = False, +) -> typing.Callable[[AnyCallable], AnyCallable]: + def decorator(func: AnyCallable) -> AnyCallable: + if IS_PYDANTIC_V2: + return pydantic.model_validator(mode="before" if pre else "after")(func) # type: ignore # Pydantic v2 + else: + return pydantic.root_validator(pre=pre)(func) # type: ignore # Pydantic v1 + + return decorator + + +def universal_field_validator(field_name: str, pre: bool = False) -> typing.Callable[[AnyCallable], AnyCallable]: + def decorator(func: AnyCallable) -> AnyCallable: + if IS_PYDANTIC_V2: + return pydantic.field_validator(field_name, mode="before" if pre else "after")(func) # type: ignore # Pydantic v2 + else: + return pydantic.validator(field_name, pre=pre)(func) # type: ignore # Pydantic v1 + + return decorator + + +PydanticField = typing.Union[ModelField, pydantic.fields.FieldInfo] + + +def _get_model_fields( + model: typing.Type["Model"], +) -> typing.Mapping[str, PydanticField]: + if IS_PYDANTIC_V2: + return model.model_fields # type: ignore # Pydantic v2 + else: + return model.__fields__ # type: ignore # Pydantic v1 + + +def _get_field_default(field: PydanticField) -> typing.Any: + try: + value = field.get_default() # type: ignore # Pydantic < v1.10.15 + except: + value = field.default + if IS_PYDANTIC_V2: + from pydantic_core import PydanticUndefined + + if value == PydanticUndefined: + return None + return value + return value diff --git a/src/square/core/query_encoder.py b/src/square/core/query_encoder.py new file mode 100644 index 00000000..3183001d --- /dev/null +++ b/src/square/core/query_encoder.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import Any, Dict, List, Optional, Tuple + +import pydantic + + +# Flattens dicts to be of the form {"key[subkey][subkey2]": value} where value is not a dict +def traverse_query_dict(dict_flat: Dict[str, Any], key_prefix: Optional[str] = None) -> List[Tuple[str, Any]]: + result = [] + for k, v in dict_flat.items(): + key = f"{key_prefix}[{k}]" if key_prefix is not None else k + if isinstance(v, dict): + result.extend(traverse_query_dict(v, key)) + elif isinstance(v, list): + for arr_v in v: + if isinstance(arr_v, dict): + result.extend(traverse_query_dict(arr_v, key)) + else: + result.append((key, arr_v)) + else: + result.append((key, v)) + return result + + +def single_query_encoder(query_key: str, query_value: Any) -> List[Tuple[str, Any]]: + if isinstance(query_value, pydantic.BaseModel) or isinstance(query_value, dict): + if isinstance(query_value, pydantic.BaseModel): + obj_dict = query_value.dict(by_alias=True) + else: + obj_dict = query_value + return traverse_query_dict(obj_dict, query_key) + elif isinstance(query_value, list): + encoded_values: List[Tuple[str, Any]] = [] + for value in query_value: + if isinstance(value, pydantic.BaseModel) or isinstance(value, dict): + if isinstance(value, pydantic.BaseModel): + obj_dict = value.dict(by_alias=True) + elif isinstance(value, dict): + obj_dict = value + + encoded_values.extend(single_query_encoder(query_key, obj_dict)) + else: + encoded_values.append((query_key, value)) + + return encoded_values + + return [(query_key, query_value)] + + +def encode_query(query: Optional[Dict[str, Any]]) -> Optional[List[Tuple[str, Any]]]: + if query is None: + return None + + encoded_query = [] + for k, v in query.items(): + encoded_query.extend(single_query_encoder(k, v)) + return encoded_query diff --git a/src/square/core/remove_none_from_dict.py b/src/square/core/remove_none_from_dict.py new file mode 100644 index 00000000..c2298143 --- /dev/null +++ b/src/square/core/remove_none_from_dict.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import Any, Dict, Mapping, Optional + + +def remove_none_from_dict(original: Mapping[str, Optional[Any]]) -> Dict[str, Any]: + new: Dict[str, Any] = {} + for key, value in original.items(): + if value is not None: + new[key] = value + return new diff --git a/src/square/core/request_options.py b/src/square/core/request_options.py new file mode 100644 index 00000000..1b388044 --- /dev/null +++ b/src/square/core/request_options.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +try: + from typing import NotRequired # type: ignore +except ImportError: + from typing_extensions import NotRequired + + +class RequestOptions(typing.TypedDict, total=False): + """ + Additional options for request-specific configuration when calling APIs via the SDK. + This is used primarily as an optional final parameter for service functions. + + Attributes: + - timeout_in_seconds: int. The number of seconds to await an API call before timing out. + + - max_retries: int. The max number of retries to attempt if the API call fails. + + - additional_headers: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's header dict + + - additional_query_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's query parameters dict + + - additional_body_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's body parameters dict + + - chunk_size: int. The size, in bytes, to process each chunk of data being streamed back within the response. This equates to leveraging `chunk_size` within `requests` or `httpx`, and is only leveraged for file downloads. + """ + + timeout_in_seconds: NotRequired[int] + max_retries: NotRequired[int] + additional_headers: NotRequired[typing.Dict[str, typing.Any]] + additional_query_parameters: NotRequired[typing.Dict[str, typing.Any]] + additional_body_parameters: NotRequired[typing.Dict[str, typing.Any]] + chunk_size: NotRequired[int] diff --git a/src/square/core/serialization.py b/src/square/core/serialization.py new file mode 100644 index 00000000..c36e865c --- /dev/null +++ b/src/square/core/serialization.py @@ -0,0 +1,276 @@ +# This file was auto-generated by Fern from our API Definition. + +import collections +import inspect +import typing + +import pydantic +import typing_extensions + + +class FieldMetadata: + """ + Metadata class used to annotate fields to provide additional information. + + Example: + class MyDict(TypedDict): + field: typing.Annotated[str, FieldMetadata(alias="field_name")] + + Will serialize: `{"field": "value"}` + To: `{"field_name": "value"}` + """ + + alias: str + + def __init__(self, *, alias: str) -> None: + self.alias = alias + + +def convert_and_respect_annotation_metadata( + *, + object_: typing.Any, + annotation: typing.Any, + inner_type: typing.Optional[typing.Any] = None, + direction: typing.Literal["read", "write"], +) -> typing.Any: + """ + Respect the metadata annotations on a field, such as aliasing. This function effectively + manipulates the dict-form of an object to respect the metadata annotations. This is primarily used for + TypedDicts, which cannot support aliasing out of the box, and can be extended for additional + utilities, such as defaults. + + Parameters + ---------- + object_ : typing.Any + + annotation : type + The type we're looking to apply typing annotations from + + inner_type : typing.Optional[type] + + Returns + ------- + typing.Any + """ + + if object_ is None: + return None + if inner_type is None: + inner_type = annotation + + clean_type = _remove_annotations(inner_type) + # Pydantic models + if ( + inspect.isclass(clean_type) + and issubclass(clean_type, pydantic.BaseModel) + and isinstance(object_, typing.Mapping) + ): + return _convert_mapping(object_, clean_type, direction) + # TypedDicts + if typing_extensions.is_typeddict(clean_type) and isinstance(object_, typing.Mapping): + return _convert_mapping(object_, clean_type, direction) + + if ( + typing_extensions.get_origin(clean_type) == typing.Dict + or typing_extensions.get_origin(clean_type) == dict + or clean_type == typing.Dict + ) and isinstance(object_, typing.Dict): + key_type = typing_extensions.get_args(clean_type)[0] + value_type = typing_extensions.get_args(clean_type)[1] + + return { + key: convert_and_respect_annotation_metadata( + object_=value, + annotation=annotation, + inner_type=value_type, + direction=direction, + ) + for key, value in object_.items() + } + + # If you're iterating on a string, do not bother to coerce it to a sequence. + if not isinstance(object_, str): + if ( + typing_extensions.get_origin(clean_type) == typing.Set + or typing_extensions.get_origin(clean_type) == set + or clean_type == typing.Set + ) and isinstance(object_, typing.Set): + inner_type = typing_extensions.get_args(clean_type)[0] + return { + convert_and_respect_annotation_metadata( + object_=item, + annotation=annotation, + inner_type=inner_type, + direction=direction, + ) + for item in object_ + } + elif ( + ( + typing_extensions.get_origin(clean_type) == typing.List + or typing_extensions.get_origin(clean_type) == list + or clean_type == typing.List + ) + and isinstance(object_, typing.List) + ) or ( + ( + typing_extensions.get_origin(clean_type) == typing.Sequence + or typing_extensions.get_origin(clean_type) == collections.abc.Sequence + or clean_type == typing.Sequence + ) + and isinstance(object_, typing.Sequence) + ): + inner_type = typing_extensions.get_args(clean_type)[0] + return [ + convert_and_respect_annotation_metadata( + object_=item, + annotation=annotation, + inner_type=inner_type, + direction=direction, + ) + for item in object_ + ] + + if typing_extensions.get_origin(clean_type) == typing.Union: + # We should be able to ~relatively~ safely try to convert keys against all + # member types in the union, the edge case here is if one member aliases a field + # of the same name to a different name from another member + # Or if another member aliases a field of the same name that another member does not. + for member in typing_extensions.get_args(clean_type): + object_ = convert_and_respect_annotation_metadata( + object_=object_, + annotation=annotation, + inner_type=member, + direction=direction, + ) + return object_ + + annotated_type = _get_annotation(annotation) + if annotated_type is None: + return object_ + + # If the object is not a TypedDict, a Union, or other container (list, set, sequence, etc.) + # Then we can safely call it on the recursive conversion. + return object_ + + +def _convert_mapping( + object_: typing.Mapping[str, object], + expected_type: typing.Any, + direction: typing.Literal["read", "write"], +) -> typing.Mapping[str, object]: + converted_object: typing.Dict[str, object] = {} + try: + annotations = typing_extensions.get_type_hints(expected_type, include_extras=True) + except NameError: + # The TypedDict contains a circular reference, so + # we use the __annotations__ attribute directly. + annotations = getattr(expected_type, "__annotations__", {}) + aliases_to_field_names = _get_alias_to_field_name(annotations) + for key, value in object_.items(): + if direction == "read" and key in aliases_to_field_names: + dealiased_key = aliases_to_field_names.get(key) + if dealiased_key is not None: + type_ = annotations.get(dealiased_key) + else: + type_ = annotations.get(key) + # Note you can't get the annotation by the field name if you're in read mode, so you must check the aliases map + # + # So this is effectively saying if we're in write mode, and we don't have a type, or if we're in read mode and we don't have an alias + # then we can just pass the value through as is + if type_ is None: + converted_object[key] = value + elif direction == "read" and key not in aliases_to_field_names: + converted_object[key] = convert_and_respect_annotation_metadata( + object_=value, annotation=type_, direction=direction + ) + else: + converted_object[_alias_key(key, type_, direction, aliases_to_field_names)] = ( + convert_and_respect_annotation_metadata(object_=value, annotation=type_, direction=direction) + ) + return converted_object + + +def _get_annotation(type_: typing.Any) -> typing.Optional[typing.Any]: + maybe_annotated_type = typing_extensions.get_origin(type_) + if maybe_annotated_type is None: + return None + + if maybe_annotated_type == typing_extensions.NotRequired: + type_ = typing_extensions.get_args(type_)[0] + maybe_annotated_type = typing_extensions.get_origin(type_) + + if maybe_annotated_type == typing_extensions.Annotated: + return type_ + + return None + + +def _remove_annotations(type_: typing.Any) -> typing.Any: + maybe_annotated_type = typing_extensions.get_origin(type_) + if maybe_annotated_type is None: + return type_ + + if maybe_annotated_type == typing_extensions.NotRequired: + return _remove_annotations(typing_extensions.get_args(type_)[0]) + + if maybe_annotated_type == typing_extensions.Annotated: + return _remove_annotations(typing_extensions.get_args(type_)[0]) + + return type_ + + +def get_alias_to_field_mapping(type_: typing.Any) -> typing.Dict[str, str]: + annotations = typing_extensions.get_type_hints(type_, include_extras=True) + return _get_alias_to_field_name(annotations) + + +def get_field_to_alias_mapping(type_: typing.Any) -> typing.Dict[str, str]: + annotations = typing_extensions.get_type_hints(type_, include_extras=True) + return _get_field_to_alias_name(annotations) + + +def _get_alias_to_field_name( + field_to_hint: typing.Dict[str, typing.Any], +) -> typing.Dict[str, str]: + aliases = {} + for field, hint in field_to_hint.items(): + maybe_alias = _get_alias_from_type(hint) + if maybe_alias is not None: + aliases[maybe_alias] = field + return aliases + + +def _get_field_to_alias_name( + field_to_hint: typing.Dict[str, typing.Any], +) -> typing.Dict[str, str]: + aliases = {} + for field, hint in field_to_hint.items(): + maybe_alias = _get_alias_from_type(hint) + if maybe_alias is not None: + aliases[field] = maybe_alias + return aliases + + +def _get_alias_from_type(type_: typing.Any) -> typing.Optional[str]: + maybe_annotated_type = _get_annotation(type_) + + if maybe_annotated_type is not None: + # The actual annotations are 1 onward, the first is the annotated type + annotations = typing_extensions.get_args(maybe_annotated_type)[1:] + + for annotation in annotations: + if isinstance(annotation, FieldMetadata) and annotation.alias is not None: + return annotation.alias + return None + + +def _alias_key( + key: str, + type_: typing.Any, + direction: typing.Literal["read", "write"], + aliases_to_field_names: typing.Dict[str, str], +) -> str: + if direction == "read": + return aliases_to_field_names.get(key, key) + return _get_alias_from_type(type_=type_) or key diff --git a/src/square/core/unchecked_base_model.py b/src/square/core/unchecked_base_model.py new file mode 100644 index 00000000..2c2d92a7 --- /dev/null +++ b/src/square/core/unchecked_base_model.py @@ -0,0 +1,303 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import inspect +import typing +import uuid + +import pydantic +import typing_extensions +from .pydantic_utilities import ( + IS_PYDANTIC_V2, + ModelField, + UniversalBaseModel, + get_args, + get_origin, + is_literal_type, + is_union, + parse_date, + parse_datetime, + parse_obj_as, +) +from .serialization import get_field_to_alias_mapping +from pydantic_core import PydanticUndefined + + +class UnionMetadata: + discriminant: str + + def __init__(self, *, discriminant: str) -> None: + self.discriminant = discriminant + + +Model = typing.TypeVar("Model", bound=pydantic.BaseModel) + + +class UncheckedBaseModel(UniversalBaseModel): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2 + else: + + class Config: + extra = pydantic.Extra.allow + + @classmethod + def model_construct( + cls: typing.Type["Model"], + _fields_set: typing.Optional[typing.Set[str]] = None, + **values: typing.Any, + ) -> "Model": + # Fallback construct function to the specified override below. + return cls.construct(_fields_set=_fields_set, **values) + + # Allow construct to not validate model + # Implementation taken from: https://github.com/pydantic/pydantic/issues/1168#issuecomment-817742836 + @classmethod + def construct( + cls: typing.Type["Model"], + _fields_set: typing.Optional[typing.Set[str]] = None, + **values: typing.Any, + ) -> "Model": + m = cls.__new__(cls) + fields_values = {} + + if _fields_set is None: + _fields_set = set(values.keys()) + + fields = _get_model_fields(cls) + populate_by_name = _get_is_populate_by_name(cls) + field_aliases = get_field_to_alias_mapping(cls) + + for name, field in fields.items(): + # Key here is only used to pull data from the values dict + # you should always use the NAME of the field to for field_values, etc. + # because that's how the object is constructed from a pydantic perspective + key = field.alias + if (key is None or field.alias == name) and name in field_aliases: + key = field_aliases[name] + + if key is None or (key not in values and populate_by_name): # Added this to allow population by field name + key = name + + if key in values: + if IS_PYDANTIC_V2: + type_ = field.annotation # type: ignore # Pydantic v2 + else: + type_ = typing.cast(typing.Type, field.outer_type_) # type: ignore # Pydantic < v1.10.15 + + fields_values[name] = ( + construct_type(object_=values[key], type_=type_) if type_ is not None else values[key] + ) + _fields_set.add(name) + else: + default = _get_field_default(field) + fields_values[name] = default + + # If the default values are non-null act like they've been set + # This effectively allows exclude_unset to work like exclude_none where + # the latter passes through intentionally set none values. + if default != None and default != PydanticUndefined: + _fields_set.add(name) + + # Add extras back in + extras = {} + pydantic_alias_fields = [field.alias for field in fields.values()] + internal_alias_fields = list(field_aliases.values()) + for key, value in values.items(): + # If the key is not a field by name, nor an alias to a field, then it's extra + if (key not in pydantic_alias_fields and key not in internal_alias_fields) and key not in fields: + if IS_PYDANTIC_V2: + extras[key] = value + else: + _fields_set.add(key) + fields_values[key] = value + + object.__setattr__(m, "__dict__", fields_values) + + if IS_PYDANTIC_V2: + object.__setattr__(m, "__pydantic_private__", None) + object.__setattr__(m, "__pydantic_extra__", extras) + object.__setattr__(m, "__pydantic_fields_set__", _fields_set) + else: + object.__setattr__(m, "__fields_set__", _fields_set) + m._init_private_attributes() # type: ignore # Pydantic v1 + return m + + +def _convert_undiscriminated_union_type(union_type: typing.Type[typing.Any], object_: typing.Any) -> typing.Any: + inner_types = get_args(union_type) + if typing.Any in inner_types: + return object_ + + for inner_type in inner_types: + try: + if inspect.isclass(inner_type) and issubclass(inner_type, pydantic.BaseModel): + # Attempt a validated parse until one works + return parse_obj_as(inner_type, object_) + except Exception: + continue + + # If none of the types work, just return the first successful cast + for inner_type in inner_types: + try: + return construct_type(object_=object_, type_=inner_type) + except Exception: + continue + + +def _convert_union_type(type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any: + base_type = get_origin(type_) or type_ + union_type = type_ + if base_type == typing_extensions.Annotated: + union_type = get_args(type_)[0] + annotated_metadata = get_args(type_)[1:] + for metadata in annotated_metadata: + if isinstance(metadata, UnionMetadata): + try: + # Cast to the correct type, based on the discriminant + for inner_type in get_args(union_type): + try: + objects_discriminant = getattr(object_, metadata.discriminant) + except: + objects_discriminant = object_[metadata.discriminant] + if inner_type.__fields__[metadata.discriminant].default == objects_discriminant: + return construct_type(object_=object_, type_=inner_type) + except Exception: + # Allow to fall through to our regular union handling + pass + return _convert_undiscriminated_union_type(union_type, object_) + + +def construct_type(*, type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any: + """ + Here we are essentially creating the same `construct` method in spirit as the above, but for all types, not just + Pydantic models. + The idea is to essentially attempt to coerce object_ to type_ (recursively) + """ + # Short circuit when dealing with optionals, don't try to coerces None to a type + if object_ is None: + return None + + base_type = get_origin(type_) or type_ + is_annotated = base_type == typing_extensions.Annotated + maybe_annotation_members = get_args(type_) + is_annotated_union = is_annotated and is_union(get_origin(maybe_annotation_members[0])) + + if base_type == typing.Any: + return object_ + + if base_type == dict: + if not isinstance(object_, typing.Mapping): + return object_ + + key_type, items_type = get_args(type_) + d = { + construct_type(object_=key, type_=key_type): construct_type(object_=item, type_=items_type) + for key, item in object_.items() + } + return d + + if base_type == list: + if not isinstance(object_, list): + return object_ + + inner_type = get_args(type_)[0] + return [construct_type(object_=entry, type_=inner_type) for entry in object_] + + if base_type == set: + if not isinstance(object_, set) and not isinstance(object_, list): + return object_ + + inner_type = get_args(type_)[0] + return {construct_type(object_=entry, type_=inner_type) for entry in object_} + + if is_union(base_type) or is_annotated_union: + return _convert_union_type(type_, object_) + + # Cannot do an `issubclass` with a literal type, let's also just confirm we have a class before this call + if ( + object_ is not None + and not is_literal_type(type_) + and ( + (inspect.isclass(base_type) and issubclass(base_type, pydantic.BaseModel)) + or ( + is_annotated + and inspect.isclass(maybe_annotation_members[0]) + and issubclass(maybe_annotation_members[0], pydantic.BaseModel) + ) + ) + ): + if IS_PYDANTIC_V2: + return type_.model_construct(**object_) + else: + return type_.construct(**object_) + + if base_type == dt.datetime: + try: + return parse_datetime(object_) + except Exception: + return object_ + + if base_type == dt.date: + try: + return parse_date(object_) + except Exception: + return object_ + + if base_type == uuid.UUID: + try: + return uuid.UUID(object_) + except Exception: + return object_ + + if base_type == int: + try: + return int(object_) + except Exception: + return object_ + + if base_type == bool: + try: + if isinstance(object_, str): + stringified_object = object_.lower() + return stringified_object == "true" or stringified_object == "1" + + return bool(object_) + except Exception: + return object_ + + return object_ + + +def _get_is_populate_by_name(model: typing.Type["Model"]) -> bool: + if IS_PYDANTIC_V2: + return model.model_config.get("populate_by_name", False) # type: ignore # Pydantic v2 + return model.__config__.allow_population_by_field_name # type: ignore # Pydantic v1 + + +PydanticField = typing.Union[ModelField, pydantic.fields.FieldInfo] + + +# Pydantic V1 swapped the typing of __fields__'s values from ModelField to FieldInfo +# And so we try to handle both V1 cases, as well as V2 (FieldInfo from model.model_fields) +def _get_model_fields( + model: typing.Type["Model"], +) -> typing.Mapping[str, PydanticField]: + if IS_PYDANTIC_V2: + return model.model_fields # type: ignore # Pydantic v2 + else: + return model.__fields__ # type: ignore # Pydantic v1 + + +def _get_field_default(field: PydanticField) -> typing.Any: + try: + value = field.get_default() # type: ignore # Pydantic < v1.10.15 + except: + value = field.default + if IS_PYDANTIC_V2: + from pydantic_core import PydanticUndefined + + if value == PydanticUndefined: + return None + return value + return value diff --git a/src/square/customers/__init__.py b/src/square/customers/__init__.py new file mode 100644 index 00000000..6b3e506c --- /dev/null +++ b/src/square/customers/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import cards, custom_attribute_definitions, custom_attributes, groups, segments + +__all__ = ["cards", "custom_attribute_definitions", "custom_attributes", "groups", "segments"] diff --git a/src/square/customers/cards/__init__.py b/src/square/customers/cards/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/customers/cards/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/customers/cards/client.py b/src/square/customers/cards/client.py new file mode 100644 index 00000000..90364144 --- /dev/null +++ b/src/square/customers/cards/client.py @@ -0,0 +1,308 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCardsClient +from ...requests.address import AddressParams +from ...core.request_options import RequestOptions +from ...types.create_customer_card_response import CreateCustomerCardResponse +from ...types.delete_customer_card_response import DeleteCustomerCardResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCardsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCardsClient + """ + return self._raw_client + + def create( + self, + customer_id: str, + *, + card_nonce: str, + billing_address: typing.Optional[AddressParams] = OMIT, + cardholder_name: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerCardResponse: + """ + Adds a card on file to an existing customer. + + As with charges, calls to `CreateCustomerCard` are idempotent. Multiple + calls with the same card nonce return the same card record that was created + with the provided nonce during the _first_ call. + + Parameters + ---------- + customer_id : str + The Square ID of the customer profile the card is linked to. + + card_nonce : str + A card nonce representing the credit card to link to the customer. + + Card nonces are generated by the Square payment form when customers enter + their card information. For more information, see + [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment). + + __NOTE:__ Card nonces generated by digital wallets (such as Apple Pay) + cannot be used to create a customer card. + + billing_address : typing.Optional[AddressParams] + Address information for the card on file. + + __NOTE:__ If a billing address is provided in the request, the + `CreateCustomerCardRequest.billing_address.postal_code` must match + the postal code encoded in the card nonce. + + cardholder_name : typing.Optional[str] + The full name printed on the credit card. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.cards.create( + customer_id="customer_id", + card_nonce="YOUR_CARD_NONCE", + billing_address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + cardholder_name="Amelia Earhart", + ) + """ + response = self._raw_client.create( + customer_id, + card_nonce=card_nonce, + billing_address=billing_address, + cardholder_name=cardholder_name, + verification_token=verification_token, + request_options=request_options, + ) + return response.data + + def delete( + self, customer_id: str, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerCardResponse: + """ + Removes a card on file from a customer. + + Parameters + ---------- + customer_id : str + The ID of the customer that the card on file belongs to. + + card_id : str + The ID of the card on file to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.cards.delete( + customer_id="customer_id", + card_id="card_id", + ) + """ + response = self._raw_client.delete(customer_id, card_id, request_options=request_options) + return response.data + + +class AsyncCardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCardsClient + """ + return self._raw_client + + async def create( + self, + customer_id: str, + *, + card_nonce: str, + billing_address: typing.Optional[AddressParams] = OMIT, + cardholder_name: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerCardResponse: + """ + Adds a card on file to an existing customer. + + As with charges, calls to `CreateCustomerCard` are idempotent. Multiple + calls with the same card nonce return the same card record that was created + with the provided nonce during the _first_ call. + + Parameters + ---------- + customer_id : str + The Square ID of the customer profile the card is linked to. + + card_nonce : str + A card nonce representing the credit card to link to the customer. + + Card nonces are generated by the Square payment form when customers enter + their card information. For more information, see + [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment). + + __NOTE:__ Card nonces generated by digital wallets (such as Apple Pay) + cannot be used to create a customer card. + + billing_address : typing.Optional[AddressParams] + Address information for the card on file. + + __NOTE:__ If a billing address is provided in the request, the + `CreateCustomerCardRequest.billing_address.postal_code` must match + the postal code encoded in the card nonce. + + cardholder_name : typing.Optional[str] + The full name printed on the credit card. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.cards.create( + customer_id="customer_id", + card_nonce="YOUR_CARD_NONCE", + billing_address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + cardholder_name="Amelia Earhart", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + customer_id, + card_nonce=card_nonce, + billing_address=billing_address, + cardholder_name=cardholder_name, + verification_token=verification_token, + request_options=request_options, + ) + return response.data + + async def delete( + self, customer_id: str, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerCardResponse: + """ + Removes a card on file from a customer. + + Parameters + ---------- + customer_id : str + The ID of the customer that the card on file belongs to. + + card_id : str + The ID of the card on file to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.cards.delete( + customer_id="customer_id", + card_id="card_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(customer_id, card_id, request_options=request_options) + return response.data diff --git a/src/square/customers/cards/raw_client.py b/src/square/customers/cards/raw_client.py new file mode 100644 index 00000000..e83cc619 --- /dev/null +++ b/src/square/customers/cards/raw_client.py @@ -0,0 +1,287 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.address import AddressParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_customer_card_response import CreateCustomerCardResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.delete_customer_card_response import DeleteCustomerCardResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + customer_id: str, + *, + card_nonce: str, + billing_address: typing.Optional[AddressParams] = OMIT, + cardholder_name: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCustomerCardResponse]: + """ + Adds a card on file to an existing customer. + + As with charges, calls to `CreateCustomerCard` are idempotent. Multiple + calls with the same card nonce return the same card record that was created + with the provided nonce during the _first_ call. + + Parameters + ---------- + customer_id : str + The Square ID of the customer profile the card is linked to. + + card_nonce : str + A card nonce representing the credit card to link to the customer. + + Card nonces are generated by the Square payment form when customers enter + their card information. For more information, see + [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment). + + __NOTE:__ Card nonces generated by digital wallets (such as Apple Pay) + cannot be used to create a customer card. + + billing_address : typing.Optional[AddressParams] + Address information for the card on file. + + __NOTE:__ If a billing address is provided in the request, the + `CreateCustomerCardRequest.billing_address.postal_code` must match + the postal code encoded in the card nonce. + + cardholder_name : typing.Optional[str] + The full name printed on the credit card. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCustomerCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/cards", + method="POST", + json={ + "card_nonce": card_nonce, + "billing_address": convert_and_respect_annotation_metadata( + object_=billing_address, annotation=AddressParams, direction="write" + ), + "cardholder_name": cardholder_name, + "verification_token": verification_token, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerCardResponse, + construct_type( + type_=CreateCustomerCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, customer_id: str, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteCustomerCardResponse]: + """ + Removes a card on file from a customer. + + Parameters + ---------- + customer_id : str + The ID of the customer that the card on file belongs to. + + card_id : str + The ID of the card on file to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteCustomerCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/cards/{jsonable_encoder(card_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerCardResponse, + construct_type( + type_=DeleteCustomerCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + customer_id: str, + *, + card_nonce: str, + billing_address: typing.Optional[AddressParams] = OMIT, + cardholder_name: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCustomerCardResponse]: + """ + Adds a card on file to an existing customer. + + As with charges, calls to `CreateCustomerCard` are idempotent. Multiple + calls with the same card nonce return the same card record that was created + with the provided nonce during the _first_ call. + + Parameters + ---------- + customer_id : str + The Square ID of the customer profile the card is linked to. + + card_nonce : str + A card nonce representing the credit card to link to the customer. + + Card nonces are generated by the Square payment form when customers enter + their card information. For more information, see + [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment). + + __NOTE:__ Card nonces generated by digital wallets (such as Apple Pay) + cannot be used to create a customer card. + + billing_address : typing.Optional[AddressParams] + Address information for the card on file. + + __NOTE:__ If a billing address is provided in the request, the + `CreateCustomerCardRequest.billing_address.postal_code` must match + the postal code encoded in the card nonce. + + cardholder_name : typing.Optional[str] + The full name printed on the credit card. + + verification_token : typing.Optional[str] + An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCustomerCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/cards", + method="POST", + json={ + "card_nonce": card_nonce, + "billing_address": convert_and_respect_annotation_metadata( + object_=billing_address, annotation=AddressParams, direction="write" + ), + "cardholder_name": cardholder_name, + "verification_token": verification_token, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerCardResponse, + construct_type( + type_=CreateCustomerCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, customer_id: str, card_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteCustomerCardResponse]: + """ + Removes a card on file from a customer. + + Parameters + ---------- + customer_id : str + The ID of the customer that the card on file belongs to. + + card_id : str + The ID of the card on file to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteCustomerCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/cards/{jsonable_encoder(card_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerCardResponse, + construct_type( + type_=DeleteCustomerCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/customers/client.py b/src/square/customers/client.py new file mode 100644 index 00000000..95d83b2a --- /dev/null +++ b/src/square/customers/client.py @@ -0,0 +1,1675 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomersClient +from .custom_attribute_definitions.client import CustomAttributeDefinitionsClient +from .groups.client import GroupsClient +from .segments.client import SegmentsClient +from .cards.client import CardsClient +from .custom_attributes.client import CustomAttributesClient +from ..types.customer_sort_field import CustomerSortField +from ..types.sort_order import SortOrder +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.customer import Customer +from ..types.list_customers_response import ListCustomersResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.address import AddressParams +from ..requests.customer_tax_ids import CustomerTaxIdsParams +from ..types.create_customer_response import CreateCustomerResponse +from ..requests.bulk_create_customer_data import BulkCreateCustomerDataParams +from ..types.bulk_create_customers_response import BulkCreateCustomersResponse +from ..types.bulk_delete_customers_response import BulkDeleteCustomersResponse +from ..types.bulk_retrieve_customers_response import BulkRetrieveCustomersResponse +from ..requests.bulk_update_customer_data import BulkUpdateCustomerDataParams +from ..types.bulk_update_customers_response import BulkUpdateCustomersResponse +from ..requests.customer_query import CustomerQueryParams +from ..types.search_customers_response import SearchCustomersResponse +from ..types.get_customer_response import GetCustomerResponse +from ..types.update_customer_response import UpdateCustomerResponse +from ..types.delete_customer_response import DeleteCustomerResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomersClient +from .custom_attribute_definitions.client import AsyncCustomAttributeDefinitionsClient +from .groups.client import AsyncGroupsClient +from .segments.client import AsyncSegmentsClient +from .cards.client import AsyncCardsClient +from .custom_attributes.client import AsyncCustomAttributesClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomersClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = CustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.groups = GroupsClient(client_wrapper=client_wrapper) + + self.segments = SegmentsClient(client_wrapper=client_wrapper) + + self.cards = CardsClient(client_wrapper=client_wrapper) + + self.custom_attributes = CustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomersClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + sort_field: typing.Optional[CustomerSortField] = None, + sort_order: typing.Optional[SortOrder] = None, + count: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Customer]: + """ + Lists customer profiles associated with a Square account. + + Under normal operating conditions, newly created or updated customer profiles become available + for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated + profiles can take closer to one minute or longer, especially during network incidents and outages. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + sort_field : typing.Optional[CustomerSortField] + Indicates how customers should be sorted. + + The default value is `DEFAULT`. + + sort_order : typing.Optional[SortOrder] + Indicates whether customers should be sorted in ascending (`ASC`) or + descending (`DESC`) order. + + The default value is `ASC`. + + count : typing.Optional[bool] + Indicates whether to return the total count of customers in the `count` field of the response. + + The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Customer] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.customers.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/customers", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + "sort_field": sort_field, + "sort_order": sort_order, + "count": count, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomersResponse, + construct_type( + type_=ListCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + sort_field=sort_field, + sort_order=sort_order, + count=count, + request_options=request_options, + ) + _items = _parsed_response.customers + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerResponse: + """ + Creates a new customer for a business. + + You must provide at least one of the following values in your request to this + endpoint: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. For maximum length constraints, see + [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.create( + given_name="Amelia", + family_name="Earhart", + email_address="Amelia.Earhart@example.com", + address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + phone_number="+1-212-555-4240", + reference_id="YOUR_REFERENCE_ID", + note="a customer", + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, + given_name=given_name, + family_name=family_name, + company_name=company_name, + nickname=nickname, + email_address=email_address, + address=address, + phone_number=phone_number, + reference_id=reference_id, + note=note, + birthday=birthday, + tax_ids=tax_ids, + request_options=request_options, + ) + return response.data + + def batch_create( + self, + *, + customers: typing.Dict[str, BulkCreateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkCreateCustomersResponse: + """ + Creates multiple [customer profiles](entity:Customer) for a business. + + This endpoint takes a map of individual create requests and returns a map of responses. + + You must provide at least one of the following values in each create request: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + customers : typing.Dict[str, BulkCreateCustomerDataParams] + A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }` + key-value pairs. + + Each key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + that uniquely identifies the create request. Each value contains the customer data used to create the + customer profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkCreateCustomersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.batch_create( + customers={ + "8bb76c4f-e35d-4c5b-90de-1194cd9179f0": { + "given_name": "Amelia", + "family_name": "Earhart", + "email_address": "Amelia.Earhart@example.com", + "address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "phone_number": "+1-212-555-4240", + "reference_id": "YOUR_REFERENCE_ID", + "note": "a customer", + }, + "d1689f23-b25d-4932-b2f0-aed00f5e2029": { + "given_name": "Marie", + "family_name": "Curie", + "email_address": "Marie.Curie@example.com", + "address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 601", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "phone_number": "+1-212-444-4240", + "reference_id": "YOUR_REFERENCE_ID", + "note": "another customer", + }, + }, + ) + """ + response = self._raw_client.batch_create(customers=customers, request_options=request_options) + return response.data + + def bulk_delete_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkDeleteCustomersResponse: + """ + Deletes multiple customer profiles. + + The endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteCustomersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.bulk_delete_customers( + customer_ids=[ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8", + ], + ) + """ + response = self._raw_client.bulk_delete_customers(customer_ids=customer_ids, request_options=request_options) + return response.data + + def bulk_retrieve_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkRetrieveCustomersResponse: + """ + Retrieves multiple customer profiles. + + This endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkRetrieveCustomersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.bulk_retrieve_customers( + customer_ids=[ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8", + ], + ) + """ + response = self._raw_client.bulk_retrieve_customers(customer_ids=customer_ids, request_options=request_options) + return response.data + + def bulk_update_customers( + self, + *, + customers: typing.Dict[str, BulkUpdateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpdateCustomersResponse: + """ + Updates multiple customer profiles. + + This endpoint takes a map of individual update requests and returns a map of responses. + + Parameters + ---------- + customers : typing.Dict[str, BulkUpdateCustomerDataParams] + A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }` + key-value pairs. + + Each key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile + that was created by merging existing profiles, provide the ID of the newly created profile. + + Each value contains the updated customer data. Only new or changed fields are required. To add or + update a field, specify the new value. To remove a field, specify `null`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpdateCustomersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.bulk_update_customers( + customers={ + "8DDA5NZVBZFGAX0V3HPF81HHE0": { + "email_address": "New.Amelia.Earhart@example.com", + "note": "updated customer note", + "version": 2, + }, + "N18CPRVXR5214XPBBA6BZQWF3C": { + "given_name": "Marie", + "family_name": "Curie", + "version": 0, + }, + }, + ) + """ + response = self._raw_client.bulk_update_customers(customers=customers, request_options=request_options) + return response.data + + def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[CustomerQueryParams] = OMIT, + count: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchCustomersResponse: + """ + Searches the customer profiles associated with a Square account using one or more supported query filters. + + Calling `SearchCustomers` without any explicit query filter returns all + customer profiles ordered alphabetically based on `given_name` and + `family_name`. + + Under normal operating conditions, newly created or updated customer profiles become available + for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated + profiles can take closer to one minute or longer, especially during network incidents and outages. + + Parameters + ---------- + cursor : typing.Optional[str] + Include the pagination cursor in subsequent calls to this endpoint to retrieve + the next set of results associated with the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[CustomerQueryParams] + The filtering and sorting criteria for the search request. If a query is not specified, + Square returns all customer profiles ordered alphabetically by `given_name` and `family_name`. + + count : typing.Optional[bool] + Indicates whether to return the total count of matching customers in the `count` field of the response. + + The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchCustomersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.search( + limit=2, + query={ + "filter": { + "creation_source": {"values": ["THIRD_PARTY"], "rule": "INCLUDE"}, + "created_at": { + "start_at": "2018-01-01T00:00:00-00:00", + "end_at": "2018-02-01T00:00:00-00:00", + }, + "email_address": {"fuzzy": "example.com"}, + "group_ids": {"all_": ["545AXB44B4XXWMVQ4W8SBT3HHF"]}, + }, + "sort": {"field": "CREATED_AT", "order": "ASC"}, + }, + ) + """ + response = self._raw_client.search( + cursor=cursor, limit=limit, query=query, count=count, request_options=request_options + ) + return response.data + + def get(self, customer_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetCustomerResponse: + """ + Returns details for a single customer. + + Parameters + ---------- + customer_id : str + The ID of the customer to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.get( + customer_id="customer_id", + ) + """ + response = self._raw_client.get(customer_id, request_options=request_options) + return response.data + + def update( + self, + customer_id: str, + *, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + version: typing.Optional[int] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateCustomerResponse: + """ + Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. + To add or update a field, specify the new value. To remove a field, specify `null`. + + To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to update. + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. Only new or changed fields are required in the request. + + For maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCustomerResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.update( + customer_id="customer_id", + email_address="New.Amelia.Earhart@example.com", + note="updated customer note", + version=2, + ) + """ + response = self._raw_client.update( + customer_id, + given_name=given_name, + family_name=family_name, + company_name=company_name, + nickname=nickname, + email_address=email_address, + address=address, + phone_number=phone_number, + reference_id=reference_id, + note=note, + birthday=birthday, + version=version, + tax_ids=tax_ids, + request_options=request_options, + ) + return response.data + + def delete( + self, + customer_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> DeleteCustomerResponse: + """ + Deletes a customer profile from a business. + + To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to delete. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.delete( + customer_id="customer_id", + ) + """ + response = self._raw_client.delete(customer_id, version=version, request_options=request_options) + return response.data + + +class AsyncCustomersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomersClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = AsyncCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.groups = AsyncGroupsClient(client_wrapper=client_wrapper) + + self.segments = AsyncSegmentsClient(client_wrapper=client_wrapper) + + self.cards = AsyncCardsClient(client_wrapper=client_wrapper) + + self.custom_attributes = AsyncCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomersClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + sort_field: typing.Optional[CustomerSortField] = None, + sort_order: typing.Optional[SortOrder] = None, + count: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Customer]: + """ + Lists customer profiles associated with a Square account. + + Under normal operating conditions, newly created or updated customer profiles become available + for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated + profiles can take closer to one minute or longer, especially during network incidents and outages. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + sort_field : typing.Optional[CustomerSortField] + Indicates how customers should be sorted. + + The default value is `DEFAULT`. + + sort_order : typing.Optional[SortOrder] + Indicates whether customers should be sorted in ascending (`ASC`) or + descending (`DESC`) order. + + The default value is `ASC`. + + count : typing.Optional[bool] + Indicates whether to return the total count of customers in the `count` field of the response. + + The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Customer] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.customers.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/customers", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + "sort_field": sort_field, + "sort_order": sort_order, + "count": count, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomersResponse, + construct_type( + type_=ListCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + sort_field=sort_field, + sort_order=sort_order, + count=count, + request_options=request_options, + ) + _items = _parsed_response.customers + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerResponse: + """ + Creates a new customer for a business. + + You must provide at least one of the following values in your request to this + endpoint: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. For maximum length constraints, see + [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.create( + given_name="Amelia", + family_name="Earhart", + email_address="Amelia.Earhart@example.com", + address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + phone_number="+1-212-555-4240", + reference_id="YOUR_REFERENCE_ID", + note="a customer", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, + given_name=given_name, + family_name=family_name, + company_name=company_name, + nickname=nickname, + email_address=email_address, + address=address, + phone_number=phone_number, + reference_id=reference_id, + note=note, + birthday=birthday, + tax_ids=tax_ids, + request_options=request_options, + ) + return response.data + + async def batch_create( + self, + *, + customers: typing.Dict[str, BulkCreateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkCreateCustomersResponse: + """ + Creates multiple [customer profiles](entity:Customer) for a business. + + This endpoint takes a map of individual create requests and returns a map of responses. + + You must provide at least one of the following values in each create request: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + customers : typing.Dict[str, BulkCreateCustomerDataParams] + A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }` + key-value pairs. + + Each key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + that uniquely identifies the create request. Each value contains the customer data used to create the + customer profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkCreateCustomersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.batch_create( + customers={ + "8bb76c4f-e35d-4c5b-90de-1194cd9179f0": { + "given_name": "Amelia", + "family_name": "Earhart", + "email_address": "Amelia.Earhart@example.com", + "address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "phone_number": "+1-212-555-4240", + "reference_id": "YOUR_REFERENCE_ID", + "note": "a customer", + }, + "d1689f23-b25d-4932-b2f0-aed00f5e2029": { + "given_name": "Marie", + "family_name": "Curie", + "email_address": "Marie.Curie@example.com", + "address": { + "address_line1": "500 Electric Ave", + "address_line2": "Suite 601", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "phone_number": "+1-212-444-4240", + "reference_id": "YOUR_REFERENCE_ID", + "note": "another customer", + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_create(customers=customers, request_options=request_options) + return response.data + + async def bulk_delete_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkDeleteCustomersResponse: + """ + Deletes multiple customer profiles. + + The endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteCustomersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.bulk_delete_customers( + customer_ids=[ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8", + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.bulk_delete_customers( + customer_ids=customer_ids, request_options=request_options + ) + return response.data + + async def bulk_retrieve_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> BulkRetrieveCustomersResponse: + """ + Retrieves multiple customer profiles. + + This endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkRetrieveCustomersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.bulk_retrieve_customers( + customer_ids=[ + "8DDA5NZVBZFGAX0V3HPF81HHE0", + "N18CPRVXR5214XPBBA6BZQWF3C", + "2GYD7WNXF7BJZW1PMGNXZ3Y8M8", + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.bulk_retrieve_customers( + customer_ids=customer_ids, request_options=request_options + ) + return response.data + + async def bulk_update_customers( + self, + *, + customers: typing.Dict[str, BulkUpdateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpdateCustomersResponse: + """ + Updates multiple customer profiles. + + This endpoint takes a map of individual update requests and returns a map of responses. + + Parameters + ---------- + customers : typing.Dict[str, BulkUpdateCustomerDataParams] + A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }` + key-value pairs. + + Each key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile + that was created by merging existing profiles, provide the ID of the newly created profile. + + Each value contains the updated customer data. Only new or changed fields are required. To add or + update a field, specify the new value. To remove a field, specify `null`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpdateCustomersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.bulk_update_customers( + customers={ + "8DDA5NZVBZFGAX0V3HPF81HHE0": { + "email_address": "New.Amelia.Earhart@example.com", + "note": "updated customer note", + "version": 2, + }, + "N18CPRVXR5214XPBBA6BZQWF3C": { + "given_name": "Marie", + "family_name": "Curie", + "version": 0, + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.bulk_update_customers(customers=customers, request_options=request_options) + return response.data + + async def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[CustomerQueryParams] = OMIT, + count: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchCustomersResponse: + """ + Searches the customer profiles associated with a Square account using one or more supported query filters. + + Calling `SearchCustomers` without any explicit query filter returns all + customer profiles ordered alphabetically based on `given_name` and + `family_name`. + + Under normal operating conditions, newly created or updated customer profiles become available + for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated + profiles can take closer to one minute or longer, especially during network incidents and outages. + + Parameters + ---------- + cursor : typing.Optional[str] + Include the pagination cursor in subsequent calls to this endpoint to retrieve + the next set of results associated with the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[CustomerQueryParams] + The filtering and sorting criteria for the search request. If a query is not specified, + Square returns all customer profiles ordered alphabetically by `given_name` and `family_name`. + + count : typing.Optional[bool] + Indicates whether to return the total count of matching customers in the `count` field of the response. + + The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchCustomersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.search( + limit=2, + query={ + "filter": { + "creation_source": { + "values": ["THIRD_PARTY"], + "rule": "INCLUDE", + }, + "created_at": { + "start_at": "2018-01-01T00:00:00-00:00", + "end_at": "2018-02-01T00:00:00-00:00", + }, + "email_address": {"fuzzy": "example.com"}, + "group_ids": {"all_": ["545AXB44B4XXWMVQ4W8SBT3HHF"]}, + }, + "sort": {"field": "CREATED_AT", "order": "ASC"}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + cursor=cursor, limit=limit, query=query, count=count, request_options=request_options + ) + return response.data + + async def get( + self, customer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerResponse: + """ + Returns details for a single customer. + + Parameters + ---------- + customer_id : str + The ID of the customer to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.get( + customer_id="customer_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(customer_id, request_options=request_options) + return response.data + + async def update( + self, + customer_id: str, + *, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + version: typing.Optional[int] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateCustomerResponse: + """ + Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. + To add or update a field, specify the new value. To remove a field, specify `null`. + + To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to update. + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. Only new or changed fields are required in the request. + + For maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCustomerResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.update( + customer_id="customer_id", + email_address="New.Amelia.Earhart@example.com", + note="updated customer note", + version=2, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + customer_id, + given_name=given_name, + family_name=family_name, + company_name=company_name, + nickname=nickname, + email_address=email_address, + address=address, + phone_number=phone_number, + reference_id=reference_id, + note=note, + birthday=birthday, + version=version, + tax_ids=tax_ids, + request_options=request_options, + ) + return response.data + + async def delete( + self, + customer_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> DeleteCustomerResponse: + """ + Deletes a customer profile from a business. + + To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to delete. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.delete( + customer_id="customer_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(customer_id, version=version, request_options=request_options) + return response.data diff --git a/src/square/customers/custom_attribute_definitions/__init__.py b/src/square/customers/custom_attribute_definitions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/customers/custom_attribute_definitions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/customers/custom_attribute_definitions/client.py b/src/square/customers/custom_attribute_definitions/client.py new file mode 100644 index 00000000..4ff99540 --- /dev/null +++ b/src/square/customers/custom_attribute_definitions/client.py @@ -0,0 +1,882 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributeDefinitionsClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.custom_attribute_definition import CustomAttributeDefinition +from ...types.list_customer_custom_attribute_definitions_response import ListCustomerCustomAttributeDefinitionsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...types.create_customer_custom_attribute_definition_response import ( + CreateCustomerCustomAttributeDefinitionResponse, +) +from ...types.get_customer_custom_attribute_definition_response import GetCustomerCustomAttributeDefinitionResponse +from ...types.update_customer_custom_attribute_definition_response import ( + UpdateCustomerCustomAttributeDefinitionResponse, +) +from ...types.delete_customer_custom_attribute_definition_response import ( + DeleteCustomerCustomAttributeDefinitionResponse, +) +from ...requests.batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request import ( + BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams, +) +from ...types.batch_upsert_customer_custom_attributes_response import BatchUpsertCustomerCustomAttributesResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributeDefinitionsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributeDefinitionsClient + """ + return self._raw_client + + def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttributeDefinition]: + """ + Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that + seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.customers.custom_attribute_definitions.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/customers/custom-attribute-definitions", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerCustomAttributeDefinitionsResponse, + construct_type( + type_=ListCustomerCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerCustomAttributeDefinitionResponse: + """ + Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with customer profiles. + + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + to set the custom attribute for customer profiles in the seller's Customer Directory. + + Sellers can view all custom attributes in exported customer data, including those set to + `VISIBILITY_HIDDEN`. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "favoritemovie", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Favorite Movie", + "description": "The favorite movie of the customer.", + "visibility": "VISIBILITY_HIDDEN", + }, + ) + """ + response = self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerCustomAttributeDefinitionResponse: + """ + Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attribute_definitions.get( + key="key", + ) + """ + response = self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateCustomerCustomAttributeDefinitionResponse: + """ + Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + + Only the definition owner can update a custom attribute definition. Note that sellers can view + all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + """ + response = self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerCustomAttributeDefinitionResponse: + """ + Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all customer profiles in the seller's Customer Directory. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attribute_definitions.delete( + key="key", + ) + """ + response = self._raw_client.delete(key, request_options=request_options) + return response.data + + def batch_upsert( + self, + *, + values: typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpsertCustomerCustomAttributesResponse: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation. + + Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a customer ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpsertCustomerCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attribute_definitions.batch_upsert( + values={ + "id1": { + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": {"key": "favoritemovie", "value": "Dune"}, + }, + "id2": { + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": {"key": "ownsmovie", "value": False}, + }, + "id3": { + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": {"key": "favoritemovie", "value": "Star Wars"}, + }, + "id4": { + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": { + "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808", + "value": "10.5", + }, + }, + "id5": { + "customer_id": "70548QG1HN43B05G0KCZ4MMC1G", + "custom_attribute": { + "key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail", + "value": "fake-email@squareup.com", + }, + }, + }, + ) + """ + response = self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + +class AsyncCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributeDefinitionsClient + """ + return self._raw_client + + async def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttributeDefinition]: + """ + Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that + seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.customers.custom_attribute_definitions.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/customers/custom-attribute-definitions", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerCustomAttributeDefinitionsResponse, + construct_type( + type_=ListCustomerCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerCustomAttributeDefinitionResponse: + """ + Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with customer profiles. + + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + to set the custom attribute for customer profiles in the seller's Customer Directory. + + Sellers can view all custom attributes in exported customer data, including those set to + `VISIBILITY_HIDDEN`. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "favoritemovie", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Favorite Movie", + "description": "The favorite movie of the customer.", + "visibility": "VISIBILITY_HIDDEN", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerCustomAttributeDefinitionResponse: + """ + Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attribute_definitions.get( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateCustomerCustomAttributeDefinitionResponse: + """ + Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + + Only the definition owner can update a custom attribute definition. Note that sellers can view + all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerCustomAttributeDefinitionResponse: + """ + Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all customer profiles in the seller's Customer Directory. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attribute_definitions.delete( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(key, request_options=request_options) + return response.data + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpsertCustomerCustomAttributesResponse: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation. + + Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a customer ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpsertCustomerCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attribute_definitions.batch_upsert( + values={ + "id1": { + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": {"key": "favoritemovie", "value": "Dune"}, + }, + "id2": { + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": {"key": "ownsmovie", "value": False}, + }, + "id3": { + "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM", + "custom_attribute": { + "key": "favoritemovie", + "value": "Star Wars", + }, + }, + "id4": { + "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", + "custom_attribute": { + "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808", + "value": "10.5", + }, + }, + "id5": { + "customer_id": "70548QG1HN43B05G0KCZ4MMC1G", + "custom_attribute": { + "key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail", + "value": "fake-email@squareup.com", + }, + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data diff --git a/src/square/customers/custom_attribute_definitions/raw_client.py b/src/square/customers/custom_attribute_definitions/raw_client.py new file mode 100644 index 00000000..1330e59e --- /dev/null +++ b/src/square/customers/custom_attribute_definitions/raw_client.py @@ -0,0 +1,681 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_customer_custom_attribute_definition_response import ( + CreateCustomerCustomAttributeDefinitionResponse, +) +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_customer_custom_attribute_definition_response import GetCustomerCustomAttributeDefinitionResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_customer_custom_attribute_definition_response import ( + UpdateCustomerCustomAttributeDefinitionResponse, +) +from ...types.delete_customer_custom_attribute_definition_response import ( + DeleteCustomerCustomAttributeDefinitionResponse, +) +from ...requests.batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request import ( + BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams, +) +from ...types.batch_upsert_customer_custom_attributes_response import BatchUpsertCustomerCustomAttributesResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCustomerCustomAttributeDefinitionResponse]: + """ + Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with customer profiles. + + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + to set the custom attribute for customer profiles in the seller's Customer Directory. + + Sellers can view all custom attributes in exported customer data, including those set to + `VISIBILITY_HIDDEN`. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=CreateCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetCustomerCustomAttributeDefinitionResponse]: + """ + Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=GetCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateCustomerCustomAttributeDefinitionResponse]: + """ + Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + + Only the definition owner can update a custom attribute definition. Note that sellers can view + all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteCustomerCustomAttributeDefinitionResponse]: + """ + Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all customer profiles in the seller's Customer Directory. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_upsert( + self, + *, + values: typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchUpsertCustomerCustomAttributesResponse]: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation. + + Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a customer ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchUpsertCustomerCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpsertCustomerCustomAttributesResponse, + construct_type( + type_=BatchUpsertCustomerCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCustomerCustomAttributeDefinitionResponse]: + """ + Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with customer profiles. + + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or + [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + to set the custom attribute for customer profiles in the seller's Customer Directory. + + Sellers can view all custom attributes in exported customer data, including those set to + `VISIBILITY_HIDDEN`. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=CreateCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetCustomerCustomAttributeDefinitionResponse]: + """ + Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=GetCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateCustomerCustomAttributeDefinitionResponse]: + """ + Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + + Only the definition owner can update a custom attribute definition. Note that sellers can view + all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteCustomerCustomAttributeDefinitionResponse]: + """ + Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all customer profiles in the seller's Customer Directory. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteCustomerCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteCustomerCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchUpsertCustomerCustomAttributesResponse]: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation. + + Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a customer ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchUpsertCustomerCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpsertCustomerCustomAttributesResponse, + construct_type( + type_=BatchUpsertCustomerCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/customers/custom_attributes/__init__.py b/src/square/customers/custom_attributes/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/customers/custom_attributes/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/customers/custom_attributes/client.py b/src/square/customers/custom_attributes/client.py new file mode 100644 index 00000000..fa57cc6a --- /dev/null +++ b/src/square/customers/custom_attributes/client.py @@ -0,0 +1,647 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributesClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.custom_attribute import CustomAttribute +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_customer_custom_attributes_response import ListCustomerCustomAttributesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_customer_custom_attribute_response import GetCustomerCustomAttributeResponse +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_customer_custom_attribute_response import UpsertCustomerCustomAttributeResponse +from ...types.delete_customer_custom_attribute_response import DeleteCustomerCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributesClient + """ + return self._raw_client + + def list( + self, + customer_id: str, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with a customer profile. + + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttribute] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.customers.custom_attributes.list( + customer_id="customer_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerCustomAttributesResponse, + construct_type( + type_=ListCustomerCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + customer_id, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + customer_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> GetCustomerCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attributes.get( + customer_id="customer_id", + key="key", + ) + """ + response = self._raw_client.get( + customer_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + def upsert( + self, + customer_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertCustomerCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile. + + Use this endpoint to set the value of a custom attribute for a specified customer profile. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertCustomerCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attributes.upsert( + customer_id="customer_id", + key="key", + custom_attribute={"value": "Dune"}, + ) + """ + response = self._raw_client.upsert( + customer_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, customer_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.custom_attributes.delete( + customer_id="customer_id", + key="key", + ) + """ + response = self._raw_client.delete(customer_id, key, request_options=request_options) + return response.data + + +class AsyncCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributesClient + """ + return self._raw_client + + async def list( + self, + customer_id: str, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with a customer profile. + + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttribute] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.customers.custom_attributes.list( + customer_id="customer_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerCustomAttributesResponse, + construct_type( + type_=ListCustomerCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + customer_id, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + customer_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> GetCustomerCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attributes.get( + customer_id="customer_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get( + customer_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + async def upsert( + self, + customer_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertCustomerCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile. + + Use this endpoint to set the value of a custom attribute for a specified customer profile. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertCustomerCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attributes.upsert( + customer_id="customer_id", + key="key", + custom_attribute={"value": "Dune"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert( + customer_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, customer_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.custom_attributes.delete( + customer_id="customer_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(customer_id, key, request_options=request_options) + return response.data diff --git a/src/square/customers/custom_attributes/raw_client.py b/src/square/customers/custom_attributes/raw_client.py new file mode 100644 index 00000000..4b8f6fa9 --- /dev/null +++ b/src/square/customers/custom_attributes/raw_client.py @@ -0,0 +1,434 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_customer_custom_attribute_response import GetCustomerCustomAttributeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_customer_custom_attribute_response import UpsertCustomerCustomAttributeResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...types.delete_customer_custom_attribute_response import DeleteCustomerCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, + customer_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[GetCustomerCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCustomerCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerCustomAttributeResponse, + construct_type( + type_=GetCustomerCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def upsert( + self, + customer_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpsertCustomerCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile. + + Use this endpoint to set the value of a custom attribute for a specified customer profile. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertCustomerCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes/{jsonable_encoder(key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertCustomerCustomAttributeResponse, + construct_type( + type_=UpsertCustomerCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, customer_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteCustomerCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteCustomerCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerCustomAttributeResponse, + construct_type( + type_=DeleteCustomerCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, + customer_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[GetCustomerCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCustomerCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerCustomAttributeResponse, + construct_type( + type_=GetCustomerCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def upsert( + self, + customer_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpsertCustomerCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile. + + Use this endpoint to set the value of a custom attribute for a specified customer profile. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include this optional field and specify the current version + of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertCustomerCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes/{jsonable_encoder(key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertCustomerCustomAttributeResponse, + construct_type( + type_=UpsertCustomerCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, customer_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteCustomerCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + customer_id : str + The ID of the target [customer profile](entity:Customer). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteCustomerCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerCustomAttributeResponse, + construct_type( + type_=DeleteCustomerCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/customers/groups/__init__.py b/src/square/customers/groups/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/customers/groups/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/customers/groups/client.py b/src/square/customers/groups/client.py new file mode 100644 index 00000000..89caccdd --- /dev/null +++ b/src/square/customers/groups/client.py @@ -0,0 +1,723 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawGroupsClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.customer_group import CustomerGroup +from ...types.list_customer_groups_response import ListCustomerGroupsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.customer_group import CustomerGroupParams +from ...types.create_customer_group_response import CreateCustomerGroupResponse +from ...types.get_customer_group_response import GetCustomerGroupResponse +from ...types.update_customer_group_response import UpdateCustomerGroupResponse +from ...types.delete_customer_group_response import DeleteCustomerGroupResponse +from ...types.add_group_to_customer_response import AddGroupToCustomerResponse +from ...types.remove_group_from_customer_response import RemoveGroupFromCustomerResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawGroupsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class GroupsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawGroupsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawGroupsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawGroupsClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomerGroup]: + """ + Retrieves the list of customer groups of a business. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomerGroup] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.customers.groups.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/customers/groups", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerGroupsResponse, + construct_type( + type_=ListCustomerGroupsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.groups + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + group: CustomerGroupParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerGroupResponse: + """ + Creates a new customer group for a business. + + The request must include the `name` value of the group. + + Parameters + ---------- + group : CustomerGroupParams + The customer group to create. + + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerGroupResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.groups.create( + group={"name": "Loyal Customers"}, + ) + """ + response = self._raw_client.create( + group=group, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def get( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerGroupResponse: + """ + Retrieves a specific customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerGroupResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.groups.get( + group_id="group_id", + ) + """ + response = self._raw_client.get(group_id, request_options=request_options) + return response.data + + def update( + self, group_id: str, *, group: CustomerGroupParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateCustomerGroupResponse: + """ + Updates a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to update. + + group : CustomerGroupParams + The `CustomerGroup` object including all the updates you want to make. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCustomerGroupResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.groups.update( + group_id="group_id", + group={"name": "Loyal Customers"}, + ) + """ + response = self._raw_client.update(group_id, group=group, request_options=request_options) + return response.data + + def delete( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerGroupResponse: + """ + Deletes a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerGroupResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.groups.delete( + group_id="group_id", + ) + """ + response = self._raw_client.delete(group_id, request_options=request_options) + return response.data + + def add( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AddGroupToCustomerResponse: + """ + Adds a group membership to a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to add to a group. + + group_id : str + The ID of the customer group to add the customer to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AddGroupToCustomerResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.groups.add( + customer_id="customer_id", + group_id="group_id", + ) + """ + response = self._raw_client.add(customer_id, group_id, request_options=request_options) + return response.data + + def remove( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RemoveGroupFromCustomerResponse: + """ + Removes a group membership from a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to remove from the group. + + group_id : str + The ID of the customer group to remove the customer from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RemoveGroupFromCustomerResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.groups.remove( + customer_id="customer_id", + group_id="group_id", + ) + """ + response = self._raw_client.remove(customer_id, group_id, request_options=request_options) + return response.data + + +class AsyncGroupsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawGroupsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawGroupsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawGroupsClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomerGroup]: + """ + Retrieves the list of customer groups of a business. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomerGroup] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.customers.groups.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/customers/groups", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerGroupsResponse, + construct_type( + type_=ListCustomerGroupsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.groups + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + group: CustomerGroupParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCustomerGroupResponse: + """ + Creates a new customer group for a business. + + The request must include the `name` value of the group. + + Parameters + ---------- + group : CustomerGroupParams + The customer group to create. + + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCustomerGroupResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.groups.create( + group={"name": "Loyal Customers"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + group=group, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def get( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerGroupResponse: + """ + Retrieves a specific customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerGroupResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.groups.get( + group_id="group_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(group_id, request_options=request_options) + return response.data + + async def update( + self, group_id: str, *, group: CustomerGroupParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateCustomerGroupResponse: + """ + Updates a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to update. + + group : CustomerGroupParams + The `CustomerGroup` object including all the updates you want to make. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateCustomerGroupResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.groups.update( + group_id="group_id", + group={"name": "Loyal Customers"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update(group_id, group=group, request_options=request_options) + return response.data + + async def delete( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteCustomerGroupResponse: + """ + Deletes a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteCustomerGroupResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.groups.delete( + group_id="group_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(group_id, request_options=request_options) + return response.data + + async def add( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AddGroupToCustomerResponse: + """ + Adds a group membership to a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to add to a group. + + group_id : str + The ID of the customer group to add the customer to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AddGroupToCustomerResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.groups.add( + customer_id="customer_id", + group_id="group_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.add(customer_id, group_id, request_options=request_options) + return response.data + + async def remove( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RemoveGroupFromCustomerResponse: + """ + Removes a group membership from a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to remove from the group. + + group_id : str + The ID of the customer group to remove the customer from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RemoveGroupFromCustomerResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.groups.remove( + customer_id="customer_id", + group_id="group_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.remove(customer_id, group_id, request_options=request_options) + return response.data diff --git a/src/square/customers/groups/raw_client.py b/src/square/customers/groups/raw_client.py new file mode 100644 index 00000000..8e7ae04f --- /dev/null +++ b/src/square/customers/groups/raw_client.py @@ -0,0 +1,587 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.customer_group import CustomerGroupParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_customer_group_response import CreateCustomerGroupResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_customer_group_response import GetCustomerGroupResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_customer_group_response import UpdateCustomerGroupResponse +from ...types.delete_customer_group_response import DeleteCustomerGroupResponse +from ...types.add_group_to_customer_response import AddGroupToCustomerResponse +from ...types.remove_group_from_customer_response import RemoveGroupFromCustomerResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawGroupsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + group: CustomerGroupParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCustomerGroupResponse]: + """ + Creates a new customer group for a business. + + The request must include the `name` value of the group. + + Parameters + ---------- + group : CustomerGroupParams + The customer group to create. + + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCustomerGroupResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/groups", + method="POST", + json={ + "idempotency_key": idempotency_key, + "group": convert_and_respect_annotation_metadata( + object_=group, annotation=CustomerGroupParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerGroupResponse, + construct_type( + type_=CreateCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetCustomerGroupResponse]: + """ + Retrieves a specific customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCustomerGroupResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/groups/{jsonable_encoder(group_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerGroupResponse, + construct_type( + type_=GetCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, group_id: str, *, group: CustomerGroupParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpdateCustomerGroupResponse]: + """ + Updates a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to update. + + group : CustomerGroupParams + The `CustomerGroup` object including all the updates you want to make. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateCustomerGroupResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/groups/{jsonable_encoder(group_id)}", + method="PUT", + json={ + "group": convert_and_respect_annotation_metadata( + object_=group, annotation=CustomerGroupParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCustomerGroupResponse, + construct_type( + type_=UpdateCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteCustomerGroupResponse]: + """ + Deletes a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteCustomerGroupResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/groups/{jsonable_encoder(group_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerGroupResponse, + construct_type( + type_=DeleteCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def add( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[AddGroupToCustomerResponse]: + """ + Adds a group membership to a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to add to a group. + + group_id : str + The ID of the customer group to add the customer to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AddGroupToCustomerResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/groups/{jsonable_encoder(group_id)}", + method="PUT", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AddGroupToCustomerResponse, + construct_type( + type_=AddGroupToCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def remove( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RemoveGroupFromCustomerResponse]: + """ + Removes a group membership from a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to remove from the group. + + group_id : str + The ID of the customer group to remove the customer from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RemoveGroupFromCustomerResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/groups/{jsonable_encoder(group_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RemoveGroupFromCustomerResponse, + construct_type( + type_=RemoveGroupFromCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawGroupsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + group: CustomerGroupParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCustomerGroupResponse]: + """ + Creates a new customer group for a business. + + The request must include the `name` value of the group. + + Parameters + ---------- + group : CustomerGroupParams + The customer group to create. + + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCustomerGroupResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/groups", + method="POST", + json={ + "idempotency_key": idempotency_key, + "group": convert_and_respect_annotation_metadata( + object_=group, annotation=CustomerGroupParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerGroupResponse, + construct_type( + type_=CreateCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetCustomerGroupResponse]: + """ + Retrieves a specific customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCustomerGroupResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/groups/{jsonable_encoder(group_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerGroupResponse, + construct_type( + type_=GetCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, group_id: str, *, group: CustomerGroupParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpdateCustomerGroupResponse]: + """ + Updates a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to update. + + group : CustomerGroupParams + The `CustomerGroup` object including all the updates you want to make. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateCustomerGroupResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/groups/{jsonable_encoder(group_id)}", + method="PUT", + json={ + "group": convert_and_respect_annotation_metadata( + object_=group, annotation=CustomerGroupParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCustomerGroupResponse, + construct_type( + type_=UpdateCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteCustomerGroupResponse]: + """ + Deletes a customer group as identified by the `group_id` value. + + Parameters + ---------- + group_id : str + The ID of the customer group to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteCustomerGroupResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/groups/{jsonable_encoder(group_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerGroupResponse, + construct_type( + type_=DeleteCustomerGroupResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def add( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[AddGroupToCustomerResponse]: + """ + Adds a group membership to a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to add to a group. + + group_id : str + The ID of the customer group to add the customer to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AddGroupToCustomerResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/groups/{jsonable_encoder(group_id)}", + method="PUT", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AddGroupToCustomerResponse, + construct_type( + type_=AddGroupToCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def remove( + self, customer_id: str, group_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RemoveGroupFromCustomerResponse]: + """ + Removes a group membership from a customer. + + The customer is identified by the `customer_id` value + and the customer group is identified by the `group_id` value. + + Parameters + ---------- + customer_id : str + The ID of the customer to remove from the group. + + group_id : str + The ID of the customer group to remove the customer from. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RemoveGroupFromCustomerResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}/groups/{jsonable_encoder(group_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RemoveGroupFromCustomerResponse, + construct_type( + type_=RemoveGroupFromCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/customers/raw_client.py b/src/square/customers/raw_client.py new file mode 100644 index 00000000..eb903436 --- /dev/null +++ b/src/square/customers/raw_client.py @@ -0,0 +1,1390 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.address import AddressParams +from ..requests.customer_tax_ids import CustomerTaxIdsParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_customer_response import CreateCustomerResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.bulk_create_customer_data import BulkCreateCustomerDataParams +from ..types.bulk_create_customers_response import BulkCreateCustomersResponse +from ..types.bulk_delete_customers_response import BulkDeleteCustomersResponse +from ..types.bulk_retrieve_customers_response import BulkRetrieveCustomersResponse +from ..requests.bulk_update_customer_data import BulkUpdateCustomerDataParams +from ..types.bulk_update_customers_response import BulkUpdateCustomersResponse +from ..requests.customer_query import CustomerQueryParams +from ..types.search_customers_response import SearchCustomersResponse +from ..types.get_customer_response import GetCustomerResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_customer_response import UpdateCustomerResponse +from ..types.delete_customer_response import DeleteCustomerResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCustomerResponse]: + """ + Creates a new customer for a business. + + You must provide at least one of the following values in your request to this + endpoint: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. For maximum length constraints, see + [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCustomerResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers", + method="POST", + json={ + "idempotency_key": idempotency_key, + "given_name": given_name, + "family_name": family_name, + "company_name": company_name, + "nickname": nickname, + "email_address": email_address, + "address": convert_and_respect_annotation_metadata( + object_=address, annotation=AddressParams, direction="write" + ), + "phone_number": phone_number, + "reference_id": reference_id, + "note": note, + "birthday": birthday, + "tax_ids": convert_and_respect_annotation_metadata( + object_=tax_ids, annotation=CustomerTaxIdsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerResponse, + construct_type( + type_=CreateCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_create( + self, + *, + customers: typing.Dict[str, BulkCreateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkCreateCustomersResponse]: + """ + Creates multiple [customer profiles](entity:Customer) for a business. + + This endpoint takes a map of individual create requests and returns a map of responses. + + You must provide at least one of the following values in each create request: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + customers : typing.Dict[str, BulkCreateCustomerDataParams] + A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }` + key-value pairs. + + Each key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + that uniquely identifies the create request. Each value contains the customer data used to create the + customer profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkCreateCustomersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/bulk-create", + method="POST", + json={ + "customers": convert_and_respect_annotation_metadata( + object_=customers, annotation=typing.Dict[str, BulkCreateCustomerDataParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkCreateCustomersResponse, + construct_type( + type_=BulkCreateCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def bulk_delete_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[BulkDeleteCustomersResponse]: + """ + Deletes multiple customer profiles. + + The endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkDeleteCustomersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/bulk-delete", + method="POST", + json={ + "customer_ids": customer_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteCustomersResponse, + construct_type( + type_=BulkDeleteCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def bulk_retrieve_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[BulkRetrieveCustomersResponse]: + """ + Retrieves multiple customer profiles. + + This endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkRetrieveCustomersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/bulk-retrieve", + method="POST", + json={ + "customer_ids": customer_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkRetrieveCustomersResponse, + construct_type( + type_=BulkRetrieveCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def bulk_update_customers( + self, + *, + customers: typing.Dict[str, BulkUpdateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkUpdateCustomersResponse]: + """ + Updates multiple customer profiles. + + This endpoint takes a map of individual update requests and returns a map of responses. + + Parameters + ---------- + customers : typing.Dict[str, BulkUpdateCustomerDataParams] + A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }` + key-value pairs. + + Each key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile + that was created by merging existing profiles, provide the ID of the newly created profile. + + Each value contains the updated customer data. Only new or changed fields are required. To add or + update a field, specify the new value. To remove a field, specify `null`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkUpdateCustomersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/bulk-update", + method="POST", + json={ + "customers": convert_and_respect_annotation_metadata( + object_=customers, annotation=typing.Dict[str, BulkUpdateCustomerDataParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpdateCustomersResponse, + construct_type( + type_=BulkUpdateCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[CustomerQueryParams] = OMIT, + count: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchCustomersResponse]: + """ + Searches the customer profiles associated with a Square account using one or more supported query filters. + + Calling `SearchCustomers` without any explicit query filter returns all + customer profiles ordered alphabetically based on `given_name` and + `family_name`. + + Under normal operating conditions, newly created or updated customer profiles become available + for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated + profiles can take closer to one minute or longer, especially during network incidents and outages. + + Parameters + ---------- + cursor : typing.Optional[str] + Include the pagination cursor in subsequent calls to this endpoint to retrieve + the next set of results associated with the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[CustomerQueryParams] + The filtering and sorting criteria for the search request. If a query is not specified, + Square returns all customer profiles ordered alphabetically by `given_name` and `family_name`. + + count : typing.Optional[bool] + Indicates whether to return the total count of matching customers in the `count` field of the response. + + The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchCustomersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/customers/search", + method="POST", + json={ + "cursor": cursor, + "limit": limit, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=CustomerQueryParams, direction="write" + ), + "count": count, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchCustomersResponse, + construct_type( + type_=SearchCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, customer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetCustomerResponse]: + """ + Returns details for a single customer. + + Parameters + ---------- + customer_id : str + The ID of the customer to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCustomerResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerResponse, + construct_type( + type_=GetCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + customer_id: str, + *, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + version: typing.Optional[int] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateCustomerResponse]: + """ + Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. + To add or update a field, specify the new value. To remove a field, specify `null`. + + To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to update. + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. Only new or changed fields are required in the request. + + For maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateCustomerResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}", + method="PUT", + json={ + "given_name": given_name, + "family_name": family_name, + "company_name": company_name, + "nickname": nickname, + "email_address": email_address, + "address": convert_and_respect_annotation_metadata( + object_=address, annotation=AddressParams, direction="write" + ), + "phone_number": phone_number, + "reference_id": reference_id, + "note": note, + "birthday": birthday, + "version": version, + "tax_ids": convert_and_respect_annotation_metadata( + object_=tax_ids, annotation=CustomerTaxIdsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCustomerResponse, + construct_type( + type_=UpdateCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, + customer_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[DeleteCustomerResponse]: + """ + Deletes a customer profile from a business. + + To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to delete. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteCustomerResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}", + method="DELETE", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerResponse, + construct_type( + type_=DeleteCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCustomerResponse]: + """ + Creates a new customer for a business. + + You must provide at least one of the following values in your request to this + endpoint: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + idempotency_key : typing.Optional[str] + The idempotency key for the request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. For maximum length constraints, see + [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCustomerResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers", + method="POST", + json={ + "idempotency_key": idempotency_key, + "given_name": given_name, + "family_name": family_name, + "company_name": company_name, + "nickname": nickname, + "email_address": email_address, + "address": convert_and_respect_annotation_metadata( + object_=address, annotation=AddressParams, direction="write" + ), + "phone_number": phone_number, + "reference_id": reference_id, + "note": note, + "birthday": birthday, + "tax_ids": convert_and_respect_annotation_metadata( + object_=tax_ids, annotation=CustomerTaxIdsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCustomerResponse, + construct_type( + type_=CreateCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_create( + self, + *, + customers: typing.Dict[str, BulkCreateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkCreateCustomersResponse]: + """ + Creates multiple [customer profiles](entity:Customer) for a business. + + This endpoint takes a map of individual create requests and returns a map of responses. + + You must provide at least one of the following values in each create request: + + - `given_name` + - `family_name` + - `company_name` + - `email_address` + - `phone_number` + + Parameters + ---------- + customers : typing.Dict[str, BulkCreateCustomerDataParams] + A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }` + key-value pairs. + + Each key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) + that uniquely identifies the create request. Each value contains the customer data used to create the + customer profile. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkCreateCustomersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/bulk-create", + method="POST", + json={ + "customers": convert_and_respect_annotation_metadata( + object_=customers, annotation=typing.Dict[str, BulkCreateCustomerDataParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkCreateCustomersResponse, + construct_type( + type_=BulkCreateCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def bulk_delete_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[BulkDeleteCustomersResponse]: + """ + Deletes multiple customer profiles. + + The endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkDeleteCustomersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/bulk-delete", + method="POST", + json={ + "customer_ids": customer_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteCustomersResponse, + construct_type( + type_=BulkDeleteCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def bulk_retrieve_customers( + self, *, customer_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[BulkRetrieveCustomersResponse]: + """ + Retrieves multiple customer profiles. + + This endpoint takes a list of customer IDs and returns a map of responses. + + Parameters + ---------- + customer_ids : typing.Sequence[str] + The IDs of the [customer profiles](entity:Customer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkRetrieveCustomersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/bulk-retrieve", + method="POST", + json={ + "customer_ids": customer_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkRetrieveCustomersResponse, + construct_type( + type_=BulkRetrieveCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def bulk_update_customers( + self, + *, + customers: typing.Dict[str, BulkUpdateCustomerDataParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkUpdateCustomersResponse]: + """ + Updates multiple customer profiles. + + This endpoint takes a map of individual update requests and returns a map of responses. + + Parameters + ---------- + customers : typing.Dict[str, BulkUpdateCustomerDataParams] + A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }` + key-value pairs. + + Each key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile + that was created by merging existing profiles, provide the ID of the newly created profile. + + Each value contains the updated customer data. Only new or changed fields are required. To add or + update a field, specify the new value. To remove a field, specify `null`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkUpdateCustomersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/bulk-update", + method="POST", + json={ + "customers": convert_and_respect_annotation_metadata( + object_=customers, annotation=typing.Dict[str, BulkUpdateCustomerDataParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpdateCustomersResponse, + construct_type( + type_=BulkUpdateCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[CustomerQueryParams] = OMIT, + count: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchCustomersResponse]: + """ + Searches the customer profiles associated with a Square account using one or more supported query filters. + + Calling `SearchCustomers` without any explicit query filter returns all + customer profiles ordered alphabetically based on `given_name` and + `family_name`. + + Under normal operating conditions, newly created or updated customer profiles become available + for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated + profiles can take closer to one minute or longer, especially during network incidents and outages. + + Parameters + ---------- + cursor : typing.Optional[str] + Include the pagination cursor in subsequent calls to this endpoint to retrieve + the next set of results associated with the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[CustomerQueryParams] + The filtering and sorting criteria for the search request. If a query is not specified, + Square returns all customer profiles ordered alphabetically by `given_name` and `family_name`. + + count : typing.Optional[bool] + Indicates whether to return the total count of matching customers in the `count` field of the response. + + The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchCustomersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/customers/search", + method="POST", + json={ + "cursor": cursor, + "limit": limit, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=CustomerQueryParams, direction="write" + ), + "count": count, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchCustomersResponse, + construct_type( + type_=SearchCustomersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, customer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetCustomerResponse]: + """ + Returns details for a single customer. + + Parameters + ---------- + customer_id : str + The ID of the customer to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCustomerResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerResponse, + construct_type( + type_=GetCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + customer_id: str, + *, + given_name: typing.Optional[str] = OMIT, + family_name: typing.Optional[str] = OMIT, + company_name: typing.Optional[str] = OMIT, + nickname: typing.Optional[str] = OMIT, + email_address: typing.Optional[str] = OMIT, + address: typing.Optional[AddressParams] = OMIT, + phone_number: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + note: typing.Optional[str] = OMIT, + birthday: typing.Optional[str] = OMIT, + version: typing.Optional[int] = OMIT, + tax_ids: typing.Optional[CustomerTaxIdsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateCustomerResponse]: + """ + Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. + To add or update a field, specify the new value. To remove a field, specify `null`. + + To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to update. + + given_name : typing.Optional[str] + The given name (that is, the first name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + family_name : typing.Optional[str] + The family name (that is, the last name) associated with the customer profile. + + The maximum length for this value is 300 characters. + + company_name : typing.Optional[str] + A business name associated with the customer profile. + + The maximum length for this value is 500 characters. + + nickname : typing.Optional[str] + A nickname for the customer profile. + + The maximum length for this value is 100 characters. + + email_address : typing.Optional[str] + The email address associated with the customer profile. + + The maximum length for this value is 254 characters. + + address : typing.Optional[AddressParams] + The physical address associated with the customer profile. Only new or changed fields are required in the request. + + For maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + + phone_number : typing.Optional[str] + The phone number associated with the customer profile. The phone number must be valid and can contain + 9–16 digits, with an optional `+` prefix and country code. For more information, see + [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + + reference_id : typing.Optional[str] + An optional second ID used to associate the customer profile with an + entity in another system. + + The maximum length for this value is 100 characters. + + note : typing.Optional[str] + A custom note associated with the customer profile. + + birthday : typing.Optional[str] + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, + specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` + format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). + + tax_ids : typing.Optional[CustomerTaxIdsParams] + The tax ID associated with the customer profile. This field is available only for customers of sellers + in EU countries or the United Kingdom. For more information, + see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateCustomerResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}", + method="PUT", + json={ + "given_name": given_name, + "family_name": family_name, + "company_name": company_name, + "nickname": nickname, + "email_address": email_address, + "address": convert_and_respect_annotation_metadata( + object_=address, annotation=AddressParams, direction="write" + ), + "phone_number": phone_number, + "reference_id": reference_id, + "note": note, + "birthday": birthday, + "version": version, + "tax_ids": convert_and_respect_annotation_metadata( + object_=tax_ids, annotation=CustomerTaxIdsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateCustomerResponse, + construct_type( + type_=UpdateCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, + customer_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[DeleteCustomerResponse]: + """ + Deletes a customer profile from a business. + + To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. + + Parameters + ---------- + customer_id : str + The ID of the customer to delete. + + version : typing.Optional[int] + The current version of the customer profile. + + As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteCustomerResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/{jsonable_encoder(customer_id)}", + method="DELETE", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteCustomerResponse, + construct_type( + type_=DeleteCustomerResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/customers/segments/__init__.py b/src/square/customers/segments/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/customers/segments/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/customers/segments/client.py b/src/square/customers/segments/client.py new file mode 100644 index 00000000..a88b0f71 --- /dev/null +++ b/src/square/customers/segments/client.py @@ -0,0 +1,286 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawSegmentsClient +import typing +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.customer_segment import CustomerSegment +from ...types.list_customer_segments_response import ListCustomerSegmentsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_customer_segment_response import GetCustomerSegmentResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawSegmentsClient +from ...core.pagination import AsyncPager + + +class SegmentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawSegmentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawSegmentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawSegmentsClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomerSegment]: + """ + Retrieves the list of customer segments of a business. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by previous calls to `ListCustomerSegments`. + This cursor is used to retrieve the next set of query results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomerSegment] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.customers.segments.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/customers/segments", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerSegmentsResponse, + construct_type( + type_=ListCustomerSegmentsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.segments + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, segment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerSegmentResponse: + """ + Retrieves a specific customer segment as identified by the `segment_id` value. + + Parameters + ---------- + segment_id : str + The Square-issued ID of the customer segment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerSegmentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.customers.segments.get( + segment_id="segment_id", + ) + """ + response = self._raw_client.get(segment_id, request_options=request_options) + return response.data + + +class AsyncSegmentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawSegmentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawSegmentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawSegmentsClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomerSegment]: + """ + Retrieves the list of customer segments of a business. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by previous calls to `ListCustomerSegments`. + This cursor is used to retrieve the next set of query results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. + If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomerSegment] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.customers.segments.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/customers/segments", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListCustomerSegmentsResponse, + construct_type( + type_=ListCustomerSegmentsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.segments + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, segment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetCustomerSegmentResponse: + """ + Retrieves a specific customer segment as identified by the `segment_id` value. + + Parameters + ---------- + segment_id : str + The Square-issued ID of the customer segment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetCustomerSegmentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.customers.segments.get( + segment_id="segment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(segment_id, request_options=request_options) + return response.data diff --git a/src/square/customers/segments/raw_client.py b/src/square/customers/segments/raw_client.py new file mode 100644 index 00000000..21bf465c --- /dev/null +++ b/src/square/customers/segments/raw_client.py @@ -0,0 +1,101 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_customer_segment_response import GetCustomerSegmentResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawSegmentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, segment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetCustomerSegmentResponse]: + """ + Retrieves a specific customer segment as identified by the `segment_id` value. + + Parameters + ---------- + segment_id : str + The Square-issued ID of the customer segment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetCustomerSegmentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/customers/segments/{jsonable_encoder(segment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerSegmentResponse, + construct_type( + type_=GetCustomerSegmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawSegmentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, segment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetCustomerSegmentResponse]: + """ + Retrieves a specific customer segment as identified by the `segment_id` value. + + Parameters + ---------- + segment_id : str + The Square-issued ID of the customer segment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetCustomerSegmentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/customers/segments/{jsonable_encoder(segment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetCustomerSegmentResponse, + construct_type( + type_=GetCustomerSegmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/devices/__init__.py b/src/square/devices/__init__.py new file mode 100644 index 00000000..56e09d86 --- /dev/null +++ b/src/square/devices/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import codes + +__all__ = ["codes"] diff --git a/src/square/devices/client.py b/src/square/devices/client.py new file mode 100644 index 00000000..ccc6bbae --- /dev/null +++ b/src/square/devices/client.py @@ -0,0 +1,311 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawDevicesClient +from .codes.client import CodesClient +import typing +from ..types.sort_order import SortOrder +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.device import Device +from ..types.list_devices_response import ListDevicesResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_device_response import GetDeviceResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawDevicesClient +from .codes.client import AsyncCodesClient +from ..core.pagination import AsyncPager + + +class DevicesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawDevicesClient(client_wrapper=client_wrapper) + self.codes = CodesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawDevicesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawDevicesClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Device]: + """ + List devices associated with the merchant. Currently, only Terminal API + devices are supported. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + sort_order : typing.Optional[SortOrder] + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + limit : typing.Optional[int] + The number of results to return in a single page. + + location_id : typing.Optional[str] + If present, only returns devices at the target location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Device] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.devices.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/devices", + method="GET", + params={ + "cursor": cursor, + "sort_order": sort_order, + "limit": limit, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDevicesResponse, + construct_type( + type_=ListDevicesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + sort_order=sort_order, + limit=limit, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.devices + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, device_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetDeviceResponse: + """ + Retrieves Device with the associated `device_id`. + + Parameters + ---------- + device_id : str + The unique ID for the desired `Device`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDeviceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.devices.get( + device_id="device_id", + ) + """ + response = self._raw_client.get(device_id, request_options=request_options) + return response.data + + +class AsyncDevicesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawDevicesClient(client_wrapper=client_wrapper) + self.codes = AsyncCodesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawDevicesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawDevicesClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Device]: + """ + List devices associated with the merchant. Currently, only Terminal API + devices are supported. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + sort_order : typing.Optional[SortOrder] + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + limit : typing.Optional[int] + The number of results to return in a single page. + + location_id : typing.Optional[str] + If present, only returns devices at the target location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Device] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.devices.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/devices", + method="GET", + params={ + "cursor": cursor, + "sort_order": sort_order, + "limit": limit, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDevicesResponse, + construct_type( + type_=ListDevicesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + sort_order=sort_order, + limit=limit, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.devices + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, device_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetDeviceResponse: + """ + Retrieves Device with the associated `device_id`. + + Parameters + ---------- + device_id : str + The unique ID for the desired `Device`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDeviceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.devices.get( + device_id="device_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(device_id, request_options=request_options) + return response.data diff --git a/src/square/devices/codes/__init__.py b/src/square/devices/codes/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/devices/codes/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/devices/codes/client.py b/src/square/devices/codes/client.py new file mode 100644 index 00000000..155d9639 --- /dev/null +++ b/src/square/devices/codes/client.py @@ -0,0 +1,423 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCodesClient +from ...types.product_type import ProductType +from ...types.device_code_status import DeviceCodeStatus +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.device_code import DeviceCode +from ...types.list_device_codes_response import ListDeviceCodesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.device_code import DeviceCodeParams +from ...types.create_device_code_response import CreateDeviceCodeResponse +from ...types.get_device_code_response import GetDeviceCodeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCodesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CodesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCodesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCodesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCodesClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + product_type: typing.Optional[ProductType] = None, + status: typing.Optional[DeviceCodeStatus] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[DeviceCode]: + """ + Lists all DeviceCodes associated with the merchant. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + + location_id : typing.Optional[str] + If specified, only returns DeviceCodes of the specified location. + Returns DeviceCodes of all locations if empty. + + product_type : typing.Optional[ProductType] + If specified, only returns DeviceCodes targeting the specified product type. + Returns DeviceCodes of all product types if empty. + + status : typing.Optional[DeviceCodeStatus] + If specified, returns DeviceCodes with the specified statuses. + Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[DeviceCode] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.devices.codes.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/devices/codes", + method="GET", + params={ + "cursor": cursor, + "location_id": location_id, + "product_type": product_type, + "status": status, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDeviceCodesResponse, + construct_type( + type_=ListDeviceCodesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + location_id=location_id, + product_type=product_type, + status=status, + request_options=request_options, + ) + _items = _parsed_response.device_codes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: str, + device_code: DeviceCodeParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateDeviceCodeResponse: + """ + Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected + terminal mode. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateDeviceCode request. Keys can + be any valid string but must be unique for every CreateDeviceCode request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + device_code : DeviceCodeParams + The device code to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateDeviceCodeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.devices.codes.create( + idempotency_key="01bb00a6-0c86-4770-94ed-f5fca973cd56", + device_code={ + "name": "Counter 1", + "product_type": "TERMINAL_API", + "location_id": "B5E4484SHHNYH", + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, device_code=device_code, request_options=request_options + ) + return response.data + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetDeviceCodeResponse: + """ + Retrieves DeviceCode with the associated ID. + + Parameters + ---------- + id : str + The unique identifier for the device code. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDeviceCodeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.devices.codes.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + +class AsyncCodesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCodesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCodesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCodesClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + product_type: typing.Optional[ProductType] = None, + status: typing.Optional[DeviceCodeStatus] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[DeviceCode]: + """ + Lists all DeviceCodes associated with the merchant. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + + location_id : typing.Optional[str] + If specified, only returns DeviceCodes of the specified location. + Returns DeviceCodes of all locations if empty. + + product_type : typing.Optional[ProductType] + If specified, only returns DeviceCodes targeting the specified product type. + Returns DeviceCodes of all product types if empty. + + status : typing.Optional[DeviceCodeStatus] + If specified, returns DeviceCodes with the specified statuses. + Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[DeviceCode] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.devices.codes.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/devices/codes", + method="GET", + params={ + "cursor": cursor, + "location_id": location_id, + "product_type": product_type, + "status": status, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDeviceCodesResponse, + construct_type( + type_=ListDeviceCodesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + location_id=location_id, + product_type=product_type, + status=status, + request_options=request_options, + ) + _items = _parsed_response.device_codes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: str, + device_code: DeviceCodeParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateDeviceCodeResponse: + """ + Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected + terminal mode. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateDeviceCode request. Keys can + be any valid string but must be unique for every CreateDeviceCode request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + device_code : DeviceCodeParams + The device code to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateDeviceCodeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.devices.codes.create( + idempotency_key="01bb00a6-0c86-4770-94ed-f5fca973cd56", + device_code={ + "name": "Counter 1", + "product_type": "TERMINAL_API", + "location_id": "B5E4484SHHNYH", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, device_code=device_code, request_options=request_options + ) + return response.data + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetDeviceCodeResponse: + """ + Retrieves DeviceCode with the associated ID. + + Parameters + ---------- + id : str + The unique identifier for the device code. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDeviceCodeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.devices.codes.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data diff --git a/src/square/devices/codes/raw_client.py b/src/square/devices/codes/raw_client.py new file mode 100644 index 00000000..4d99ab20 --- /dev/null +++ b/src/square/devices/codes/raw_client.py @@ -0,0 +1,227 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.device_code import DeviceCodeParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_device_code_response import CreateDeviceCodeResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_device_code_response import GetDeviceCodeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCodesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + device_code: DeviceCodeParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateDeviceCodeResponse]: + """ + Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected + terminal mode. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateDeviceCode request. Keys can + be any valid string but must be unique for every CreateDeviceCode request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + device_code : DeviceCodeParams + The device code to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateDeviceCodeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/devices/codes", + method="POST", + json={ + "idempotency_key": idempotency_key, + "device_code": convert_and_respect_annotation_metadata( + object_=device_code, annotation=DeviceCodeParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateDeviceCodeResponse, + construct_type( + type_=CreateDeviceCodeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetDeviceCodeResponse]: + """ + Retrieves DeviceCode with the associated ID. + + Parameters + ---------- + id : str + The unique identifier for the device code. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetDeviceCodeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/devices/codes/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDeviceCodeResponse, + construct_type( + type_=GetDeviceCodeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCodesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + device_code: DeviceCodeParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateDeviceCodeResponse]: + """ + Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected + terminal mode. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this CreateDeviceCode request. Keys can + be any valid string but must be unique for every CreateDeviceCode request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + device_code : DeviceCodeParams + The device code to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateDeviceCodeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/devices/codes", + method="POST", + json={ + "idempotency_key": idempotency_key, + "device_code": convert_and_respect_annotation_metadata( + object_=device_code, annotation=DeviceCodeParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateDeviceCodeResponse, + construct_type( + type_=CreateDeviceCodeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetDeviceCodeResponse]: + """ + Retrieves DeviceCode with the associated ID. + + Parameters + ---------- + id : str + The unique identifier for the device code. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetDeviceCodeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/devices/codes/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDeviceCodeResponse, + construct_type( + type_=GetDeviceCodeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/devices/raw_client.py b/src/square/devices/raw_client.py new file mode 100644 index 00000000..83d78c58 --- /dev/null +++ b/src/square/devices/raw_client.py @@ -0,0 +1,101 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_device_response import GetDeviceResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawDevicesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, device_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetDeviceResponse]: + """ + Retrieves Device with the associated `device_id`. + + Parameters + ---------- + device_id : str + The unique ID for the desired `Device`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetDeviceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/devices/{jsonable_encoder(device_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDeviceResponse, + construct_type( + type_=GetDeviceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawDevicesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, device_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetDeviceResponse]: + """ + Retrieves Device with the associated `device_id`. + + Parameters + ---------- + device_id : str + The unique ID for the desired `Device`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetDeviceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/devices/{jsonable_encoder(device_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDeviceResponse, + construct_type( + type_=GetDeviceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/disputes/__init__.py b/src/square/disputes/__init__.py new file mode 100644 index 00000000..899056be --- /dev/null +++ b/src/square/disputes/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import evidence + +__all__ = ["evidence"] diff --git a/src/square/disputes/client.py b/src/square/disputes/client.py new file mode 100644 index 00000000..1bdfeb74 --- /dev/null +++ b/src/square/disputes/client.py @@ -0,0 +1,697 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawDisputesClient +from .evidence.client import EvidenceClient +from ..types.dispute_state import DisputeState +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.dispute import Dispute +from ..types.list_disputes_response import ListDisputesResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_dispute_response import GetDisputeResponse +from ..types.accept_dispute_response import AcceptDisputeResponse +from ..requests.create_dispute_evidence_file_request import CreateDisputeEvidenceFileRequestParams +from .. import core +from ..types.create_dispute_evidence_file_response import CreateDisputeEvidenceFileResponse +from ..types.dispute_evidence_type import DisputeEvidenceType +from ..types.create_dispute_evidence_text_response import CreateDisputeEvidenceTextResponse +from ..types.submit_evidence_response import SubmitEvidenceResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawDisputesClient +from .evidence.client import AsyncEvidenceClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class DisputesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawDisputesClient(client_wrapper=client_wrapper) + self.evidence = EvidenceClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawDisputesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawDisputesClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + states: typing.Optional[DisputeState] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Dispute]: + """ + Returns a list of disputes associated with a particular account. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + states : typing.Optional[DisputeState] + The dispute states used to filter the result. If not specified, the endpoint returns all disputes. + + location_id : typing.Optional[str] + The ID of the location for which to return a list of disputes. + If not specified, the endpoint returns disputes associated with all locations. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Dispute] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.disputes.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/disputes", + method="GET", + params={ + "cursor": cursor, + "states": states, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDisputesResponse, + construct_type( + type_=ListDisputesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + states=states, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.disputes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetDisputeResponse: + """ + Returns details about a specific dispute. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want more details about. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDisputeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.get( + dispute_id="dispute_id", + ) + """ + response = self._raw_client.get(dispute_id, request_options=request_options) + return response.data + + def accept( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AcceptDisputeResponse: + """ + Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and + updates the dispute state to ACCEPTED. + + Square debits the disputed amount from the seller’s Square account. If the Square account + does not have sufficient funds, Square debits the associated bank account. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want to accept. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AcceptDisputeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.accept( + dispute_id="dispute_id", + ) + """ + response = self._raw_client.accept(dispute_id, request_options=request_options) + return response.data + + def create_evidence_file( + self, + dispute_id: str, + *, + request: typing.Optional[CreateDisputeEvidenceFileRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateDisputeEvidenceFileResponse: + """ + Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP + multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + request : typing.Optional[CreateDisputeEvidenceFileRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateDisputeEvidenceFileResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.create_evidence_file( + dispute_id="dispute_id", + ) + """ + response = self._raw_client.create_evidence_file( + dispute_id, request=request, image_file=image_file, request_options=request_options + ) + return response.data + + def create_evidence_text( + self, + dispute_id: str, + *, + idempotency_key: str, + evidence_text: str, + evidence_type: typing.Optional[DisputeEvidenceType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateDisputeEvidenceTextResponse: + """ + Uploads text to use as evidence for a dispute challenge. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + idempotency_key : str + A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + evidence_text : str + The evidence string. + + evidence_type : typing.Optional[DisputeEvidenceType] + The type of evidence you are uploading. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateDisputeEvidenceTextResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.create_evidence_text( + dispute_id="dispute_id", + idempotency_key="ed3ee3933d946f1514d505d173c82648", + evidence_type="TRACKING_NUMBER", + evidence_text="1Z8888888888888888", + ) + """ + response = self._raw_client.create_evidence_text( + dispute_id, + idempotency_key=idempotency_key, + evidence_text=evidence_text, + evidence_type=evidence_type, + request_options=request_options, + ) + return response.data + + def submit_evidence( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> SubmitEvidenceResponse: + """ + Submits evidence to the cardholder's bank. + + The evidence submitted by this endpoint includes evidence uploaded + using the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and + [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and + evidence automatically provided by Square, when available. Evidence cannot be removed from + a dispute after submission. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to submit evidence. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SubmitEvidenceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.submit_evidence( + dispute_id="dispute_id", + ) + """ + response = self._raw_client.submit_evidence(dispute_id, request_options=request_options) + return response.data + + +class AsyncDisputesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawDisputesClient(client_wrapper=client_wrapper) + self.evidence = AsyncEvidenceClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawDisputesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawDisputesClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + states: typing.Optional[DisputeState] = None, + location_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Dispute]: + """ + Returns a list of disputes associated with a particular account. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + states : typing.Optional[DisputeState] + The dispute states used to filter the result. If not specified, the endpoint returns all disputes. + + location_id : typing.Optional[str] + The ID of the location for which to return a list of disputes. + If not specified, the endpoint returns disputes associated with all locations. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Dispute] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.disputes.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/disputes", + method="GET", + params={ + "cursor": cursor, + "states": states, + "location_id": location_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDisputesResponse, + construct_type( + type_=ListDisputesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + states=states, + location_id=location_id, + request_options=request_options, + ) + _items = _parsed_response.disputes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetDisputeResponse: + """ + Returns details about a specific dispute. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want more details about. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDisputeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.get( + dispute_id="dispute_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(dispute_id, request_options=request_options) + return response.data + + async def accept( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AcceptDisputeResponse: + """ + Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and + updates the dispute state to ACCEPTED. + + Square debits the disputed amount from the seller’s Square account. If the Square account + does not have sufficient funds, Square debits the associated bank account. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want to accept. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AcceptDisputeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.accept( + dispute_id="dispute_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.accept(dispute_id, request_options=request_options) + return response.data + + async def create_evidence_file( + self, + dispute_id: str, + *, + request: typing.Optional[CreateDisputeEvidenceFileRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateDisputeEvidenceFileResponse: + """ + Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP + multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + request : typing.Optional[CreateDisputeEvidenceFileRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateDisputeEvidenceFileResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.create_evidence_file( + dispute_id="dispute_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create_evidence_file( + dispute_id, request=request, image_file=image_file, request_options=request_options + ) + return response.data + + async def create_evidence_text( + self, + dispute_id: str, + *, + idempotency_key: str, + evidence_text: str, + evidence_type: typing.Optional[DisputeEvidenceType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateDisputeEvidenceTextResponse: + """ + Uploads text to use as evidence for a dispute challenge. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + idempotency_key : str + A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + evidence_text : str + The evidence string. + + evidence_type : typing.Optional[DisputeEvidenceType] + The type of evidence you are uploading. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateDisputeEvidenceTextResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.create_evidence_text( + dispute_id="dispute_id", + idempotency_key="ed3ee3933d946f1514d505d173c82648", + evidence_type="TRACKING_NUMBER", + evidence_text="1Z8888888888888888", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create_evidence_text( + dispute_id, + idempotency_key=idempotency_key, + evidence_text=evidence_text, + evidence_type=evidence_type, + request_options=request_options, + ) + return response.data + + async def submit_evidence( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> SubmitEvidenceResponse: + """ + Submits evidence to the cardholder's bank. + + The evidence submitted by this endpoint includes evidence uploaded + using the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and + [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and + evidence automatically provided by Square, when available. Evidence cannot be removed from + a dispute after submission. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to submit evidence. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SubmitEvidenceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.submit_evidence( + dispute_id="dispute_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.submit_evidence(dispute_id, request_options=request_options) + return response.data diff --git a/src/square/disputes/evidence/__init__.py b/src/square/disputes/evidence/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/disputes/evidence/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/disputes/evidence/client.py b/src/square/disputes/evidence/client.py new file mode 100644 index 00000000..5ef81caa --- /dev/null +++ b/src/square/disputes/evidence/client.py @@ -0,0 +1,378 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawEvidenceClient +import typing +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.dispute_evidence import DisputeEvidence +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_dispute_evidence_response import ListDisputeEvidenceResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_dispute_evidence_response import GetDisputeEvidenceResponse +from ...types.delete_dispute_evidence_response import DeleteDisputeEvidenceResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawEvidenceClient +from ...core.pagination import AsyncPager + + +class EvidenceClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawEvidenceClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawEvidenceClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawEvidenceClient + """ + return self._raw_client + + def list( + self, + dispute_id: str, + *, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[DisputeEvidence]: + """ + Returns a list of evidence associated with a dispute. + + Parameters + ---------- + dispute_id : str + The ID of the dispute. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[DisputeEvidence] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.disputes.evidence.list( + dispute_id="dispute_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence", + method="GET", + params={ + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDisputeEvidenceResponse, + construct_type( + type_=ListDisputeEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + dispute_id, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.evidence + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetDisputeEvidenceResponse: + """ + Returns the metadata for the evidence specified in the request URL path. + + You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to retrieve evidence metadata. + + evidence_id : str + The ID of the evidence to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDisputeEvidenceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.evidence.get( + dispute_id="dispute_id", + evidence_id="evidence_id", + ) + """ + response = self._raw_client.get(dispute_id, evidence_id, request_options=request_options) + return response.data + + def delete( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteDisputeEvidenceResponse: + """ + Removes specified evidence from a dispute. + Square does not send the bank any evidence that is removed. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to remove evidence. + + evidence_id : str + The ID of the evidence you want to remove. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteDisputeEvidenceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.disputes.evidence.delete( + dispute_id="dispute_id", + evidence_id="evidence_id", + ) + """ + response = self._raw_client.delete(dispute_id, evidence_id, request_options=request_options) + return response.data + + +class AsyncEvidenceClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawEvidenceClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawEvidenceClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawEvidenceClient + """ + return self._raw_client + + async def list( + self, + dispute_id: str, + *, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[DisputeEvidence]: + """ + Returns a list of evidence associated with a dispute. + + Parameters + ---------- + dispute_id : str + The ID of the dispute. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[DisputeEvidence] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.disputes.evidence.list( + dispute_id="dispute_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence", + method="GET", + params={ + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListDisputeEvidenceResponse, + construct_type( + type_=ListDisputeEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + dispute_id, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.evidence + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetDisputeEvidenceResponse: + """ + Returns the metadata for the evidence specified in the request URL path. + + You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to retrieve evidence metadata. + + evidence_id : str + The ID of the evidence to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetDisputeEvidenceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.evidence.get( + dispute_id="dispute_id", + evidence_id="evidence_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(dispute_id, evidence_id, request_options=request_options) + return response.data + + async def delete( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteDisputeEvidenceResponse: + """ + Removes specified evidence from a dispute. + Square does not send the bank any evidence that is removed. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to remove evidence. + + evidence_id : str + The ID of the evidence you want to remove. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteDisputeEvidenceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.disputes.evidence.delete( + dispute_id="dispute_id", + evidence_id="evidence_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(dispute_id, evidence_id, request_options=request_options) + return response.data diff --git a/src/square/disputes/evidence/raw_client.py b/src/square/disputes/evidence/raw_client.py new file mode 100644 index 00000000..20879e93 --- /dev/null +++ b/src/square/disputes/evidence/raw_client.py @@ -0,0 +1,198 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_dispute_evidence_response import GetDisputeEvidenceResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.delete_dispute_evidence_response import DeleteDisputeEvidenceResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawEvidenceClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetDisputeEvidenceResponse]: + """ + Returns the metadata for the evidence specified in the request URL path. + + You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to retrieve evidence metadata. + + evidence_id : str + The ID of the evidence to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetDisputeEvidenceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence/{jsonable_encoder(evidence_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDisputeEvidenceResponse, + construct_type( + type_=GetDisputeEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteDisputeEvidenceResponse]: + """ + Removes specified evidence from a dispute. + Square does not send the bank any evidence that is removed. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to remove evidence. + + evidence_id : str + The ID of the evidence you want to remove. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteDisputeEvidenceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence/{jsonable_encoder(evidence_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteDisputeEvidenceResponse, + construct_type( + type_=DeleteDisputeEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawEvidenceClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetDisputeEvidenceResponse]: + """ + Returns the metadata for the evidence specified in the request URL path. + + You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to retrieve evidence metadata. + + evidence_id : str + The ID of the evidence to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetDisputeEvidenceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence/{jsonable_encoder(evidence_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDisputeEvidenceResponse, + construct_type( + type_=GetDisputeEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, dispute_id: str, evidence_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteDisputeEvidenceResponse]: + """ + Removes specified evidence from a dispute. + Square does not send the bank any evidence that is removed. + + Parameters + ---------- + dispute_id : str + The ID of the dispute from which you want to remove evidence. + + evidence_id : str + The ID of the evidence you want to remove. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteDisputeEvidenceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence/{jsonable_encoder(evidence_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteDisputeEvidenceResponse, + construct_type( + type_=DeleteDisputeEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/disputes/raw_client.py b/src/square/disputes/raw_client.py new file mode 100644 index 00000000..4a3b6013 --- /dev/null +++ b/src/square/disputes/raw_client.py @@ -0,0 +1,544 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_dispute_response import GetDisputeResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.accept_dispute_response import AcceptDisputeResponse +from ..requests.create_dispute_evidence_file_request import CreateDisputeEvidenceFileRequestParams +from .. import core +from ..types.create_dispute_evidence_file_response import CreateDisputeEvidenceFileResponse +import json +from ..types.dispute_evidence_type import DisputeEvidenceType +from ..types.create_dispute_evidence_text_response import CreateDisputeEvidenceTextResponse +from ..types.submit_evidence_response import SubmitEvidenceResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawDisputesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetDisputeResponse]: + """ + Returns details about a specific dispute. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want more details about. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetDisputeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDisputeResponse, + construct_type( + type_=GetDisputeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def accept( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[AcceptDisputeResponse]: + """ + Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and + updates the dispute state to ACCEPTED. + + Square debits the disputed amount from the seller’s Square account. If the Square account + does not have sufficient funds, Square debits the associated bank account. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want to accept. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AcceptDisputeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/accept", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AcceptDisputeResponse, + construct_type( + type_=AcceptDisputeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create_evidence_file( + self, + dispute_id: str, + *, + request: typing.Optional[CreateDisputeEvidenceFileRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateDisputeEvidenceFileResponse]: + """ + Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP + multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + request : typing.Optional[CreateDisputeEvidenceFileRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateDisputeEvidenceFileResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence-files", + method="POST", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateDisputeEvidenceFileResponse, + construct_type( + type_=CreateDisputeEvidenceFileResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create_evidence_text( + self, + dispute_id: str, + *, + idempotency_key: str, + evidence_text: str, + evidence_type: typing.Optional[DisputeEvidenceType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateDisputeEvidenceTextResponse]: + """ + Uploads text to use as evidence for a dispute challenge. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + idempotency_key : str + A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + evidence_text : str + The evidence string. + + evidence_type : typing.Optional[DisputeEvidenceType] + The type of evidence you are uploading. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateDisputeEvidenceTextResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence-text", + method="POST", + json={ + "idempotency_key": idempotency_key, + "evidence_type": evidence_type, + "evidence_text": evidence_text, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateDisputeEvidenceTextResponse, + construct_type( + type_=CreateDisputeEvidenceTextResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def submit_evidence( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[SubmitEvidenceResponse]: + """ + Submits evidence to the cardholder's bank. + + The evidence submitted by this endpoint includes evidence uploaded + using the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and + [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and + evidence automatically provided by Square, when available. Evidence cannot be removed from + a dispute after submission. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to submit evidence. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SubmitEvidenceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/submit-evidence", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SubmitEvidenceResponse, + construct_type( + type_=SubmitEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawDisputesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetDisputeResponse]: + """ + Returns details about a specific dispute. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want more details about. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetDisputeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetDisputeResponse, + construct_type( + type_=GetDisputeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def accept( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[AcceptDisputeResponse]: + """ + Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and + updates the dispute state to ACCEPTED. + + Square debits the disputed amount from the seller’s Square account. If the Square account + does not have sufficient funds, Square debits the associated bank account. + + Parameters + ---------- + dispute_id : str + The ID of the dispute you want to accept. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AcceptDisputeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/accept", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AcceptDisputeResponse, + construct_type( + type_=AcceptDisputeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create_evidence_file( + self, + dispute_id: str, + *, + request: typing.Optional[CreateDisputeEvidenceFileRequestParams] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateDisputeEvidenceFileResponse]: + """ + Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP + multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + request : typing.Optional[CreateDisputeEvidenceFileRequestParams] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateDisputeEvidenceFileResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence-files", + method="POST", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateDisputeEvidenceFileResponse, + construct_type( + type_=CreateDisputeEvidenceFileResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create_evidence_text( + self, + dispute_id: str, + *, + idempotency_key: str, + evidence_text: str, + evidence_type: typing.Optional[DisputeEvidenceType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateDisputeEvidenceTextResponse]: + """ + Uploads text to use as evidence for a dispute challenge. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to upload evidence. + + idempotency_key : str + A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + evidence_text : str + The evidence string. + + evidence_type : typing.Optional[DisputeEvidenceType] + The type of evidence you are uploading. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateDisputeEvidenceTextResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/evidence-text", + method="POST", + json={ + "idempotency_key": idempotency_key, + "evidence_type": evidence_type, + "evidence_text": evidence_text, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateDisputeEvidenceTextResponse, + construct_type( + type_=CreateDisputeEvidenceTextResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def submit_evidence( + self, dispute_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[SubmitEvidenceResponse]: + """ + Submits evidence to the cardholder's bank. + + The evidence submitted by this endpoint includes evidence uploaded + using the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and + [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and + evidence automatically provided by Square, when available. Evidence cannot be removed from + a dispute after submission. + + Parameters + ---------- + dispute_id : str + The ID of the dispute for which you want to submit evidence. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SubmitEvidenceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/disputes/{jsonable_encoder(dispute_id)}/submit-evidence", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SubmitEvidenceResponse, + construct_type( + type_=SubmitEvidenceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/employees/__init__.py b/src/square/employees/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/employees/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/employees/client.py b/src/square/employees/client.py new file mode 100644 index 00000000..5c602191 --- /dev/null +++ b/src/square/employees/client.py @@ -0,0 +1,295 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawEmployeesClient +import typing +from ..types.employee_status import EmployeeStatus +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.employee import Employee +from ..types.list_employees_response import ListEmployeesResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_employee_response import GetEmployeeResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawEmployeesClient +from ..core.pagination import AsyncPager + + +class EmployeesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawEmployeesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawEmployeesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawEmployeesClient + """ + return self._raw_client + + def list( + self, + *, + location_id: typing.Optional[str] = None, + status: typing.Optional[EmployeeStatus] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Employee]: + """ + + + Parameters + ---------- + location_id : typing.Optional[str] + + + status : typing.Optional[EmployeeStatus] + Specifies the EmployeeStatus to filter the employee by. + + limit : typing.Optional[int] + The number of employees to be returned on each page. + + cursor : typing.Optional[str] + The token required to retrieve the specified page of results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Employee] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.employees.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/employees", + method="GET", + params={ + "location_id": location_id, + "status": status, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListEmployeesResponse, + construct_type( + type_=ListEmployeesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + status=status, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.employees + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetEmployeeResponse: + """ + + + Parameters + ---------- + id : str + UUID for the employee that was requested. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetEmployeeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.employees.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + +class AsyncEmployeesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawEmployeesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawEmployeesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawEmployeesClient + """ + return self._raw_client + + async def list( + self, + *, + location_id: typing.Optional[str] = None, + status: typing.Optional[EmployeeStatus] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Employee]: + """ + + + Parameters + ---------- + location_id : typing.Optional[str] + + + status : typing.Optional[EmployeeStatus] + Specifies the EmployeeStatus to filter the employee by. + + limit : typing.Optional[int] + The number of employees to be returned on each page. + + cursor : typing.Optional[str] + The token required to retrieve the specified page of results. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Employee] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.employees.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/employees", + method="GET", + params={ + "location_id": location_id, + "status": status, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListEmployeesResponse, + construct_type( + type_=ListEmployeesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + status=status, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.employees + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetEmployeeResponse: + """ + + + Parameters + ---------- + id : str + UUID for the employee that was requested. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetEmployeeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.employees.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data diff --git a/src/square/employees/raw_client.py b/src/square/employees/raw_client.py new file mode 100644 index 00000000..0fc41587 --- /dev/null +++ b/src/square/employees/raw_client.py @@ -0,0 +1,101 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_employee_response import GetEmployeeResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawEmployeesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetEmployeeResponse]: + """ + + + Parameters + ---------- + id : str + UUID for the employee that was requested. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetEmployeeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/employees/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetEmployeeResponse, + construct_type( + type_=GetEmployeeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawEmployeesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetEmployeeResponse]: + """ + + + Parameters + ---------- + id : str + UUID for the employee that was requested. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetEmployeeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/employees/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetEmployeeResponse, + construct_type( + type_=GetEmployeeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/environment.py b/src/square/environment.py new file mode 100644 index 00000000..7e3a13ea --- /dev/null +++ b/src/square/environment.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import enum + + +class SquareEnvironment(enum.Enum): + PRODUCTION = "https://connect.squareup.com" + SANDBOX = "https://connect.squareupsandbox.com" diff --git a/src/square/events/__init__.py b/src/square/events/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/events/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/events/client.py b/src/square/events/client.py new file mode 100644 index 00000000..493aeb2b --- /dev/null +++ b/src/square/events/client.py @@ -0,0 +1,350 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawEventsClient +from ..requests.search_events_query import SearchEventsQueryParams +from ..core.request_options import RequestOptions +from ..types.search_events_response import SearchEventsResponse +from ..types.disable_events_response import DisableEventsResponse +from ..types.enable_events_response import EnableEventsResponse +from ..types.list_event_types_response import ListEventTypesResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawEventsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class EventsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawEventsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawEventsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawEventsClient + """ + return self._raw_client + + def search_events( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchEventsQueryParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchEventsResponse: + """ + Search for Square API events that occur within a 28-day timeframe. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + Default: 100 + + query : typing.Optional[SearchEventsQueryParams] + The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchEventsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.events.search_events() + """ + response = self._raw_client.search_events( + cursor=cursor, limit=limit, query=query, request_options=request_options + ) + return response.data + + def disable_events(self, *, request_options: typing.Optional[RequestOptions] = None) -> DisableEventsResponse: + """ + Disables events to prevent them from being searchable. + All events are disabled by default. You must enable events to make them searchable. + Disabling events for a specific time period prevents them from being searchable, even if you re-enable them later. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DisableEventsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.events.disable_events() + """ + response = self._raw_client.disable_events(request_options=request_options) + return response.data + + def enable_events(self, *, request_options: typing.Optional[RequestOptions] = None) -> EnableEventsResponse: + """ + Enables events to make them searchable. Only events that occur while in the enabled state are searchable. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + EnableEventsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.events.enable_events() + """ + response = self._raw_client.enable_events(request_options=request_options) + return response.data + + def list_event_types( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> ListEventTypesResponse: + """ + Lists all event types that you can subscribe to as webhooks or query using the Events API. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListEventTypesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.events.list_event_types() + """ + response = self._raw_client.list_event_types(api_version=api_version, request_options=request_options) + return response.data + + +class AsyncEventsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawEventsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawEventsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawEventsClient + """ + return self._raw_client + + async def search_events( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchEventsQueryParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchEventsResponse: + """ + Search for Square API events that occur within a 28-day timeframe. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + Default: 100 + + query : typing.Optional[SearchEventsQueryParams] + The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchEventsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.events.search_events() + + + asyncio.run(main()) + """ + response = await self._raw_client.search_events( + cursor=cursor, limit=limit, query=query, request_options=request_options + ) + return response.data + + async def disable_events(self, *, request_options: typing.Optional[RequestOptions] = None) -> DisableEventsResponse: + """ + Disables events to prevent them from being searchable. + All events are disabled by default. You must enable events to make them searchable. + Disabling events for a specific time period prevents them from being searchable, even if you re-enable them later. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DisableEventsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.events.disable_events() + + + asyncio.run(main()) + """ + response = await self._raw_client.disable_events(request_options=request_options) + return response.data + + async def enable_events(self, *, request_options: typing.Optional[RequestOptions] = None) -> EnableEventsResponse: + """ + Enables events to make them searchable. Only events that occur while in the enabled state are searchable. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + EnableEventsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.events.enable_events() + + + asyncio.run(main()) + """ + response = await self._raw_client.enable_events(request_options=request_options) + return response.data + + async def list_event_types( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> ListEventTypesResponse: + """ + Lists all event types that you can subscribe to as webhooks or query using the Events API. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListEventTypesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.events.list_event_types() + + + asyncio.run(main()) + """ + response = await self._raw_client.list_event_types(api_version=api_version, request_options=request_options) + return response.data diff --git a/src/square/events/raw_client.py b/src/square/events/raw_client.py new file mode 100644 index 00000000..74408ed8 --- /dev/null +++ b/src/square/events/raw_client.py @@ -0,0 +1,396 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.search_events_query import SearchEventsQueryParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.search_events_response import SearchEventsResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.disable_events_response import DisableEventsResponse +from ..types.enable_events_response import EnableEventsResponse +from ..types.list_event_types_response import ListEventTypesResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawEventsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def search_events( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchEventsQueryParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchEventsResponse]: + """ + Search for Square API events that occur within a 28-day timeframe. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + Default: 100 + + query : typing.Optional[SearchEventsQueryParams] + The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchEventsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/events", + method="POST", + json={ + "cursor": cursor, + "limit": limit, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchEventsQueryParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchEventsResponse, + construct_type( + type_=SearchEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def disable_events( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DisableEventsResponse]: + """ + Disables events to prevent them from being searchable. + All events are disabled by default. You must enable events to make them searchable. + Disabling events for a specific time period prevents them from being searchable, even if you re-enable them later. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DisableEventsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/events/disable", + method="PUT", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DisableEventsResponse, + construct_type( + type_=DisableEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def enable_events( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[EnableEventsResponse]: + """ + Enables events to make them searchable. Only events that occur while in the enabled state are searchable. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[EnableEventsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/events/enable", + method="PUT", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + EnableEventsResponse, + construct_type( + type_=EnableEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def list_event_types( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ListEventTypesResponse]: + """ + Lists all event types that you can subscribe to as webhooks or query using the Events API. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListEventTypesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/events/types", + method="GET", + params={ + "api_version": api_version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListEventTypesResponse, + construct_type( + type_=ListEventTypesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawEventsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def search_events( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchEventsQueryParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchEventsResponse]: + """ + Search for Square API events that occur within a 28-day timeframe. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + Default: 100 + + query : typing.Optional[SearchEventsQueryParams] + The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchEventsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/events", + method="POST", + json={ + "cursor": cursor, + "limit": limit, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchEventsQueryParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchEventsResponse, + construct_type( + type_=SearchEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def disable_events( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DisableEventsResponse]: + """ + Disables events to prevent them from being searchable. + All events are disabled by default. You must enable events to make them searchable. + Disabling events for a specific time period prevents them from being searchable, even if you re-enable them later. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DisableEventsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/events/disable", + method="PUT", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DisableEventsResponse, + construct_type( + type_=DisableEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def enable_events( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[EnableEventsResponse]: + """ + Enables events to make them searchable. Only events that occur while in the enabled state are searchable. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[EnableEventsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/events/enable", + method="PUT", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + EnableEventsResponse, + construct_type( + type_=EnableEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def list_event_types( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ListEventTypesResponse]: + """ + Lists all event types that you can subscribe to as webhooks or query using the Events API. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListEventTypesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/events/types", + method="GET", + params={ + "api_version": api_version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListEventTypesResponse, + construct_type( + type_=ListEventTypesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/gift_cards/__init__.py b/src/square/gift_cards/__init__.py new file mode 100644 index 00000000..121cf796 --- /dev/null +++ b/src/square/gift_cards/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import activities + +__all__ = ["activities"] diff --git a/src/square/gift_cards/activities/__init__.py b/src/square/gift_cards/activities/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/gift_cards/activities/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/gift_cards/activities/client.py b/src/square/gift_cards/activities/client.py new file mode 100644 index 00000000..10d24366 --- /dev/null +++ b/src/square/gift_cards/activities/client.py @@ -0,0 +1,422 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawActivitiesClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.gift_card_activity import GiftCardActivity +from ...types.list_gift_card_activities_response import ListGiftCardActivitiesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.gift_card_activity import GiftCardActivityParams +from ...types.create_gift_card_activity_response import CreateGiftCardActivityResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawActivitiesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ActivitiesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawActivitiesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawActivitiesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawActivitiesClient + """ + return self._raw_client + + def list( + self, + *, + gift_card_id: typing.Optional[str] = None, + type: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + sort_order: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[GiftCardActivity]: + """ + Lists gift card activities. By default, you get gift card activities for all + gift cards in the seller's account. You can optionally specify query parameters to + filter the list. For example, you can get a list of gift card activities for a gift card, + for all gift cards in a specific region, or for activities within a time window. + + Parameters + ---------- + gift_card_id : typing.Optional[str] + If a gift card ID is provided, the endpoint returns activities related + to the specified gift card. Otherwise, the endpoint returns all gift card activities for + the seller. + + type : typing.Optional[str] + If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. + Otherwise, the endpoint returns all types of gift card activities. + + location_id : typing.Optional[str] + If a location ID is provided, the endpoint returns gift card activities for the specified location. + Otherwise, the endpoint returns gift card activities for all locations. + + begin_time : typing.Optional[str] + The timestamp for the beginning of the reporting period, in RFC 3339 format. + This start time is inclusive. The default value is the current time minus one year. + + end_time : typing.Optional[str] + The timestamp for the end of the reporting period, in RFC 3339 format. + This end time is inclusive. The default value is the current time. + + limit : typing.Optional[int] + If a limit is provided, the endpoint returns the specified number + of results (or fewer) per page. The maximum value is 100. The default value is 50. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + If a cursor is not provided, the endpoint returns the first page of the results. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + sort_order : typing.Optional[str] + The order in which the endpoint returns the activities, based on `created_at`. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[GiftCardActivity] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.gift_cards.activities.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/gift-cards/activities", + method="GET", + params={ + "gift_card_id": gift_card_id, + "type": type, + "location_id": location_id, + "begin_time": begin_time, + "end_time": end_time, + "limit": limit, + "cursor": cursor, + "sort_order": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListGiftCardActivitiesResponse, + construct_type( + type_=ListGiftCardActivitiesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + gift_card_id=gift_card_id, + type=type, + location_id=location_id, + begin_time=begin_time, + end_time=end_time, + limit=limit, + cursor=_parsed_next, + sort_order=sort_order, + request_options=request_options, + ) + _items = _parsed_response.gift_card_activities + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: str, + gift_card_activity: GiftCardActivityParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateGiftCardActivityResponse: + """ + Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard). + For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies the `CreateGiftCardActivity` request. + + gift_card_activity : GiftCardActivityParams + The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target + gift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateGiftCardActivityResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.activities.create( + idempotency_key="U16kfr-kA70er-q4Rsym-7U7NnY", + gift_card_activity={ + "type": "ACTIVATE", + "location_id": "81FN9BNFZTKS4", + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "activate_activity_details": { + "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY", + "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", + }, + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, gift_card_activity=gift_card_activity, request_options=request_options + ) + return response.data + + +class AsyncActivitiesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawActivitiesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawActivitiesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawActivitiesClient + """ + return self._raw_client + + async def list( + self, + *, + gift_card_id: typing.Optional[str] = None, + type: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + sort_order: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[GiftCardActivity]: + """ + Lists gift card activities. By default, you get gift card activities for all + gift cards in the seller's account. You can optionally specify query parameters to + filter the list. For example, you can get a list of gift card activities for a gift card, + for all gift cards in a specific region, or for activities within a time window. + + Parameters + ---------- + gift_card_id : typing.Optional[str] + If a gift card ID is provided, the endpoint returns activities related + to the specified gift card. Otherwise, the endpoint returns all gift card activities for + the seller. + + type : typing.Optional[str] + If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. + Otherwise, the endpoint returns all types of gift card activities. + + location_id : typing.Optional[str] + If a location ID is provided, the endpoint returns gift card activities for the specified location. + Otherwise, the endpoint returns gift card activities for all locations. + + begin_time : typing.Optional[str] + The timestamp for the beginning of the reporting period, in RFC 3339 format. + This start time is inclusive. The default value is the current time minus one year. + + end_time : typing.Optional[str] + The timestamp for the end of the reporting period, in RFC 3339 format. + This end time is inclusive. The default value is the current time. + + limit : typing.Optional[int] + If a limit is provided, the endpoint returns the specified number + of results (or fewer) per page. The maximum value is 100. The default value is 50. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + If a cursor is not provided, the endpoint returns the first page of the results. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + sort_order : typing.Optional[str] + The order in which the endpoint returns the activities, based on `created_at`. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[GiftCardActivity] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.gift_cards.activities.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/gift-cards/activities", + method="GET", + params={ + "gift_card_id": gift_card_id, + "type": type, + "location_id": location_id, + "begin_time": begin_time, + "end_time": end_time, + "limit": limit, + "cursor": cursor, + "sort_order": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListGiftCardActivitiesResponse, + construct_type( + type_=ListGiftCardActivitiesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + gift_card_id=gift_card_id, + type=type, + location_id=location_id, + begin_time=begin_time, + end_time=end_time, + limit=limit, + cursor=_parsed_next, + sort_order=sort_order, + request_options=request_options, + ) + _items = _parsed_response.gift_card_activities + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: str, + gift_card_activity: GiftCardActivityParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateGiftCardActivityResponse: + """ + Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard). + For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies the `CreateGiftCardActivity` request. + + gift_card_activity : GiftCardActivityParams + The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target + gift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateGiftCardActivityResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.activities.create( + idempotency_key="U16kfr-kA70er-q4Rsym-7U7NnY", + gift_card_activity={ + "type": "ACTIVATE", + "location_id": "81FN9BNFZTKS4", + "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", + "activate_activity_details": { + "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY", + "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, gift_card_activity=gift_card_activity, request_options=request_options + ) + return response.data diff --git a/src/square/gift_cards/activities/raw_client.py b/src/square/gift_cards/activities/raw_client.py new file mode 100644 index 00000000..d40c039f --- /dev/null +++ b/src/square/gift_cards/activities/raw_client.py @@ -0,0 +1,143 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.gift_card_activity import GiftCardActivityParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_gift_card_activity_response import CreateGiftCardActivityResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawActivitiesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + gift_card_activity: GiftCardActivityParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateGiftCardActivityResponse]: + """ + Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard). + For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies the `CreateGiftCardActivity` request. + + gift_card_activity : GiftCardActivityParams + The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target + gift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateGiftCardActivityResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/gift-cards/activities", + method="POST", + json={ + "idempotency_key": idempotency_key, + "gift_card_activity": convert_and_respect_annotation_metadata( + object_=gift_card_activity, annotation=GiftCardActivityParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateGiftCardActivityResponse, + construct_type( + type_=CreateGiftCardActivityResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawActivitiesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + gift_card_activity: GiftCardActivityParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateGiftCardActivityResponse]: + """ + Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard). + For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies the `CreateGiftCardActivity` request. + + gift_card_activity : GiftCardActivityParams + The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target + gift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateGiftCardActivityResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/gift-cards/activities", + method="POST", + json={ + "idempotency_key": idempotency_key, + "gift_card_activity": convert_and_respect_annotation_metadata( + object_=gift_card_activity, annotation=GiftCardActivityParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateGiftCardActivityResponse, + construct_type( + type_=CreateGiftCardActivityResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/gift_cards/client.py b/src/square/gift_cards/client.py new file mode 100644 index 00000000..c0ad5b06 --- /dev/null +++ b/src/square/gift_cards/client.py @@ -0,0 +1,813 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawGiftCardsClient +from .activities.client import ActivitiesClient +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.gift_card import GiftCard +from ..types.list_gift_cards_response import ListGiftCardsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.gift_card import GiftCardParams +from ..types.create_gift_card_response import CreateGiftCardResponse +from ..types.get_gift_card_from_gan_response import GetGiftCardFromGanResponse +from ..types.get_gift_card_from_nonce_response import GetGiftCardFromNonceResponse +from ..types.link_customer_to_gift_card_response import LinkCustomerToGiftCardResponse +from ..types.unlink_customer_from_gift_card_response import UnlinkCustomerFromGiftCardResponse +from ..types.get_gift_card_response import GetGiftCardResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawGiftCardsClient +from .activities.client import AsyncActivitiesClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class GiftCardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawGiftCardsClient(client_wrapper=client_wrapper) + self.activities = ActivitiesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawGiftCardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawGiftCardsClient + """ + return self._raw_client + + def list( + self, + *, + type: typing.Optional[str] = None, + state: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + customer_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[GiftCard]: + """ + Lists all gift cards. You can specify optional filters to retrieve + a subset of the gift cards. Results are sorted by `created_at` in ascending order. + + Parameters + ---------- + type : typing.Optional[str] + If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type. + Otherwise, the endpoint returns gift cards of all types. + + state : typing.Optional[str] + If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. + Otherwise, the endpoint returns the gift cards of all states. + + limit : typing.Optional[int] + If a limit is provided, the endpoint returns only the specified number of results per page. + The maximum value is 200. The default value is 30. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + If a cursor is not provided, the endpoint returns the first page of the results. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + customer_id : typing.Optional[str] + If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[GiftCard] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.gift_cards.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/gift-cards", + method="GET", + params={ + "type": type, + "state": state, + "limit": limit, + "cursor": cursor, + "customer_id": customer_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListGiftCardsResponse, + construct_type( + type_=ListGiftCardsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + type=type, + state=state, + limit=limit, + cursor=_parsed_next, + customer_id=customer_id, + request_options=request_options, + ) + _items = _parsed_response.gift_cards + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: str, + location_id: str, + gift_card: GiftCardParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateGiftCardResponse: + """ + Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card + has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` + activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) + to refund a payment to the new gift card. + + Parameters + ---------- + idempotency_key : str + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + location_id : str + The ID of the [location](entity:Location) where the gift card should be registered for + reporting purposes. Gift cards can be redeemed at any of the seller's locations. + + gift_card : GiftCardParams + The gift card to create. The `type` field is required for this request. The `gan_source` + and `gan` fields are included as follows: + + To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`. + + To provide a custom GAN, include `gan_source` and `gan`. + - For `gan_source`, specify `OTHER`. + - For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be + unique for the seller and cannot start with the same bank identification number (BIN) as major + credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly + increase the risk of fraud. It is the responsibility of the developer to ensure the security + of their custom GANs. For more information, see + [Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). + + To register an unused, physical gift card that the seller previously ordered from Square, + include `gan` and provide the GAN that is printed on the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateGiftCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.create( + idempotency_key="NC9Tm69EjbjtConu", + location_id="81FN9BNFZTKS4", + gift_card={"type": "DIGITAL"}, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, + location_id=location_id, + gift_card=gift_card, + request_options=request_options, + ) + return response.data + + def get_from_gan( + self, *, gan: str, request_options: typing.Optional[RequestOptions] = None + ) -> GetGiftCardFromGanResponse: + """ + Retrieves a gift card using the gift card account number (GAN). + + Parameters + ---------- + gan : str + The gift card account number (GAN) of the gift card to retrieve. + The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. + Square-issued gift cards have 16-digit GANs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetGiftCardFromGanResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.get_from_gan( + gan="7783320001001635", + ) + """ + response = self._raw_client.get_from_gan(gan=gan, request_options=request_options) + return response.data + + def get_from_nonce( + self, *, nonce: str, request_options: typing.Optional[RequestOptions] = None + ) -> GetGiftCardFromNonceResponse: + """ + Retrieves a gift card using a secure payment token that represents the gift card. + + Parameters + ---------- + nonce : str + The payment token of the gift card to retrieve. Payment tokens are generated by the + Web Payments SDK or In-App Payments SDK. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetGiftCardFromNonceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.get_from_nonce( + nonce="cnon:7783322135245171", + ) + """ + response = self._raw_client.get_from_nonce(nonce=nonce, request_options=request_options) + return response.data + + def link_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> LinkCustomerToGiftCardResponse: + """ + Links a customer to a gift card, which is also referred to as adding a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be linked. + + customer_id : str + The ID of the customer to link to the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + LinkCustomerToGiftCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.link_customer( + gift_card_id="gift_card_id", + customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW", + ) + """ + response = self._raw_client.link_customer( + gift_card_id, customer_id=customer_id, request_options=request_options + ) + return response.data + + def unlink_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> UnlinkCustomerFromGiftCardResponse: + """ + Unlinks a customer from a gift card, which is also referred to as removing a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be unlinked. + + customer_id : str + The ID of the customer to unlink from the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UnlinkCustomerFromGiftCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.unlink_customer( + gift_card_id="gift_card_id", + customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW", + ) + """ + response = self._raw_client.unlink_customer( + gift_card_id, customer_id=customer_id, request_options=request_options + ) + return response.data + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetGiftCardResponse: + """ + Retrieves a gift card using the gift card ID. + + Parameters + ---------- + id : str + The ID of the gift card to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetGiftCardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.gift_cards.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + +class AsyncGiftCardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawGiftCardsClient(client_wrapper=client_wrapper) + self.activities = AsyncActivitiesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawGiftCardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawGiftCardsClient + """ + return self._raw_client + + async def list( + self, + *, + type: typing.Optional[str] = None, + state: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + customer_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[GiftCard]: + """ + Lists all gift cards. You can specify optional filters to retrieve + a subset of the gift cards. Results are sorted by `created_at` in ascending order. + + Parameters + ---------- + type : typing.Optional[str] + If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type. + Otherwise, the endpoint returns gift cards of all types. + + state : typing.Optional[str] + If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. + Otherwise, the endpoint returns the gift cards of all states. + + limit : typing.Optional[int] + If a limit is provided, the endpoint returns only the specified number of results per page. + The maximum value is 200. The default value is 30. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + If a cursor is not provided, the endpoint returns the first page of the results. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + customer_id : typing.Optional[str] + If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[GiftCard] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.gift_cards.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/gift-cards", + method="GET", + params={ + "type": type, + "state": state, + "limit": limit, + "cursor": cursor, + "customer_id": customer_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListGiftCardsResponse, + construct_type( + type_=ListGiftCardsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + type=type, + state=state, + limit=limit, + cursor=_parsed_next, + customer_id=customer_id, + request_options=request_options, + ) + _items = _parsed_response.gift_cards + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: str, + location_id: str, + gift_card: GiftCardParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateGiftCardResponse: + """ + Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card + has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` + activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) + to refund a payment to the new gift card. + + Parameters + ---------- + idempotency_key : str + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + location_id : str + The ID of the [location](entity:Location) where the gift card should be registered for + reporting purposes. Gift cards can be redeemed at any of the seller's locations. + + gift_card : GiftCardParams + The gift card to create. The `type` field is required for this request. The `gan_source` + and `gan` fields are included as follows: + + To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`. + + To provide a custom GAN, include `gan_source` and `gan`. + - For `gan_source`, specify `OTHER`. + - For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be + unique for the seller and cannot start with the same bank identification number (BIN) as major + credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly + increase the risk of fraud. It is the responsibility of the developer to ensure the security + of their custom GANs. For more information, see + [Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). + + To register an unused, physical gift card that the seller previously ordered from Square, + include `gan` and provide the GAN that is printed on the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateGiftCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.create( + idempotency_key="NC9Tm69EjbjtConu", + location_id="81FN9BNFZTKS4", + gift_card={"type": "DIGITAL"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, + location_id=location_id, + gift_card=gift_card, + request_options=request_options, + ) + return response.data + + async def get_from_gan( + self, *, gan: str, request_options: typing.Optional[RequestOptions] = None + ) -> GetGiftCardFromGanResponse: + """ + Retrieves a gift card using the gift card account number (GAN). + + Parameters + ---------- + gan : str + The gift card account number (GAN) of the gift card to retrieve. + The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. + Square-issued gift cards have 16-digit GANs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetGiftCardFromGanResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.get_from_gan( + gan="7783320001001635", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get_from_gan(gan=gan, request_options=request_options) + return response.data + + async def get_from_nonce( + self, *, nonce: str, request_options: typing.Optional[RequestOptions] = None + ) -> GetGiftCardFromNonceResponse: + """ + Retrieves a gift card using a secure payment token that represents the gift card. + + Parameters + ---------- + nonce : str + The payment token of the gift card to retrieve. Payment tokens are generated by the + Web Payments SDK or In-App Payments SDK. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetGiftCardFromNonceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.get_from_nonce( + nonce="cnon:7783322135245171", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get_from_nonce(nonce=nonce, request_options=request_options) + return response.data + + async def link_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> LinkCustomerToGiftCardResponse: + """ + Links a customer to a gift card, which is also referred to as adding a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be linked. + + customer_id : str + The ID of the customer to link to the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + LinkCustomerToGiftCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.link_customer( + gift_card_id="gift_card_id", + customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.link_customer( + gift_card_id, customer_id=customer_id, request_options=request_options + ) + return response.data + + async def unlink_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> UnlinkCustomerFromGiftCardResponse: + """ + Unlinks a customer from a gift card, which is also referred to as removing a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be unlinked. + + customer_id : str + The ID of the customer to unlink from the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UnlinkCustomerFromGiftCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.unlink_customer( + gift_card_id="gift_card_id", + customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.unlink_customer( + gift_card_id, customer_id=customer_id, request_options=request_options + ) + return response.data + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetGiftCardResponse: + """ + Retrieves a gift card using the gift card ID. + + Parameters + ---------- + id : str + The ID of the gift card to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetGiftCardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.gift_cards.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data diff --git a/src/square/gift_cards/raw_client.py b/src/square/gift_cards/raw_client.py new file mode 100644 index 00000000..56c60d65 --- /dev/null +++ b/src/square/gift_cards/raw_client.py @@ -0,0 +1,661 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.gift_card import GiftCardParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_gift_card_response import CreateGiftCardResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_gift_card_from_gan_response import GetGiftCardFromGanResponse +from ..types.get_gift_card_from_nonce_response import GetGiftCardFromNonceResponse +from ..types.link_customer_to_gift_card_response import LinkCustomerToGiftCardResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.unlink_customer_from_gift_card_response import UnlinkCustomerFromGiftCardResponse +from ..types.get_gift_card_response import GetGiftCardResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawGiftCardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + location_id: str, + gift_card: GiftCardParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateGiftCardResponse]: + """ + Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card + has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` + activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) + to refund a payment to the new gift card. + + Parameters + ---------- + idempotency_key : str + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + location_id : str + The ID of the [location](entity:Location) where the gift card should be registered for + reporting purposes. Gift cards can be redeemed at any of the seller's locations. + + gift_card : GiftCardParams + The gift card to create. The `type` field is required for this request. The `gan_source` + and `gan` fields are included as follows: + + To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`. + + To provide a custom GAN, include `gan_source` and `gan`. + - For `gan_source`, specify `OTHER`. + - For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be + unique for the seller and cannot start with the same bank identification number (BIN) as major + credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly + increase the risk of fraud. It is the responsibility of the developer to ensure the security + of their custom GANs. For more information, see + [Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). + + To register an unused, physical gift card that the seller previously ordered from Square, + include `gan` and provide the GAN that is printed on the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateGiftCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/gift-cards", + method="POST", + json={ + "idempotency_key": idempotency_key, + "location_id": location_id, + "gift_card": convert_and_respect_annotation_metadata( + object_=gift_card, annotation=GiftCardParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateGiftCardResponse, + construct_type( + type_=CreateGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_from_gan( + self, *, gan: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetGiftCardFromGanResponse]: + """ + Retrieves a gift card using the gift card account number (GAN). + + Parameters + ---------- + gan : str + The gift card account number (GAN) of the gift card to retrieve. + The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. + Square-issued gift cards have 16-digit GANs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetGiftCardFromGanResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/gift-cards/from-gan", + method="POST", + json={ + "gan": gan, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetGiftCardFromGanResponse, + construct_type( + type_=GetGiftCardFromGanResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_from_nonce( + self, *, nonce: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetGiftCardFromNonceResponse]: + """ + Retrieves a gift card using a secure payment token that represents the gift card. + + Parameters + ---------- + nonce : str + The payment token of the gift card to retrieve. Payment tokens are generated by the + Web Payments SDK or In-App Payments SDK. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetGiftCardFromNonceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/gift-cards/from-nonce", + method="POST", + json={ + "nonce": nonce, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetGiftCardFromNonceResponse, + construct_type( + type_=GetGiftCardFromNonceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def link_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[LinkCustomerToGiftCardResponse]: + """ + Links a customer to a gift card, which is also referred to as adding a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be linked. + + customer_id : str + The ID of the customer to link to the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[LinkCustomerToGiftCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/gift-cards/{jsonable_encoder(gift_card_id)}/link-customer", + method="POST", + json={ + "customer_id": customer_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + LinkCustomerToGiftCardResponse, + construct_type( + type_=LinkCustomerToGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def unlink_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UnlinkCustomerFromGiftCardResponse]: + """ + Unlinks a customer from a gift card, which is also referred to as removing a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be unlinked. + + customer_id : str + The ID of the customer to unlink from the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UnlinkCustomerFromGiftCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/gift-cards/{jsonable_encoder(gift_card_id)}/unlink-customer", + method="POST", + json={ + "customer_id": customer_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UnlinkCustomerFromGiftCardResponse, + construct_type( + type_=UnlinkCustomerFromGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetGiftCardResponse]: + """ + Retrieves a gift card using the gift card ID. + + Parameters + ---------- + id : str + The ID of the gift card to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetGiftCardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/gift-cards/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetGiftCardResponse, + construct_type( + type_=GetGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawGiftCardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + location_id: str, + gift_card: GiftCardParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateGiftCardResponse]: + """ + Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card + has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` + activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) + to refund a payment to the new gift card. + + Parameters + ---------- + idempotency_key : str + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + location_id : str + The ID of the [location](entity:Location) where the gift card should be registered for + reporting purposes. Gift cards can be redeemed at any of the seller's locations. + + gift_card : GiftCardParams + The gift card to create. The `type` field is required for this request. The `gan_source` + and `gan` fields are included as follows: + + To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`. + + To provide a custom GAN, include `gan_source` and `gan`. + - For `gan_source`, specify `OTHER`. + - For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be + unique for the seller and cannot start with the same bank identification number (BIN) as major + credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly + increase the risk of fraud. It is the responsibility of the developer to ensure the security + of their custom GANs. For more information, see + [Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). + + To register an unused, physical gift card that the seller previously ordered from Square, + include `gan` and provide the GAN that is printed on the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateGiftCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/gift-cards", + method="POST", + json={ + "idempotency_key": idempotency_key, + "location_id": location_id, + "gift_card": convert_and_respect_annotation_metadata( + object_=gift_card, annotation=GiftCardParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateGiftCardResponse, + construct_type( + type_=CreateGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_from_gan( + self, *, gan: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetGiftCardFromGanResponse]: + """ + Retrieves a gift card using the gift card account number (GAN). + + Parameters + ---------- + gan : str + The gift card account number (GAN) of the gift card to retrieve. + The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. + Square-issued gift cards have 16-digit GANs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetGiftCardFromGanResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/gift-cards/from-gan", + method="POST", + json={ + "gan": gan, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetGiftCardFromGanResponse, + construct_type( + type_=GetGiftCardFromGanResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_from_nonce( + self, *, nonce: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetGiftCardFromNonceResponse]: + """ + Retrieves a gift card using a secure payment token that represents the gift card. + + Parameters + ---------- + nonce : str + The payment token of the gift card to retrieve. Payment tokens are generated by the + Web Payments SDK or In-App Payments SDK. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetGiftCardFromNonceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/gift-cards/from-nonce", + method="POST", + json={ + "nonce": nonce, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetGiftCardFromNonceResponse, + construct_type( + type_=GetGiftCardFromNonceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def link_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[LinkCustomerToGiftCardResponse]: + """ + Links a customer to a gift card, which is also referred to as adding a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be linked. + + customer_id : str + The ID of the customer to link to the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[LinkCustomerToGiftCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/gift-cards/{jsonable_encoder(gift_card_id)}/link-customer", + method="POST", + json={ + "customer_id": customer_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + LinkCustomerToGiftCardResponse, + construct_type( + type_=LinkCustomerToGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def unlink_customer( + self, gift_card_id: str, *, customer_id: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UnlinkCustomerFromGiftCardResponse]: + """ + Unlinks a customer from a gift card, which is also referred to as removing a card on file. + + Parameters + ---------- + gift_card_id : str + The ID of the gift card to be unlinked. + + customer_id : str + The ID of the customer to unlink from the gift card. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UnlinkCustomerFromGiftCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/gift-cards/{jsonable_encoder(gift_card_id)}/unlink-customer", + method="POST", + json={ + "customer_id": customer_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UnlinkCustomerFromGiftCardResponse, + construct_type( + type_=UnlinkCustomerFromGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetGiftCardResponse]: + """ + Retrieves a gift card using the gift card ID. + + Parameters + ---------- + id : str + The ID of the gift card to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetGiftCardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/gift-cards/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetGiftCardResponse, + construct_type( + type_=GetGiftCardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/inventory/__init__.py b/src/square/inventory/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/inventory/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/inventory/client.py b/src/square/inventory/client.py new file mode 100644 index 00000000..a02c104f --- /dev/null +++ b/src/square/inventory/client.py @@ -0,0 +1,2018 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawInventoryClient +from ..core.request_options import RequestOptions +from ..types.get_inventory_adjustment_response import GetInventoryAdjustmentResponse +from ..requests.inventory_change import InventoryChangeParams +from ..types.batch_change_inventory_response import BatchChangeInventoryResponse +from ..types.inventory_change_type import InventoryChangeType +from ..types.inventory_state import InventoryState +from ..types.batch_get_inventory_changes_response import BatchGetInventoryChangesResponse +from ..types.batch_get_inventory_counts_response import BatchGetInventoryCountsResponse +from ..core.pagination import SyncPager +from ..types.inventory_change import InventoryChange +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.inventory_count import InventoryCount +from ..types.get_inventory_physical_count_response import GetInventoryPhysicalCountResponse +from ..types.get_inventory_transfer_response import GetInventoryTransferResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.get_inventory_count_response import GetInventoryCountResponse +from ..types.get_inventory_changes_response import GetInventoryChangesResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawInventoryClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class InventoryClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawInventoryClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawInventoryClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawInventoryClient + """ + return self._raw_client + + def deprecated_get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryAdjustmentResponse: + """ + Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryAdjustmentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.deprecated_get_adjustment( + adjustment_id="adjustment_id", + ) + """ + response = self._raw_client.deprecated_get_adjustment(adjustment_id, request_options=request_options) + return response.data + + def get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryAdjustmentResponse: + """ + Returns the [InventoryAdjustment](entity:InventoryAdjustment) object + with the provided `adjustment_id`. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryAdjustmentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.get_adjustment( + adjustment_id="adjustment_id", + ) + """ + response = self._raw_client.get_adjustment(adjustment_id, request_options=request_options) + return response.data + + def deprecated_batch_change( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchChangeInventoryResponse: + """ + Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchChangeInventoryResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.deprecated_batch_change( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "state": "IN_STOCK", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "team_member_id": "LRK57NSQ5X7PUD05", + "occurred_at": "2016-11-16T22:25:24.878Z", + }, + } + ], + ignore_unchanged_counts=True, + ) + """ + response = self._raw_client.deprecated_batch_change( + idempotency_key=idempotency_key, + changes=changes, + ignore_unchanged_counts=ignore_unchanged_counts, + request_options=request_options, + ) + return response.data + + def deprecated_batch_get_changes( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + types: typing.Optional[typing.Sequence[InventoryChangeType]] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + updated_before: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetInventoryChangesResponse: + """ + Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + + types : typing.Optional[typing.Sequence[InventoryChangeType]] + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + updated_before : typing.Optional[str] + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + The number of [records](entity:InventoryChange) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetInventoryChangesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.deprecated_batch_get_changes( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["C6W5YS5QM06F5"], + types=["PHYSICAL_COUNT"], + states=["IN_STOCK"], + updated_after="2016-11-01T00:00:00.000Z", + updated_before="2016-12-01T00:00:00.000Z", + ) + """ + response = self._raw_client.deprecated_batch_get_changes( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + types=types, + states=states, + updated_after=updated_after, + updated_before=updated_before, + cursor=cursor, + limit=limit, + request_options=request_options, + ) + return response.data + + def deprecated_batch_get_counts( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetInventoryCountsResponse: + """ + Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + + limit : typing.Optional[int] + The number of [records](entity:InventoryCount) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetInventoryCountsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.deprecated_batch_get_counts( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["59TNP9SA8VGDA"], + updated_after="2016-11-16T00:00:00.000Z", + ) + """ + response = self._raw_client.deprecated_batch_get_counts( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + updated_after=updated_after, + cursor=cursor, + states=states, + limit=limit, + request_options=request_options, + ) + return response.data + + def batch_create_changes( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchChangeInventoryResponse: + """ + Applies adjustments and counts to the provided item quantities. + + On success: returns the current calculated counts for all objects + referenced in the request. + On failure: returns a list of related errors. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchChangeInventoryResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.batch_create_changes( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "state": "IN_STOCK", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "team_member_id": "LRK57NSQ5X7PUD05", + "occurred_at": "2016-11-16T22:25:24.878Z", + }, + } + ], + ignore_unchanged_counts=True, + ) + """ + response = self._raw_client.batch_create_changes( + idempotency_key=idempotency_key, + changes=changes, + ignore_unchanged_counts=ignore_unchanged_counts, + request_options=request_options, + ) + return response.data + + def batch_get_changes( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + types: typing.Optional[typing.Sequence[InventoryChangeType]] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + updated_before: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[InventoryChange]: + """ + Returns historical physical counts and adjustments based on the + provided filter criteria. + + Results are paginated and sorted in ascending order according their + `occurred_at` timestamp (oldest first). + + BatchRetrieveInventoryChanges is a catch-all query endpoint for queries + that cannot be handled by other, simpler endpoints. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + + types : typing.Optional[typing.Sequence[InventoryChangeType]] + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + updated_before : typing.Optional[str] + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + The number of [records](entity:InventoryChange) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[InventoryChange] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.inventory.batch_get_changes( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["C6W5YS5QM06F5"], + types=["PHYSICAL_COUNT"], + states=["IN_STOCK"], + updated_after="2016-11-01T00:00:00.000Z", + updated_before="2016-12-01T00:00:00.000Z", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/inventory/changes/batch-retrieve", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "types": types, + "states": states, + "updated_after": updated_after, + "updated_before": updated_before, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + BatchGetInventoryChangesResponse, + construct_type( + type_=BatchGetInventoryChangesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.batch_get_changes( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + types=types, + states=states, + updated_after=updated_after, + updated_before=updated_before, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.changes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_get_counts( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[InventoryCount]: + """ + Returns current counts for the provided + [CatalogObject](entity:CatalogObject)s at the requested + [Location](entity:Location)s. + + Results are paginated and sorted in descending order according to their + `calculated_at` timestamp (newest first). + + When `updated_after` is specified, only counts that have changed since that + time (based on the server timestamp for the most recent change) are + returned. This allows clients to perform a "sync" operation, for example + in response to receiving a Webhook notification. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + + limit : typing.Optional[int] + The number of [records](entity:InventoryCount) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[InventoryCount] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.inventory.batch_get_counts( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["59TNP9SA8VGDA"], + updated_after="2016-11-16T00:00:00.000Z", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/inventory/counts/batch-retrieve", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "updated_after": updated_after, + "cursor": cursor, + "states": states, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + BatchGetInventoryCountsResponse, + construct_type( + type_=BatchGetInventoryCountsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.batch_get_counts( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + updated_after=updated_after, + cursor=_parsed_next, + states=states, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.counts + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def deprecated_get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryPhysicalCountResponse: + """ + Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryPhysicalCountResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.deprecated_get_physical_count( + physical_count_id="physical_count_id", + ) + """ + response = self._raw_client.deprecated_get_physical_count(physical_count_id, request_options=request_options) + return response.data + + def get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryPhysicalCountResponse: + """ + Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount) + object with the provided `physical_count_id`. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryPhysicalCountResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.get_physical_count( + physical_count_id="physical_count_id", + ) + """ + response = self._raw_client.get_physical_count(physical_count_id, request_options=request_options) + return response.data + + def get_transfer( + self, transfer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryTransferResponse: + """ + Returns the [InventoryTransfer](entity:InventoryTransfer) object + with the provided `transfer_id`. + + Parameters + ---------- + transfer_id : str + ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryTransferResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.inventory.get_transfer( + transfer_id="transfer_id", + ) + """ + response = self._raw_client.get_transfer(transfer_id, request_options=request_options) + return response.data + + def get( + self, + catalog_object_id: str, + *, + location_ids: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[InventoryCount]: + """ + Retrieves the current calculated stock count for a given + [CatalogObject](entity:CatalogObject) at a given set of + [Location](entity:Location)s. Responses are paginated and unsorted. + For more sophisticated queries, use a batch endpoint. + + Parameters + ---------- + catalog_object_id : str + ID of the [CatalogObject](entity:CatalogObject) to retrieve. + + location_ids : typing.Optional[str] + The [Location](entity:Location) IDs to look up as a comma-separated + list. An empty list queries all locations. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[InventoryCount] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.inventory.get( + catalog_object_id="catalog_object_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/inventory/{jsonable_encoder(catalog_object_id)}", + method="GET", + params={ + "location_ids": location_ids, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + GetInventoryCountResponse, + construct_type( + type_=GetInventoryCountResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.get( + catalog_object_id, + location_ids=location_ids, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.counts + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def changes( + self, + catalog_object_id: str, + *, + location_ids: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[InventoryChange]: + """ + Returns a set of physical counts and inventory adjustments for the + provided [CatalogObject](entity:CatalogObject) at the requested + [Location](entity:Location)s. + + You can achieve the same result by calling [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) + and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID. + + Results are paginated and sorted in descending order according to their + `occurred_at` timestamp (newest first). + + There are no limits on how far back the caller can page. This endpoint can be + used to display recent changes for a specific item. For more + sophisticated queries, use a batch endpoint. + + Parameters + ---------- + catalog_object_id : str + ID of the [CatalogObject](entity:CatalogObject) to retrieve. + + location_ids : typing.Optional[str] + The [Location](entity:Location) IDs to look up as a comma-separated + list. An empty list queries all locations. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[InventoryChange] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.inventory.changes( + catalog_object_id="catalog_object_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/inventory/{jsonable_encoder(catalog_object_id)}/changes", + method="GET", + params={ + "location_ids": location_ids, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + GetInventoryChangesResponse, + construct_type( + type_=GetInventoryChangesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.changes( + catalog_object_id, + location_ids=location_ids, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.changes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncInventoryClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawInventoryClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawInventoryClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawInventoryClient + """ + return self._raw_client + + async def deprecated_get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryAdjustmentResponse: + """ + Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryAdjustmentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.deprecated_get_adjustment( + adjustment_id="adjustment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.deprecated_get_adjustment(adjustment_id, request_options=request_options) + return response.data + + async def get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryAdjustmentResponse: + """ + Returns the [InventoryAdjustment](entity:InventoryAdjustment) object + with the provided `adjustment_id`. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryAdjustmentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.get_adjustment( + adjustment_id="adjustment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get_adjustment(adjustment_id, request_options=request_options) + return response.data + + async def deprecated_batch_change( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchChangeInventoryResponse: + """ + Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchChangeInventoryResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.deprecated_batch_change( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "state": "IN_STOCK", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "team_member_id": "LRK57NSQ5X7PUD05", + "occurred_at": "2016-11-16T22:25:24.878Z", + }, + } + ], + ignore_unchanged_counts=True, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.deprecated_batch_change( + idempotency_key=idempotency_key, + changes=changes, + ignore_unchanged_counts=ignore_unchanged_counts, + request_options=request_options, + ) + return response.data + + async def deprecated_batch_get_changes( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + types: typing.Optional[typing.Sequence[InventoryChangeType]] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + updated_before: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetInventoryChangesResponse: + """ + Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + + types : typing.Optional[typing.Sequence[InventoryChangeType]] + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + updated_before : typing.Optional[str] + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + The number of [records](entity:InventoryChange) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetInventoryChangesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.deprecated_batch_get_changes( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["C6W5YS5QM06F5"], + types=["PHYSICAL_COUNT"], + states=["IN_STOCK"], + updated_after="2016-11-01T00:00:00.000Z", + updated_before="2016-12-01T00:00:00.000Z", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.deprecated_batch_get_changes( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + types=types, + states=states, + updated_after=updated_after, + updated_before=updated_before, + cursor=cursor, + limit=limit, + request_options=request_options, + ) + return response.data + + async def deprecated_batch_get_counts( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetInventoryCountsResponse: + """ + Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + + limit : typing.Optional[int] + The number of [records](entity:InventoryCount) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetInventoryCountsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.deprecated_batch_get_counts( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["59TNP9SA8VGDA"], + updated_after="2016-11-16T00:00:00.000Z", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.deprecated_batch_get_counts( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + updated_after=updated_after, + cursor=cursor, + states=states, + limit=limit, + request_options=request_options, + ) + return response.data + + async def batch_create_changes( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchChangeInventoryResponse: + """ + Applies adjustments and counts to the provided item quantities. + + On success: returns the current calculated counts for all objects + referenced in the request. + On failure: returns a list of related errors. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchChangeInventoryResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.batch_create_changes( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", + "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", + "state": "IN_STOCK", + "location_id": "C6W5YS5QM06F5", + "quantity": "53", + "team_member_id": "LRK57NSQ5X7PUD05", + "occurred_at": "2016-11-16T22:25:24.878Z", + }, + } + ], + ignore_unchanged_counts=True, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_create_changes( + idempotency_key=idempotency_key, + changes=changes, + ignore_unchanged_counts=ignore_unchanged_counts, + request_options=request_options, + ) + return response.data + + async def batch_get_changes( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + types: typing.Optional[typing.Sequence[InventoryChangeType]] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + updated_before: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[InventoryChange]: + """ + Returns historical physical counts and adjustments based on the + provided filter criteria. + + Results are paginated and sorted in ascending order according their + `occurred_at` timestamp (oldest first). + + BatchRetrieveInventoryChanges is a catch-all query endpoint for queries + that cannot be handled by other, simpler endpoints. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + + types : typing.Optional[typing.Sequence[InventoryChangeType]] + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + updated_before : typing.Optional[str] + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + The number of [records](entity:InventoryChange) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[InventoryChange] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.inventory.batch_get_changes( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["C6W5YS5QM06F5"], + types=["PHYSICAL_COUNT"], + states=["IN_STOCK"], + updated_after="2016-11-01T00:00:00.000Z", + updated_before="2016-12-01T00:00:00.000Z", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/inventory/changes/batch-retrieve", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "types": types, + "states": states, + "updated_after": updated_after, + "updated_before": updated_before, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + BatchGetInventoryChangesResponse, + construct_type( + type_=BatchGetInventoryChangesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.batch_get_changes( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + types=types, + states=states, + updated_after=updated_after, + updated_before=updated_before, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.changes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_get_counts( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[InventoryCount]: + """ + Returns current counts for the provided + [CatalogObject](entity:CatalogObject)s at the requested + [Location](entity:Location)s. + + Results are paginated and sorted in descending order according to their + `calculated_at` timestamp (newest first). + + When `updated_after` is specified, only counts that have changed since that + time (based on the server timestamp for the most recent change) are + returned. This allows clients to perform a "sync" operation, for example + in response to receiving a Webhook notification. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + + limit : typing.Optional[int] + The number of [records](entity:InventoryCount) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[InventoryCount] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.inventory.batch_get_counts( + catalog_object_ids=["W62UWFY35CWMYGVWK6TWJDNI"], + location_ids=["59TNP9SA8VGDA"], + updated_after="2016-11-16T00:00:00.000Z", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/inventory/counts/batch-retrieve", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "updated_after": updated_after, + "cursor": cursor, + "states": states, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + BatchGetInventoryCountsResponse, + construct_type( + type_=BatchGetInventoryCountsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.batch_get_counts( + catalog_object_ids=catalog_object_ids, + location_ids=location_ids, + updated_after=updated_after, + cursor=_parsed_next, + states=states, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.counts + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def deprecated_get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryPhysicalCountResponse: + """ + Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryPhysicalCountResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.deprecated_get_physical_count( + physical_count_id="physical_count_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.deprecated_get_physical_count( + physical_count_id, request_options=request_options + ) + return response.data + + async def get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryPhysicalCountResponse: + """ + Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount) + object with the provided `physical_count_id`. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryPhysicalCountResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.get_physical_count( + physical_count_id="physical_count_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get_physical_count(physical_count_id, request_options=request_options) + return response.data + + async def get_transfer( + self, transfer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInventoryTransferResponse: + """ + Returns the [InventoryTransfer](entity:InventoryTransfer) object + with the provided `transfer_id`. + + Parameters + ---------- + transfer_id : str + ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInventoryTransferResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.inventory.get_transfer( + transfer_id="transfer_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get_transfer(transfer_id, request_options=request_options) + return response.data + + async def get( + self, + catalog_object_id: str, + *, + location_ids: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[InventoryCount]: + """ + Retrieves the current calculated stock count for a given + [CatalogObject](entity:CatalogObject) at a given set of + [Location](entity:Location)s. Responses are paginated and unsorted. + For more sophisticated queries, use a batch endpoint. + + Parameters + ---------- + catalog_object_id : str + ID of the [CatalogObject](entity:CatalogObject) to retrieve. + + location_ids : typing.Optional[str] + The [Location](entity:Location) IDs to look up as a comma-separated + list. An empty list queries all locations. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[InventoryCount] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.inventory.get( + catalog_object_id="catalog_object_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/inventory/{jsonable_encoder(catalog_object_id)}", + method="GET", + params={ + "location_ids": location_ids, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + GetInventoryCountResponse, + construct_type( + type_=GetInventoryCountResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.get( + catalog_object_id, + location_ids=location_ids, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.counts + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def changes( + self, + catalog_object_id: str, + *, + location_ids: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[InventoryChange]: + """ + Returns a set of physical counts and inventory adjustments for the + provided [CatalogObject](entity:CatalogObject) at the requested + [Location](entity:Location)s. + + You can achieve the same result by calling [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) + and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID. + + Results are paginated and sorted in descending order according to their + `occurred_at` timestamp (newest first). + + There are no limits on how far back the caller can page. This endpoint can be + used to display recent changes for a specific item. For more + sophisticated queries, use a batch endpoint. + + Parameters + ---------- + catalog_object_id : str + ID of the [CatalogObject](entity:CatalogObject) to retrieve. + + location_ids : typing.Optional[str] + The [Location](entity:Location) IDs to look up as a comma-separated + list. An empty list queries all locations. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[InventoryChange] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.inventory.changes( + catalog_object_id="catalog_object_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/inventory/{jsonable_encoder(catalog_object_id)}/changes", + method="GET", + params={ + "location_ids": location_ids, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + GetInventoryChangesResponse, + construct_type( + type_=GetInventoryChangesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.changes( + catalog_object_id, + location_ids=location_ids, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.changes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/inventory/raw_client.py b/src/square/inventory/raw_client.py new file mode 100644 index 00000000..2bf46f77 --- /dev/null +++ b/src/square/inventory/raw_client.py @@ -0,0 +1,1071 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_inventory_adjustment_response import GetInventoryAdjustmentResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.inventory_change import InventoryChangeParams +from ..types.batch_change_inventory_response import BatchChangeInventoryResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..types.inventory_change_type import InventoryChangeType +from ..types.inventory_state import InventoryState +from ..types.batch_get_inventory_changes_response import BatchGetInventoryChangesResponse +from ..types.batch_get_inventory_counts_response import BatchGetInventoryCountsResponse +from ..types.get_inventory_physical_count_response import GetInventoryPhysicalCountResponse +from ..types.get_inventory_transfer_response import GetInventoryTransferResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawInventoryClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def deprecated_get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetInventoryAdjustmentResponse]: + """ + Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetInventoryAdjustmentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/inventory/adjustment/{jsonable_encoder(adjustment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryAdjustmentResponse, + construct_type( + type_=GetInventoryAdjustmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetInventoryAdjustmentResponse]: + """ + Returns the [InventoryAdjustment](entity:InventoryAdjustment) object + with the provided `adjustment_id`. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetInventoryAdjustmentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/inventory/adjustments/{jsonable_encoder(adjustment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryAdjustmentResponse, + construct_type( + type_=GetInventoryAdjustmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def deprecated_batch_change( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchChangeInventoryResponse]: + """ + Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchChangeInventoryResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/inventory/batch-change", + method="POST", + json={ + "idempotency_key": idempotency_key, + "changes": convert_and_respect_annotation_metadata( + object_=changes, + annotation=typing.Optional[typing.Sequence[InventoryChangeParams]], + direction="write", + ), + "ignore_unchanged_counts": ignore_unchanged_counts, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchChangeInventoryResponse, + construct_type( + type_=BatchChangeInventoryResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def deprecated_batch_get_changes( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + types: typing.Optional[typing.Sequence[InventoryChangeType]] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + updated_before: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchGetInventoryChangesResponse]: + """ + Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + + types : typing.Optional[typing.Sequence[InventoryChangeType]] + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + updated_before : typing.Optional[str] + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + The number of [records](entity:InventoryChange) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchGetInventoryChangesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/inventory/batch-retrieve-changes", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "types": types, + "states": states, + "updated_after": updated_after, + "updated_before": updated_before, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetInventoryChangesResponse, + construct_type( + type_=BatchGetInventoryChangesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def deprecated_batch_get_counts( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchGetInventoryCountsResponse]: + """ + Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + + limit : typing.Optional[int] + The number of [records](entity:InventoryCount) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchGetInventoryCountsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/inventory/batch-retrieve-counts", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "updated_after": updated_after, + "cursor": cursor, + "states": states, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetInventoryCountsResponse, + construct_type( + type_=BatchGetInventoryCountsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_create_changes( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchChangeInventoryResponse]: + """ + Applies adjustments and counts to the provided item quantities. + + On success: returns the current calculated counts for all objects + referenced in the request. + On failure: returns a list of related errors. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchChangeInventoryResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/inventory/changes/batch-create", + method="POST", + json={ + "idempotency_key": idempotency_key, + "changes": convert_and_respect_annotation_metadata( + object_=changes, + annotation=typing.Optional[typing.Sequence[InventoryChangeParams]], + direction="write", + ), + "ignore_unchanged_counts": ignore_unchanged_counts, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchChangeInventoryResponse, + construct_type( + type_=BatchChangeInventoryResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def deprecated_get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetInventoryPhysicalCountResponse]: + """ + Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetInventoryPhysicalCountResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/inventory/physical-count/{jsonable_encoder(physical_count_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryPhysicalCountResponse, + construct_type( + type_=GetInventoryPhysicalCountResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetInventoryPhysicalCountResponse]: + """ + Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount) + object with the provided `physical_count_id`. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetInventoryPhysicalCountResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/inventory/physical-counts/{jsonable_encoder(physical_count_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryPhysicalCountResponse, + construct_type( + type_=GetInventoryPhysicalCountResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get_transfer( + self, transfer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetInventoryTransferResponse]: + """ + Returns the [InventoryTransfer](entity:InventoryTransfer) object + with the provided `transfer_id`. + + Parameters + ---------- + transfer_id : str + ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetInventoryTransferResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/inventory/transfers/{jsonable_encoder(transfer_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryTransferResponse, + construct_type( + type_=GetInventoryTransferResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawInventoryClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def deprecated_get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetInventoryAdjustmentResponse]: + """ + Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetInventoryAdjustmentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/inventory/adjustment/{jsonable_encoder(adjustment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryAdjustmentResponse, + construct_type( + type_=GetInventoryAdjustmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_adjustment( + self, adjustment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetInventoryAdjustmentResponse]: + """ + Returns the [InventoryAdjustment](entity:InventoryAdjustment) object + with the provided `adjustment_id`. + + Parameters + ---------- + adjustment_id : str + ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetInventoryAdjustmentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/inventory/adjustments/{jsonable_encoder(adjustment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryAdjustmentResponse, + construct_type( + type_=GetInventoryAdjustmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def deprecated_batch_change( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchChangeInventoryResponse]: + """ + Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchChangeInventoryResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/inventory/batch-change", + method="POST", + json={ + "idempotency_key": idempotency_key, + "changes": convert_and_respect_annotation_metadata( + object_=changes, + annotation=typing.Optional[typing.Sequence[InventoryChangeParams]], + direction="write", + ), + "ignore_unchanged_counts": ignore_unchanged_counts, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchChangeInventoryResponse, + construct_type( + type_=BatchChangeInventoryResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def deprecated_batch_get_changes( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + types: typing.Optional[typing.Sequence[InventoryChangeType]] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + updated_before: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchGetInventoryChangesResponse]: + """ + Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + + types : typing.Optional[typing.Sequence[InventoryChangeType]] + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + updated_before : typing.Optional[str] + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + limit : typing.Optional[int] + The number of [records](entity:InventoryChange) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchGetInventoryChangesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/inventory/batch-retrieve-changes", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "types": types, + "states": states, + "updated_after": updated_after, + "updated_before": updated_before, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetInventoryChangesResponse, + construct_type( + type_=BatchGetInventoryChangesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def deprecated_batch_get_counts( + self, + *, + catalog_object_ids: typing.Optional[typing.Sequence[str]] = OMIT, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + updated_after: typing.Optional[str] = OMIT, + cursor: typing.Optional[str] = OMIT, + states: typing.Optional[typing.Sequence[InventoryState]] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchGetInventoryCountsResponse]: + """ + Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + catalog_object_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + + location_ids : typing.Optional[typing.Sequence[str]] + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + + updated_after : typing.Optional[str] + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + states : typing.Optional[typing.Sequence[InventoryState]] + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + + limit : typing.Optional[int] + The number of [records](entity:InventoryCount) to return. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchGetInventoryCountsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/inventory/batch-retrieve-counts", + method="POST", + json={ + "catalog_object_ids": catalog_object_ids, + "location_ids": location_ids, + "updated_after": updated_after, + "cursor": cursor, + "states": states, + "limit": limit, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetInventoryCountsResponse, + construct_type( + type_=BatchGetInventoryCountsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_create_changes( + self, + *, + idempotency_key: str, + changes: typing.Optional[typing.Sequence[InventoryChangeParams]] = OMIT, + ignore_unchanged_counts: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchChangeInventoryResponse]: + """ + Applies adjustments and counts to the provided item quantities. + + On success: returns the current calculated counts for all objects + referenced in the request. + On failure: returns a list of related errors. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + changes : typing.Optional[typing.Sequence[InventoryChangeParams]] + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + + ignore_unchanged_counts : typing.Optional[bool] + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchChangeInventoryResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/inventory/changes/batch-create", + method="POST", + json={ + "idempotency_key": idempotency_key, + "changes": convert_and_respect_annotation_metadata( + object_=changes, + annotation=typing.Optional[typing.Sequence[InventoryChangeParams]], + direction="write", + ), + "ignore_unchanged_counts": ignore_unchanged_counts, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchChangeInventoryResponse, + construct_type( + type_=BatchChangeInventoryResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def deprecated_get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetInventoryPhysicalCountResponse]: + """ + Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL + is updated to conform to the standard convention. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetInventoryPhysicalCountResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/inventory/physical-count/{jsonable_encoder(physical_count_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryPhysicalCountResponse, + construct_type( + type_=GetInventoryPhysicalCountResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_physical_count( + self, physical_count_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetInventoryPhysicalCountResponse]: + """ + Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount) + object with the provided `physical_count_id`. + + Parameters + ---------- + physical_count_id : str + ID of the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetInventoryPhysicalCountResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/inventory/physical-counts/{jsonable_encoder(physical_count_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryPhysicalCountResponse, + construct_type( + type_=GetInventoryPhysicalCountResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get_transfer( + self, transfer_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetInventoryTransferResponse]: + """ + Returns the [InventoryTransfer](entity:InventoryTransfer) object + with the provided `transfer_id`. + + Parameters + ---------- + transfer_id : str + ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetInventoryTransferResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/inventory/transfers/{jsonable_encoder(transfer_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInventoryTransferResponse, + construct_type( + type_=GetInventoryTransferResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/invoices/__init__.py b/src/square/invoices/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/invoices/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/invoices/client.py b/src/square/invoices/client.py new file mode 100644 index 00000000..5fb73a6b --- /dev/null +++ b/src/square/invoices/client.py @@ -0,0 +1,1332 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawInvoicesClient +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.invoice import Invoice +from ..types.list_invoices_response import ListInvoicesResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.invoice import InvoiceParams +from ..types.create_invoice_response import CreateInvoiceResponse +from ..requests.invoice_query import InvoiceQueryParams +from ..types.search_invoices_response import SearchInvoicesResponse +from ..types.get_invoice_response import GetInvoiceResponse +from ..types.update_invoice_response import UpdateInvoiceResponse +from ..types.delete_invoice_response import DeleteInvoiceResponse +from .. import core +from ..types.create_invoice_attachment_response import CreateInvoiceAttachmentResponse +from ..types.delete_invoice_attachment_response import DeleteInvoiceAttachmentResponse +from ..types.cancel_invoice_response import CancelInvoiceResponse +from ..types.publish_invoice_response import PublishInvoiceResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawInvoicesClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class InvoicesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawInvoicesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawInvoicesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawInvoicesClient + """ + return self._raw_client + + def list( + self, + *, + location_id: str, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Invoice]: + """ + Returns a list of invoices for a given location. The response + is paginated. If truncated, the response includes a `cursor` that you + use in a subsequent request to retrieve the next set of invoices. + + Parameters + ---------- + location_id : str + The ID of the location for which to list invoices. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of invoices to return (200 is the maximum `limit`). + If not provided, the server uses a default limit of 100 invoices. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Invoice] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.invoices.list( + location_id="location_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/invoices", + method="GET", + params={ + "location_id": location_id, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListInvoicesResponse, + construct_type( + type_=ListInvoicesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.invoices + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateInvoiceResponse: + """ + Creates a draft [invoice](entity:Invoice) + for an order created using the Orders API. + + A draft invoice remains in your account and no action is taken. + You must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file). + + Parameters + ---------- + invoice : InvoiceParams + The invoice to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `CreateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateInvoiceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.create( + invoice={ + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "primary_recipient": {"customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4"}, + "payment_requests": [ + { + "request_type": "BALANCE", + "due_date": "2030-01-24", + "tipping_enabled": True, + "automatic_payment_source": "NONE", + "reminders": [ + { + "relative_scheduled_days": -1, + "message": "Your invoice is due tomorrow", + } + ], + } + ], + "delivery_method": "EMAIL", + "invoice_number": "inv-100", + "title": "Event Planning Services", + "description": "We appreciate your business!", + "scheduled_at": "2030-01-13T10:00:00Z", + "accepted_payment_methods": { + "card": True, + "square_gift_card": False, + "bank_account": False, + "buy_now_pay_later": False, + "cash_app_pay": False, + }, + "custom_fields": [ + { + "label": "Event Reference Number", + "value": "Ref. #1234", + "placement": "ABOVE_LINE_ITEMS", + }, + { + "label": "Terms of Service", + "value": "The terms of service are...", + "placement": "BELOW_LINE_ITEMS", + }, + ], + "sale_or_service_date": "2030-01-24", + "store_payment_method_enabled": False, + }, + idempotency_key="ce3748f9-5fc1-4762-aa12-aae5e843f1f4", + ) + """ + response = self._raw_client.create( + invoice=invoice, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: InvoiceQueryParams, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchInvoicesResponse: + """ + Searches for invoices from a location specified in + the filter. You can optionally specify customers in the filter for whom to + retrieve invoices. In the current implementation, you can only specify one location and + optionally one customer. + + The response is paginated. If truncated, the response includes a `cursor` + that you use in a subsequent request to retrieve the next set of invoices. + + Parameters + ---------- + query : InvoiceQueryParams + Describes the query criteria for searching invoices. + + limit : typing.Optional[int] + The maximum number of invoices to return (200 is the maximum `limit`). + If not provided, the server uses a default limit of 100 invoices. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchInvoicesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.search( + query={ + "filter": { + "location_ids": ["ES0RJRZYEC39A"], + "customer_ids": ["JDKYHBWT1D4F8MFH63DBMEN8Y4"], + }, + "sort": {"field": "INVOICE_SORT_DATE", "order": "DESC"}, + }, + limit=100, + ) + """ + response = self._raw_client.search(query=query, limit=limit, cursor=cursor, request_options=request_options) + return response.data + + def get(self, invoice_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetInvoiceResponse: + """ + Retrieves an invoice by invoice ID. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInvoiceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.get( + invoice_id="invoice_id", + ) + """ + response = self._raw_client.get(invoice_id, request_options=request_options) + return response.data + + def update( + self, + invoice_id: str, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateInvoiceResponse: + """ + Updates an invoice. This endpoint supports sparse updates, so you only need + to specify the fields you want to change along with the required `version` field. + Some restrictions apply to updating invoices. For example, you cannot change the + `order_id` or `location_id` field. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to update. + + invoice : InvoiceParams + The invoice fields to add, change, or clear. Fields can be cleared using + null values or the `remove` field (for individual payment requests or reminders). + The current invoice `version` is also required. For more information, including requirements, + limitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + idempotency_key : typing.Optional[str] + A unique string that identifies the `UpdateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The list of fields to clear. Although this field is currently supported, we + recommend using null values or the `remove` field when possible. For examples, see + [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateInvoiceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.update( + invoice_id="invoice_id", + invoice={ + "version": 1, + "payment_requests": [ + { + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355", + "tipping_enabled": False, + } + ], + }, + idempotency_key="4ee82288-0910-499e-ab4c-5d0071dad1be", + ) + """ + response = self._raw_client.update( + invoice_id, + invoice=invoice, + idempotency_key=idempotency_key, + fields_to_clear=fields_to_clear, + request_options=request_options, + ) + return response.data + + def delete( + self, + invoice_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> DeleteInvoiceResponse: + """ + Deletes the specified invoice. When an invoice is deleted, the + associated order status changes to CANCELED. You can only delete a draft + invoice (you cannot delete a published invoice, including one that is scheduled for processing). + + Parameters + ---------- + invoice_id : str + The ID of the invoice to delete. + + version : typing.Optional[int] + The version of the [invoice](entity:Invoice) to delete. + If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or + [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteInvoiceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.delete( + invoice_id="invoice_id", + ) + """ + response = self._raw_client.delete(invoice_id, version=version, request_options=request_options) + return response.data + + def create_invoice_attachment( + self, + invoice_id: str, + *, + request: typing.Optional[typing.Optional[typing.Any]] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateInvoiceAttachmentResponse: + """ + Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads + with a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file + in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF. + + Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices + in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + __NOTE:__ When testing in the Sandbox environment, the total file size is limited to 1 KB. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to attach the file to. + + request : typing.Optional[typing.Optional[typing.Any]] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateInvoiceAttachmentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.create_invoice_attachment( + invoice_id="invoice_id", + ) + """ + response = self._raw_client.create_invoice_attachment( + invoice_id, request=request, image_file=image_file, request_options=request_options + ) + return response.data + + def delete_invoice_attachment( + self, invoice_id: str, attachment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteInvoiceAttachmentResponse: + """ + Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only + from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to delete the attachment from. + + attachment_id : str + The ID of the [attachment](entity:InvoiceAttachment) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteInvoiceAttachmentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.delete_invoice_attachment( + invoice_id="invoice_id", + attachment_id="attachment_id", + ) + """ + response = self._raw_client.delete_invoice_attachment( + invoice_id, attachment_id, request_options=request_options + ) + return response.data + + def cancel( + self, invoice_id: str, *, version: int, request_options: typing.Optional[RequestOptions] = None + ) -> CancelInvoiceResponse: + """ + Cancels an invoice. The seller cannot collect payments for + the canceled invoice. + + You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to cancel. + + version : int + The version of the [invoice](entity:Invoice) to cancel. + If you do not know the version, you can call + [GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelInvoiceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.cancel( + invoice_id="invoice_id", + version=0, + ) + """ + response = self._raw_client.cancel(invoice_id, version=version, request_options=request_options) + return response.data + + def publish( + self, + invoice_id: str, + *, + version: int, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> PublishInvoiceResponse: + """ + Publishes the specified draft invoice. + + After an invoice is published, Square + follows up based on the invoice configuration. For example, Square + sends the invoice to the customer's email address, charges the customer's card on file, or does + nothing. Square also makes the invoice available on a Square-hosted invoice page. + + The invoice `status` also changes from `DRAFT` to a status + based on the invoice configuration. For example, the status changes to `UNPAID` if + Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the + invoice amount. + + In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ` + and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to publish. + + version : int + The version of the [invoice](entity:Invoice) to publish. + This must match the current version of the invoice; otherwise, the request is rejected. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `PublishInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + PublishInvoiceResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.invoices.publish( + invoice_id="invoice_id", + version=1, + idempotency_key="32da42d0-1997-41b0-826b-f09464fc2c2e", + ) + """ + response = self._raw_client.publish( + invoice_id, version=version, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + +class AsyncInvoicesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawInvoicesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawInvoicesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawInvoicesClient + """ + return self._raw_client + + async def list( + self, + *, + location_id: str, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Invoice]: + """ + Returns a list of invoices for a given location. The response + is paginated. If truncated, the response includes a `cursor` that you + use in a subsequent request to retrieve the next set of invoices. + + Parameters + ---------- + location_id : str + The ID of the location for which to list invoices. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of invoices to return (200 is the maximum `limit`). + If not provided, the server uses a default limit of 100 invoices. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Invoice] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.invoices.list( + location_id="location_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/invoices", + method="GET", + params={ + "location_id": location_id, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListInvoicesResponse, + construct_type( + type_=ListInvoicesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.invoices + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateInvoiceResponse: + """ + Creates a draft [invoice](entity:Invoice) + for an order created using the Orders API. + + A draft invoice remains in your account and no action is taken. + You must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file). + + Parameters + ---------- + invoice : InvoiceParams + The invoice to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `CreateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateInvoiceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.create( + invoice={ + "location_id": "ES0RJRZYEC39A", + "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", + "primary_recipient": {"customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4"}, + "payment_requests": [ + { + "request_type": "BALANCE", + "due_date": "2030-01-24", + "tipping_enabled": True, + "automatic_payment_source": "NONE", + "reminders": [ + { + "relative_scheduled_days": -1, + "message": "Your invoice is due tomorrow", + } + ], + } + ], + "delivery_method": "EMAIL", + "invoice_number": "inv-100", + "title": "Event Planning Services", + "description": "We appreciate your business!", + "scheduled_at": "2030-01-13T10:00:00Z", + "accepted_payment_methods": { + "card": True, + "square_gift_card": False, + "bank_account": False, + "buy_now_pay_later": False, + "cash_app_pay": False, + }, + "custom_fields": [ + { + "label": "Event Reference Number", + "value": "Ref. #1234", + "placement": "ABOVE_LINE_ITEMS", + }, + { + "label": "Terms of Service", + "value": "The terms of service are...", + "placement": "BELOW_LINE_ITEMS", + }, + ], + "sale_or_service_date": "2030-01-24", + "store_payment_method_enabled": False, + }, + idempotency_key="ce3748f9-5fc1-4762-aa12-aae5e843f1f4", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + invoice=invoice, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: InvoiceQueryParams, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchInvoicesResponse: + """ + Searches for invoices from a location specified in + the filter. You can optionally specify customers in the filter for whom to + retrieve invoices. In the current implementation, you can only specify one location and + optionally one customer. + + The response is paginated. If truncated, the response includes a `cursor` + that you use in a subsequent request to retrieve the next set of invoices. + + Parameters + ---------- + query : InvoiceQueryParams + Describes the query criteria for searching invoices. + + limit : typing.Optional[int] + The maximum number of invoices to return (200 is the maximum `limit`). + If not provided, the server uses a default limit of 100 invoices. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchInvoicesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.search( + query={ + "filter": { + "location_ids": ["ES0RJRZYEC39A"], + "customer_ids": ["JDKYHBWT1D4F8MFH63DBMEN8Y4"], + }, + "sort": {"field": "INVOICE_SORT_DATE", "order": "DESC"}, + }, + limit=100, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data + + async def get( + self, invoice_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetInvoiceResponse: + """ + Retrieves an invoice by invoice ID. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetInvoiceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.get( + invoice_id="invoice_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(invoice_id, request_options=request_options) + return response.data + + async def update( + self, + invoice_id: str, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateInvoiceResponse: + """ + Updates an invoice. This endpoint supports sparse updates, so you only need + to specify the fields you want to change along with the required `version` field. + Some restrictions apply to updating invoices. For example, you cannot change the + `order_id` or `location_id` field. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to update. + + invoice : InvoiceParams + The invoice fields to add, change, or clear. Fields can be cleared using + null values or the `remove` field (for individual payment requests or reminders). + The current invoice `version` is also required. For more information, including requirements, + limitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + idempotency_key : typing.Optional[str] + A unique string that identifies the `UpdateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The list of fields to clear. Although this field is currently supported, we + recommend using null values or the `remove` field when possible. For examples, see + [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateInvoiceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.update( + invoice_id="invoice_id", + invoice={ + "version": 1, + "payment_requests": [ + { + "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355", + "tipping_enabled": False, + } + ], + }, + idempotency_key="4ee82288-0910-499e-ab4c-5d0071dad1be", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + invoice_id, + invoice=invoice, + idempotency_key=idempotency_key, + fields_to_clear=fields_to_clear, + request_options=request_options, + ) + return response.data + + async def delete( + self, + invoice_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> DeleteInvoiceResponse: + """ + Deletes the specified invoice. When an invoice is deleted, the + associated order status changes to CANCELED. You can only delete a draft + invoice (you cannot delete a published invoice, including one that is scheduled for processing). + + Parameters + ---------- + invoice_id : str + The ID of the invoice to delete. + + version : typing.Optional[int] + The version of the [invoice](entity:Invoice) to delete. + If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or + [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteInvoiceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.delete( + invoice_id="invoice_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(invoice_id, version=version, request_options=request_options) + return response.data + + async def create_invoice_attachment( + self, + invoice_id: str, + *, + request: typing.Optional[typing.Optional[typing.Any]] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateInvoiceAttachmentResponse: + """ + Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads + with a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file + in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF. + + Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices + in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + __NOTE:__ When testing in the Sandbox environment, the total file size is limited to 1 KB. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to attach the file to. + + request : typing.Optional[typing.Optional[typing.Any]] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateInvoiceAttachmentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.create_invoice_attachment( + invoice_id="invoice_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create_invoice_attachment( + invoice_id, request=request, image_file=image_file, request_options=request_options + ) + return response.data + + async def delete_invoice_attachment( + self, invoice_id: str, attachment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteInvoiceAttachmentResponse: + """ + Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only + from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to delete the attachment from. + + attachment_id : str + The ID of the [attachment](entity:InvoiceAttachment) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteInvoiceAttachmentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.delete_invoice_attachment( + invoice_id="invoice_id", + attachment_id="attachment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete_invoice_attachment( + invoice_id, attachment_id, request_options=request_options + ) + return response.data + + async def cancel( + self, invoice_id: str, *, version: int, request_options: typing.Optional[RequestOptions] = None + ) -> CancelInvoiceResponse: + """ + Cancels an invoice. The seller cannot collect payments for + the canceled invoice. + + You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to cancel. + + version : int + The version of the [invoice](entity:Invoice) to cancel. + If you do not know the version, you can call + [GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelInvoiceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.cancel( + invoice_id="invoice_id", + version=0, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(invoice_id, version=version, request_options=request_options) + return response.data + + async def publish( + self, + invoice_id: str, + *, + version: int, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> PublishInvoiceResponse: + """ + Publishes the specified draft invoice. + + After an invoice is published, Square + follows up based on the invoice configuration. For example, Square + sends the invoice to the customer's email address, charges the customer's card on file, or does + nothing. Square also makes the invoice available on a Square-hosted invoice page. + + The invoice `status` also changes from `DRAFT` to a status + based on the invoice configuration. For example, the status changes to `UNPAID` if + Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the + invoice amount. + + In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ` + and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to publish. + + version : int + The version of the [invoice](entity:Invoice) to publish. + This must match the current version of the invoice; otherwise, the request is rejected. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `PublishInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + PublishInvoiceResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.invoices.publish( + invoice_id="invoice_id", + version=1, + idempotency_key="32da42d0-1997-41b0-826b-f09464fc2c2e", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.publish( + invoice_id, version=version, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data diff --git a/src/square/invoices/raw_client.py b/src/square/invoices/raw_client.py new file mode 100644 index 00000000..608d8b59 --- /dev/null +++ b/src/square/invoices/raw_client.py @@ -0,0 +1,1133 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.invoice import InvoiceParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_invoice_response import CreateInvoiceResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.invoice_query import InvoiceQueryParams +from ..types.search_invoices_response import SearchInvoicesResponse +from ..types.get_invoice_response import GetInvoiceResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_invoice_response import UpdateInvoiceResponse +from ..types.delete_invoice_response import DeleteInvoiceResponse +from .. import core +from ..types.create_invoice_attachment_response import CreateInvoiceAttachmentResponse +import json +from ..types.delete_invoice_attachment_response import DeleteInvoiceAttachmentResponse +from ..types.cancel_invoice_response import CancelInvoiceResponse +from ..types.publish_invoice_response import PublishInvoiceResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawInvoicesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateInvoiceResponse]: + """ + Creates a draft [invoice](entity:Invoice) + for an order created using the Orders API. + + A draft invoice remains in your account and no action is taken. + You must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file). + + Parameters + ---------- + invoice : InvoiceParams + The invoice to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `CreateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateInvoiceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/invoices", + method="POST", + json={ + "invoice": convert_and_respect_annotation_metadata( + object_=invoice, annotation=InvoiceParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateInvoiceResponse, + construct_type( + type_=CreateInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: InvoiceQueryParams, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchInvoicesResponse]: + """ + Searches for invoices from a location specified in + the filter. You can optionally specify customers in the filter for whom to + retrieve invoices. In the current implementation, you can only specify one location and + optionally one customer. + + The response is paginated. If truncated, the response includes a `cursor` + that you use in a subsequent request to retrieve the next set of invoices. + + Parameters + ---------- + query : InvoiceQueryParams + Describes the query criteria for searching invoices. + + limit : typing.Optional[int] + The maximum number of invoices to return (200 is the maximum `limit`). + If not provided, the server uses a default limit of 100 invoices. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchInvoicesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/invoices/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=InvoiceQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchInvoicesResponse, + construct_type( + type_=SearchInvoicesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, invoice_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetInvoiceResponse]: + """ + Retrieves an invoice by invoice ID. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetInvoiceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInvoiceResponse, + construct_type( + type_=GetInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + invoice_id: str, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateInvoiceResponse]: + """ + Updates an invoice. This endpoint supports sparse updates, so you only need + to specify the fields you want to change along with the required `version` field. + Some restrictions apply to updating invoices. For example, you cannot change the + `order_id` or `location_id` field. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to update. + + invoice : InvoiceParams + The invoice fields to add, change, or clear. Fields can be cleared using + null values or the `remove` field (for individual payment requests or reminders). + The current invoice `version` is also required. For more information, including requirements, + limitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + idempotency_key : typing.Optional[str] + A unique string that identifies the `UpdateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The list of fields to clear. Although this field is currently supported, we + recommend using null values or the `remove` field when possible. For examples, see + [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateInvoiceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}", + method="PUT", + json={ + "invoice": convert_and_respect_annotation_metadata( + object_=invoice, annotation=InvoiceParams, direction="write" + ), + "idempotency_key": idempotency_key, + "fields_to_clear": fields_to_clear, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateInvoiceResponse, + construct_type( + type_=UpdateInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, + invoice_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[DeleteInvoiceResponse]: + """ + Deletes the specified invoice. When an invoice is deleted, the + associated order status changes to CANCELED. You can only delete a draft + invoice (you cannot delete a published invoice, including one that is scheduled for processing). + + Parameters + ---------- + invoice_id : str + The ID of the invoice to delete. + + version : typing.Optional[int] + The version of the [invoice](entity:Invoice) to delete. + If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or + [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteInvoiceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}", + method="DELETE", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteInvoiceResponse, + construct_type( + type_=DeleteInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create_invoice_attachment( + self, + invoice_id: str, + *, + request: typing.Optional[typing.Optional[typing.Any]] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateInvoiceAttachmentResponse]: + """ + Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads + with a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file + in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF. + + Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices + in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + __NOTE:__ When testing in the Sandbox environment, the total file size is limited to 1 KB. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to attach the file to. + + request : typing.Optional[typing.Optional[typing.Any]] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateInvoiceAttachmentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/attachments", + method="POST", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateInvoiceAttachmentResponse, + construct_type( + type_=CreateInvoiceAttachmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete_invoice_attachment( + self, invoice_id: str, attachment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteInvoiceAttachmentResponse]: + """ + Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only + from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to delete the attachment from. + + attachment_id : str + The ID of the [attachment](entity:InvoiceAttachment) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteInvoiceAttachmentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/attachments/{jsonable_encoder(attachment_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteInvoiceAttachmentResponse, + construct_type( + type_=DeleteInvoiceAttachmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, invoice_id: str, *, version: int, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelInvoiceResponse]: + """ + Cancels an invoice. The seller cannot collect payments for + the canceled invoice. + + You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to cancel. + + version : int + The version of the [invoice](entity:Invoice) to cancel. + If you do not know the version, you can call + [GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelInvoiceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/cancel", + method="POST", + json={ + "version": version, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelInvoiceResponse, + construct_type( + type_=CancelInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def publish( + self, + invoice_id: str, + *, + version: int, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[PublishInvoiceResponse]: + """ + Publishes the specified draft invoice. + + After an invoice is published, Square + follows up based on the invoice configuration. For example, Square + sends the invoice to the customer's email address, charges the customer's card on file, or does + nothing. Square also makes the invoice available on a Square-hosted invoice page. + + The invoice `status` also changes from `DRAFT` to a status + based on the invoice configuration. For example, the status changes to `UNPAID` if + Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the + invoice amount. + + In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ` + and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to publish. + + version : int + The version of the [invoice](entity:Invoice) to publish. + This must match the current version of the invoice; otherwise, the request is rejected. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `PublishInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[PublishInvoiceResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/publish", + method="POST", + json={ + "version": version, + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PublishInvoiceResponse, + construct_type( + type_=PublishInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawInvoicesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateInvoiceResponse]: + """ + Creates a draft [invoice](entity:Invoice) + for an order created using the Orders API. + + A draft invoice remains in your account and no action is taken. + You must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file). + + Parameters + ---------- + invoice : InvoiceParams + The invoice to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `CreateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateInvoiceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/invoices", + method="POST", + json={ + "invoice": convert_and_respect_annotation_metadata( + object_=invoice, annotation=InvoiceParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateInvoiceResponse, + construct_type( + type_=CreateInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: InvoiceQueryParams, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchInvoicesResponse]: + """ + Searches for invoices from a location specified in + the filter. You can optionally specify customers in the filter for whom to + retrieve invoices. In the current implementation, you can only specify one location and + optionally one customer. + + The response is paginated. If truncated, the response includes a `cursor` + that you use in a subsequent request to retrieve the next set of invoices. + + Parameters + ---------- + query : InvoiceQueryParams + Describes the query criteria for searching invoices. + + limit : typing.Optional[int] + The maximum number of invoices to return (200 is the maximum `limit`). + If not provided, the server uses a default limit of 100 invoices. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchInvoicesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/invoices/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=InvoiceQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchInvoicesResponse, + construct_type( + type_=SearchInvoicesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, invoice_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetInvoiceResponse]: + """ + Retrieves an invoice by invoice ID. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetInvoiceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetInvoiceResponse, + construct_type( + type_=GetInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + invoice_id: str, + *, + invoice: InvoiceParams, + idempotency_key: typing.Optional[str] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateInvoiceResponse]: + """ + Updates an invoice. This endpoint supports sparse updates, so you only need + to specify the fields you want to change along with the required `version` field. + Some restrictions apply to updating invoices. For example, you cannot change the + `order_id` or `location_id` field. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to update. + + invoice : InvoiceParams + The invoice fields to add, change, or clear. Fields can be cleared using + null values or the `remove` field (for individual payment requests or reminders). + The current invoice `version` is also required. For more information, including requirements, + limitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + idempotency_key : typing.Optional[str] + A unique string that identifies the `UpdateInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The list of fields to clear. Although this field is currently supported, we + recommend using null values or the `remove` field when possible. For examples, see + [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateInvoiceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}", + method="PUT", + json={ + "invoice": convert_and_respect_annotation_metadata( + object_=invoice, annotation=InvoiceParams, direction="write" + ), + "idempotency_key": idempotency_key, + "fields_to_clear": fields_to_clear, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateInvoiceResponse, + construct_type( + type_=UpdateInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, + invoice_id: str, + *, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[DeleteInvoiceResponse]: + """ + Deletes the specified invoice. When an invoice is deleted, the + associated order status changes to CANCELED. You can only delete a draft + invoice (you cannot delete a published invoice, including one that is scheduled for processing). + + Parameters + ---------- + invoice_id : str + The ID of the invoice to delete. + + version : typing.Optional[int] + The version of the [invoice](entity:Invoice) to delete. + If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or + [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteInvoiceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}", + method="DELETE", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteInvoiceResponse, + construct_type( + type_=DeleteInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create_invoice_attachment( + self, + invoice_id: str, + *, + request: typing.Optional[typing.Optional[typing.Any]] = OMIT, + image_file: typing.Optional[core.File] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateInvoiceAttachmentResponse]: + """ + Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads + with a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file + in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF. + + Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices + in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + __NOTE:__ When testing in the Sandbox environment, the total file size is limited to 1 KB. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to attach the file to. + + request : typing.Optional[typing.Optional[typing.Any]] + + image_file : typing.Optional[core.File] + See core.File for more documentation + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateInvoiceAttachmentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/attachments", + method="POST", + data={}, + files={ + **( + {"request": (None, json.dumps(jsonable_encoder(request)), "application/json; charset=utf-8")} + if request is not OMIT + else {} + ), + **( + {"image_file": core.with_content_type(file=image_file, default_content_type="image/jpeg")} + if image_file is not None + else {} + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateInvoiceAttachmentResponse, + construct_type( + type_=CreateInvoiceAttachmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete_invoice_attachment( + self, invoice_id: str, attachment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteInvoiceAttachmentResponse]: + """ + Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only + from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to delete the attachment from. + + attachment_id : str + The ID of the [attachment](entity:InvoiceAttachment) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteInvoiceAttachmentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/attachments/{jsonable_encoder(attachment_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteInvoiceAttachmentResponse, + construct_type( + type_=DeleteInvoiceAttachmentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, invoice_id: str, *, version: int, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelInvoiceResponse]: + """ + Cancels an invoice. The seller cannot collect payments for + the canceled invoice. + + You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`. + + Parameters + ---------- + invoice_id : str + The ID of the [invoice](entity:Invoice) to cancel. + + version : int + The version of the [invoice](entity:Invoice) to cancel. + If you do not know the version, you can call + [GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelInvoiceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/cancel", + method="POST", + json={ + "version": version, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelInvoiceResponse, + construct_type( + type_=CancelInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def publish( + self, + invoice_id: str, + *, + version: int, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[PublishInvoiceResponse]: + """ + Publishes the specified draft invoice. + + After an invoice is published, Square + follows up based on the invoice configuration. For example, Square + sends the invoice to the customer's email address, charges the customer's card on file, or does + nothing. Square also makes the invoice available on a Square-hosted invoice page. + + The invoice `status` also changes from `DRAFT` to a status + based on the invoice configuration. For example, the status changes to `UNPAID` if + Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the + invoice amount. + + In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ` + and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments. + + Parameters + ---------- + invoice_id : str + The ID of the invoice to publish. + + version : int + The version of the [invoice](entity:Invoice) to publish. + This must match the current version of the invoice; otherwise, the request is rejected. + + idempotency_key : typing.Optional[str] + A unique string that identifies the `PublishInvoice` request. If you do not + provide `idempotency_key` (or provide an empty string as the value), the endpoint + treats each request as independent. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[PublishInvoiceResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/invoices/{jsonable_encoder(invoice_id)}/publish", + method="POST", + json={ + "version": version, + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PublishInvoiceResponse, + construct_type( + type_=PublishInvoiceResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/labor/__init__.py b/src/square/labor/__init__.py new file mode 100644 index 00000000..35d793c5 --- /dev/null +++ b/src/square/labor/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import break_types, employee_wages, shifts, team_member_wages, workweek_configs + +__all__ = ["break_types", "employee_wages", "shifts", "team_member_wages", "workweek_configs"] diff --git a/src/square/labor/break_types/__init__.py b/src/square/labor/break_types/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/labor/break_types/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/labor/break_types/client.py b/src/square/labor/break_types/client.py new file mode 100644 index 00000000..a890205c --- /dev/null +++ b/src/square/labor/break_types/client.py @@ -0,0 +1,593 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawBreakTypesClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.break_type import BreakType +from ...types.list_break_types_response import ListBreakTypesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.break_type import BreakTypeParams +from ...types.create_break_type_response import CreateBreakTypeResponse +from ...types.get_break_type_response import GetBreakTypeResponse +from ...types.update_break_type_response import UpdateBreakTypeResponse +from ...types.delete_break_type_response import DeleteBreakTypeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawBreakTypesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class BreakTypesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawBreakTypesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawBreakTypesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawBreakTypesClient + """ + return self._raw_client + + def list( + self, + *, + location_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[BreakType]: + """ + Returns a paginated list of `BreakType` instances for a business. + + Parameters + ---------- + location_id : typing.Optional[str] + Filter the returned `BreakType` results to only those that are associated with the + specified location. + + limit : typing.Optional[int] + The maximum number of `BreakType` results to return per page. The number can range between 1 + and 200. The default is 200. + + cursor : typing.Optional[str] + A pointer to the next page of `BreakType` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[BreakType] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.labor.break_types.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/break-types", + method="GET", + params={ + "location_id": location_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBreakTypesResponse, + construct_type( + type_=ListBreakTypesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.break_types + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + break_type: BreakTypeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateBreakTypeResponse: + """ + Creates a new `BreakType`. + + A `BreakType` is a template for creating `Break` objects. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `break_name` + - `expected_duration` + - `is_paid` + + You can only have three `BreakType` instances per location. If you attempt to add a fourth + `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location." + is returned. + + Parameters + ---------- + break_type : BreakTypeParams + The `BreakType` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateBreakTypeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.break_types.create( + idempotency_key="PAD3NG5KSN2GL", + break_type={ + "location_id": "CGJN03P1D08GF", + "break_name": "Lunch Break", + "expected_duration": "PT30M", + "is_paid": True, + }, + ) + """ + response = self._raw_client.create( + break_type=break_type, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetBreakTypeResponse: + """ + Returns a single `BreakType` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBreakTypeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.break_types.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + def update( + self, id: str, *, break_type: BreakTypeParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateBreakTypeResponse: + """ + Updates an existing `BreakType`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being updated. + + break_type : BreakTypeParams + The updated `BreakType`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateBreakTypeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.break_types.update( + id="id", + break_type={ + "location_id": "26M7H24AZ9N6R", + "break_name": "Lunch", + "expected_duration": "PT50M", + "is_paid": True, + "version": 1, + }, + ) + """ + response = self._raw_client.update(id, break_type=break_type, request_options=request_options) + return response.data + + def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteBreakTypeResponse: + """ + Deletes an existing `BreakType`. + + A `BreakType` can be deleted even if it is referenced from a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteBreakTypeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.break_types.delete( + id="id", + ) + """ + response = self._raw_client.delete(id, request_options=request_options) + return response.data + + +class AsyncBreakTypesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawBreakTypesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawBreakTypesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawBreakTypesClient + """ + return self._raw_client + + async def list( + self, + *, + location_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[BreakType]: + """ + Returns a paginated list of `BreakType` instances for a business. + + Parameters + ---------- + location_id : typing.Optional[str] + Filter the returned `BreakType` results to only those that are associated with the + specified location. + + limit : typing.Optional[int] + The maximum number of `BreakType` results to return per page. The number can range between 1 + and 200. The default is 200. + + cursor : typing.Optional[str] + A pointer to the next page of `BreakType` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[BreakType] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.labor.break_types.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/break-types", + method="GET", + params={ + "location_id": location_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListBreakTypesResponse, + construct_type( + type_=ListBreakTypesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.break_types + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + break_type: BreakTypeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateBreakTypeResponse: + """ + Creates a new `BreakType`. + + A `BreakType` is a template for creating `Break` objects. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `break_name` + - `expected_duration` + - `is_paid` + + You can only have three `BreakType` instances per location. If you attempt to add a fourth + `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location." + is returned. + + Parameters + ---------- + break_type : BreakTypeParams + The `BreakType` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateBreakTypeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.break_types.create( + idempotency_key="PAD3NG5KSN2GL", + break_type={ + "location_id": "CGJN03P1D08GF", + "break_name": "Lunch Break", + "expected_duration": "PT30M", + "is_paid": True, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + break_type=break_type, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetBreakTypeResponse: + """ + Returns a single `BreakType` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetBreakTypeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.break_types.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data + + async def update( + self, id: str, *, break_type: BreakTypeParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateBreakTypeResponse: + """ + Updates an existing `BreakType`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being updated. + + break_type : BreakTypeParams + The updated `BreakType`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateBreakTypeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.break_types.update( + id="id", + break_type={ + "location_id": "26M7H24AZ9N6R", + "break_name": "Lunch", + "expected_duration": "PT50M", + "is_paid": True, + "version": 1, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update(id, break_type=break_type, request_options=request_options) + return response.data + + async def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteBreakTypeResponse: + """ + Deletes an existing `BreakType`. + + A `BreakType` can be deleted even if it is referenced from a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteBreakTypeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.break_types.delete( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(id, request_options=request_options) + return response.data diff --git a/src/square/labor/break_types/raw_client.py b/src/square/labor/break_types/raw_client.py new file mode 100644 index 00000000..3b437ece --- /dev/null +++ b/src/square/labor/break_types/raw_client.py @@ -0,0 +1,431 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.break_type import BreakTypeParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_break_type_response import CreateBreakTypeResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_break_type_response import GetBreakTypeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_break_type_response import UpdateBreakTypeResponse +from ...types.delete_break_type_response import DeleteBreakTypeResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawBreakTypesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + break_type: BreakTypeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateBreakTypeResponse]: + """ + Creates a new `BreakType`. + + A `BreakType` is a template for creating `Break` objects. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `break_name` + - `expected_duration` + - `is_paid` + + You can only have three `BreakType` instances per location. If you attempt to add a fourth + `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location." + is returned. + + Parameters + ---------- + break_type : BreakTypeParams + The `BreakType` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateBreakTypeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/labor/break-types", + method="POST", + json={ + "idempotency_key": idempotency_key, + "break_type": convert_and_respect_annotation_metadata( + object_=break_type, annotation=BreakTypeParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateBreakTypeResponse, + construct_type( + type_=CreateBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetBreakTypeResponse]: + """ + Returns a single `BreakType` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetBreakTypeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/break-types/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBreakTypeResponse, + construct_type( + type_=GetBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, id: str, *, break_type: BreakTypeParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpdateBreakTypeResponse]: + """ + Updates an existing `BreakType`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being updated. + + break_type : BreakTypeParams + The updated `BreakType`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateBreakTypeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/break-types/{jsonable_encoder(id)}", + method="PUT", + json={ + "break_type": convert_and_respect_annotation_metadata( + object_=break_type, annotation=BreakTypeParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateBreakTypeResponse, + construct_type( + type_=UpdateBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteBreakTypeResponse]: + """ + Deletes an existing `BreakType`. + + A `BreakType` can be deleted even if it is referenced from a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteBreakTypeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/break-types/{jsonable_encoder(id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteBreakTypeResponse, + construct_type( + type_=DeleteBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawBreakTypesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + break_type: BreakTypeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateBreakTypeResponse]: + """ + Creates a new `BreakType`. + + A `BreakType` is a template for creating `Break` objects. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `break_name` + - `expected_duration` + - `is_paid` + + You can only have three `BreakType` instances per location. If you attempt to add a fourth + `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location." + is returned. + + Parameters + ---------- + break_type : BreakTypeParams + The `BreakType` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateBreakTypeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/labor/break-types", + method="POST", + json={ + "idempotency_key": idempotency_key, + "break_type": convert_and_respect_annotation_metadata( + object_=break_type, annotation=BreakTypeParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateBreakTypeResponse, + construct_type( + type_=CreateBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetBreakTypeResponse]: + """ + Returns a single `BreakType` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetBreakTypeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/break-types/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetBreakTypeResponse, + construct_type( + type_=GetBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, id: str, *, break_type: BreakTypeParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpdateBreakTypeResponse]: + """ + Updates an existing `BreakType`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being updated. + + break_type : BreakTypeParams + The updated `BreakType`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateBreakTypeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/break-types/{jsonable_encoder(id)}", + method="PUT", + json={ + "break_type": convert_and_respect_annotation_metadata( + object_=break_type, annotation=BreakTypeParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateBreakTypeResponse, + construct_type( + type_=UpdateBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteBreakTypeResponse]: + """ + Deletes an existing `BreakType`. + + A `BreakType` can be deleted even if it is referenced from a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `BreakType` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteBreakTypeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/break-types/{jsonable_encoder(id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteBreakTypeResponse, + construct_type( + type_=DeleteBreakTypeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/labor/client.py b/src/square/labor/client.py new file mode 100644 index 00000000..aa170b26 --- /dev/null +++ b/src/square/labor/client.py @@ -0,0 +1,66 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawLaborClient +from .break_types.client import BreakTypesClient +from .employee_wages.client import EmployeeWagesClient +from .shifts.client import ShiftsClient +from .team_member_wages.client import TeamMemberWagesClient +from .workweek_configs.client import WorkweekConfigsClient +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawLaborClient +from .break_types.client import AsyncBreakTypesClient +from .employee_wages.client import AsyncEmployeeWagesClient +from .shifts.client import AsyncShiftsClient +from .team_member_wages.client import AsyncTeamMemberWagesClient +from .workweek_configs.client import AsyncWorkweekConfigsClient + + +class LaborClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawLaborClient(client_wrapper=client_wrapper) + self.break_types = BreakTypesClient(client_wrapper=client_wrapper) + + self.employee_wages = EmployeeWagesClient(client_wrapper=client_wrapper) + + self.shifts = ShiftsClient(client_wrapper=client_wrapper) + + self.team_member_wages = TeamMemberWagesClient(client_wrapper=client_wrapper) + + self.workweek_configs = WorkweekConfigsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawLaborClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawLaborClient + """ + return self._raw_client + + +class AsyncLaborClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawLaborClient(client_wrapper=client_wrapper) + self.break_types = AsyncBreakTypesClient(client_wrapper=client_wrapper) + + self.employee_wages = AsyncEmployeeWagesClient(client_wrapper=client_wrapper) + + self.shifts = AsyncShiftsClient(client_wrapper=client_wrapper) + + self.team_member_wages = AsyncTeamMemberWagesClient(client_wrapper=client_wrapper) + + self.workweek_configs = AsyncWorkweekConfigsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawLaborClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawLaborClient + """ + return self._raw_client diff --git a/src/square/labor/employee_wages/__init__.py b/src/square/labor/employee_wages/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/labor/employee_wages/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/labor/employee_wages/client.py b/src/square/labor/employee_wages/client.py new file mode 100644 index 00000000..31147294 --- /dev/null +++ b/src/square/labor/employee_wages/client.py @@ -0,0 +1,284 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawEmployeeWagesClient +import typing +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.employee_wage import EmployeeWage +from ...types.list_employee_wages_response import ListEmployeeWagesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_employee_wage_response import GetEmployeeWageResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawEmployeeWagesClient +from ...core.pagination import AsyncPager + + +class EmployeeWagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawEmployeeWagesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawEmployeeWagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawEmployeeWagesClient + """ + return self._raw_client + + def list( + self, + *, + employee_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[EmployeeWage]: + """ + Returns a paginated list of `EmployeeWage` instances for a business. + + Parameters + ---------- + employee_id : typing.Optional[str] + Filter the returned wages to only those that are associated with the specified employee. + + limit : typing.Optional[int] + The maximum number of `EmployeeWage` results to return per page. The number can range between + 1 and 200. The default is 200. + + cursor : typing.Optional[str] + A pointer to the next page of `EmployeeWage` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[EmployeeWage] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.labor.employee_wages.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/employee-wages", + method="GET", + params={ + "employee_id": employee_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListEmployeeWagesResponse, + construct_type( + type_=ListEmployeeWagesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + employee_id=employee_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.employee_wages + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetEmployeeWageResponse: + """ + Returns a single `EmployeeWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `EmployeeWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetEmployeeWageResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.employee_wages.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + +class AsyncEmployeeWagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawEmployeeWagesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawEmployeeWagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawEmployeeWagesClient + """ + return self._raw_client + + async def list( + self, + *, + employee_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[EmployeeWage]: + """ + Returns a paginated list of `EmployeeWage` instances for a business. + + Parameters + ---------- + employee_id : typing.Optional[str] + Filter the returned wages to only those that are associated with the specified employee. + + limit : typing.Optional[int] + The maximum number of `EmployeeWage` results to return per page. The number can range between + 1 and 200. The default is 200. + + cursor : typing.Optional[str] + A pointer to the next page of `EmployeeWage` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[EmployeeWage] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.labor.employee_wages.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/employee-wages", + method="GET", + params={ + "employee_id": employee_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListEmployeeWagesResponse, + construct_type( + type_=ListEmployeeWagesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + employee_id=employee_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.employee_wages + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetEmployeeWageResponse: + """ + Returns a single `EmployeeWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `EmployeeWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetEmployeeWageResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.employee_wages.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data diff --git a/src/square/labor/employee_wages/raw_client.py b/src/square/labor/employee_wages/raw_client.py new file mode 100644 index 00000000..94227b7a --- /dev/null +++ b/src/square/labor/employee_wages/raw_client.py @@ -0,0 +1,101 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_employee_wage_response import GetEmployeeWageResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawEmployeeWagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetEmployeeWageResponse]: + """ + Returns a single `EmployeeWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `EmployeeWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetEmployeeWageResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/employee-wages/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetEmployeeWageResponse, + construct_type( + type_=GetEmployeeWageResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawEmployeeWagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetEmployeeWageResponse]: + """ + Returns a single `EmployeeWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `EmployeeWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetEmployeeWageResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/employee-wages/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetEmployeeWageResponse, + construct_type( + type_=GetEmployeeWageResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/labor/raw_client.py b/src/square/labor/raw_client.py new file mode 100644 index 00000000..a8d409c3 --- /dev/null +++ b/src/square/labor/raw_client.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from ..core.client_wrapper import AsyncClientWrapper + + +class RawLaborClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + +class AsyncRawLaborClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper diff --git a/src/square/labor/shifts/__init__.py b/src/square/labor/shifts/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/labor/shifts/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/labor/shifts/client.py b/src/square/labor/shifts/client.py new file mode 100644 index 00000000..23fd1d53 --- /dev/null +++ b/src/square/labor/shifts/client.py @@ -0,0 +1,648 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawShiftsClient +from ...requests.shift import ShiftParams +from ...core.request_options import RequestOptions +from ...types.create_shift_response import CreateShiftResponse +from ...requests.shift_query import ShiftQueryParams +from ...types.search_shifts_response import SearchShiftsResponse +from ...types.get_shift_response import GetShiftResponse +from ...types.update_shift_response import UpdateShiftResponse +from ...types.delete_shift_response import DeleteShiftResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawShiftsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ShiftsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawShiftsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawShiftsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawShiftsClient + """ + return self._raw_client + + def create( + self, + *, + shift: ShiftParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateShiftResponse: + """ + Creates a new `Shift`. + + A `Shift` represents a complete workday for a single team member. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `team_member_id` + - `start_at` + + An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: + - The `status` of the new `Shift` is `OPEN` and the team member has another + shift with an `OPEN` status. + - The `start_at` date is in the future. + - The `start_at` or `end_at` date overlaps another shift for the same team member. + - The `Break` instances are set in the request and a break `start_at` + is before the `Shift.start_at`, a break `end_at` is after + the `Shift.end_at`, or both. + + Parameters + ---------- + shift : ShiftParams + The `Shift` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateShiftResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.shifts.create( + idempotency_key="HIDSNG5KS478L", + shift={ + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "end_at": "2019-01-25T13:11:00-05:00", + "wage": { + "title": "Barista", + "hourly_rate": {"amount": 1100, "currency": "USD"}, + "tip_eligible": True, + }, + "breaks": [ + { + "start_at": "2019-01-25T06:11:00-05:00", + "end_at": "2019-01-25T06:16:00-05:00", + "break_type_id": "REGS1EQR1TPZ5", + "name": "Tea Break", + "expected_duration": "PT5M", + "is_paid": True, + } + ], + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, + }, + ) + """ + response = self._raw_client.create( + shift=shift, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: typing.Optional[ShiftQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchShiftsResponse: + """ + Returns a paginated list of `Shift` records for a business. + The list to be returned can be filtered by: + - Location IDs + - Team member IDs + - Shift status (`OPEN` or `CLOSED`) + - Shift start + - Shift end + - Workday details + + The list can be sorted by: + - `START_AT` + - `END_AT` + - `CREATED_AT` + - `UPDATED_AT` + + Parameters + ---------- + query : typing.Optional[ShiftQueryParams] + Query filters. + + limit : typing.Optional[int] + The number of resources in a page (200 by default). + + cursor : typing.Optional[str] + An opaque cursor for fetching the next page. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchShiftsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.shifts.search( + query={ + "filter": { + "workday": { + "date_range": { + "start_date": "2019-01-20", + "end_date": "2019-02-03", + }, + "match_shifts_by": "START_AT", + "default_timezone": "America/Los_Angeles", + } + } + }, + limit=100, + ) + """ + response = self._raw_client.search(query=query, limit=limit, cursor=cursor, request_options=request_options) + return response.data + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetShiftResponse: + """ + Returns a single `Shift` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetShiftResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.shifts.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + def update( + self, id: str, *, shift: ShiftParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateShiftResponse: + """ + Updates an existing `Shift`. + + When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have + the `end_at` property set to a valid RFC-3339 datetime string. + + When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at` + set on each `Break`. + + Parameters + ---------- + id : str + The ID of the object being updated. + + shift : ShiftParams + The updated `Shift` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateShiftResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.shifts.update( + id="id", + shift={ + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "end_at": "2019-01-25T13:11:00-05:00", + "wage": { + "title": "Bartender", + "hourly_rate": {"amount": 1500, "currency": "USD"}, + "tip_eligible": True, + }, + "breaks": [ + { + "id": "X7GAQYVVRRG6P", + "start_at": "2019-01-25T06:11:00-05:00", + "end_at": "2019-01-25T06:16:00-05:00", + "break_type_id": "REGS1EQR1TPZ5", + "name": "Tea Break", + "expected_duration": "PT5M", + "is_paid": True, + } + ], + "version": 1, + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, + }, + ) + """ + response = self._raw_client.update(id, shift=shift, request_options=request_options) + return response.data + + def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteShiftResponse: + """ + Deletes a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteShiftResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.shifts.delete( + id="id", + ) + """ + response = self._raw_client.delete(id, request_options=request_options) + return response.data + + +class AsyncShiftsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawShiftsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawShiftsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawShiftsClient + """ + return self._raw_client + + async def create( + self, + *, + shift: ShiftParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateShiftResponse: + """ + Creates a new `Shift`. + + A `Shift` represents a complete workday for a single team member. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `team_member_id` + - `start_at` + + An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: + - The `status` of the new `Shift` is `OPEN` and the team member has another + shift with an `OPEN` status. + - The `start_at` date is in the future. + - The `start_at` or `end_at` date overlaps another shift for the same team member. + - The `Break` instances are set in the request and a break `start_at` + is before the `Shift.start_at`, a break `end_at` is after + the `Shift.end_at`, or both. + + Parameters + ---------- + shift : ShiftParams + The `Shift` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateShiftResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.shifts.create( + idempotency_key="HIDSNG5KS478L", + shift={ + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "end_at": "2019-01-25T13:11:00-05:00", + "wage": { + "title": "Barista", + "hourly_rate": {"amount": 1100, "currency": "USD"}, + "tip_eligible": True, + }, + "breaks": [ + { + "start_at": "2019-01-25T06:11:00-05:00", + "end_at": "2019-01-25T06:16:00-05:00", + "break_type_id": "REGS1EQR1TPZ5", + "name": "Tea Break", + "expected_duration": "PT5M", + "is_paid": True, + } + ], + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + shift=shift, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: typing.Optional[ShiftQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchShiftsResponse: + """ + Returns a paginated list of `Shift` records for a business. + The list to be returned can be filtered by: + - Location IDs + - Team member IDs + - Shift status (`OPEN` or `CLOSED`) + - Shift start + - Shift end + - Workday details + + The list can be sorted by: + - `START_AT` + - `END_AT` + - `CREATED_AT` + - `UPDATED_AT` + + Parameters + ---------- + query : typing.Optional[ShiftQueryParams] + Query filters. + + limit : typing.Optional[int] + The number of resources in a page (200 by default). + + cursor : typing.Optional[str] + An opaque cursor for fetching the next page. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchShiftsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.shifts.search( + query={ + "filter": { + "workday": { + "date_range": { + "start_date": "2019-01-20", + "end_date": "2019-02-03", + }, + "match_shifts_by": "START_AT", + "default_timezone": "America/Los_Angeles", + } + } + }, + limit=100, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data + + async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetShiftResponse: + """ + Returns a single `Shift` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetShiftResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.shifts.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data + + async def update( + self, id: str, *, shift: ShiftParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateShiftResponse: + """ + Updates an existing `Shift`. + + When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have + the `end_at` property set to a valid RFC-3339 datetime string. + + When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at` + set on each `Break`. + + Parameters + ---------- + id : str + The ID of the object being updated. + + shift : ShiftParams + The updated `Shift` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateShiftResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.shifts.update( + id="id", + shift={ + "location_id": "PAA1RJZZKXBFG", + "start_at": "2019-01-25T03:11:00-05:00", + "end_at": "2019-01-25T13:11:00-05:00", + "wage": { + "title": "Bartender", + "hourly_rate": {"amount": 1500, "currency": "USD"}, + "tip_eligible": True, + }, + "breaks": [ + { + "id": "X7GAQYVVRRG6P", + "start_at": "2019-01-25T06:11:00-05:00", + "end_at": "2019-01-25T06:16:00-05:00", + "break_type_id": "REGS1EQR1TPZ5", + "name": "Tea Break", + "expected_duration": "PT5M", + "is_paid": True, + } + ], + "version": 1, + "team_member_id": "ormj0jJJZ5OZIzxrZYJI", + "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update(id, shift=shift, request_options=request_options) + return response.data + + async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteShiftResponse: + """ + Deletes a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteShiftResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.shifts.delete( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(id, request_options=request_options) + return response.data diff --git a/src/square/labor/shifts/raw_client.py b/src/square/labor/shifts/raw_client.py new file mode 100644 index 00000000..fff56967 --- /dev/null +++ b/src/square/labor/shifts/raw_client.py @@ -0,0 +1,597 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.shift import ShiftParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_shift_response import CreateShiftResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.shift_query import ShiftQueryParams +from ...types.search_shifts_response import SearchShiftsResponse +from ...types.get_shift_response import GetShiftResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_shift_response import UpdateShiftResponse +from ...types.delete_shift_response import DeleteShiftResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawShiftsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + shift: ShiftParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateShiftResponse]: + """ + Creates a new `Shift`. + + A `Shift` represents a complete workday for a single team member. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `team_member_id` + - `start_at` + + An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: + - The `status` of the new `Shift` is `OPEN` and the team member has another + shift with an `OPEN` status. + - The `start_at` date is in the future. + - The `start_at` or `end_at` date overlaps another shift for the same team member. + - The `Break` instances are set in the request and a break `start_at` + is before the `Shift.start_at`, a break `end_at` is after + the `Shift.end_at`, or both. + + Parameters + ---------- + shift : ShiftParams + The `Shift` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateShiftResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/labor/shifts", + method="POST", + json={ + "idempotency_key": idempotency_key, + "shift": convert_and_respect_annotation_metadata( + object_=shift, annotation=ShiftParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateShiftResponse, + construct_type( + type_=CreateShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[ShiftQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchShiftsResponse]: + """ + Returns a paginated list of `Shift` records for a business. + The list to be returned can be filtered by: + - Location IDs + - Team member IDs + - Shift status (`OPEN` or `CLOSED`) + - Shift start + - Shift end + - Workday details + + The list can be sorted by: + - `START_AT` + - `END_AT` + - `CREATED_AT` + - `UPDATED_AT` + + Parameters + ---------- + query : typing.Optional[ShiftQueryParams] + Query filters. + + limit : typing.Optional[int] + The number of resources in a page (200 by default). + + cursor : typing.Optional[str] + An opaque cursor for fetching the next page. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchShiftsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/labor/shifts/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=ShiftQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchShiftsResponse, + construct_type( + type_=SearchShiftsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetShiftResponse]: + """ + Returns a single `Shift` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetShiftResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/shifts/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetShiftResponse, + construct_type( + type_=GetShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, id: str, *, shift: ShiftParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpdateShiftResponse]: + """ + Updates an existing `Shift`. + + When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have + the `end_at` property set to a valid RFC-3339 datetime string. + + When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at` + set on each `Break`. + + Parameters + ---------- + id : str + The ID of the object being updated. + + shift : ShiftParams + The updated `Shift` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateShiftResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/shifts/{jsonable_encoder(id)}", + method="PUT", + json={ + "shift": convert_and_respect_annotation_metadata( + object_=shift, annotation=ShiftParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateShiftResponse, + construct_type( + type_=UpdateShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteShiftResponse]: + """ + Deletes a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteShiftResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/shifts/{jsonable_encoder(id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteShiftResponse, + construct_type( + type_=DeleteShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawShiftsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + shift: ShiftParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateShiftResponse]: + """ + Creates a new `Shift`. + + A `Shift` represents a complete workday for a single team member. + You must provide the following values in your request to this + endpoint: + + - `location_id` + - `team_member_id` + - `start_at` + + An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: + - The `status` of the new `Shift` is `OPEN` and the team member has another + shift with an `OPEN` status. + - The `start_at` date is in the future. + - The `start_at` or `end_at` date overlaps another shift for the same team member. + - The `Break` instances are set in the request and a break `start_at` + is before the `Shift.start_at`, a break `end_at` is after + the `Shift.end_at`, or both. + + Parameters + ---------- + shift : ShiftParams + The `Shift` to be created. + + idempotency_key : typing.Optional[str] + A unique string value to ensure the idempotency of the operation. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateShiftResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/labor/shifts", + method="POST", + json={ + "idempotency_key": idempotency_key, + "shift": convert_and_respect_annotation_metadata( + object_=shift, annotation=ShiftParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateShiftResponse, + construct_type( + type_=CreateShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[ShiftQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchShiftsResponse]: + """ + Returns a paginated list of `Shift` records for a business. + The list to be returned can be filtered by: + - Location IDs + - Team member IDs + - Shift status (`OPEN` or `CLOSED`) + - Shift start + - Shift end + - Workday details + + The list can be sorted by: + - `START_AT` + - `END_AT` + - `CREATED_AT` + - `UPDATED_AT` + + Parameters + ---------- + query : typing.Optional[ShiftQueryParams] + Query filters. + + limit : typing.Optional[int] + The number of resources in a page (200 by default). + + cursor : typing.Optional[str] + An opaque cursor for fetching the next page. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchShiftsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/labor/shifts/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=ShiftQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchShiftsResponse, + construct_type( + type_=SearchShiftsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetShiftResponse]: + """ + Returns a single `Shift` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetShiftResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/shifts/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetShiftResponse, + construct_type( + type_=GetShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, id: str, *, shift: ShiftParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpdateShiftResponse]: + """ + Updates an existing `Shift`. + + When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have + the `end_at` property set to a valid RFC-3339 datetime string. + + When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at` + set on each `Break`. + + Parameters + ---------- + id : str + The ID of the object being updated. + + shift : ShiftParams + The updated `Shift` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateShiftResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/shifts/{jsonable_encoder(id)}", + method="PUT", + json={ + "shift": convert_and_respect_annotation_metadata( + object_=shift, annotation=ShiftParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateShiftResponse, + construct_type( + type_=UpdateShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteShiftResponse]: + """ + Deletes a `Shift`. + + Parameters + ---------- + id : str + The UUID for the `Shift` being deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteShiftResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/shifts/{jsonable_encoder(id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteShiftResponse, + construct_type( + type_=DeleteShiftResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/labor/team_member_wages/__init__.py b/src/square/labor/team_member_wages/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/labor/team_member_wages/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/labor/team_member_wages/client.py b/src/square/labor/team_member_wages/client.py new file mode 100644 index 00000000..ac8334fc --- /dev/null +++ b/src/square/labor/team_member_wages/client.py @@ -0,0 +1,288 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawTeamMemberWagesClient +import typing +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.team_member_wage import TeamMemberWage +from ...types.list_team_member_wages_response import ListTeamMemberWagesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_team_member_wage_response import GetTeamMemberWageResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawTeamMemberWagesClient +from ...core.pagination import AsyncPager + + +class TeamMemberWagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTeamMemberWagesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTeamMemberWagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTeamMemberWagesClient + """ + return self._raw_client + + def list( + self, + *, + team_member_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[TeamMemberWage]: + """ + Returns a paginated list of `TeamMemberWage` instances for a business. + + Parameters + ---------- + team_member_id : typing.Optional[str] + Filter the returned wages to only those that are associated with the + specified team member. + + limit : typing.Optional[int] + The maximum number of `TeamMemberWage` results to return per page. The number can range between + 1 and 200. The default is 200. + + cursor : typing.Optional[str] + A pointer to the next page of `EmployeeWage` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[TeamMemberWage] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.labor.team_member_wages.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/team-member-wages", + method="GET", + params={ + "team_member_id": team_member_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListTeamMemberWagesResponse, + construct_type( + type_=ListTeamMemberWagesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + team_member_id=team_member_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.team_member_wages + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetTeamMemberWageResponse: + """ + Returns a single `TeamMemberWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `TeamMemberWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTeamMemberWageResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.team_member_wages.get( + id="id", + ) + """ + response = self._raw_client.get(id, request_options=request_options) + return response.data + + +class AsyncTeamMemberWagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTeamMemberWagesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTeamMemberWagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTeamMemberWagesClient + """ + return self._raw_client + + async def list( + self, + *, + team_member_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[TeamMemberWage]: + """ + Returns a paginated list of `TeamMemberWage` instances for a business. + + Parameters + ---------- + team_member_id : typing.Optional[str] + Filter the returned wages to only those that are associated with the + specified team member. + + limit : typing.Optional[int] + The maximum number of `TeamMemberWage` results to return per page. The number can range between + 1 and 200. The default is 200. + + cursor : typing.Optional[str] + A pointer to the next page of `EmployeeWage` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[TeamMemberWage] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.labor.team_member_wages.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/team-member-wages", + method="GET", + params={ + "team_member_id": team_member_id, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListTeamMemberWagesResponse, + construct_type( + type_=ListTeamMemberWagesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + team_member_id=team_member_id, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.team_member_wages + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTeamMemberWageResponse: + """ + Returns a single `TeamMemberWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `TeamMemberWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTeamMemberWageResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.team_member_wages.get( + id="id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, request_options=request_options) + return response.data diff --git a/src/square/labor/team_member_wages/raw_client.py b/src/square/labor/team_member_wages/raw_client.py new file mode 100644 index 00000000..87400051 --- /dev/null +++ b/src/square/labor/team_member_wages/raw_client.py @@ -0,0 +1,101 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_team_member_wage_response import GetTeamMemberWageResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawTeamMemberWagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTeamMemberWageResponse]: + """ + Returns a single `TeamMemberWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `TeamMemberWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTeamMemberWageResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/team-member-wages/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTeamMemberWageResponse, + construct_type( + type_=GetTeamMemberWageResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawTeamMemberWagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTeamMemberWageResponse]: + """ + Returns a single `TeamMemberWage` specified by `id`. + + Parameters + ---------- + id : str + The UUID for the `TeamMemberWage` being retrieved. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTeamMemberWageResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/team-member-wages/{jsonable_encoder(id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTeamMemberWageResponse, + construct_type( + type_=GetTeamMemberWageResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/labor/workweek_configs/__init__.py b/src/square/labor/workweek_configs/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/labor/workweek_configs/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/labor/workweek_configs/client.py b/src/square/labor/workweek_configs/client.py new file mode 100644 index 00000000..31f50647 --- /dev/null +++ b/src/square/labor/workweek_configs/client.py @@ -0,0 +1,294 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawWorkweekConfigsClient +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.workweek_config import WorkweekConfig +from ...types.list_workweek_configs_response import ListWorkweekConfigsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.workweek_config import WorkweekConfigParams +from ...types.update_workweek_config_response import UpdateWorkweekConfigResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawWorkweekConfigsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class WorkweekConfigsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawWorkweekConfigsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawWorkweekConfigsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawWorkweekConfigsClient + """ + return self._raw_client + + def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[WorkweekConfig]: + """ + Returns a list of `WorkweekConfig` instances for a business. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of `WorkweekConfigs` results to return per page. + + cursor : typing.Optional[str] + A pointer to the next page of `WorkweekConfig` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[WorkweekConfig] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.labor.workweek_configs.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/workweek-configs", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListWorkweekConfigsResponse, + construct_type( + type_=ListWorkweekConfigsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.workweek_configs + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, id: str, *, workweek_config: WorkweekConfigParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateWorkweekConfigResponse: + """ + Updates a `WorkweekConfig`. + + Parameters + ---------- + id : str + The UUID for the `WorkweekConfig` object being updated. + + workweek_config : WorkweekConfigParams + The updated `WorkweekConfig` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWorkweekConfigResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.labor.workweek_configs.get( + id="id", + workweek_config={ + "start_of_week": "MON", + "start_of_day_local_time": "10:00", + "version": 10, + }, + ) + """ + response = self._raw_client.get(id, workweek_config=workweek_config, request_options=request_options) + return response.data + + +class AsyncWorkweekConfigsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawWorkweekConfigsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawWorkweekConfigsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawWorkweekConfigsClient + """ + return self._raw_client + + async def list( + self, + *, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[WorkweekConfig]: + """ + Returns a list of `WorkweekConfig` instances for a business. + + Parameters + ---------- + limit : typing.Optional[int] + The maximum number of `WorkweekConfigs` results to return per page. + + cursor : typing.Optional[str] + A pointer to the next page of `WorkweekConfig` results to fetch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[WorkweekConfig] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.labor.workweek_configs.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/labor/workweek-configs", + method="GET", + params={ + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListWorkweekConfigsResponse, + construct_type( + type_=ListWorkweekConfigsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.workweek_configs + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, id: str, *, workweek_config: WorkweekConfigParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateWorkweekConfigResponse: + """ + Updates a `WorkweekConfig`. + + Parameters + ---------- + id : str + The UUID for the `WorkweekConfig` object being updated. + + workweek_config : WorkweekConfigParams + The updated `WorkweekConfig` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWorkweekConfigResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.labor.workweek_configs.get( + id="id", + workweek_config={ + "start_of_week": "MON", + "start_of_day_local_time": "10:00", + "version": 10, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(id, workweek_config=workweek_config, request_options=request_options) + return response.data diff --git a/src/square/labor/workweek_configs/raw_client.py b/src/square/labor/workweek_configs/raw_client.py new file mode 100644 index 00000000..2930b711 --- /dev/null +++ b/src/square/labor/workweek_configs/raw_client.py @@ -0,0 +1,130 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.workweek_config import WorkweekConfigParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.update_workweek_config_response import UpdateWorkweekConfigResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawWorkweekConfigsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, id: str, *, workweek_config: WorkweekConfigParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpdateWorkweekConfigResponse]: + """ + Updates a `WorkweekConfig`. + + Parameters + ---------- + id : str + The UUID for the `WorkweekConfig` object being updated. + + workweek_config : WorkweekConfigParams + The updated `WorkweekConfig` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateWorkweekConfigResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/labor/workweek-configs/{jsonable_encoder(id)}", + method="PUT", + json={ + "workweek_config": convert_and_respect_annotation_metadata( + object_=workweek_config, annotation=WorkweekConfigParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWorkweekConfigResponse, + construct_type( + type_=UpdateWorkweekConfigResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawWorkweekConfigsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, id: str, *, workweek_config: WorkweekConfigParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpdateWorkweekConfigResponse]: + """ + Updates a `WorkweekConfig`. + + Parameters + ---------- + id : str + The UUID for the `WorkweekConfig` object being updated. + + workweek_config : WorkweekConfigParams + The updated `WorkweekConfig` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateWorkweekConfigResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/labor/workweek-configs/{jsonable_encoder(id)}", + method="PUT", + json={ + "workweek_config": convert_and_respect_annotation_metadata( + object_=workweek_config, annotation=WorkweekConfigParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWorkweekConfigResponse, + construct_type( + type_=UpdateWorkweekConfigResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/locations/__init__.py b/src/square/locations/__init__.py new file mode 100644 index 00000000..d38cb42e --- /dev/null +++ b/src/square/locations/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import custom_attribute_definitions, custom_attributes, transactions + +__all__ = ["custom_attribute_definitions", "custom_attributes", "transactions"] diff --git a/src/square/locations/client.py b/src/square/locations/client.py new file mode 100644 index 00000000..ad76a36b --- /dev/null +++ b/src/square/locations/client.py @@ -0,0 +1,876 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawLocationsClient +from .custom_attribute_definitions.client import CustomAttributeDefinitionsClient +from .custom_attributes.client import CustomAttributesClient +from .transactions.client import TransactionsClient +from ..core.request_options import RequestOptions +from ..types.list_locations_response import ListLocationsResponse +from ..requests.location import LocationParams +from ..types.create_location_response import CreateLocationResponse +from ..types.get_location_response import GetLocationResponse +from ..types.update_location_response import UpdateLocationResponse +from ..requests.create_order_request import CreateOrderRequestParams +from ..requests.address import AddressParams +from ..requests.charge_request_additional_recipient import ChargeRequestAdditionalRecipientParams +from ..types.create_checkout_response import CreateCheckoutResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawLocationsClient +from .custom_attribute_definitions.client import AsyncCustomAttributeDefinitionsClient +from .custom_attributes.client import AsyncCustomAttributesClient +from .transactions.client import AsyncTransactionsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class LocationsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawLocationsClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = CustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = CustomAttributesClient(client_wrapper=client_wrapper) + + self.transactions = TransactionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawLocationsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawLocationsClient + """ + return self._raw_client + + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListLocationsResponse: + """ + Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), + including those with an inactive status. Locations are listed alphabetically by `name`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListLocationsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.list() + """ + response = self._raw_client.list(request_options=request_options) + return response.data + + def create( + self, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLocationResponse: + """ + Creates a [location](https://developer.squareup.com/docs/locations-api). + Creating new locations allows for separate configuration of receipt layouts, item prices, + and sales reports. Developers can use locations to separate sales activity through applications + that integrate with Square from sales activity elsewhere in a seller's account. + Locations created programmatically with the Locations API last forever and + are visible to the seller for their own management. Therefore, ensure that + each location has a sensible and unique name. + + Parameters + ---------- + location : typing.Optional[LocationParams] + The initial values of the location being created. The `name` field is required and must be unique within a seller account. + All other fields are optional, but any information you care about for the location should be included. + The remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLocationResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.create( + location={ + "name": "Midtown", + "address": { + "address_line1": "1234 Peachtree St. NE", + "locality": "Atlanta", + "administrative_district_level1": "GA", + "postal_code": "30309", + }, + "description": "Midtown Atlanta store", + }, + ) + """ + response = self._raw_client.create(location=location, request_options=request_options) + return response.data + + def get(self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetLocationResponse: + """ + Retrieves details of a single location. Specify "main" + as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + Parameters + ---------- + location_id : str + The ID of the location to retrieve. Specify the string + "main" to return the main location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLocationResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.get( + location_id="location_id", + ) + """ + response = self._raw_client.get(location_id, request_options=request_options) + return response.data + + def update( + self, + location_id: str, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateLocationResponse: + """ + Updates a [location](https://developer.squareup.com/docs/locations-api). + + Parameters + ---------- + location_id : str + The ID of the location to update. + + location : typing.Optional[LocationParams] + The `Location` object with only the fields to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateLocationResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.update( + location_id="location_id", + location={ + "business_hours": { + "periods": [ + { + "day_of_week": "FRI", + "start_local_time": "07:00", + "end_local_time": "18:00", + }, + { + "day_of_week": "SAT", + "start_local_time": "07:00", + "end_local_time": "18:00", + }, + { + "day_of_week": "SUN", + "start_local_time": "09:00", + "end_local_time": "15:00", + }, + ] + }, + "description": "Midtown Atlanta store - Open weekends", + }, + ) + """ + response = self._raw_client.update(location_id, location=location, request_options=request_options) + return response.data + + def checkouts( + self, + location_id: str, + *, + idempotency_key: str, + order: CreateOrderRequestParams, + ask_for_shipping_address: typing.Optional[bool] = OMIT, + merchant_support_email: typing.Optional[str] = OMIT, + pre_populate_buyer_email: typing.Optional[str] = OMIT, + pre_populate_shipping_address: typing.Optional[AddressParams] = OMIT, + redirect_url: typing.Optional[str] = OMIT, + additional_recipients: typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] = OMIT, + note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCheckoutResponse: + """ + Links a `checkoutId` to a `checkout_page_url` that customers are + directed to in order to provide their payment information using a + payment processing workflow hosted on connect.squareup.com. + + + NOTE: The Checkout API has been updated with new features. + For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). + + Parameters + ---------- + location_id : str + The ID of the business location to associate the checkout with. + + idempotency_key : str + A unique string that identifies this checkout among others you have created. It can be + any valid string but must be unique for every order sent to Square Checkout for a given location ID. + + The idempotency key is used to avoid processing the same order more than once. If you are + unsure whether a particular checkout was created successfully, you can attempt it again with + the same idempotency key and all the same other parameters without worrying about creating duplicates. + + You should use a random number/string generator native to the language + you are working in to generate strings for your idempotency keys. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order : CreateOrderRequestParams + The order including line items to be checked out. + + ask_for_shipping_address : typing.Optional[bool] + If `true`, Square Checkout collects shipping information on your behalf and stores + that information with the transaction information in the Square Seller Dashboard. + + Default: `false`. + + merchant_support_email : typing.Optional[str] + The email address to display on the Square Checkout confirmation page + and confirmation email that the buyer can use to contact the seller. + + If this value is not set, the confirmation page and email display the + primary email address associated with the seller's Square account. + + Default: none; only exists if explicitly set. + + pre_populate_buyer_email : typing.Optional[str] + If provided, the buyer's email is prepopulated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + + pre_populate_shipping_address : typing.Optional[AddressParams] + If provided, the buyer's shipping information is prepopulated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + + redirect_url : typing.Optional[str] + The URL to redirect to after the checkout is completed with `checkoutId`, + `transactionId`, and `referenceId` appended as URL parameters. For example, + if the provided redirect URL is `http://www.example.com/order-complete`, a + successful transaction redirects the customer to: + + `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` + + If you do not provide a redirect URL, Square Checkout displays an order + confirmation page on your behalf; however, it is strongly recommended that + you provide a redirect URL so you can verify the transaction results and + finalize the order through your existing/normal confirmation workflow. + + Default: none; only exists if explicitly set. + + additional_recipients : typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] + The basic primitive of a multi-party transaction. The value is optional. + The transaction facilitated by you can be split from here. + + If you provide this value, the `amount_money` value in your `additional_recipients` field + cannot be more than 90% of the `total_money` calculated by Square for your order. + The `location_id` must be a valid seller location where the checkout is occurring. + + This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. + + This field is currently not supported in the Square Sandbox. + + note : typing.Optional[str] + An optional note to associate with the `checkout` object. + + This value cannot exceed 60 characters. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCheckoutResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.checkouts( + location_id="location_id", + idempotency_key="86ae1696-b1e3-4328-af6d-f1e04d947ad6", + order={ + "order": { + "location_id": "location_id", + "reference_id": "reference_id", + "customer_id": "customer_id", + "line_items": [ + { + "name": "Printed T Shirt", + "quantity": "2", + "applied_taxes": [ + {"tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"} + ], + "applied_discounts": [ + {"discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4"} + ], + "base_price_money": {"amount": 1500, "currency": "USD"}, + }, + { + "name": "Slim Jeans", + "quantity": "1", + "base_price_money": {"amount": 2500, "currency": "USD"}, + }, + { + "name": "Woven Sweater", + "quantity": "3", + "base_price_money": {"amount": 3500, "currency": "USD"}, + }, + ], + "taxes": [ + { + "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3", + "type": "INCLUSIVE", + "percentage": "7.75", + "scope": "LINE_ITEM", + } + ], + "discounts": [ + { + "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4", + "type": "FIXED_AMOUNT", + "amount_money": {"amount": 100, "currency": "USD"}, + "scope": "LINE_ITEM", + } + ], + }, + "idempotency_key": "12ae1696-z1e3-4328-af6d-f1e04d947gd4", + }, + ask_for_shipping_address=True, + merchant_support_email="merchant+support@website.com", + pre_populate_buyer_email="example@email.com", + pre_populate_shipping_address={ + "address_line1": "1455 Market St.", + "address_line2": "Suite 600", + "locality": "San Francisco", + "administrative_district_level1": "CA", + "postal_code": "94103", + "country": "US", + "first_name": "Jane", + "last_name": "Doe", + }, + redirect_url="https://merchant.website.com/order-confirm", + additional_recipients=[ + { + "location_id": "057P5VYJ4A5X1", + "description": "Application fees", + "amount_money": {"amount": 60, "currency": "USD"}, + } + ], + ) + """ + response = self._raw_client.checkouts( + location_id, + idempotency_key=idempotency_key, + order=order, + ask_for_shipping_address=ask_for_shipping_address, + merchant_support_email=merchant_support_email, + pre_populate_buyer_email=pre_populate_buyer_email, + pre_populate_shipping_address=pre_populate_shipping_address, + redirect_url=redirect_url, + additional_recipients=additional_recipients, + note=note, + request_options=request_options, + ) + return response.data + + +class AsyncLocationsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawLocationsClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = AsyncCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = AsyncCustomAttributesClient(client_wrapper=client_wrapper) + + self.transactions = AsyncTransactionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawLocationsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawLocationsClient + """ + return self._raw_client + + async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListLocationsResponse: + """ + Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), + including those with an inactive status. Locations are listed alphabetically by `name`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListLocationsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.list() + + + asyncio.run(main()) + """ + response = await self._raw_client.list(request_options=request_options) + return response.data + + async def create( + self, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLocationResponse: + """ + Creates a [location](https://developer.squareup.com/docs/locations-api). + Creating new locations allows for separate configuration of receipt layouts, item prices, + and sales reports. Developers can use locations to separate sales activity through applications + that integrate with Square from sales activity elsewhere in a seller's account. + Locations created programmatically with the Locations API last forever and + are visible to the seller for their own management. Therefore, ensure that + each location has a sensible and unique name. + + Parameters + ---------- + location : typing.Optional[LocationParams] + The initial values of the location being created. The `name` field is required and must be unique within a seller account. + All other fields are optional, but any information you care about for the location should be included. + The remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLocationResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.create( + location={ + "name": "Midtown", + "address": { + "address_line1": "1234 Peachtree St. NE", + "locality": "Atlanta", + "administrative_district_level1": "GA", + "postal_code": "30309", + }, + "description": "Midtown Atlanta store", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create(location=location, request_options=request_options) + return response.data + + async def get( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLocationResponse: + """ + Retrieves details of a single location. Specify "main" + as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + Parameters + ---------- + location_id : str + The ID of the location to retrieve. Specify the string + "main" to return the main location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLocationResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.get( + location_id="location_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(location_id, request_options=request_options) + return response.data + + async def update( + self, + location_id: str, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateLocationResponse: + """ + Updates a [location](https://developer.squareup.com/docs/locations-api). + + Parameters + ---------- + location_id : str + The ID of the location to update. + + location : typing.Optional[LocationParams] + The `Location` object with only the fields to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateLocationResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.update( + location_id="location_id", + location={ + "business_hours": { + "periods": [ + { + "day_of_week": "FRI", + "start_local_time": "07:00", + "end_local_time": "18:00", + }, + { + "day_of_week": "SAT", + "start_local_time": "07:00", + "end_local_time": "18:00", + }, + { + "day_of_week": "SUN", + "start_local_time": "09:00", + "end_local_time": "15:00", + }, + ] + }, + "description": "Midtown Atlanta store - Open weekends", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update(location_id, location=location, request_options=request_options) + return response.data + + async def checkouts( + self, + location_id: str, + *, + idempotency_key: str, + order: CreateOrderRequestParams, + ask_for_shipping_address: typing.Optional[bool] = OMIT, + merchant_support_email: typing.Optional[str] = OMIT, + pre_populate_buyer_email: typing.Optional[str] = OMIT, + pre_populate_shipping_address: typing.Optional[AddressParams] = OMIT, + redirect_url: typing.Optional[str] = OMIT, + additional_recipients: typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] = OMIT, + note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateCheckoutResponse: + """ + Links a `checkoutId` to a `checkout_page_url` that customers are + directed to in order to provide their payment information using a + payment processing workflow hosted on connect.squareup.com. + + + NOTE: The Checkout API has been updated with new features. + For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). + + Parameters + ---------- + location_id : str + The ID of the business location to associate the checkout with. + + idempotency_key : str + A unique string that identifies this checkout among others you have created. It can be + any valid string but must be unique for every order sent to Square Checkout for a given location ID. + + The idempotency key is used to avoid processing the same order more than once. If you are + unsure whether a particular checkout was created successfully, you can attempt it again with + the same idempotency key and all the same other parameters without worrying about creating duplicates. + + You should use a random number/string generator native to the language + you are working in to generate strings for your idempotency keys. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order : CreateOrderRequestParams + The order including line items to be checked out. + + ask_for_shipping_address : typing.Optional[bool] + If `true`, Square Checkout collects shipping information on your behalf and stores + that information with the transaction information in the Square Seller Dashboard. + + Default: `false`. + + merchant_support_email : typing.Optional[str] + The email address to display on the Square Checkout confirmation page + and confirmation email that the buyer can use to contact the seller. + + If this value is not set, the confirmation page and email display the + primary email address associated with the seller's Square account. + + Default: none; only exists if explicitly set. + + pre_populate_buyer_email : typing.Optional[str] + If provided, the buyer's email is prepopulated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + + pre_populate_shipping_address : typing.Optional[AddressParams] + If provided, the buyer's shipping information is prepopulated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + + redirect_url : typing.Optional[str] + The URL to redirect to after the checkout is completed with `checkoutId`, + `transactionId`, and `referenceId` appended as URL parameters. For example, + if the provided redirect URL is `http://www.example.com/order-complete`, a + successful transaction redirects the customer to: + + `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` + + If you do not provide a redirect URL, Square Checkout displays an order + confirmation page on your behalf; however, it is strongly recommended that + you provide a redirect URL so you can verify the transaction results and + finalize the order through your existing/normal confirmation workflow. + + Default: none; only exists if explicitly set. + + additional_recipients : typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] + The basic primitive of a multi-party transaction. The value is optional. + The transaction facilitated by you can be split from here. + + If you provide this value, the `amount_money` value in your `additional_recipients` field + cannot be more than 90% of the `total_money` calculated by Square for your order. + The `location_id` must be a valid seller location where the checkout is occurring. + + This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. + + This field is currently not supported in the Square Sandbox. + + note : typing.Optional[str] + An optional note to associate with the `checkout` object. + + This value cannot exceed 60 characters. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateCheckoutResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.checkouts( + location_id="location_id", + idempotency_key="86ae1696-b1e3-4328-af6d-f1e04d947ad6", + order={ + "order": { + "location_id": "location_id", + "reference_id": "reference_id", + "customer_id": "customer_id", + "line_items": [ + { + "name": "Printed T Shirt", + "quantity": "2", + "applied_taxes": [ + {"tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"} + ], + "applied_discounts": [ + { + "discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4" + } + ], + "base_price_money": {"amount": 1500, "currency": "USD"}, + }, + { + "name": "Slim Jeans", + "quantity": "1", + "base_price_money": {"amount": 2500, "currency": "USD"}, + }, + { + "name": "Woven Sweater", + "quantity": "3", + "base_price_money": {"amount": 3500, "currency": "USD"}, + }, + ], + "taxes": [ + { + "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3", + "type": "INCLUSIVE", + "percentage": "7.75", + "scope": "LINE_ITEM", + } + ], + "discounts": [ + { + "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4", + "type": "FIXED_AMOUNT", + "amount_money": {"amount": 100, "currency": "USD"}, + "scope": "LINE_ITEM", + } + ], + }, + "idempotency_key": "12ae1696-z1e3-4328-af6d-f1e04d947gd4", + }, + ask_for_shipping_address=True, + merchant_support_email="merchant+support@website.com", + pre_populate_buyer_email="example@email.com", + pre_populate_shipping_address={ + "address_line1": "1455 Market St.", + "address_line2": "Suite 600", + "locality": "San Francisco", + "administrative_district_level1": "CA", + "postal_code": "94103", + "country": "US", + "first_name": "Jane", + "last_name": "Doe", + }, + redirect_url="https://merchant.website.com/order-confirm", + additional_recipients=[ + { + "location_id": "057P5VYJ4A5X1", + "description": "Application fees", + "amount_money": {"amount": 60, "currency": "USD"}, + } + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.checkouts( + location_id, + idempotency_key=idempotency_key, + order=order, + ask_for_shipping_address=ask_for_shipping_address, + merchant_support_email=merchant_support_email, + pre_populate_buyer_email=pre_populate_buyer_email, + pre_populate_shipping_address=pre_populate_shipping_address, + redirect_url=redirect_url, + additional_recipients=additional_recipients, + note=note, + request_options=request_options, + ) + return response.data diff --git a/src/square/locations/custom_attribute_definitions/__init__.py b/src/square/locations/custom_attribute_definitions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/locations/custom_attribute_definitions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/locations/custom_attribute_definitions/client.py b/src/square/locations/custom_attribute_definitions/client.py new file mode 100644 index 00000000..cba80946 --- /dev/null +++ b/src/square/locations/custom_attribute_definitions/client.py @@ -0,0 +1,696 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributeDefinitionsClient +from ...types.visibility_filter import VisibilityFilter +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.custom_attribute_definition import CustomAttributeDefinition +from ...types.list_location_custom_attribute_definitions_response import ListLocationCustomAttributeDefinitionsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...types.create_location_custom_attribute_definition_response import ( + CreateLocationCustomAttributeDefinitionResponse, +) +from ...types.retrieve_location_custom_attribute_definition_response import ( + RetrieveLocationCustomAttributeDefinitionResponse, +) +from ...types.update_location_custom_attribute_definition_response import ( + UpdateLocationCustomAttributeDefinitionResponse, +) +from ...types.delete_location_custom_attribute_definition_response import ( + DeleteLocationCustomAttributeDefinitionResponse, +) +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributeDefinitionsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributeDefinitionsClient + """ + return self._raw_client + + def list( + self, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttributeDefinition]: + """ + Lists the location-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.locations.custom_attribute_definitions.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/locations/custom-attribute-definitions", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLocationCustomAttributeDefinitionsResponse, + construct_type( + type_=ListLocationCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLocationCustomAttributeDefinitionResponse: + """ + Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with locations. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + to set the custom attribute for locations. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "bestseller", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Bestseller", + "description": "Bestselling item at location", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + }, + ) + """ + response = self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveLocationCustomAttributeDefinitionResponse: + """ + Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attribute_definitions.get( + key="key", + ) + """ + response = self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateLocationCustomAttributeDefinitionResponse: + """ + Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Update a location custom attribute definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, specify the current version of the custom attribute definition. + If this is not important for your application, `version` can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + """ + response = self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteLocationCustomAttributeDefinitionResponse: + """ + Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all locations. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attribute_definitions.delete( + key="key", + ) + """ + response = self._raw_client.delete(key, request_options=request_options) + return response.data + + +class AsyncCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributeDefinitionsClient + """ + return self._raw_client + + async def list( + self, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttributeDefinition]: + """ + Lists the location-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.locations.custom_attribute_definitions.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/locations/custom-attribute-definitions", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLocationCustomAttributeDefinitionsResponse, + construct_type( + type_=ListLocationCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLocationCustomAttributeDefinitionResponse: + """ + Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with locations. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + to set the custom attribute for locations. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "bestseller", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Bestseller", + "description": "Bestselling item at location", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveLocationCustomAttributeDefinitionResponse: + """ + Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attribute_definitions.get( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateLocationCustomAttributeDefinitionResponse: + """ + Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Update a location custom attribute definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, specify the current version of the custom attribute definition. + If this is not important for your application, `version` can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteLocationCustomAttributeDefinitionResponse: + """ + Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all locations. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteLocationCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attribute_definitions.delete( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(key, request_options=request_options) + return response.data diff --git a/src/square/locations/custom_attribute_definitions/raw_client.py b/src/square/locations/custom_attribute_definitions/raw_client.py new file mode 100644 index 00000000..82590275 --- /dev/null +++ b/src/square/locations/custom_attribute_definitions/raw_client.py @@ -0,0 +1,513 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_location_custom_attribute_definition_response import ( + CreateLocationCustomAttributeDefinitionResponse, +) +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_location_custom_attribute_definition_response import ( + RetrieveLocationCustomAttributeDefinitionResponse, +) +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_location_custom_attribute_definition_response import ( + UpdateLocationCustomAttributeDefinitionResponse, +) +from ...types.delete_location_custom_attribute_definition_response import ( + DeleteLocationCustomAttributeDefinitionResponse, +) +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateLocationCustomAttributeDefinitionResponse]: + """ + Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with locations. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + to set the custom attribute for locations. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateLocationCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/locations/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLocationCustomAttributeDefinitionResponse, + construct_type( + type_=CreateLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveLocationCustomAttributeDefinitionResponse]: + """ + Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveLocationCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateLocationCustomAttributeDefinitionResponse]: + """ + Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Update a location custom attribute definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, specify the current version of the custom attribute definition. + If this is not important for your application, `version` can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateLocationCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateLocationCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteLocationCustomAttributeDefinitionResponse]: + """ + Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all locations. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteLocationCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteLocationCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateLocationCustomAttributeDefinitionResponse]: + """ + Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with locations. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or + [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + to set the custom attribute for locations. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateLocationCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/locations/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLocationCustomAttributeDefinitionResponse, + construct_type( + type_=CreateLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveLocationCustomAttributeDefinitionResponse]: + """ + Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveLocationCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateLocationCustomAttributeDefinitionResponse]: + """ + Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + + For more information, see + [Update a location custom attribute definition](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, specify the current version of the custom attribute definition. + If this is not important for your application, `version` can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateLocationCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateLocationCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteLocationCustomAttributeDefinitionResponse]: + """ + Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + all locations. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteLocationCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteLocationCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteLocationCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/locations/custom_attributes/__init__.py b/src/square/locations/custom_attributes/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/locations/custom_attributes/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/locations/custom_attributes/client.py b/src/square/locations/custom_attributes/client.py new file mode 100644 index 00000000..3911388c --- /dev/null +++ b/src/square/locations/custom_attributes/client.py @@ -0,0 +1,878 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributesClient +from ...requests.bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request import ( + BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams, +) +from ...core.request_options import RequestOptions +from ...types.bulk_delete_location_custom_attributes_response import BulkDeleteLocationCustomAttributesResponse +from ...requests.bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request import ( + BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams, +) +from ...types.bulk_upsert_location_custom_attributes_response import BulkUpsertLocationCustomAttributesResponse +from ...types.visibility_filter import VisibilityFilter +from ...core.pagination import SyncPager +from ...types.custom_attribute import CustomAttribute +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_location_custom_attributes_response import ListLocationCustomAttributesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_location_custom_attribute_response import RetrieveLocationCustomAttributeResponse +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_location_custom_attribute_response import UpsertLocationCustomAttributeResponse +from ...types.delete_location_custom_attribute_response import DeleteLocationCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributesClient + """ + return self._raw_client + + def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteLocationCustomAttributesResponse: + """ + Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteLocationCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attributes.batch_delete( + values={ + "id1": {"key": "bestseller"}, + "id2": {"key": "bestseller"}, + "id3": {"key": "phone-number"}, + }, + ) + """ + response = self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertLocationCustomAttributesResponse: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for one or more locations. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a location ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertLocationCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attributes.batch_upsert( + values={ + "id1": { + "location_id": "L0TBCBTB7P8RQ", + "custom_attribute": {"key": "bestseller", "value": "hot cocoa"}, + }, + "id2": { + "location_id": "L9XMD04V3STJX", + "custom_attribute": { + "key": "bestseller", + "value": "berry smoothie", + }, + }, + "id3": { + "location_id": "L0TBCBTB7P8RQ", + "custom_attribute": { + "key": "phone-number", + "value": "+12223334444", + }, + }, + }, + ) + """ + response = self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + def list( + self, + location_id: str, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with a location. + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttribute] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.locations.custom_attributes.list( + location_id="location_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLocationCustomAttributesResponse, + construct_type( + type_=ListLocationCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id, + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + location_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveLocationCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a location. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attributes.get( + location_id="location_id", + key="key", + ) + """ + response = self._raw_client.get( + location_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + def upsert( + self, + location_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertLocationCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a location. + Use this endpoint to set the value of a custom attribute for a specified location. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include the current version of the custom attribute. + If this is not important for your application, version can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertLocationCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attributes.upsert( + location_id="location_id", + key="key", + custom_attribute={"value": "hot cocoa"}, + ) + """ + response = self._raw_client.upsert( + location_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, location_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteLocationCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a location. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteLocationCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.custom_attributes.delete( + location_id="location_id", + key="key", + ) + """ + response = self._raw_client.delete(location_id, key, request_options=request_options) + return response.data + + +class AsyncCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributesClient + """ + return self._raw_client + + async def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteLocationCustomAttributesResponse: + """ + Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteLocationCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attributes.batch_delete( + values={ + "id1": {"key": "bestseller"}, + "id2": {"key": "bestseller"}, + "id3": {"key": "phone-number"}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertLocationCustomAttributesResponse: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for one or more locations. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a location ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertLocationCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attributes.batch_upsert( + values={ + "id1": { + "location_id": "L0TBCBTB7P8RQ", + "custom_attribute": {"key": "bestseller", "value": "hot cocoa"}, + }, + "id2": { + "location_id": "L9XMD04V3STJX", + "custom_attribute": { + "key": "bestseller", + "value": "berry smoothie", + }, + }, + "id3": { + "location_id": "L0TBCBTB7P8RQ", + "custom_attribute": { + "key": "phone-number", + "value": "+12223334444", + }, + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + async def list( + self, + location_id: str, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with a location. + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttribute] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.locations.custom_attributes.list( + location_id="location_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLocationCustomAttributesResponse, + construct_type( + type_=ListLocationCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id, + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + location_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveLocationCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a location. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveLocationCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attributes.get( + location_id="location_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get( + location_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + async def upsert( + self, + location_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertLocationCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a location. + Use this endpoint to set the value of a custom attribute for a specified location. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include the current version of the custom attribute. + If this is not important for your application, version can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertLocationCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attributes.upsert( + location_id="location_id", + key="key", + custom_attribute={"value": "hot cocoa"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert( + location_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, location_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteLocationCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a location. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteLocationCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.custom_attributes.delete( + location_id="location_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(location_id, key, request_options=request_options) + return response.data diff --git a/src/square/locations/custom_attributes/raw_client.py b/src/square/locations/custom_attributes/raw_client.py new file mode 100644 index 00000000..caeb62ee --- /dev/null +++ b/src/square/locations/custom_attributes/raw_client.py @@ -0,0 +1,670 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request import ( + BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams, +) +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.bulk_delete_location_custom_attributes_response import BulkDeleteLocationCustomAttributesResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request import ( + BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams, +) +from ...types.bulk_upsert_location_custom_attributes_response import BulkUpsertLocationCustomAttributesResponse +from ...types.retrieve_location_custom_attribute_response import RetrieveLocationCustomAttributeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_location_custom_attribute_response import UpsertLocationCustomAttributeResponse +from ...types.delete_location_custom_attribute_response import DeleteLocationCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkDeleteLocationCustomAttributesResponse]: + """ + Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkDeleteLocationCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/locations/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteLocationCustomAttributesResponse, + construct_type( + type_=BulkDeleteLocationCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkUpsertLocationCustomAttributesResponse]: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for one or more locations. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a location ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkUpsertLocationCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/locations/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertLocationCustomAttributesResponse, + construct_type( + type_=BulkUpsertLocationCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + location_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RetrieveLocationCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a location. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveLocationCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationCustomAttributeResponse, + construct_type( + type_=RetrieveLocationCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def upsert( + self, + location_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpsertLocationCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a location. + Use this endpoint to set the value of a custom attribute for a specified location. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include the current version of the custom attribute. + If this is not important for your application, version can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertLocationCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes/{jsonable_encoder(key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertLocationCustomAttributeResponse, + construct_type( + type_=UpsertLocationCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, location_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteLocationCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a location. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteLocationCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteLocationCustomAttributeResponse, + construct_type( + type_=DeleteLocationCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkDeleteLocationCustomAttributesResponse]: + """ + Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkDeleteLocationCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/locations/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteLocationCustomAttributesResponse, + construct_type( + type_=BulkDeleteLocationCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkUpsertLocationCustomAttributesResponse]: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for one or more locations. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a location ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkUpsertLocationCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/locations/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertLocationCustomAttributesResponse, + construct_type( + type_=BulkUpsertLocationCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + location_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RetrieveLocationCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a location. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveLocationCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveLocationCustomAttributeResponse, + construct_type( + type_=RetrieveLocationCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def upsert( + self, + location_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpsertLocationCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a location. + Use this endpoint to set the value of a custom attribute for a specified location. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for an update operation, include the current version of the custom attribute. + If this is not important for your application, version can be set to -1. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertLocationCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes/{jsonable_encoder(key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertLocationCustomAttributeResponse, + construct_type( + type_=UpsertLocationCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, location_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteLocationCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a location. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + location_id : str + The ID of the target [location](entity:Location). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteLocationCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteLocationCustomAttributeResponse, + construct_type( + type_=DeleteLocationCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/locations/raw_client.py b/src/square/locations/raw_client.py new file mode 100644 index 00000000..5ea3dc6c --- /dev/null +++ b/src/square/locations/raw_client.py @@ -0,0 +1,727 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.list_locations_response import ListLocationsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.location import LocationParams +from ..types.create_location_response import CreateLocationResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..types.get_location_response import GetLocationResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_location_response import UpdateLocationResponse +from ..requests.create_order_request import CreateOrderRequestParams +from ..requests.address import AddressParams +from ..requests.charge_request_additional_recipient import ChargeRequestAdditionalRecipientParams +from ..types.create_checkout_response import CreateCheckoutResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawLocationsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[ListLocationsResponse]: + """ + Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), + including those with an inactive status. Locations are listed alphabetically by `name`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListLocationsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/locations", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListLocationsResponse, + construct_type( + type_=ListLocationsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateLocationResponse]: + """ + Creates a [location](https://developer.squareup.com/docs/locations-api). + Creating new locations allows for separate configuration of receipt layouts, item prices, + and sales reports. Developers can use locations to separate sales activity through applications + that integrate with Square from sales activity elsewhere in a seller's account. + Locations created programmatically with the Locations API last forever and + are visible to the seller for their own management. Therefore, ensure that + each location has a sensible and unique name. + + Parameters + ---------- + location : typing.Optional[LocationParams] + The initial values of the location being created. The `name` field is required and must be unique within a seller account. + All other fields are optional, but any information you care about for the location should be included. + The remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateLocationResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/locations", + method="POST", + json={ + "location": convert_and_respect_annotation_metadata( + object_=location, annotation=LocationParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLocationResponse, + construct_type( + type_=CreateLocationResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetLocationResponse]: + """ + Retrieves details of a single location. Specify "main" + as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + Parameters + ---------- + location_id : str + The ID of the location to retrieve. Specify the string + "main" to return the main location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetLocationResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLocationResponse, + construct_type( + type_=GetLocationResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + location_id: str, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateLocationResponse]: + """ + Updates a [location](https://developer.squareup.com/docs/locations-api). + + Parameters + ---------- + location_id : str + The ID of the location to update. + + location : typing.Optional[LocationParams] + The `Location` object with only the fields to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateLocationResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}", + method="PUT", + json={ + "location": convert_and_respect_annotation_metadata( + object_=location, annotation=LocationParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateLocationResponse, + construct_type( + type_=UpdateLocationResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def checkouts( + self, + location_id: str, + *, + idempotency_key: str, + order: CreateOrderRequestParams, + ask_for_shipping_address: typing.Optional[bool] = OMIT, + merchant_support_email: typing.Optional[str] = OMIT, + pre_populate_buyer_email: typing.Optional[str] = OMIT, + pre_populate_shipping_address: typing.Optional[AddressParams] = OMIT, + redirect_url: typing.Optional[str] = OMIT, + additional_recipients: typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] = OMIT, + note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateCheckoutResponse]: + """ + Links a `checkoutId` to a `checkout_page_url` that customers are + directed to in order to provide their payment information using a + payment processing workflow hosted on connect.squareup.com. + + + NOTE: The Checkout API has been updated with new features. + For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). + + Parameters + ---------- + location_id : str + The ID of the business location to associate the checkout with. + + idempotency_key : str + A unique string that identifies this checkout among others you have created. It can be + any valid string but must be unique for every order sent to Square Checkout for a given location ID. + + The idempotency key is used to avoid processing the same order more than once. If you are + unsure whether a particular checkout was created successfully, you can attempt it again with + the same idempotency key and all the same other parameters without worrying about creating duplicates. + + You should use a random number/string generator native to the language + you are working in to generate strings for your idempotency keys. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order : CreateOrderRequestParams + The order including line items to be checked out. + + ask_for_shipping_address : typing.Optional[bool] + If `true`, Square Checkout collects shipping information on your behalf and stores + that information with the transaction information in the Square Seller Dashboard. + + Default: `false`. + + merchant_support_email : typing.Optional[str] + The email address to display on the Square Checkout confirmation page + and confirmation email that the buyer can use to contact the seller. + + If this value is not set, the confirmation page and email display the + primary email address associated with the seller's Square account. + + Default: none; only exists if explicitly set. + + pre_populate_buyer_email : typing.Optional[str] + If provided, the buyer's email is prepopulated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + + pre_populate_shipping_address : typing.Optional[AddressParams] + If provided, the buyer's shipping information is prepopulated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + + redirect_url : typing.Optional[str] + The URL to redirect to after the checkout is completed with `checkoutId`, + `transactionId`, and `referenceId` appended as URL parameters. For example, + if the provided redirect URL is `http://www.example.com/order-complete`, a + successful transaction redirects the customer to: + + `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` + + If you do not provide a redirect URL, Square Checkout displays an order + confirmation page on your behalf; however, it is strongly recommended that + you provide a redirect URL so you can verify the transaction results and + finalize the order through your existing/normal confirmation workflow. + + Default: none; only exists if explicitly set. + + additional_recipients : typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] + The basic primitive of a multi-party transaction. The value is optional. + The transaction facilitated by you can be split from here. + + If you provide this value, the `amount_money` value in your `additional_recipients` field + cannot be more than 90% of the `total_money` calculated by Square for your order. + The `location_id` must be a valid seller location where the checkout is occurring. + + This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. + + This field is currently not supported in the Square Sandbox. + + note : typing.Optional[str] + An optional note to associate with the `checkout` object. + + This value cannot exceed 60 characters. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateCheckoutResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/checkouts", + method="POST", + json={ + "idempotency_key": idempotency_key, + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=CreateOrderRequestParams, direction="write" + ), + "ask_for_shipping_address": ask_for_shipping_address, + "merchant_support_email": merchant_support_email, + "pre_populate_buyer_email": pre_populate_buyer_email, + "pre_populate_shipping_address": convert_and_respect_annotation_metadata( + object_=pre_populate_shipping_address, annotation=AddressParams, direction="write" + ), + "redirect_url": redirect_url, + "additional_recipients": convert_and_respect_annotation_metadata( + object_=additional_recipients, + annotation=typing.Sequence[ChargeRequestAdditionalRecipientParams], + direction="write", + ), + "note": note, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCheckoutResponse, + construct_type( + type_=CreateCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawLocationsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ListLocationsResponse]: + """ + Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), + including those with an inactive status. Locations are listed alphabetically by `name`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListLocationsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/locations", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListLocationsResponse, + construct_type( + type_=ListLocationsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateLocationResponse]: + """ + Creates a [location](https://developer.squareup.com/docs/locations-api). + Creating new locations allows for separate configuration of receipt layouts, item prices, + and sales reports. Developers can use locations to separate sales activity through applications + that integrate with Square from sales activity elsewhere in a seller's account. + Locations created programmatically with the Locations API last forever and + are visible to the seller for their own management. Therefore, ensure that + each location has a sensible and unique name. + + Parameters + ---------- + location : typing.Optional[LocationParams] + The initial values of the location being created. The `name` field is required and must be unique within a seller account. + All other fields are optional, but any information you care about for the location should be included. + The remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateLocationResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/locations", + method="POST", + json={ + "location": convert_and_respect_annotation_metadata( + object_=location, annotation=LocationParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLocationResponse, + construct_type( + type_=CreateLocationResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, location_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetLocationResponse]: + """ + Retrieves details of a single location. Specify "main" + as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location). + + Parameters + ---------- + location_id : str + The ID of the location to retrieve. Specify the string + "main" to return the main location. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetLocationResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLocationResponse, + construct_type( + type_=GetLocationResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + location_id: str, + *, + location: typing.Optional[LocationParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateLocationResponse]: + """ + Updates a [location](https://developer.squareup.com/docs/locations-api). + + Parameters + ---------- + location_id : str + The ID of the location to update. + + location : typing.Optional[LocationParams] + The `Location` object with only the fields to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateLocationResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}", + method="PUT", + json={ + "location": convert_and_respect_annotation_metadata( + object_=location, annotation=LocationParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateLocationResponse, + construct_type( + type_=UpdateLocationResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def checkouts( + self, + location_id: str, + *, + idempotency_key: str, + order: CreateOrderRequestParams, + ask_for_shipping_address: typing.Optional[bool] = OMIT, + merchant_support_email: typing.Optional[str] = OMIT, + pre_populate_buyer_email: typing.Optional[str] = OMIT, + pre_populate_shipping_address: typing.Optional[AddressParams] = OMIT, + redirect_url: typing.Optional[str] = OMIT, + additional_recipients: typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] = OMIT, + note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateCheckoutResponse]: + """ + Links a `checkoutId` to a `checkout_page_url` that customers are + directed to in order to provide their payment information using a + payment processing workflow hosted on connect.squareup.com. + + + NOTE: The Checkout API has been updated with new features. + For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). + + Parameters + ---------- + location_id : str + The ID of the business location to associate the checkout with. + + idempotency_key : str + A unique string that identifies this checkout among others you have created. It can be + any valid string but must be unique for every order sent to Square Checkout for a given location ID. + + The idempotency key is used to avoid processing the same order more than once. If you are + unsure whether a particular checkout was created successfully, you can attempt it again with + the same idempotency key and all the same other parameters without worrying about creating duplicates. + + You should use a random number/string generator native to the language + you are working in to generate strings for your idempotency keys. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order : CreateOrderRequestParams + The order including line items to be checked out. + + ask_for_shipping_address : typing.Optional[bool] + If `true`, Square Checkout collects shipping information on your behalf and stores + that information with the transaction information in the Square Seller Dashboard. + + Default: `false`. + + merchant_support_email : typing.Optional[str] + The email address to display on the Square Checkout confirmation page + and confirmation email that the buyer can use to contact the seller. + + If this value is not set, the confirmation page and email display the + primary email address associated with the seller's Square account. + + Default: none; only exists if explicitly set. + + pre_populate_buyer_email : typing.Optional[str] + If provided, the buyer's email is prepopulated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + + pre_populate_shipping_address : typing.Optional[AddressParams] + If provided, the buyer's shipping information is prepopulated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + + redirect_url : typing.Optional[str] + The URL to redirect to after the checkout is completed with `checkoutId`, + `transactionId`, and `referenceId` appended as URL parameters. For example, + if the provided redirect URL is `http://www.example.com/order-complete`, a + successful transaction redirects the customer to: + + `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` + + If you do not provide a redirect URL, Square Checkout displays an order + confirmation page on your behalf; however, it is strongly recommended that + you provide a redirect URL so you can verify the transaction results and + finalize the order through your existing/normal confirmation workflow. + + Default: none; only exists if explicitly set. + + additional_recipients : typing.Optional[typing.Sequence[ChargeRequestAdditionalRecipientParams]] + The basic primitive of a multi-party transaction. The value is optional. + The transaction facilitated by you can be split from here. + + If you provide this value, the `amount_money` value in your `additional_recipients` field + cannot be more than 90% of the `total_money` calculated by Square for your order. + The `location_id` must be a valid seller location where the checkout is occurring. + + This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. + + This field is currently not supported in the Square Sandbox. + + note : typing.Optional[str] + An optional note to associate with the `checkout` object. + + This value cannot exceed 60 characters. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateCheckoutResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/checkouts", + method="POST", + json={ + "idempotency_key": idempotency_key, + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=CreateOrderRequestParams, direction="write" + ), + "ask_for_shipping_address": ask_for_shipping_address, + "merchant_support_email": merchant_support_email, + "pre_populate_buyer_email": pre_populate_buyer_email, + "pre_populate_shipping_address": convert_and_respect_annotation_metadata( + object_=pre_populate_shipping_address, annotation=AddressParams, direction="write" + ), + "redirect_url": redirect_url, + "additional_recipients": convert_and_respect_annotation_metadata( + object_=additional_recipients, + annotation=typing.Sequence[ChargeRequestAdditionalRecipientParams], + direction="write", + ), + "note": note, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateCheckoutResponse, + construct_type( + type_=CreateCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/locations/transactions/__init__.py b/src/square/locations/transactions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/locations/transactions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/locations/transactions/client.py b/src/square/locations/transactions/client.py new file mode 100644 index 00000000..14967b8c --- /dev/null +++ b/src/square/locations/transactions/client.py @@ -0,0 +1,475 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawTransactionsClient +import typing +from ...types.sort_order import SortOrder +from ...core.request_options import RequestOptions +from ...types.list_transactions_response import ListTransactionsResponse +from ...types.get_transaction_response import GetTransactionResponse +from ...types.capture_transaction_response import CaptureTransactionResponse +from ...types.void_transaction_response import VoidTransactionResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawTransactionsClient + + +class TransactionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTransactionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTransactionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTransactionsClient + """ + return self._raw_client + + def list( + self, + location_id: str, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> ListTransactionsResponse: + """ + Lists transactions for a particular location. + + Transactions include payment information from sales and exchanges and refund + information from returns and exchanges. + + Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50 + + Parameters + ---------- + location_id : str + The ID of the location to list transactions for. + + begin_time : typing.Optional[str] + The beginning of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time minus one year. + + end_time : typing.Optional[str] + The end of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time. + + sort_order : typing.Optional[SortOrder] + The order in which results are listed in the response (`ASC` for + oldest first, `DESC` for newest first). + + Default value: `DESC` + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListTransactionsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.transactions.list( + location_id="location_id", + ) + """ + response = self._raw_client.list( + location_id, + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=cursor, + request_options=request_options, + ) + return response.data + + def get( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTransactionResponse: + """ + Retrieves details for a single transaction. + + Parameters + ---------- + location_id : str + The ID of the transaction's associated location. + + transaction_id : str + The ID of the transaction to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTransactionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.transactions.get( + location_id="location_id", + transaction_id="transaction_id", + ) + """ + response = self._raw_client.get(location_id, transaction_id, request_options=request_options) + return response.data + + def capture( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CaptureTransactionResponse: + """ + Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CaptureTransactionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.transactions.capture( + location_id="location_id", + transaction_id="transaction_id", + ) + """ + response = self._raw_client.capture(location_id, transaction_id, request_options=request_options) + return response.data + + def void( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> VoidTransactionResponse: + """ + Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + VoidTransactionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.locations.transactions.void( + location_id="location_id", + transaction_id="transaction_id", + ) + """ + response = self._raw_client.void(location_id, transaction_id, request_options=request_options) + return response.data + + +class AsyncTransactionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTransactionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTransactionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTransactionsClient + """ + return self._raw_client + + async def list( + self, + location_id: str, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> ListTransactionsResponse: + """ + Lists transactions for a particular location. + + Transactions include payment information from sales and exchanges and refund + information from returns and exchanges. + + Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50 + + Parameters + ---------- + location_id : str + The ID of the location to list transactions for. + + begin_time : typing.Optional[str] + The beginning of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time minus one year. + + end_time : typing.Optional[str] + The end of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time. + + sort_order : typing.Optional[SortOrder] + The order in which results are listed in the response (`ASC` for + oldest first, `DESC` for newest first). + + Default value: `DESC` + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListTransactionsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.transactions.list( + location_id="location_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.list( + location_id, + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=cursor, + request_options=request_options, + ) + return response.data + + async def get( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTransactionResponse: + """ + Retrieves details for a single transaction. + + Parameters + ---------- + location_id : str + The ID of the transaction's associated location. + + transaction_id : str + The ID of the transaction to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTransactionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.transactions.get( + location_id="location_id", + transaction_id="transaction_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(location_id, transaction_id, request_options=request_options) + return response.data + + async def capture( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CaptureTransactionResponse: + """ + Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CaptureTransactionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.transactions.capture( + location_id="location_id", + transaction_id="transaction_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.capture(location_id, transaction_id, request_options=request_options) + return response.data + + async def void( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> VoidTransactionResponse: + """ + Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + VoidTransactionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.locations.transactions.void( + location_id="location_id", + transaction_id="transaction_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.void(location_id, transaction_id, request_options=request_options) + return response.data diff --git a/src/square/locations/transactions/raw_client.py b/src/square/locations/transactions/raw_client.py new file mode 100644 index 00000000..4ca8615a --- /dev/null +++ b/src/square/locations/transactions/raw_client.py @@ -0,0 +1,465 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...types.sort_order import SortOrder +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.list_transactions_response import ListTransactionsResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_transaction_response import GetTransactionResponse +from ...types.capture_transaction_response import CaptureTransactionResponse +from ...types.void_transaction_response import VoidTransactionResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawTransactionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + location_id: str, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ListTransactionsResponse]: + """ + Lists transactions for a particular location. + + Transactions include payment information from sales and exchanges and refund + information from returns and exchanges. + + Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50 + + Parameters + ---------- + location_id : str + The ID of the location to list transactions for. + + begin_time : typing.Optional[str] + The beginning of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time minus one year. + + end_time : typing.Optional[str] + The end of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time. + + sort_order : typing.Optional[SortOrder] + The order in which results are listed in the response (`ASC` for + oldest first, `DESC` for newest first). + + Default value: `DESC` + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListTransactionsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions", + method="GET", + params={ + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListTransactionsResponse, + construct_type( + type_=ListTransactionsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTransactionResponse]: + """ + Retrieves details for a single transaction. + + Parameters + ---------- + location_id : str + The ID of the transaction's associated location. + + transaction_id : str + The ID of the transaction to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTransactionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions/{jsonable_encoder(transaction_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTransactionResponse, + construct_type( + type_=GetTransactionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def capture( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CaptureTransactionResponse]: + """ + Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CaptureTransactionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions/{jsonable_encoder(transaction_id)}/capture", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CaptureTransactionResponse, + construct_type( + type_=CaptureTransactionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def void( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[VoidTransactionResponse]: + """ + Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[VoidTransactionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions/{jsonable_encoder(transaction_id)}/void", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + VoidTransactionResponse, + construct_type( + type_=VoidTransactionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawTransactionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + location_id: str, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ListTransactionsResponse]: + """ + Lists transactions for a particular location. + + Transactions include payment information from sales and exchanges and refund + information from returns and exchanges. + + Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50 + + Parameters + ---------- + location_id : str + The ID of the location to list transactions for. + + begin_time : typing.Optional[str] + The beginning of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time minus one year. + + end_time : typing.Optional[str] + The end of the requested reporting period, in RFC 3339 format. + + See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. + + Default value: The current time. + + sort_order : typing.Optional[SortOrder] + The order in which results are listed in the response (`ASC` for + oldest first, `DESC` for newest first). + + Default value: `DESC` + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListTransactionsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions", + method="GET", + params={ + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListTransactionsResponse, + construct_type( + type_=ListTransactionsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTransactionResponse]: + """ + Retrieves details for a single transaction. + + Parameters + ---------- + location_id : str + The ID of the transaction's associated location. + + transaction_id : str + The ID of the transaction to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTransactionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions/{jsonable_encoder(transaction_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTransactionResponse, + construct_type( + type_=GetTransactionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def capture( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CaptureTransactionResponse]: + """ + Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CaptureTransactionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions/{jsonable_encoder(transaction_id)}/capture", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CaptureTransactionResponse, + construct_type( + type_=CaptureTransactionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def void( + self, location_id: str, transaction_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[VoidTransactionResponse]: + """ + Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint with a `delay_capture` value of `true`. + + + See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) + for more information. + + Parameters + ---------- + location_id : str + + + transaction_id : str + + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[VoidTransactionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/locations/{jsonable_encoder(location_id)}/transactions/{jsonable_encoder(transaction_id)}/void", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + VoidTransactionResponse, + construct_type( + type_=VoidTransactionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/loyalty/__init__.py b/src/square/loyalty/__init__.py new file mode 100644 index 00000000..81d53d39 --- /dev/null +++ b/src/square/loyalty/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import accounts, programs, rewards + +__all__ = ["accounts", "programs", "rewards"] diff --git a/src/square/loyalty/accounts/__init__.py b/src/square/loyalty/accounts/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/loyalty/accounts/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/loyalty/accounts/client.py b/src/square/loyalty/accounts/client.py new file mode 100644 index 00000000..b0952702 --- /dev/null +++ b/src/square/loyalty/accounts/client.py @@ -0,0 +1,638 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawAccountsClient +from ...requests.loyalty_account import LoyaltyAccountParams +from ...core.request_options import RequestOptions +from ...types.create_loyalty_account_response import CreateLoyaltyAccountResponse +from ...requests.search_loyalty_accounts_request_loyalty_account_query import ( + SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams, +) +from ...types.search_loyalty_accounts_response import SearchLoyaltyAccountsResponse +from ...types.get_loyalty_account_response import GetLoyaltyAccountResponse +from ...requests.loyalty_event_accumulate_points import LoyaltyEventAccumulatePointsParams +from ...types.accumulate_loyalty_points_response import AccumulateLoyaltyPointsResponse +from ...requests.loyalty_event_adjust_points import LoyaltyEventAdjustPointsParams +from ...types.adjust_loyalty_points_response import AdjustLoyaltyPointsResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawAccountsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class AccountsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawAccountsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawAccountsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawAccountsClient + """ + return self._raw_client + + def create( + self, + *, + loyalty_account: LoyaltyAccountParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLoyaltyAccountResponse: + """ + Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer. + + Parameters + ---------- + loyalty_account : LoyaltyAccountParams + The loyalty account to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyAccount` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLoyaltyAccountResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.accounts.create( + loyalty_account={ + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "mapping": {"phone_number": "+14155551234"}, + }, + idempotency_key="ec78c477-b1c3-4899-a209-a4e71337c996", + ) + """ + response = self._raw_client.create( + loyalty_account=loyalty_account, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchLoyaltyAccountsResponse: + """ + Searches for loyalty accounts in a loyalty program. + + You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. + + Search results are sorted by `created_at` in ascending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] + The search criteria for the request. + + limit : typing.Optional[int] + The maximum number of results to include in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchLoyaltyAccountsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.accounts.search( + query={"mappings": [{"phone_number": "+14155551234"}]}, + limit=10, + ) + """ + response = self._raw_client.search(query=query, limit=limit, cursor=cursor, request_options=request_options) + return response.data + + def get( + self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyAccountResponse: + """ + Retrieves a loyalty account. + + Parameters + ---------- + account_id : str + The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyAccountResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.accounts.get( + account_id="account_id", + ) + """ + response = self._raw_client.get(account_id, request_options=request_options) + return response.data + + def accumulate_points( + self, + account_id: str, + *, + accumulate_points: LoyaltyEventAccumulatePointsParams, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AccumulateLoyaltyPointsResponse: + """ + Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount). + + - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order + to compute the points earned from both the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual + rules, Square computes points based on the accrual rule that grants the most points. + For purchases that qualify for multiple promotions, Square computes points based on the most + recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. + + - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. + You must first perform a client-side computation of the points earned from the loyalty program and + loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) + to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + accumulate_points : LoyaltyEventAccumulatePointsParams + The points to add to the account. + If you are using the Orders API to manage orders, specify the order ID. + Otherwise, specify the points to add. + + idempotency_key : str + A unique string that identifies the `AccumulateLoyaltyPoints` request. + Keys can be any valid string but must be unique for every request. + + location_id : str + The [location](entity:Location) where the purchase was made. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AccumulateLoyaltyPointsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.accounts.accumulate_points( + account_id="account_id", + accumulate_points={"order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY"}, + idempotency_key="58b90739-c3e8-4b11-85f7-e636d48d72cb", + location_id="P034NEENMD09F", + ) + """ + response = self._raw_client.accumulate_points( + account_id, + accumulate_points=accumulate_points, + idempotency_key=idempotency_key, + location_id=location_id, + request_options=request_options, + ) + return response.data + + def adjust( + self, + account_id: str, + *, + idempotency_key: str, + adjust_points: LoyaltyEventAdjustPointsParams, + allow_negative_balance: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AdjustLoyaltyPointsResponse: + """ + Adds points to or subtracts points from a buyer's account. + + Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call + [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) + to add points when a buyer pays for the purchase. + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + idempotency_key : str + A unique string that identifies this `AdjustLoyaltyPoints` request. + Keys can be any valid string, but must be unique for every request. + + adjust_points : LoyaltyEventAdjustPointsParams + The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. + To subtract points, specify a negative integer. + + allow_negative_balance : typing.Optional[bool] + Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative + balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting + the specified number of points would result in a negative balance. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AdjustLoyaltyPointsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.accounts.adjust( + account_id="account_id", + idempotency_key="bc29a517-3dc9-450e-aa76-fae39ee849d1", + adjust_points={"points": 10, "reason": "Complimentary points"}, + ) + """ + response = self._raw_client.adjust( + account_id, + idempotency_key=idempotency_key, + adjust_points=adjust_points, + allow_negative_balance=allow_negative_balance, + request_options=request_options, + ) + return response.data + + +class AsyncAccountsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawAccountsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawAccountsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawAccountsClient + """ + return self._raw_client + + async def create( + self, + *, + loyalty_account: LoyaltyAccountParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLoyaltyAccountResponse: + """ + Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer. + + Parameters + ---------- + loyalty_account : LoyaltyAccountParams + The loyalty account to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyAccount` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLoyaltyAccountResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.accounts.create( + loyalty_account={ + "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd", + "mapping": {"phone_number": "+14155551234"}, + }, + idempotency_key="ec78c477-b1c3-4899-a209-a4e71337c996", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + loyalty_account=loyalty_account, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchLoyaltyAccountsResponse: + """ + Searches for loyalty accounts in a loyalty program. + + You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. + + Search results are sorted by `created_at` in ascending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] + The search criteria for the request. + + limit : typing.Optional[int] + The maximum number of results to include in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchLoyaltyAccountsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.accounts.search( + query={"mappings": [{"phone_number": "+14155551234"}]}, + limit=10, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data + + async def get( + self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyAccountResponse: + """ + Retrieves a loyalty account. + + Parameters + ---------- + account_id : str + The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyAccountResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.accounts.get( + account_id="account_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(account_id, request_options=request_options) + return response.data + + async def accumulate_points( + self, + account_id: str, + *, + accumulate_points: LoyaltyEventAccumulatePointsParams, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AccumulateLoyaltyPointsResponse: + """ + Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount). + + - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order + to compute the points earned from both the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual + rules, Square computes points based on the accrual rule that grants the most points. + For purchases that qualify for multiple promotions, Square computes points based on the most + recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. + + - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. + You must first perform a client-side computation of the points earned from the loyalty program and + loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) + to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + accumulate_points : LoyaltyEventAccumulatePointsParams + The points to add to the account. + If you are using the Orders API to manage orders, specify the order ID. + Otherwise, specify the points to add. + + idempotency_key : str + A unique string that identifies the `AccumulateLoyaltyPoints` request. + Keys can be any valid string but must be unique for every request. + + location_id : str + The [location](entity:Location) where the purchase was made. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AccumulateLoyaltyPointsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.accounts.accumulate_points( + account_id="account_id", + accumulate_points={"order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY"}, + idempotency_key="58b90739-c3e8-4b11-85f7-e636d48d72cb", + location_id="P034NEENMD09F", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.accumulate_points( + account_id, + accumulate_points=accumulate_points, + idempotency_key=idempotency_key, + location_id=location_id, + request_options=request_options, + ) + return response.data + + async def adjust( + self, + account_id: str, + *, + idempotency_key: str, + adjust_points: LoyaltyEventAdjustPointsParams, + allow_negative_balance: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AdjustLoyaltyPointsResponse: + """ + Adds points to or subtracts points from a buyer's account. + + Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call + [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) + to add points when a buyer pays for the purchase. + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + idempotency_key : str + A unique string that identifies this `AdjustLoyaltyPoints` request. + Keys can be any valid string, but must be unique for every request. + + adjust_points : LoyaltyEventAdjustPointsParams + The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. + To subtract points, specify a negative integer. + + allow_negative_balance : typing.Optional[bool] + Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative + balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting + the specified number of points would result in a negative balance. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AdjustLoyaltyPointsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.accounts.adjust( + account_id="account_id", + idempotency_key="bc29a517-3dc9-450e-aa76-fae39ee849d1", + adjust_points={"points": 10, "reason": "Complimentary points"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.adjust( + account_id, + idempotency_key=idempotency_key, + adjust_points=adjust_points, + allow_negative_balance=allow_negative_balance, + request_options=request_options, + ) + return response.data diff --git a/src/square/loyalty/accounts/raw_client.py b/src/square/loyalty/accounts/raw_client.py new file mode 100644 index 00000000..c1717cd8 --- /dev/null +++ b/src/square/loyalty/accounts/raw_client.py @@ -0,0 +1,677 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.loyalty_account import LoyaltyAccountParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_loyalty_account_response import CreateLoyaltyAccountResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.search_loyalty_accounts_request_loyalty_account_query import ( + SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams, +) +from ...types.search_loyalty_accounts_response import SearchLoyaltyAccountsResponse +from ...types.get_loyalty_account_response import GetLoyaltyAccountResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.loyalty_event_accumulate_points import LoyaltyEventAccumulatePointsParams +from ...types.accumulate_loyalty_points_response import AccumulateLoyaltyPointsResponse +from ...requests.loyalty_event_adjust_points import LoyaltyEventAdjustPointsParams +from ...types.adjust_loyalty_points_response import AdjustLoyaltyPointsResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawAccountsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + loyalty_account: LoyaltyAccountParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateLoyaltyAccountResponse]: + """ + Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer. + + Parameters + ---------- + loyalty_account : LoyaltyAccountParams + The loyalty account to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyAccount` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateLoyaltyAccountResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/loyalty/accounts", + method="POST", + json={ + "loyalty_account": convert_and_respect_annotation_metadata( + object_=loyalty_account, annotation=LoyaltyAccountParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLoyaltyAccountResponse, + construct_type( + type_=CreateLoyaltyAccountResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchLoyaltyAccountsResponse]: + """ + Searches for loyalty accounts in a loyalty program. + + You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. + + Search results are sorted by `created_at` in ascending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] + The search criteria for the request. + + limit : typing.Optional[int] + The maximum number of results to include in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchLoyaltyAccountsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/loyalty/accounts/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchLoyaltyAccountsResponse, + construct_type( + type_=SearchLoyaltyAccountsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetLoyaltyAccountResponse]: + """ + Retrieves a loyalty account. + + Parameters + ---------- + account_id : str + The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetLoyaltyAccountResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/accounts/{jsonable_encoder(account_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyAccountResponse, + construct_type( + type_=GetLoyaltyAccountResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def accumulate_points( + self, + account_id: str, + *, + accumulate_points: LoyaltyEventAccumulatePointsParams, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[AccumulateLoyaltyPointsResponse]: + """ + Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount). + + - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order + to compute the points earned from both the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual + rules, Square computes points based on the accrual rule that grants the most points. + For purchases that qualify for multiple promotions, Square computes points based on the most + recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. + + - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. + You must first perform a client-side computation of the points earned from the loyalty program and + loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) + to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + accumulate_points : LoyaltyEventAccumulatePointsParams + The points to add to the account. + If you are using the Orders API to manage orders, specify the order ID. + Otherwise, specify the points to add. + + idempotency_key : str + A unique string that identifies the `AccumulateLoyaltyPoints` request. + Keys can be any valid string but must be unique for every request. + + location_id : str + The [location](entity:Location) where the purchase was made. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AccumulateLoyaltyPointsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/accounts/{jsonable_encoder(account_id)}/accumulate", + method="POST", + json={ + "accumulate_points": convert_and_respect_annotation_metadata( + object_=accumulate_points, annotation=LoyaltyEventAccumulatePointsParams, direction="write" + ), + "idempotency_key": idempotency_key, + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AccumulateLoyaltyPointsResponse, + construct_type( + type_=AccumulateLoyaltyPointsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def adjust( + self, + account_id: str, + *, + idempotency_key: str, + adjust_points: LoyaltyEventAdjustPointsParams, + allow_negative_balance: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[AdjustLoyaltyPointsResponse]: + """ + Adds points to or subtracts points from a buyer's account. + + Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call + [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) + to add points when a buyer pays for the purchase. + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + idempotency_key : str + A unique string that identifies this `AdjustLoyaltyPoints` request. + Keys can be any valid string, but must be unique for every request. + + adjust_points : LoyaltyEventAdjustPointsParams + The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. + To subtract points, specify a negative integer. + + allow_negative_balance : typing.Optional[bool] + Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative + balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting + the specified number of points would result in a negative balance. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AdjustLoyaltyPointsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/accounts/{jsonable_encoder(account_id)}/adjust", + method="POST", + json={ + "idempotency_key": idempotency_key, + "adjust_points": convert_and_respect_annotation_metadata( + object_=adjust_points, annotation=LoyaltyEventAdjustPointsParams, direction="write" + ), + "allow_negative_balance": allow_negative_balance, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AdjustLoyaltyPointsResponse, + construct_type( + type_=AdjustLoyaltyPointsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawAccountsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + loyalty_account: LoyaltyAccountParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateLoyaltyAccountResponse]: + """ + Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer. + + Parameters + ---------- + loyalty_account : LoyaltyAccountParams + The loyalty account to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyAccount` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateLoyaltyAccountResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/loyalty/accounts", + method="POST", + json={ + "loyalty_account": convert_and_respect_annotation_metadata( + object_=loyalty_account, annotation=LoyaltyAccountParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLoyaltyAccountResponse, + construct_type( + type_=CreateLoyaltyAccountResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchLoyaltyAccountsResponse]: + """ + Searches for loyalty accounts in a loyalty program. + + You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. + + Search results are sorted by `created_at` in ascending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams] + The search criteria for the request. + + limit : typing.Optional[int] + The maximum number of results to include in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchLoyaltyAccountsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/loyalty/accounts/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchLoyaltyAccountsResponse, + construct_type( + type_=SearchLoyaltyAccountsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetLoyaltyAccountResponse]: + """ + Retrieves a loyalty account. + + Parameters + ---------- + account_id : str + The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetLoyaltyAccountResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/accounts/{jsonable_encoder(account_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyAccountResponse, + construct_type( + type_=GetLoyaltyAccountResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def accumulate_points( + self, + account_id: str, + *, + accumulate_points: LoyaltyEventAccumulatePointsParams, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[AccumulateLoyaltyPointsResponse]: + """ + Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount). + + - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order + to compute the points earned from both the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual + rules, Square computes points based on the accrual rule that grants the most points. + For purchases that qualify for multiple promotions, Square computes points based on the most + recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. + + - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. + You must first perform a client-side computation of the points earned from the loyalty program and + loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) + to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + accumulate_points : LoyaltyEventAccumulatePointsParams + The points to add to the account. + If you are using the Orders API to manage orders, specify the order ID. + Otherwise, specify the points to add. + + idempotency_key : str + A unique string that identifies the `AccumulateLoyaltyPoints` request. + Keys can be any valid string but must be unique for every request. + + location_id : str + The [location](entity:Location) where the purchase was made. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AccumulateLoyaltyPointsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/accounts/{jsonable_encoder(account_id)}/accumulate", + method="POST", + json={ + "accumulate_points": convert_and_respect_annotation_metadata( + object_=accumulate_points, annotation=LoyaltyEventAccumulatePointsParams, direction="write" + ), + "idempotency_key": idempotency_key, + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AccumulateLoyaltyPointsResponse, + construct_type( + type_=AccumulateLoyaltyPointsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def adjust( + self, + account_id: str, + *, + idempotency_key: str, + adjust_points: LoyaltyEventAdjustPointsParams, + allow_negative_balance: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[AdjustLoyaltyPointsResponse]: + """ + Adds points to or subtracts points from a buyer's account. + + Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call + [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) + to add points when a buyer pays for the purchase. + + Parameters + ---------- + account_id : str + The ID of the target [loyalty account](entity:LoyaltyAccount). + + idempotency_key : str + A unique string that identifies this `AdjustLoyaltyPoints` request. + Keys can be any valid string, but must be unique for every request. + + adjust_points : LoyaltyEventAdjustPointsParams + The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. + To subtract points, specify a negative integer. + + allow_negative_balance : typing.Optional[bool] + Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative + balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting + the specified number of points would result in a negative balance. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AdjustLoyaltyPointsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/accounts/{jsonable_encoder(account_id)}/adjust", + method="POST", + json={ + "idempotency_key": idempotency_key, + "adjust_points": convert_and_respect_annotation_metadata( + object_=adjust_points, annotation=LoyaltyEventAdjustPointsParams, direction="write" + ), + "allow_negative_balance": allow_negative_balance, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AdjustLoyaltyPointsResponse, + construct_type( + type_=AdjustLoyaltyPointsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/loyalty/client.py b/src/square/loyalty/client.py new file mode 100644 index 00000000..f811820c --- /dev/null +++ b/src/square/loyalty/client.py @@ -0,0 +1,199 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawLoyaltyClient +from .accounts.client import AccountsClient +from .programs.client import ProgramsClient +from .rewards.client import RewardsClient +from ..requests.loyalty_event_query import LoyaltyEventQueryParams +from ..core.request_options import RequestOptions +from ..types.search_loyalty_events_response import SearchLoyaltyEventsResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawLoyaltyClient +from .accounts.client import AsyncAccountsClient +from .programs.client import AsyncProgramsClient +from .rewards.client import AsyncRewardsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class LoyaltyClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawLoyaltyClient(client_wrapper=client_wrapper) + self.accounts = AccountsClient(client_wrapper=client_wrapper) + + self.programs = ProgramsClient(client_wrapper=client_wrapper) + + self.rewards = RewardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawLoyaltyClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawLoyaltyClient + """ + return self._raw_client + + def search_events( + self, + *, + query: typing.Optional[LoyaltyEventQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchLoyaltyEventsResponse: + """ + Searches for loyalty events. + + A Square loyalty program maintains a ledger of events that occur during the lifetime of a + buyer's loyalty account. Each change in the point balance + (for example, points earned, points redeemed, and points expired) is + recorded in the ledger. Using this endpoint, you can search the ledger for events. + + Search results are sorted by `created_at` in descending order. + + Parameters + ---------- + query : typing.Optional[LoyaltyEventQueryParams] + A set of one or more predefined query filters to apply when + searching for loyalty events. The endpoint performs a logical AND to + evaluate multiple filters and performs a logical OR on arrays + that specifies multiple field values. + + limit : typing.Optional[int] + The maximum number of results to include in the response. + The last page might contain fewer events. + The default is 30 events. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchLoyaltyEventsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.search_events( + query={ + "filter": { + "order_filter": {"order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY"} + } + }, + limit=30, + ) + """ + response = self._raw_client.search_events( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data + + +class AsyncLoyaltyClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawLoyaltyClient(client_wrapper=client_wrapper) + self.accounts = AsyncAccountsClient(client_wrapper=client_wrapper) + + self.programs = AsyncProgramsClient(client_wrapper=client_wrapper) + + self.rewards = AsyncRewardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawLoyaltyClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawLoyaltyClient + """ + return self._raw_client + + async def search_events( + self, + *, + query: typing.Optional[LoyaltyEventQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchLoyaltyEventsResponse: + """ + Searches for loyalty events. + + A Square loyalty program maintains a ledger of events that occur during the lifetime of a + buyer's loyalty account. Each change in the point balance + (for example, points earned, points redeemed, and points expired) is + recorded in the ledger. Using this endpoint, you can search the ledger for events. + + Search results are sorted by `created_at` in descending order. + + Parameters + ---------- + query : typing.Optional[LoyaltyEventQueryParams] + A set of one or more predefined query filters to apply when + searching for loyalty events. The endpoint performs a logical AND to + evaluate multiple filters and performs a logical OR on arrays + that specifies multiple field values. + + limit : typing.Optional[int] + The maximum number of results to include in the response. + The last page might contain fewer events. + The default is 30 events. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchLoyaltyEventsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.search_events( + query={ + "filter": { + "order_filter": {"order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY"} + } + }, + limit=30, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search_events( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data diff --git a/src/square/loyalty/programs/__init__.py b/src/square/loyalty/programs/__init__.py new file mode 100644 index 00000000..86e70d3e --- /dev/null +++ b/src/square/loyalty/programs/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import promotions + +__all__ = ["promotions"] diff --git a/src/square/loyalty/programs/client.py b/src/square/loyalty/programs/client.py new file mode 100644 index 00000000..fc4010d5 --- /dev/null +++ b/src/square/loyalty/programs/client.py @@ -0,0 +1,367 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawProgramsClient +from .promotions.client import PromotionsClient +from ...core.request_options import RequestOptions +from ...types.list_loyalty_programs_response import ListLoyaltyProgramsResponse +from ...types.get_loyalty_program_response import GetLoyaltyProgramResponse +from ...requests.money import MoneyParams +from ...types.calculate_loyalty_points_response import CalculateLoyaltyPointsResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawProgramsClient +from .promotions.client import AsyncPromotionsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ProgramsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawProgramsClient(client_wrapper=client_wrapper) + self.promotions = PromotionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawProgramsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawProgramsClient + """ + return self._raw_client + + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListLoyaltyProgramsResponse: + """ + Returns a list of loyalty programs in the seller's account. + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + + Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListLoyaltyProgramsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.programs.list() + """ + response = self._raw_client.list(request_options=request_options) + return response.data + + def get( + self, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyProgramResponse: + """ + Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. + + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + Parameters + ---------- + program_id : str + The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyProgramResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.programs.get( + program_id="program_id", + ) + """ + response = self._raw_client.get(program_id, request_options=request_options) + return response.data + + def calculate( + self, + program_id: str, + *, + order_id: typing.Optional[str] = OMIT, + transaction_amount_money: typing.Optional[MoneyParams] = OMIT, + loyalty_account_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CalculateLoyaltyPointsResponse: + """ + Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint + to display the points to the buyer. + + - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. + Square reads the order to compute the points earned from the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). + + - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the + purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, + but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` + setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. + If the purchase qualifies for program points, call + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation + to calculate whether the purchase also qualifies for promotion points. For more information, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points. + + order_id : typing.Optional[str] + The [order](entity:Order) ID for which to calculate the points. + Specify this field if your application uses the Orders API to process orders. + Otherwise, specify the `transaction_amount_money`. + + transaction_amount_money : typing.Optional[MoneyParams] + The purchase amount for which to calculate the points. + Specify this field if your application does not use the Orders API to process orders. + Otherwise, specify the `order_id`. + + loyalty_account_id : typing.Optional[str] + The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field + if your application uses the Orders API to process orders. + + If specified, the `promotion_points` field in the response shows the number of points the buyer would + earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's + `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. + If not specified, the `promotion_points` field shows the number of points the purchase qualifies + for regardless of the trigger limit. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CalculateLoyaltyPointsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.programs.calculate( + program_id="program_id", + order_id="RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + loyalty_account_id="79b807d2-d786-46a9-933b-918028d7a8c5", + ) + """ + response = self._raw_client.calculate( + program_id, + order_id=order_id, + transaction_amount_money=transaction_amount_money, + loyalty_account_id=loyalty_account_id, + request_options=request_options, + ) + return response.data + + +class AsyncProgramsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawProgramsClient(client_wrapper=client_wrapper) + self.promotions = AsyncPromotionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawProgramsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawProgramsClient + """ + return self._raw_client + + async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListLoyaltyProgramsResponse: + """ + Returns a list of loyalty programs in the seller's account. + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + + Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListLoyaltyProgramsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.programs.list() + + + asyncio.run(main()) + """ + response = await self._raw_client.list(request_options=request_options) + return response.data + + async def get( + self, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyProgramResponse: + """ + Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. + + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + Parameters + ---------- + program_id : str + The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyProgramResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.programs.get( + program_id="program_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(program_id, request_options=request_options) + return response.data + + async def calculate( + self, + program_id: str, + *, + order_id: typing.Optional[str] = OMIT, + transaction_amount_money: typing.Optional[MoneyParams] = OMIT, + loyalty_account_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CalculateLoyaltyPointsResponse: + """ + Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint + to display the points to the buyer. + + - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. + Square reads the order to compute the points earned from the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). + + - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the + purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, + but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` + setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. + If the purchase qualifies for program points, call + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation + to calculate whether the purchase also qualifies for promotion points. For more information, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points. + + order_id : typing.Optional[str] + The [order](entity:Order) ID for which to calculate the points. + Specify this field if your application uses the Orders API to process orders. + Otherwise, specify the `transaction_amount_money`. + + transaction_amount_money : typing.Optional[MoneyParams] + The purchase amount for which to calculate the points. + Specify this field if your application does not use the Orders API to process orders. + Otherwise, specify the `order_id`. + + loyalty_account_id : typing.Optional[str] + The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field + if your application uses the Orders API to process orders. + + If specified, the `promotion_points` field in the response shows the number of points the buyer would + earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's + `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. + If not specified, the `promotion_points` field shows the number of points the purchase qualifies + for regardless of the trigger limit. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CalculateLoyaltyPointsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.programs.calculate( + program_id="program_id", + order_id="RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + loyalty_account_id="79b807d2-d786-46a9-933b-918028d7a8c5", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.calculate( + program_id, + order_id=order_id, + transaction_amount_money=transaction_amount_money, + loyalty_account_id=loyalty_account_id, + request_options=request_options, + ) + return response.data diff --git a/src/square/loyalty/programs/promotions/__init__.py b/src/square/loyalty/programs/promotions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/loyalty/programs/promotions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/loyalty/programs/promotions/client.py b/src/square/loyalty/programs/promotions/client.py new file mode 100644 index 00000000..c393ae4d --- /dev/null +++ b/src/square/loyalty/programs/promotions/client.py @@ -0,0 +1,582 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ....core.client_wrapper import SyncClientWrapper +from .raw_client import RawPromotionsClient +from ....types.loyalty_promotion_status import LoyaltyPromotionStatus +from ....core.request_options import RequestOptions +from ....core.pagination import SyncPager +from ....types.loyalty_promotion import LoyaltyPromotion +from ....core.jsonable_encoder import jsonable_encoder +from ....types.list_loyalty_promotions_response import ListLoyaltyPromotionsResponse +from ....core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ....core.api_error import ApiError +from ....requests.loyalty_promotion import LoyaltyPromotionParams +from ....types.create_loyalty_promotion_response import CreateLoyaltyPromotionResponse +from ....types.get_loyalty_promotion_response import GetLoyaltyPromotionResponse +from ....types.cancel_loyalty_promotion_response import CancelLoyaltyPromotionResponse +from ....core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawPromotionsClient +from ....core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class PromotionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawPromotionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawPromotionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawPromotionsClient + """ + return self._raw_client + + def list( + self, + program_id: str, + *, + status: typing.Optional[LoyaltyPromotionStatus] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[LoyaltyPromotion]: + """ + Lists the loyalty promotions associated with a [loyalty program](entity:LoyaltyProgram). + Results are sorted by the `created_at` date in descending order (newest to oldest). + + Parameters + ---------- + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, + call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + + status : typing.Optional[LoyaltyPromotionStatus] + The status to filter the results by. If a status is provided, only loyalty promotions + with the specified status are returned. Otherwise, all loyalty promotions associated with + the loyalty program are returned. + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. + The minimum value is 1 and the maximum value is 30. The default value is 30. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[LoyaltyPromotion] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.loyalty.programs.promotions.list( + program_id="program_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions", + method="GET", + params={ + "status": status, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLoyaltyPromotionsResponse, + construct_type( + type_=ListLoyaltyPromotionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + program_id, + status=status, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.loyalty_promotions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + program_id: str, + *, + loyalty_promotion: LoyaltyPromotionParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLoyaltyPromotionResponse: + """ + Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion + enables buyers to earn points in addition to those earned from the base loyalty program. + + This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the + `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an + `ACTIVE` or `SCHEDULED` status. + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. + To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + using the `main` keyword. + + loyalty_promotion : LoyaltyPromotionParams + The loyalty promotion to create. + + idempotency_key : str + A unique identifier for this request, which is used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLoyaltyPromotionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.programs.promotions.create( + program_id="program_id", + loyalty_promotion={ + "name": "Tuesday Happy Hour Promo", + "incentive": { + "type": "POINTS_MULTIPLIER", + "points_multiplier_data": {"multiplier": "3.0"}, + }, + "available_time": { + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "trigger_limit": {"times": 1, "interval": "DAY"}, + "minimum_spend_amount_money": {"amount": 2000, "currency": "USD"}, + "qualifying_category_ids": ["XTQPYLR3IIU9C44VRCB3XD12"], + }, + idempotency_key="ec78c477-b1c3-4899-a209-a4e71337c996", + ) + """ + response = self._raw_client.create( + program_id, + loyalty_promotion=loyalty_promotion, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def get( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyPromotionResponse: + """ + Retrieves a loyalty promotion. + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, + call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyPromotionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.programs.promotions.get( + promotion_id="promotion_id", + program_id="program_id", + ) + """ + response = self._raw_client.get(promotion_id, program_id, request_options=request_options) + return response.data + + def cancel( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelLoyaltyPromotionResponse: + """ + Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the + end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. + Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before + you create a new one. + + This endpoint sets the loyalty promotion to the `CANCELED` state + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a + promotion that has an `ACTIVE` or `SCHEDULED` status. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelLoyaltyPromotionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.programs.promotions.cancel( + promotion_id="promotion_id", + program_id="program_id", + ) + """ + response = self._raw_client.cancel(promotion_id, program_id, request_options=request_options) + return response.data + + +class AsyncPromotionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawPromotionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawPromotionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawPromotionsClient + """ + return self._raw_client + + async def list( + self, + program_id: str, + *, + status: typing.Optional[LoyaltyPromotionStatus] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[LoyaltyPromotion]: + """ + Lists the loyalty promotions associated with a [loyalty program](entity:LoyaltyProgram). + Results are sorted by the `created_at` date in descending order (newest to oldest). + + Parameters + ---------- + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, + call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + + status : typing.Optional[LoyaltyPromotionStatus] + The status to filter the results by. If a status is provided, only loyalty promotions + with the specified status are returned. Otherwise, all loyalty promotions associated with + the loyalty program are returned. + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. + The minimum value is 1 and the maximum value is 30. The default value is 30. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[LoyaltyPromotion] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.loyalty.programs.promotions.list( + program_id="program_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions", + method="GET", + params={ + "status": status, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListLoyaltyPromotionsResponse, + construct_type( + type_=ListLoyaltyPromotionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + program_id, + status=status, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.loyalty_promotions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + program_id: str, + *, + loyalty_promotion: LoyaltyPromotionParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLoyaltyPromotionResponse: + """ + Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion + enables buyers to earn points in addition to those earned from the base loyalty program. + + This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the + `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an + `ACTIVE` or `SCHEDULED` status. + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. + To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + using the `main` keyword. + + loyalty_promotion : LoyaltyPromotionParams + The loyalty promotion to create. + + idempotency_key : str + A unique identifier for this request, which is used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLoyaltyPromotionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.programs.promotions.create( + program_id="program_id", + loyalty_promotion={ + "name": "Tuesday Happy Hour Promo", + "incentive": { + "type": "POINTS_MULTIPLIER", + "points_multiplier_data": {"multiplier": "3.0"}, + }, + "available_time": { + "time_periods": [ + "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT" + ] + }, + "trigger_limit": {"times": 1, "interval": "DAY"}, + "minimum_spend_amount_money": {"amount": 2000, "currency": "USD"}, + "qualifying_category_ids": ["XTQPYLR3IIU9C44VRCB3XD12"], + }, + idempotency_key="ec78c477-b1c3-4899-a209-a4e71337c996", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + program_id, + loyalty_promotion=loyalty_promotion, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def get( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyPromotionResponse: + """ + Retrieves a loyalty promotion. + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, + call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyPromotionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.programs.promotions.get( + promotion_id="promotion_id", + program_id="program_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(promotion_id, program_id, request_options=request_options) + return response.data + + async def cancel( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelLoyaltyPromotionResponse: + """ + Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the + end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. + Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before + you create a new one. + + This endpoint sets the loyalty promotion to the `CANCELED` state + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a + promotion that has an `ACTIVE` or `SCHEDULED` status. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelLoyaltyPromotionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.programs.promotions.cancel( + promotion_id="promotion_id", + program_id="program_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(promotion_id, program_id, request_options=request_options) + return response.data diff --git a/src/square/loyalty/programs/promotions/raw_client.py b/src/square/loyalty/programs/promotions/raw_client.py new file mode 100644 index 00000000..54b4f37e --- /dev/null +++ b/src/square/loyalty/programs/promotions/raw_client.py @@ -0,0 +1,348 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ....core.client_wrapper import SyncClientWrapper +from ....requests.loyalty_promotion import LoyaltyPromotionParams +from ....core.request_options import RequestOptions +from ....core.http_response import HttpResponse +from ....types.create_loyalty_promotion_response import CreateLoyaltyPromotionResponse +from ....core.jsonable_encoder import jsonable_encoder +from ....core.serialization import convert_and_respect_annotation_metadata +from ....core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ....core.api_error import ApiError +from ....types.get_loyalty_promotion_response import GetLoyaltyPromotionResponse +from ....types.cancel_loyalty_promotion_response import CancelLoyaltyPromotionResponse +from ....core.client_wrapper import AsyncClientWrapper +from ....core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawPromotionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + program_id: str, + *, + loyalty_promotion: LoyaltyPromotionParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateLoyaltyPromotionResponse]: + """ + Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion + enables buyers to earn points in addition to those earned from the base loyalty program. + + This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the + `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an + `ACTIVE` or `SCHEDULED` status. + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. + To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + using the `main` keyword. + + loyalty_promotion : LoyaltyPromotionParams + The loyalty promotion to create. + + idempotency_key : str + A unique identifier for this request, which is used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateLoyaltyPromotionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions", + method="POST", + json={ + "loyalty_promotion": convert_and_respect_annotation_metadata( + object_=loyalty_promotion, annotation=LoyaltyPromotionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLoyaltyPromotionResponse, + construct_type( + type_=CreateLoyaltyPromotionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetLoyaltyPromotionResponse]: + """ + Retrieves a loyalty promotion. + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, + call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetLoyaltyPromotionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions/{jsonable_encoder(promotion_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyPromotionResponse, + construct_type( + type_=GetLoyaltyPromotionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelLoyaltyPromotionResponse]: + """ + Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the + end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. + Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before + you create a new one. + + This endpoint sets the loyalty promotion to the `CANCELED` state + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a + promotion that has an `ACTIVE` or `SCHEDULED` status. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelLoyaltyPromotionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions/{jsonable_encoder(promotion_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelLoyaltyPromotionResponse, + construct_type( + type_=CancelLoyaltyPromotionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawPromotionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + program_id: str, + *, + loyalty_promotion: LoyaltyPromotionParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateLoyaltyPromotionResponse]: + """ + Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion + enables buyers to earn points in addition to those earned from the base loyalty program. + + This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the + `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an + `ACTIVE` or `SCHEDULED` status. + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. + To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) + using the `main` keyword. + + loyalty_promotion : LoyaltyPromotionParams + The loyalty promotion to create. + + idempotency_key : str + A unique identifier for this request, which is used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateLoyaltyPromotionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions", + method="POST", + json={ + "loyalty_promotion": convert_and_respect_annotation_metadata( + object_=loyalty_promotion, annotation=LoyaltyPromotionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLoyaltyPromotionResponse, + construct_type( + type_=CreateLoyaltyPromotionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetLoyaltyPromotionResponse]: + """ + Retrieves a loyalty promotion. + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, + call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetLoyaltyPromotionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions/{jsonable_encoder(promotion_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyPromotionResponse, + construct_type( + type_=GetLoyaltyPromotionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, promotion_id: str, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelLoyaltyPromotionResponse]: + """ + Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the + end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. + Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before + you create a new one. + + This endpoint sets the loyalty promotion to the `CANCELED` state + + Parameters + ---------- + promotion_id : str + The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a + promotion that has an `ACTIVE` or `SCHEDULED` status. + + program_id : str + The ID of the base [loyalty program](entity:LoyaltyProgram). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelLoyaltyPromotionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/promotions/{jsonable_encoder(promotion_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelLoyaltyPromotionResponse, + construct_type( + type_=CancelLoyaltyPromotionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/loyalty/programs/raw_client.py b/src/square/loyalty/programs/raw_client.py new file mode 100644 index 00000000..e6e99950 --- /dev/null +++ b/src/square/loyalty/programs/raw_client.py @@ -0,0 +1,372 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.list_loyalty_programs_response import ListLoyaltyProgramsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_loyalty_program_response import GetLoyaltyProgramResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.money import MoneyParams +from ...types.calculate_loyalty_points_response import CalculateLoyaltyPointsResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawProgramsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ListLoyaltyProgramsResponse]: + """ + Returns a list of loyalty programs in the seller's account. + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + + Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListLoyaltyProgramsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/loyalty/programs", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListLoyaltyProgramsResponse, + construct_type( + type_=ListLoyaltyProgramsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetLoyaltyProgramResponse]: + """ + Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. + + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + Parameters + ---------- + program_id : str + The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetLoyaltyProgramResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyProgramResponse, + construct_type( + type_=GetLoyaltyProgramResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def calculate( + self, + program_id: str, + *, + order_id: typing.Optional[str] = OMIT, + transaction_amount_money: typing.Optional[MoneyParams] = OMIT, + loyalty_account_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CalculateLoyaltyPointsResponse]: + """ + Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint + to display the points to the buyer. + + - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. + Square reads the order to compute the points earned from the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). + + - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the + purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, + but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` + setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. + If the purchase qualifies for program points, call + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation + to calculate whether the purchase also qualifies for promotion points. For more information, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points. + + order_id : typing.Optional[str] + The [order](entity:Order) ID for which to calculate the points. + Specify this field if your application uses the Orders API to process orders. + Otherwise, specify the `transaction_amount_money`. + + transaction_amount_money : typing.Optional[MoneyParams] + The purchase amount for which to calculate the points. + Specify this field if your application does not use the Orders API to process orders. + Otherwise, specify the `order_id`. + + loyalty_account_id : typing.Optional[str] + The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field + if your application uses the Orders API to process orders. + + If specified, the `promotion_points` field in the response shows the number of points the buyer would + earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's + `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. + If not specified, the `promotion_points` field shows the number of points the purchase qualifies + for regardless of the trigger limit. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CalculateLoyaltyPointsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/calculate", + method="POST", + json={ + "order_id": order_id, + "transaction_amount_money": convert_and_respect_annotation_metadata( + object_=transaction_amount_money, annotation=MoneyParams, direction="write" + ), + "loyalty_account_id": loyalty_account_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CalculateLoyaltyPointsResponse, + construct_type( + type_=CalculateLoyaltyPointsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawProgramsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ListLoyaltyProgramsResponse]: + """ + Returns a list of loyalty programs in the seller's account. + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + + Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListLoyaltyProgramsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/loyalty/programs", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListLoyaltyProgramsResponse, + construct_type( + type_=ListLoyaltyProgramsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, program_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetLoyaltyProgramResponse]: + """ + Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. + + Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + + Parameters + ---------- + program_id : str + The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetLoyaltyProgramResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyProgramResponse, + construct_type( + type_=GetLoyaltyProgramResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def calculate( + self, + program_id: str, + *, + order_id: typing.Optional[str] = OMIT, + transaction_amount_money: typing.Optional[MoneyParams] = OMIT, + loyalty_account_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CalculateLoyaltyPointsResponse]: + """ + Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint + to display the points to the buyer. + + - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. + Square reads the order to compute the points earned from the base loyalty program and an associated + [loyalty promotion](entity:LoyaltyPromotion). + + - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the + purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, + but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` + setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. + If the purchase qualifies for program points, call + [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation + to calculate whether the purchase also qualifies for promotion points. For more information, see + [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points). + + Parameters + ---------- + program_id : str + The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points. + + order_id : typing.Optional[str] + The [order](entity:Order) ID for which to calculate the points. + Specify this field if your application uses the Orders API to process orders. + Otherwise, specify the `transaction_amount_money`. + + transaction_amount_money : typing.Optional[MoneyParams] + The purchase amount for which to calculate the points. + Specify this field if your application does not use the Orders API to process orders. + Otherwise, specify the `order_id`. + + loyalty_account_id : typing.Optional[str] + The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field + if your application uses the Orders API to process orders. + + If specified, the `promotion_points` field in the response shows the number of points the buyer would + earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's + `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. + If not specified, the `promotion_points` field shows the number of points the purchase qualifies + for regardless of the trigger limit. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CalculateLoyaltyPointsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/programs/{jsonable_encoder(program_id)}/calculate", + method="POST", + json={ + "order_id": order_id, + "transaction_amount_money": convert_and_respect_annotation_metadata( + object_=transaction_amount_money, annotation=MoneyParams, direction="write" + ), + "loyalty_account_id": loyalty_account_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CalculateLoyaltyPointsResponse, + construct_type( + type_=CalculateLoyaltyPointsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/loyalty/raw_client.py b/src/square/loyalty/raw_client.py new file mode 100644 index 00000000..2fb9fde2 --- /dev/null +++ b/src/square/loyalty/raw_client.py @@ -0,0 +1,177 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.loyalty_event_query import LoyaltyEventQueryParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.search_loyalty_events_response import SearchLoyaltyEventsResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawLoyaltyClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def search_events( + self, + *, + query: typing.Optional[LoyaltyEventQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchLoyaltyEventsResponse]: + """ + Searches for loyalty events. + + A Square loyalty program maintains a ledger of events that occur during the lifetime of a + buyer's loyalty account. Each change in the point balance + (for example, points earned, points redeemed, and points expired) is + recorded in the ledger. Using this endpoint, you can search the ledger for events. + + Search results are sorted by `created_at` in descending order. + + Parameters + ---------- + query : typing.Optional[LoyaltyEventQueryParams] + A set of one or more predefined query filters to apply when + searching for loyalty events. The endpoint performs a logical AND to + evaluate multiple filters and performs a logical OR on arrays + that specifies multiple field values. + + limit : typing.Optional[int] + The maximum number of results to include in the response. + The last page might contain fewer events. + The default is 30 events. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchLoyaltyEventsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/loyalty/events/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=LoyaltyEventQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchLoyaltyEventsResponse, + construct_type( + type_=SearchLoyaltyEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawLoyaltyClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def search_events( + self, + *, + query: typing.Optional[LoyaltyEventQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchLoyaltyEventsResponse]: + """ + Searches for loyalty events. + + A Square loyalty program maintains a ledger of events that occur during the lifetime of a + buyer's loyalty account. Each change in the point balance + (for example, points earned, points redeemed, and points expired) is + recorded in the ledger. Using this endpoint, you can search the ledger for events. + + Search results are sorted by `created_at` in descending order. + + Parameters + ---------- + query : typing.Optional[LoyaltyEventQueryParams] + A set of one or more predefined query filters to apply when + searching for loyalty events. The endpoint performs a logical AND to + evaluate multiple filters and performs a logical OR on arrays + that specifies multiple field values. + + limit : typing.Optional[int] + The maximum number of results to include in the response. + The last page might contain fewer events. + The default is 30 events. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchLoyaltyEventsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/loyalty/events/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=LoyaltyEventQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchLoyaltyEventsResponse, + construct_type( + type_=SearchLoyaltyEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/loyalty/rewards/__init__.py b/src/square/loyalty/rewards/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/loyalty/rewards/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/loyalty/rewards/client.py b/src/square/loyalty/rewards/client.py new file mode 100644 index 00000000..5c0449e4 --- /dev/null +++ b/src/square/loyalty/rewards/client.py @@ -0,0 +1,582 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawRewardsClient +from ...requests.loyalty_reward import LoyaltyRewardParams +from ...core.request_options import RequestOptions +from ...types.create_loyalty_reward_response import CreateLoyaltyRewardResponse +from ...requests.search_loyalty_rewards_request_loyalty_reward_query import ( + SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams, +) +from ...types.search_loyalty_rewards_response import SearchLoyaltyRewardsResponse +from ...types.get_loyalty_reward_response import GetLoyaltyRewardResponse +from ...types.delete_loyalty_reward_response import DeleteLoyaltyRewardResponse +from ...types.redeem_loyalty_reward_response import RedeemLoyaltyRewardResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawRewardsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RewardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawRewardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawRewardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawRewardsClient + """ + return self._raw_client + + def create( + self, + *, + reward: LoyaltyRewardParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLoyaltyRewardResponse: + """ + Creates a loyalty reward. In the process, the endpoint does following: + + - Uses the `reward_tier_id` in the request to determine the number of points + to lock for this reward. + - If the request includes `order_id`, it adds the reward and related discount to the order. + + After a reward is created, the points are locked and + not available for the buyer to redeem another reward. + + Parameters + ---------- + reward : LoyaltyRewardParams + The reward to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLoyaltyRewardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.rewards.create( + reward={ + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + }, + idempotency_key="18c2e5ea-a620-4b1f-ad60-7b167285e451", + ) + """ + response = self._raw_client.create( + reward=reward, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchLoyaltyRewardsResponse: + """ + Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. + If you include a `query` object, `loyalty_account_id` is required and `status` is optional. + + If you know a reward ID, use the + [RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint. + + Search results are sorted by `updated_at` in descending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] + The search criteria for the request. + If empty, the endpoint retrieves all loyalty rewards in the loyalty program. + + limit : typing.Optional[int] + The maximum number of results to return in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchLoyaltyRewardsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.rewards.search( + query={"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd"}, + limit=10, + ) + """ + response = self._raw_client.search(query=query, limit=limit, cursor=cursor, request_options=request_options) + return response.data + + def get( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyRewardResponse: + """ + Retrieves a loyalty reward. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyRewardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.rewards.get( + reward_id="reward_id", + ) + """ + response = self._raw_client.get(reward_id, request_options=request_options) + return response.data + + def delete( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteLoyaltyRewardResponse: + """ + Deletes a loyalty reward by doing the following: + + - Returns the loyalty points back to the loyalty account. + - If an order ID was specified when the reward was created + (see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)), + it updates the order by removing the reward and related + discounts. + + You cannot delete a reward that has reached the terminal state (REDEEMED). + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteLoyaltyRewardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.rewards.delete( + reward_id="reward_id", + ) + """ + response = self._raw_client.delete(reward_id, request_options=request_options) + return response.data + + def redeem( + self, + reward_id: str, + *, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> RedeemLoyaltyRewardResponse: + """ + Redeems a loyalty reward. + + The endpoint sets the reward to the `REDEEMED` terminal state. + + If you are using your own order processing system (not using the + Orders API), you call this endpoint after the buyer paid for the + purchase. + + After the reward reaches the terminal state, it cannot be deleted. + In other words, points used for the reward cannot be returned + to the account. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. + + idempotency_key : str + A unique string that identifies this `RedeemLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + location_id : str + The ID of the [location](entity:Location) where the reward is redeemed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RedeemLoyaltyRewardResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.loyalty.rewards.redeem( + reward_id="reward_id", + idempotency_key="98adc7f7-6963-473b-b29c-f3c9cdd7d994", + location_id="P034NEENMD09F", + ) + """ + response = self._raw_client.redeem( + reward_id, idempotency_key=idempotency_key, location_id=location_id, request_options=request_options + ) + return response.data + + +class AsyncRewardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawRewardsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawRewardsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawRewardsClient + """ + return self._raw_client + + async def create( + self, + *, + reward: LoyaltyRewardParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateLoyaltyRewardResponse: + """ + Creates a loyalty reward. In the process, the endpoint does following: + + - Uses the `reward_tier_id` in the request to determine the number of points + to lock for this reward. + - If the request includes `order_id`, it adds the reward and related discount to the order. + + After a reward is created, the points are locked and + not available for the buyer to redeem another reward. + + Parameters + ---------- + reward : LoyaltyRewardParams + The reward to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateLoyaltyRewardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.rewards.create( + reward={ + "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", + "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", + "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", + }, + idempotency_key="18c2e5ea-a620-4b1f-ad60-7b167285e451", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + reward=reward, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchLoyaltyRewardsResponse: + """ + Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. + If you include a `query` object, `loyalty_account_id` is required and `status` is optional. + + If you know a reward ID, use the + [RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint. + + Search results are sorted by `updated_at` in descending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] + The search criteria for the request. + If empty, the endpoint retrieves all loyalty rewards in the loyalty program. + + limit : typing.Optional[int] + The maximum number of results to return in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchLoyaltyRewardsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.rewards.search( + query={"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd"}, + limit=10, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data + + async def get( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetLoyaltyRewardResponse: + """ + Retrieves a loyalty reward. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetLoyaltyRewardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.rewards.get( + reward_id="reward_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(reward_id, request_options=request_options) + return response.data + + async def delete( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteLoyaltyRewardResponse: + """ + Deletes a loyalty reward by doing the following: + + - Returns the loyalty points back to the loyalty account. + - If an order ID was specified when the reward was created + (see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)), + it updates the order by removing the reward and related + discounts. + + You cannot delete a reward that has reached the terminal state (REDEEMED). + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteLoyaltyRewardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.rewards.delete( + reward_id="reward_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(reward_id, request_options=request_options) + return response.data + + async def redeem( + self, + reward_id: str, + *, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> RedeemLoyaltyRewardResponse: + """ + Redeems a loyalty reward. + + The endpoint sets the reward to the `REDEEMED` terminal state. + + If you are using your own order processing system (not using the + Orders API), you call this endpoint after the buyer paid for the + purchase. + + After the reward reaches the terminal state, it cannot be deleted. + In other words, points used for the reward cannot be returned + to the account. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. + + idempotency_key : str + A unique string that identifies this `RedeemLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + location_id : str + The ID of the [location](entity:Location) where the reward is redeemed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RedeemLoyaltyRewardResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.loyalty.rewards.redeem( + reward_id="reward_id", + idempotency_key="98adc7f7-6963-473b-b29c-f3c9cdd7d994", + location_id="P034NEENMD09F", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.redeem( + reward_id, idempotency_key=idempotency_key, location_id=location_id, request_options=request_options + ) + return response.data diff --git a/src/square/loyalty/rewards/raw_client.py b/src/square/loyalty/rewards/raw_client.py new file mode 100644 index 00000000..5d2fbca8 --- /dev/null +++ b/src/square/loyalty/rewards/raw_client.py @@ -0,0 +1,617 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.loyalty_reward import LoyaltyRewardParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_loyalty_reward_response import CreateLoyaltyRewardResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.search_loyalty_rewards_request_loyalty_reward_query import ( + SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams, +) +from ...types.search_loyalty_rewards_response import SearchLoyaltyRewardsResponse +from ...types.get_loyalty_reward_response import GetLoyaltyRewardResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.delete_loyalty_reward_response import DeleteLoyaltyRewardResponse +from ...types.redeem_loyalty_reward_response import RedeemLoyaltyRewardResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawRewardsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + reward: LoyaltyRewardParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateLoyaltyRewardResponse]: + """ + Creates a loyalty reward. In the process, the endpoint does following: + + - Uses the `reward_tier_id` in the request to determine the number of points + to lock for this reward. + - If the request includes `order_id`, it adds the reward and related discount to the order. + + After a reward is created, the points are locked and + not available for the buyer to redeem another reward. + + Parameters + ---------- + reward : LoyaltyRewardParams + The reward to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateLoyaltyRewardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/loyalty/rewards", + method="POST", + json={ + "reward": convert_and_respect_annotation_metadata( + object_=reward, annotation=LoyaltyRewardParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLoyaltyRewardResponse, + construct_type( + type_=CreateLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchLoyaltyRewardsResponse]: + """ + Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. + If you include a `query` object, `loyalty_account_id` is required and `status` is optional. + + If you know a reward ID, use the + [RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint. + + Search results are sorted by `updated_at` in descending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] + The search criteria for the request. + If empty, the endpoint retrieves all loyalty rewards in the loyalty program. + + limit : typing.Optional[int] + The maximum number of results to return in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchLoyaltyRewardsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/loyalty/rewards/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchLoyaltyRewardsResponse, + construct_type( + type_=SearchLoyaltyRewardsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetLoyaltyRewardResponse]: + """ + Retrieves a loyalty reward. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetLoyaltyRewardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/rewards/{jsonable_encoder(reward_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyRewardResponse, + construct_type( + type_=GetLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteLoyaltyRewardResponse]: + """ + Deletes a loyalty reward by doing the following: + + - Returns the loyalty points back to the loyalty account. + - If an order ID was specified when the reward was created + (see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)), + it updates the order by removing the reward and related + discounts. + + You cannot delete a reward that has reached the terminal state (REDEEMED). + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteLoyaltyRewardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/rewards/{jsonable_encoder(reward_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteLoyaltyRewardResponse, + construct_type( + type_=DeleteLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def redeem( + self, + reward_id: str, + *, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RedeemLoyaltyRewardResponse]: + """ + Redeems a loyalty reward. + + The endpoint sets the reward to the `REDEEMED` terminal state. + + If you are using your own order processing system (not using the + Orders API), you call this endpoint after the buyer paid for the + purchase. + + After the reward reaches the terminal state, it cannot be deleted. + In other words, points used for the reward cannot be returned + to the account. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. + + idempotency_key : str + A unique string that identifies this `RedeemLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + location_id : str + The ID of the [location](entity:Location) where the reward is redeemed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RedeemLoyaltyRewardResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/loyalty/rewards/{jsonable_encoder(reward_id)}/redeem", + method="POST", + json={ + "idempotency_key": idempotency_key, + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RedeemLoyaltyRewardResponse, + construct_type( + type_=RedeemLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawRewardsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + reward: LoyaltyRewardParams, + idempotency_key: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateLoyaltyRewardResponse]: + """ + Creates a loyalty reward. In the process, the endpoint does following: + + - Uses the `reward_tier_id` in the request to determine the number of points + to lock for this reward. + - If the request includes `order_id`, it adds the reward and related discount to the order. + + After a reward is created, the points are locked and + not available for the buyer to redeem another reward. + + Parameters + ---------- + reward : LoyaltyRewardParams + The reward to create. + + idempotency_key : str + A unique string that identifies this `CreateLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateLoyaltyRewardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/loyalty/rewards", + method="POST", + json={ + "reward": convert_and_respect_annotation_metadata( + object_=reward, annotation=LoyaltyRewardParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateLoyaltyRewardResponse, + construct_type( + type_=CreateLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchLoyaltyRewardsResponse]: + """ + Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. + If you include a `query` object, `loyalty_account_id` is required and `status` is optional. + + If you know a reward ID, use the + [RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint. + + Search results are sorted by `updated_at` in descending order. + + Parameters + ---------- + query : typing.Optional[SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams] + The search criteria for the request. + If empty, the endpoint retrieves all loyalty rewards in the loyalty program. + + limit : typing.Optional[int] + The maximum number of results to return in the response. The default value is 30. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to + this endpoint. Provide this to retrieve the next set of + results for the original query. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchLoyaltyRewardsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/loyalty/rewards/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchLoyaltyRewardsResponse, + construct_type( + type_=SearchLoyaltyRewardsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetLoyaltyRewardResponse]: + """ + Retrieves a loyalty reward. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetLoyaltyRewardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/rewards/{jsonable_encoder(reward_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetLoyaltyRewardResponse, + construct_type( + type_=GetLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, reward_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteLoyaltyRewardResponse]: + """ + Deletes a loyalty reward by doing the following: + + - Returns the loyalty points back to the loyalty account. + - If an order ID was specified when the reward was created + (see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)), + it updates the order by removing the reward and related + discounts. + + You cannot delete a reward that has reached the terminal state (REDEEMED). + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteLoyaltyRewardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/rewards/{jsonable_encoder(reward_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteLoyaltyRewardResponse, + construct_type( + type_=DeleteLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def redeem( + self, + reward_id: str, + *, + idempotency_key: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RedeemLoyaltyRewardResponse]: + """ + Redeems a loyalty reward. + + The endpoint sets the reward to the `REDEEMED` terminal state. + + If you are using your own order processing system (not using the + Orders API), you call this endpoint after the buyer paid for the + purchase. + + After the reward reaches the terminal state, it cannot be deleted. + In other words, points used for the reward cannot be returned + to the account. + + Parameters + ---------- + reward_id : str + The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. + + idempotency_key : str + A unique string that identifies this `RedeemLoyaltyReward` request. + Keys can be any valid string, but must be unique for every request. + + location_id : str + The ID of the [location](entity:Location) where the reward is redeemed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RedeemLoyaltyRewardResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/loyalty/rewards/{jsonable_encoder(reward_id)}/redeem", + method="POST", + json={ + "idempotency_key": idempotency_key, + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RedeemLoyaltyRewardResponse, + construct_type( + type_=RedeemLoyaltyRewardResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/merchants/__init__.py b/src/square/merchants/__init__.py new file mode 100644 index 00000000..cbf84df6 --- /dev/null +++ b/src/square/merchants/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import custom_attribute_definitions, custom_attributes + +__all__ = ["custom_attribute_definitions", "custom_attributes"] diff --git a/src/square/merchants/client.py b/src/square/merchants/client.py new file mode 100644 index 00000000..1eae1070 --- /dev/null +++ b/src/square/merchants/client.py @@ -0,0 +1,284 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawMerchantsClient +from .custom_attribute_definitions.client import CustomAttributeDefinitionsClient +from .custom_attributes.client import CustomAttributesClient +import typing +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.merchant import Merchant +from ..types.list_merchants_response import ListMerchantsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_merchant_response import GetMerchantResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawMerchantsClient +from .custom_attribute_definitions.client import AsyncCustomAttributeDefinitionsClient +from .custom_attributes.client import AsyncCustomAttributesClient +from ..core.pagination import AsyncPager + + +class MerchantsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawMerchantsClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = CustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = CustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawMerchantsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawMerchantsClient + """ + return self._raw_client + + def list( + self, *, cursor: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> SyncPager[Merchant]: + """ + Provides details about the merchant associated with a given access token. + + The access token used to connect your application to a Square seller is associated + with a single merchant. That means that `ListMerchants` returns a list + with a single `Merchant` object. You can specify your personal access token + to get your own merchant information or specify an OAuth token to get the + information for the merchant that granted your application access. + + If you know the merchant ID, you can also use the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) + endpoint to retrieve the merchant information. + + Parameters + ---------- + cursor : typing.Optional[int] + The cursor generated by the previous response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Merchant] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.merchants.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/merchants", + method="GET", + params={ + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListMerchantsResponse, + construct_type( + type_=ListMerchantsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.merchant + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, merchant_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetMerchantResponse: + """ + Retrieves the `Merchant` object for the given `merchant_id`. + + Parameters + ---------- + merchant_id : str + The ID of the merchant to retrieve. If the string "me" is supplied as the ID, + then retrieve the merchant that is currently accessible to this call. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetMerchantResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.get( + merchant_id="merchant_id", + ) + """ + response = self._raw_client.get(merchant_id, request_options=request_options) + return response.data + + +class AsyncMerchantsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawMerchantsClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = AsyncCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = AsyncCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawMerchantsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawMerchantsClient + """ + return self._raw_client + + async def list( + self, *, cursor: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncPager[Merchant]: + """ + Provides details about the merchant associated with a given access token. + + The access token used to connect your application to a Square seller is associated + with a single merchant. That means that `ListMerchants` returns a list + with a single `Merchant` object. You can specify your personal access token + to get your own merchant information or specify an OAuth token to get the + information for the merchant that granted your application access. + + If you know the merchant ID, you can also use the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) + endpoint to retrieve the merchant information. + + Parameters + ---------- + cursor : typing.Optional[int] + The cursor generated by the previous response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Merchant] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.merchants.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/merchants", + method="GET", + params={ + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListMerchantsResponse, + construct_type( + type_=ListMerchantsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.merchant + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, merchant_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetMerchantResponse: + """ + Retrieves the `Merchant` object for the given `merchant_id`. + + Parameters + ---------- + merchant_id : str + The ID of the merchant to retrieve. If the string "me" is supplied as the ID, + then retrieve the merchant that is currently accessible to this call. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetMerchantResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.get( + merchant_id="merchant_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(merchant_id, request_options=request_options) + return response.data diff --git a/src/square/merchants/custom_attribute_definitions/__init__.py b/src/square/merchants/custom_attribute_definitions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/merchants/custom_attribute_definitions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/merchants/custom_attribute_definitions/client.py b/src/square/merchants/custom_attribute_definitions/client.py new file mode 100644 index 00000000..f8d0d440 --- /dev/null +++ b/src/square/merchants/custom_attribute_definitions/client.py @@ -0,0 +1,694 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributeDefinitionsClient +from ...types.visibility_filter import VisibilityFilter +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.custom_attribute_definition import CustomAttributeDefinition +from ...types.list_merchant_custom_attribute_definitions_response import ListMerchantCustomAttributeDefinitionsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...types.create_merchant_custom_attribute_definition_response import ( + CreateMerchantCustomAttributeDefinitionResponse, +) +from ...types.retrieve_merchant_custom_attribute_definition_response import ( + RetrieveMerchantCustomAttributeDefinitionResponse, +) +from ...types.update_merchant_custom_attribute_definition_response import ( + UpdateMerchantCustomAttributeDefinitionResponse, +) +from ...types.delete_merchant_custom_attribute_definition_response import ( + DeleteMerchantCustomAttributeDefinitionResponse, +) +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributeDefinitionsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributeDefinitionsClient + """ + return self._raw_client + + def list( + self, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttributeDefinition]: + """ + Lists the merchant-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.merchants.custom_attribute_definitions.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/merchants/custom-attribute-definitions", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListMerchantCustomAttributeDefinitionsResponse, + construct_type( + type_=ListMerchantCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateMerchantCustomAttributeDefinitionResponse: + """ + Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) or + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + to set the custom attribute for a merchant. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "alternative_seller_name", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Alternative Merchant Name", + "description": "This is the other name this merchant goes by.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + """ + response = self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveMerchantCustomAttributeDefinitionResponse: + """ + Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attribute_definitions.get( + key="key", + ) + """ + response = self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateMerchantCustomAttributeDefinitionResponse: + """ + Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + For more information, see + [Update a merchant custom attribute definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + """ + response = self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteMerchantCustomAttributeDefinitionResponse: + """ + Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + the merchant. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attribute_definitions.delete( + key="key", + ) + """ + response = self._raw_client.delete(key, request_options=request_options) + return response.data + + +class AsyncCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributeDefinitionsClient + """ + return self._raw_client + + async def list( + self, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttributeDefinition]: + """ + Lists the merchant-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.merchants.custom_attribute_definitions.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/merchants/custom-attribute-definitions", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListMerchantCustomAttributeDefinitionsResponse, + construct_type( + type_=ListMerchantCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateMerchantCustomAttributeDefinitionResponse: + """ + Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) or + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + to set the custom attribute for a merchant. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "alternative_seller_name", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + "name": "Alternative Merchant Name", + "description": "This is the other name this merchant goes by.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveMerchantCustomAttributeDefinitionResponse: + """ + Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attribute_definitions.get( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateMerchantCustomAttributeDefinitionResponse: + """ + Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + For more information, see + [Update a merchant custom attribute definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "description": "Update the description as desired.", + "visibility": "VISIBILITY_READ_ONLY", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteMerchantCustomAttributeDefinitionResponse: + """ + Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + the merchant. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteMerchantCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attribute_definitions.delete( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(key, request_options=request_options) + return response.data diff --git a/src/square/merchants/custom_attribute_definitions/raw_client.py b/src/square/merchants/custom_attribute_definitions/raw_client.py new file mode 100644 index 00000000..6f1e08b3 --- /dev/null +++ b/src/square/merchants/custom_attribute_definitions/raw_client.py @@ -0,0 +1,511 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_merchant_custom_attribute_definition_response import ( + CreateMerchantCustomAttributeDefinitionResponse, +) +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_merchant_custom_attribute_definition_response import ( + RetrieveMerchantCustomAttributeDefinitionResponse, +) +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_merchant_custom_attribute_definition_response import ( + UpdateMerchantCustomAttributeDefinitionResponse, +) +from ...types.delete_merchant_custom_attribute_definition_response import ( + DeleteMerchantCustomAttributeDefinitionResponse, +) +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateMerchantCustomAttributeDefinitionResponse]: + """ + Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) or + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + to set the custom attribute for a merchant. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/merchants/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=CreateMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveMerchantCustomAttributeDefinitionResponse]: + """ + Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateMerchantCustomAttributeDefinitionResponse]: + """ + Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + For more information, see + [Update a merchant custom attribute definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteMerchantCustomAttributeDefinitionResponse]: + """ + Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + the merchant. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateMerchantCustomAttributeDefinitionResponse]: + """ + Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. + A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties + for a custom attribute. After the definition is created, you can call + [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) or + [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + to set the custom attribute for a merchant. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - `name` is required unless `visibility` is set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/merchants/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=CreateMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveMerchantCustomAttributeDefinitionResponse]: + """ + Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. If the requesting application + is not the definition owner, you must use the qualified key. + + version : typing.Optional[int] + The current version of the custom attribute definition, which is used for strongly consistent + reads to guarantee that you receive the most up-to-date data. When included in the request, + Square returns the specified version or a higher version if one exists. If the specified version + is higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateMerchantCustomAttributeDefinitionResponse]: + """ + Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. + Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the + `schema` for a `Selection` data type. + Only the definition owner can update a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint + supports sparse updates, so only new or changed fields need to be included in the request. + Only the following fields can be updated: + - `name` + - `description` + - `visibility` + - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed + selections are supported. + For more information, see + [Update a merchant custom attribute definition](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions#update-custom-attribute-definition). + The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteMerchantCustomAttributeDefinitionResponse]: + """ + Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + Deleting a custom attribute definition also deletes the corresponding custom attribute from + the merchant. + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteMerchantCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteMerchantCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteMerchantCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/merchants/custom_attributes/__init__.py b/src/square/merchants/custom_attributes/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/merchants/custom_attributes/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/merchants/custom_attributes/client.py b/src/square/merchants/custom_attributes/client.py new file mode 100644 index 00000000..2619d72a --- /dev/null +++ b/src/square/merchants/custom_attributes/client.py @@ -0,0 +1,862 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributesClient +from ...requests.bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request import ( + BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams, +) +from ...core.request_options import RequestOptions +from ...types.bulk_delete_merchant_custom_attributes_response import BulkDeleteMerchantCustomAttributesResponse +from ...requests.bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request import ( + BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams, +) +from ...types.bulk_upsert_merchant_custom_attributes_response import BulkUpsertMerchantCustomAttributesResponse +from ...types.visibility_filter import VisibilityFilter +from ...core.pagination import SyncPager +from ...types.custom_attribute import CustomAttribute +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_merchant_custom_attributes_response import ListMerchantCustomAttributesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_merchant_custom_attribute_response import RetrieveMerchantCustomAttributeResponse +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_merchant_custom_attribute_response import UpsertMerchantCustomAttributeResponse +from ...types.delete_merchant_custom_attribute_response import DeleteMerchantCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributesClient + """ + return self._raw_client + + def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteMerchantCustomAttributesResponse: + """ + Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteMerchantCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attributes.batch_delete( + values={ + "id1": {"key": "alternative_seller_name"}, + "id2": {"key": "has_seen_tutorial"}, + }, + ) + """ + response = self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertMerchantCustomAttributesResponse: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for a merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a merchant ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertMerchantCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attributes.batch_upsert( + values={ + "id1": { + "merchant_id": "DM7VKY8Q63GNP", + "custom_attribute": { + "key": "alternative_seller_name", + "value": "Ultimate Sneaker Store", + }, + }, + "id2": { + "merchant_id": "DM7VKY8Q63GNP", + "custom_attribute": {"key": "has_seen_tutorial", "value": True}, + }, + }, + ) + """ + response = self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + def list( + self, + merchant_id: str, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with a merchant. + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttribute] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.merchants.custom_attributes.list( + merchant_id="merchant_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListMerchantCustomAttributesResponse, + construct_type( + type_=ListMerchantCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + merchant_id, + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + merchant_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveMerchantCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveMerchantCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attributes.get( + merchant_id="merchant_id", + key="key", + ) + """ + response = self._raw_client.get( + merchant_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + def upsert( + self, + merchant_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertMerchantCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant. + Use this endpoint to set the value of a custom attribute for a specified merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertMerchantCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attributes.upsert( + merchant_id="merchant_id", + key="key", + custom_attribute={"value": "Ultimate Sneaker Store"}, + ) + """ + response = self._raw_client.upsert( + merchant_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, merchant_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteMerchantCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteMerchantCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.merchants.custom_attributes.delete( + merchant_id="merchant_id", + key="key", + ) + """ + response = self._raw_client.delete(merchant_id, key, request_options=request_options) + return response.data + + +class AsyncCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributesClient + """ + return self._raw_client + + async def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteMerchantCustomAttributesResponse: + """ + Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteMerchantCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attributes.batch_delete( + values={ + "id1": {"key": "alternative_seller_name"}, + "id2": {"key": "has_seen_tutorial"}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertMerchantCustomAttributesResponse: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for a merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a merchant ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertMerchantCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attributes.batch_upsert( + values={ + "id1": { + "merchant_id": "DM7VKY8Q63GNP", + "custom_attribute": { + "key": "alternative_seller_name", + "value": "Ultimate Sneaker Store", + }, + }, + "id2": { + "merchant_id": "DM7VKY8Q63GNP", + "custom_attribute": {"key": "has_seen_tutorial", "value": True}, + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + async def list( + self, + merchant_id: str, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + limit: typing.Optional[int] = None, + cursor: typing.Optional[str] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with a merchant. + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + visibility_filter : typing.Optional[VisibilityFilter] + Filters the `CustomAttributeDefinition` results by their `visibility` values. + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. For more + information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom + attribute, information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttribute] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.merchants.custom_attributes.list( + merchant_id="merchant_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes", + method="GET", + params={ + "visibility_filter": visibility_filter, + "limit": limit, + "cursor": cursor, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListMerchantCustomAttributesResponse, + construct_type( + type_=ListMerchantCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + merchant_id, + visibility_filter=visibility_filter, + limit=limit, + cursor=_parsed_next, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + merchant_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveMerchantCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveMerchantCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attributes.get( + merchant_id="merchant_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get( + merchant_id, key, with_definition=with_definition, version=version, request_options=request_options + ) + return response.data + + async def upsert( + self, + merchant_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertMerchantCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant. + Use this endpoint to set the value of a custom attribute for a specified merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertMerchantCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attributes.upsert( + merchant_id="merchant_id", + key="key", + custom_attribute={"value": "Ultimate Sneaker Store"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert( + merchant_id, + key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, merchant_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteMerchantCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteMerchantCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.merchants.custom_attributes.delete( + merchant_id="merchant_id", + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(merchant_id, key, request_options=request_options) + return response.data diff --git a/src/square/merchants/custom_attributes/raw_client.py b/src/square/merchants/custom_attributes/raw_client.py new file mode 100644 index 00000000..eb44aad3 --- /dev/null +++ b/src/square/merchants/custom_attributes/raw_client.py @@ -0,0 +1,670 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request import ( + BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams, +) +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.bulk_delete_merchant_custom_attributes_response import BulkDeleteMerchantCustomAttributesResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request import ( + BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams, +) +from ...types.bulk_upsert_merchant_custom_attributes_response import BulkUpsertMerchantCustomAttributesResponse +from ...types.retrieve_merchant_custom_attribute_response import RetrieveMerchantCustomAttributeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_merchant_custom_attribute_response import UpsertMerchantCustomAttributeResponse +from ...types.delete_merchant_custom_attribute_response import DeleteMerchantCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkDeleteMerchantCustomAttributesResponse]: + """ + Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkDeleteMerchantCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/merchants/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteMerchantCustomAttributesResponse, + construct_type( + type_=BulkDeleteMerchantCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkUpsertMerchantCustomAttributesResponse]: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for a merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a merchant ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkUpsertMerchantCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/merchants/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertMerchantCustomAttributesResponse, + construct_type( + type_=BulkUpsertMerchantCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + merchant_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RetrieveMerchantCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveMerchantCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveMerchantCustomAttributeResponse, + construct_type( + type_=RetrieveMerchantCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def upsert( + self, + merchant_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpsertMerchantCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant. + Use this endpoint to set the value of a custom attribute for a specified merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertMerchantCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes/{jsonable_encoder(key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertMerchantCustomAttributeResponse, + construct_type( + type_=UpsertMerchantCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, merchant_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteMerchantCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteMerchantCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteMerchantCustomAttributeResponse, + construct_type( + type_=DeleteMerchantCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkDeleteMerchantCustomAttributesResponse]: + """ + Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams] + The data used to update the `CustomAttribute` objects. + The keys must be unique and are used to map to the corresponding response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkDeleteMerchantCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/merchants/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteMerchantCustomAttributesResponse, + construct_type( + type_=BulkDeleteMerchantCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkUpsertMerchantCustomAttributesResponse]: + """ + Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation. + Use this endpoint to set the value of one or more custom attributes for a merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which is + created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides a merchant ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams] + A map containing 1 to 25 individual upsert requests. For each request, provide an + arbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the + information needed to create or update a custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkUpsertMerchantCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/merchants/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[ + str, BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams + ], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertMerchantCustomAttributesResponse, + construct_type( + type_=BulkUpsertMerchantCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + merchant_id: str, + key: str, + *, + with_definition: typing.Optional[bool] = None, + version: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RetrieveMerchantCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant. + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to retrieve. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of + the custom attribute. Set this parameter to `true` to get the name and description of the custom + attribute, information about the data type, or other definition details. The default value is `false`. + + version : typing.Optional[int] + The current version of the custom attribute, which is used for strongly consistent reads to + guarantee that you receive the most up-to-date data. When included in the request, Square + returns the specified version or a higher version if one exists. If the specified version is + higher than the current version, Square returns a `BAD_REQUEST` error. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveMerchantCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes/{jsonable_encoder(key)}", + method="GET", + params={ + "with_definition": with_definition, + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveMerchantCustomAttributeResponse, + construct_type( + type_=RetrieveMerchantCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def upsert( + self, + merchant_id: str, + key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpsertMerchantCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant. + Use this endpoint to set the value of a custom attribute for a specified merchant. + A custom attribute is based on a custom attribute definition in a Square seller account, which + is created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint. + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to create or update. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. For more information, + see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertMerchantCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes/{jsonable_encoder(key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertMerchantCustomAttributeResponse, + construct_type( + type_=UpsertMerchantCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, merchant_id: str, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteMerchantCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant. + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + merchant_id : str + The ID of the target [merchant](entity:Merchant). + + key : str + The key of the custom attribute to delete. This key must match the `key` of a custom + attribute definition in the Square seller account. If the requesting application is not the + definition owner, you must use the qualified key. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteMerchantCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}/custom-attributes/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteMerchantCustomAttributeResponse, + construct_type( + type_=DeleteMerchantCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/merchants/raw_client.py b/src/square/merchants/raw_client.py new file mode 100644 index 00000000..a41dcfcf --- /dev/null +++ b/src/square/merchants/raw_client.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_merchant_response import GetMerchantResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawMerchantsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, merchant_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetMerchantResponse]: + """ + Retrieves the `Merchant` object for the given `merchant_id`. + + Parameters + ---------- + merchant_id : str + The ID of the merchant to retrieve. If the string "me" is supplied as the ID, + then retrieve the merchant that is currently accessible to this call. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetMerchantResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetMerchantResponse, + construct_type( + type_=GetMerchantResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawMerchantsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, merchant_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetMerchantResponse]: + """ + Retrieves the `Merchant` object for the given `merchant_id`. + + Parameters + ---------- + merchant_id : str + The ID of the merchant to retrieve. If the string "me" is supplied as the ID, + then retrieve the merchant that is currently accessible to this call. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetMerchantResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/merchants/{jsonable_encoder(merchant_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetMerchantResponse, + construct_type( + type_=GetMerchantResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/mobile/__init__.py b/src/square/mobile/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/mobile/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/mobile/client.py b/src/square/mobile/client.py new file mode 100644 index 00000000..024d8292 --- /dev/null +++ b/src/square/mobile/client.py @@ -0,0 +1,146 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawMobileClient +from ..core.request_options import RequestOptions +from ..types.create_mobile_authorization_code_response import CreateMobileAuthorizationCodeResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawMobileClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class MobileClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawMobileClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawMobileClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawMobileClient + """ + return self._raw_client + + def authorization_code( + self, *, location_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None + ) -> CreateMobileAuthorizationCodeResponse: + """ + __Note:__ This endpoint is used by the deprecated Reader SDK. + Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. + + Generates code to authorize a mobile application to connect to a Square card reader. + + Authorization codes are one-time-use codes and expire 60 minutes after being issued. + + The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + Replace `ACCESS_TOKEN` with a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + Parameters + ---------- + location_id : typing.Optional[str] + The Square location ID that the authorization code should be tied to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateMobileAuthorizationCodeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.mobile.authorization_code( + location_id="YOUR_LOCATION_ID", + ) + """ + response = self._raw_client.authorization_code(location_id=location_id, request_options=request_options) + return response.data + + +class AsyncMobileClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawMobileClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawMobileClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawMobileClient + """ + return self._raw_client + + async def authorization_code( + self, *, location_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None + ) -> CreateMobileAuthorizationCodeResponse: + """ + __Note:__ This endpoint is used by the deprecated Reader SDK. + Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. + + Generates code to authorize a mobile application to connect to a Square card reader. + + Authorization codes are one-time-use codes and expire 60 minutes after being issued. + + The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + Replace `ACCESS_TOKEN` with a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + Parameters + ---------- + location_id : typing.Optional[str] + The Square location ID that the authorization code should be tied to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateMobileAuthorizationCodeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.mobile.authorization_code( + location_id="YOUR_LOCATION_ID", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.authorization_code(location_id=location_id, request_options=request_options) + return response.data diff --git a/src/square/mobile/raw_client.py b/src/square/mobile/raw_client.py new file mode 100644 index 00000000..d7a22d19 --- /dev/null +++ b/src/square/mobile/raw_client.py @@ -0,0 +1,145 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_mobile_authorization_code_response import CreateMobileAuthorizationCodeResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawMobileClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def authorization_code( + self, *, location_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CreateMobileAuthorizationCodeResponse]: + """ + __Note:__ This endpoint is used by the deprecated Reader SDK. + Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. + + Generates code to authorize a mobile application to connect to a Square card reader. + + Authorization codes are one-time-use codes and expire 60 minutes after being issued. + + The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + Replace `ACCESS_TOKEN` with a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + Parameters + ---------- + location_id : typing.Optional[str] + The Square location ID that the authorization code should be tied to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateMobileAuthorizationCodeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "mobile/authorization-code", + method="POST", + json={ + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateMobileAuthorizationCodeResponse, + construct_type( + type_=CreateMobileAuthorizationCodeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawMobileClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def authorization_code( + self, *, location_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CreateMobileAuthorizationCodeResponse]: + """ + __Note:__ This endpoint is used by the deprecated Reader SDK. + Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods. + + Generates code to authorize a mobile application to connect to a Square card reader. + + Authorization codes are one-time-use codes and expire 60 minutes after being issued. + + The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + Replace `ACCESS_TOKEN` with a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + Parameters + ---------- + location_id : typing.Optional[str] + The Square location ID that the authorization code should be tied to. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateMobileAuthorizationCodeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "mobile/authorization-code", + method="POST", + json={ + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateMobileAuthorizationCodeResponse, + construct_type( + type_=CreateMobileAuthorizationCodeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/o_auth/__init__.py b/src/square/o_auth/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/o_auth/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/o_auth/client.py b/src/square/o_auth/client.py new file mode 100644 index 00000000..9a534c8b --- /dev/null +++ b/src/square/o_auth/client.py @@ -0,0 +1,642 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawOAuthClient +from ..core.request_options import RequestOptions +from ..types.revoke_token_response import RevokeTokenResponse +from ..types.obtain_token_response import ObtainTokenResponse +from ..types.retrieve_token_status_response import RetrieveTokenStatusResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawOAuthClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class OAuthClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawOAuthClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawOAuthClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawOAuthClient + """ + return self._raw_client + + def revoke_token( + self, + *, + client_id: typing.Optional[str] = OMIT, + access_token: typing.Optional[str] = OMIT, + merchant_id: typing.Optional[str] = OMIT, + revoke_only_access_token: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> RevokeTokenResponse: + """ + Revokes an access token generated with the OAuth flow. + + If an account has more than one OAuth access token for your application, this + endpoint revokes all of them, regardless of which token you specify. + + __Important:__ The `Authorization` header for this endpoint must have the + following format: + + ``` + Authorization: Client APPLICATION_SECRET + ``` + + Replace `APPLICATION_SECRET` with the application secret on the **OAuth** + page for your application in the Developer Dashboard. + + Parameters + ---------- + client_id : typing.Optional[str] + The Square-issued ID for your application, which is available on the **OAuth** page in the + [Developer Dashboard](https://developer.squareup.com/apps). + + access_token : typing.Optional[str] + The access token of the merchant whose token you want to revoke. + Do not provide a value for `merchant_id` if you provide this parameter. + + merchant_id : typing.Optional[str] + The ID of the merchant whose token you want to revoke. + Do not provide a value for `access_token` if you provide this parameter. + + revoke_only_access_token : typing.Optional[bool] + If `true`, terminate the given single access token, but do not + terminate the entire authorization. + Default: `false` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RevokeTokenResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.o_auth.revoke_token( + client_id="CLIENT_ID", + access_token="ACCESS_TOKEN", + ) + """ + response = self._raw_client.revoke_token( + client_id=client_id, + access_token=access_token, + merchant_id=merchant_id, + revoke_only_access_token=revoke_only_access_token, + request_options=request_options, + ) + return response.data + + def obtain_token( + self, + *, + client_id: str, + grant_type: str, + client_secret: typing.Optional[str] = OMIT, + code: typing.Optional[str] = OMIT, + redirect_uri: typing.Optional[str] = OMIT, + refresh_token: typing.Optional[str] = OMIT, + migration_token: typing.Optional[str] = OMIT, + scopes: typing.Optional[typing.Sequence[str]] = OMIT, + short_lived: typing.Optional[bool] = OMIT, + code_verifier: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> ObtainTokenResponse: + """ + Returns an OAuth access token and refresh token using the `authorization_code` + or `refresh_token` grant type. + + When `grant_type` is `authorization_code`: + - With the [code flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow), + provide `code`, `client_id`, and `client_secret`. + - With the [PKCE flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow), + provide `code`, `client_id`, and `code_verifier`. + + When `grant_type` is `refresh_token`: + - With the code flow, provide `refresh_token`, `client_id`, and `client_secret`. + The response returns the same refresh token provided in the request. + - With the PKCE flow, provide `refresh_token` and `client_id`. The response returns + a new refresh token. + + You can use the `scopes` parameter to limit the set of permissions authorized by the + access token. You can use the `short_lived` parameter to create an access token that + expires in 24 hours. + + __Important:__ OAuth tokens should be encrypted and stored on a secure server. + Application clients should never interact directly with OAuth tokens. + + Parameters + ---------- + client_id : str + The Square-issued ID of your application, which is available as the **Application ID** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow for any grant type. + + grant_type : str + The method used to obtain an OAuth access token. The request must include the + credential that corresponds to the specified grant type. Valid values are: + - `authorization_code` - Requires the `code` field. + - `refresh_token` - Requires the `refresh_token` field. + - `migration_token` - LEGACY for access tokens obtained using a Square API version prior + to 2019-03-13. Requires the `migration_token` field. + + client_secret : typing.Optional[str] + The secret key for your application, which is available as the **Application secret** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow for any grant type. Don't confuse your client secret with your + personal access token. + + code : typing.Optional[str] + The authorization code to exchange for an OAuth access token. This is the `code` + value that Square sent to your redirect URL in the authorization response. + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code`. + + redirect_uri : typing.Optional[str] + The redirect URL for your application, which you registered as the **Redirect URL** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code` and + you provided the `redirect_uri` parameter in your authorization URL. + + refresh_token : typing.Optional[str] + A valid refresh token used to generate a new OAuth access token. This is a + refresh token that was returned in a previous `ObtainToken` response. + + Required for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + migration_token : typing.Optional[str] + __LEGACY__ A valid access token (obtained using a Square API version prior to 2019-03-13) + used to generate a new OAuth access token. + + Required if `grant_type` is `migration_token`. For more information, see + [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). + + scopes : typing.Optional[typing.Sequence[str]] + The list of permissions that are explicitly requested for the access token. + For example, ["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]. + + The returned access token is limited to the permissions that are the intersection + of these requested permissions and those authorized by the provided `refresh_token`. + + Optional for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + short_lived : typing.Optional[bool] + Indicates whether the returned access token should expire in 24 hours. + + Optional for the code flow and PKCE flow for any grant type. The default value is `false`. + + code_verifier : typing.Optional[str] + The secret your application generated for the authorization request used to + obtain the authorization code. This is the source of the `code_challenge` hash you + provided in your authorization URL. + + Required for the PKCE flow if `grant_type` is `authorization_code`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ObtainTokenResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.o_auth.obtain_token( + client_id="sq0idp-uaPHILoPzWZk3tlJqlML0g", + client_secret="sq0csp-30a-4C_tVOnTh14Piza2BfTPBXyLafLPWSzY1qAjeBfM", + code="sq0cgb-l0SBqxs4uwxErTVyYOdemg", + grant_type="authorization_code", + ) + """ + response = self._raw_client.obtain_token( + client_id=client_id, + grant_type=grant_type, + client_secret=client_secret, + code=code, + redirect_uri=redirect_uri, + refresh_token=refresh_token, + migration_token=migration_token, + scopes=scopes, + short_lived=short_lived, + code_verifier=code_verifier, + request_options=request_options, + ) + return response.data + + def retrieve_token_status( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveTokenStatusResponse: + """ + Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token). + + Add the access token to the Authorization header of the request. + + __Important:__ The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + where `ACCESS_TOKEN` is a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveTokenStatusResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.o_auth.retrieve_token_status() + """ + response = self._raw_client.retrieve_token_status(request_options=request_options) + return response.data + + def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> None: + """ + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.o_auth.authorize() + """ + response = self._raw_client.authorize(request_options=request_options) + return response.data + + +class AsyncOAuthClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawOAuthClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawOAuthClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawOAuthClient + """ + return self._raw_client + + async def revoke_token( + self, + *, + client_id: typing.Optional[str] = OMIT, + access_token: typing.Optional[str] = OMIT, + merchant_id: typing.Optional[str] = OMIT, + revoke_only_access_token: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> RevokeTokenResponse: + """ + Revokes an access token generated with the OAuth flow. + + If an account has more than one OAuth access token for your application, this + endpoint revokes all of them, regardless of which token you specify. + + __Important:__ The `Authorization` header for this endpoint must have the + following format: + + ``` + Authorization: Client APPLICATION_SECRET + ``` + + Replace `APPLICATION_SECRET` with the application secret on the **OAuth** + page for your application in the Developer Dashboard. + + Parameters + ---------- + client_id : typing.Optional[str] + The Square-issued ID for your application, which is available on the **OAuth** page in the + [Developer Dashboard](https://developer.squareup.com/apps). + + access_token : typing.Optional[str] + The access token of the merchant whose token you want to revoke. + Do not provide a value for `merchant_id` if you provide this parameter. + + merchant_id : typing.Optional[str] + The ID of the merchant whose token you want to revoke. + Do not provide a value for `access_token` if you provide this parameter. + + revoke_only_access_token : typing.Optional[bool] + If `true`, terminate the given single access token, but do not + terminate the entire authorization. + Default: `false` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RevokeTokenResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.o_auth.revoke_token( + client_id="CLIENT_ID", + access_token="ACCESS_TOKEN", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.revoke_token( + client_id=client_id, + access_token=access_token, + merchant_id=merchant_id, + revoke_only_access_token=revoke_only_access_token, + request_options=request_options, + ) + return response.data + + async def obtain_token( + self, + *, + client_id: str, + grant_type: str, + client_secret: typing.Optional[str] = OMIT, + code: typing.Optional[str] = OMIT, + redirect_uri: typing.Optional[str] = OMIT, + refresh_token: typing.Optional[str] = OMIT, + migration_token: typing.Optional[str] = OMIT, + scopes: typing.Optional[typing.Sequence[str]] = OMIT, + short_lived: typing.Optional[bool] = OMIT, + code_verifier: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> ObtainTokenResponse: + """ + Returns an OAuth access token and refresh token using the `authorization_code` + or `refresh_token` grant type. + + When `grant_type` is `authorization_code`: + - With the [code flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow), + provide `code`, `client_id`, and `client_secret`. + - With the [PKCE flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow), + provide `code`, `client_id`, and `code_verifier`. + + When `grant_type` is `refresh_token`: + - With the code flow, provide `refresh_token`, `client_id`, and `client_secret`. + The response returns the same refresh token provided in the request. + - With the PKCE flow, provide `refresh_token` and `client_id`. The response returns + a new refresh token. + + You can use the `scopes` parameter to limit the set of permissions authorized by the + access token. You can use the `short_lived` parameter to create an access token that + expires in 24 hours. + + __Important:__ OAuth tokens should be encrypted and stored on a secure server. + Application clients should never interact directly with OAuth tokens. + + Parameters + ---------- + client_id : str + The Square-issued ID of your application, which is available as the **Application ID** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow for any grant type. + + grant_type : str + The method used to obtain an OAuth access token. The request must include the + credential that corresponds to the specified grant type. Valid values are: + - `authorization_code` - Requires the `code` field. + - `refresh_token` - Requires the `refresh_token` field. + - `migration_token` - LEGACY for access tokens obtained using a Square API version prior + to 2019-03-13. Requires the `migration_token` field. + + client_secret : typing.Optional[str] + The secret key for your application, which is available as the **Application secret** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow for any grant type. Don't confuse your client secret with your + personal access token. + + code : typing.Optional[str] + The authorization code to exchange for an OAuth access token. This is the `code` + value that Square sent to your redirect URL in the authorization response. + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code`. + + redirect_uri : typing.Optional[str] + The redirect URL for your application, which you registered as the **Redirect URL** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code` and + you provided the `redirect_uri` parameter in your authorization URL. + + refresh_token : typing.Optional[str] + A valid refresh token used to generate a new OAuth access token. This is a + refresh token that was returned in a previous `ObtainToken` response. + + Required for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + migration_token : typing.Optional[str] + __LEGACY__ A valid access token (obtained using a Square API version prior to 2019-03-13) + used to generate a new OAuth access token. + + Required if `grant_type` is `migration_token`. For more information, see + [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). + + scopes : typing.Optional[typing.Sequence[str]] + The list of permissions that are explicitly requested for the access token. + For example, ["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]. + + The returned access token is limited to the permissions that are the intersection + of these requested permissions and those authorized by the provided `refresh_token`. + + Optional for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + short_lived : typing.Optional[bool] + Indicates whether the returned access token should expire in 24 hours. + + Optional for the code flow and PKCE flow for any grant type. The default value is `false`. + + code_verifier : typing.Optional[str] + The secret your application generated for the authorization request used to + obtain the authorization code. This is the source of the `code_challenge` hash you + provided in your authorization URL. + + Required for the PKCE flow if `grant_type` is `authorization_code`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ObtainTokenResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.o_auth.obtain_token( + client_id="sq0idp-uaPHILoPzWZk3tlJqlML0g", + client_secret="sq0csp-30a-4C_tVOnTh14Piza2BfTPBXyLafLPWSzY1qAjeBfM", + code="sq0cgb-l0SBqxs4uwxErTVyYOdemg", + grant_type="authorization_code", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.obtain_token( + client_id=client_id, + grant_type=grant_type, + client_secret=client_secret, + code=code, + redirect_uri=redirect_uri, + refresh_token=refresh_token, + migration_token=migration_token, + scopes=scopes, + short_lived=short_lived, + code_verifier=code_verifier, + request_options=request_options, + ) + return response.data + + async def retrieve_token_status( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveTokenStatusResponse: + """ + Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token). + + Add the access token to the Authorization header of the request. + + __Important:__ The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + where `ACCESS_TOKEN` is a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveTokenStatusResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.o_auth.retrieve_token_status() + + + asyncio.run(main()) + """ + response = await self._raw_client.retrieve_token_status(request_options=request_options) + return response.data + + async def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> None: + """ + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.o_auth.authorize() + + + asyncio.run(main()) + """ + response = await self._raw_client.authorize(request_options=request_options) + return response.data diff --git a/src/square/o_auth/raw_client.py b/src/square/o_auth/raw_client.py new file mode 100644 index 00000000..b7e4a7d1 --- /dev/null +++ b/src/square/o_auth/raw_client.py @@ -0,0 +1,641 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.revoke_token_response import RevokeTokenResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.obtain_token_response import ObtainTokenResponse +from ..types.retrieve_token_status_response import RetrieveTokenStatusResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawOAuthClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def revoke_token( + self, + *, + client_id: typing.Optional[str] = OMIT, + access_token: typing.Optional[str] = OMIT, + merchant_id: typing.Optional[str] = OMIT, + revoke_only_access_token: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RevokeTokenResponse]: + """ + Revokes an access token generated with the OAuth flow. + + If an account has more than one OAuth access token for your application, this + endpoint revokes all of them, regardless of which token you specify. + + __Important:__ The `Authorization` header for this endpoint must have the + following format: + + ``` + Authorization: Client APPLICATION_SECRET + ``` + + Replace `APPLICATION_SECRET` with the application secret on the **OAuth** + page for your application in the Developer Dashboard. + + Parameters + ---------- + client_id : typing.Optional[str] + The Square-issued ID for your application, which is available on the **OAuth** page in the + [Developer Dashboard](https://developer.squareup.com/apps). + + access_token : typing.Optional[str] + The access token of the merchant whose token you want to revoke. + Do not provide a value for `merchant_id` if you provide this parameter. + + merchant_id : typing.Optional[str] + The ID of the merchant whose token you want to revoke. + Do not provide a value for `access_token` if you provide this parameter. + + revoke_only_access_token : typing.Optional[bool] + If `true`, terminate the given single access token, but do not + terminate the entire authorization. + Default: `false` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RevokeTokenResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "oauth2/revoke", + method="POST", + json={ + "client_id": client_id, + "access_token": access_token, + "merchant_id": merchant_id, + "revoke_only_access_token": revoke_only_access_token, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RevokeTokenResponse, + construct_type( + type_=RevokeTokenResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def obtain_token( + self, + *, + client_id: str, + grant_type: str, + client_secret: typing.Optional[str] = OMIT, + code: typing.Optional[str] = OMIT, + redirect_uri: typing.Optional[str] = OMIT, + refresh_token: typing.Optional[str] = OMIT, + migration_token: typing.Optional[str] = OMIT, + scopes: typing.Optional[typing.Sequence[str]] = OMIT, + short_lived: typing.Optional[bool] = OMIT, + code_verifier: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ObtainTokenResponse]: + """ + Returns an OAuth access token and refresh token using the `authorization_code` + or `refresh_token` grant type. + + When `grant_type` is `authorization_code`: + - With the [code flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow), + provide `code`, `client_id`, and `client_secret`. + - With the [PKCE flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow), + provide `code`, `client_id`, and `code_verifier`. + + When `grant_type` is `refresh_token`: + - With the code flow, provide `refresh_token`, `client_id`, and `client_secret`. + The response returns the same refresh token provided in the request. + - With the PKCE flow, provide `refresh_token` and `client_id`. The response returns + a new refresh token. + + You can use the `scopes` parameter to limit the set of permissions authorized by the + access token. You can use the `short_lived` parameter to create an access token that + expires in 24 hours. + + __Important:__ OAuth tokens should be encrypted and stored on a secure server. + Application clients should never interact directly with OAuth tokens. + + Parameters + ---------- + client_id : str + The Square-issued ID of your application, which is available as the **Application ID** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow for any grant type. + + grant_type : str + The method used to obtain an OAuth access token. The request must include the + credential that corresponds to the specified grant type. Valid values are: + - `authorization_code` - Requires the `code` field. + - `refresh_token` - Requires the `refresh_token` field. + - `migration_token` - LEGACY for access tokens obtained using a Square API version prior + to 2019-03-13. Requires the `migration_token` field. + + client_secret : typing.Optional[str] + The secret key for your application, which is available as the **Application secret** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow for any grant type. Don't confuse your client secret with your + personal access token. + + code : typing.Optional[str] + The authorization code to exchange for an OAuth access token. This is the `code` + value that Square sent to your redirect URL in the authorization response. + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code`. + + redirect_uri : typing.Optional[str] + The redirect URL for your application, which you registered as the **Redirect URL** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code` and + you provided the `redirect_uri` parameter in your authorization URL. + + refresh_token : typing.Optional[str] + A valid refresh token used to generate a new OAuth access token. This is a + refresh token that was returned in a previous `ObtainToken` response. + + Required for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + migration_token : typing.Optional[str] + __LEGACY__ A valid access token (obtained using a Square API version prior to 2019-03-13) + used to generate a new OAuth access token. + + Required if `grant_type` is `migration_token`. For more information, see + [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). + + scopes : typing.Optional[typing.Sequence[str]] + The list of permissions that are explicitly requested for the access token. + For example, ["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]. + + The returned access token is limited to the permissions that are the intersection + of these requested permissions and those authorized by the provided `refresh_token`. + + Optional for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + short_lived : typing.Optional[bool] + Indicates whether the returned access token should expire in 24 hours. + + Optional for the code flow and PKCE flow for any grant type. The default value is `false`. + + code_verifier : typing.Optional[str] + The secret your application generated for the authorization request used to + obtain the authorization code. This is the source of the `code_challenge` hash you + provided in your authorization URL. + + Required for the PKCE flow if `grant_type` is `authorization_code`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ObtainTokenResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "oauth2/token", + method="POST", + json={ + "client_id": client_id, + "client_secret": client_secret, + "code": code, + "redirect_uri": redirect_uri, + "grant_type": grant_type, + "refresh_token": refresh_token, + "migration_token": migration_token, + "scopes": scopes, + "short_lived": short_lived, + "code_verifier": code_verifier, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ObtainTokenResponse, + construct_type( + type_=ObtainTokenResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def retrieve_token_status( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveTokenStatusResponse]: + """ + Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token). + + Add the access token to the Authorization header of the request. + + __Important:__ The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + where `ACCESS_TOKEN` is a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveTokenStatusResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "oauth2/token/status", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveTokenStatusResponse, + construct_type( + type_=RetrieveTokenStatusResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]: + """ + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + "oauth2/authorize", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawOAuthClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def revoke_token( + self, + *, + client_id: typing.Optional[str] = OMIT, + access_token: typing.Optional[str] = OMIT, + merchant_id: typing.Optional[str] = OMIT, + revoke_only_access_token: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RevokeTokenResponse]: + """ + Revokes an access token generated with the OAuth flow. + + If an account has more than one OAuth access token for your application, this + endpoint revokes all of them, regardless of which token you specify. + + __Important:__ The `Authorization` header for this endpoint must have the + following format: + + ``` + Authorization: Client APPLICATION_SECRET + ``` + + Replace `APPLICATION_SECRET` with the application secret on the **OAuth** + page for your application in the Developer Dashboard. + + Parameters + ---------- + client_id : typing.Optional[str] + The Square-issued ID for your application, which is available on the **OAuth** page in the + [Developer Dashboard](https://developer.squareup.com/apps). + + access_token : typing.Optional[str] + The access token of the merchant whose token you want to revoke. + Do not provide a value for `merchant_id` if you provide this parameter. + + merchant_id : typing.Optional[str] + The ID of the merchant whose token you want to revoke. + Do not provide a value for `access_token` if you provide this parameter. + + revoke_only_access_token : typing.Optional[bool] + If `true`, terminate the given single access token, but do not + terminate the entire authorization. + Default: `false` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RevokeTokenResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "oauth2/revoke", + method="POST", + json={ + "client_id": client_id, + "access_token": access_token, + "merchant_id": merchant_id, + "revoke_only_access_token": revoke_only_access_token, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RevokeTokenResponse, + construct_type( + type_=RevokeTokenResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def obtain_token( + self, + *, + client_id: str, + grant_type: str, + client_secret: typing.Optional[str] = OMIT, + code: typing.Optional[str] = OMIT, + redirect_uri: typing.Optional[str] = OMIT, + refresh_token: typing.Optional[str] = OMIT, + migration_token: typing.Optional[str] = OMIT, + scopes: typing.Optional[typing.Sequence[str]] = OMIT, + short_lived: typing.Optional[bool] = OMIT, + code_verifier: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ObtainTokenResponse]: + """ + Returns an OAuth access token and refresh token using the `authorization_code` + or `refresh_token` grant type. + + When `grant_type` is `authorization_code`: + - With the [code flow](https://developer.squareup.com/docs/oauth-api/overview#code-flow), + provide `code`, `client_id`, and `client_secret`. + - With the [PKCE flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow), + provide `code`, `client_id`, and `code_verifier`. + + When `grant_type` is `refresh_token`: + - With the code flow, provide `refresh_token`, `client_id`, and `client_secret`. + The response returns the same refresh token provided in the request. + - With the PKCE flow, provide `refresh_token` and `client_id`. The response returns + a new refresh token. + + You can use the `scopes` parameter to limit the set of permissions authorized by the + access token. You can use the `short_lived` parameter to create an access token that + expires in 24 hours. + + __Important:__ OAuth tokens should be encrypted and stored on a secure server. + Application clients should never interact directly with OAuth tokens. + + Parameters + ---------- + client_id : str + The Square-issued ID of your application, which is available as the **Application ID** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow for any grant type. + + grant_type : str + The method used to obtain an OAuth access token. The request must include the + credential that corresponds to the specified grant type. Valid values are: + - `authorization_code` - Requires the `code` field. + - `refresh_token` - Requires the `refresh_token` field. + - `migration_token` - LEGACY for access tokens obtained using a Square API version prior + to 2019-03-13. Requires the `migration_token` field. + + client_secret : typing.Optional[str] + The secret key for your application, which is available as the **Application secret** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow for any grant type. Don't confuse your client secret with your + personal access token. + + code : typing.Optional[str] + The authorization code to exchange for an OAuth access token. This is the `code` + value that Square sent to your redirect URL in the authorization response. + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code`. + + redirect_uri : typing.Optional[str] + The redirect URL for your application, which you registered as the **Redirect URL** + on the **OAuth** page in the [Developer Console](https://developer.squareup.com/apps). + + Required for the code flow and PKCE flow if `grant_type` is `authorization_code` and + you provided the `redirect_uri` parameter in your authorization URL. + + refresh_token : typing.Optional[str] + A valid refresh token used to generate a new OAuth access token. This is a + refresh token that was returned in a previous `ObtainToken` response. + + Required for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + migration_token : typing.Optional[str] + __LEGACY__ A valid access token (obtained using a Square API version prior to 2019-03-13) + used to generate a new OAuth access token. + + Required if `grant_type` is `migration_token`. For more information, see + [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). + + scopes : typing.Optional[typing.Sequence[str]] + The list of permissions that are explicitly requested for the access token. + For example, ["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]. + + The returned access token is limited to the permissions that are the intersection + of these requested permissions and those authorized by the provided `refresh_token`. + + Optional for the code flow and PKCE flow if `grant_type` is `refresh_token`. + + short_lived : typing.Optional[bool] + Indicates whether the returned access token should expire in 24 hours. + + Optional for the code flow and PKCE flow for any grant type. The default value is `false`. + + code_verifier : typing.Optional[str] + The secret your application generated for the authorization request used to + obtain the authorization code. This is the source of the `code_challenge` hash you + provided in your authorization URL. + + Required for the PKCE flow if `grant_type` is `authorization_code`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ObtainTokenResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "oauth2/token", + method="POST", + json={ + "client_id": client_id, + "client_secret": client_secret, + "code": code, + "redirect_uri": redirect_uri, + "grant_type": grant_type, + "refresh_token": refresh_token, + "migration_token": migration_token, + "scopes": scopes, + "short_lived": short_lived, + "code_verifier": code_verifier, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ObtainTokenResponse, + construct_type( + type_=ObtainTokenResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def retrieve_token_status( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveTokenStatusResponse]: + """ + Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token). + + Add the access token to the Authorization header of the request. + + __Important:__ The `Authorization` header you provide to this endpoint must have the following format: + + ``` + Authorization: Bearer ACCESS_TOKEN + ``` + + where `ACCESS_TOKEN` is a + [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). + + If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveTokenStatusResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "oauth2/token/status", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveTokenStatusResponse, + construct_type( + type_=RetrieveTokenStatusResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> AsyncHttpResponse[None]: + """ + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + "oauth2/authorize", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/orders/__init__.py b/src/square/orders/__init__.py new file mode 100644 index 00000000..cbf84df6 --- /dev/null +++ b/src/square/orders/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import custom_attribute_definitions, custom_attributes + +__all__ = ["custom_attribute_definitions", "custom_attributes"] diff --git a/src/square/orders/client.py b/src/square/orders/client.py new file mode 100644 index 00000000..70f24cc5 --- /dev/null +++ b/src/square/orders/client.py @@ -0,0 +1,1274 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawOrdersClient +from .custom_attribute_definitions.client import CustomAttributeDefinitionsClient +from .custom_attributes.client import CustomAttributesClient +from ..requests.order import OrderParams +from ..core.request_options import RequestOptions +from ..types.create_order_response import CreateOrderResponse +from ..types.batch_get_orders_response import BatchGetOrdersResponse +from ..requests.order_reward import OrderRewardParams +from ..types.calculate_order_response import CalculateOrderResponse +from ..types.clone_order_response import CloneOrderResponse +from ..requests.search_orders_query import SearchOrdersQueryParams +from ..types.search_orders_response import SearchOrdersResponse +from ..types.get_order_response import GetOrderResponse +from ..types.update_order_response import UpdateOrderResponse +from ..types.pay_order_response import PayOrderResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawOrdersClient +from .custom_attribute_definitions.client import AsyncCustomAttributeDefinitionsClient +from .custom_attributes.client import AsyncCustomAttributesClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class OrdersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawOrdersClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = CustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = CustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawOrdersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawOrdersClient + """ + return self._raw_client + + def create( + self, + *, + order: typing.Optional[OrderParams] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateOrderResponse: + """ + Creates a new [order](entity:Order) that can include information about products for + purchase and settings to apply to the purchase. + + To pay for a created order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + You can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + + Parameters + ---------- + order : typing.Optional[OrderParams] + The order to create. If this field is set, the only other top-level field that can be + set is the `idempotency_key`. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this + order among orders you have created. + + If you are unsure whether a particular order was created successfully, + you can try it again with the same idempotency key without + worrying about creating duplicate orders. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateOrderResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.create( + order={ + "location_id": "057P5VYJ4A5X1", + "reference_id": "my-order-001", + "line_items": [ + { + "name": "New York Strip Steak", + "quantity": "1", + "base_price_money": {"amount": 1599, "currency": "USD"}, + }, + { + "quantity": "2", + "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", + "modifiers": [ + {"catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ"} + ], + "applied_discounts": [{"discount_uid": "one-dollar-off"}], + }, + ], + "taxes": [ + { + "uid": "state-sales-tax", + "name": "State Sales Tax", + "percentage": "9", + "scope": "ORDER", + } + ], + "discounts": [ + { + "uid": "labor-day-sale", + "name": "Labor Day Sale", + "percentage": "5", + "scope": "ORDER", + }, + { + "uid": "membership-discount", + "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", + "scope": "ORDER", + }, + { + "uid": "one-dollar-off", + "name": "Sale - $1.00 off", + "amount_money": {"amount": 100, "currency": "USD"}, + "scope": "LINE_ITEM", + }, + ], + }, + idempotency_key="8193148c-9586-11e6-99f9-28cfe92138cf", + ) + """ + response = self._raw_client.create( + order=order, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def batch_get( + self, + *, + order_ids: typing.Sequence[str], + location_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetOrdersResponse: + """ + Retrieves a set of [orders](entity:Order) by their IDs. + + If a given order ID does not exist, the ID is ignored instead of generating an error. + + Parameters + ---------- + order_ids : typing.Sequence[str] + The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. + + location_id : typing.Optional[str] + The ID of the location for these orders. This field is optional: omit it to retrieve + orders within the scope of the current authorization's merchant ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetOrdersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.batch_get( + location_id="057P5VYJ4A5X1", + order_ids=["CAISEM82RcpmcFBM0TfOyiHV3es", "CAISENgvlJ6jLWAzERDzjyHVybY"], + ) + """ + response = self._raw_client.batch_get( + order_ids=order_ids, location_id=location_id, request_options=request_options + ) + return response.data + + def calculate( + self, + *, + order: OrderParams, + proposed_rewards: typing.Optional[typing.Sequence[OrderRewardParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CalculateOrderResponse: + """ + Enables applications to preview order pricing without creating an order. + + Parameters + ---------- + order : OrderParams + The order to be calculated. Expects the entire order, not a sparse update. + + proposed_rewards : typing.Optional[typing.Sequence[OrderRewardParams]] + Identifies one or more loyalty reward tiers to apply during the order calculation. + The discounts defined by the reward tiers are added to the order only to preview the + effect of applying the specified rewards. The rewards do not correspond to actual + redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are + random strings used only to reference the reward tier. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CalculateOrderResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.calculate( + order={ + "location_id": "D7AVYMEAPJ3A3", + "line_items": [ + { + "name": "Item 1", + "quantity": "1", + "base_price_money": {"amount": 500, "currency": "USD"}, + }, + { + "name": "Item 2", + "quantity": "2", + "base_price_money": {"amount": 300, "currency": "USD"}, + }, + ], + "discounts": [ + {"name": "50% Off", "percentage": "50", "scope": "ORDER"} + ], + }, + ) + """ + response = self._raw_client.calculate( + order=order, proposed_rewards=proposed_rewards, request_options=request_options + ) + return response.data + + def clone( + self, + *, + order_id: str, + version: typing.Optional[int] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CloneOrderResponse: + """ + Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has + only the core fields (such as line items, taxes, and discounts) copied from the original order. + + Parameters + ---------- + order_id : str + The ID of the order to clone. + + version : typing.Optional[int] + An optional order version for concurrency protection. + + If a version is provided, it must match the latest stored version of the order to clone. + If a version is not provided, the API clones the latest version. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this clone request. + + If you are unsure whether a particular order was cloned successfully, + you can reattempt the call with the same idempotency key without + worrying about creating duplicate cloned orders. + The originally cloned order is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CloneOrderResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.clone( + order_id="ZAISEM52YcpmcWAzERDOyiWS123", + version=3, + idempotency_key="UNIQUE_STRING", + ) + """ + response = self._raw_client.clone( + order_id=order_id, version=version, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def search( + self, + *, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + query: typing.Optional[SearchOrdersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + return_entries: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchOrdersResponse: + """ + Search all orders for one or more locations. Orders include all sales, + returns, and exchanges regardless of how or when they entered the Square + ecosystem (such as Point of Sale, Invoices, and Connect APIs). + + `SearchOrders` requests need to specify which locations to search and define a + [SearchOrdersQuery](entity:SearchOrdersQuery) object that controls + how to sort or filter the results. Your `SearchOrdersQuery` can: + + Set filter criteria. + Set the sort order. + Determine whether to return results as complete `Order` objects or as + [OrderEntry](entity:OrderEntry) objects. + + Note that details for orders processed with Square Point of Sale while in + offline mode might not be transmitted to Square for up to 72 hours. Offline + orders have a `created_at` value that reflects the time the order was created, + not the time it was subsequently transmitted to Square. + + Parameters + ---------- + location_ids : typing.Optional[typing.Sequence[str]] + The location IDs for the orders to query. All locations must belong to + the same merchant. + + Max: 10 location IDs. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[SearchOrdersQueryParams] + Query conditions used to filter or sort the results. Note that when + retrieving additional pages using a cursor, you must use the original query. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + + Default: `500` + Max: `1000` + + return_entries : typing.Optional[bool] + A Boolean that controls the format of the search results. If `true`, + `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders` + returns complete order objects. + + Default: `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchOrdersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.search( + location_ids=["057P5VYJ4A5X1", "18YC4JDH91E1H"], + query={ + "filter": { + "state_filter": {"states": ["COMPLETED"]}, + "date_time_filter": { + "closed_at": { + "start_at": "2018-03-03T20:00:00+00:00", + "end_at": "2019-03-04T21:54:45+00:00", + } + }, + }, + "sort": {"sort_field": "CLOSED_AT", "sort_order": "DESC"}, + }, + limit=3, + return_entries=True, + ) + """ + response = self._raw_client.search( + location_ids=location_ids, + cursor=cursor, + query=query, + limit=limit, + return_entries=return_entries, + request_options=request_options, + ) + return response.data + + def get(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetOrderResponse: + """ + Retrieves an [Order](entity:Order) by ID. + + Parameters + ---------- + order_id : str + The ID of the order to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetOrderResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.get( + order_id="order_id", + ) + """ + response = self._raw_client.get(order_id, request_options=request_options) + return response.data + + def update( + self, + order_id: str, + *, + order: typing.Optional[OrderParams] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateOrderResponse: + """ + Updates an open [order](entity:Order) by adding, replacing, or deleting + fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. + + An `UpdateOrder` request requires the following: + + - The `order_id` in the endpoint path, identifying the order to update. + - The latest `version` of the order to update. + - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + identifying the fields to clear. + + To pay for an order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + Parameters + ---------- + order_id : str + The ID of the order to update. + + order : typing.Optional[OrderParams] + The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + fields to clear. For example, `line_items[uid].note`. + For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this update request. + + If you are unsure whether a particular update was applied to an order successfully, + you can reattempt it with the same idempotency key without + worrying about creating duplicate updates to the order. + The latest order version is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateOrderResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.update( + order_id="order_id", + order={ + "location_id": "location_id", + "line_items": [ + { + "uid": "cookie_uid", + "name": "COOKIE", + "quantity": "2", + "base_price_money": {"amount": 200, "currency": "USD"}, + } + ], + "version": 1, + }, + fields_to_clear=["discounts"], + idempotency_key="UNIQUE_STRING", + ) + """ + response = self._raw_client.update( + order_id, + order=order, + fields_to_clear=fields_to_clear, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def pay( + self, + order_id: str, + *, + idempotency_key: str, + order_version: typing.Optional[int] = OMIT, + payment_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> PayOrderResponse: + """ + Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment) + or settle an order with a total of `0`. + + The total of the `payment_ids` listed in the request must be equal to the order + total. Orders with a total amount of `0` can be marked as paid by specifying an empty + array of `payment_ids` in the request. + + To be used with `PayOrder`, a payment must: + + - Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment). + Any approved payments that reference the same `order_id` not specified in the + `payment_ids` is canceled. + - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). + Using a delayed capture payment with `PayOrder` completes the approved payment. + + Parameters + ---------- + order_id : str + The ID of the order being paid. + + idempotency_key : str + A value you specify that uniquely identifies this request among requests you have sent. If + you are unsure whether a particular payment request was completed successfully, you can reattempt + it with the same idempotency key without worrying about duplicate payments. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order_version : typing.Optional[int] + The version of the order being paid. If not supplied, the latest version will be paid. + + payment_ids : typing.Optional[typing.Sequence[str]] + The IDs of the [payments](entity:Payment) to collect. + The payment total must match the order total. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + PayOrderResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.pay( + order_id="order_id", + idempotency_key="c043a359-7ad9-4136-82a9-c3f1d66dcbff", + payment_ids=["EnZdNAlWCmfh6Mt5FMNST1o7taB", "0LRiVlbXVwe8ozu4KbZxd12mvaB"], + ) + """ + response = self._raw_client.pay( + order_id, + idempotency_key=idempotency_key, + order_version=order_version, + payment_ids=payment_ids, + request_options=request_options, + ) + return response.data + + +class AsyncOrdersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawOrdersClient(client_wrapper=client_wrapper) + self.custom_attribute_definitions = AsyncCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + self.custom_attributes = AsyncCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawOrdersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawOrdersClient + """ + return self._raw_client + + async def create( + self, + *, + order: typing.Optional[OrderParams] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateOrderResponse: + """ + Creates a new [order](entity:Order) that can include information about products for + purchase and settings to apply to the purchase. + + To pay for a created order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + You can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + + Parameters + ---------- + order : typing.Optional[OrderParams] + The order to create. If this field is set, the only other top-level field that can be + set is the `idempotency_key`. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this + order among orders you have created. + + If you are unsure whether a particular order was created successfully, + you can try it again with the same idempotency key without + worrying about creating duplicate orders. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateOrderResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.create( + order={ + "location_id": "057P5VYJ4A5X1", + "reference_id": "my-order-001", + "line_items": [ + { + "name": "New York Strip Steak", + "quantity": "1", + "base_price_money": {"amount": 1599, "currency": "USD"}, + }, + { + "quantity": "2", + "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", + "modifiers": [ + {"catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ"} + ], + "applied_discounts": [{"discount_uid": "one-dollar-off"}], + }, + ], + "taxes": [ + { + "uid": "state-sales-tax", + "name": "State Sales Tax", + "percentage": "9", + "scope": "ORDER", + } + ], + "discounts": [ + { + "uid": "labor-day-sale", + "name": "Labor Day Sale", + "percentage": "5", + "scope": "ORDER", + }, + { + "uid": "membership-discount", + "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", + "scope": "ORDER", + }, + { + "uid": "one-dollar-off", + "name": "Sale - $1.00 off", + "amount_money": {"amount": 100, "currency": "USD"}, + "scope": "LINE_ITEM", + }, + ], + }, + idempotency_key="8193148c-9586-11e6-99f9-28cfe92138cf", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + order=order, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def batch_get( + self, + *, + order_ids: typing.Sequence[str], + location_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetOrdersResponse: + """ + Retrieves a set of [orders](entity:Order) by their IDs. + + If a given order ID does not exist, the ID is ignored instead of generating an error. + + Parameters + ---------- + order_ids : typing.Sequence[str] + The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. + + location_id : typing.Optional[str] + The ID of the location for these orders. This field is optional: omit it to retrieve + orders within the scope of the current authorization's merchant ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetOrdersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.batch_get( + location_id="057P5VYJ4A5X1", + order_ids=[ + "CAISEM82RcpmcFBM0TfOyiHV3es", + "CAISENgvlJ6jLWAzERDzjyHVybY", + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_get( + order_ids=order_ids, location_id=location_id, request_options=request_options + ) + return response.data + + async def calculate( + self, + *, + order: OrderParams, + proposed_rewards: typing.Optional[typing.Sequence[OrderRewardParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CalculateOrderResponse: + """ + Enables applications to preview order pricing without creating an order. + + Parameters + ---------- + order : OrderParams + The order to be calculated. Expects the entire order, not a sparse update. + + proposed_rewards : typing.Optional[typing.Sequence[OrderRewardParams]] + Identifies one or more loyalty reward tiers to apply during the order calculation. + The discounts defined by the reward tiers are added to the order only to preview the + effect of applying the specified rewards. The rewards do not correspond to actual + redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are + random strings used only to reference the reward tier. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CalculateOrderResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.calculate( + order={ + "location_id": "D7AVYMEAPJ3A3", + "line_items": [ + { + "name": "Item 1", + "quantity": "1", + "base_price_money": {"amount": 500, "currency": "USD"}, + }, + { + "name": "Item 2", + "quantity": "2", + "base_price_money": {"amount": 300, "currency": "USD"}, + }, + ], + "discounts": [ + {"name": "50% Off", "percentage": "50", "scope": "ORDER"} + ], + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.calculate( + order=order, proposed_rewards=proposed_rewards, request_options=request_options + ) + return response.data + + async def clone( + self, + *, + order_id: str, + version: typing.Optional[int] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CloneOrderResponse: + """ + Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has + only the core fields (such as line items, taxes, and discounts) copied from the original order. + + Parameters + ---------- + order_id : str + The ID of the order to clone. + + version : typing.Optional[int] + An optional order version for concurrency protection. + + If a version is provided, it must match the latest stored version of the order to clone. + If a version is not provided, the API clones the latest version. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this clone request. + + If you are unsure whether a particular order was cloned successfully, + you can reattempt the call with the same idempotency key without + worrying about creating duplicate cloned orders. + The originally cloned order is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CloneOrderResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.clone( + order_id="ZAISEM52YcpmcWAzERDOyiWS123", + version=3, + idempotency_key="UNIQUE_STRING", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.clone( + order_id=order_id, version=version, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def search( + self, + *, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + query: typing.Optional[SearchOrdersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + return_entries: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchOrdersResponse: + """ + Search all orders for one or more locations. Orders include all sales, + returns, and exchanges regardless of how or when they entered the Square + ecosystem (such as Point of Sale, Invoices, and Connect APIs). + + `SearchOrders` requests need to specify which locations to search and define a + [SearchOrdersQuery](entity:SearchOrdersQuery) object that controls + how to sort or filter the results. Your `SearchOrdersQuery` can: + + Set filter criteria. + Set the sort order. + Determine whether to return results as complete `Order` objects or as + [OrderEntry](entity:OrderEntry) objects. + + Note that details for orders processed with Square Point of Sale while in + offline mode might not be transmitted to Square for up to 72 hours. Offline + orders have a `created_at` value that reflects the time the order was created, + not the time it was subsequently transmitted to Square. + + Parameters + ---------- + location_ids : typing.Optional[typing.Sequence[str]] + The location IDs for the orders to query. All locations must belong to + the same merchant. + + Max: 10 location IDs. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[SearchOrdersQueryParams] + Query conditions used to filter or sort the results. Note that when + retrieving additional pages using a cursor, you must use the original query. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + + Default: `500` + Max: `1000` + + return_entries : typing.Optional[bool] + A Boolean that controls the format of the search results. If `true`, + `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders` + returns complete order objects. + + Default: `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchOrdersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.search( + location_ids=["057P5VYJ4A5X1", "18YC4JDH91E1H"], + query={ + "filter": { + "state_filter": {"states": ["COMPLETED"]}, + "date_time_filter": { + "closed_at": { + "start_at": "2018-03-03T20:00:00+00:00", + "end_at": "2019-03-04T21:54:45+00:00", + } + }, + }, + "sort": {"sort_field": "CLOSED_AT", "sort_order": "DESC"}, + }, + limit=3, + return_entries=True, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + location_ids=location_ids, + cursor=cursor, + query=query, + limit=limit, + return_entries=return_entries, + request_options=request_options, + ) + return response.data + + async def get(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetOrderResponse: + """ + Retrieves an [Order](entity:Order) by ID. + + Parameters + ---------- + order_id : str + The ID of the order to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetOrderResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.get( + order_id="order_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(order_id, request_options=request_options) + return response.data + + async def update( + self, + order_id: str, + *, + order: typing.Optional[OrderParams] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateOrderResponse: + """ + Updates an open [order](entity:Order) by adding, replacing, or deleting + fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. + + An `UpdateOrder` request requires the following: + + - The `order_id` in the endpoint path, identifying the order to update. + - The latest `version` of the order to update. + - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + identifying the fields to clear. + + To pay for an order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + Parameters + ---------- + order_id : str + The ID of the order to update. + + order : typing.Optional[OrderParams] + The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + fields to clear. For example, `line_items[uid].note`. + For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this update request. + + If you are unsure whether a particular update was applied to an order successfully, + you can reattempt it with the same idempotency key without + worrying about creating duplicate updates to the order. + The latest order version is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateOrderResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.update( + order_id="order_id", + order={ + "location_id": "location_id", + "line_items": [ + { + "uid": "cookie_uid", + "name": "COOKIE", + "quantity": "2", + "base_price_money": {"amount": 200, "currency": "USD"}, + } + ], + "version": 1, + }, + fields_to_clear=["discounts"], + idempotency_key="UNIQUE_STRING", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + order_id, + order=order, + fields_to_clear=fields_to_clear, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def pay( + self, + order_id: str, + *, + idempotency_key: str, + order_version: typing.Optional[int] = OMIT, + payment_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> PayOrderResponse: + """ + Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment) + or settle an order with a total of `0`. + + The total of the `payment_ids` listed in the request must be equal to the order + total. Orders with a total amount of `0` can be marked as paid by specifying an empty + array of `payment_ids` in the request. + + To be used with `PayOrder`, a payment must: + + - Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment). + Any approved payments that reference the same `order_id` not specified in the + `payment_ids` is canceled. + - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). + Using a delayed capture payment with `PayOrder` completes the approved payment. + + Parameters + ---------- + order_id : str + The ID of the order being paid. + + idempotency_key : str + A value you specify that uniquely identifies this request among requests you have sent. If + you are unsure whether a particular payment request was completed successfully, you can reattempt + it with the same idempotency key without worrying about duplicate payments. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order_version : typing.Optional[int] + The version of the order being paid. If not supplied, the latest version will be paid. + + payment_ids : typing.Optional[typing.Sequence[str]] + The IDs of the [payments](entity:Payment) to collect. + The payment total must match the order total. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + PayOrderResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.pay( + order_id="order_id", + idempotency_key="c043a359-7ad9-4136-82a9-c3f1d66dcbff", + payment_ids=[ + "EnZdNAlWCmfh6Mt5FMNST1o7taB", + "0LRiVlbXVwe8ozu4KbZxd12mvaB", + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.pay( + order_id, + idempotency_key=idempotency_key, + order_version=order_version, + payment_ids=payment_ids, + request_options=request_options, + ) + return response.data diff --git a/src/square/orders/custom_attribute_definitions/__init__.py b/src/square/orders/custom_attribute_definitions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/orders/custom_attribute_definitions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/orders/custom_attribute_definitions/client.py b/src/square/orders/custom_attribute_definitions/client.py new file mode 100644 index 00000000..e4deec15 --- /dev/null +++ b/src/square/orders/custom_attribute_definitions/client.py @@ -0,0 +1,674 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributeDefinitionsClient +from ...types.visibility_filter import VisibilityFilter +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.custom_attribute_definition import CustomAttributeDefinition +from ...types.list_order_custom_attribute_definitions_response import ListOrderCustomAttributeDefinitionsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...types.create_order_custom_attribute_definition_response import CreateOrderCustomAttributeDefinitionResponse +from ...types.retrieve_order_custom_attribute_definition_response import RetrieveOrderCustomAttributeDefinitionResponse +from ...types.update_order_custom_attribute_definition_response import UpdateOrderCustomAttributeDefinitionResponse +from ...types.delete_order_custom_attribute_definition_response import DeleteOrderCustomAttributeDefinitionResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributeDefinitionsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributeDefinitionsClient + """ + return self._raw_client + + def list( + self, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttributeDefinition]: + """ + Lists the order-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that + seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + visibility_filter : typing.Optional[VisibilityFilter] + Requests that all of the custom attributes be returned, or only those that are read-only or read-write. + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.orders.custom_attribute_definitions.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/orders/custom-attribute-definitions", + method="GET", + params={ + "visibility_filter": visibility_filter, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListOrderCustomAttributeDefinitionsResponse, + construct_type( + type_=ListOrderCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + visibility_filter=visibility_filter, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateOrderCustomAttributeDefinitionResponse: + """ + Creates an order-related custom attribute definition. Use this endpoint to + define a custom attribute that can be associated with orders. + + After creating a custom attribute definition, you can set the custom attribute for orders + in the Square seller account. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "cover-count", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "name": "Cover count", + "description": "The number of people seated at a table", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + }, + idempotency_key="IDEMPOTENCY_KEY", + ) + """ + response = self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveOrderCustomAttributeDefinitionResponse: + """ + Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attribute_definitions.get( + key="key", + ) + """ + response = self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateOrderCustomAttributeDefinitionResponse: + """ + Updates an order-related custom attribute definition for a Square seller account. + + Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, + so only new or changed fields need to be included in the request. For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "key": "cover-count", + "visibility": "VISIBILITY_READ_ONLY", + "version": 1, + }, + idempotency_key="IDEMPOTENCY_KEY", + ) + """ + response = self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteOrderCustomAttributeDefinitionResponse: + """ + Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attribute_definitions.delete( + key="key", + ) + """ + response = self._raw_client.delete(key, request_options=request_options) + return response.data + + +class AsyncCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributeDefinitionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributeDefinitionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributeDefinitionsClient + """ + return self._raw_client + + async def list( + self, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttributeDefinition]: + """ + Lists the order-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account. + + When all response pages are retrieved, the results include all custom attribute definitions + that are visible to the requesting application, including those that are created by other + applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that + seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + visibility_filter : typing.Optional[VisibilityFilter] + Requests that all of the custom attributes be returned, or only those that are read-only or read-write. + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttributeDefinition] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.orders.custom_attribute_definitions.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/orders/custom-attribute-definitions", + method="GET", + params={ + "visibility_filter": visibility_filter, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListOrderCustomAttributeDefinitionsResponse, + construct_type( + type_=ListOrderCustomAttributeDefinitionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + visibility_filter=visibility_filter, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.custom_attribute_definitions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateOrderCustomAttributeDefinitionResponse: + """ + Creates an order-related custom attribute definition. Use this endpoint to + define a custom attribute that can be associated with orders. + + After creating a custom attribute definition, you can set the custom attribute for orders + in the Square seller account. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": "cover-count", + "schema": { + "ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number" + }, + "name": "Cover count", + "description": "The number of people seated at a table", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + }, + idempotency_key="IDEMPOTENCY_KEY", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveOrderCustomAttributeDefinitionResponse: + """ + Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attribute_definitions.get( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(key, version=version, request_options=request_options) + return response.data + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateOrderCustomAttributeDefinitionResponse: + """ + Updates an order-related custom attribute definition for a Square seller account. + + Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, + so only new or changed fields need to be included in the request. For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attribute_definitions.update( + key="key", + custom_attribute_definition={ + "key": "cover-count", + "visibility": "VISIBILITY_READ_ONLY", + "version": 1, + }, + idempotency_key="IDEMPOTENCY_KEY", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + key, + custom_attribute_definition=custom_attribute_definition, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteOrderCustomAttributeDefinitionResponse: + """ + Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteOrderCustomAttributeDefinitionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attribute_definitions.delete( + key="key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(key, request_options=request_options) + return response.data diff --git a/src/square/orders/custom_attribute_definitions/raw_client.py b/src/square/orders/custom_attribute_definitions/raw_client.py new file mode 100644 index 00000000..4179529c --- /dev/null +++ b/src/square/orders/custom_attribute_definitions/raw_client.py @@ -0,0 +1,479 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.custom_attribute_definition import CustomAttributeDefinitionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_order_custom_attribute_definition_response import CreateOrderCustomAttributeDefinitionResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_order_custom_attribute_definition_response import RetrieveOrderCustomAttributeDefinitionResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_order_custom_attribute_definition_response import UpdateOrderCustomAttributeDefinitionResponse +from ...types.delete_order_custom_attribute_definition_response import DeleteOrderCustomAttributeDefinitionResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateOrderCustomAttributeDefinitionResponse]: + """ + Creates an order-related custom attribute definition. Use this endpoint to + define a custom attribute that can be associated with orders. + + After creating a custom attribute definition, you can set the custom attribute for orders + in the Square seller account. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateOrderCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateOrderCustomAttributeDefinitionResponse, + construct_type( + type_=CreateOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveOrderCustomAttributeDefinitionResponse]: + """ + Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveOrderCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveOrderCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateOrderCustomAttributeDefinitionResponse]: + """ + Updates an order-related custom attribute definition for a Square seller account. + + Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, + so only new or changed fields need to be included in the request. For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateOrderCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateOrderCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteOrderCustomAttributeDefinitionResponse]: + """ + Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteOrderCustomAttributeDefinitionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteOrderCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributeDefinitionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateOrderCustomAttributeDefinitionResponse]: + """ + Creates an order-related custom attribute definition. Use this endpoint to + define a custom attribute that can be associated with orders. + + After creating a custom attribute definition, you can set the custom attribute for orders + in the Square seller account. + + Parameters + ---------- + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition to create. Note the following: + - With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema + definition hosted on the Square CDN. For more information, including supported values and constraints, see + [Specifying the schema](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#specify-schema). + - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. + - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateOrderCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/custom-attribute-definitions", + method="POST", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateOrderCustomAttributeDefinitionResponse, + construct_type( + type_=CreateOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, key: str, *, version: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveOrderCustomAttributeDefinitionResponse]: + """ + Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + To retrieve a custom attribute definition created by another application, the `visibility` + setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to retrieve. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveOrderCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/custom-attribute-definitions/{jsonable_encoder(key)}", + method="GET", + params={ + "version": version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveOrderCustomAttributeDefinitionResponse, + construct_type( + type_=RetrieveOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + key: str, + *, + custom_attribute_definition: CustomAttributeDefinitionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateOrderCustomAttributeDefinitionResponse]: + """ + Updates an order-related custom attribute definition for a Square seller account. + + Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`. + + Parameters + ---------- + key : str + The key of the custom attribute definition to update. + + custom_attribute_definition : CustomAttributeDefinitionParams + The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, + so only new or changed fields need to be included in the request. For more information, see + [Updatable definition fields](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions#updatable-definition-fields). + + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include the optional `version` field and specify the current version of the custom attribute definition. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateOrderCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/custom-attribute-definitions/{jsonable_encoder(key)}", + method="PUT", + json={ + "custom_attribute_definition": convert_and_respect_annotation_metadata( + object_=custom_attribute_definition, annotation=CustomAttributeDefinitionParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateOrderCustomAttributeDefinitionResponse, + construct_type( + type_=UpdateOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteOrderCustomAttributeDefinitionResponse]: + """ + Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account. + + Only the definition owner can delete a custom attribute definition. + + Parameters + ---------- + key : str + The key of the custom attribute definition to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteOrderCustomAttributeDefinitionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/custom-attribute-definitions/{jsonable_encoder(key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteOrderCustomAttributeDefinitionResponse, + construct_type( + type_=DeleteOrderCustomAttributeDefinitionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/orders/custom_attributes/__init__.py b/src/square/orders/custom_attributes/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/orders/custom_attributes/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/orders/custom_attributes/client.py b/src/square/orders/custom_attributes/client.py new file mode 100644 index 00000000..4db14c24 --- /dev/null +++ b/src/square/orders/custom_attributes/client.py @@ -0,0 +1,930 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCustomAttributesClient +from ...requests.bulk_delete_order_custom_attributes_request_delete_custom_attribute import ( + BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams, +) +from ...core.request_options import RequestOptions +from ...types.bulk_delete_order_custom_attributes_response import BulkDeleteOrderCustomAttributesResponse +from ...requests.bulk_upsert_order_custom_attributes_request_upsert_custom_attribute import ( + BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams, +) +from ...types.bulk_upsert_order_custom_attributes_response import BulkUpsertOrderCustomAttributesResponse +from ...types.visibility_filter import VisibilityFilter +from ...core.pagination import SyncPager +from ...types.custom_attribute import CustomAttribute +from ...core.jsonable_encoder import jsonable_encoder +from ...types.list_order_custom_attributes_response import ListOrderCustomAttributesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.retrieve_order_custom_attribute_response import RetrieveOrderCustomAttributeResponse +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_order_custom_attribute_response import UpsertOrderCustomAttributeResponse +from ...types.delete_order_custom_attribute_response import DeleteOrderCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCustomAttributesClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCustomAttributesClient + """ + return self._raw_client + + def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteOrderCustomAttributesResponse: + """ + Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete + requests and returns a map of individual delete responses. Each delete request has a unique ID + and provides an order ID and custom attribute. Each delete response is returned with the ID + of the corresponding request. + + To delete a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams] + A map of requests that correspond to individual delete operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteOrderCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attributes.batch_delete( + values={ + "cover-count": { + "key": "cover-count", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + "table-number": { + "key": "table-number", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + }, + ) + """ + response = self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertOrderCustomAttributesResponse: + """ + Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides an order ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams] + A map of requests that correspond to individual upsert operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertOrderCustomAttributesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attributes.batch_upsert( + values={ + "cover-count": { + "custom_attribute": { + "key": "cover-count", + "value": "6", + "version": 2, + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + "table-number": { + "custom_attribute": { + "key": "table-number", + "value": "11", + "version": 4, + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + }, + ) + """ + response = self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + def list( + self, + order_id: str, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with an order. + + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + visibility_filter : typing.Optional[VisibilityFilter] + Requests that all of the custom attributes be returned, or only those that are read-only or read-write. + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, + information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[CustomAttribute] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.orders.custom_attributes.list( + order_id="order_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes", + method="GET", + params={ + "visibility_filter": visibility_filter, + "cursor": cursor, + "limit": limit, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListOrderCustomAttributesResponse, + construct_type( + type_=ListOrderCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + order_id, + visibility_filter=visibility_filter, + cursor=_parsed_next, + limit=limit, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + order_id: str, + custom_attribute_key: str, + *, + version: typing.Optional[int] = None, + with_definition: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveOrderCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with an order. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to retrieve. This key must match the key of an + existing custom attribute definition. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, + information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveOrderCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attributes.get( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + ) + """ + response = self._raw_client.get( + order_id, + custom_attribute_key, + version=version, + with_definition=with_definition, + request_options=request_options, + ) + return response.data + + def upsert( + self, + order_id: str, + custom_attribute_key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertOrderCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for an order. + + Use this endpoint to set the value of a custom attribute for a specific order. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to create or update. This key must match the key + of an existing custom attribute definition. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertOrderCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attributes.upsert( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + custom_attribute={"key": "table-number", "value": "42", "version": 1}, + ) + """ + response = self._raw_client.upsert( + order_id, + custom_attribute_key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + def delete( + self, order_id: str, custom_attribute_key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteOrderCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to delete. This key must match the key of an + existing custom attribute definition. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteOrderCustomAttributeResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.orders.custom_attributes.delete( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + ) + """ + response = self._raw_client.delete(order_id, custom_attribute_key, request_options=request_options) + return response.data + + +class AsyncCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCustomAttributesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCustomAttributesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCustomAttributesClient + """ + return self._raw_client + + async def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkDeleteOrderCustomAttributesResponse: + """ + Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete + requests and returns a map of individual delete responses. Each delete request has a unique ID + and provides an order ID and custom attribute. Each delete response is returned with the ID + of the corresponding request. + + To delete a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams] + A map of requests that correspond to individual delete operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkDeleteOrderCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attributes.batch_delete( + values={ + "cover-count": { + "key": "cover-count", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + "table-number": { + "key": "table-number", + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_delete(values=values, request_options=request_options) + return response.data + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkUpsertOrderCustomAttributesResponse: + """ + Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides an order ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams] + A map of requests that correspond to individual upsert operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkUpsertOrderCustomAttributesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attributes.batch_upsert( + values={ + "cover-count": { + "custom_attribute": { + "key": "cover-count", + "value": "6", + "version": 2, + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + "table-number": { + "custom_attribute": { + "key": "table-number", + "value": "11", + "version": 4, + }, + "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_upsert(values=values, request_options=request_options) + return response.data + + async def list( + self, + order_id: str, + *, + visibility_filter: typing.Optional[VisibilityFilter] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + with_definitions: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[CustomAttribute]: + """ + Lists the [custom attributes](entity:CustomAttribute) associated with an order. + + You can use the `with_definitions` query parameter to also retrieve custom attribute definitions + in the same call. + + When all response pages are retrieved, the results include all custom attributes that are + visible to the requesting application, including those that are owned by other applications + and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + visibility_filter : typing.Optional[VisibilityFilter] + Requests that all of the custom attributes be returned, or only those that are read-only or read-write. + + cursor : typing.Optional[str] + The cursor returned in the paged response from the previous call to this endpoint. + Provide this cursor to retrieve the next page of results for your original request. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + limit : typing.Optional[int] + The maximum number of results to return in a single paged response. This limit is advisory. + The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. + The default value is 20. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + with_definitions : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, + information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[CustomAttribute] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.orders.custom_attributes.list( + order_id="order_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes", + method="GET", + params={ + "visibility_filter": visibility_filter, + "cursor": cursor, + "limit": limit, + "with_definitions": with_definitions, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListOrderCustomAttributesResponse, + construct_type( + type_=ListOrderCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + order_id, + visibility_filter=visibility_filter, + cursor=_parsed_next, + limit=limit, + with_definitions=with_definitions, + request_options=request_options, + ) + _items = _parsed_response.custom_attributes + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + order_id: str, + custom_attribute_key: str, + *, + version: typing.Optional[int] = None, + with_definition: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> RetrieveOrderCustomAttributeResponse: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with an order. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to retrieve. This key must match the key of an + existing custom attribute definition. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, + information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveOrderCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attributes.get( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get( + order_id, + custom_attribute_key, + version=version, + with_definition=with_definition, + request_options=request_options, + ) + return response.data + + async def upsert( + self, + order_id: str, + custom_attribute_key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpsertOrderCustomAttributeResponse: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for an order. + + Use this endpoint to set the value of a custom attribute for a specific order. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to create or update. This key must match the key + of an existing custom attribute definition. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertOrderCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attributes.upsert( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + custom_attribute={"key": "table-number", "value": "42", "version": 1}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert( + order_id, + custom_attribute_key, + custom_attribute=custom_attribute, + idempotency_key=idempotency_key, + request_options=request_options, + ) + return response.data + + async def delete( + self, order_id: str, custom_attribute_key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteOrderCustomAttributeResponse: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to delete. This key must match the key of an + existing custom attribute definition. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteOrderCustomAttributeResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.orders.custom_attributes.delete( + order_id="order_id", + custom_attribute_key="custom_attribute_key", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(order_id, custom_attribute_key, request_options=request_options) + return response.data diff --git a/src/square/orders/custom_attributes/raw_client.py b/src/square/orders/custom_attributes/raw_client.py new file mode 100644 index 00000000..7bcc5616 --- /dev/null +++ b/src/square/orders/custom_attributes/raw_client.py @@ -0,0 +1,694 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.bulk_delete_order_custom_attributes_request_delete_custom_attribute import ( + BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams, +) +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.bulk_delete_order_custom_attributes_response import BulkDeleteOrderCustomAttributesResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.bulk_upsert_order_custom_attributes_request_upsert_custom_attribute import ( + BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams, +) +from ...types.bulk_upsert_order_custom_attributes_response import BulkUpsertOrderCustomAttributesResponse +from ...types.retrieve_order_custom_attribute_response import RetrieveOrderCustomAttributeResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...requests.custom_attribute import CustomAttributeParams +from ...types.upsert_order_custom_attribute_response import UpsertOrderCustomAttributeResponse +from ...types.delete_order_custom_attribute_response import DeleteOrderCustomAttributeResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCustomAttributesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkDeleteOrderCustomAttributesResponse]: + """ + Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete + requests and returns a map of individual delete responses. Each delete request has a unique ID + and provides an order ID and custom attribute. Each delete response is returned with the ID + of the corresponding request. + + To delete a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams] + A map of requests that correspond to individual delete operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkDeleteOrderCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteOrderCustomAttributesResponse, + construct_type( + type_=BulkDeleteOrderCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkUpsertOrderCustomAttributesResponse]: + """ + Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides an order ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams] + A map of requests that correspond to individual upsert operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkUpsertOrderCustomAttributesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertOrderCustomAttributesResponse, + construct_type( + type_=BulkUpsertOrderCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + order_id: str, + custom_attribute_key: str, + *, + version: typing.Optional[int] = None, + with_definition: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RetrieveOrderCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with an order. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to retrieve. This key must match the key of an + existing custom attribute definition. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, + information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveOrderCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes/{jsonable_encoder(custom_attribute_key)}", + method="GET", + params={ + "version": version, + "with_definition": with_definition, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveOrderCustomAttributeResponse, + construct_type( + type_=RetrieveOrderCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def upsert( + self, + order_id: str, + custom_attribute_key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpsertOrderCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for an order. + + Use this endpoint to set the value of a custom attribute for a specific order. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to create or update. This key must match the key + of an existing custom attribute definition. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertOrderCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes/{jsonable_encoder(custom_attribute_key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertOrderCustomAttributeResponse, + construct_type( + type_=UpsertOrderCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, order_id: str, custom_attribute_key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteOrderCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to delete. This key must match the key of an + existing custom attribute definition. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteOrderCustomAttributeResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes/{jsonable_encoder(custom_attribute_key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteOrderCustomAttributeResponse, + construct_type( + type_=DeleteOrderCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCustomAttributesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def batch_delete( + self, + *, + values: typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkDeleteOrderCustomAttributesResponse]: + """ + Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete + requests and returns a map of individual delete responses. Each delete request has a unique ID + and provides an order ID and custom attribute. Each delete response is returned with the ID + of the corresponding request. + + To delete a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams] + A map of requests that correspond to individual delete operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkDeleteOrderCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/custom-attributes/bulk-delete", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkDeleteOrderCustomAttributesResponse, + construct_type( + type_=BulkDeleteOrderCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_upsert( + self, + *, + values: typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkUpsertOrderCustomAttributesResponse]: + """ + Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation. + + Use this endpoint to delete one or more custom attributes from one or more orders. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert + requests and returns a map of individual upsert responses. Each upsert request has a unique ID + and provides an order ID and custom attribute. Each upsert response is returned with the ID + of the corresponding request. + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + values : typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams] + A map of requests that correspond to individual upsert operations for custom attributes. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkUpsertOrderCustomAttributesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/custom-attributes/bulk-upsert", + method="POST", + json={ + "values": convert_and_respect_annotation_metadata( + object_=values, + annotation=typing.Dict[str, BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkUpsertOrderCustomAttributesResponse, + construct_type( + type_=BulkUpsertOrderCustomAttributesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + order_id: str, + custom_attribute_key: str, + *, + version: typing.Optional[int] = None, + with_definition: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RetrieveOrderCustomAttributeResponse]: + """ + Retrieves a [custom attribute](entity:CustomAttribute) associated with an order. + + You can use the `with_definition` query parameter to also retrieve the custom attribute definition + in the same call. + + To retrieve a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to retrieve. This key must match the key of an + existing custom attribute definition. + + version : typing.Optional[int] + To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + with_definition : typing.Optional[bool] + Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each + custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, + information about the data type, or other definition details. The default value is `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveOrderCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes/{jsonable_encoder(custom_attribute_key)}", + method="GET", + params={ + "version": version, + "with_definition": with_definition, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveOrderCustomAttributeResponse, + construct_type( + type_=RetrieveOrderCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def upsert( + self, + order_id: str, + custom_attribute_key: str, + *, + custom_attribute: CustomAttributeParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpsertOrderCustomAttributeResponse]: + """ + Creates or updates a [custom attribute](entity:CustomAttribute) for an order. + + Use this endpoint to set the value of a custom attribute for a specific order. + A custom attribute is based on a custom attribute definition in a Square seller account. (To create a + custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.) + + To create or update a custom attribute owned by another application, the `visibility` setting + must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to create or update. This key must match the key + of an existing custom attribute definition. + + custom_attribute : CustomAttributeParams + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + + idempotency_key : typing.Optional[str] + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertOrderCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes/{jsonable_encoder(custom_attribute_key)}", + method="POST", + json={ + "custom_attribute": convert_and_respect_annotation_metadata( + object_=custom_attribute, annotation=CustomAttributeParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertOrderCustomAttributeResponse, + construct_type( + type_=UpsertOrderCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, order_id: str, custom_attribute_key: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteOrderCustomAttributeResponse]: + """ + Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile. + + To delete a custom attribute owned by another application, the `visibility` setting must be + `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes + (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. + + Parameters + ---------- + order_id : str + The ID of the target [order](entity:Order). + + custom_attribute_key : str + The key of the custom attribute to delete. This key must match the key of an + existing custom attribute definition. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteOrderCustomAttributeResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/custom-attributes/{jsonable_encoder(custom_attribute_key)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteOrderCustomAttributeResponse, + construct_type( + type_=DeleteOrderCustomAttributeResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/orders/raw_client.py b/src/square/orders/raw_client.py new file mode 100644 index 00000000..3127e2f5 --- /dev/null +++ b/src/square/orders/raw_client.py @@ -0,0 +1,1173 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.order import OrderParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_order_response import CreateOrderResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.batch_get_orders_response import BatchGetOrdersResponse +from ..requests.order_reward import OrderRewardParams +from ..types.calculate_order_response import CalculateOrderResponse +from ..types.clone_order_response import CloneOrderResponse +from ..requests.search_orders_query import SearchOrdersQueryParams +from ..types.search_orders_response import SearchOrdersResponse +from ..types.get_order_response import GetOrderResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_order_response import UpdateOrderResponse +from ..types.pay_order_response import PayOrderResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawOrdersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + order: typing.Optional[OrderParams] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateOrderResponse]: + """ + Creates a new [order](entity:Order) that can include information about products for + purchase and settings to apply to the purchase. + + To pay for a created order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + You can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + + Parameters + ---------- + order : typing.Optional[OrderParams] + The order to create. If this field is set, the only other top-level field that can be + set is the `idempotency_key`. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this + order among orders you have created. + + If you are unsure whether a particular order was created successfully, + you can try it again with the same idempotency key without + worrying about creating duplicate orders. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateOrderResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders", + method="POST", + json={ + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateOrderResponse, + construct_type( + type_=CreateOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_get( + self, + *, + order_ids: typing.Sequence[str], + location_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchGetOrdersResponse]: + """ + Retrieves a set of [orders](entity:Order) by their IDs. + + If a given order ID does not exist, the ID is ignored instead of generating an error. + + Parameters + ---------- + order_ids : typing.Sequence[str] + The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. + + location_id : typing.Optional[str] + The ID of the location for these orders. This field is optional: omit it to retrieve + orders within the scope of the current authorization's merchant ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchGetOrdersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/batch-retrieve", + method="POST", + json={ + "location_id": location_id, + "order_ids": order_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetOrdersResponse, + construct_type( + type_=BatchGetOrdersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def calculate( + self, + *, + order: OrderParams, + proposed_rewards: typing.Optional[typing.Sequence[OrderRewardParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CalculateOrderResponse]: + """ + Enables applications to preview order pricing without creating an order. + + Parameters + ---------- + order : OrderParams + The order to be calculated. Expects the entire order, not a sparse update. + + proposed_rewards : typing.Optional[typing.Sequence[OrderRewardParams]] + Identifies one or more loyalty reward tiers to apply during the order calculation. + The discounts defined by the reward tiers are added to the order only to preview the + effect of applying the specified rewards. The rewards do not correspond to actual + redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are + random strings used only to reference the reward tier. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CalculateOrderResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/calculate", + method="POST", + json={ + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "proposed_rewards": convert_and_respect_annotation_metadata( + object_=proposed_rewards, + annotation=typing.Optional[typing.Sequence[OrderRewardParams]], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CalculateOrderResponse, + construct_type( + type_=CalculateOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def clone( + self, + *, + order_id: str, + version: typing.Optional[int] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CloneOrderResponse]: + """ + Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has + only the core fields (such as line items, taxes, and discounts) copied from the original order. + + Parameters + ---------- + order_id : str + The ID of the order to clone. + + version : typing.Optional[int] + An optional order version for concurrency protection. + + If a version is provided, it must match the latest stored version of the order to clone. + If a version is not provided, the API clones the latest version. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this clone request. + + If you are unsure whether a particular order was cloned successfully, + you can reattempt the call with the same idempotency key without + worrying about creating duplicate cloned orders. + The originally cloned order is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CloneOrderResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/clone", + method="POST", + json={ + "order_id": order_id, + "version": version, + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CloneOrderResponse, + construct_type( + type_=CloneOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + query: typing.Optional[SearchOrdersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + return_entries: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchOrdersResponse]: + """ + Search all orders for one or more locations. Orders include all sales, + returns, and exchanges regardless of how or when they entered the Square + ecosystem (such as Point of Sale, Invoices, and Connect APIs). + + `SearchOrders` requests need to specify which locations to search and define a + [SearchOrdersQuery](entity:SearchOrdersQuery) object that controls + how to sort or filter the results. Your `SearchOrdersQuery` can: + + Set filter criteria. + Set the sort order. + Determine whether to return results as complete `Order` objects or as + [OrderEntry](entity:OrderEntry) objects. + + Note that details for orders processed with Square Point of Sale while in + offline mode might not be transmitted to Square for up to 72 hours. Offline + orders have a `created_at` value that reflects the time the order was created, + not the time it was subsequently transmitted to Square. + + Parameters + ---------- + location_ids : typing.Optional[typing.Sequence[str]] + The location IDs for the orders to query. All locations must belong to + the same merchant. + + Max: 10 location IDs. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[SearchOrdersQueryParams] + Query conditions used to filter or sort the results. Note that when + retrieving additional pages using a cursor, you must use the original query. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + + Default: `500` + Max: `1000` + + return_entries : typing.Optional[bool] + A Boolean that controls the format of the search results. If `true`, + `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders` + returns complete order objects. + + Default: `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchOrdersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/orders/search", + method="POST", + json={ + "location_ids": location_ids, + "cursor": cursor, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchOrdersQueryParams, direction="write" + ), + "limit": limit, + "return_entries": return_entries, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchOrdersResponse, + construct_type( + type_=SearchOrdersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetOrderResponse]: + """ + Retrieves an [Order](entity:Order) by ID. + + Parameters + ---------- + order_id : str + The ID of the order to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetOrderResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetOrderResponse, + construct_type( + type_=GetOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + order_id: str, + *, + order: typing.Optional[OrderParams] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateOrderResponse]: + """ + Updates an open [order](entity:Order) by adding, replacing, or deleting + fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. + + An `UpdateOrder` request requires the following: + + - The `order_id` in the endpoint path, identifying the order to update. + - The latest `version` of the order to update. + - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + identifying the fields to clear. + + To pay for an order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + Parameters + ---------- + order_id : str + The ID of the order to update. + + order : typing.Optional[OrderParams] + The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + fields to clear. For example, `line_items[uid].note`. + For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this update request. + + If you are unsure whether a particular update was applied to an order successfully, + you can reattempt it with the same idempotency key without + worrying about creating duplicate updates to the order. + The latest order version is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateOrderResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}", + method="PUT", + json={ + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "fields_to_clear": fields_to_clear, + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateOrderResponse, + construct_type( + type_=UpdateOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def pay( + self, + order_id: str, + *, + idempotency_key: str, + order_version: typing.Optional[int] = OMIT, + payment_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[PayOrderResponse]: + """ + Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment) + or settle an order with a total of `0`. + + The total of the `payment_ids` listed in the request must be equal to the order + total. Orders with a total amount of `0` can be marked as paid by specifying an empty + array of `payment_ids` in the request. + + To be used with `PayOrder`, a payment must: + + - Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment). + Any approved payments that reference the same `order_id` not specified in the + `payment_ids` is canceled. + - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). + Using a delayed capture payment with `PayOrder` completes the approved payment. + + Parameters + ---------- + order_id : str + The ID of the order being paid. + + idempotency_key : str + A value you specify that uniquely identifies this request among requests you have sent. If + you are unsure whether a particular payment request was completed successfully, you can reattempt + it with the same idempotency key without worrying about duplicate payments. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order_version : typing.Optional[int] + The version of the order being paid. If not supplied, the latest version will be paid. + + payment_ids : typing.Optional[typing.Sequence[str]] + The IDs of the [payments](entity:Payment) to collect. + The payment total must match the order total. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[PayOrderResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/pay", + method="POST", + json={ + "idempotency_key": idempotency_key, + "order_version": order_version, + "payment_ids": payment_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PayOrderResponse, + construct_type( + type_=PayOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawOrdersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + order: typing.Optional[OrderParams] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateOrderResponse]: + """ + Creates a new [order](entity:Order) that can include information about products for + purchase and settings to apply to the purchase. + + To pay for a created order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + You can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + + Parameters + ---------- + order : typing.Optional[OrderParams] + The order to create. If this field is set, the only other top-level field that can be + set is the `idempotency_key`. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this + order among orders you have created. + + If you are unsure whether a particular order was created successfully, + you can try it again with the same idempotency key without + worrying about creating duplicate orders. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateOrderResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders", + method="POST", + json={ + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateOrderResponse, + construct_type( + type_=CreateOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_get( + self, + *, + order_ids: typing.Sequence[str], + location_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchGetOrdersResponse]: + """ + Retrieves a set of [orders](entity:Order) by their IDs. + + If a given order ID does not exist, the ID is ignored instead of generating an error. + + Parameters + ---------- + order_ids : typing.Sequence[str] + The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. + + location_id : typing.Optional[str] + The ID of the location for these orders. This field is optional: omit it to retrieve + orders within the scope of the current authorization's merchant ID. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchGetOrdersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/batch-retrieve", + method="POST", + json={ + "location_id": location_id, + "order_ids": order_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetOrdersResponse, + construct_type( + type_=BatchGetOrdersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def calculate( + self, + *, + order: OrderParams, + proposed_rewards: typing.Optional[typing.Sequence[OrderRewardParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CalculateOrderResponse]: + """ + Enables applications to preview order pricing without creating an order. + + Parameters + ---------- + order : OrderParams + The order to be calculated. Expects the entire order, not a sparse update. + + proposed_rewards : typing.Optional[typing.Sequence[OrderRewardParams]] + Identifies one or more loyalty reward tiers to apply during the order calculation. + The discounts defined by the reward tiers are added to the order only to preview the + effect of applying the specified rewards. The rewards do not correspond to actual + redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are + random strings used only to reference the reward tier. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CalculateOrderResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/calculate", + method="POST", + json={ + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "proposed_rewards": convert_and_respect_annotation_metadata( + object_=proposed_rewards, + annotation=typing.Optional[typing.Sequence[OrderRewardParams]], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CalculateOrderResponse, + construct_type( + type_=CalculateOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def clone( + self, + *, + order_id: str, + version: typing.Optional[int] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CloneOrderResponse]: + """ + Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has + only the core fields (such as line items, taxes, and discounts) copied from the original order. + + Parameters + ---------- + order_id : str + The ID of the order to clone. + + version : typing.Optional[int] + An optional order version for concurrency protection. + + If a version is provided, it must match the latest stored version of the order to clone. + If a version is not provided, the API clones the latest version. + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this clone request. + + If you are unsure whether a particular order was cloned successfully, + you can reattempt the call with the same idempotency key without + worrying about creating duplicate cloned orders. + The originally cloned order is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CloneOrderResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/clone", + method="POST", + json={ + "order_id": order_id, + "version": version, + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CloneOrderResponse, + construct_type( + type_=CloneOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + location_ids: typing.Optional[typing.Sequence[str]] = OMIT, + cursor: typing.Optional[str] = OMIT, + query: typing.Optional[SearchOrdersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + return_entries: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchOrdersResponse]: + """ + Search all orders for one or more locations. Orders include all sales, + returns, and exchanges regardless of how or when they entered the Square + ecosystem (such as Point of Sale, Invoices, and Connect APIs). + + `SearchOrders` requests need to specify which locations to search and define a + [SearchOrdersQuery](entity:SearchOrdersQuery) object that controls + how to sort or filter the results. Your `SearchOrdersQuery` can: + + Set filter criteria. + Set the sort order. + Determine whether to return results as complete `Order` objects or as + [OrderEntry](entity:OrderEntry) objects. + + Note that details for orders processed with Square Point of Sale while in + offline mode might not be transmitted to Square for up to 72 hours. Offline + orders have a `created_at` value that reflects the time the order was created, + not the time it was subsequently transmitted to Square. + + Parameters + ---------- + location_ids : typing.Optional[typing.Sequence[str]] + The location IDs for the orders to query. All locations must belong to + the same merchant. + + Max: 10 location IDs. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for your original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + query : typing.Optional[SearchOrdersQueryParams] + Query conditions used to filter or sort the results. Note that when + retrieving additional pages using a cursor, you must use the original query. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + + Default: `500` + Max: `1000` + + return_entries : typing.Optional[bool] + A Boolean that controls the format of the search results. If `true`, + `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders` + returns complete order objects. + + Default: `false`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchOrdersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/orders/search", + method="POST", + json={ + "location_ids": location_ids, + "cursor": cursor, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchOrdersQueryParams, direction="write" + ), + "limit": limit, + "return_entries": return_entries, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchOrdersResponse, + construct_type( + type_=SearchOrdersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetOrderResponse]: + """ + Retrieves an [Order](entity:Order) by ID. + + Parameters + ---------- + order_id : str + The ID of the order to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetOrderResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetOrderResponse, + construct_type( + type_=GetOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + order_id: str, + *, + order: typing.Optional[OrderParams] = OMIT, + fields_to_clear: typing.Optional[typing.Sequence[str]] = OMIT, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateOrderResponse]: + """ + Updates an open [order](entity:Order) by adding, replacing, or deleting + fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. + + An `UpdateOrder` request requires the following: + + - The `order_id` in the endpoint path, identifying the order to update. + - The latest `version` of the order to update. + - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + identifying the fields to clear. + + To pay for an order, see + [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). + + Parameters + ---------- + order_id : str + The ID of the order to update. + + order : typing.Optional[OrderParams] + The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) + containing only the fields to update and the version to which the update is + being applied. + + fields_to_clear : typing.Optional[typing.Sequence[str]] + The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) + fields to clear. For example, `line_items[uid].note`. + For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). + + idempotency_key : typing.Optional[str] + A value you specify that uniquely identifies this update request. + + If you are unsure whether a particular update was applied to an order successfully, + you can reattempt it with the same idempotency key without + worrying about creating duplicate updates to the order. + The latest order version is returned. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateOrderResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}", + method="PUT", + json={ + "order": convert_and_respect_annotation_metadata( + object_=order, annotation=OrderParams, direction="write" + ), + "fields_to_clear": fields_to_clear, + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateOrderResponse, + construct_type( + type_=UpdateOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def pay( + self, + order_id: str, + *, + idempotency_key: str, + order_version: typing.Optional[int] = OMIT, + payment_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[PayOrderResponse]: + """ + Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment) + or settle an order with a total of `0`. + + The total of the `payment_ids` listed in the request must be equal to the order + total. Orders with a total amount of `0` can be marked as paid by specifying an empty + array of `payment_ids` in the request. + + To be used with `PayOrder`, a payment must: + + - Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment). + Any approved payments that reference the same `order_id` not specified in the + `payment_ids` is canceled. + - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). + Using a delayed capture payment with `PayOrder` completes the approved payment. + + Parameters + ---------- + order_id : str + The ID of the order being paid. + + idempotency_key : str + A value you specify that uniquely identifies this request among requests you have sent. If + you are unsure whether a particular payment request was completed successfully, you can reattempt + it with the same idempotency key without worrying about duplicate payments. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + order_version : typing.Optional[int] + The version of the order being paid. If not supplied, the latest version will be paid. + + payment_ids : typing.Optional[typing.Sequence[str]] + The IDs of the [payments](entity:Payment) to collect. + The payment total must match the order total. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[PayOrderResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/orders/{jsonable_encoder(order_id)}/pay", + method="POST", + json={ + "idempotency_key": idempotency_key, + "order_version": order_version, + "payment_ids": payment_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PayOrderResponse, + construct_type( + type_=PayOrderResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/payments/__init__.py b/src/square/payments/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/payments/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/payments/client.py b/src/square/payments/client.py new file mode 100644 index 00000000..bf21b89c --- /dev/null +++ b/src/square/payments/client.py @@ -0,0 +1,1456 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawPaymentsClient +from ..types.list_payments_request_sort_field import ListPaymentsRequestSortField +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.payment import Payment +from ..types.list_payments_response import ListPaymentsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.money import MoneyParams +from ..requests.address import AddressParams +from ..requests.cash_payment_details import CashPaymentDetailsParams +from ..requests.external_payment_details import ExternalPaymentDetailsParams +from ..requests.customer_details import CustomerDetailsParams +from ..requests.offline_payment_details import OfflinePaymentDetailsParams +from ..types.create_payment_response import CreatePaymentResponse +from ..types.cancel_payment_by_idempotency_key_response import CancelPaymentByIdempotencyKeyResponse +from ..types.get_payment_response import GetPaymentResponse +from ..requests.payment import PaymentParams +from ..types.update_payment_response import UpdatePaymentResponse +from ..types.cancel_payment_response import CancelPaymentResponse +from ..types.complete_payment_response import CompletePaymentResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawPaymentsClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class PaymentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawPaymentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawPaymentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawPaymentsClient + """ + return self._raw_client + + def list( + self, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + total: typing.Optional[int] = None, + last4: typing.Optional[str] = None, + card_brand: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + is_offline_payment: typing.Optional[bool] = None, + offline_begin_time: typing.Optional[str] = None, + offline_end_time: typing.Optional[str] = None, + updated_at_begin_time: typing.Optional[str] = None, + updated_at_end_time: typing.Optional[str] = None, + sort_field: typing.Optional[ListPaymentsRequestSortField] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Payment]: + """ + Retrieves a list of payments taken by the account making the request. + + Results are eventually consistent, and new payments or changes to payments might take several + seconds to appear. + + The maximum results per page is 100. + + Parameters + ---------- + begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve payments for, in RFC 3339 format. + The range is determined using the `created_at` field for each Payment. + Inclusive. Default: The current time minus one year. + + end_time : typing.Optional[str] + Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The + range is determined using the `created_at` field for each Payment. + + Default: The current time. + + sort_order : typing.Optional[str] + The order in which results are listed by `ListPaymentsRequest.sort_field`: + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + location_id : typing.Optional[str] + Limit results to the location supplied. By default, results are returned + for the default (main) location associated with the seller. + + total : typing.Optional[int] + The exact amount in the `total_money` for a payment. + + last4 : typing.Optional[str] + The last four digits of a payment card. + + card_brand : typing.Optional[str] + The brand of the payment card (for example, VISA). + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + + The default value of 100 is also the maximum allowed value. If the provided value is + greater than 100, it is ignored and the default value is used instead. + + Default: `100` + + is_offline_payment : typing.Optional[bool] + Whether the payment was taken offline or not. + + offline_begin_time : typing.Optional[str] + Indicates the start of the time range for which to retrieve offline payments, in RFC 3339 + format for timestamps. The range is determined using the + `offline_payment_details.client_created_at` field for each Payment. If set, payments without a + value set in `offline_payment_details.client_created_at` will not be returned. + + Default: The current time. + + offline_end_time : typing.Optional[str] + Indicates the end of the time range for which to retrieve offline payments, in RFC 3339 + format for timestamps. The range is determined using the + `offline_payment_details.client_created_at` field for each Payment. If set, payments without a + value set in `offline_payment_details.client_created_at` will not be returned. + + Default: The current time. + + updated_at_begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The + range is determined using the `updated_at` field for each Payment. + + updated_at_end_time : typing.Optional[str] + Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The + range is determined using the `updated_at` field for each Payment. + + sort_field : typing.Optional[ListPaymentsRequestSortField] + The field used to sort results by. The default is `CREATED_AT`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Payment] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.payments.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/payments", + method="GET", + params={ + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + "location_id": location_id, + "total": total, + "last_4": last4, + "card_brand": card_brand, + "limit": limit, + "is_offline_payment": is_offline_payment, + "offline_begin_time": offline_begin_time, + "offline_end_time": offline_end_time, + "updated_at_begin_time": updated_at_begin_time, + "updated_at_end_time": updated_at_end_time, + "sort_field": sort_field, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPaymentsResponse, + construct_type( + type_=ListPaymentsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=_parsed_next, + location_id=location_id, + total=total, + last4=last4, + card_brand=card_brand, + limit=limit, + is_offline_payment=is_offline_payment, + offline_begin_time=offline_begin_time, + offline_end_time=offline_end_time, + updated_at_begin_time=updated_at_begin_time, + updated_at_end_time=updated_at_end_time, + sort_field=sort_field, + request_options=request_options, + ) + _items = _parsed_response.payments + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + source_id: str, + idempotency_key: str, + amount_money: typing.Optional[MoneyParams] = OMIT, + tip_money: typing.Optional[MoneyParams] = OMIT, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + delay_duration: typing.Optional[str] = OMIT, + delay_action: typing.Optional[str] = OMIT, + autocomplete: typing.Optional[bool] = OMIT, + order_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + location_id: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + accept_partial_authorization: typing.Optional[bool] = OMIT, + buyer_email_address: typing.Optional[str] = OMIT, + buyer_phone_number: typing.Optional[str] = OMIT, + billing_address: typing.Optional[AddressParams] = OMIT, + shipping_address: typing.Optional[AddressParams] = OMIT, + note: typing.Optional[str] = OMIT, + statement_description_identifier: typing.Optional[str] = OMIT, + cash_details: typing.Optional[CashPaymentDetailsParams] = OMIT, + external_details: typing.Optional[ExternalPaymentDetailsParams] = OMIT, + customer_details: typing.Optional[CustomerDetailsParams] = OMIT, + offline_payment_details: typing.Optional[OfflinePaymentDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreatePaymentResponse: + """ + Creates a payment using the provided source. You can use this endpoint + to charge a card (credit/debit card or + Square gift card) or record a payment that the seller received outside of Square + (cash payment from a buyer or a payment that an external entity + processed on behalf of the seller). + + The endpoint creates a + `Payment` object and returns it in the response. + + Parameters + ---------- + source_id : str + The ID for the source of funds for this payment. + This could be a payment token generated by the Web Payments SDK for any of its + [supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), + including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment + that the seller received outside of Square, specify either "CASH" or "EXTERNAL". + For more information, see + [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + idempotency_key : str + A unique string that identifies this `CreatePayment` request. Keys can be any valid string + but must be unique for every `CreatePayment` request. + + Note: The number of allowed characters might be less than the stated maximum, if multi-byte + characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : typing.Optional[MoneyParams] + The amount of money to accept for this payment, not including `tip_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + tip_money : typing.Optional[MoneyParams] + The amount designated as a tip, in addition to `amount_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money that the developer is taking as a fee + for facilitating the payment on behalf of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller + that is accepting the payment. The application must be from a developer + account in the same country and using the same currency code as the seller. + + For more information about the application fee scenario, see + [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + delay_duration : typing.Optional[str] + The duration of time after the payment's creation when Square automatically + either completes or cancels the payment depending on the `delay_action` field value. + For more information, see + [Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + This parameter should be specified as a time duration, in RFC 3339 format. + + Note: This feature is only supported for card payments. This parameter can only be set for a delayed + capture payment (`autocomplete=false`). + + Default: + + - Card-present payments: "PT36H" (36 hours) from the creation time. + - Card-not-present payments: "P7D" (7 days) from the creation time. + + delay_action : typing.Optional[str] + The action to be applied to the payment when the `delay_duration` has elapsed. The action must be + CANCEL or COMPLETE. For more information, see + [Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: CANCEL + + autocomplete : typing.Optional[bool] + If set to `true`, this payment will be completed when possible. If + set to `false`, this payment is held in an approved state until either + explicitly completed (captured) or canceled (voided). For more information, see + [Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). + + Default: true + + order_id : typing.Optional[str] + Associates a previously created order with this payment. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the payment. + + This is required if the `source_id` refers to a card on file created using the Cards API. + + location_id : typing.Optional[str] + The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is + used. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with + this payment. + + reference_id : typing.Optional[str] + A user-defined ID to associate with the payment. + + You can use this field to associate the payment to an entity in an external system + (for example, you might specify an order ID that is generated by a third-party shopping cart). + + verification_token : typing.Optional[str] + An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + accept_partial_authorization : typing.Optional[bool] + If set to `true` and charging a Square Gift Card, a payment might be returned with + `amount_money` equal to less than what was requested. For example, a request for $20 when charging + a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose + to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card + payment. This field cannot be `true` when `autocomplete = true`. + + For more information, see + [Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). + + Default: false + + buyer_email_address : typing.Optional[str] + The buyer's email address. + + buyer_phone_number : typing.Optional[str] + The buyer's phone number. + Must follow the following format: + 1. A leading + symbol (followed by a country code) + 2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`. + Alphabetical characters aren't allowed. + 3. The phone number must contain between 9 and 16 digits. + + billing_address : typing.Optional[AddressParams] + The buyer's billing address. + + shipping_address : typing.Optional[AddressParams] + The buyer's shipping address. + + note : typing.Optional[str] + An optional note to be entered by the developer when creating a payment. + + statement_description_identifier : typing.Optional[str] + Optional additional payment information to include on the customer's card statement + as part of the statement description. This can be, for example, an invoice number, ticket number, + or short description that uniquely identifies the purchase. + + Note that the `statement_description_identifier` might get truncated on the statement description + to fit the required information including the Square identifier (SQ *) and name of the + seller taking the payment. + + cash_details : typing.Optional[CashPaymentDetailsParams] + Additional details required when recording a cash payment (`source_id` is CASH). + + external_details : typing.Optional[ExternalPaymentDetailsParams] + Additional details required when recording an external payment (`source_id` is EXTERNAL). + + customer_details : typing.Optional[CustomerDetailsParams] + Details about the customer making the payment. + + offline_payment_details : typing.Optional[OfflinePaymentDetailsParams] + An optional field for specifying the offline payment details. This is intended for + internal 1st-party callers only. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreatePaymentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payments.create( + source_id="ccof:GaJGNaZa8x4OgDJn4GB", + idempotency_key="7b0f3ec5-086a-4871-8f13-3c81b3875218", + amount_money={"amount": 1000, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=True, + customer_id="W92WH6P11H4Z77CTET0RNTGFW8", + location_id="L88917AVBK2S5", + reference_id="123456", + note="Brief description", + ) + """ + response = self._raw_client.create( + source_id=source_id, + idempotency_key=idempotency_key, + amount_money=amount_money, + tip_money=tip_money, + app_fee_money=app_fee_money, + delay_duration=delay_duration, + delay_action=delay_action, + autocomplete=autocomplete, + order_id=order_id, + customer_id=customer_id, + location_id=location_id, + team_member_id=team_member_id, + reference_id=reference_id, + verification_token=verification_token, + accept_partial_authorization=accept_partial_authorization, + buyer_email_address=buyer_email_address, + buyer_phone_number=buyer_phone_number, + billing_address=billing_address, + shipping_address=shipping_address, + note=note, + statement_description_identifier=statement_description_identifier, + cash_details=cash_details, + external_details=external_details, + customer_details=customer_details, + offline_payment_details=offline_payment_details, + request_options=request_options, + ) + return response.data + + def cancel_by_idempotency_key( + self, *, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> CancelPaymentByIdempotencyKeyResponse: + """ + Cancels (voids) a payment identified by the idempotency key that is specified in the + request. + + Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a + `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can + direct Square to cancel the payment using this endpoint. In the request, you provide the same + idempotency key that you provided in your `CreatePayment` request that you want to cancel. After + canceling the payment, you can submit your `CreatePayment` request again. + + Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint + returns successfully. + + Parameters + ---------- + idempotency_key : str + The `idempotency_key` identifying the payment to be canceled. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelPaymentByIdempotencyKeyResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payments.cancel_by_idempotency_key( + idempotency_key="a7e36d40-d24b-11e8-b568-0800200c9a66", + ) + """ + response = self._raw_client.cancel_by_idempotency_key( + idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def get(self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetPaymentResponse: + """ + Retrieves details for a specific payment. + + Parameters + ---------- + payment_id : str + A unique ID for the desired payment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPaymentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payments.get( + payment_id="payment_id", + ) + """ + response = self._raw_client.get(payment_id, request_options=request_options) + return response.data + + def update( + self, + payment_id: str, + *, + idempotency_key: str, + payment: typing.Optional[PaymentParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdatePaymentResponse: + """ + Updates a payment with the APPROVED status. + You can update the `amount_money` and `tip_money` using this endpoint. + + Parameters + ---------- + payment_id : str + The ID of the payment to update. + + idempotency_key : str + A unique string that identifies this `UpdatePayment` request. Keys can be any valid string + but must be unique for every `UpdatePayment` request. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + payment : typing.Optional[PaymentParams] + The updated `Payment` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdatePaymentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payments.update( + payment_id="payment_id", + payment={ + "amount_money": {"amount": 1000, "currency": "USD"}, + "tip_money": {"amount": 100, "currency": "USD"}, + "version_token": "ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o", + }, + idempotency_key="956f8b13-e4ec-45d6-85e8-d1d95ef0c5de", + ) + """ + response = self._raw_client.update( + payment_id, idempotency_key=idempotency_key, payment=payment, request_options=request_options + ) + return response.data + + def cancel( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelPaymentResponse: + """ + Cancels (voids) a payment. You can use this endpoint to cancel a payment with + the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The ID of the payment to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelPaymentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payments.cancel( + payment_id="payment_id", + ) + """ + response = self._raw_client.cancel(payment_id, request_options=request_options) + return response.data + + def complete( + self, + payment_id: str, + *, + version_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CompletePaymentResponse: + """ + Completes (captures) a payment. + By default, payments are set to complete immediately after they are created. + + You can use this endpoint to complete a payment with the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The unique ID identifying the payment to be completed. + + version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CompletePaymentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payments.complete( + payment_id="payment_id", + ) + """ + response = self._raw_client.complete(payment_id, version_token=version_token, request_options=request_options) + return response.data + + +class AsyncPaymentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawPaymentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawPaymentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawPaymentsClient + """ + return self._raw_client + + async def list( + self, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + total: typing.Optional[int] = None, + last4: typing.Optional[str] = None, + card_brand: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + is_offline_payment: typing.Optional[bool] = None, + offline_begin_time: typing.Optional[str] = None, + offline_end_time: typing.Optional[str] = None, + updated_at_begin_time: typing.Optional[str] = None, + updated_at_end_time: typing.Optional[str] = None, + sort_field: typing.Optional[ListPaymentsRequestSortField] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Payment]: + """ + Retrieves a list of payments taken by the account making the request. + + Results are eventually consistent, and new payments or changes to payments might take several + seconds to appear. + + The maximum results per page is 100. + + Parameters + ---------- + begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve payments for, in RFC 3339 format. + The range is determined using the `created_at` field for each Payment. + Inclusive. Default: The current time minus one year. + + end_time : typing.Optional[str] + Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The + range is determined using the `created_at` field for each Payment. + + Default: The current time. + + sort_order : typing.Optional[str] + The order in which results are listed by `ListPaymentsRequest.sort_field`: + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + location_id : typing.Optional[str] + Limit results to the location supplied. By default, results are returned + for the default (main) location associated with the seller. + + total : typing.Optional[int] + The exact amount in the `total_money` for a payment. + + last4 : typing.Optional[str] + The last four digits of a payment card. + + card_brand : typing.Optional[str] + The brand of the payment card (for example, VISA). + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + + The default value of 100 is also the maximum allowed value. If the provided value is + greater than 100, it is ignored and the default value is used instead. + + Default: `100` + + is_offline_payment : typing.Optional[bool] + Whether the payment was taken offline or not. + + offline_begin_time : typing.Optional[str] + Indicates the start of the time range for which to retrieve offline payments, in RFC 3339 + format for timestamps. The range is determined using the + `offline_payment_details.client_created_at` field for each Payment. If set, payments without a + value set in `offline_payment_details.client_created_at` will not be returned. + + Default: The current time. + + offline_end_time : typing.Optional[str] + Indicates the end of the time range for which to retrieve offline payments, in RFC 3339 + format for timestamps. The range is determined using the + `offline_payment_details.client_created_at` field for each Payment. If set, payments without a + value set in `offline_payment_details.client_created_at` will not be returned. + + Default: The current time. + + updated_at_begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The + range is determined using the `updated_at` field for each Payment. + + updated_at_end_time : typing.Optional[str] + Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The + range is determined using the `updated_at` field for each Payment. + + sort_field : typing.Optional[ListPaymentsRequestSortField] + The field used to sort results by. The default is `CREATED_AT`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Payment] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.payments.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/payments", + method="GET", + params={ + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + "location_id": location_id, + "total": total, + "last_4": last4, + "card_brand": card_brand, + "limit": limit, + "is_offline_payment": is_offline_payment, + "offline_begin_time": offline_begin_time, + "offline_end_time": offline_end_time, + "updated_at_begin_time": updated_at_begin_time, + "updated_at_end_time": updated_at_end_time, + "sort_field": sort_field, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPaymentsResponse, + construct_type( + type_=ListPaymentsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=_parsed_next, + location_id=location_id, + total=total, + last4=last4, + card_brand=card_brand, + limit=limit, + is_offline_payment=is_offline_payment, + offline_begin_time=offline_begin_time, + offline_end_time=offline_end_time, + updated_at_begin_time=updated_at_begin_time, + updated_at_end_time=updated_at_end_time, + sort_field=sort_field, + request_options=request_options, + ) + _items = _parsed_response.payments + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + source_id: str, + idempotency_key: str, + amount_money: typing.Optional[MoneyParams] = OMIT, + tip_money: typing.Optional[MoneyParams] = OMIT, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + delay_duration: typing.Optional[str] = OMIT, + delay_action: typing.Optional[str] = OMIT, + autocomplete: typing.Optional[bool] = OMIT, + order_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + location_id: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + accept_partial_authorization: typing.Optional[bool] = OMIT, + buyer_email_address: typing.Optional[str] = OMIT, + buyer_phone_number: typing.Optional[str] = OMIT, + billing_address: typing.Optional[AddressParams] = OMIT, + shipping_address: typing.Optional[AddressParams] = OMIT, + note: typing.Optional[str] = OMIT, + statement_description_identifier: typing.Optional[str] = OMIT, + cash_details: typing.Optional[CashPaymentDetailsParams] = OMIT, + external_details: typing.Optional[ExternalPaymentDetailsParams] = OMIT, + customer_details: typing.Optional[CustomerDetailsParams] = OMIT, + offline_payment_details: typing.Optional[OfflinePaymentDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreatePaymentResponse: + """ + Creates a payment using the provided source. You can use this endpoint + to charge a card (credit/debit card or + Square gift card) or record a payment that the seller received outside of Square + (cash payment from a buyer or a payment that an external entity + processed on behalf of the seller). + + The endpoint creates a + `Payment` object and returns it in the response. + + Parameters + ---------- + source_id : str + The ID for the source of funds for this payment. + This could be a payment token generated by the Web Payments SDK for any of its + [supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), + including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment + that the seller received outside of Square, specify either "CASH" or "EXTERNAL". + For more information, see + [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + idempotency_key : str + A unique string that identifies this `CreatePayment` request. Keys can be any valid string + but must be unique for every `CreatePayment` request. + + Note: The number of allowed characters might be less than the stated maximum, if multi-byte + characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : typing.Optional[MoneyParams] + The amount of money to accept for this payment, not including `tip_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + tip_money : typing.Optional[MoneyParams] + The amount designated as a tip, in addition to `amount_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money that the developer is taking as a fee + for facilitating the payment on behalf of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller + that is accepting the payment. The application must be from a developer + account in the same country and using the same currency code as the seller. + + For more information about the application fee scenario, see + [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + delay_duration : typing.Optional[str] + The duration of time after the payment's creation when Square automatically + either completes or cancels the payment depending on the `delay_action` field value. + For more information, see + [Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + This parameter should be specified as a time duration, in RFC 3339 format. + + Note: This feature is only supported for card payments. This parameter can only be set for a delayed + capture payment (`autocomplete=false`). + + Default: + + - Card-present payments: "PT36H" (36 hours) from the creation time. + - Card-not-present payments: "P7D" (7 days) from the creation time. + + delay_action : typing.Optional[str] + The action to be applied to the payment when the `delay_duration` has elapsed. The action must be + CANCEL or COMPLETE. For more information, see + [Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: CANCEL + + autocomplete : typing.Optional[bool] + If set to `true`, this payment will be completed when possible. If + set to `false`, this payment is held in an approved state until either + explicitly completed (captured) or canceled (voided). For more information, see + [Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). + + Default: true + + order_id : typing.Optional[str] + Associates a previously created order with this payment. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the payment. + + This is required if the `source_id` refers to a card on file created using the Cards API. + + location_id : typing.Optional[str] + The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is + used. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with + this payment. + + reference_id : typing.Optional[str] + A user-defined ID to associate with the payment. + + You can use this field to associate the payment to an entity in an external system + (for example, you might specify an order ID that is generated by a third-party shopping cart). + + verification_token : typing.Optional[str] + An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + accept_partial_authorization : typing.Optional[bool] + If set to `true` and charging a Square Gift Card, a payment might be returned with + `amount_money` equal to less than what was requested. For example, a request for $20 when charging + a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose + to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card + payment. This field cannot be `true` when `autocomplete = true`. + + For more information, see + [Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). + + Default: false + + buyer_email_address : typing.Optional[str] + The buyer's email address. + + buyer_phone_number : typing.Optional[str] + The buyer's phone number. + Must follow the following format: + 1. A leading + symbol (followed by a country code) + 2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`. + Alphabetical characters aren't allowed. + 3. The phone number must contain between 9 and 16 digits. + + billing_address : typing.Optional[AddressParams] + The buyer's billing address. + + shipping_address : typing.Optional[AddressParams] + The buyer's shipping address. + + note : typing.Optional[str] + An optional note to be entered by the developer when creating a payment. + + statement_description_identifier : typing.Optional[str] + Optional additional payment information to include on the customer's card statement + as part of the statement description. This can be, for example, an invoice number, ticket number, + or short description that uniquely identifies the purchase. + + Note that the `statement_description_identifier` might get truncated on the statement description + to fit the required information including the Square identifier (SQ *) and name of the + seller taking the payment. + + cash_details : typing.Optional[CashPaymentDetailsParams] + Additional details required when recording a cash payment (`source_id` is CASH). + + external_details : typing.Optional[ExternalPaymentDetailsParams] + Additional details required when recording an external payment (`source_id` is EXTERNAL). + + customer_details : typing.Optional[CustomerDetailsParams] + Details about the customer making the payment. + + offline_payment_details : typing.Optional[OfflinePaymentDetailsParams] + An optional field for specifying the offline payment details. This is intended for + internal 1st-party callers only. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreatePaymentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payments.create( + source_id="ccof:GaJGNaZa8x4OgDJn4GB", + idempotency_key="7b0f3ec5-086a-4871-8f13-3c81b3875218", + amount_money={"amount": 1000, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=True, + customer_id="W92WH6P11H4Z77CTET0RNTGFW8", + location_id="L88917AVBK2S5", + reference_id="123456", + note="Brief description", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + source_id=source_id, + idempotency_key=idempotency_key, + amount_money=amount_money, + tip_money=tip_money, + app_fee_money=app_fee_money, + delay_duration=delay_duration, + delay_action=delay_action, + autocomplete=autocomplete, + order_id=order_id, + customer_id=customer_id, + location_id=location_id, + team_member_id=team_member_id, + reference_id=reference_id, + verification_token=verification_token, + accept_partial_authorization=accept_partial_authorization, + buyer_email_address=buyer_email_address, + buyer_phone_number=buyer_phone_number, + billing_address=billing_address, + shipping_address=shipping_address, + note=note, + statement_description_identifier=statement_description_identifier, + cash_details=cash_details, + external_details=external_details, + customer_details=customer_details, + offline_payment_details=offline_payment_details, + request_options=request_options, + ) + return response.data + + async def cancel_by_idempotency_key( + self, *, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> CancelPaymentByIdempotencyKeyResponse: + """ + Cancels (voids) a payment identified by the idempotency key that is specified in the + request. + + Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a + `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can + direct Square to cancel the payment using this endpoint. In the request, you provide the same + idempotency key that you provided in your `CreatePayment` request that you want to cancel. After + canceling the payment, you can submit your `CreatePayment` request again. + + Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint + returns successfully. + + Parameters + ---------- + idempotency_key : str + The `idempotency_key` identifying the payment to be canceled. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelPaymentByIdempotencyKeyResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payments.cancel_by_idempotency_key( + idempotency_key="a7e36d40-d24b-11e8-b568-0800200c9a66", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel_by_idempotency_key( + idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def get( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetPaymentResponse: + """ + Retrieves details for a specific payment. + + Parameters + ---------- + payment_id : str + A unique ID for the desired payment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPaymentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payments.get( + payment_id="payment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(payment_id, request_options=request_options) + return response.data + + async def update( + self, + payment_id: str, + *, + idempotency_key: str, + payment: typing.Optional[PaymentParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdatePaymentResponse: + """ + Updates a payment with the APPROVED status. + You can update the `amount_money` and `tip_money` using this endpoint. + + Parameters + ---------- + payment_id : str + The ID of the payment to update. + + idempotency_key : str + A unique string that identifies this `UpdatePayment` request. Keys can be any valid string + but must be unique for every `UpdatePayment` request. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + payment : typing.Optional[PaymentParams] + The updated `Payment` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdatePaymentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payments.update( + payment_id="payment_id", + payment={ + "amount_money": {"amount": 1000, "currency": "USD"}, + "tip_money": {"amount": 100, "currency": "USD"}, + "version_token": "ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o", + }, + idempotency_key="956f8b13-e4ec-45d6-85e8-d1d95ef0c5de", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + payment_id, idempotency_key=idempotency_key, payment=payment, request_options=request_options + ) + return response.data + + async def cancel( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelPaymentResponse: + """ + Cancels (voids) a payment. You can use this endpoint to cancel a payment with + the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The ID of the payment to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelPaymentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payments.cancel( + payment_id="payment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(payment_id, request_options=request_options) + return response.data + + async def complete( + self, + payment_id: str, + *, + version_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CompletePaymentResponse: + """ + Completes (captures) a payment. + By default, payments are set to complete immediately after they are created. + + You can use this endpoint to complete a payment with the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The unique ID identifying the payment to be completed. + + version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CompletePaymentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payments.complete( + payment_id="payment_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.complete( + payment_id, version_token=version_token, request_options=request_options + ) + return response.data diff --git a/src/square/payments/raw_client.py b/src/square/payments/raw_client.py new file mode 100644 index 00000000..c9794b0b --- /dev/null +++ b/src/square/payments/raw_client.py @@ -0,0 +1,1135 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.money import MoneyParams +from ..requests.address import AddressParams +from ..requests.cash_payment_details import CashPaymentDetailsParams +from ..requests.external_payment_details import ExternalPaymentDetailsParams +from ..requests.customer_details import CustomerDetailsParams +from ..requests.offline_payment_details import OfflinePaymentDetailsParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_payment_response import CreatePaymentResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.cancel_payment_by_idempotency_key_response import CancelPaymentByIdempotencyKeyResponse +from ..types.get_payment_response import GetPaymentResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..requests.payment import PaymentParams +from ..types.update_payment_response import UpdatePaymentResponse +from ..types.cancel_payment_response import CancelPaymentResponse +from ..types.complete_payment_response import CompletePaymentResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawPaymentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + source_id: str, + idempotency_key: str, + amount_money: typing.Optional[MoneyParams] = OMIT, + tip_money: typing.Optional[MoneyParams] = OMIT, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + delay_duration: typing.Optional[str] = OMIT, + delay_action: typing.Optional[str] = OMIT, + autocomplete: typing.Optional[bool] = OMIT, + order_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + location_id: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + accept_partial_authorization: typing.Optional[bool] = OMIT, + buyer_email_address: typing.Optional[str] = OMIT, + buyer_phone_number: typing.Optional[str] = OMIT, + billing_address: typing.Optional[AddressParams] = OMIT, + shipping_address: typing.Optional[AddressParams] = OMIT, + note: typing.Optional[str] = OMIT, + statement_description_identifier: typing.Optional[str] = OMIT, + cash_details: typing.Optional[CashPaymentDetailsParams] = OMIT, + external_details: typing.Optional[ExternalPaymentDetailsParams] = OMIT, + customer_details: typing.Optional[CustomerDetailsParams] = OMIT, + offline_payment_details: typing.Optional[OfflinePaymentDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreatePaymentResponse]: + """ + Creates a payment using the provided source. You can use this endpoint + to charge a card (credit/debit card or + Square gift card) or record a payment that the seller received outside of Square + (cash payment from a buyer or a payment that an external entity + processed on behalf of the seller). + + The endpoint creates a + `Payment` object and returns it in the response. + + Parameters + ---------- + source_id : str + The ID for the source of funds for this payment. + This could be a payment token generated by the Web Payments SDK for any of its + [supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), + including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment + that the seller received outside of Square, specify either "CASH" or "EXTERNAL". + For more information, see + [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + idempotency_key : str + A unique string that identifies this `CreatePayment` request. Keys can be any valid string + but must be unique for every `CreatePayment` request. + + Note: The number of allowed characters might be less than the stated maximum, if multi-byte + characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : typing.Optional[MoneyParams] + The amount of money to accept for this payment, not including `tip_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + tip_money : typing.Optional[MoneyParams] + The amount designated as a tip, in addition to `amount_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money that the developer is taking as a fee + for facilitating the payment on behalf of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller + that is accepting the payment. The application must be from a developer + account in the same country and using the same currency code as the seller. + + For more information about the application fee scenario, see + [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + delay_duration : typing.Optional[str] + The duration of time after the payment's creation when Square automatically + either completes or cancels the payment depending on the `delay_action` field value. + For more information, see + [Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + This parameter should be specified as a time duration, in RFC 3339 format. + + Note: This feature is only supported for card payments. This parameter can only be set for a delayed + capture payment (`autocomplete=false`). + + Default: + + - Card-present payments: "PT36H" (36 hours) from the creation time. + - Card-not-present payments: "P7D" (7 days) from the creation time. + + delay_action : typing.Optional[str] + The action to be applied to the payment when the `delay_duration` has elapsed. The action must be + CANCEL or COMPLETE. For more information, see + [Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: CANCEL + + autocomplete : typing.Optional[bool] + If set to `true`, this payment will be completed when possible. If + set to `false`, this payment is held in an approved state until either + explicitly completed (captured) or canceled (voided). For more information, see + [Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). + + Default: true + + order_id : typing.Optional[str] + Associates a previously created order with this payment. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the payment. + + This is required if the `source_id` refers to a card on file created using the Cards API. + + location_id : typing.Optional[str] + The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is + used. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with + this payment. + + reference_id : typing.Optional[str] + A user-defined ID to associate with the payment. + + You can use this field to associate the payment to an entity in an external system + (for example, you might specify an order ID that is generated by a third-party shopping cart). + + verification_token : typing.Optional[str] + An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + accept_partial_authorization : typing.Optional[bool] + If set to `true` and charging a Square Gift Card, a payment might be returned with + `amount_money` equal to less than what was requested. For example, a request for $20 when charging + a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose + to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card + payment. This field cannot be `true` when `autocomplete = true`. + + For more information, see + [Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). + + Default: false + + buyer_email_address : typing.Optional[str] + The buyer's email address. + + buyer_phone_number : typing.Optional[str] + The buyer's phone number. + Must follow the following format: + 1. A leading + symbol (followed by a country code) + 2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`. + Alphabetical characters aren't allowed. + 3. The phone number must contain between 9 and 16 digits. + + billing_address : typing.Optional[AddressParams] + The buyer's billing address. + + shipping_address : typing.Optional[AddressParams] + The buyer's shipping address. + + note : typing.Optional[str] + An optional note to be entered by the developer when creating a payment. + + statement_description_identifier : typing.Optional[str] + Optional additional payment information to include on the customer's card statement + as part of the statement description. This can be, for example, an invoice number, ticket number, + or short description that uniquely identifies the purchase. + + Note that the `statement_description_identifier` might get truncated on the statement description + to fit the required information including the Square identifier (SQ *) and name of the + seller taking the payment. + + cash_details : typing.Optional[CashPaymentDetailsParams] + Additional details required when recording a cash payment (`source_id` is CASH). + + external_details : typing.Optional[ExternalPaymentDetailsParams] + Additional details required when recording an external payment (`source_id` is EXTERNAL). + + customer_details : typing.Optional[CustomerDetailsParams] + Details about the customer making the payment. + + offline_payment_details : typing.Optional[OfflinePaymentDetailsParams] + An optional field for specifying the offline payment details. This is intended for + internal 1st-party callers only. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreatePaymentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/payments", + method="POST", + json={ + "source_id": source_id, + "idempotency_key": idempotency_key, + "amount_money": convert_and_respect_annotation_metadata( + object_=amount_money, annotation=MoneyParams, direction="write" + ), + "tip_money": convert_and_respect_annotation_metadata( + object_=tip_money, annotation=MoneyParams, direction="write" + ), + "app_fee_money": convert_and_respect_annotation_metadata( + object_=app_fee_money, annotation=MoneyParams, direction="write" + ), + "delay_duration": delay_duration, + "delay_action": delay_action, + "autocomplete": autocomplete, + "order_id": order_id, + "customer_id": customer_id, + "location_id": location_id, + "team_member_id": team_member_id, + "reference_id": reference_id, + "verification_token": verification_token, + "accept_partial_authorization": accept_partial_authorization, + "buyer_email_address": buyer_email_address, + "buyer_phone_number": buyer_phone_number, + "billing_address": convert_and_respect_annotation_metadata( + object_=billing_address, annotation=AddressParams, direction="write" + ), + "shipping_address": convert_and_respect_annotation_metadata( + object_=shipping_address, annotation=AddressParams, direction="write" + ), + "note": note, + "statement_description_identifier": statement_description_identifier, + "cash_details": convert_and_respect_annotation_metadata( + object_=cash_details, annotation=CashPaymentDetailsParams, direction="write" + ), + "external_details": convert_and_respect_annotation_metadata( + object_=external_details, annotation=ExternalPaymentDetailsParams, direction="write" + ), + "customer_details": convert_and_respect_annotation_metadata( + object_=customer_details, annotation=CustomerDetailsParams, direction="write" + ), + "offline_payment_details": convert_and_respect_annotation_metadata( + object_=offline_payment_details, annotation=OfflinePaymentDetailsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreatePaymentResponse, + construct_type( + type_=CreatePaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel_by_idempotency_key( + self, *, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelPaymentByIdempotencyKeyResponse]: + """ + Cancels (voids) a payment identified by the idempotency key that is specified in the + request. + + Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a + `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can + direct Square to cancel the payment using this endpoint. In the request, you provide the same + idempotency key that you provided in your `CreatePayment` request that you want to cancel. After + canceling the payment, you can submit your `CreatePayment` request again. + + Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint + returns successfully. + + Parameters + ---------- + idempotency_key : str + The `idempotency_key` identifying the payment to be canceled. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelPaymentByIdempotencyKeyResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/payments/cancel", + method="POST", + json={ + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelPaymentByIdempotencyKeyResponse, + construct_type( + type_=CancelPaymentByIdempotencyKeyResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetPaymentResponse]: + """ + Retrieves details for a specific payment. + + Parameters + ---------- + payment_id : str + A unique ID for the desired payment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetPaymentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPaymentResponse, + construct_type( + type_=GetPaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + payment_id: str, + *, + idempotency_key: str, + payment: typing.Optional[PaymentParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdatePaymentResponse]: + """ + Updates a payment with the APPROVED status. + You can update the `amount_money` and `tip_money` using this endpoint. + + Parameters + ---------- + payment_id : str + The ID of the payment to update. + + idempotency_key : str + A unique string that identifies this `UpdatePayment` request. Keys can be any valid string + but must be unique for every `UpdatePayment` request. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + payment : typing.Optional[PaymentParams] + The updated `Payment` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdatePaymentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}", + method="PUT", + json={ + "payment": convert_and_respect_annotation_metadata( + object_=payment, annotation=PaymentParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdatePaymentResponse, + construct_type( + type_=UpdatePaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelPaymentResponse]: + """ + Cancels (voids) a payment. You can use this endpoint to cancel a payment with + the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The ID of the payment to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelPaymentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelPaymentResponse, + construct_type( + type_=CancelPaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def complete( + self, + payment_id: str, + *, + version_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CompletePaymentResponse]: + """ + Completes (captures) a payment. + By default, payments are set to complete immediately after they are created. + + You can use this endpoint to complete a payment with the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The unique ID identifying the payment to be completed. + + version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CompletePaymentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}/complete", + method="POST", + json={ + "version_token": version_token, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CompletePaymentResponse, + construct_type( + type_=CompletePaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawPaymentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + source_id: str, + idempotency_key: str, + amount_money: typing.Optional[MoneyParams] = OMIT, + tip_money: typing.Optional[MoneyParams] = OMIT, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + delay_duration: typing.Optional[str] = OMIT, + delay_action: typing.Optional[str] = OMIT, + autocomplete: typing.Optional[bool] = OMIT, + order_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + location_id: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + reference_id: typing.Optional[str] = OMIT, + verification_token: typing.Optional[str] = OMIT, + accept_partial_authorization: typing.Optional[bool] = OMIT, + buyer_email_address: typing.Optional[str] = OMIT, + buyer_phone_number: typing.Optional[str] = OMIT, + billing_address: typing.Optional[AddressParams] = OMIT, + shipping_address: typing.Optional[AddressParams] = OMIT, + note: typing.Optional[str] = OMIT, + statement_description_identifier: typing.Optional[str] = OMIT, + cash_details: typing.Optional[CashPaymentDetailsParams] = OMIT, + external_details: typing.Optional[ExternalPaymentDetailsParams] = OMIT, + customer_details: typing.Optional[CustomerDetailsParams] = OMIT, + offline_payment_details: typing.Optional[OfflinePaymentDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreatePaymentResponse]: + """ + Creates a payment using the provided source. You can use this endpoint + to charge a card (credit/debit card or + Square gift card) or record a payment that the seller received outside of Square + (cash payment from a buyer or a payment that an external entity + processed on behalf of the seller). + + The endpoint creates a + `Payment` object and returns it in the response. + + Parameters + ---------- + source_id : str + The ID for the source of funds for this payment. + This could be a payment token generated by the Web Payments SDK for any of its + [supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), + including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment + that the seller received outside of Square, specify either "CASH" or "EXTERNAL". + For more information, see + [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + idempotency_key : str + A unique string that identifies this `CreatePayment` request. Keys can be any valid string + but must be unique for every `CreatePayment` request. + + Note: The number of allowed characters might be less than the stated maximum, if multi-byte + characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : typing.Optional[MoneyParams] + The amount of money to accept for this payment, not including `tip_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + tip_money : typing.Optional[MoneyParams] + The amount designated as a tip, in addition to `amount_money`. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is accepting the payment. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money that the developer is taking as a fee + for facilitating the payment on behalf of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller + that is accepting the payment. The application must be from a developer + account in the same country and using the same currency code as the seller. + + For more information about the application fee scenario, see + [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + delay_duration : typing.Optional[str] + The duration of time after the payment's creation when Square automatically + either completes or cancels the payment depending on the `delay_action` field value. + For more information, see + [Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + This parameter should be specified as a time duration, in RFC 3339 format. + + Note: This feature is only supported for card payments. This parameter can only be set for a delayed + capture payment (`autocomplete=false`). + + Default: + + - Card-present payments: "PT36H" (36 hours) from the creation time. + - Card-not-present payments: "P7D" (7 days) from the creation time. + + delay_action : typing.Optional[str] + The action to be applied to the payment when the `delay_duration` has elapsed. The action must be + CANCEL or COMPLETE. For more information, see + [Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: CANCEL + + autocomplete : typing.Optional[bool] + If set to `true`, this payment will be completed when possible. If + set to `false`, this payment is held in an approved state until either + explicitly completed (captured) or canceled (voided). For more information, see + [Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). + + Default: true + + order_id : typing.Optional[str] + Associates a previously created order with this payment. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the payment. + + This is required if the `source_id` refers to a card on file created using the Cards API. + + location_id : typing.Optional[str] + The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is + used. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with + this payment. + + reference_id : typing.Optional[str] + A user-defined ID to associate with the payment. + + You can use this field to associate the payment to an entity in an external system + (for example, you might specify an order ID that is generated by a third-party shopping cart). + + verification_token : typing.Optional[str] + An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). + Verification tokens encapsulate customer device information and 3-D Secure + challenge results to indicate that Square has verified the buyer identity. + + For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). + + accept_partial_authorization : typing.Optional[bool] + If set to `true` and charging a Square Gift Card, a payment might be returned with + `amount_money` equal to less than what was requested. For example, a request for $20 when charging + a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose + to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card + payment. This field cannot be `true` when `autocomplete = true`. + + For more information, see + [Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). + + Default: false + + buyer_email_address : typing.Optional[str] + The buyer's email address. + + buyer_phone_number : typing.Optional[str] + The buyer's phone number. + Must follow the following format: + 1. A leading + symbol (followed by a country code) + 2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`. + Alphabetical characters aren't allowed. + 3. The phone number must contain between 9 and 16 digits. + + billing_address : typing.Optional[AddressParams] + The buyer's billing address. + + shipping_address : typing.Optional[AddressParams] + The buyer's shipping address. + + note : typing.Optional[str] + An optional note to be entered by the developer when creating a payment. + + statement_description_identifier : typing.Optional[str] + Optional additional payment information to include on the customer's card statement + as part of the statement description. This can be, for example, an invoice number, ticket number, + or short description that uniquely identifies the purchase. + + Note that the `statement_description_identifier` might get truncated on the statement description + to fit the required information including the Square identifier (SQ *) and name of the + seller taking the payment. + + cash_details : typing.Optional[CashPaymentDetailsParams] + Additional details required when recording a cash payment (`source_id` is CASH). + + external_details : typing.Optional[ExternalPaymentDetailsParams] + Additional details required when recording an external payment (`source_id` is EXTERNAL). + + customer_details : typing.Optional[CustomerDetailsParams] + Details about the customer making the payment. + + offline_payment_details : typing.Optional[OfflinePaymentDetailsParams] + An optional field for specifying the offline payment details. This is intended for + internal 1st-party callers only. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreatePaymentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/payments", + method="POST", + json={ + "source_id": source_id, + "idempotency_key": idempotency_key, + "amount_money": convert_and_respect_annotation_metadata( + object_=amount_money, annotation=MoneyParams, direction="write" + ), + "tip_money": convert_and_respect_annotation_metadata( + object_=tip_money, annotation=MoneyParams, direction="write" + ), + "app_fee_money": convert_and_respect_annotation_metadata( + object_=app_fee_money, annotation=MoneyParams, direction="write" + ), + "delay_duration": delay_duration, + "delay_action": delay_action, + "autocomplete": autocomplete, + "order_id": order_id, + "customer_id": customer_id, + "location_id": location_id, + "team_member_id": team_member_id, + "reference_id": reference_id, + "verification_token": verification_token, + "accept_partial_authorization": accept_partial_authorization, + "buyer_email_address": buyer_email_address, + "buyer_phone_number": buyer_phone_number, + "billing_address": convert_and_respect_annotation_metadata( + object_=billing_address, annotation=AddressParams, direction="write" + ), + "shipping_address": convert_and_respect_annotation_metadata( + object_=shipping_address, annotation=AddressParams, direction="write" + ), + "note": note, + "statement_description_identifier": statement_description_identifier, + "cash_details": convert_and_respect_annotation_metadata( + object_=cash_details, annotation=CashPaymentDetailsParams, direction="write" + ), + "external_details": convert_and_respect_annotation_metadata( + object_=external_details, annotation=ExternalPaymentDetailsParams, direction="write" + ), + "customer_details": convert_and_respect_annotation_metadata( + object_=customer_details, annotation=CustomerDetailsParams, direction="write" + ), + "offline_payment_details": convert_and_respect_annotation_metadata( + object_=offline_payment_details, annotation=OfflinePaymentDetailsParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreatePaymentResponse, + construct_type( + type_=CreatePaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel_by_idempotency_key( + self, *, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelPaymentByIdempotencyKeyResponse]: + """ + Cancels (voids) a payment identified by the idempotency key that is specified in the + request. + + Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a + `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can + direct Square to cancel the payment using this endpoint. In the request, you provide the same + idempotency key that you provided in your `CreatePayment` request that you want to cancel. After + canceling the payment, you can submit your `CreatePayment` request again. + + Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint + returns successfully. + + Parameters + ---------- + idempotency_key : str + The `idempotency_key` identifying the payment to be canceled. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelPaymentByIdempotencyKeyResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/payments/cancel", + method="POST", + json={ + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelPaymentByIdempotencyKeyResponse, + construct_type( + type_=CancelPaymentByIdempotencyKeyResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetPaymentResponse]: + """ + Retrieves details for a specific payment. + + Parameters + ---------- + payment_id : str + A unique ID for the desired payment. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetPaymentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPaymentResponse, + construct_type( + type_=GetPaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + payment_id: str, + *, + idempotency_key: str, + payment: typing.Optional[PaymentParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdatePaymentResponse]: + """ + Updates a payment with the APPROVED status. + You can update the `amount_money` and `tip_money` using this endpoint. + + Parameters + ---------- + payment_id : str + The ID of the payment to update. + + idempotency_key : str + A unique string that identifies this `UpdatePayment` request. Keys can be any valid string + but must be unique for every `UpdatePayment` request. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + payment : typing.Optional[PaymentParams] + The updated `Payment` object. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdatePaymentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}", + method="PUT", + json={ + "payment": convert_and_respect_annotation_metadata( + object_=payment, annotation=PaymentParams, direction="write" + ), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdatePaymentResponse, + construct_type( + type_=UpdatePaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, payment_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelPaymentResponse]: + """ + Cancels (voids) a payment. You can use this endpoint to cancel a payment with + the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The ID of the payment to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelPaymentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelPaymentResponse, + construct_type( + type_=CancelPaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def complete( + self, + payment_id: str, + *, + version_token: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CompletePaymentResponse]: + """ + Completes (captures) a payment. + By default, payments are set to complete immediately after they are created. + + You can use this endpoint to complete a payment with the APPROVED `status`. + + Parameters + ---------- + payment_id : str + The unique ID identifying the payment to be completed. + + version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CompletePaymentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/payments/{jsonable_encoder(payment_id)}/complete", + method="POST", + json={ + "version_token": version_token, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CompletePaymentResponse, + construct_type( + type_=CompletePaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/payouts/__init__.py b/src/square/payouts/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/payouts/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/payouts/client.py b/src/square/payouts/client.py new file mode 100644 index 00000000..3f85b22b --- /dev/null +++ b/src/square/payouts/client.py @@ -0,0 +1,557 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawPayoutsClient +import typing +from ..types.payout_status import PayoutStatus +from ..types.sort_order import SortOrder +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.payout import Payout +from ..types.list_payouts_response import ListPayoutsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_payout_response import GetPayoutResponse +from ..types.payout_entry import PayoutEntry +from ..core.jsonable_encoder import jsonable_encoder +from ..types.list_payout_entries_response import ListPayoutEntriesResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawPayoutsClient +from ..core.pagination import AsyncPager + + +class PayoutsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawPayoutsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawPayoutsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawPayoutsClient + """ + return self._raw_client + + def list( + self, + *, + location_id: typing.Optional[str] = None, + status: typing.Optional[PayoutStatus] = None, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[Payout]: + """ + Retrieves a list of all payouts for the default location. + You can filter payouts by location ID, status, time range, and order them in ascending or descending order. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + location_id : typing.Optional[str] + The ID of the location for which to list the payouts. + By default, payouts are returned for the default (main) location associated with the seller. + + status : typing.Optional[PayoutStatus] + If provided, only payouts with the given status are returned. + + begin_time : typing.Optional[str] + The timestamp for the beginning of the payout creation time, in RFC 3339 format. + Inclusive. Default: The current time minus one year. + + end_time : typing.Optional[str] + The timestamp for the end of the payout creation time, in RFC 3339 format. + Default: The current time. + + sort_order : typing.Optional[SortOrder] + The order in which payouts are listed. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + If request parameters change between requests, subsequent results may contain duplicates or missing records. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + The default value of 100 is also the maximum allowed value. If the provided value is + greater than 100, it is ignored and the default value is used instead. + Default: `100` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[Payout] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.payouts.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/payouts", + method="GET", + params={ + "location_id": location_id, + "status": status, + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPayoutsResponse, + construct_type( + type_=ListPayoutsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + status=status, + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.payouts + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get(self, payout_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetPayoutResponse: + """ + Retrieves details of a specific payout identified by a payout ID. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + payout_id : str + The ID of the payout to retrieve the information for. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPayoutResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.payouts.get( + payout_id="payout_id", + ) + """ + response = self._raw_client.get(payout_id, request_options=request_options) + return response.data + + def list_entries( + self, + payout_id: str, + *, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[PayoutEntry]: + """ + Retrieves a list of all payout entries for a specific payout. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + payout_id : str + The ID of the payout to retrieve the information for. + + sort_order : typing.Optional[SortOrder] + The order in which payout entries are listed. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + If request parameters change between requests, subsequent results may contain duplicates or missing records. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + The default value of 100 is also the maximum allowed value. If the provided value is + greater than 100, it is ignored and the default value is used instead. + Default: `100` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[PayoutEntry] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.payouts.list_entries( + payout_id="payout_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/payouts/{jsonable_encoder(payout_id)}/payout-entries", + method="GET", + params={ + "sort_order": sort_order, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPayoutEntriesResponse, + construct_type( + type_=ListPayoutEntriesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list_entries( + payout_id, + sort_order=sort_order, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.payout_entries + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncPayoutsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawPayoutsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawPayoutsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawPayoutsClient + """ + return self._raw_client + + async def list( + self, + *, + location_id: typing.Optional[str] = None, + status: typing.Optional[PayoutStatus] = None, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[Payout]: + """ + Retrieves a list of all payouts for the default location. + You can filter payouts by location ID, status, time range, and order them in ascending or descending order. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + location_id : typing.Optional[str] + The ID of the location for which to list the payouts. + By default, payouts are returned for the default (main) location associated with the seller. + + status : typing.Optional[PayoutStatus] + If provided, only payouts with the given status are returned. + + begin_time : typing.Optional[str] + The timestamp for the beginning of the payout creation time, in RFC 3339 format. + Inclusive. Default: The current time minus one year. + + end_time : typing.Optional[str] + The timestamp for the end of the payout creation time, in RFC 3339 format. + Default: The current time. + + sort_order : typing.Optional[SortOrder] + The order in which payouts are listed. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + If request parameters change between requests, subsequent results may contain duplicates or missing records. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + The default value of 100 is also the maximum allowed value. If the provided value is + greater than 100, it is ignored and the default value is used instead. + Default: `100` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[Payout] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.payouts.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/payouts", + method="GET", + params={ + "location_id": location_id, + "status": status, + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPayoutsResponse, + construct_type( + type_=ListPayoutsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + location_id=location_id, + status=status, + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.payouts + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, payout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetPayoutResponse: + """ + Retrieves details of a specific payout identified by a payout ID. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + payout_id : str + The ID of the payout to retrieve the information for. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPayoutResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.payouts.get( + payout_id="payout_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(payout_id, request_options=request_options) + return response.data + + async def list_entries( + self, + payout_id: str, + *, + sort_order: typing.Optional[SortOrder] = None, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[PayoutEntry]: + """ + Retrieves a list of all payout entries for a specific payout. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + payout_id : str + The ID of the payout to retrieve the information for. + + sort_order : typing.Optional[SortOrder] + The order in which payout entries are listed. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + If request parameters change between requests, subsequent results may contain duplicates or missing records. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + The default value of 100 is also the maximum allowed value. If the provided value is + greater than 100, it is ignored and the default value is used instead. + Default: `100` + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[PayoutEntry] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.payouts.list_entries( + payout_id="payout_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/payouts/{jsonable_encoder(payout_id)}/payout-entries", + method="GET", + params={ + "sort_order": sort_order, + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPayoutEntriesResponse, + construct_type( + type_=ListPayoutEntriesResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list_entries( + payout_id, + sort_order=sort_order, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.payout_entries + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/payouts/raw_client.py b/src/square/payouts/raw_client.py new file mode 100644 index 00000000..447a4721 --- /dev/null +++ b/src/square/payouts/raw_client.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_payout_response import GetPayoutResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawPayoutsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, payout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetPayoutResponse]: + """ + Retrieves details of a specific payout identified by a payout ID. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + payout_id : str + The ID of the payout to retrieve the information for. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetPayoutResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/payouts/{jsonable_encoder(payout_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPayoutResponse, + construct_type( + type_=GetPayoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawPayoutsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, payout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetPayoutResponse]: + """ + Retrieves details of a specific payout identified by a payout ID. + To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. + + Parameters + ---------- + payout_id : str + The ID of the payout to retrieve the information for. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetPayoutResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/payouts/{jsonable_encoder(payout_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPayoutResponse, + construct_type( + type_=GetPayoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/py.typed b/src/square/py.typed new file mode 100644 index 00000000..e69de29b diff --git a/src/square/refunds/__init__.py b/src/square/refunds/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/refunds/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/refunds/client.py b/src/square/refunds/client.py new file mode 100644 index 00000000..83e269bf --- /dev/null +++ b/src/square/refunds/client.py @@ -0,0 +1,772 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawRefundsClient +from ..types.list_payment_refunds_request_sort_field import ListPaymentRefundsRequestSortField +from ..core.request_options import RequestOptions +from ..core.pagination import SyncPager +from ..types.payment_refund import PaymentRefund +from ..types.list_payment_refunds_response import ListPaymentRefundsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.money import MoneyParams +from ..requests.destination_details_cash_refund_details import DestinationDetailsCashRefundDetailsParams +from ..requests.destination_details_external_refund_details import DestinationDetailsExternalRefundDetailsParams +from ..types.refund_payment_response import RefundPaymentResponse +from ..types.get_payment_refund_response import GetPaymentRefundResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawRefundsClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RefundsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawRefundsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawRefundsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawRefundsClient + """ + return self._raw_client + + def list( + self, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + status: typing.Optional[str] = None, + source_type: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + updated_at_begin_time: typing.Optional[str] = None, + updated_at_end_time: typing.Optional[str] = None, + sort_field: typing.Optional[ListPaymentRefundsRequestSortField] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[PaymentRefund]: + """ + Retrieves a list of refunds for the account making the request. + + Results are eventually consistent, and new refunds or changes to refunds might take several + seconds to appear. + + The maximum results per page is 100. + + Parameters + ---------- + begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `created_at` field for each `PaymentRefund`. + + Default: The current time minus one year. + + end_time : typing.Optional[str] + Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `created_at` field for each `PaymentRefund`. + + Default: The current time. + + sort_order : typing.Optional[str] + The order in which results are listed by `PaymentRefund.created_at`: + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + location_id : typing.Optional[str] + Limit results to the location supplied. By default, results are returned + for all locations associated with the seller. + + status : typing.Optional[str] + If provided, only refunds with the given status are returned. + For a list of refund status values, see [PaymentRefund](entity:PaymentRefund). + + Default: If omitted, refunds are returned regardless of their status. + + source_type : typing.Optional[str] + If provided, only returns refunds whose payments have the indicated source type. + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. + For information about these payment source types, see + [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + Default: If omitted, refunds are returned regardless of the source type. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + + It is possible to receive fewer results than the specified limit on a given page. + + If the supplied value is greater than 100, no more than 100 results are returned. + + Default: 100 + + updated_at_begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `updated_at` field for each `PaymentRefund`. + + Default: If omitted, the time range starts at `begin_time`. + + updated_at_end_time : typing.Optional[str] + Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `updated_at` field for each `PaymentRefund`. + + Default: The current time. + + sort_field : typing.Optional[ListPaymentRefundsRequestSortField] + The field used to sort results by. The default is `CREATED_AT`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[PaymentRefund] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.refunds.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/refunds", + method="GET", + params={ + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + "location_id": location_id, + "status": status, + "source_type": source_type, + "limit": limit, + "updated_at_begin_time": updated_at_begin_time, + "updated_at_end_time": updated_at_end_time, + "sort_field": sort_field, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPaymentRefundsResponse, + construct_type( + type_=ListPaymentRefundsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=_parsed_next, + location_id=location_id, + status=status, + source_type=source_type, + limit=limit, + updated_at_begin_time=updated_at_begin_time, + updated_at_end_time=updated_at_end_time, + sort_field=sort_field, + request_options=request_options, + ) + _items = _parsed_response.refunds + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def refund_payment( + self, + *, + idempotency_key: str, + amount_money: MoneyParams, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + payment_id: typing.Optional[str] = OMIT, + destination_id: typing.Optional[str] = OMIT, + unlinked: typing.Optional[bool] = OMIT, + location_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + reason: typing.Optional[str] = OMIT, + payment_version_token: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + cash_details: typing.Optional[DestinationDetailsCashRefundDetailsParams] = OMIT, + external_details: typing.Optional[DestinationDetailsExternalRefundDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> RefundPaymentResponse: + """ + Refunds a payment. You can refund the entire payment amount or a + portion of it. You can use this endpoint to refund a card payment or record a + refund of a cash or external payment. For more information, see + [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `RefundPayment` request. The key can be any valid string + but must be unique for every `RefundPayment` request. + + Keys are limited to a max of 45 characters - however, the number of allowed characters might be + less than 45, if multi-byte characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : MoneyParams + The amount of money to refund. + + This amount cannot be more than the `total_money` value of the payment minus the total + amount of all previously completed refunds for this payment. + + This amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is charging the card. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money the developer contributes to help cover the refunded amount. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). + + The value cannot be more than the `amount_money`. + + You can specify this parameter in a refund request only if the same parameter was also included + when taking the payment. This is part of the application fee scenario the API supports. For more + information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + payment_id : typing.Optional[str] + The unique ID of the payment being refunded. + Required when unlinked=false, otherwise must not be set. + + destination_id : typing.Optional[str] + The ID indicating where funds will be refunded to. Required for unlinked refunds. For more + information, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds). + + For refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds + will be returned to the original payment source. The field may be specified in order to request + a cross-method refund to a gift card. For more information, + see [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). + + unlinked : typing.Optional[bool] + Indicates that the refund is not linked to a Square payment. + If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not + be provided. + + location_id : typing.Optional[str] + The location ID associated with the unlinked refund. + Required for requests specifying `unlinked=true`. + Otherwise, if included when `unlinked=false`, will throw an error. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the refund. + This is required if the `destination_id` refers to a card on file created using the Cards + API. Only allowed when `unlinked=true`. + + reason : typing.Optional[str] + A description of the reason for the refund. + + payment_version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + If the versions match, or the field is not provided, the refund proceeds as normal. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with this refund. + + cash_details : typing.Optional[DestinationDetailsCashRefundDetailsParams] + Additional details required when recording an unlinked cash refund (`destination_id` is CASH). + + external_details : typing.Optional[DestinationDetailsExternalRefundDetailsParams] + Additional details required when recording an unlinked external refund + (`destination_id` is EXTERNAL). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RefundPaymentResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.refunds.refund_payment( + idempotency_key="9b7f2dcf-49da-4411-b23e-a2d6af21333a", + amount_money={"amount": 1000, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + payment_id="R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", + reason="Example", + ) + """ + response = self._raw_client.refund_payment( + idempotency_key=idempotency_key, + amount_money=amount_money, + app_fee_money=app_fee_money, + payment_id=payment_id, + destination_id=destination_id, + unlinked=unlinked, + location_id=location_id, + customer_id=customer_id, + reason=reason, + payment_version_token=payment_version_token, + team_member_id=team_member_id, + cash_details=cash_details, + external_details=external_details, + request_options=request_options, + ) + return response.data + + def get( + self, refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetPaymentRefundResponse: + """ + Retrieves a specific refund using the `refund_id`. + + Parameters + ---------- + refund_id : str + The unique ID for the desired `PaymentRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPaymentRefundResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.refunds.get( + refund_id="refund_id", + ) + """ + response = self._raw_client.get(refund_id, request_options=request_options) + return response.data + + +class AsyncRefundsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawRefundsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawRefundsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawRefundsClient + """ + return self._raw_client + + async def list( + self, + *, + begin_time: typing.Optional[str] = None, + end_time: typing.Optional[str] = None, + sort_order: typing.Optional[str] = None, + cursor: typing.Optional[str] = None, + location_id: typing.Optional[str] = None, + status: typing.Optional[str] = None, + source_type: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + updated_at_begin_time: typing.Optional[str] = None, + updated_at_end_time: typing.Optional[str] = None, + sort_field: typing.Optional[ListPaymentRefundsRequestSortField] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[PaymentRefund]: + """ + Retrieves a list of refunds for the account making the request. + + Results are eventually consistent, and new refunds or changes to refunds might take several + seconds to appear. + + The maximum results per page is 100. + + Parameters + ---------- + begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `created_at` field for each `PaymentRefund`. + + Default: The current time minus one year. + + end_time : typing.Optional[str] + Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `created_at` field for each `PaymentRefund`. + + Default: The current time. + + sort_order : typing.Optional[str] + The order in which results are listed by `PaymentRefund.created_at`: + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + location_id : typing.Optional[str] + Limit results to the location supplied. By default, results are returned + for all locations associated with the seller. + + status : typing.Optional[str] + If provided, only refunds with the given status are returned. + For a list of refund status values, see [PaymentRefund](entity:PaymentRefund). + + Default: If omitted, refunds are returned regardless of their status. + + source_type : typing.Optional[str] + If provided, only returns refunds whose payments have the indicated source type. + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. + For information about these payment source types, see + [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + + Default: If omitted, refunds are returned regardless of the source type. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + + It is possible to receive fewer results than the specified limit on a given page. + + If the supplied value is greater than 100, no more than 100 results are returned. + + Default: 100 + + updated_at_begin_time : typing.Optional[str] + Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `updated_at` field for each `PaymentRefund`. + + Default: If omitted, the time range starts at `begin_time`. + + updated_at_end_time : typing.Optional[str] + Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 + format. The range is determined using the `updated_at` field for each `PaymentRefund`. + + Default: The current time. + + sort_field : typing.Optional[ListPaymentRefundsRequestSortField] + The field used to sort results by. The default is `CREATED_AT`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[PaymentRefund] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.refunds.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/refunds", + method="GET", + params={ + "begin_time": begin_time, + "end_time": end_time, + "sort_order": sort_order, + "cursor": cursor, + "location_id": location_id, + "status": status, + "source_type": source_type, + "limit": limit, + "updated_at_begin_time": updated_at_begin_time, + "updated_at_end_time": updated_at_end_time, + "sort_field": sort_field, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListPaymentRefundsResponse, + construct_type( + type_=ListPaymentRefundsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + begin_time=begin_time, + end_time=end_time, + sort_order=sort_order, + cursor=_parsed_next, + location_id=location_id, + status=status, + source_type=source_type, + limit=limit, + updated_at_begin_time=updated_at_begin_time, + updated_at_end_time=updated_at_end_time, + sort_field=sort_field, + request_options=request_options, + ) + _items = _parsed_response.refunds + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def refund_payment( + self, + *, + idempotency_key: str, + amount_money: MoneyParams, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + payment_id: typing.Optional[str] = OMIT, + destination_id: typing.Optional[str] = OMIT, + unlinked: typing.Optional[bool] = OMIT, + location_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + reason: typing.Optional[str] = OMIT, + payment_version_token: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + cash_details: typing.Optional[DestinationDetailsCashRefundDetailsParams] = OMIT, + external_details: typing.Optional[DestinationDetailsExternalRefundDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> RefundPaymentResponse: + """ + Refunds a payment. You can refund the entire payment amount or a + portion of it. You can use this endpoint to refund a card payment or record a + refund of a cash or external payment. For more information, see + [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `RefundPayment` request. The key can be any valid string + but must be unique for every `RefundPayment` request. + + Keys are limited to a max of 45 characters - however, the number of allowed characters might be + less than 45, if multi-byte characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : MoneyParams + The amount of money to refund. + + This amount cannot be more than the `total_money` value of the payment minus the total + amount of all previously completed refunds for this payment. + + This amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is charging the card. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money the developer contributes to help cover the refunded amount. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). + + The value cannot be more than the `amount_money`. + + You can specify this parameter in a refund request only if the same parameter was also included + when taking the payment. This is part of the application fee scenario the API supports. For more + information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + payment_id : typing.Optional[str] + The unique ID of the payment being refunded. + Required when unlinked=false, otherwise must not be set. + + destination_id : typing.Optional[str] + The ID indicating where funds will be refunded to. Required for unlinked refunds. For more + information, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds). + + For refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds + will be returned to the original payment source. The field may be specified in order to request + a cross-method refund to a gift card. For more information, + see [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). + + unlinked : typing.Optional[bool] + Indicates that the refund is not linked to a Square payment. + If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not + be provided. + + location_id : typing.Optional[str] + The location ID associated with the unlinked refund. + Required for requests specifying `unlinked=true`. + Otherwise, if included when `unlinked=false`, will throw an error. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the refund. + This is required if the `destination_id` refers to a card on file created using the Cards + API. Only allowed when `unlinked=true`. + + reason : typing.Optional[str] + A description of the reason for the refund. + + payment_version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + If the versions match, or the field is not provided, the refund proceeds as normal. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with this refund. + + cash_details : typing.Optional[DestinationDetailsCashRefundDetailsParams] + Additional details required when recording an unlinked cash refund (`destination_id` is CASH). + + external_details : typing.Optional[DestinationDetailsExternalRefundDetailsParams] + Additional details required when recording an unlinked external refund + (`destination_id` is EXTERNAL). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RefundPaymentResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.refunds.refund_payment( + idempotency_key="9b7f2dcf-49da-4411-b23e-a2d6af21333a", + amount_money={"amount": 1000, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + payment_id="R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", + reason="Example", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.refund_payment( + idempotency_key=idempotency_key, + amount_money=amount_money, + app_fee_money=app_fee_money, + payment_id=payment_id, + destination_id=destination_id, + unlinked=unlinked, + location_id=location_id, + customer_id=customer_id, + reason=reason, + payment_version_token=payment_version_token, + team_member_id=team_member_id, + cash_details=cash_details, + external_details=external_details, + request_options=request_options, + ) + return response.data + + async def get( + self, refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetPaymentRefundResponse: + """ + Retrieves a specific refund using the `refund_id`. + + Parameters + ---------- + refund_id : str + The unique ID for the desired `PaymentRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetPaymentRefundResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.refunds.get( + refund_id="refund_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(refund_id, request_options=request_options) + return response.data diff --git a/src/square/refunds/raw_client.py b/src/square/refunds/raw_client.py new file mode 100644 index 00000000..750ef8f0 --- /dev/null +++ b/src/square/refunds/raw_client.py @@ -0,0 +1,441 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.money import MoneyParams +from ..requests.destination_details_cash_refund_details import DestinationDetailsCashRefundDetailsParams +from ..requests.destination_details_external_refund_details import DestinationDetailsExternalRefundDetailsParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.refund_payment_response import RefundPaymentResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.get_payment_refund_response import GetPaymentRefundResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawRefundsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def refund_payment( + self, + *, + idempotency_key: str, + amount_money: MoneyParams, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + payment_id: typing.Optional[str] = OMIT, + destination_id: typing.Optional[str] = OMIT, + unlinked: typing.Optional[bool] = OMIT, + location_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + reason: typing.Optional[str] = OMIT, + payment_version_token: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + cash_details: typing.Optional[DestinationDetailsCashRefundDetailsParams] = OMIT, + external_details: typing.Optional[DestinationDetailsExternalRefundDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[RefundPaymentResponse]: + """ + Refunds a payment. You can refund the entire payment amount or a + portion of it. You can use this endpoint to refund a card payment or record a + refund of a cash or external payment. For more information, see + [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `RefundPayment` request. The key can be any valid string + but must be unique for every `RefundPayment` request. + + Keys are limited to a max of 45 characters - however, the number of allowed characters might be + less than 45, if multi-byte characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : MoneyParams + The amount of money to refund. + + This amount cannot be more than the `total_money` value of the payment minus the total + amount of all previously completed refunds for this payment. + + This amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is charging the card. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money the developer contributes to help cover the refunded amount. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). + + The value cannot be more than the `amount_money`. + + You can specify this parameter in a refund request only if the same parameter was also included + when taking the payment. This is part of the application fee scenario the API supports. For more + information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + payment_id : typing.Optional[str] + The unique ID of the payment being refunded. + Required when unlinked=false, otherwise must not be set. + + destination_id : typing.Optional[str] + The ID indicating where funds will be refunded to. Required for unlinked refunds. For more + information, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds). + + For refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds + will be returned to the original payment source. The field may be specified in order to request + a cross-method refund to a gift card. For more information, + see [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). + + unlinked : typing.Optional[bool] + Indicates that the refund is not linked to a Square payment. + If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not + be provided. + + location_id : typing.Optional[str] + The location ID associated with the unlinked refund. + Required for requests specifying `unlinked=true`. + Otherwise, if included when `unlinked=false`, will throw an error. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the refund. + This is required if the `destination_id` refers to a card on file created using the Cards + API. Only allowed when `unlinked=true`. + + reason : typing.Optional[str] + A description of the reason for the refund. + + payment_version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + If the versions match, or the field is not provided, the refund proceeds as normal. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with this refund. + + cash_details : typing.Optional[DestinationDetailsCashRefundDetailsParams] + Additional details required when recording an unlinked cash refund (`destination_id` is CASH). + + external_details : typing.Optional[DestinationDetailsExternalRefundDetailsParams] + Additional details required when recording an unlinked external refund + (`destination_id` is EXTERNAL). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RefundPaymentResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/refunds", + method="POST", + json={ + "idempotency_key": idempotency_key, + "amount_money": convert_and_respect_annotation_metadata( + object_=amount_money, annotation=MoneyParams, direction="write" + ), + "app_fee_money": convert_and_respect_annotation_metadata( + object_=app_fee_money, annotation=MoneyParams, direction="write" + ), + "payment_id": payment_id, + "destination_id": destination_id, + "unlinked": unlinked, + "location_id": location_id, + "customer_id": customer_id, + "reason": reason, + "payment_version_token": payment_version_token, + "team_member_id": team_member_id, + "cash_details": convert_and_respect_annotation_metadata( + object_=cash_details, annotation=DestinationDetailsCashRefundDetailsParams, direction="write" + ), + "external_details": convert_and_respect_annotation_metadata( + object_=external_details, + annotation=DestinationDetailsExternalRefundDetailsParams, + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RefundPaymentResponse, + construct_type( + type_=RefundPaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetPaymentRefundResponse]: + """ + Retrieves a specific refund using the `refund_id`. + + Parameters + ---------- + refund_id : str + The unique ID for the desired `PaymentRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetPaymentRefundResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/refunds/{jsonable_encoder(refund_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPaymentRefundResponse, + construct_type( + type_=GetPaymentRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawRefundsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def refund_payment( + self, + *, + idempotency_key: str, + amount_money: MoneyParams, + app_fee_money: typing.Optional[MoneyParams] = OMIT, + payment_id: typing.Optional[str] = OMIT, + destination_id: typing.Optional[str] = OMIT, + unlinked: typing.Optional[bool] = OMIT, + location_id: typing.Optional[str] = OMIT, + customer_id: typing.Optional[str] = OMIT, + reason: typing.Optional[str] = OMIT, + payment_version_token: typing.Optional[str] = OMIT, + team_member_id: typing.Optional[str] = OMIT, + cash_details: typing.Optional[DestinationDetailsCashRefundDetailsParams] = OMIT, + external_details: typing.Optional[DestinationDetailsExternalRefundDetailsParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[RefundPaymentResponse]: + """ + Refunds a payment. You can refund the entire payment amount or a + portion of it. You can use this endpoint to refund a card payment or record a + refund of a cash or external payment. For more information, see + [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `RefundPayment` request. The key can be any valid string + but must be unique for every `RefundPayment` request. + + Keys are limited to a max of 45 characters - however, the number of allowed characters might be + less than 45, if multi-byte characters are used. + + For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + + amount_money : MoneyParams + The amount of money to refund. + + This amount cannot be more than the `total_money` value of the payment minus the total + amount of all previously completed refunds for this payment. + + This amount must be specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The currency code must match the currency associated with the business + that is charging the card. + + app_fee_money : typing.Optional[MoneyParams] + The amount of money the developer contributes to help cover the refunded amount. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). + + The value cannot be more than the `amount_money`. + + You can specify this parameter in a refund request only if the same parameter was also included + when taking the payment. This is part of the application fee scenario the API supports. For more + information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + + payment_id : typing.Optional[str] + The unique ID of the payment being refunded. + Required when unlinked=false, otherwise must not be set. + + destination_id : typing.Optional[str] + The ID indicating where funds will be refunded to. Required for unlinked refunds. For more + information, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds). + + For refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds + will be returned to the original payment source. The field may be specified in order to request + a cross-method refund to a gift card. For more information, + see [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). + + unlinked : typing.Optional[bool] + Indicates that the refund is not linked to a Square payment. + If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not + be provided. + + location_id : typing.Optional[str] + The location ID associated with the unlinked refund. + Required for requests specifying `unlinked=true`. + Otherwise, if included when `unlinked=false`, will throw an error. + + customer_id : typing.Optional[str] + The [Customer](entity:Customer) ID of the customer associated with the refund. + This is required if the `destination_id` refers to a card on file created using the Cards + API. Only allowed when `unlinked=true`. + + reason : typing.Optional[str] + A description of the reason for the refund. + + payment_version_token : typing.Optional[str] + Used for optimistic concurrency. This opaque token identifies the current `Payment` + version that the caller expects. If the server has a different version of the Payment, + the update fails and a response with a VERSION_MISMATCH error is returned. + If the versions match, or the field is not provided, the refund proceeds as normal. + + team_member_id : typing.Optional[str] + An optional [TeamMember](entity:TeamMember) ID to associate with this refund. + + cash_details : typing.Optional[DestinationDetailsCashRefundDetailsParams] + Additional details required when recording an unlinked cash refund (`destination_id` is CASH). + + external_details : typing.Optional[DestinationDetailsExternalRefundDetailsParams] + Additional details required when recording an unlinked external refund + (`destination_id` is EXTERNAL). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RefundPaymentResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/refunds", + method="POST", + json={ + "idempotency_key": idempotency_key, + "amount_money": convert_and_respect_annotation_metadata( + object_=amount_money, annotation=MoneyParams, direction="write" + ), + "app_fee_money": convert_and_respect_annotation_metadata( + object_=app_fee_money, annotation=MoneyParams, direction="write" + ), + "payment_id": payment_id, + "destination_id": destination_id, + "unlinked": unlinked, + "location_id": location_id, + "customer_id": customer_id, + "reason": reason, + "payment_version_token": payment_version_token, + "team_member_id": team_member_id, + "cash_details": convert_and_respect_annotation_metadata( + object_=cash_details, annotation=DestinationDetailsCashRefundDetailsParams, direction="write" + ), + "external_details": convert_and_respect_annotation_metadata( + object_=external_details, + annotation=DestinationDetailsExternalRefundDetailsParams, + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RefundPaymentResponse, + construct_type( + type_=RefundPaymentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetPaymentRefundResponse]: + """ + Retrieves a specific refund using the `refund_id`. + + Parameters + ---------- + refund_id : str + The unique ID for the desired `PaymentRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetPaymentRefundResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/refunds/{jsonable_encoder(refund_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetPaymentRefundResponse, + construct_type( + type_=GetPaymentRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/requests/__init__.py b/src/square/requests/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/requests/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/requests/accept_dispute_response.py b/src/square/requests/accept_dispute_response.py new file mode 100644 index 00000000..bac64b8e --- /dev/null +++ b/src/square/requests/accept_dispute_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute import DisputeParams + + +class AcceptDisputeResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in an `AcceptDispute` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + dispute: typing_extensions.NotRequired[DisputeParams] + """ + Details about the accepted dispute. + """ diff --git a/src/square/requests/accepted_payment_methods.py b/src/square/requests/accepted_payment_methods.py new file mode 100644 index 00000000..b8193815 --- /dev/null +++ b/src/square/requests/accepted_payment_methods.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class AcceptedPaymentMethodsParams(typing_extensions.TypedDict): + apple_pay: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether Apple Pay is accepted at checkout. + """ + + google_pay: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether Google Pay is accepted at checkout. + """ + + cash_app_pay: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether Cash App Pay is accepted at checkout. + """ + + afterpay_clearpay: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether Afterpay/Clearpay is accepted at checkout. + """ diff --git a/src/square/requests/accumulate_loyalty_points_response.py b/src/square/requests/accumulate_loyalty_points_response.py new file mode 100644 index 00000000..6035854e --- /dev/null +++ b/src/square/requests/accumulate_loyalty_points_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_event import LoyaltyEventParams + + +class AccumulateLoyaltyPointsResponseParams(typing_extensions.TypedDict): + """ + Represents an [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + event: typing_extensions.NotRequired[LoyaltyEventParams] + """ + The resulting loyalty event. Starting in Square version 2022-08-17, this field is no longer returned. + """ + + events: typing_extensions.NotRequired[typing.Sequence[LoyaltyEventParams]] + """ + The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event + is always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included + if the purchase also qualifies for a loyalty promotion. + """ diff --git a/src/square/requests/ach_details.py b/src/square/requests/ach_details.py new file mode 100644 index 00000000..2a5f34dc --- /dev/null +++ b/src/square/requests/ach_details.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class AchDetailsParams(typing_extensions.TypedDict): + """ + ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`. + """ + + routing_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The routing number for the bank account. + """ + + account_number_suffix: typing_extensions.NotRequired[typing.Optional[str]] + """ + The last few digits of the bank account number. + """ + + account_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The type of the bank account performing the transfer. The account type can be `CHECKING`, + `SAVINGS`, or `UNKNOWN`. + """ diff --git a/src/square/requests/add_group_to_customer_response.py b/src/square/requests/add_group_to_customer_response.py new file mode 100644 index 00000000..f35bd007 --- /dev/null +++ b/src/square/requests/add_group_to_customer_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class AddGroupToCustomerResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/additional_recipient.py b/src/square/requests/additional_recipient.py new file mode 100644 index 00000000..140badcb --- /dev/null +++ b/src/square/requests/additional_recipient.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class AdditionalRecipientParams(typing_extensions.TypedDict): + """ + Represents an additional recipient (other than the merchant) receiving a portion of this tender. + """ + + location_id: str + """ + The location ID for a recipient (other than the merchant) receiving a portion of this tender. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The description of the additional recipient. + """ + + amount_money: MoneyParams + """ + The amount of money distributed to the recipient. + """ + + receivable_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement. + """ diff --git a/src/square/requests/address.py b/src/square/requests/address.py new file mode 100644 index 00000000..7c5b5621 --- /dev/null +++ b/src/square/requests/address.py @@ -0,0 +1,109 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..core.serialization import FieldMetadata +from ..types.country import Country + + +class AddressParams(typing_extensions.TypedDict): + """ + Represents a postal address in a country. + For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + address_line1: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="address_line_1")] + ] + """ + The first line of the address. + + Fields that start with `address_line` provide the address's most specific + details, like street number, street name, and building name. They do *not* + provide less specific details like city, state/province, or country (these + details are provided in other fields). + """ + + address_line2: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="address_line_2")] + ] + """ + The second line of the address, if any. + """ + + address_line3: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="address_line_3")] + ] + """ + The third line of the address, if any. + """ + + locality: typing_extensions.NotRequired[typing.Optional[str]] + """ + The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + sublocality: typing_extensions.NotRequired[typing.Optional[str]] + """ + A civil region within the address's `locality`, if any. + """ + + sublocality2: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="sublocality_2")] + ] + """ + A civil region within the address's `sublocality`, if any. + """ + + sublocality3: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="sublocality_3")] + ] + """ + A civil region within the address's `sublocality_2`, if any. + """ + + administrative_district_level1: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="administrative_district_level_1")] + ] + """ + A civil entity within the address's country. In the US, this + is the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + administrative_district_level2: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="administrative_district_level_2")] + ] + """ + A civil entity within the address's `administrative_district_level_1`. + In the US, this is the county. + """ + + administrative_district_level3: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="administrative_district_level_3")] + ] + """ + A civil entity within the address's `administrative_district_level_2`, + if any. + """ + + postal_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + country: typing_extensions.NotRequired[Country] + """ + The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`. + See [Country](#type-country) for possible values + """ + + first_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + Optional first name when it's representing recipient. + """ + + last_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + Optional last name when it's representing recipient. + """ diff --git a/src/square/requests/adjust_loyalty_points_response.py b/src/square/requests/adjust_loyalty_points_response.py new file mode 100644 index 00000000..df752da1 --- /dev/null +++ b/src/square/requests/adjust_loyalty_points_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_event import LoyaltyEventParams + + +class AdjustLoyaltyPointsResponseParams(typing_extensions.TypedDict): + """ + Represents an [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints) request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + event: typing_extensions.NotRequired[LoyaltyEventParams] + """ + The resulting event data for the adjustment. + """ diff --git a/src/square/requests/afterpay_details.py b/src/square/requests/afterpay_details.py new file mode 100644 index 00000000..a62946a4 --- /dev/null +++ b/src/square/requests/afterpay_details.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class AfterpayDetailsParams(typing_extensions.TypedDict): + """ + Additional details about Afterpay payments. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + Email address on the buyer's Afterpay account. + """ diff --git a/src/square/requests/application_details.py b/src/square/requests/application_details.py new file mode 100644 index 00000000..900b1554 --- /dev/null +++ b/src/square/requests/application_details.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.application_details_external_square_product import ApplicationDetailsExternalSquareProduct +import typing + + +class ApplicationDetailsParams(typing_extensions.TypedDict): + """ + Details about the application that took the payment. + """ + + square_product: typing_extensions.NotRequired[ApplicationDetailsExternalSquareProduct] + """ + The Square product, such as Square Point of Sale (POS), + Square Invoices, or Square Virtual Terminal. + See [ExternalSquareProduct](#type-externalsquareproduct) for possible values + """ + + application_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square ID assigned to the application used to take the payment. + Application developers can use this information to identify payments that + their application processed. + For example, if a developer uses a custom application to process payments, + this field contains the application ID from the Developer Dashboard. + If a seller uses a [Square App Marketplace](https://developer.squareup.com/docs/app-marketplace) + application to process payments, the field contains the corresponding application ID. + """ diff --git a/src/square/requests/appointment_segment.py b/src/square/requests/appointment_segment.py new file mode 100644 index 00000000..797f81b9 --- /dev/null +++ b/src/square/requests/appointment_segment.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class AppointmentSegmentParams(typing_extensions.TypedDict): + """ + Defines an appointment segment of a booking. + """ + + duration_minutes: typing_extensions.NotRequired[typing.Optional[int]] + """ + The time span in minutes of an appointment segment. + """ + + service_variation_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment. + """ + + team_member_id: str + """ + The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment. + """ + + service_variation_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The current version of the item variation representing the service booked in this segment. + """ + + intermission_minutes: typing_extensions.NotRequired[int] + """ + Time between the end of this segment and the beginning of the subsequent segment. + """ + + any_team_member: typing_extensions.NotRequired[bool] + """ + Whether the customer accepts any team member, instead of a specific one, to serve this segment. + """ + + resource_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The IDs of the seller-accessible resources used for this appointment segment. + """ diff --git a/src/square/requests/availability.py b/src/square/requests/availability.py new file mode 100644 index 00000000..71ed4d52 --- /dev/null +++ b/src/square/requests/availability.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .appointment_segment import AppointmentSegmentParams + + +class AvailabilityParams(typing_extensions.TypedDict): + """ + Defines an appointment slot that encapsulates the appointment segments, location and starting time available for booking. + """ + + start_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The RFC 3339 timestamp specifying the beginning time of the slot available for booking. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location available for booking. + """ + + appointment_segments: typing_extensions.NotRequired[typing.Optional[typing.Sequence[AppointmentSegmentParams]]] + """ + The list of appointment segments available for booking + """ diff --git a/src/square/requests/bank_account.py b/src/square/requests/bank_account.py new file mode 100644 index 00000000..86df7455 --- /dev/null +++ b/src/square/requests/bank_account.py @@ -0,0 +1,117 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.country import Country +from ..types.currency import Currency +from ..types.bank_account_type import BankAccountType +import typing_extensions +import typing +from ..types.bank_account_status import BankAccountStatus + + +class BankAccountParams(typing_extensions.TypedDict): + """ + Represents a bank account. For more information about + linking a bank account to a Square account, see + [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). + """ + + id: str + """ + The unique, Square-issued identifier for the bank account. + """ + + account_number_suffix: str + """ + The last few digits of the account number. + """ + + country: Country + """ + The ISO 3166 Alpha-2 country code where the bank account is based. + See [Country](#type-country) for possible values + """ + + currency: Currency + """ + The 3-character ISO 4217 currency code indicating the operating + currency of the bank account. For example, the currency code for US dollars + is `USD`. + See [Currency](#type-currency) for possible values + """ + + account_type: BankAccountType + """ + The financial purpose of the associated bank account. + See [BankAccountType](#type-bankaccounttype) for possible values + """ + + holder_name: str + """ + Name of the account holder. This name must match the name + on the targeted bank account record. + """ + + primary_bank_identification_number: str + """ + Primary identifier for the bank. For more information, see + [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). + """ + + secondary_bank_identification_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + Secondary identifier for the bank. For more information, see + [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). + """ + + debit_mandate_reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + Reference identifier that will be displayed to UK bank account owners + when collecting direct debit authorization. Only required for UK bank accounts. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + Client-provided identifier for linking the banking account to an entity + in a third-party system (for example, a bank account number or a user identifier). + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The location to which the bank account belongs. + """ + + status: BankAccountStatus + """ + Read-only. The current verification status of this BankAccount object. + See [BankAccountStatus](#type-bankaccountstatus) for possible values + """ + + creditable: bool + """ + Indicates whether it is possible for Square to send money to this bank account. + """ + + debitable: bool + """ + Indicates whether it is possible for Square to take money from this + bank account. + """ + + fingerprint: typing_extensions.NotRequired[typing.Optional[str]] + """ + A Square-assigned, unique identifier for the bank account based on the + account information. The account fingerprint can be used to compare account + entries and determine if the they represent the same real-world bank account. + """ + + version: typing_extensions.NotRequired[int] + """ + The current version of the `BankAccount`. + """ + + bank_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + Read only. Name of actual financial institution. + For example "Bank of America". + """ diff --git a/src/square/requests/bank_account_payment_details.py b/src/square/requests/bank_account_payment_details.py new file mode 100644 index 00000000..e3f18a04 --- /dev/null +++ b/src/square/requests/bank_account_payment_details.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .ach_details import AchDetailsParams +from .error import ErrorParams + + +class BankAccountPaymentDetailsParams(typing_extensions.TypedDict): + """ + Additional details about BANK_ACCOUNT type payments. + """ + + bank_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the bank associated with the bank account. + """ + + transfer_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The type of the bank transfer. The type can be `ACH` or `UNKNOWN`. + """ + + account_ownership_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ownership type of the bank account performing the transfer. + The type can be `INDIVIDUAL`, `COMPANY`, or `ACCOUNT_TYPE_UNKNOWN`. + """ + + fingerprint: typing_extensions.NotRequired[typing.Optional[str]] + """ + Uniquely identifies the bank account for this seller and can be used + to determine if payments are from the same bank account. + """ + + country: typing_extensions.NotRequired[typing.Optional[str]] + """ + The two-letter ISO code representing the country the bank account is located in. + """ + + statement_description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The statement description as sent to the bank. + """ + + ach_details: typing_extensions.NotRequired[AchDetailsParams] + """ + ACH-specific information about the transfer. The information is only populated + if the `transfer_type` is `ACH`. + """ + + errors: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ErrorParams]]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/batch_change_inventory_request.py b/src/square/requests/batch_change_inventory_request.py new file mode 100644 index 00000000..d736b7ef --- /dev/null +++ b/src/square/requests/batch_change_inventory_request.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .inventory_change import InventoryChangeParams + + +class BatchChangeInventoryRequestParams(typing_extensions.TypedDict): + idempotency_key: str + """ + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + """ + + changes: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InventoryChangeParams]]] + """ + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + """ + + ignore_unchanged_counts: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + """ diff --git a/src/square/requests/batch_change_inventory_response.py b/src/square/requests/batch_change_inventory_response.py new file mode 100644 index 00000000..f8719ffe --- /dev/null +++ b/src/square/requests/batch_change_inventory_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_count import InventoryCountParams +from .inventory_change import InventoryChangeParams + + +class BatchChangeInventoryResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + counts: typing_extensions.NotRequired[typing.Sequence[InventoryCountParams]] + """ + The current counts for all objects referenced in the request. + """ + + changes: typing_extensions.NotRequired[typing.Sequence[InventoryChangeParams]] + """ + Changes created for the request. + """ diff --git a/src/square/requests/batch_create_team_members_response.py b/src/square/requests/batch_create_team_members_response.py new file mode 100644 index 00000000..6df7f48a --- /dev/null +++ b/src/square/requests/batch_create_team_members_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .create_team_member_response import CreateTeamMemberResponseParams +from .error import ErrorParams + + +class BatchCreateTeamMembersResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a bulk create request containing the created `TeamMember` objects or error messages. + """ + + team_members: typing_extensions.NotRequired[typing.Dict[str, CreateTeamMemberResponseParams]] + """ + The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/batch_create_vendors_response.py b/src/square/requests/batch_create_vendors_response.py new file mode 100644 index 00000000..4fd7cf78 --- /dev/null +++ b/src/square/requests/batch_create_vendors_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .create_vendor_response import CreateVendorResponseParams + + +class BatchCreateVendorsResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, CreateVendorResponseParams]] + """ + A set of [CreateVendorResponse](entity:CreateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor) + objects or error responses for failed attempts. The set is represented by + a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified + in the input. + """ diff --git a/src/square/requests/batch_delete_catalog_objects_response.py b/src/square/requests/batch_delete_catalog_objects_response.py new file mode 100644 index 00000000..93a7bfd9 --- /dev/null +++ b/src/square/requests/batch_delete_catalog_objects_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class BatchDeleteCatalogObjectsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + deleted_object_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The IDs of all CatalogObjects deleted by this request. + """ + + deleted_at: typing_extensions.NotRequired[str] + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". + """ diff --git a/src/square/requests/batch_get_catalog_objects_response.py b/src/square/requests/batch_get_catalog_objects_response.py new file mode 100644 index 00000000..cbb6c2f2 --- /dev/null +++ b/src/square/requests/batch_get_catalog_objects_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class BatchGetCatalogObjectsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + A list of [CatalogObject](entity:CatalogObject)s returned. + """ + + related_objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + A list of [CatalogObject](entity:CatalogObject)s referenced by the object in the `objects` field. + """ diff --git a/src/square/requests/batch_get_inventory_changes_response.py b/src/square/requests/batch_get_inventory_changes_response.py new file mode 100644 index 00000000..d98b9cc4 --- /dev/null +++ b/src/square/requests/batch_get_inventory_changes_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_change import InventoryChangeParams + + +class BatchGetInventoryChangesResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + changes: typing_extensions.NotRequired[typing.Sequence[InventoryChangeParams]] + """ + The current calculated inventory changes for the requested objects + and locations. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ diff --git a/src/square/requests/batch_get_inventory_counts_request.py b/src/square/requests/batch_get_inventory_counts_request.py new file mode 100644 index 00000000..8e681750 --- /dev/null +++ b/src/square/requests/batch_get_inventory_counts_request.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.inventory_state import InventoryState + + +class BatchGetInventoryCountsRequestParams(typing_extensions.TypedDict): + catalog_object_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + """ + + updated_after: typing_extensions.NotRequired[typing.Optional[str]] + """ + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + """ + + cursor: typing_extensions.NotRequired[typing.Optional[str]] + """ + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + states: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InventoryState]]] + """ + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + """ + + limit: typing_extensions.NotRequired[typing.Optional[int]] + """ + The number of [records](entity:InventoryCount) to return. + """ diff --git a/src/square/requests/batch_get_inventory_counts_response.py b/src/square/requests/batch_get_inventory_counts_response.py new file mode 100644 index 00000000..df61152b --- /dev/null +++ b/src/square/requests/batch_get_inventory_counts_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_count import InventoryCountParams + + +class BatchGetInventoryCountsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + counts: typing_extensions.NotRequired[typing.Sequence[InventoryCountParams]] + """ + The current calculated inventory counts for the requested objects + and locations. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ diff --git a/src/square/requests/batch_get_orders_response.py b/src/square/requests/batch_get_orders_response.py new file mode 100644 index 00000000..dd2377db --- /dev/null +++ b/src/square/requests/batch_get_orders_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order import OrderParams +from .error import ErrorParams + + +class BatchGetOrdersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `BatchRetrieveOrders` endpoint. + """ + + orders: typing_extensions.NotRequired[typing.Sequence[OrderParams]] + """ + The requested orders. This will omit any requested orders that do not exist. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/batch_get_vendors_response.py b/src/square/requests/batch_get_vendors_response.py new file mode 100644 index 00000000..7a32de9b --- /dev/null +++ b/src/square/requests/batch_get_vendors_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .get_vendor_response import GetVendorResponseParams + + +class BatchGetVendorsResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, GetVendorResponseParams]] + """ + The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](entity:Vendor) + objects or error responses for failed attempts. The set is represented by + a collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs. + """ diff --git a/src/square/requests/batch_retrieve_inventory_changes_request.py b/src/square/requests/batch_retrieve_inventory_changes_request.py new file mode 100644 index 00000000..d66ed4f1 --- /dev/null +++ b/src/square/requests/batch_retrieve_inventory_changes_request.py @@ -0,0 +1,61 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.inventory_change_type import InventoryChangeType +from ..types.inventory_state import InventoryState + + +class BatchRetrieveInventoryChangesRequestParams(typing_extensions.TypedDict): + catalog_object_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + """ + + types: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InventoryChangeType]]] + """ + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + """ + + states: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InventoryState]]] + """ + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + """ + + updated_after: typing_extensions.NotRequired[typing.Optional[str]] + """ + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + """ + + updated_before: typing_extensions.NotRequired[typing.Optional[str]] + """ + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + """ + + cursor: typing_extensions.NotRequired[typing.Optional[str]] + """ + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + limit: typing_extensions.NotRequired[typing.Optional[int]] + """ + The number of [records](entity:InventoryChange) to return. + """ diff --git a/src/square/requests/batch_update_team_members_response.py b/src/square/requests/batch_update_team_members_response.py new file mode 100644 index 00000000..769388b2 --- /dev/null +++ b/src/square/requests/batch_update_team_members_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .update_team_member_response import UpdateTeamMemberResponseParams +from .error import ErrorParams + + +class BatchUpdateTeamMembersResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a bulk update request containing the updated `TeamMember` objects or error messages. + """ + + team_members: typing_extensions.NotRequired[typing.Dict[str, UpdateTeamMemberResponseParams]] + """ + The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/batch_update_vendors_response.py b/src/square/requests/batch_update_vendors_response.py new file mode 100644 index 00000000..305cc20c --- /dev/null +++ b/src/square/requests/batch_update_vendors_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .update_vendor_response import UpdateVendorResponseParams + + +class BatchUpdateVendorsResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered when the request fails. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, UpdateVendorResponseParams]] + """ + A set of [UpdateVendorResponse](entity:UpdateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor) + objects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or + `Vendor`-ID/error-object pairs. + """ diff --git a/src/square/requests/batch_upsert_catalog_objects_response.py b/src/square/requests/batch_upsert_catalog_objects_response.py new file mode 100644 index 00000000..f1118b81 --- /dev/null +++ b/src/square/requests/batch_upsert_catalog_objects_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams +from .catalog_id_mapping import CatalogIdMappingParams + + +class BatchUpsertCatalogObjectsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + The created successfully created CatalogObjects. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". + """ + + id_mappings: typing_extensions.NotRequired[typing.Sequence[CatalogIdMappingParams]] + """ + The mapping between client and server IDs for this upsert. + """ diff --git a/src/square/requests/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.py b/src/square/requests/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.py new file mode 100644 index 00000000..69a5a615 --- /dev/null +++ b/src/square/requests/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing_extensions +import typing + + +class BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequestParams(typing_extensions.TypedDict): + """ + Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + request. An individual request contains a customer ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + customer_id: str + """ + The ID of the target [customer profile](entity:Customer). + """ + + custom_attribute: CustomAttributeParams + """ + The custom attribute to create or update, with following fields: + + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for update operations, include this optional field in the request and set the + value to the current version of the custom attribute. + """ + + idempotency_key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ diff --git a/src/square/requests/batch_upsert_customer_custom_attributes_response.py b/src/square/requests/batch_upsert_customer_custom_attributes_response.py new file mode 100644 index 00000000..ed2d79ad --- /dev/null +++ b/src/square/requests/batch_upsert_customer_custom_attributes_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response import ( + BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponseParams, +) +from .error import ErrorParams + + +class BatchUpsertCustomerCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing_extensions.NotRequired[ + typing.Dict[str, BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponseParams] + ] + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `customer_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.py b/src/square/requests/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.py new file mode 100644 index 00000000..c6e6375b --- /dev/null +++ b/src/square/requests/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponseParams( + typing_extensions.TypedDict +): + """ + Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) operation. + """ + + customer_id: typing_extensions.NotRequired[str] + """ + The ID of the customer profile associated with the custom attribute. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred while processing the individual request. + """ diff --git a/src/square/requests/booking.py b/src/square/requests/booking.py new file mode 100644 index 00000000..8542f9a1 --- /dev/null +++ b/src/square/requests/booking.py @@ -0,0 +1,109 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.booking_status import BookingStatus +import typing +from .appointment_segment import AppointmentSegmentParams +from ..types.business_appointment_settings_booking_location_type import BusinessAppointmentSettingsBookingLocationType +from .booking_creator_details import BookingCreatorDetailsParams +from ..types.booking_booking_source import BookingBookingSource +from .address import AddressParams + + +class BookingParams(typing_extensions.TypedDict): + """ + Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service + at a given location to a requesting customer in one or more appointment segments. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID of this object representing a booking. + """ + + version: typing_extensions.NotRequired[int] + """ + The revision number for the booking used for optimistic concurrency. + """ + + status: typing_extensions.NotRequired[BookingStatus] + """ + The status of the booking, describing where the booking stands with respect to the booking state machine. + See [BookingStatus](#type-bookingstatus) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The RFC 3339 timestamp specifying the creation time of this booking. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The RFC 3339 timestamp specifying the most recent update time of this booking. + """ + + start_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The RFC 3339 timestamp specifying the starting time of this booking. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service. + """ + + customer_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance. + """ + + seller_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance. + This field should not be visible to customers. + """ + + appointment_segments: typing_extensions.NotRequired[typing.Optional[typing.Sequence[AppointmentSegmentParams]]] + """ + A list of appointment segments for this booking. + """ + + transition_time_minutes: typing_extensions.NotRequired[int] + """ + Additional time at the end of a booking. + Applications should not make this field visible to customers of a seller. + """ + + all_day: typing_extensions.NotRequired[bool] + """ + Whether the booking is of a full business day. + """ + + location_type: typing_extensions.NotRequired[BusinessAppointmentSettingsBookingLocationType] + """ + The type of location where the booking is held. + See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values + """ + + creator_details: typing_extensions.NotRequired[BookingCreatorDetailsParams] + """ + Information about the booking creator. + """ + + source: typing_extensions.NotRequired[BookingBookingSource] + """ + The source of the booking. + Access to this field requires seller-level permissions. + See [BookingBookingSource](#type-bookingbookingsource) for possible values + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + Stores a customer address if the location type is `CUSTOMER_LOCATION`. + """ diff --git a/src/square/requests/booking_creator_details.py b/src/square/requests/booking_creator_details.py new file mode 100644 index 00000000..878a8500 --- /dev/null +++ b/src/square/requests/booking_creator_details.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.booking_creator_details_creator_type import BookingCreatorDetailsCreatorType + + +class BookingCreatorDetailsParams(typing_extensions.TypedDict): + """ + Information about a booking creator. + """ + + creator_type: typing_extensions.NotRequired[BookingCreatorDetailsCreatorType] + """ + The seller-accessible type of the creator of the booking. + See [BookingCreatorDetailsCreatorType](#type-bookingcreatordetailscreatortype) for possible values + """ + + team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type. + Access to this field requires seller-level permissions. + """ + + customer_id: typing_extensions.NotRequired[str] + """ + The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type. + Access to this field requires seller-level permissions. + """ diff --git a/src/square/requests/booking_custom_attribute_delete_request.py b/src/square/requests/booking_custom_attribute_delete_request.py new file mode 100644 index 00000000..1ae622f2 --- /dev/null +++ b/src/square/requests/booking_custom_attribute_delete_request.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class BookingCustomAttributeDeleteRequestParams(typing_extensions.TypedDict): + """ + Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) + request. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key. + """ + + booking_id: str + """ + The ID of the target [booking](entity:Booking). + """ + + key: str + """ + The key of the custom attribute to delete. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + """ diff --git a/src/square/requests/booking_custom_attribute_delete_response.py b/src/square/requests/booking_custom_attribute_delete_response.py new file mode 100644 index 00000000..e2f18380 --- /dev/null +++ b/src/square/requests/booking_custom_attribute_delete_response.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class BookingCustomAttributeDeleteResponseParams(typing_extensions.TypedDict): + """ + Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) operation. + """ + + booking_id: typing_extensions.NotRequired[str] + """ + The ID of the [booking](entity:Booking) associated with the custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred while processing the individual request. + """ diff --git a/src/square/requests/booking_custom_attribute_upsert_request.py b/src/square/requests/booking_custom_attribute_upsert_request.py new file mode 100644 index 00000000..5384f71a --- /dev/null +++ b/src/square/requests/booking_custom_attribute_upsert_request.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing_extensions +import typing + + +class BookingCustomAttributeUpsertRequestParams(typing_extensions.TypedDict): + """ + Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) + request. An individual request contains a booking ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + booking_id: str + """ + The ID of the target [booking](entity:Booking). + """ + + custom_attribute: CustomAttributeParams + """ + The custom attribute to create or update, with following fields: + + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for update operations, include this optional field in the request and set the + value to the current version of the custom attribute. + """ + + idempotency_key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ diff --git a/src/square/requests/booking_custom_attribute_upsert_response.py b/src/square/requests/booking_custom_attribute_upsert_response.py new file mode 100644 index 00000000..d9f3e8e7 --- /dev/null +++ b/src/square/requests/booking_custom_attribute_upsert_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class BookingCustomAttributeUpsertResponseParams(typing_extensions.TypedDict): + """ + Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) operation. + """ + + booking_id: typing_extensions.NotRequired[str] + """ + The ID of the [booking](entity:Booking) associated with the custom attribute. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred while processing the individual request. + """ diff --git a/src/square/requests/break_.py b/src/square/requests/break_.py new file mode 100644 index 00000000..53f2b769 --- /dev/null +++ b/src/square/requests/break_.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class BreakParams(typing_extensions.TypedDict): + """ + A record of an employee's break during a shift. + """ + + id: typing_extensions.NotRequired[str] + """ + The UUID for this object. + """ + + start_at: str + """ + RFC 3339; follows the same timezone information as `Shift`. Precision up to + the minute is respected; seconds are truncated. + """ + + end_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + RFC 3339; follows the same timezone information as `Shift`. Precision up to + the minute is respected; seconds are truncated. + """ + + break_type_id: str + """ + The `BreakType` that this `Break` was templated on. + """ + + name: str + """ + A human-readable name. + """ + + expected_duration: str + """ + Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of + the break. + """ + + is_paid: bool + """ + Whether this break counts towards time worked for compensation + purposes. + """ diff --git a/src/square/requests/break_type.py b/src/square/requests/break_type.py new file mode 100644 index 00000000..aa630780 --- /dev/null +++ b/src/square/requests/break_type.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class BreakTypeParams(typing_extensions.TypedDict): + """ + A defined break template that sets an expectation for possible `Break` + instances on a `Shift`. + """ + + id: typing_extensions.NotRequired[str] + """ + The UUID for this object. + """ + + location_id: str + """ + The ID of the business location this type of break applies to. + """ + + break_name: str + """ + A human-readable name for this type of break. The name is displayed to + employees in Square products. + """ + + expected_duration: str + """ + Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of + this break. Precision less than minutes is truncated. + + Example for break expected duration of 15 minutes: T15M + """ + + is_paid: bool + """ + Whether this break counts towards time worked for compensation + purposes. + """ + + version: typing_extensions.NotRequired[int] + """ + Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If a value is not + provided, Square's servers execute a "blind" write; potentially + overwriting another writer's data. + """ + + created_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format. + """ diff --git a/src/square/requests/bulk_create_customer_data.py b/src/square/requests/bulk_create_customer_data.py new file mode 100644 index 00000000..9c132274 --- /dev/null +++ b/src/square/requests/bulk_create_customer_data.py @@ -0,0 +1,79 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from .customer_tax_ids import CustomerTaxIdsParams + + +class BulkCreateCustomerDataParams(typing_extensions.TypedDict): + """ + Defines the customer data provided in individual create requests for a + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) operation. + """ + + given_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The given name (that is, the first name) associated with the customer profile. + """ + + family_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The family name (that is, the last name) associated with the customer profile. + """ + + company_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A business name associated with the customer profile. + """ + + nickname: typing_extensions.NotRequired[typing.Optional[str]] + """ + A nickname for the customer profile. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address associated with the customer profile. + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The physical address associated with the customer profile. For maximum length constraints, + see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number associated with the customer profile. The phone number must be valid + and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, + see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional second ID used to associate the customer profile with an + entity in another system. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A custom note associated with the customer profile. + """ + + birthday: typing_extensions.NotRequired[typing.Optional[str]] + """ + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. + For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. + Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or + `0000` if a birth year is not specified. + """ + + tax_ids: typing_extensions.NotRequired[CustomerTaxIdsParams] + """ + The tax ID associated with the customer profile. This field is available only for + customers of sellers in EU countries or the United Kingdom. For more information, see + [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ diff --git a/src/square/requests/bulk_create_customers_response.py b/src/square/requests/bulk_create_customers_response.py new file mode 100644 index 00000000..f3addd01 --- /dev/null +++ b/src/square/requests/bulk_create_customers_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .create_customer_response import CreateCustomerResponseParams +from .error import ErrorParams + + +class BulkCreateCustomersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields included in the response body from the + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, CreateCustomerResponseParams]] + """ + A map of responses that correspond to individual create requests, represented by + key-value pairs. + + Each key is the idempotency key that was provided for a create request and each value + is the corresponding response. + If the request succeeds, the value is the new customer profile. + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any top-level errors that prevented the bulk operation from running. + """ diff --git a/src/square/requests/bulk_delete_booking_custom_attributes_response.py b/src/square/requests/bulk_delete_booking_custom_attributes_response.py new file mode 100644 index 00000000..493f90c1 --- /dev/null +++ b/src/square/requests/bulk_delete_booking_custom_attributes_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .booking_custom_attribute_delete_response import BookingCustomAttributeDeleteResponseParams +from .error import ErrorParams + + +class BulkDeleteBookingCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) response, + which contains a map of responses that each corresponds to an individual delete request. + """ + + values: typing_extensions.NotRequired[typing.Dict[str, BookingCustomAttributeDeleteResponseParams]] + """ + A map of responses that correspond to individual delete requests. Each response has the + same ID as the corresponding request and contains `booking_id` and `errors` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_delete_customers_response.py b/src/square/requests/bulk_delete_customers_response.py new file mode 100644 index 00000000..96b4349d --- /dev/null +++ b/src/square/requests/bulk_delete_customers_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .delete_customer_response import DeleteCustomerResponseParams +from .error import ErrorParams + + +class BulkDeleteCustomersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields included in the response body from the + [BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) endpoint. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, DeleteCustomerResponseParams]] + """ + A map of responses that correspond to individual delete requests, represented by + key-value pairs. + + Each key is the customer ID that was specified for a delete request and each value + is the corresponding response. + If the request succeeds, the value is an empty object (`{ }`). + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any top-level errors that prevented the bulk operation from running. + """ diff --git a/src/square/requests/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.py b/src/square/requests/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.py new file mode 100644 index 00000000..77b38c5c --- /dev/null +++ b/src/square/requests/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequestParams(typing_extensions.TypedDict): + """ + Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + request. An individual request contains an optional ID of the associated custom attribute definition + and optional key of the associated custom attribute definition. + """ + + key: typing_extensions.NotRequired[str] + """ + The key of the associated custom attribute definition. + Represented as a qualified key if the requesting app is not the definition owner. + """ diff --git a/src/square/requests/bulk_delete_location_custom_attributes_response.py b/src/square/requests/bulk_delete_location_custom_attributes_response.py new file mode 100644 index 00000000..e5fa7b0d --- /dev/null +++ b/src/square/requests/bulk_delete_location_custom_attributes_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from .bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response import ( + BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponseParams, +) +import typing_extensions +from .error import ErrorParams + + +class BulkDeleteLocationCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) response, + which contains a map of responses that each corresponds to an individual delete request. + """ + + values: typing.Dict[str, BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponseParams] + """ + A map of responses that correspond to individual delete requests. Each response has the + same key as the corresponding request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.py b/src/square/requests/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.py new file mode 100644 index 00000000..a46bf4b7 --- /dev/null +++ b/src/square/requests/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponseParams( + typing_extensions.TypedDict +): + """ + Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + request. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location associated with the custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request + """ diff --git a/src/square/requests/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.py b/src/square/requests/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.py new file mode 100644 index 00000000..83c086c8 --- /dev/null +++ b/src/square/requests/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequestParams(typing_extensions.TypedDict): + """ + Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + request. An individual request contains an optional ID of the associated custom attribute definition + and optional key of the associated custom attribute definition. + """ + + key: typing_extensions.NotRequired[str] + """ + The key of the associated custom attribute definition. + Represented as a qualified key if the requesting app is not the definition owner. + """ diff --git a/src/square/requests/bulk_delete_merchant_custom_attributes_response.py b/src/square/requests/bulk_delete_merchant_custom_attributes_response.py new file mode 100644 index 00000000..686953b4 --- /dev/null +++ b/src/square/requests/bulk_delete_merchant_custom_attributes_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from .bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response import ( + BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponseParams, +) +import typing_extensions +from .error import ErrorParams + + +class BulkDeleteMerchantCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) response, + which contains a map of responses that each corresponds to an individual delete request. + """ + + values: typing.Dict[str, BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponseParams] + """ + A map of responses that correspond to individual delete requests. Each response has the + same key as the corresponding request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.py b/src/square/requests/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.py new file mode 100644 index 00000000..8d273b7c --- /dev/null +++ b/src/square/requests/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponseParams( + typing_extensions.TypedDict +): + """ + Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred while processing the individual MerchantCustomAttributeDeleteRequest request + """ diff --git a/src/square/requests/bulk_delete_order_custom_attributes_request_delete_custom_attribute.py b/src/square/requests/bulk_delete_order_custom_attributes_request_delete_custom_attribute.py new file mode 100644 index 00000000..8007edec --- /dev/null +++ b/src/square/requests/bulk_delete_order_custom_attributes_request_delete_custom_attribute.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class BulkDeleteOrderCustomAttributesRequestDeleteCustomAttributeParams(typing_extensions.TypedDict): + """ + Represents one delete within the bulk operation. + """ + + key: typing_extensions.NotRequired[str] + """ + The key of the custom attribute to delete. This key must match the key + of an existing custom attribute definition. + """ + + order_id: str + """ + The ID of the target [order](entity:Order). + """ diff --git a/src/square/requests/bulk_delete_order_custom_attributes_response.py b/src/square/requests/bulk_delete_order_custom_attributes_response.py new file mode 100644 index 00000000..4d96949c --- /dev/null +++ b/src/square/requests/bulk_delete_order_custom_attributes_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .delete_order_custom_attribute_response import DeleteOrderCustomAttributeResponseParams + + +class BulkDeleteOrderCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a response from deleting one or more order custom attributes. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + values: typing.Dict[str, DeleteOrderCustomAttributeResponseParams] + """ + A map of responses that correspond to individual delete requests. Each response has the same ID + as the corresponding request and contains either a `custom_attribute` or an `errors` field. + """ diff --git a/src/square/requests/bulk_retrieve_bookings_response.py b/src/square/requests/bulk_retrieve_bookings_response.py new file mode 100644 index 00000000..5fdf6e01 --- /dev/null +++ b/src/square/requests/bulk_retrieve_bookings_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .get_booking_response import GetBookingResponseParams +from .error import ErrorParams + + +class BulkRetrieveBookingsResponseParams(typing_extensions.TypedDict): + """ + Response payload for bulk retrieval of bookings. + """ + + bookings: typing_extensions.NotRequired[typing.Dict[str, GetBookingResponseParams]] + """ + Requested bookings returned as a map containing `booking_id` as the key and `RetrieveBookingResponse` as the value. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_retrieve_customers_response.py b/src/square/requests/bulk_retrieve_customers_response.py new file mode 100644 index 00000000..80b03a16 --- /dev/null +++ b/src/square/requests/bulk_retrieve_customers_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .get_customer_response import GetCustomerResponseParams +from .error import ErrorParams + + +class BulkRetrieveCustomersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields included in the response body from the + [BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) endpoint. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, GetCustomerResponseParams]] + """ + A map of responses that correspond to individual retrieve requests, represented by + key-value pairs. + + Each key is the customer ID that was specified for a retrieve request and each value + is the corresponding response. + If the request succeeds, the value is the requested customer profile. + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any top-level errors that prevented the bulk operation from running. + """ diff --git a/src/square/requests/bulk_retrieve_team_member_booking_profiles_response.py b/src/square/requests/bulk_retrieve_team_member_booking_profiles_response.py new file mode 100644 index 00000000..dc4163bd --- /dev/null +++ b/src/square/requests/bulk_retrieve_team_member_booking_profiles_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .get_team_member_booking_profile_response import GetTeamMemberBookingProfileResponseParams +from .error import ErrorParams + + +class BulkRetrieveTeamMemberBookingProfilesResponseParams(typing_extensions.TypedDict): + """ + Response payload for the [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles) endpoint. + """ + + team_member_booking_profiles: typing_extensions.NotRequired[ + typing.Dict[str, GetTeamMemberBookingProfileResponseParams] + ] + """ + The returned team members' booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](entity:TeamMemberBookingProfile) the value. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_swap_plan_response.py b/src/square/requests/bulk_swap_plan_response.py new file mode 100644 index 00000000..a0ec5dbf --- /dev/null +++ b/src/square/requests/bulk_swap_plan_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class BulkSwapPlanResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response of the + [BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + affected_subscriptions: typing_extensions.NotRequired[int] + """ + The number of affected subscriptions. + """ diff --git a/src/square/requests/bulk_update_customer_data.py b/src/square/requests/bulk_update_customer_data.py new file mode 100644 index 00000000..ecd5260b --- /dev/null +++ b/src/square/requests/bulk_update_customer_data.py @@ -0,0 +1,88 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from .customer_tax_ids import CustomerTaxIdsParams + + +class BulkUpdateCustomerDataParams(typing_extensions.TypedDict): + """ + Defines the customer data provided in individual update requests for a + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) operation. + """ + + given_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The given name (that is, the first name) associated with the customer profile. + """ + + family_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The family name (that is, the last name) associated with the customer profile. + """ + + company_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A business name associated with the customer profile. + """ + + nickname: typing_extensions.NotRequired[typing.Optional[str]] + """ + A nickname for the customer profile. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address associated with the customer profile. + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The physical address associated with the customer profile. For maximum length constraints, + see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number associated with the customer profile. The phone number must be valid + and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, + see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional second ID used to associate the customer profile with an + entity in another system. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + An custom note associates with the customer profile. + """ + + birthday: typing_extensions.NotRequired[typing.Optional[str]] + """ + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. + For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. + Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or + `0000` if a birth year is not specified. + """ + + tax_ids: typing_extensions.NotRequired[CustomerTaxIdsParams] + """ + The tax ID associated with the customer profile. This field is available only for + customers of sellers in EU countries or the United Kingdom. For more information, see + [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ + + version: typing_extensions.NotRequired[int] + """ + The current version of the customer profile. + + As a best practice, you should include this field to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control. + """ diff --git a/src/square/requests/bulk_update_customers_response.py b/src/square/requests/bulk_update_customers_response.py new file mode 100644 index 00000000..3dd2b049 --- /dev/null +++ b/src/square/requests/bulk_update_customers_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .update_customer_response import UpdateCustomerResponseParams +from .error import ErrorParams + + +class BulkUpdateCustomersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields included in the response body from the + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint. + """ + + responses: typing_extensions.NotRequired[typing.Dict[str, UpdateCustomerResponseParams]] + """ + A map of responses that correspond to individual update requests, represented by + key-value pairs. + + Each key is the customer ID that was specified for an update request and each value + is the corresponding response. + If the request succeeds, the value is the updated customer profile. + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any top-level errors that prevented the bulk operation from running. + """ diff --git a/src/square/requests/bulk_upsert_booking_custom_attributes_response.py b/src/square/requests/bulk_upsert_booking_custom_attributes_response.py new file mode 100644 index 00000000..429a7b32 --- /dev/null +++ b/src/square/requests/bulk_upsert_booking_custom_attributes_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .booking_custom_attribute_upsert_response import BookingCustomAttributeUpsertResponseParams +from .error import ErrorParams + + +class BulkUpsertBookingCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing_extensions.NotRequired[typing.Dict[str, BookingCustomAttributeUpsertResponseParams]] + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `booking_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.py b/src/square/requests/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.py new file mode 100644 index 00000000..b4b6d0df --- /dev/null +++ b/src/square/requests/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing_extensions +import typing + + +class BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequestParams(typing_extensions.TypedDict): + """ + Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + request. An individual request contains a location ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + location_id: str + """ + The ID of the target [location](entity:Location). + """ + + custom_attribute: CustomAttributeParams + """ + The custom attribute to create or update, with following fields: + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).. + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, specify the current version of the custom attribute. + If this is not important for your application, `version` can be set to -1. + """ + + idempotency_key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ diff --git a/src/square/requests/bulk_upsert_location_custom_attributes_response.py b/src/square/requests/bulk_upsert_location_custom_attributes_response.py new file mode 100644 index 00000000..0d5e6a39 --- /dev/null +++ b/src/square/requests/bulk_upsert_location_custom_attributes_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response import ( + BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponseParams, +) +from .error import ErrorParams + + +class BulkUpsertLocationCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing_extensions.NotRequired[ + typing.Dict[str, BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponseParams] + ] + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `location_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.py b/src/square/requests/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.py new file mode 100644 index 00000000..9ab91818 --- /dev/null +++ b/src/square/requests/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponseParams( + typing_extensions.TypedDict +): + """ + Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) operation. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location associated with the custom attribute. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred while processing the individual request. + """ diff --git a/src/square/requests/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.py b/src/square/requests/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.py new file mode 100644 index 00000000..87eea5e2 --- /dev/null +++ b/src/square/requests/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing_extensions +import typing + + +class BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequestParams(typing_extensions.TypedDict): + """ + Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + request. An individual request contains a merchant ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + merchant_id: str + """ + The ID of the target [merchant](entity:Merchant). + """ + + custom_attribute: CustomAttributeParams + """ + The custom attribute to create or update, with following fields: + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + """ + + idempotency_key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ diff --git a/src/square/requests/bulk_upsert_merchant_custom_attributes_response.py b/src/square/requests/bulk_upsert_merchant_custom_attributes_response.py new file mode 100644 index 00000000..ea537063 --- /dev/null +++ b/src/square/requests/bulk_upsert_merchant_custom_attributes_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response import ( + BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponseParams, +) +from .error import ErrorParams + + +class BulkUpsertMerchantCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing_extensions.NotRequired[ + typing.Dict[str, BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponseParams] + ] + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `merchant_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.py b/src/square/requests/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.py new file mode 100644 index 00000000..3722aa95 --- /dev/null +++ b/src/square/requests/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponseParams( + typing_extensions.TypedDict +): + """ + Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) operation. + """ + + merchant_id: typing_extensions.NotRequired[str] + """ + The ID of the merchant associated with the custom attribute. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred while processing the individual request. + """ diff --git a/src/square/requests/bulk_upsert_order_custom_attributes_request_upsert_custom_attribute.py b/src/square/requests/bulk_upsert_order_custom_attributes_request_upsert_custom_attribute.py new file mode 100644 index 00000000..03cb9bb7 --- /dev/null +++ b/src/square/requests/bulk_upsert_order_custom_attributes_request_upsert_custom_attribute.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing_extensions +import typing + + +class BulkUpsertOrderCustomAttributesRequestUpsertCustomAttributeParams(typing_extensions.TypedDict): + """ + Represents one upsert within the bulk operation. + """ + + custom_attribute: CustomAttributeParams + """ + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + """ + + idempotency_key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + order_id: str + """ + The ID of the target [order](entity:Order). + """ diff --git a/src/square/requests/bulk_upsert_order_custom_attributes_response.py b/src/square/requests/bulk_upsert_order_custom_attributes_response.py new file mode 100644 index 00000000..71ab555f --- /dev/null +++ b/src/square/requests/bulk_upsert_order_custom_attributes_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .upsert_order_custom_attribute_response import UpsertOrderCustomAttributeResponseParams + + +class BulkUpsertOrderCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a bulk upsert of order custom attributes. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + values: typing.Dict[str, UpsertOrderCustomAttributeResponseParams] + """ + A map of responses that correspond to individual upsert operations for custom attributes. + """ diff --git a/src/square/requests/business_appointment_settings.py b/src/square/requests/business_appointment_settings.py new file mode 100644 index 00000000..67240b1a --- /dev/null +++ b/src/square/requests/business_appointment_settings.py @@ -0,0 +1,93 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.business_appointment_settings_booking_location_type import BusinessAppointmentSettingsBookingLocationType +from ..types.business_appointment_settings_alignment_time import BusinessAppointmentSettingsAlignmentTime +from ..types.business_appointment_settings_max_appointments_per_day_limit_type import ( + BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType, +) +from .money import MoneyParams +from ..types.business_appointment_settings_cancellation_policy import BusinessAppointmentSettingsCancellationPolicy + + +class BusinessAppointmentSettingsParams(typing_extensions.TypedDict): + """ + The service appointment settings, including where and how the service is provided. + """ + + location_types: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[BusinessAppointmentSettingsBookingLocationType]] + ] + """ + Types of the location allowed for bookings. + See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values + """ + + alignment_time: typing_extensions.NotRequired[BusinessAppointmentSettingsAlignmentTime] + """ + The time unit of the service duration for bookings. + See [BusinessAppointmentSettingsAlignmentTime](#type-businessappointmentsettingsalignmenttime) for possible values + """ + + min_booking_lead_time_seconds: typing_extensions.NotRequired[typing.Optional[int]] + """ + The minimum lead time in seconds before a service can be booked. A booking must be created at least this amount of time before its starting time. + """ + + max_booking_lead_time_seconds: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum lead time in seconds before a service can be booked. A booking must be created at most this amount of time before its starting time. + """ + + any_team_member_booking_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether a customer can choose from all available time slots and have a staff member assigned + automatically (`true`) or not (`false`). + """ + + multiple_service_booking_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether a customer can book multiple services in a single online booking. + """ + + max_appointments_per_day_limit_type: typing_extensions.NotRequired[ + BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType + ] + """ + Indicates whether the daily appointment limit applies to team members or to + business locations. + See [BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType](#type-businessappointmentsettingsmaxappointmentsperdaylimittype) for possible values + """ + + max_appointments_per_day_limit: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of daily appointments per team member or per location. + """ + + cancellation_window_seconds: typing_extensions.NotRequired[typing.Optional[int]] + """ + The cut-off time in seconds for allowing clients to cancel or reschedule an appointment. + """ + + cancellation_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The flat-fee amount charged for a no-show booking. + """ + + cancellation_policy: typing_extensions.NotRequired[BusinessAppointmentSettingsCancellationPolicy] + """ + The cancellation policy adopted by the seller. + See [BusinessAppointmentSettingsCancellationPolicy](#type-businessappointmentsettingscancellationpolicy) for possible values + """ + + cancellation_policy_text: typing_extensions.NotRequired[typing.Optional[str]] + """ + The free-form text of the seller's cancellation policy. + """ + + skip_booking_flow_staff_selection: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether customers has an assigned staff member (`true`) or can select s staff member of their choice (`false`). + """ diff --git a/src/square/requests/business_booking_profile.py b/src/square/requests/business_booking_profile.py new file mode 100644 index 00000000..fb9f7696 --- /dev/null +++ b/src/square/requests/business_booking_profile.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.business_booking_profile_customer_timezone_choice import BusinessBookingProfileCustomerTimezoneChoice +from ..types.business_booking_profile_booking_policy import BusinessBookingProfileBookingPolicy +from .business_appointment_settings import BusinessAppointmentSettingsParams + + +class BusinessBookingProfileParams(typing_extensions.TypedDict): + """ + A seller's business booking profile, including booking policy, appointment settings, etc. + """ + + seller_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the seller, obtainable using the Merchants API. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The RFC 3339 timestamp specifying the booking's creation time. + """ + + booking_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the seller is open for booking. + """ + + customer_timezone_choice: typing_extensions.NotRequired[BusinessBookingProfileCustomerTimezoneChoice] + """ + The choice of customer's time zone information of a booking. + The Square online booking site and all notifications to customers uses either the seller location’s time zone + or the time zone the customer chooses at booking. + See [BusinessBookingProfileCustomerTimezoneChoice](#type-businessbookingprofilecustomertimezonechoice) for possible values + """ + + booking_policy: typing_extensions.NotRequired[BusinessBookingProfileBookingPolicy] + """ + The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`). + See [BusinessBookingProfileBookingPolicy](#type-businessbookingprofilebookingpolicy) for possible values + """ + + allow_user_cancel: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether customers can cancel or reschedule their own bookings (`true`) or not (`false`). + """ + + business_appointment_settings: typing_extensions.NotRequired[BusinessAppointmentSettingsParams] + """ + Settings for appointment-type bookings. + """ + + support_seller_level_writes: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the seller's subscription to Square Appointments supports creating, updating or canceling an appointment through the API (`true`) or not (`false`) using seller permission. + """ diff --git a/src/square/requests/business_hours.py b/src/square/requests/business_hours.py new file mode 100644 index 00000000..758aeade --- /dev/null +++ b/src/square/requests/business_hours.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .business_hours_period import BusinessHoursPeriodParams + + +class BusinessHoursParams(typing_extensions.TypedDict): + """ + The hours of operation for a location. + """ + + periods: typing_extensions.NotRequired[typing.Optional[typing.Sequence[BusinessHoursPeriodParams]]] + """ + The list of time periods during which the business is open. There can be at most 10 periods per day. + """ diff --git a/src/square/requests/business_hours_period.py b/src/square/requests/business_hours_period.py new file mode 100644 index 00000000..887c08a3 --- /dev/null +++ b/src/square/requests/business_hours_period.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.day_of_week import DayOfWeek +import typing + + +class BusinessHoursPeriodParams(typing_extensions.TypedDict): + """ + Represents a period of time during which a business location is open. + """ + + day_of_week: typing_extensions.NotRequired[DayOfWeek] + """ + The day of the week for this time period. + See [DayOfWeek](#type-dayofweek) for possible values + """ + + start_local_time: typing_extensions.NotRequired[typing.Optional[str]] + """ + The start time of a business hours period, specified in local time using partial-time + RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + end_local_time: typing_extensions.NotRequired[typing.Optional[str]] + """ + The end time of a business hours period, specified in local time using partial-time + RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ diff --git a/src/square/requests/buy_now_pay_later_details.py b/src/square/requests/buy_now_pay_later_details.py new file mode 100644 index 00000000..be192e33 --- /dev/null +++ b/src/square/requests/buy_now_pay_later_details.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .afterpay_details import AfterpayDetailsParams +from .clearpay_details import ClearpayDetailsParams + + +class BuyNowPayLaterDetailsParams(typing_extensions.TypedDict): + """ + Additional details about a Buy Now Pay Later payment type. + """ + + brand: typing_extensions.NotRequired[typing.Optional[str]] + """ + The brand used for the Buy Now Pay Later payment. + The brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`. + """ + + afterpay_details: typing_extensions.NotRequired[AfterpayDetailsParams] + """ + Details about an Afterpay payment. These details are only populated if the `brand` is + `AFTERPAY`. + """ + + clearpay_details: typing_extensions.NotRequired[ClearpayDetailsParams] + """ + Details about a Clearpay payment. These details are only populated if the `brand` is + `CLEARPAY`. + """ diff --git a/src/square/requests/calculate_loyalty_points_response.py b/src/square/requests/calculate_loyalty_points_response.py new file mode 100644 index 00000000..b636b3f9 --- /dev/null +++ b/src/square/requests/calculate_loyalty_points_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class CalculateLoyaltyPointsResponseParams(typing_extensions.TypedDict): + """ + Represents a [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + points: typing_extensions.NotRequired[int] + """ + The number of points that the buyer can earn from the base loyalty program. + """ + + promotion_points: typing_extensions.NotRequired[int] + """ + The number of points that the buyer can earn from a loyalty promotion. To be eligible + to earn promotion points, the purchase must first qualify for program points. When `order_id` + is not provided in the request, this value is always 0. + """ diff --git a/src/square/requests/calculate_order_response.py b/src/square/requests/calculate_order_response.py new file mode 100644 index 00000000..4e9c7aba --- /dev/null +++ b/src/square/requests/calculate_order_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .order import OrderParams +import typing +from .error import ErrorParams + + +class CalculateOrderResponseParams(typing_extensions.TypedDict): + order: typing_extensions.NotRequired[OrderParams] + """ + The calculated version of the order provided in the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/cancel_booking_response.py b/src/square/requests/cancel_booking_response.py new file mode 100644 index 00000000..21150235 --- /dev/null +++ b/src/square/requests/cancel_booking_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .booking import BookingParams +import typing +from .error import ErrorParams + + +class CancelBookingResponseParams(typing_extensions.TypedDict): + booking: typing_extensions.NotRequired[BookingParams] + """ + The booking that was cancelled. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/cancel_invoice_response.py b/src/square/requests/cancel_invoice_response.py new file mode 100644 index 00000000..09263787 --- /dev/null +++ b/src/square/requests/cancel_invoice_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .invoice import InvoiceParams +import typing +from .error import ErrorParams + + +class CancelInvoiceResponseParams(typing_extensions.TypedDict): + """ + The response returned by the `CancelInvoice` request. + """ + + invoice: typing_extensions.NotRequired[InvoiceParams] + """ + The canceled invoice. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/cancel_loyalty_promotion_response.py b/src/square/requests/cancel_loyalty_promotion_response.py new file mode 100644 index 00000000..3ce7d076 --- /dev/null +++ b/src/square/requests/cancel_loyalty_promotion_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_promotion import LoyaltyPromotionParams + + +class CancelLoyaltyPromotionResponseParams(typing_extensions.TypedDict): + """ + Represents a [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion) response. + Either `loyalty_promotion` or `errors` is present in the response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_promotion: typing_extensions.NotRequired[LoyaltyPromotionParams] + """ + The canceled loyalty promotion. + """ diff --git a/src/square/requests/cancel_payment_by_idempotency_key_response.py b/src/square/requests/cancel_payment_by_idempotency_key_response.py new file mode 100644 index 00000000..f20cec37 --- /dev/null +++ b/src/square/requests/cancel_payment_by_idempotency_key_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class CancelPaymentByIdempotencyKeyResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by + [CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey). + On success, `errors` is empty. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/cancel_payment_response.py b/src/square/requests/cancel_payment_response.py new file mode 100644 index 00000000..376577e0 --- /dev/null +++ b/src/square/requests/cancel_payment_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment import PaymentParams + + +class CancelPaymentResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by [CancelPayment](api-endpoint:Payments-CancelPayment). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + payment: typing_extensions.NotRequired[PaymentParams] + """ + The successfully canceled `Payment` object. + """ diff --git a/src/square/requests/cancel_subscription_response.py b/src/square/requests/cancel_subscription_response.py new file mode 100644 index 00000000..c2420103 --- /dev/null +++ b/src/square/requests/cancel_subscription_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams +from .subscription_action import SubscriptionActionParams + + +class CancelSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [CancelSubscription](api-endpoint:Subscriptions-CancelSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The specified subscription scheduled for cancellation according to the action created by the request. + """ + + actions: typing_extensions.NotRequired[typing.Sequence[SubscriptionActionParams]] + """ + A list of a single `CANCEL` action scheduled for the subscription. + """ diff --git a/src/square/requests/cancel_terminal_action_response.py b/src/square/requests/cancel_terminal_action_response.py new file mode 100644 index 00000000..6595afc6 --- /dev/null +++ b/src/square/requests/cancel_terminal_action_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_action import TerminalActionParams + + +class CancelTerminalActionResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + action: typing_extensions.NotRequired[TerminalActionParams] + """ + The canceled `TerminalAction` + """ diff --git a/src/square/requests/cancel_terminal_checkout_response.py b/src/square/requests/cancel_terminal_checkout_response.py new file mode 100644 index 00000000..703c4d4a --- /dev/null +++ b/src/square/requests/cancel_terminal_checkout_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_checkout import TerminalCheckoutParams + + +class CancelTerminalCheckoutResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + checkout: typing_extensions.NotRequired[TerminalCheckoutParams] + """ + The canceled `TerminalCheckout`. + """ diff --git a/src/square/requests/cancel_terminal_refund_response.py b/src/square/requests/cancel_terminal_refund_response.py new file mode 100644 index 00000000..fb81fc57 --- /dev/null +++ b/src/square/requests/cancel_terminal_refund_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_refund import TerminalRefundParams + + +class CancelTerminalRefundResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refund: typing_extensions.NotRequired[TerminalRefundParams] + """ + The updated `TerminalRefund`. + """ diff --git a/src/square/requests/capture_transaction_response.py b/src/square/requests/capture_transaction_response.py new file mode 100644 index 00000000..89a83fc4 --- /dev/null +++ b/src/square/requests/capture_transaction_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class CaptureTransactionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/card.py b/src/square/requests/card.py new file mode 100644 index 00000000..cd699fd1 --- /dev/null +++ b/src/square/requests/card.py @@ -0,0 +1,143 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.card_brand import CardBrand +from ..core.serialization import FieldMetadata +import typing +from .address import AddressParams +from ..types.card_type import CardType +from ..types.card_prepaid_type import CardPrepaidType +from ..types.card_co_brand import CardCoBrand +from ..types.card_issuer_alert import CardIssuerAlert + + +class CardParams(typing_extensions.TypedDict): + """ + Represents the payment details of a card to be used for payments. These + details are determined by the payment token generated by Web Payments SDK. + """ + + id: typing_extensions.NotRequired[str] + """ + Unique ID for this card. Generated by Square. + """ + + card_brand: typing_extensions.NotRequired[CardBrand] + """ + The card's brand. + See [CardBrand](#type-cardbrand) for possible values + """ + + last4: typing_extensions.NotRequired[typing_extensions.Annotated[str, FieldMetadata(alias="last_4")]] + """ + The last 4 digits of the card number. + """ + + exp_month: typing_extensions.NotRequired[typing.Optional[int]] + """ + The expiration month of the associated card as an integer between 1 and 12. + """ + + exp_year: typing_extensions.NotRequired[typing.Optional[int]] + """ + The four-digit year of the card's expiration date. + """ + + cardholder_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the cardholder. + """ + + billing_address: typing_extensions.NotRequired[AddressParams] + """ + The billing address for this card. `US` postal codes can be provided as a 5-digit zip code + or 9-digit ZIP+4 (example: `12345-6789`). For a full list of field meanings by country, see + [Working with Addresses](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-addresses). + """ + + fingerprint: typing_extensions.NotRequired[str] + """ + Intended as a Square-assigned identifier, based + on the card number, to identify the card across multiple locations within a + single application. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + **Required** The ID of a [customer](entity:Customer) to be associated with the card. + """ + + merchant_id: typing_extensions.NotRequired[str] + """ + The ID of the merchant associated with the card. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional user-defined reference ID that associates this card with + another entity in an external system. For example, a customer ID from an + external customer management system. + """ + + enabled: typing_extensions.NotRequired[bool] + """ + Indicates whether or not a card can be used for payments. + """ + + card_type: typing_extensions.NotRequired[CardType] + """ + The type of the card. + The Card object includes this field only in response to Payments API calls. + See [CardType](#type-cardtype) for possible values + """ + + prepaid_type: typing_extensions.NotRequired[CardPrepaidType] + """ + Indicates whether the card is prepaid or not. + See [CardPrepaidType](#type-cardprepaidtype) for possible values + """ + + bin: typing_extensions.NotRequired[str] + """ + The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API + returns this field. + """ + + version: typing_extensions.NotRequired[int] + """ + Current version number of the card. Increments with each card update. Requests to update an + existing Card object will be rejected unless the version in the request matches the current + version for the Card. + """ + + card_co_brand: typing_extensions.NotRequired[CardCoBrand] + """ + The card's co-brand if available. For example, an Afterpay virtual card would have a + co-brand of AFTERPAY. + See [CardCoBrand](#type-cardcobrand) for possible values + """ + + issuer_alert: typing_extensions.NotRequired[CardIssuerAlert] + """ + An alert from the issuing bank about the card status. Alerts can indicate whether + future charges to the card are likely to fail. For more information, see + [Manage Card on File Declines](https://developer.squareup.com/docs/cards-api/manage-card-on-file-declines). + + This field is present only if there's an active issuer alert. + See [IssuerAlert](#type-issueralert) for possible values + """ + + issuer_alert_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the current issuer alert was received and processed, in + RFC 3339 format. + + This field is present only if there's an active issuer alert. + """ + + hsa_fsa: typing_extensions.NotRequired[bool] + """ + Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible + Spending Account (FSA), based on the card BIN. + """ diff --git a/src/square/requests/card_payment_details.py b/src/square/requests/card_payment_details.py new file mode 100644 index 00000000..d479f4fe --- /dev/null +++ b/src/square/requests/card_payment_details.py @@ -0,0 +1,108 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .card import CardParams +from .device_details import DeviceDetailsParams +from .card_payment_timeline import CardPaymentTimelineParams +from .error import ErrorParams + + +class CardPaymentDetailsParams(typing_extensions.TypedDict): + """ + Reflects the current status of a card payment. Contains only non-confidential information. + """ + + status: typing_extensions.NotRequired[typing.Optional[str]] + """ + The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or + FAILED. + """ + + card: typing_extensions.NotRequired[CardParams] + """ + The credit card's non-confidential details. + """ + + entry_method: typing_extensions.NotRequired[typing.Optional[str]] + """ + The method used to enter the card's details for the payment. The method can be + `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + """ + + cvv_status: typing_extensions.NotRequired[typing.Optional[str]] + """ + The status code returned from the Card Verification Value (CVV) check. The code can be + `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`. + """ + + avs_status: typing_extensions.NotRequired[typing.Optional[str]] + """ + The status code returned from the Address Verification System (AVS) check. The code can be + `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`. + """ + + auth_result_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The status code returned by the card issuer that describes the payment's + authorization status. + """ + + application_identifier: typing_extensions.NotRequired[typing.Optional[str]] + """ + For EMV payments, the application ID identifies the EMV application used for the payment. + """ + + application_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + For EMV payments, the human-readable name of the EMV application used for the payment. + """ + + application_cryptogram: typing_extensions.NotRequired[typing.Optional[str]] + """ + For EMV payments, the cryptogram generated for the payment. + """ + + verification_method: typing_extensions.NotRequired[typing.Optional[str]] + """ + For EMV payments, the method used to verify the cardholder's identity. The method can be + `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. + """ + + verification_results: typing_extensions.NotRequired[typing.Optional[str]] + """ + For EMV payments, the results of the cardholder verification. The result can be + `SUCCESS`, `FAILURE`, or `UNKNOWN`. + """ + + statement_description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The statement description sent to the card networks. + + Note: The actual statement description varies and is likely to be truncated and appended with + additional information on a per issuer basis. + """ + + device_details: typing_extensions.NotRequired[DeviceDetailsParams] + """ + __Deprecated__: Use `Payment.device_details` instead. + + Details about the device that took the payment. + """ + + card_payment_timeline: typing_extensions.NotRequired[CardPaymentTimelineParams] + """ + The timeline for card payments. + """ + + refund_requires_card_presence: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether the card must be physically present for the payment to + be refunded. If set to `true`, the card must be present. + """ + + errors: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ErrorParams]]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/card_payment_timeline.py b/src/square/requests/card_payment_timeline.py new file mode 100644 index 00000000..b75bf94a --- /dev/null +++ b/src/square/requests/card_payment_timeline.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CardPaymentTimelineParams(typing_extensions.TypedDict): + """ + The timeline for card payments. + """ + + authorized_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the payment was authorized, in RFC 3339 format. + """ + + captured_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the payment was captured, in RFC 3339 format. + """ + + voided_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the payment was voided, in RFC 3339 format. + """ diff --git a/src/square/requests/cash_app_details.py b/src/square/requests/cash_app_details.py new file mode 100644 index 00000000..1c11aa6e --- /dev/null +++ b/src/square/requests/cash_app_details.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CashAppDetailsParams(typing_extensions.TypedDict): + """ + Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. + """ + + buyer_full_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the Cash App account holder. + """ + + buyer_country_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The country of the Cash App account holder, in ISO 3166-1-alpha-2 format. + + For possible values, see [Country](entity:Country). + """ + + buyer_cashtag: typing_extensions.NotRequired[str] + """ + $Cashtag of the Cash App account holder. + """ diff --git a/src/square/requests/cash_drawer_device.py b/src/square/requests/cash_drawer_device.py new file mode 100644 index 00000000..44474514 --- /dev/null +++ b/src/square/requests/cash_drawer_device.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CashDrawerDeviceParams(typing_extensions.TypedDict): + id: typing_extensions.NotRequired[str] + """ + The device Square-issued ID + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The device merchant-specified name. + """ diff --git a/src/square/requests/cash_drawer_shift.py b/src/square/requests/cash_drawer_shift.py new file mode 100644 index 00000000..b2316697 --- /dev/null +++ b/src/square/requests/cash_drawer_shift.py @@ -0,0 +1,142 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.cash_drawer_shift_state import CashDrawerShiftState +import typing +from .money import MoneyParams +from .cash_drawer_device import CashDrawerDeviceParams + + +class CashDrawerShiftParams(typing_extensions.TypedDict): + """ + This model gives the details of a cash drawer shift. + The cash_payment_money, cash_refund_money, cash_paid_in_money, + and cash_paid_out_money fields are all computed by summing their respective + event types. + """ + + id: typing_extensions.NotRequired[str] + """ + The shift unique ID. + """ + + state: typing_extensions.NotRequired[CashDrawerShiftState] + """ + The shift current state. + See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values + """ + + opened_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the shift began, in ISO 8601 format. + """ + + ended_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the shift ended, in ISO 8601 format. + """ + + closed_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the shift was closed, in ISO 8601 format. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The free-form text description of a cash drawer by an employee. + """ + + opened_cash_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money in the cash drawer at the start of the shift. + The amount must be greater than or equal to zero. + """ + + cash_payment_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money added to the cash drawer from cash payments. + This is computed by summing all events with the types CASH_TENDER_PAYMENT and + CASH_TENDER_CANCELED_PAYMENT. The amount is always greater than or equal to + zero. + """ + + cash_refunds_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money removed from the cash drawer from cash refunds. + It is computed by summing the events of type CASH_TENDER_REFUND. The amount + is always greater than or equal to zero. + """ + + cash_paid_in_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money added to the cash drawer for reasons other than cash + payments. It is computed by summing the events of type PAID_IN. The amount is + always greater than or equal to zero. + """ + + cash_paid_out_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money removed from the cash drawer for reasons other than + cash refunds. It is computed by summing the events of type PAID_OUT. The amount + is always greater than or equal to zero. + """ + + expected_cash_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money that should be in the cash drawer at the end of the + shift, based on the shift's other money amounts. + This can be negative if employees have not correctly recorded all the events + on the cash drawer. + cash_paid_out_money is a summation of amounts from cash_payment_money (zero + or positive), cash_refunds_money (zero or negative), cash_paid_in_money (zero + or positive), and cash_paid_out_money (zero or negative) event types. + """ + + closed_cash_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money found in the cash drawer at the end of the shift + by an auditing employee. The amount should be positive. + """ + + device: typing_extensions.NotRequired[CashDrawerDeviceParams] + """ + The device running Square Point of Sale that was connected to the cash drawer. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The shift start time in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The shift updated at time in RFC 3339 format. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location the cash drawer shift belongs to. + """ + + team_member_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The IDs of all team members that were logged into Square Point of Sale at any + point while the cash drawer shift was open. + """ + + opening_team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the team member that started the cash drawer shift. + """ + + ending_team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the team member that ended the cash drawer shift. + """ + + closing_team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the team member that closed the cash drawer shift by auditing + the cash drawer contents. + """ diff --git a/src/square/requests/cash_drawer_shift_event.py b/src/square/requests/cash_drawer_shift_event.py new file mode 100644 index 00000000..924ff154 --- /dev/null +++ b/src/square/requests/cash_drawer_shift_event.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.cash_drawer_event_type import CashDrawerEventType +from .money import MoneyParams +import typing + + +class CashDrawerShiftEventParams(typing_extensions.TypedDict): + id: typing_extensions.NotRequired[str] + """ + The unique ID of the event. + """ + + event_type: typing_extensions.NotRequired[CashDrawerEventType] + """ + The type of cash drawer shift event. + See [CashDrawerEventType](#type-cashdrawereventtype) for possible values + """ + + event_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money that was added to or removed from the cash drawer + in the event. The amount can be positive (for added money) + or zero (for other tender type payments). The addition or removal of money can be determined by + by the event type. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The event time in RFC 3339 format. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional description of the event, entered by the employee that + created the event. + """ + + team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the team member that created the event. + """ diff --git a/src/square/requests/cash_drawer_shift_summary.py b/src/square/requests/cash_drawer_shift_summary.py new file mode 100644 index 00000000..716b2d75 --- /dev/null +++ b/src/square/requests/cash_drawer_shift_summary.py @@ -0,0 +1,83 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.cash_drawer_shift_state import CashDrawerShiftState +import typing +from .money import MoneyParams + + +class CashDrawerShiftSummaryParams(typing_extensions.TypedDict): + """ + The summary of a closed cash drawer shift. + This model contains only the money counted to start a cash drawer shift, counted + at the end of the shift, and the amount that should be in the drawer at shift + end based on summing all cash drawer shift events. + """ + + id: typing_extensions.NotRequired[str] + """ + The shift unique ID. + """ + + state: typing_extensions.NotRequired[CashDrawerShiftState] + """ + The shift current state. + See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values + """ + + opened_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The shift start time in ISO 8601 format. + """ + + ended_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The shift end time in ISO 8601 format. + """ + + closed_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The shift close time in ISO 8601 format. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + An employee free-text description of a cash drawer shift. + """ + + opened_cash_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money in the cash drawer at the start of the shift. This + must be a positive amount. + """ + + expected_cash_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money that should be in the cash drawer at the end of the + shift, based on the cash drawer events on the shift. + The amount is correct if all shift employees accurately recorded their + cash drawer shift events. Unrecorded events and events with the wrong amount + result in an incorrect expected_cash_money amount that can be negative. + """ + + closed_cash_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money found in the cash drawer at the end of the shift by + an auditing employee. The amount must be greater than or equal to zero. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The shift start time in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The shift updated at time in RFC 3339 format. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location the cash drawer shift belongs to. + """ diff --git a/src/square/requests/cash_payment_details.py b/src/square/requests/cash_payment_details.py new file mode 100644 index 00000000..9b758cac --- /dev/null +++ b/src/square/requests/cash_payment_details.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +import typing_extensions + + +class CashPaymentDetailsParams(typing_extensions.TypedDict): + """ + Stores details about a cash payment. Contains only non-confidential information. For more information, see + [Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments). + """ + + buyer_supplied_money: MoneyParams + """ + The amount and currency of the money supplied by the buyer. + """ + + change_back_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of change due back to the buyer. + This read-only field is calculated + from the `amount_money` and `buyer_supplied_money` fields. + """ diff --git a/src/square/requests/catalog_availability_period.py b/src/square/requests/catalog_availability_period.py new file mode 100644 index 00000000..449c166a --- /dev/null +++ b/src/square/requests/catalog_availability_period.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.day_of_week import DayOfWeek + + +class CatalogAvailabilityPeriodParams(typing_extensions.TypedDict): + """ + Represents a time period of availability. + """ + + start_local_time: typing_extensions.NotRequired[typing.Optional[str]] + """ + The start time of an availability period, specified in local time using partial-time + RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + end_local_time: typing_extensions.NotRequired[typing.Optional[str]] + """ + The end time of an availability period, specified in local time using partial-time + RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + day_of_week: typing_extensions.NotRequired[DayOfWeek] + """ + The day of the week for this availability period. + See [DayOfWeek](#type-dayofweek) for possible values + """ diff --git a/src/square/requests/catalog_category.py b/src/square/requests/catalog_category.py new file mode 100644 index 00000000..6bdb97fb --- /dev/null +++ b/src/square/requests/catalog_category.py @@ -0,0 +1,77 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +from ..types.catalog_category_type import CatalogCategoryType +from .catalog_ecom_seo_data import CatalogEcomSeoDataParams +from .category_path_to_root_node import CategoryPathToRootNodeParams +import typing + +if typing.TYPE_CHECKING: + from .catalog_object_category import CatalogObjectCategoryParams + + +class CatalogCategoryParams(typing_extensions.TypedDict): + """ + A category to which a `CatalogItem` instance belongs. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + image_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of images associated with this `CatalogCategory` instance. + Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications. + """ + + category_type: typing_extensions.NotRequired[CatalogCategoryType] + """ + The type of the category. + See [CatalogCategoryType](#type-catalogcategorytype) for possible values + """ + + parent_category: typing_extensions.NotRequired["CatalogObjectCategoryParams"] + """ + The ID of the parent category of this category instance. + """ + + is_top_level: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether a category is a top level category, which does not have any parent_category. + """ + + channels: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of IDs representing channels, such as a Square Online site, where the category can be made visible. + """ + + availability_period_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of the `CatalogAvailabilityPeriod` objects associated with the category. + """ + + online_visibility: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites. + """ + + root_category: typing_extensions.NotRequired[str] + """ + The top-level category in a category hierarchy. + """ + + ecom_seo_data: typing_extensions.NotRequired[CatalogEcomSeoDataParams] + """ + The SEO data for a seller's Square Online store. + """ + + path_to_root: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CategoryPathToRootNodeParams]]] + """ + The path from the category to its root category. The first node of the path is the parent of the category + and the last is the root category. The path is empty if the category is a root category. + """ diff --git a/src/square/requests/catalog_custom_attribute_definition.py b/src/square/requests/catalog_custom_attribute_definition.py new file mode 100644 index 00000000..7a4d44fc --- /dev/null +++ b/src/square/requests/catalog_custom_attribute_definition.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.catalog_custom_attribute_definition_type import CatalogCustomAttributeDefinitionType +import typing_extensions +import typing +from .source_application import SourceApplicationParams +from ..types.catalog_object_type import CatalogObjectType +from ..types.catalog_custom_attribute_definition_seller_visibility import ( + CatalogCustomAttributeDefinitionSellerVisibility, +) +from ..types.catalog_custom_attribute_definition_app_visibility import CatalogCustomAttributeDefinitionAppVisibility +from .catalog_custom_attribute_definition_string_config import CatalogCustomAttributeDefinitionStringConfigParams +from .catalog_custom_attribute_definition_number_config import CatalogCustomAttributeDefinitionNumberConfigParams +from .catalog_custom_attribute_definition_selection_config import CatalogCustomAttributeDefinitionSelectionConfigParams + + +class CatalogCustomAttributeDefinitionParams(typing_extensions.TypedDict): + """ + Contains information defining a custom attribute. Custom attributes are + intended to store additional information about a catalog object or to associate a + catalog object with an entity in another system. Do not use custom attributes + to store any sensitive information (personally identifiable information, card details, etc.). + [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes) + """ + + type: CatalogCustomAttributeDefinitionType + """ + The type of this custom attribute. Cannot be modified after creation. + Required. + See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values + """ + + name: str + """ + The name of this definition for API and seller-facing UI purposes. + The name must be unique within the (merchant, application) pair. Required. + May not be empty and may not exceed 255 characters. Can be modified after creation. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + Seller-oriented description of the meaning of this Custom Attribute, + any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs. + """ + + source_application: typing_extensions.NotRequired[SourceApplicationParams] + """ + __Read only.__ Contains information about the application that + created this custom attribute definition. + """ + + allowed_object_types: typing.Sequence[CatalogObjectType] + """ + The set of `CatalogObject` types that this custom atttribute may be applied to. + Currently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included. + See [CatalogObjectType](#type-catalogobjecttype) for possible values + """ + + seller_visibility: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionSellerVisibility] + """ + The visibility of a custom attribute in seller-facing UIs (including Square Point + of Sale applications and Square Dashboard). May be modified. + See [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) for possible values + """ + + app_visibility: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionAppVisibility] + """ + The visibility of a custom attribute to applications other than the application + that created the attribute. + See [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) for possible values + """ + + string_config: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionStringConfigParams] + """ + Optionally, populated when `type` = `STRING`, unset otherwise. + """ + + number_config: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionNumberConfigParams] + """ + Optionally, populated when `type` = `NUMBER`, unset otherwise. + """ + + selection_config: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionSelectionConfigParams] + """ + Populated when `type` is set to `SELECTION`, unset otherwise. + """ + + custom_attribute_usage_count: typing_extensions.NotRequired[int] + """ + The number of custom attributes that reference this + custom attribute definition. Set by the server in response to a ListCatalog + request with `include_counts` set to `true`. If the actual count is greater + than 100, `custom_attribute_usage_count` will be set to `100`. + """ + + key: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the desired custom attribute key that can be used to access + the custom attribute value on catalog objects. Cannot be modified after the + custom attribute definition has been created. + Must be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`. + """ diff --git a/src/square/requests/catalog_custom_attribute_definition_number_config.py b/src/square/requests/catalog_custom_attribute_definition_number_config.py new file mode 100644 index 00000000..0a35d32d --- /dev/null +++ b/src/square/requests/catalog_custom_attribute_definition_number_config.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogCustomAttributeDefinitionNumberConfigParams(typing_extensions.TypedDict): + precision: typing_extensions.NotRequired[typing.Optional[int]] + """ + An integer between 0 and 5 that represents the maximum number of + positions allowed after the decimal in number custom attribute values + For example: + + - if the precision is 0, the quantity can be 1, 2, 3, etc. + - if the precision is 1, the quantity can be 0.1, 0.2, etc. + - if the precision is 2, the quantity can be 0.01, 0.12, etc. + + Default: 5 + """ diff --git a/src/square/requests/catalog_custom_attribute_definition_selection_config.py b/src/square/requests/catalog_custom_attribute_definition_selection_config.py new file mode 100644 index 00000000..006f636a --- /dev/null +++ b/src/square/requests/catalog_custom_attribute_definition_selection_config.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .catalog_custom_attribute_definition_selection_config_custom_attribute_selection import ( + CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelectionParams, +) + + +class CatalogCustomAttributeDefinitionSelectionConfigParams(typing_extensions.TypedDict): + """ + Configuration associated with `SELECTION`-type custom attribute definitions. + """ + + max_allowed_selections: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of selections that can be set. The maximum value for this + attribute is 100. The default value is 1. The value can be modified, but changing the value will not + affect existing custom attribute values on objects. Clients need to + handle custom attributes with more selected values than allowed by this limit. + """ + + allowed_selections: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelectionParams]] + ] + """ + The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100 + selections can be defined. Can be modified. + """ diff --git a/src/square/requests/catalog_custom_attribute_definition_selection_config_custom_attribute_selection.py b/src/square/requests/catalog_custom_attribute_definition_selection_config_custom_attribute_selection.py new file mode 100644 index 00000000..92f688b7 --- /dev/null +++ b/src/square/requests/catalog_custom_attribute_definition_selection_config_custom_attribute_selection.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelectionParams(typing_extensions.TypedDict): + """ + A named selection for this `SELECTION`-type custom attribute definition. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + Unique ID set by Square. + """ + + name: str + """ + Selection name, unique within `allowed_selections`. + """ diff --git a/src/square/requests/catalog_custom_attribute_definition_string_config.py b/src/square/requests/catalog_custom_attribute_definition_string_config.py new file mode 100644 index 00000000..85bd17a4 --- /dev/null +++ b/src/square/requests/catalog_custom_attribute_definition_string_config.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogCustomAttributeDefinitionStringConfigParams(typing_extensions.TypedDict): + """ + Configuration associated with Custom Attribute Definitions of type `STRING`. + """ + + enforce_uniqueness: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If true, each Custom Attribute instance associated with this Custom Attribute + Definition must have a unique value within the seller's catalog. For + example, this may be used for a value like a SKU that should not be + duplicated within a seller's catalog. May not be modified after the + definition has been created. + """ diff --git a/src/square/requests/catalog_custom_attribute_value.py b/src/square/requests/catalog_custom_attribute_value.py new file mode 100644 index 00000000..ccb9cae3 --- /dev/null +++ b/src/square/requests/catalog_custom_attribute_value.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.catalog_custom_attribute_definition_type import CatalogCustomAttributeDefinitionType + + +class CatalogCustomAttributeValueParams(typing_extensions.TypedDict): + """ + An instance of a custom attribute. Custom attributes can be defined and + added to `ITEM` and `ITEM_VARIATION` type catalog objects. + [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes). + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the custom attribute. + """ + + string_value: typing_extensions.NotRequired[typing.Optional[str]] + """ + The string value of the custom attribute. Populated if `type` = `STRING`. + """ + + custom_attribute_definition_id: typing_extensions.NotRequired[str] + """ + The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to. + """ + + type: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionType] + """ + A copy of type from the associated `CatalogCustomAttributeDefinition`. + See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values + """ + + number_value: typing_extensions.NotRequired[typing.Optional[str]] + """ + Populated if `type` = `NUMBER`. Contains a string + representation of a decimal number, using a `.` as the decimal separator. + """ + + boolean_value: typing_extensions.NotRequired[typing.Optional[bool]] + """ + A `true` or `false` value. Populated if `type` = `BOOLEAN`. + """ + + selection_uid_values: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`. + """ + + key: typing_extensions.NotRequired[str] + """ + If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID. + For example, if the CatalogCustomAttributeDefinition has a key attribute of "cocoa_brand" and the defining application ID is "abcd1234", this key is "abcd1234:cocoa_brand" + when the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand". + """ diff --git a/src/square/requests/catalog_discount.py b/src/square/requests/catalog_discount.py new file mode 100644 index 00000000..b94ea17c --- /dev/null +++ b/src/square/requests/catalog_discount.py @@ -0,0 +1,74 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.catalog_discount_type import CatalogDiscountType +from .money import MoneyParams +from ..types.catalog_discount_modify_tax_basis import CatalogDiscountModifyTaxBasis + + +class CatalogDiscountParams(typing_extensions.TypedDict): + """ + A discount applicable to items. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + discount_type: typing_extensions.NotRequired[CatalogDiscountType] + """ + Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. + See [CatalogDiscountType](#type-catalogdiscounttype) for possible values + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal + separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` + is `VARIABLE_PERCENTAGE`. + + Do not use this field for amount-based or variable discounts. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. + + Do not use this field for percentage-based or variable discounts. + """ + + pin_required: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether a mobile staff member needs to enter their PIN to apply the + discount to a payment in the Square Point of Sale app. + """ + + label_color: typing_extensions.NotRequired[typing.Optional[str]] + """ + The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. + """ + + modify_tax_basis: typing_extensions.NotRequired[CatalogDiscountModifyTaxBasis] + """ + Indicates whether this discount should reduce the price used to calculate tax. + + Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must + be calculated based on an item's price, ignoring a particular discount. For example, + in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a + customer pays but does not reduce the sale price used to calculate how much sales tax is + due. In this case, the discount representing that manufacturer coupon should have + `DO_NOT_MODIFY_TAX_BASIS` for this field. + + If you are unsure whether you need to use this field, consult your tax professional. + See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values + """ + + maximum_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + For a percentage discount, the maximum absolute value of the discount. For example, if a + 50% discount has a `maximum_amount_money` of $20, a $100 purchase will yield a $20 discount, + not a $50 discount. + """ diff --git a/src/square/requests/catalog_ecom_seo_data.py b/src/square/requests/catalog_ecom_seo_data.py new file mode 100644 index 00000000..856e84a1 --- /dev/null +++ b/src/square/requests/catalog_ecom_seo_data.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogEcomSeoDataParams(typing_extensions.TypedDict): + """ + SEO data for for a seller's Square Online store. + """ + + page_title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The SEO title used for the Square Online store. + """ + + page_description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The SEO description used for the Square Online store. + """ + + permalink: typing_extensions.NotRequired[typing.Optional[str]] + """ + The SEO permalink used for the Square Online store. + """ diff --git a/src/square/requests/catalog_id_mapping.py b/src/square/requests/catalog_id_mapping.py new file mode 100644 index 00000000..c0546499 --- /dev/null +++ b/src/square/requests/catalog_id_mapping.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogIdMappingParams(typing_extensions.TypedDict): + """ + A mapping between a temporary client-supplied ID and a permanent server-generated ID. + + When calling [UpsertCatalogObject](api-endpoint:Catalog-UpsertCatalogObject) or + [BatchUpsertCatalogObjects](api-endpoint:Catalog-BatchUpsertCatalogObjects) to + create a [CatalogObject](entity:CatalogObject) instance, you can supply + a temporary ID for the to-be-created object, especially when the object is to be referenced + elsewhere in the same request body. This temporary ID can be any string unique within + the call, but must be prefixed by "#". + + After the request is submitted and the object created, a permanent server-generated ID is assigned + to the new object. The permanent ID is unique across the Square catalog. + """ + + client_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The client-supplied temporary `#`-prefixed ID for a new `CatalogObject`. + """ + + object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The permanent ID for the CatalogObject created by the server. + """ diff --git a/src/square/requests/catalog_image.py b/src/square/requests/catalog_image.py new file mode 100644 index 00000000..b9d1a689 --- /dev/null +++ b/src/square/requests/catalog_image.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogImageParams(typing_extensions.TypedDict): + """ + An image file to use in Square catalogs. It can be associated with + `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects. + Only the images on items and item variations are exposed in Dashboard. + Only the first image on an item is displayed in Square Point of Sale (SPOS). + Images on items and variations are displayed through Square Online Store. + Images on other object types are for use by 3rd party application developers. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The internal name to identify this image in calls to the Square API. + This is a searchable attribute for use in applicable query filters + using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + It is not unique and should not be shown in a buyer facing context. + """ + + url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The URL of this image, generated by Square after an image is uploaded + using the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint. + To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field. + """ + + caption: typing_extensions.NotRequired[typing.Optional[str]] + """ + A caption that describes what is shown in the image. Displayed in the + Square Online Store. This is a searchable attribute for use in applicable query filters + using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + """ + + photo_studio_order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The immutable order ID for this image object created by the Photo Studio service in Square Online Store. + """ diff --git a/src/square/requests/catalog_info_response.py b/src/square/requests/catalog_info_response.py new file mode 100644 index 00000000..496b3aaf --- /dev/null +++ b/src/square/requests/catalog_info_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_info_response_limits import CatalogInfoResponseLimitsParams +from .standard_unit_description_group import StandardUnitDescriptionGroupParams + + +class CatalogInfoResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + limits: typing_extensions.NotRequired[CatalogInfoResponseLimitsParams] + """ + Limits that apply to this API. + """ + + standard_unit_description_group: typing_extensions.NotRequired[StandardUnitDescriptionGroupParams] + """ + Names and abbreviations for standard units. + """ diff --git a/src/square/requests/catalog_info_response_limits.py b/src/square/requests/catalog_info_response_limits.py new file mode 100644 index 00000000..75bd739c --- /dev/null +++ b/src/square/requests/catalog_info_response_limits.py @@ -0,0 +1,73 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogInfoResponseLimitsParams(typing_extensions.TypedDict): + batch_upsert_max_objects_per_batch: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of objects that may appear within a single batch in a + `/v2/catalog/batch-upsert` request. + """ + + batch_upsert_max_total_objects: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of objects that may appear across all batches in a + `/v2/catalog/batch-upsert` request. + """ + + batch_retrieve_max_object_ids: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve` + request. + """ + + search_max_page_limit: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of results that may be returned in a page of a + `/v2/catalog/search` response. + """ + + batch_delete_max_object_ids: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of object IDs that may be included in a single + `/v2/catalog/batch-delete` request. + """ + + update_item_taxes_max_item_ids: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of item IDs that may be included in a single + `/v2/catalog/update-item-taxes` request. + """ + + update_item_taxes_max_taxes_to_enable: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of tax IDs to be enabled that may be included in a single + `/v2/catalog/update-item-taxes` request. + """ + + update_item_taxes_max_taxes_to_disable: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of tax IDs to be disabled that may be included in a single + `/v2/catalog/update-item-taxes` request. + """ + + update_item_modifier_lists_max_item_ids: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of item IDs that may be included in a single + `/v2/catalog/update-item-modifier-lists` request. + """ + + update_item_modifier_lists_max_modifier_lists_to_enable: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of modifier list IDs to be enabled that may be included in + a single `/v2/catalog/update-item-modifier-lists` request. + """ + + update_item_modifier_lists_max_modifier_lists_to_disable: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum number of modifier list IDs to be disabled that may be included in + a single `/v2/catalog/update-item-modifier-lists` request. + """ diff --git a/src/square/requests/catalog_item.py b/src/square/requests/catalog_item.py new file mode 100644 index 00000000..73a681fa --- /dev/null +++ b/src/square/requests/catalog_item.py @@ -0,0 +1,205 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +from .catalog_item_modifier_list_info import CatalogItemModifierListInfoParams +from ..types.catalog_item_product_type import CatalogItemProductType +from .catalog_item_option_for_item import CatalogItemOptionForItemParams +from .catalog_object_category import CatalogObjectCategoryParams +from .catalog_ecom_seo_data import CatalogEcomSeoDataParams +from .catalog_item_food_and_beverage_details import CatalogItemFoodAndBeverageDetailsParams +import typing + +if typing.TYPE_CHECKING: + from .catalog_object import CatalogObjectParams + + +class CatalogItemParams(typing_extensions.TypedDict): + """ + A [CatalogObject](entity:CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + + Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description + of the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to + set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, + except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null + does not nullify `description_html`. + """ + + abbreviation: typing_extensions.NotRequired[typing.Optional[str]] + """ + The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. + This attribute is searchable, and its value length is of Unicode code points. + """ + + label_color: typing_extensions.NotRequired[typing.Optional[str]] + """ + The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. + """ + + is_taxable: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the item is taxable (`true`) or non-taxable (`false`). Default is `true`. + """ + + category_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the item's category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead. + """ + + tax_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A set of IDs indicating the taxes enabled for + this item. When updating an item, any taxes listed here will be added to the item. + Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. + """ + + modifier_list_info: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[CatalogItemModifierListInfoParams]] + ] + """ + A set of `CatalogItemModifierListInfo` objects + representing the modifier lists that apply to this item, along with the overrides and min + and max limits that are specific to this item. Modifier lists + may also be added to or deleted from an item using `UpdateItemModifierLists`. + """ + + variations: typing_extensions.NotRequired[typing.Optional[typing.Sequence["CatalogObjectParams"]]] + """ + A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have + at least one variation. + """ + + product_type: typing_extensions.NotRequired[CatalogItemProductType] + """ + The product type of the item. Once set, the `product_type` value cannot be modified. + + Items of the `LEGACY_SQUARE_ONLINE_SERVICE` and `LEGACY_SQUARE_ONLINE_MEMBERSHIP` product types can be updated + but cannot be created using the API. + See [CatalogItemProductType](#type-catalogitemproducttype) for possible values + """ + + skip_modifier_screen: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `false`, the Square Point of Sale app will present the `CatalogItem`'s + details screen immediately, allowing the merchant to choose `CatalogModifier`s + before adding the item to the cart. This is the default behavior. + + If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected + modifiers, and merchants can edit modifiers by drilling down onto the item's details. + + Third-party clients are encouraged to implement similar behaviors. + """ + + item_options: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CatalogItemOptionForItemParams]]] + """ + List of item options IDs for this item. Used to manage and group item + variations in a specified order. + + Maximum: 6 item options. + """ + + ecom_uri: typing_extensions.NotRequired[typing.Optional[str]] + """ + Deprecated; see go/ecomUriUseCases. A URI pointing to a published e-commerce product page for the Item. + """ + + ecom_image_uris: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Deprecated; see go/ecomUriUseCases. A comma-separated list of encoded URIs pointing to a set of published e-commerce images for the Item. + """ + + image_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of images associated with this `CatalogItem` instance. + These images will be shown to customers in Square Online Store. + The first image will show up as the icon for this item in POS. + """ + + sort_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting. + Its value must not be empty. + + It is currently supported for sellers of the Japanese locale only. + """ + + categories: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CatalogObjectCategoryParams]]] + """ + The list of categories. + """ + + description_html: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags, + is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or + unsupported HTML elements or attributes are ignored. + + Supported HTML elements include: + - `a`: Link. Supports linking to website URLs, email address, and telephone numbers. + - `b`, `strong`: Bold text + - `br`: Line break + - `code`: Computer code + - `div`: Section + - `h1-h6`: Headings + - `i`, `em`: Italics + - `li`: List element + - `ol`: Numbered list + - `p`: Paragraph + - `ul`: Bullet list + - `u`: Underline + + + Supported HTML attributes include: + - `align`: Alignment of the text content + - `href`: Link destination + - `rel`: Relationship between link's target and source + - `target`: Place to open the linked document + """ + + description_plaintext: typing_extensions.NotRequired[str] + """ + A server-generated plaintext version of the `description_html` field, without formatting tags. + """ + + channels: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available. + This field is read only and cannot be edited. + """ + + is_archived: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether this item is archived (`true`) or not (`false`). + """ + + ecom_seo_data: typing_extensions.NotRequired[CatalogEcomSeoDataParams] + """ + The SEO data for a seller's Square Online store. + """ + + food_and_beverage_details: typing_extensions.NotRequired[CatalogItemFoodAndBeverageDetailsParams] + """ + The food and beverage-specific details for the `FOOD_AND_BEV` item. + """ + + reporting_category: typing_extensions.NotRequired[CatalogObjectCategoryParams] + """ + The item's reporting category. + """ + + is_alcoholic: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether this item is alcoholic (`true`) or not (`false`). + """ diff --git a/src/square/requests/catalog_item_food_and_beverage_details.py b/src/square/requests/catalog_item_food_and_beverage_details.py new file mode 100644 index 00000000..2b3c1602 --- /dev/null +++ b/src/square/requests/catalog_item_food_and_beverage_details.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .catalog_item_food_and_beverage_details_dietary_preference import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceParams, +) +from .catalog_item_food_and_beverage_details_ingredient import CatalogItemFoodAndBeverageDetailsIngredientParams + + +class CatalogItemFoodAndBeverageDetailsParams(typing_extensions.TypedDict): + """ + The food and beverage-specific details of a `FOOD_AND_BEV` item. + """ + + calorie_count: typing_extensions.NotRequired[typing.Optional[int]] + """ + The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of items. + """ + + dietary_preferences: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[CatalogItemFoodAndBeverageDetailsDietaryPreferenceParams]] + ] + """ + The dietary preferences for the `FOOD_AND_BEV` item. + """ + + ingredients: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[CatalogItemFoodAndBeverageDetailsIngredientParams]] + ] + """ + The ingredients for the `FOOD_AND_BEV` type item. + """ diff --git a/src/square/requests/catalog_item_food_and_beverage_details_dietary_preference.py b/src/square/requests/catalog_item_food_and_beverage_details_dietary_preference.py new file mode 100644 index 00000000..72ba99bb --- /dev/null +++ b/src/square/requests/catalog_item_food_and_beverage_details_dietary_preference.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.catalog_item_food_and_beverage_details_dietary_preference_type import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceType, +) +from ..types.catalog_item_food_and_beverage_details_dietary_preference_standard_dietary_preference import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference, +) +import typing + + +class CatalogItemFoodAndBeverageDetailsDietaryPreferenceParams(typing_extensions.TypedDict): + """ + Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its ingredients. + """ + + type: typing_extensions.NotRequired[CatalogItemFoodAndBeverageDetailsDietaryPreferenceType] + """ + The dietary preference type. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`. + See [DietaryPreferenceType](#type-dietarypreferencetype) for possible values + """ + + standard_name: typing_extensions.NotRequired[ + CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference + ] + """ + The name of the dietary preference from a standard pre-defined list. This should be null if it's a custom dietary preference. + See [StandardDietaryPreference](#type-standarddietarypreference) for possible values + """ + + custom_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of a user-defined custom dietary preference. This should be null if it's a standard dietary preference. + """ diff --git a/src/square/requests/catalog_item_food_and_beverage_details_ingredient.py b/src/square/requests/catalog_item_food_and_beverage_details_ingredient.py new file mode 100644 index 00000000..b9fe63e2 --- /dev/null +++ b/src/square/requests/catalog_item_food_and_beverage_details_ingredient.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.catalog_item_food_and_beverage_details_dietary_preference_type import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceType, +) +from ..types.catalog_item_food_and_beverage_details_ingredient_standard_ingredient import ( + CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient, +) +import typing + + +class CatalogItemFoodAndBeverageDetailsIngredientParams(typing_extensions.TypedDict): + """ + Describes the ingredient used in a `FOOD_AND_BEV` item. + """ + + type: typing_extensions.NotRequired[CatalogItemFoodAndBeverageDetailsDietaryPreferenceType] + """ + The dietary preference type of the ingredient. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`. + See [DietaryPreferenceType](#type-dietarypreferencetype) for possible values + """ + + standard_name: typing_extensions.NotRequired[CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient] + """ + The name of the ingredient from a standard pre-defined list. This should be null if it's a custom dietary preference. + See [StandardIngredient](#type-standardingredient) for possible values + """ + + custom_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of a custom user-defined ingredient. This should be null if it's a standard dietary preference. + """ diff --git a/src/square/requests/catalog_item_modifier_list_info.py b/src/square/requests/catalog_item_modifier_list_info.py new file mode 100644 index 00000000..d2b61d26 --- /dev/null +++ b/src/square/requests/catalog_item_modifier_list_info.py @@ -0,0 +1,62 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .catalog_modifier_override import CatalogModifierOverrideParams + + +class CatalogItemModifierListInfoParams(typing_extensions.TypedDict): + """ + References a text-based modifier or a list of non text-based modifiers applied to a `CatalogItem` instance + and specifies supported behaviors of the application. + """ + + modifier_list_id: str + """ + The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. + """ + + modifier_overrides: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CatalogModifierOverrideParams]]] + """ + A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. + """ + + min_selected_modifiers: typing_extensions.NotRequired[typing.Optional[int]] + """ + If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. + The default value is `-1`. + + When `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of + the `CatalogModifierList` can be selected from the `CatalogModifierList`. + + When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in + and can be selected from the `CatalogModifierList` + """ + + max_selected_modifiers: typing_extensions.NotRequired[typing.Optional[int]] + """ + If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. + The default value is `-1`. + + When `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of + the `CatalogModifierList` can be selected from the `CatalogModifierList`. + + When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in + and can be selected from the `CatalogModifierList` + """ + + enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `true`, enable this `CatalogModifierList`. The default value is `true`. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied + to a `CatalogItem` instance. + """ diff --git a/src/square/requests/catalog_item_option.py b/src/square/requests/catalog_item_option.py new file mode 100644 index 00000000..22745c42 --- /dev/null +++ b/src/square/requests/catalog_item_option.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +import typing + +if typing.TYPE_CHECKING: + from .catalog_object import CatalogObjectParams + + +class CatalogItemOptionParams(typing_extensions.TypedDict): + """ + A group of variations for a `CatalogItem`. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item option's display name for the seller. Must be unique across + all item options. This is a searchable attribute for use in applicable query filters. + """ + + display_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item option's display name for the customer. This is a searchable attribute for use in applicable query filters. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item option's human-readable description. Displayed in the Square + Point of Sale app for the seller and in the Online Store or on receipts for + the buyer. This is a searchable attribute for use in applicable query filters. + """ + + show_colors: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If true, display colors for entries in `values` when present. + """ + + values: typing_extensions.NotRequired[typing.Optional[typing.Sequence["CatalogObjectParams"]]] + """ + A list of CatalogObjects containing the + `CatalogItemOptionValue`s for this item. + """ diff --git a/src/square/requests/catalog_item_option_for_item.py b/src/square/requests/catalog_item_option_for_item.py new file mode 100644 index 00000000..a77e9826 --- /dev/null +++ b/src/square/requests/catalog_item_option_for_item.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogItemOptionForItemParams(typing_extensions.TypedDict): + """ + An option that can be assigned to an item. + For example, a t-shirt item may offer a color option or a size option. + """ + + item_option_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique id of the item option, used to form the dimensions of the item option matrix in a specified order. + """ diff --git a/src/square/requests/catalog_item_option_value.py b/src/square/requests/catalog_item_option_value.py new file mode 100644 index 00000000..92241f91 --- /dev/null +++ b/src/square/requests/catalog_item_option_value.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogItemOptionValueParams(typing_extensions.TypedDict): + """ + An enumerated value that can link a + `CatalogItemVariation` to an item option as one of + its item option values. + """ + + item_option_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + Unique ID of the associated item option. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + Name of this item option value. This is a searchable attribute for use in applicable query filters. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + A human-readable description for the option value. This is a searchable attribute for use in applicable query filters. + """ + + color: typing_extensions.NotRequired[typing.Optional[str]] + """ + The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). + Only displayed if `show_colors` is enabled on the parent `ItemOption`. When + left unset, `color` defaults to white ("#ffffff") when `show_colors` is + enabled on the parent `ItemOption`. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + Determines where this option value appears in a list of option values. + """ diff --git a/src/square/requests/catalog_item_option_value_for_item_variation.py b/src/square/requests/catalog_item_option_value_for_item_variation.py new file mode 100644 index 00000000..ed53a181 --- /dev/null +++ b/src/square/requests/catalog_item_option_value_for_item_variation.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogItemOptionValueForItemVariationParams(typing_extensions.TypedDict): + """ + A `CatalogItemOptionValue` links an item variation to an item option as + an item option value. For example, a t-shirt item may offer a color option and + a size option. An item option value would represent each variation of t-shirt: + For example, "Color:Red, Size:Small" or "Color:Blue, Size:Medium". + """ + + item_option_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique id of an item option. + """ + + item_option_value_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique id of the selected value for the item option. + """ diff --git a/src/square/requests/catalog_item_variation.py b/src/square/requests/catalog_item_variation.py new file mode 100644 index 00000000..d28c59c3 --- /dev/null +++ b/src/square/requests/catalog_item_variation.py @@ -0,0 +1,170 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.catalog_pricing_type import CatalogPricingType +from .money import MoneyParams +from .item_variation_location_overrides import ItemVariationLocationOverridesParams +from ..types.inventory_alert_type import InventoryAlertType +from .catalog_item_option_value_for_item_variation import CatalogItemOptionValueForItemVariationParams +from .catalog_stock_conversion import CatalogStockConversionParams + + +class CatalogItemVariationParams(typing_extensions.TypedDict): + """ + An item variation, representing a product for sale, in the Catalog object model. Each [item](entity:CatalogItem) must have at least one + item variation and can have at most 250 item variations. + + An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked + number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both + stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass + variation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be + converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes + the `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count + decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion. + """ + + item_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the `CatalogItem` associated with this item variation. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item variation's name. This is a searchable attribute for use in applicable query filters. + + Its value has a maximum length of 255 Unicode code points. However, when the parent [item](entity:CatalogItem) + uses [item options](entity:CatalogItemOption), this attribute is auto-generated, read-only, and can be + longer than 255 Unicode code points. + """ + + sku: typing_extensions.NotRequired[typing.Optional[str]] + """ + The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters. + """ + + upc: typing_extensions.NotRequired[typing.Optional[str]] + """ + The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters. + + The value of this attribute should be a number of 12-14 digits long. This restriction is enforced on the Square Seller Dashboard, + Square Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned + to this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps + unless it is updated to fit the expected format. + """ + + ordinal: typing_extensions.NotRequired[int] + """ + The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal + for each item variation within a parent `CatalogItem` is set according to the item variations's + position. On reads, the value is not guaranteed to be sequential or unique. + """ + + pricing_type: typing_extensions.NotRequired[CatalogPricingType] + """ + Indicates whether the item variation's price is fixed or determined at the time + of sale. + See [CatalogPricingType](#type-catalogpricingtype) for possible values + """ + + price_money: typing_extensions.NotRequired[MoneyParams] + """ + The item variation's price, if fixed pricing is used. + """ + + location_overrides: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[ItemVariationLocationOverridesParams]] + ] + """ + Per-location price and inventory overrides. + """ + + track_inventory: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `true`, inventory tracking is active for the variation. + """ + + inventory_alert_type: typing_extensions.NotRequired[InventoryAlertType] + """ + Indicates whether the item variation displays an alert when its inventory quantity is less than or equal + to its `inventory_alert_threshold`. + See [InventoryAlertType](#type-inventoryalerttype) for possible values + """ + + inventory_alert_threshold: typing_extensions.NotRequired[typing.Optional[int]] + """ + If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` + is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. + + This value is always an integer. + """ + + user_data: typing_extensions.NotRequired[typing.Optional[str]] + """ + Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points. + """ + + service_duration: typing_extensions.NotRequired[typing.Optional[int]] + """ + If the `CatalogItem` that owns this item variation is of type + `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For + example, a 30 minute appointment would have the value `1800000`, which is equal to + 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). + """ + + available_for_booking: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If the `CatalogItem` that owns this item variation is of type + `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking. + """ + + item_option_values: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[CatalogItemOptionValueForItemVariationParams]] + ] + """ + List of item option values associated with this item variation. Listed + in the same order as the item options of the parent item. + """ + + measurement_unit_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity + sold of this item variation. If left unset, the item will be sold in + whole quantities. + """ + + sellable: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether this variation can be sold. The inventory count of a sellable variation indicates + the number of units available for sale. When a variation is both stockable and sellable, + its sellable inventory count can be smaller than or equal to its stockable count. + """ + + stockable: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE). + When a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock + and is not an indicator of the number of units of the variation that can be sold. + """ + + image_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of images associated with this `CatalogItemVariation` instance. + These images will be shown to customers in Square Online Store. + """ + + team_member_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Tokens of employees that can perform the service represented by this variation. Only valid for + variations of type `APPOINTMENTS_SERVICE`. + """ + + stockable_conversion: typing_extensions.NotRequired[CatalogStockConversionParams] + """ + The unit conversion rule, as prescribed by the [CatalogStockConversion](entity:CatalogStockConversion) type, + that describes how this non-stockable (i.e., sellable/receivable) item variation is converted + to/from the stockable item variation sharing the same parent item. With the stock conversion, + you can accurately track inventory when an item variation is sold in one unit, but stocked in + another unit. + """ diff --git a/src/square/requests/catalog_measurement_unit.py b/src/square/requests/catalog_measurement_unit.py new file mode 100644 index 00000000..b2eb24c1 --- /dev/null +++ b/src/square/requests/catalog_measurement_unit.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .measurement_unit import MeasurementUnitParams +import typing + + +class CatalogMeasurementUnitParams(typing_extensions.TypedDict): + """ + Represents the unit used to measure a `CatalogItemVariation` and + specifies the precision for decimal quantities. + """ + + measurement_unit: typing_extensions.NotRequired[MeasurementUnitParams] + """ + Indicates the unit used to measure the quantity of a catalog item variation. + """ + + precision: typing_extensions.NotRequired[typing.Optional[int]] + """ + An integer between 0 and 5 that represents the maximum number of + positions allowed after the decimal in quantities measured with this unit. + For example: + + - if the precision is 0, the quantity can be 1, 2, 3, etc. + - if the precision is 1, the quantity can be 0.1, 0.2, etc. + - if the precision is 2, the quantity can be 0.01, 0.12, etc. + + Default: 3 + """ diff --git a/src/square/requests/catalog_modifier.py b/src/square/requests/catalog_modifier.py new file mode 100644 index 00000000..342171b0 --- /dev/null +++ b/src/square/requests/catalog_modifier.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from .modifier_location_overrides import ModifierLocationOverridesParams + + +class CatalogModifierParams(typing_extensions.TypedDict): + """ + A modifier applicable to items at the time of sale. An example of a modifier is a Cheese add-on to a Burger item. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The modifier name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + price_money: typing_extensions.NotRequired[MoneyParams] + """ + The modifier price. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + Determines where this `CatalogModifier` appears in the `CatalogModifierList`. + """ + + modifier_list_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the `CatalogModifierList` associated with this modifier. + """ + + location_overrides: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ModifierLocationOverridesParams]]] + """ + Location-specific price overrides. + """ + + image_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the image associated with this `CatalogModifier` instance. + Currently this image is not displayed by Square, but is free to be displayed in 3rd party applications. + """ diff --git a/src/square/requests/catalog_modifier_list.py b/src/square/requests/catalog_modifier_list.py new file mode 100644 index 00000000..d5248bd2 --- /dev/null +++ b/src/square/requests/catalog_modifier_list.py @@ -0,0 +1,102 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +from ..types.catalog_modifier_list_selection_type import CatalogModifierListSelectionType +from ..types.catalog_modifier_list_modifier_type import CatalogModifierListModifierType +import typing + +if typing.TYPE_CHECKING: + from .catalog_object import CatalogObjectParams + + +class CatalogModifierListParams(typing_extensions.TypedDict): + """ + For a text-based modifier, this encapsulates the modifier's text when its `modifier_type` is `TEXT`. + For example, to sell T-shirts with custom prints, a text-based modifier can be used to capture the buyer-supplied + text string to be selected for the T-shirt at the time of sale. + + For non text-based modifiers, this encapsulates a non-empty list of modifiers applicable to items + at the time of sale. Each element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type. + For example, a "Condiments" modifier list applicable to a "Hot Dog" item + may contain "Ketchup", "Mustard", and "Relish" modifiers. + + A non text-based modifier can be applied to the modified item once or multiple times, if the `selection_type` field + is set to `SINGLE` or `MULTIPLE`, respectively. On the other hand, a text-based modifier can be applied to the item + only once and the `selection_type` field is always set to `SINGLE`. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of + Unicode code points. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + The position of this `CatalogModifierList` within a list of `CatalogModifierList` instances. + """ + + selection_type: typing_extensions.NotRequired[CatalogModifierListSelectionType] + """ + Indicates whether a single (`SINGLE`) or multiple (`MULTIPLE`) modifiers from the list + can be applied to a single `CatalogItem`. + + For text-based modifiers, the `selection_type` attribute is always `SINGLE`. The other value is ignored. + See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values + """ + + modifiers: typing_extensions.NotRequired[typing.Optional[typing.Sequence["CatalogObjectParams"]]] + """ + A non-empty list of `CatalogModifier` objects to be included in the `CatalogModifierList`, + for non text-based modifiers when the `modifier_type` attribute is `LIST`. Each element of this list + is a `CatalogObject` instance of the `MODIFIER` type, containing the following attributes: + ``` + { + "id": "{{catalog_modifier_id}}", + "type": "MODIFIER", + "modifier_data": {{a CatalogModifier instance>}} + } + ``` + """ + + image_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of images associated with this `CatalogModifierList` instance. + Currently these images are not displayed on Square products, but may be displayed in 3rd-party applications. + """ + + modifier_type: typing_extensions.NotRequired[CatalogModifierListModifierType] + """ + The type of the modifier. + + When this `modifier_type` value is `TEXT`, the `CatalogModifierList` represents a text-based modifier. + When this `modifier_type` value is `LIST`, the `CatalogModifierList` contains a list of `CatalogModifier` objects. + See [CatalogModifierListModifierType](#type-catalogmodifierlistmodifiertype) for possible values + """ + + max_length: typing_extensions.NotRequired[typing.Optional[int]] + """ + The maximum length, in Unicode points, of the text string of the text-based modifier as represented by + this `CatalogModifierList` object with the `modifier_type` set to `TEXT`. + """ + + text_required: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether the text string must be a non-empty string (`true`) or not (`false`) for a text-based modifier + as represented by this `CatalogModifierList` object with the `modifier_type` set to `TEXT`. + """ + + internal_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note for internal use by the business. + + For example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of "Hello, Kitty!" + is to be printed on the T-shirt, this `internal_name` attribute can be "Use italic face" as + an instruction for the business to follow. + + For non text-based modifiers, this `internal_name` attribute can be + used to include SKUs, internal codes, or supplemental descriptions for internal use. + """ diff --git a/src/square/requests/catalog_modifier_override.py b/src/square/requests/catalog_modifier_override.py new file mode 100644 index 00000000..168a8c79 --- /dev/null +++ b/src/square/requests/catalog_modifier_override.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogModifierOverrideParams(typing_extensions.TypedDict): + """ + Options to control how to override the default behavior of the specified modifier. + """ + + modifier_id: str + """ + The ID of the `CatalogModifier` whose default behavior is being overridden. + """ + + on_by_default: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. + """ diff --git a/src/square/requests/catalog_object.py b/src/square/requests/catalog_object.py new file mode 100644 index 00000000..2b2c085d --- /dev/null +++ b/src/square/requests/catalog_object.py @@ -0,0 +1,65 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing +from .catalog_object_image import CatalogObjectImageParams +from .catalog_object_category import CatalogObjectCategoryParams +from .catalog_object_item_variation import CatalogObjectItemVariationParams +from .catalog_object_tax import CatalogObjectTaxParams +from .catalog_object_discount import CatalogObjectDiscountParams +from .catalog_object_modifier import CatalogObjectModifierParams +from .catalog_object_dining_option import CatalogObjectDiningOptionParams +from .catalog_object_tax_exemption import CatalogObjectTaxExemptionParams +from .catalog_object_service_charge import CatalogObjectServiceChargeParams +from .catalog_object_pricing_rule import CatalogObjectPricingRuleParams +from .catalog_object_product_set import CatalogObjectProductSetParams +from .catalog_object_time_period import CatalogObjectTimePeriodParams +from .catalog_object_measurement_unit import CatalogObjectMeasurementUnitParams +from .catalog_object_item_option_value import CatalogObjectItemOptionValueParams +from .catalog_object_custom_attribute_definition import CatalogObjectCustomAttributeDefinitionParams +from .catalog_object_quick_amounts_settings import CatalogObjectQuickAmountsSettingsParams +from .catalog_object_component import CatalogObjectComponentParams +from .catalog_object_composition import CatalogObjectCompositionParams +from .catalog_object_resource import CatalogObjectResourceParams +from .catalog_object_checkout_link import CatalogObjectCheckoutLinkParams +from .catalog_object_address import CatalogObjectAddressParams +from .catalog_object_subscription_product import CatalogObjectSubscriptionProductParams +from .catalog_object_subscription_plan_variation import CatalogObjectSubscriptionPlanVariationParams +from .catalog_object_availability_period import CatalogObjectAvailabilityPeriodParams +import typing + +if typing.TYPE_CHECKING: + from .catalog_object_item import CatalogObjectItemParams + from .catalog_object_modifier_list import CatalogObjectModifierListParams + from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlanParams + from .catalog_object_item_option import CatalogObjectItemOptionParams +CatalogObjectParams = typing.Union[ + "CatalogObjectItemParams", + CatalogObjectImageParams, + CatalogObjectCategoryParams, + CatalogObjectItemVariationParams, + CatalogObjectTaxParams, + CatalogObjectDiscountParams, + "CatalogObjectModifierListParams", + CatalogObjectModifierParams, + CatalogObjectDiningOptionParams, + CatalogObjectTaxExemptionParams, + CatalogObjectServiceChargeParams, + CatalogObjectPricingRuleParams, + CatalogObjectProductSetParams, + CatalogObjectTimePeriodParams, + CatalogObjectMeasurementUnitParams, + "CatalogObjectSubscriptionPlanParams", + "CatalogObjectItemOptionParams", + CatalogObjectItemOptionValueParams, + CatalogObjectCustomAttributeDefinitionParams, + CatalogObjectQuickAmountsSettingsParams, + CatalogObjectComponentParams, + CatalogObjectCompositionParams, + CatalogObjectResourceParams, + CatalogObjectCheckoutLinkParams, + CatalogObjectAddressParams, + CatalogObjectSubscriptionProductParams, + CatalogObjectSubscriptionPlanVariationParams, + CatalogObjectAvailabilityPeriodParams, +] diff --git a/src/square/requests/catalog_object_address.py b/src/square/requests/catalog_object_address.py new file mode 100644 index 00000000..e561795f --- /dev/null +++ b/src/square/requests/catalog_object_address.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectAddressParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_availability_period.py b/src/square/requests/catalog_object_availability_period.py new file mode 100644 index 00000000..7045a6b5 --- /dev/null +++ b/src/square/requests/catalog_object_availability_period.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_availability_period import CatalogAvailabilityPeriodParams + + +class CatalogObjectAvailabilityPeriodParams(CatalogObjectBaseParams): + availability_period_data: typing_extensions.NotRequired[CatalogAvailabilityPeriodParams] + """ + Structured data for a `CatalogAvailabilityPeriod`, set for CatalogObjects of type `AVAILABILITY_PERIOD`. + """ diff --git a/src/square/requests/catalog_object_base.py b/src/square/requests/catalog_object_base.py new file mode 100644 index 00000000..121cdc09 --- /dev/null +++ b/src/square/requests/catalog_object_base.py @@ -0,0 +1,100 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.catalog_object_type import CatalogObjectType +import typing_extensions +import typing +from .catalog_custom_attribute_value import CatalogCustomAttributeValueParams +from .catalog_v1id import CatalogV1IdParams +from ..core.serialization import FieldMetadata + + +class CatalogObjectBaseParams(typing_extensions.TypedDict): + type: CatalogObjectType + """ + The type of this object. Each object type has expected + properties expressed in a structured format within its corresponding `*_data` field below. + See [CatalogObjectType](#type-catalogobjecttype) for possible values + """ + + id: str + """ + An identifier to reference this object in the catalog. When a new `CatalogObject` + is inserted, the client should set the id to a temporary identifier starting with + a "`#`" character. Other objects being inserted or updated within the same request + may use this identifier to refer to the new object. + + When the server receives the new object, it will supply a unique identifier that + replaces the temporary identifier for all future references. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` + would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + """ + + version: typing_extensions.NotRequired[int] + """ + The version of the object. When updating an object, the version supplied + must match the version in the database, otherwise the write will be rejected as conflicting. + """ + + is_deleted: typing_extensions.NotRequired[bool] + """ + If `true`, the object has been deleted from the database. Must be `false` for new objects + being inserted. When deleted, the `updated_at` field will equal the deletion time. + """ + + custom_attribute_values: typing_extensions.NotRequired[typing.Dict[str, CatalogCustomAttributeValueParams]] + """ + A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair + is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute + value defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + object defined by the application making the request. + + If the `CatalogCustomAttributeDefinition` object is + defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by + the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of + `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"` + if the application making the request is different from the application defining the custom attribute definition. + Otherwise, the key used in the map is simply `"cocoa_brand"`. + + Application-defined custom attributes are set at a global (location-independent) level. + Custom attribute values are intended to store additional information about a catalog object + or associations with an entity in another system. Do not use custom attributes + to store any sensitive information (personally identifiable information, card details, etc.). + """ + + catalog_v1ids: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Sequence[CatalogV1IdParams], FieldMetadata(alias="catalog_v1_ids")] + ] + """ + The Connect v1 IDs for this object at each location where it is present, where they + differ from the object's Connect V2 ID. The field will only be present for objects that + have been created or modified by legacy APIs. + """ + + present_at_all_locations: typing_extensions.NotRequired[bool] + """ + If `true`, this object is present at all locations (including future locations), except where specified in + the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), + except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. + """ + + present_at_location_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + A list of locations where the object is present, even if `present_at_all_locations` is `false`. + This can include locations that are deactivated. + """ + + absent_at_location_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + A list of locations where the object is not present, even if `present_at_all_locations` is `true`. + This can include locations that are deactivated. + """ + + image_id: typing_extensions.NotRequired[str] + """ + Identifies the `CatalogImage` attached to this `CatalogObject`. + """ diff --git a/src/square/requests/catalog_object_batch.py b/src/square/requests/catalog_object_batch.py new file mode 100644 index 00000000..7ed9ff54 --- /dev/null +++ b/src/square/requests/catalog_object_batch.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from .catalog_object import CatalogObjectParams + + +class CatalogObjectBatchParams(typing_extensions.TypedDict): + """ + A batch of catalog objects. + """ + + objects: typing.Sequence[CatalogObjectParams] + """ + A list of CatalogObjects belonging to this batch. + """ diff --git a/src/square/requests/catalog_object_category.py b/src/square/requests/catalog_object_category.py new file mode 100644 index 00000000..e18c25b1 --- /dev/null +++ b/src/square/requests/catalog_object_category.py @@ -0,0 +1,115 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +from ..types.catalog_object_type import CatalogObjectType +from .catalog_custom_attribute_value import CatalogCustomAttributeValueParams +from .catalog_v1id import CatalogV1IdParams +from ..core.serialization import FieldMetadata +import typing + +if typing.TYPE_CHECKING: + from .catalog_category import CatalogCategoryParams + + +class CatalogObjectCategoryParams(typing_extensions.TypedDict): + """ + A category that can be assigned to an item or a parent category that can be assigned + to another category. For example, a clothing category can be assigned to a t-shirt item or + be made as the parent category to the pants category. + """ + + id: typing_extensions.NotRequired[str] + """ + The ID of the object's category. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + The order of the object within the context of the category. + """ + + category_data: typing_extensions.NotRequired["CatalogCategoryParams"] + """ + Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`. + """ + + type: CatalogObjectType + """ + The type of this object. Each object type has expected + properties expressed in a structured format within its corresponding `*_data` field below. + See [CatalogObjectType](#type-catalogobjecttype) for possible values + """ + + updated_at: typing_extensions.NotRequired[str] + """ + Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` + would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + """ + + version: typing_extensions.NotRequired[int] + """ + The version of the object. When updating an object, the version supplied + must match the version in the database, otherwise the write will be rejected as conflicting. + """ + + is_deleted: typing_extensions.NotRequired[bool] + """ + If `true`, the object has been deleted from the database. Must be `false` for new objects + being inserted. When deleted, the `updated_at` field will equal the deletion time. + """ + + custom_attribute_values: typing_extensions.NotRequired[typing.Dict[str, CatalogCustomAttributeValueParams]] + """ + A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair + is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute + value defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + object defined by the application making the request. + + If the `CatalogCustomAttributeDefinition` object is + defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by + the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of + `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"` + if the application making the request is different from the application defining the custom attribute definition. + Otherwise, the key used in the map is simply `"cocoa_brand"`. + + Application-defined custom attributes are set at a global (location-independent) level. + Custom attribute values are intended to store additional information about a catalog object + or associations with an entity in another system. Do not use custom attributes + to store any sensitive information (personally identifiable information, card details, etc.). + """ + + catalog_v1ids: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Sequence[CatalogV1IdParams], FieldMetadata(alias="catalog_v1_ids")] + ] + """ + The Connect v1 IDs for this object at each location where it is present, where they + differ from the object's Connect V2 ID. The field will only be present for objects that + have been created or modified by legacy APIs. + """ + + present_at_all_locations: typing_extensions.NotRequired[bool] + """ + If `true`, this object is present at all locations (including future locations), except where specified in + the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), + except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. + """ + + present_at_location_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + A list of locations where the object is present, even if `present_at_all_locations` is `false`. + This can include locations that are deactivated. + """ + + absent_at_location_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + A list of locations where the object is not present, even if `present_at_all_locations` is `true`. + This can include locations that are deactivated. + """ + + image_id: typing_extensions.NotRequired[str] + """ + Identifies the `CatalogImage` attached to this `CatalogObject`. + """ diff --git a/src/square/requests/catalog_object_checkout_link.py b/src/square/requests/catalog_object_checkout_link.py new file mode 100644 index 00000000..a9356521 --- /dev/null +++ b/src/square/requests/catalog_object_checkout_link.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectCheckoutLinkParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_component.py b/src/square/requests/catalog_object_component.py new file mode 100644 index 00000000..0eeedb00 --- /dev/null +++ b/src/square/requests/catalog_object_component.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectComponentParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_composition.py b/src/square/requests/catalog_object_composition.py new file mode 100644 index 00000000..6eafb16c --- /dev/null +++ b/src/square/requests/catalog_object_composition.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectCompositionParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_custom_attribute_definition.py b/src/square/requests/catalog_object_custom_attribute_definition.py new file mode 100644 index 00000000..7c31cc5d --- /dev/null +++ b/src/square/requests/catalog_object_custom_attribute_definition.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_custom_attribute_definition import CatalogCustomAttributeDefinitionParams + + +class CatalogObjectCustomAttributeDefinitionParams(CatalogObjectBaseParams): + custom_attribute_definition_data: typing_extensions.NotRequired[CatalogCustomAttributeDefinitionParams] + """ + Structured data for a `CatalogCustomAttributeDefinition`, set for CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`. + """ diff --git a/src/square/requests/catalog_object_dining_option.py b/src/square/requests/catalog_object_dining_option.py new file mode 100644 index 00000000..28d6ba9e --- /dev/null +++ b/src/square/requests/catalog_object_dining_option.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectDiningOptionParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_discount.py b/src/square/requests/catalog_object_discount.py new file mode 100644 index 00000000..2c2807fa --- /dev/null +++ b/src/square/requests/catalog_object_discount.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_discount import CatalogDiscountParams + + +class CatalogObjectDiscountParams(CatalogObjectBaseParams): + discount_data: typing_extensions.NotRequired[CatalogDiscountParams] + """ + Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`. + """ diff --git a/src/square/requests/catalog_object_image.py b/src/square/requests/catalog_object_image.py new file mode 100644 index 00000000..85d43b80 --- /dev/null +++ b/src/square/requests/catalog_object_image.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_image import CatalogImageParams + + +class CatalogObjectImageParams(CatalogObjectBaseParams): + image_data: typing_extensions.NotRequired[CatalogImageParams] + """ + Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. + """ diff --git a/src/square/requests/catalog_object_item.py b/src/square/requests/catalog_object_item.py new file mode 100644 index 00000000..588c6466 --- /dev/null +++ b/src/square/requests/catalog_object_item.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +import typing + +if typing.TYPE_CHECKING: + from .catalog_item import CatalogItemParams + + +class CatalogObjectItemParams(CatalogObjectBaseParams): + item_data: typing_extensions.NotRequired["CatalogItemParams"] + """ + Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`. + """ diff --git a/src/square/requests/catalog_object_item_option.py b/src/square/requests/catalog_object_item_option.py new file mode 100644 index 00000000..210f3a58 --- /dev/null +++ b/src/square/requests/catalog_object_item_option.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +import typing + +if typing.TYPE_CHECKING: + from .catalog_item_option import CatalogItemOptionParams + + +class CatalogObjectItemOptionParams(CatalogObjectBaseParams): + item_option_data: typing_extensions.NotRequired["CatalogItemOptionParams"] + """ + Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. + """ diff --git a/src/square/requests/catalog_object_item_option_value.py b/src/square/requests/catalog_object_item_option_value.py new file mode 100644 index 00000000..c675c724 --- /dev/null +++ b/src/square/requests/catalog_object_item_option_value.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_item_option_value import CatalogItemOptionValueParams + + +class CatalogObjectItemOptionValueParams(CatalogObjectBaseParams): + item_option_value_data: typing_extensions.NotRequired[CatalogItemOptionValueParams] + """ + Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. + """ diff --git a/src/square/requests/catalog_object_item_variation.py b/src/square/requests/catalog_object_item_variation.py new file mode 100644 index 00000000..7e1e7d56 --- /dev/null +++ b/src/square/requests/catalog_object_item_variation.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_item_variation import CatalogItemVariationParams + + +class CatalogObjectItemVariationParams(CatalogObjectBaseParams): + item_variation_data: typing_extensions.NotRequired[CatalogItemVariationParams] + """ + Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`. + """ diff --git a/src/square/requests/catalog_object_measurement_unit.py b/src/square/requests/catalog_object_measurement_unit.py new file mode 100644 index 00000000..e529b7dc --- /dev/null +++ b/src/square/requests/catalog_object_measurement_unit.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_measurement_unit import CatalogMeasurementUnitParams + + +class CatalogObjectMeasurementUnitParams(CatalogObjectBaseParams): + measurement_unit_data: typing_extensions.NotRequired[CatalogMeasurementUnitParams] + """ + Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. + """ diff --git a/src/square/requests/catalog_object_modifier.py b/src/square/requests/catalog_object_modifier.py new file mode 100644 index 00000000..2e384dcf --- /dev/null +++ b/src/square/requests/catalog_object_modifier.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_modifier import CatalogModifierParams + + +class CatalogObjectModifierParams(CatalogObjectBaseParams): + modifier_data: typing_extensions.NotRequired[CatalogModifierParams] + """ + Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`. + """ diff --git a/src/square/requests/catalog_object_modifier_list.py b/src/square/requests/catalog_object_modifier_list.py new file mode 100644 index 00000000..783d5e57 --- /dev/null +++ b/src/square/requests/catalog_object_modifier_list.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +import typing + +if typing.TYPE_CHECKING: + from .catalog_modifier_list import CatalogModifierListParams + + +class CatalogObjectModifierListParams(CatalogObjectBaseParams): + modifier_list_data: typing_extensions.NotRequired["CatalogModifierListParams"] + """ + Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`. + """ diff --git a/src/square/requests/catalog_object_pricing_rule.py b/src/square/requests/catalog_object_pricing_rule.py new file mode 100644 index 00000000..b70343b8 --- /dev/null +++ b/src/square/requests/catalog_object_pricing_rule.py @@ -0,0 +1,13 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_pricing_rule import CatalogPricingRuleParams + + +class CatalogObjectPricingRuleParams(CatalogObjectBaseParams): + pricing_rule_data: typing_extensions.NotRequired[CatalogPricingRuleParams] + """ + Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. + A `CatalogPricingRule` object often works with a `CatalogProductSet` object or a `CatalogTimePeriod` object. + """ diff --git a/src/square/requests/catalog_object_product_set.py b/src/square/requests/catalog_object_product_set.py new file mode 100644 index 00000000..77c45baa --- /dev/null +++ b/src/square/requests/catalog_object_product_set.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_product_set import CatalogProductSetParams + + +class CatalogObjectProductSetParams(CatalogObjectBaseParams): + product_set_data: typing_extensions.NotRequired[CatalogProductSetParams] + """ + Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`. + """ diff --git a/src/square/requests/catalog_object_quick_amounts_settings.py b/src/square/requests/catalog_object_quick_amounts_settings.py new file mode 100644 index 00000000..5a44595d --- /dev/null +++ b/src/square/requests/catalog_object_quick_amounts_settings.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_quick_amounts_settings import CatalogQuickAmountsSettingsParams + + +class CatalogObjectQuickAmountsSettingsParams(CatalogObjectBaseParams): + quick_amounts_settings_data: typing_extensions.NotRequired[CatalogQuickAmountsSettingsParams] + """ + Structured data for a `CatalogQuickAmountsSettings`, set for CatalogObjects of type `QUICK_AMOUNTS_SETTINGS`. + """ diff --git a/src/square/requests/catalog_object_reference.py b/src/square/requests/catalog_object_reference.py new file mode 100644 index 00000000..0a1d72ae --- /dev/null +++ b/src/square/requests/catalog_object_reference.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogObjectReferenceParams(typing_extensions.TypedDict): + """ + A reference to a Catalog object at a specific version. In general this is + used as an entry point into a graph of catalog objects, where the objects exist + at a specific version. + """ + + object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the referenced object. + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the object. + """ diff --git a/src/square/requests/catalog_object_resource.py b/src/square/requests/catalog_object_resource.py new file mode 100644 index 00000000..8ecc7bcc --- /dev/null +++ b/src/square/requests/catalog_object_resource.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectResourceParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_service_charge.py b/src/square/requests/catalog_object_service_charge.py new file mode 100644 index 00000000..4694a110 --- /dev/null +++ b/src/square/requests/catalog_object_service_charge.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectServiceChargeParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_subscription_plan.py b/src/square/requests/catalog_object_subscription_plan.py new file mode 100644 index 00000000..12d8032b --- /dev/null +++ b/src/square/requests/catalog_object_subscription_plan.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +import typing + +if typing.TYPE_CHECKING: + from .catalog_subscription_plan import CatalogSubscriptionPlanParams + + +class CatalogObjectSubscriptionPlanParams(CatalogObjectBaseParams): + subscription_plan_data: typing_extensions.NotRequired["CatalogSubscriptionPlanParams"] + """ + Structured data for a `CatalogSubscriptionPlan`, set for CatalogObjects of type `SUBSCRIPTION_PLAN`. + """ diff --git a/src/square/requests/catalog_object_subscription_plan_variation.py b/src/square/requests/catalog_object_subscription_plan_variation.py new file mode 100644 index 00000000..4b0bf2f5 --- /dev/null +++ b/src/square/requests/catalog_object_subscription_plan_variation.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_subscription_plan_variation import CatalogSubscriptionPlanVariationParams + + +class CatalogObjectSubscriptionPlanVariationParams(CatalogObjectBaseParams): + subscription_plan_variation_data: typing_extensions.NotRequired[CatalogSubscriptionPlanVariationParams] + """ + Structured data for a `CatalogSubscriptionPlanVariation`, set for CatalogObjects of type `SUBSCRIPTION_PLAN_VARIATION`. + """ diff --git a/src/square/requests/catalog_object_subscription_product.py b/src/square/requests/catalog_object_subscription_product.py new file mode 100644 index 00000000..fcf859fa --- /dev/null +++ b/src/square/requests/catalog_object_subscription_product.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectSubscriptionProductParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_tax.py b/src/square/requests/catalog_object_tax.py new file mode 100644 index 00000000..060b9bba --- /dev/null +++ b/src/square/requests/catalog_object_tax.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_tax import CatalogTaxParams + + +class CatalogObjectTaxParams(CatalogObjectBaseParams): + tax_data: typing_extensions.NotRequired[CatalogTaxParams] + """ + Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`. + """ diff --git a/src/square/requests/catalog_object_tax_exemption.py b/src/square/requests/catalog_object_tax_exemption.py new file mode 100644 index 00000000..14307439 --- /dev/null +++ b/src/square/requests/catalog_object_tax_exemption.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams + + +class CatalogObjectTaxExemptionParams(CatalogObjectBaseParams): + pass diff --git a/src/square/requests/catalog_object_time_period.py b/src/square/requests/catalog_object_time_period.py new file mode 100644 index 00000000..77007105 --- /dev/null +++ b/src/square/requests/catalog_object_time_period.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBaseParams +import typing_extensions +from .catalog_time_period import CatalogTimePeriodParams + + +class CatalogObjectTimePeriodParams(CatalogObjectBaseParams): + time_period_data: typing_extensions.NotRequired[CatalogTimePeriodParams] + """ + Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`. + """ diff --git a/src/square/requests/catalog_pricing_rule.py b/src/square/requests/catalog_pricing_rule.py new file mode 100644 index 00000000..2091d508 --- /dev/null +++ b/src/square/requests/catalog_pricing_rule.py @@ -0,0 +1,107 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.exclude_strategy import ExcludeStrategy +from .money import MoneyParams + + +class CatalogPricingRuleParams(typing_extensions.TypedDict): + """ + Defines how discounts are automatically applied to a set of items that match the pricing rule + during the active time period. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + User-defined name for the pricing rule. For example, "Buy one get one + free" or "10% off". + """ + + time_period_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of unique IDs for the catalog time periods when + this pricing rule is in effect. If left unset, the pricing rule is always + in effect. + """ + + discount_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + Unique ID for the `CatalogDiscount` to take off + the price of all matched items. + """ + + match_products_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule + matches within the entire cart, and can match multiple times. This field will always be set. + """ + + apply_products_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + __Deprecated__: Please use the `exclude_products_id` field to apply + an exclude set instead. Exclude sets allow better control over quantity + ranges and offer more flexibility for which matched items receive a discount. + + `CatalogProductSet` to apply the pricing to. + An apply rule matches within the subset of the cart that fits the match rules (the match set). + An apply rule can only match once in the match set. + If not supplied, the pricing will be applied to all products in the match set. + Other products retain their base price, or a price generated by other rules. + """ + + exclude_products_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + `CatalogProductSet` to exclude from the pricing rule. + An exclude rule matches within the subset of the cart that fits the match rules (the match set). + An exclude rule can only match once in the match set. + If not supplied, the pricing will be applied to all products in the match set. + Other products retain their base price, or a price generated by other rules. + """ + + valid_from_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD). + """ + + valid_from_local_time: typing_extensions.NotRequired[typing.Optional[str]] + """ + Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format + (HH:MM:SS). Partial seconds will be truncated. + """ + + valid_until_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD). + """ + + valid_until_local_time: typing_extensions.NotRequired[typing.Optional[str]] + """ + Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format + (HH:MM:SS). Partial seconds will be truncated. + """ + + exclude_strategy: typing_extensions.NotRequired[ExcludeStrategy] + """ + If an `exclude_products_id` was given, controls which subset of matched + products is excluded from any discounts. + + Default value: `LEAST_EXPENSIVE` + See [ExcludeStrategy](#type-excludestrategy) for possible values + """ + + minimum_order_subtotal_money: typing_extensions.NotRequired[MoneyParams] + """ + The minimum order subtotal (before discounts or taxes are applied) + that must be met before this rule may be applied. + """ + + customer_group_ids_any: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule. + Notice that a group ID is generated by the Customers API. + If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer + has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount + applies only to matched products sold to customers belonging to the specified customer groups. + """ diff --git a/src/square/requests/catalog_product_set.py b/src/square/requests/catalog_product_set.py new file mode 100644 index 00000000..93b3966e --- /dev/null +++ b/src/square/requests/catalog_product_set.py @@ -0,0 +1,72 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogProductSetParams(typing_extensions.TypedDict): + """ + Represents a collection of catalog objects for the purpose of applying a + `PricingRule`. Including a catalog object will include all of its subtypes. + For example, including a category in a product set will include all of its + items and associated item variations in the product set. Including an item in + a product set will also include its item variations. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + User-defined name for the product set. For example, "Clearance Items" + or "Winter Sale Items". + """ + + product_ids_any: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Unique IDs for any `CatalogObject` included in this product set. Any + number of these catalog objects can be in an order for a pricing rule to apply. + + This can be used with `product_ids_all` in a parent `CatalogProductSet` to + match groups of products for a bulk discount, such as a discount for an + entree and side combo. + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. + + Max: 500 catalog object IDs. + """ + + product_ids_all: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Unique IDs for any `CatalogObject` included in this product set. + All objects in this set must be included in an order for a pricing rule to apply. + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. + + Max: 500 catalog object IDs. + """ + + quantity_exact: typing_extensions.NotRequired[typing.Optional[int]] + """ + If set, there must be exactly this many items from `products_any` or `products_all` + in the cart for the discount to apply. + + Cannot be combined with either `quantity_min` or `quantity_max`. + """ + + quantity_min: typing_extensions.NotRequired[typing.Optional[int]] + """ + If set, there must be at least this many items from `products_any` or `products_all` + in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if + `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. + """ + + quantity_max: typing_extensions.NotRequired[typing.Optional[int]] + """ + If set, the pricing rule will apply to a maximum of this many items from + `products_any` or `products_all`. + """ + + all_products: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If set to `true`, the product set will include every item in the catalog. + Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. + """ diff --git a/src/square/requests/catalog_query.py b/src/square/requests/catalog_query.py new file mode 100644 index 00000000..dedb774e --- /dev/null +++ b/src/square/requests/catalog_query.py @@ -0,0 +1,106 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .catalog_query_sorted_attribute import CatalogQuerySortedAttributeParams +from .catalog_query_exact import CatalogQueryExactParams +from .catalog_query_set import CatalogQuerySetParams +from .catalog_query_prefix import CatalogQueryPrefixParams +from .catalog_query_range import CatalogQueryRangeParams +from .catalog_query_text import CatalogQueryTextParams +from .catalog_query_items_for_tax import CatalogQueryItemsForTaxParams +from .catalog_query_items_for_modifier_list import CatalogQueryItemsForModifierListParams +from .catalog_query_items_for_item_options import CatalogQueryItemsForItemOptionsParams +from .catalog_query_item_variations_for_item_option_values import CatalogQueryItemVariationsForItemOptionValuesParams + + +class CatalogQueryParams(typing_extensions.TypedDict): + """ + A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. + + Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + Any combination of the following types may be used together: + - [exact_query](entity:CatalogQueryExact) + - [prefix_query](entity:CatalogQueryPrefix) + - [range_query](entity:CatalogQueryRange) + - [sorted_attribute_query](entity:CatalogQuerySortedAttribute) + - [text_query](entity:CatalogQueryText) + + All other query types cannot be combined with any others. + + When a query filter is based on an attribute, the attribute must be searchable. + Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. + + Searchable attribute and objects queryable by searchable attributes: + - `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` + - `description`: `CatalogItem`, `CatalogItemOptionValue` + - `abbreviation`: `CatalogItem` + - `upc`: `CatalogItemVariation` + - `sku`: `CatalogItemVariation` + - `caption`: `CatalogImage` + - `display_name`: `CatalogItemOption` + + For example, to search for [CatalogItem](entity:CatalogItem) objects by searchable attributes, you can use + the `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable query filter. + """ + + sorted_attribute_query: typing_extensions.NotRequired[CatalogQuerySortedAttributeParams] + """ + A query expression to sort returned query result by the given attribute. + """ + + exact_query: typing_extensions.NotRequired[CatalogQueryExactParams] + """ + An exact query expression to return objects with attribute name and value + matching the specified attribute name and value exactly. Value matching is case insensitive. + """ + + set_query: typing_extensions.NotRequired[CatalogQuerySetParams] + """ + A set query expression to return objects with attribute name and value + matching the specified attribute name and any of the specified attribute values exactly. + Value matching is case insensitive. + """ + + prefix_query: typing_extensions.NotRequired[CatalogQueryPrefixParams] + """ + A prefix query expression to return objects with attribute values + that have a prefix matching the specified string value. Value matching is case insensitive. + """ + + range_query: typing_extensions.NotRequired[CatalogQueryRangeParams] + """ + A range query expression to return objects with numeric values + that lie in the specified range. + """ + + text_query: typing_extensions.NotRequired[CatalogQueryTextParams] + """ + A text query expression to return objects whose searchable attributes contain all of the given + keywords, irrespective of their order. For example, if a `CatalogItem` contains custom attribute values of + `{"name": "t-shirt"}` and `{"description": "Small, Purple"}`, the query filter of `{"keywords": ["shirt", "sma", "purp"]}` + returns this item. + """ + + items_for_tax_query: typing_extensions.NotRequired[CatalogQueryItemsForTaxParams] + """ + A query expression to return items that have any of the specified taxes (as identified by the corresponding `CatalogTax` object IDs) enabled. + """ + + items_for_modifier_list_query: typing_extensions.NotRequired[CatalogQueryItemsForModifierListParams] + """ + A query expression to return items that have any of the given modifier list (as identified by the corresponding `CatalogModifierList`s IDs) enabled. + """ + + items_for_item_options_query: typing_extensions.NotRequired[CatalogQueryItemsForItemOptionsParams] + """ + A query expression to return items that contains the specified item options (as identified the corresponding `CatalogItemOption` IDs). + """ + + item_variations_for_item_option_values_query: typing_extensions.NotRequired[ + CatalogQueryItemVariationsForItemOptionValuesParams + ] + """ + A query expression to return item variations (of the [CatalogItemVariation](entity:CatalogItemVariation) type) that + contain all of the specified `CatalogItemOption` IDs. + """ diff --git a/src/square/requests/catalog_query_exact.py b/src/square/requests/catalog_query_exact.py new file mode 100644 index 00000000..f3791cae --- /dev/null +++ b/src/square/requests/catalog_query_exact.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class CatalogQueryExactParams(typing_extensions.TypedDict): + """ + The query filter to return the search result by exact match of the specified attribute name and value. + """ + + attribute_name: str + """ + The name of the attribute to be searched. Matching of the attribute name is exact. + """ + + attribute_value: str + """ + The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial. + For example, if a specified value of "sma", objects with the named attribute value of "Small", "small" are both matched. + """ diff --git a/src/square/requests/catalog_query_item_variations_for_item_option_values.py b/src/square/requests/catalog_query_item_variations_for_item_option_values.py new file mode 100644 index 00000000..37b5ca1c --- /dev/null +++ b/src/square/requests/catalog_query_item_variations_for_item_option_values.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogQueryItemVariationsForItemOptionValuesParams(typing_extensions.TypedDict): + """ + The query filter to return the item variations containing the specified item option value IDs. + """ + + item_option_value_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A set of `CatalogItemOptionValue` IDs to be used to find associated + `CatalogItemVariation`s. All ItemVariations that contain all of the given + Item Option Values (in any order) will be returned. + """ diff --git a/src/square/requests/catalog_query_items_for_item_options.py b/src/square/requests/catalog_query_items_for_item_options.py new file mode 100644 index 00000000..9a89c081 --- /dev/null +++ b/src/square/requests/catalog_query_items_for_item_options.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogQueryItemsForItemOptionsParams(typing_extensions.TypedDict): + """ + The query filter to return the items containing the specified item option IDs. + """ + + item_option_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A set of `CatalogItemOption` IDs to be used to find associated + `CatalogItem`s. All Items that contain all of the given Item Options (in any order) + will be returned. + """ diff --git a/src/square/requests/catalog_query_items_for_modifier_list.py b/src/square/requests/catalog_query_items_for_modifier_list.py new file mode 100644 index 00000000..f4660dda --- /dev/null +++ b/src/square/requests/catalog_query_items_for_modifier_list.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing + + +class CatalogQueryItemsForModifierListParams(typing_extensions.TypedDict): + """ + The query filter to return the items containing the specified modifier list IDs. + """ + + modifier_list_ids: typing.Sequence[str] + """ + A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. + """ diff --git a/src/square/requests/catalog_query_items_for_tax.py b/src/square/requests/catalog_query_items_for_tax.py new file mode 100644 index 00000000..3cacda3d --- /dev/null +++ b/src/square/requests/catalog_query_items_for_tax.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing + + +class CatalogQueryItemsForTaxParams(typing_extensions.TypedDict): + """ + The query filter to return the items containing the specified tax IDs. + """ + + tax_ids: typing.Sequence[str] + """ + A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. + """ diff --git a/src/square/requests/catalog_query_prefix.py b/src/square/requests/catalog_query_prefix.py new file mode 100644 index 00000000..05626ab3 --- /dev/null +++ b/src/square/requests/catalog_query_prefix.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class CatalogQueryPrefixParams(typing_extensions.TypedDict): + """ + The query filter to return the search result whose named attribute values are prefixed by the specified attribute value. + """ + + attribute_name: str + """ + The name of the attribute to be searched. + """ + + attribute_prefix: str + """ + The desired prefix of the search attribute value. + """ diff --git a/src/square/requests/catalog_query_range.py b/src/square/requests/catalog_query_range.py new file mode 100644 index 00000000..51c68820 --- /dev/null +++ b/src/square/requests/catalog_query_range.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogQueryRangeParams(typing_extensions.TypedDict): + """ + The query filter to return the search result whose named attribute values fall between the specified range. + """ + + attribute_name: str + """ + The name of the attribute to be searched. + """ + + attribute_min_value: typing_extensions.NotRequired[typing.Optional[int]] + """ + The desired minimum value for the search attribute (inclusive). + """ + + attribute_max_value: typing_extensions.NotRequired[typing.Optional[int]] + """ + The desired maximum value for the search attribute (inclusive). + """ diff --git a/src/square/requests/catalog_query_set.py b/src/square/requests/catalog_query_set.py new file mode 100644 index 00000000..62d39852 --- /dev/null +++ b/src/square/requests/catalog_query_set.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing + + +class CatalogQuerySetParams(typing_extensions.TypedDict): + """ + The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of + the `attribute_values`. + """ + + attribute_name: str + """ + The name of the attribute to be searched. Matching of the attribute name is exact. + """ + + attribute_values: typing.Sequence[str] + """ + The desired values of the search attribute. Matching of the attribute values is exact and case insensitive. + A maximum of 250 values may be searched in a request. + """ diff --git a/src/square/requests/catalog_query_sorted_attribute.py b/src/square/requests/catalog_query_sorted_attribute.py new file mode 100644 index 00000000..ba131111 --- /dev/null +++ b/src/square/requests/catalog_query_sorted_attribute.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.sort_order import SortOrder + + +class CatalogQuerySortedAttributeParams(typing_extensions.TypedDict): + """ + The query expression to specify the key to sort search results. + """ + + attribute_name: str + """ + The attribute whose value is used as the sort key. + """ + + initial_attribute_value: typing_extensions.NotRequired[typing.Optional[str]] + """ + The first attribute value to be returned by the query. Ascending sorts will return only + objects with this value or greater, while descending sorts will return only objects with this value + or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). + """ + + sort_order: typing_extensions.NotRequired[SortOrder] + """ + The desired sort order, `"ASC"` (ascending) or `"DESC"` (descending). + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/catalog_query_text.py b/src/square/requests/catalog_query_text.py new file mode 100644 index 00000000..e1ab5e71 --- /dev/null +++ b/src/square/requests/catalog_query_text.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing + + +class CatalogQueryTextParams(typing_extensions.TypedDict): + """ + The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case. + """ + + keywords: typing.Sequence[str] + """ + A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 alphanumeric characters are ignored. + """ diff --git a/src/square/requests/catalog_quick_amount.py b/src/square/requests/catalog_quick_amount.py new file mode 100644 index 00000000..3a71a2d3 --- /dev/null +++ b/src/square/requests/catalog_quick_amount.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.catalog_quick_amount_type import CatalogQuickAmountType +from .money import MoneyParams +import typing_extensions +import typing + + +class CatalogQuickAmountParams(typing_extensions.TypedDict): + """ + Represents a Quick Amount in the Catalog. + """ + + type: CatalogQuickAmountType + """ + Represents the type of the Quick Amount. + See [CatalogQuickAmountType](#type-catalogquickamounttype) for possible values + """ + + amount: MoneyParams + """ + Represents the actual amount of the Quick Amount with Money type. + """ + + score: typing_extensions.NotRequired[typing.Optional[int]] + """ + Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100]. + MANUAL type amount will always have score = 100. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + The order in which this Quick Amount should be displayed. + """ diff --git a/src/square/requests/catalog_quick_amounts_settings.py b/src/square/requests/catalog_quick_amounts_settings.py new file mode 100644 index 00000000..c60f901a --- /dev/null +++ b/src/square/requests/catalog_quick_amounts_settings.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.catalog_quick_amounts_settings_option import CatalogQuickAmountsSettingsOption +import typing_extensions +import typing +from .catalog_quick_amount import CatalogQuickAmountParams + + +class CatalogQuickAmountsSettingsParams(typing_extensions.TypedDict): + """ + A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts. + """ + + option: CatalogQuickAmountsSettingsOption + """ + Represents the option seller currently uses on Quick Amounts. + See [CatalogQuickAmountsSettingsOption](#type-catalogquickamountssettingsoption) for possible values + """ + + eligible_for_auto_amounts: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Represents location's eligibility for auto amounts + The boolean should be consistent with whether there are AUTO amounts in the `amounts`. + """ + + amounts: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CatalogQuickAmountParams]]] + """ + Represents a set of Quick Amounts at this location. + """ diff --git a/src/square/requests/catalog_stock_conversion.py b/src/square/requests/catalog_stock_conversion.py new file mode 100644 index 00000000..6ff4a82c --- /dev/null +++ b/src/square/requests/catalog_stock_conversion.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class CatalogStockConversionParams(typing_extensions.TypedDict): + """ + Represents the rule of conversion between a stockable [CatalogItemVariation](entity:CatalogItemVariation) + and a non-stockable sell-by or receive-by `CatalogItemVariation` that + share the same underlying stock. + """ + + stockable_item_variation_id: str + """ + References to the stockable [CatalogItemVariation](entity:CatalogItemVariation) + for this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation` + defined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`. + This immutable field must reference a stockable `CatalogItemVariation` + that shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.` + """ + + stockable_quantity: str + """ + The quantity of the stockable item variation (as identified by `stockable_item_variation_id`) + equivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`) + as defined by this stock conversion. It accepts a decimal number in a string format that can take + up to 10 digits before the decimal point and up to 5 digits after the decimal point. + """ + + nonstockable_quantity: str + """ + The converted equivalent quantity of the non-stockable [CatalogItemVariation](entity:CatalogItemVariation) + in its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together + define the conversion ratio between stockable item variation and the non-stockable item variation. + It accepts a decimal number in a string format that can take up to 10 digits before the decimal point + and up to 5 digits after the decimal point. + """ diff --git a/src/square/requests/catalog_subscription_plan.py b/src/square/requests/catalog_subscription_plan.py new file mode 100644 index 00000000..14977a0b --- /dev/null +++ b/src/square/requests/catalog_subscription_plan.py @@ -0,0 +1,49 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +from .subscription_phase import SubscriptionPhaseParams +import typing + +if typing.TYPE_CHECKING: + from .catalog_object import CatalogObjectParams + + +class CatalogSubscriptionPlanParams(typing_extensions.TypedDict): + """ + Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations. + For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + """ + + name: str + """ + The name of the plan. + """ + + phases: typing_extensions.NotRequired[typing.Optional[typing.Sequence[SubscriptionPhaseParams]]] + """ + A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan. + This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error + """ + + subscription_plan_variations: typing_extensions.NotRequired[typing.Optional[typing.Sequence["CatalogObjectParams"]]] + """ + The list of subscription plan variations available for this product + """ + + eligible_item_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations. + """ + + eligible_category_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations. + """ + + all_items: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan. + """ diff --git a/src/square/requests/catalog_subscription_plan_variation.py b/src/square/requests/catalog_subscription_plan_variation.py new file mode 100644 index 00000000..d4539bb3 --- /dev/null +++ b/src/square/requests/catalog_subscription_plan_variation.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from .subscription_phase import SubscriptionPhaseParams +import typing_extensions + + +class CatalogSubscriptionPlanVariationParams(typing_extensions.TypedDict): + """ + Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold. + For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + """ + + name: str + """ + The name of the plan variation. + """ + + phases: typing.Sequence[SubscriptionPhaseParams] + """ + A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation. + """ + + subscription_plan_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The id of the subscription plan, if there is one. + """ + + monthly_billing_anchor_date: typing_extensions.NotRequired[typing.Optional[int]] + """ + The day of the month the billing period starts. + """ + + can_prorate: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether bills for this plan variation can be split for proration. + """ + + successor_plan_variation_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all + locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in + its stead. + """ diff --git a/src/square/requests/catalog_tax.py b/src/square/requests/catalog_tax.py new file mode 100644 index 00000000..ec388d82 --- /dev/null +++ b/src/square/requests/catalog_tax.py @@ -0,0 +1,52 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.tax_calculation_phase import TaxCalculationPhase +from ..types.tax_inclusion_type import TaxInclusionType + + +class CatalogTaxParams(typing_extensions.TypedDict): + """ + A tax applicable to an item. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + calculation_phase: typing_extensions.NotRequired[TaxCalculationPhase] + """ + Whether the tax is calculated based on a payment's subtotal or total. + See [TaxCalculationPhase](#type-taxcalculationphase) for possible values + """ + + inclusion_type: typing_extensions.NotRequired[TaxInclusionType] + """ + Whether the tax is `ADDITIVE` or `INCLUSIVE`. + See [TaxInclusionType](#type-taxinclusiontype) for possible values + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. + A value of `7.5` corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant. + """ + + applies_to_custom_amounts: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `true`, the fee applies to custom amounts entered into the Square Point of Sale + app that are not associated with a particular `CatalogItem`. + """ + + enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`). + """ + + applies_to_product_set_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set. + """ diff --git a/src/square/requests/catalog_time_period.py b/src/square/requests/catalog_time_period.py new file mode 100644 index 00000000..99b2f94b --- /dev/null +++ b/src/square/requests/catalog_time_period.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CatalogTimePeriodParams(typing_extensions.TypedDict): + """ + Represents a time period - either a single period or a repeating period. + """ + + event: typing_extensions.NotRequired[typing.Optional[str]] + """ + An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which + specifies the name, timing, duration and recurrence of this time period. + + Example: + + ``` + DTSTART:20190707T180000 + DURATION:P2H + RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR + ``` + + Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported. + `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT` + and `END:VEVENT` is not required in the request. The response will always + include them. + """ diff --git a/src/square/requests/catalog_v1id.py b/src/square/requests/catalog_v1id.py new file mode 100644 index 00000000..419939fa --- /dev/null +++ b/src/square/requests/catalog_v1id.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..core.serialization import FieldMetadata + + +class CatalogV1IdParams(typing_extensions.TypedDict): + """ + A Square API V1 identifier of an item, including the object ID and its associated location ID. + """ + + catalog_v1id: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="catalog_v1_id")] + ] + """ + The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the `Location` this Connect V1 ID is associated with. + """ diff --git a/src/square/requests/category_path_to_root_node.py b/src/square/requests/category_path_to_root_node.py new file mode 100644 index 00000000..2fe269ad --- /dev/null +++ b/src/square/requests/category_path_to_root_node.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CategoryPathToRootNodeParams(typing_extensions.TypedDict): + """ + A node in the path from a retrieved category to its root node. + """ + + category_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The category's ID. + """ + + category_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The category's name. + """ diff --git a/src/square/requests/change_billing_anchor_date_response.py b/src/square/requests/change_billing_anchor_date_response.py new file mode 100644 index 00000000..7f075adb --- /dev/null +++ b/src/square/requests/change_billing_anchor_date_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams +from .subscription_action import SubscriptionActionParams + + +class ChangeBillingAnchorDateResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a request to the + [ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The specified subscription for updating billing anchor date. + """ + + actions: typing_extensions.NotRequired[typing.Sequence[SubscriptionActionParams]] + """ + A list of a single billing anchor date change for the subscription. + """ diff --git a/src/square/requests/charge_request_additional_recipient.py b/src/square/requests/charge_request_additional_recipient.py new file mode 100644 index 00000000..e440c004 --- /dev/null +++ b/src/square/requests/charge_request_additional_recipient.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class ChargeRequestAdditionalRecipientParams(typing_extensions.TypedDict): + """ + Represents an additional recipient (other than the merchant) entitled to a portion of the tender. + Support is currently limited to USD, CAD and GBP currencies + """ + + location_id: str + """ + The location ID for a recipient (other than the merchant) receiving a portion of the tender. + """ + + description: str + """ + The description of the additional recipient. + """ + + amount_money: MoneyParams + """ + The amount of money distributed to the recipient. + """ diff --git a/src/square/requests/checkout.py b/src/square/requests/checkout.py new file mode 100644 index 00000000..9aaa6f4f --- /dev/null +++ b/src/square/requests/checkout.py @@ -0,0 +1,94 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from .order import OrderParams +from .additional_recipient import AdditionalRecipientParams + + +class CheckoutParams(typing_extensions.TypedDict): + """ + Square Checkout lets merchants accept online payments for supported + payment types using a checkout workflow hosted on squareup.com. + """ + + id: typing_extensions.NotRequired[str] + """ + ID generated by Square Checkout when a new checkout is requested. + """ + + checkout_page_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The URL that the buyer's browser should be redirected to after the + checkout is completed. + """ + + ask_for_shipping_address: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `true`, Square Checkout will collect shipping information on your + behalf and store that information with the transaction information in your + Square Dashboard. + + Default: `false`. + """ + + merchant_support_email: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address to display on the Square Checkout confirmation page + and confirmation email that the buyer can use to contact the merchant. + + If this value is not set, the confirmation page and email will display the + primary email address associated with the merchant's Square account. + + Default: none; only exists if explicitly set. + """ + + pre_populate_buyer_email: typing_extensions.NotRequired[typing.Optional[str]] + """ + If provided, the buyer's email is pre-populated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + """ + + pre_populate_shipping_address: typing_extensions.NotRequired[AddressParams] + """ + If provided, the buyer's shipping info is pre-populated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + """ + + redirect_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The URL to redirect to after checkout is completed with `checkoutId`, + Square's `orderId`, `transactionId`, and `referenceId` appended as URL + parameters. For example, if the provided redirect_url is + `http://www.example.com/order-complete`, a successful transaction redirects + the customer to: + + 
http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
+ + If you do not provide a redirect URL, Square Checkout will display an order + confirmation page on your behalf; however Square strongly recommends that + you provide a redirect URL so you can verify the transaction results and + finalize the order through your existing/normal confirmation workflow. + """ + + order: typing_extensions.NotRequired[OrderParams] + """ + Order to be checked out. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the checkout was created, in RFC 3339 format. + """ + + additional_recipients: typing_extensions.NotRequired[typing.Optional[typing.Sequence[AdditionalRecipientParams]]] + """ + Additional recipients (other than the merchant) receiving a portion of this checkout. + For example, fees assessed on the purchase by a third party integration. + """ diff --git a/src/square/requests/checkout_location_settings.py b/src/square/requests/checkout_location_settings.py new file mode 100644 index 00000000..698da4e5 --- /dev/null +++ b/src/square/requests/checkout_location_settings.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .checkout_location_settings_policy import CheckoutLocationSettingsPolicyParams +from .checkout_location_settings_branding import CheckoutLocationSettingsBrandingParams +from .checkout_location_settings_tipping import CheckoutLocationSettingsTippingParams +from .checkout_location_settings_coupons import CheckoutLocationSettingsCouponsParams + + +class CheckoutLocationSettingsParams(typing_extensions.TypedDict): + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the location that these settings apply to. + """ + + customer_notes_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether customers are allowed to leave notes at checkout. + """ + + policies: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CheckoutLocationSettingsPolicyParams]]] + """ + Policy information is displayed at the bottom of the checkout pages. + You can set a maximum of two policies. + """ + + branding: typing_extensions.NotRequired[CheckoutLocationSettingsBrandingParams] + """ + The branding settings for this location. + """ + + tipping: typing_extensions.NotRequired[CheckoutLocationSettingsTippingParams] + """ + The tip settings for this location. + """ + + coupons: typing_extensions.NotRequired[CheckoutLocationSettingsCouponsParams] + """ + The coupon settings for this location. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the settings were last updated, in RFC 3339 format. + Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: + UTC: 2020-01-26T02:25:34Z + Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 + """ diff --git a/src/square/requests/checkout_location_settings_branding.py b/src/square/requests/checkout_location_settings_branding.py new file mode 100644 index 00000000..4ede71ae --- /dev/null +++ b/src/square/requests/checkout_location_settings_branding.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.checkout_location_settings_branding_header_type import CheckoutLocationSettingsBrandingHeaderType +import typing +from ..types.checkout_location_settings_branding_button_shape import CheckoutLocationSettingsBrandingButtonShape + + +class CheckoutLocationSettingsBrandingParams(typing_extensions.TypedDict): + header_type: typing_extensions.NotRequired[CheckoutLocationSettingsBrandingHeaderType] + """ + Show the location logo on the checkout page. + See [HeaderType](#type-headertype) for possible values + """ + + button_color: typing_extensions.NotRequired[typing.Optional[str]] + """ + The HTML-supported hex color for the button on the checkout page (for example, "#FFFFFF"). + """ + + button_shape: typing_extensions.NotRequired[CheckoutLocationSettingsBrandingButtonShape] + """ + The shape of the button on the checkout page. + See [ButtonShape](#type-buttonshape) for possible values + """ diff --git a/src/square/requests/checkout_location_settings_coupons.py b/src/square/requests/checkout_location_settings_coupons.py new file mode 100644 index 00000000..4198cb5b --- /dev/null +++ b/src/square/requests/checkout_location_settings_coupons.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CheckoutLocationSettingsCouponsParams(typing_extensions.TypedDict): + enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether coupons are enabled for this location. + """ diff --git a/src/square/requests/checkout_location_settings_policy.py b/src/square/requests/checkout_location_settings_policy.py new file mode 100644 index 00000000..e1463504 --- /dev/null +++ b/src/square/requests/checkout_location_settings_policy.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CheckoutLocationSettingsPolicyParams(typing_extensions.TypedDict): + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID to identify the policy when making changes. You must set the UID for policy updates, but it’s optional when setting new policies. + """ + + title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The title of the policy. This is required when setting the description, though you can update it in a different request. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The description of the policy. + """ diff --git a/src/square/requests/checkout_location_settings_tipping.py b/src/square/requests/checkout_location_settings_tipping.py new file mode 100644 index 00000000..186d2ba0 --- /dev/null +++ b/src/square/requests/checkout_location_settings_tipping.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class CheckoutLocationSettingsTippingParams(typing_extensions.TypedDict): + percentages: typing_extensions.NotRequired[typing.Optional[typing.Sequence[int]]] + """ + Set three custom percentage amounts that buyers can select at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more. + """ + + smart_tipping_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping works as follows: + If a transaction is less than $10, the available tipping options include No Tip, $1, $2, or $3. + If a transaction is $10 or more, the available tipping options include No Tip, 15%, 20%, or 25%. + You can set custom percentage amounts with the `percentages` field. + """ + + default_percent: typing_extensions.NotRequired[typing.Optional[int]] + """ + Set the pre-selected percentage amounts that appear at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more. + """ + + smart_tips: typing_extensions.NotRequired[typing.Optional[typing.Sequence[MoneyParams]]] + """ + Show the Smart Tip Amounts for this location. + """ + + default_smart_tip: typing_extensions.NotRequired[MoneyParams] + """ + Set the pre-selected whole amount that appears at checkout when Smart Tip is enabled and the transaction amount is less than $10. + """ diff --git a/src/square/requests/checkout_merchant_settings.py b/src/square/requests/checkout_merchant_settings.py new file mode 100644 index 00000000..0b399083 --- /dev/null +++ b/src/square/requests/checkout_merchant_settings.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .checkout_merchant_settings_payment_methods import CheckoutMerchantSettingsPaymentMethodsParams + + +class CheckoutMerchantSettingsParams(typing_extensions.TypedDict): + payment_methods: typing_extensions.NotRequired[CheckoutMerchantSettingsPaymentMethodsParams] + """ + The set of payment methods accepted for the merchant's account. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the settings were last updated, in RFC 3339 format. + Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: + UTC: 2020-01-26T02:25:34Z + Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 + """ diff --git a/src/square/requests/checkout_merchant_settings_payment_methods.py b/src/square/requests/checkout_merchant_settings_payment_methods.py new file mode 100644 index 00000000..7fb4ddb0 --- /dev/null +++ b/src/square/requests/checkout_merchant_settings_payment_methods.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .checkout_merchant_settings_payment_methods_payment_method import ( + CheckoutMerchantSettingsPaymentMethodsPaymentMethodParams, +) +from .checkout_merchant_settings_payment_methods_afterpay_clearpay import ( + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayParams, +) + + +class CheckoutMerchantSettingsPaymentMethodsParams(typing_extensions.TypedDict): + apple_pay: typing_extensions.NotRequired[CheckoutMerchantSettingsPaymentMethodsPaymentMethodParams] + google_pay: typing_extensions.NotRequired[CheckoutMerchantSettingsPaymentMethodsPaymentMethodParams] + cash_app: typing_extensions.NotRequired[CheckoutMerchantSettingsPaymentMethodsPaymentMethodParams] + afterpay_clearpay: typing_extensions.NotRequired[CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayParams] diff --git a/src/square/requests/checkout_merchant_settings_payment_methods_afterpay_clearpay.py b/src/square/requests/checkout_merchant_settings_payment_methods_afterpay_clearpay.py new file mode 100644 index 00000000..bffc8868 --- /dev/null +++ b/src/square/requests/checkout_merchant_settings_payment_methods_afterpay_clearpay.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range import ( + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRangeParams, +) + + +class CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayParams(typing_extensions.TypedDict): + """ + The settings allowed for AfterpayClearpay. + """ + + order_eligibility_range: typing_extensions.NotRequired[ + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRangeParams + ] + """ + Afterpay is shown as an option for order totals falling within the configured range. + """ + + item_eligibility_range: typing_extensions.NotRequired[ + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRangeParams + ] + """ + Afterpay is shown as an option for item totals falling within the configured range. + """ + + enabled: typing_extensions.NotRequired[bool] + """ + Indicates whether the payment method is enabled for the account. + """ diff --git a/src/square/requests/checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.py b/src/square/requests/checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.py new file mode 100644 index 00000000..9c9a11d0 --- /dev/null +++ b/src/square/requests/checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.py @@ -0,0 +1,13 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRangeParams(typing_extensions.TypedDict): + """ + A range of purchase price that qualifies. + """ + + min: MoneyParams + max: MoneyParams diff --git a/src/square/requests/checkout_merchant_settings_payment_methods_payment_method.py b/src/square/requests/checkout_merchant_settings_payment_methods_payment_method.py new file mode 100644 index 00000000..d36f29ca --- /dev/null +++ b/src/square/requests/checkout_merchant_settings_payment_methods_payment_method.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CheckoutMerchantSettingsPaymentMethodsPaymentMethodParams(typing_extensions.TypedDict): + """ + The settings allowed for a payment method. + """ + + enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the payment method is enabled for the account. + """ diff --git a/src/square/requests/checkout_options.py b/src/square/requests/checkout_options.py new file mode 100644 index 00000000..76ca2325 --- /dev/null +++ b/src/square/requests/checkout_options.py @@ -0,0 +1,75 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_field import CustomFieldParams +from .accepted_payment_methods import AcceptedPaymentMethodsParams +from .money import MoneyParams +from .shipping_fee import ShippingFeeParams + + +class CheckoutOptionsParams(typing_extensions.TypedDict): + allow_tipping: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the payment allows tipping. + """ + + custom_fields: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CustomFieldParams]]] + """ + The custom fields requesting information from the buyer. + """ + + subscription_plan_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the subscription plan for the buyer to pay and subscribe. + For more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout). + """ + + redirect_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The confirmation page URL to redirect the buyer to after Square processes the payment. + """ + + merchant_support_email: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address that buyers can use to contact the seller. + """ + + ask_for_shipping_address: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether to include the address fields in the payment form. + """ + + accepted_payment_methods: typing_extensions.NotRequired[AcceptedPaymentMethodsParams] + """ + The methods allowed for buyers during checkout. + """ + + app_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. For more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/collect-fees/additional-considerations#permissions). + """ + + shipping_fee: typing_extensions.NotRequired[ShippingFeeParams] + """ + The fee associated with shipping to be applied to the `Order` as a service charge. + """ + + enable_coupon: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form. + """ + + enable_loyalty: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both. + """ diff --git a/src/square/requests/clearpay_details.py b/src/square/requests/clearpay_details.py new file mode 100644 index 00000000..0395fca0 --- /dev/null +++ b/src/square/requests/clearpay_details.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class ClearpayDetailsParams(typing_extensions.TypedDict): + """ + Additional details about Clearpay payments. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + Email address on the buyer's Clearpay account. + """ diff --git a/src/square/requests/clone_order_response.py b/src/square/requests/clone_order_response.py new file mode 100644 index 00000000..a28752ba --- /dev/null +++ b/src/square/requests/clone_order_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .order import OrderParams +import typing +from .error import ErrorParams + + +class CloneOrderResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint. + """ + + order: typing_extensions.NotRequired[OrderParams] + """ + The cloned order. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/collected_data.py b/src/square/requests/collected_data.py new file mode 100644 index 00000000..1d5a9c34 --- /dev/null +++ b/src/square/requests/collected_data.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class CollectedDataParams(typing_extensions.TypedDict): + input_text: typing_extensions.NotRequired[str] + """ + The buyer's input text. + """ diff --git a/src/square/requests/complete_payment_response.py b/src/square/requests/complete_payment_response.py new file mode 100644 index 00000000..be6e3440 --- /dev/null +++ b/src/square/requests/complete_payment_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment import PaymentParams + + +class CompletePaymentResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by[CompletePayment](api-endpoint:Payments-CompletePayment). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + payment: typing_extensions.NotRequired[PaymentParams] + """ + The successfully completed payment. + """ diff --git a/src/square/requests/component.py b/src/square/requests/component.py new file mode 100644 index 00000000..f6614d4b --- /dev/null +++ b/src/square/requests/component.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.component_component_type import ComponentComponentType +import typing_extensions +from .device_component_details_application_details import DeviceComponentDetailsApplicationDetailsParams +from .device_component_details_card_reader_details import DeviceComponentDetailsCardReaderDetailsParams +from .device_component_details_battery_details import DeviceComponentDetailsBatteryDetailsParams +from .device_component_details_wi_fi_details import DeviceComponentDetailsWiFiDetailsParams +from .device_component_details_ethernet_details import DeviceComponentDetailsEthernetDetailsParams + + +class ComponentParams(typing_extensions.TypedDict): + """ + The wrapper object for the component entries of a given component type. + """ + + type: ComponentComponentType + """ + The type of this component. Each component type has expected properties expressed + in a structured format within its corresponding `*_details` field. + See [ComponentType](#type-componenttype) for possible values + """ + + application_details: typing_extensions.NotRequired[DeviceComponentDetailsApplicationDetailsParams] + """ + Structured data for an `Application`, set for Components of type `APPLICATION`. + """ + + card_reader_details: typing_extensions.NotRequired[DeviceComponentDetailsCardReaderDetailsParams] + """ + Structured data for a `CardReader`, set for Components of type `CARD_READER`. + """ + + battery_details: typing_extensions.NotRequired[DeviceComponentDetailsBatteryDetailsParams] + """ + Structured data for a `Battery`, set for Components of type `BATTERY`. + """ + + wifi_details: typing_extensions.NotRequired[DeviceComponentDetailsWiFiDetailsParams] + """ + Structured data for a `WiFi` interface, set for Components of type `WIFI`. + """ + + ethernet_details: typing_extensions.NotRequired[DeviceComponentDetailsEthernetDetailsParams] + """ + Structured data for an `Ethernet` interface, set for Components of type `ETHERNET`. + """ diff --git a/src/square/requests/confirmation_decision.py b/src/square/requests/confirmation_decision.py new file mode 100644 index 00000000..227faed6 --- /dev/null +++ b/src/square/requests/confirmation_decision.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class ConfirmationDecisionParams(typing_extensions.TypedDict): + has_agreed: typing_extensions.NotRequired[bool] + """ + The buyer's decision to the displayed terms. + """ diff --git a/src/square/requests/confirmation_options.py b/src/square/requests/confirmation_options.py new file mode 100644 index 00000000..313c64b1 --- /dev/null +++ b/src/square/requests/confirmation_options.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .confirmation_decision import ConfirmationDecisionParams + + +class ConfirmationOptionsParams(typing_extensions.TypedDict): + title: str + """ + The title text to display in the confirmation screen flow on the Terminal. + """ + + body: str + """ + The agreement details to display in the confirmation flow on the Terminal. + """ + + agree_button_text: str + """ + The button text to display indicating the customer agrees to the displayed terms. + """ + + disagree_button_text: typing_extensions.NotRequired[typing.Optional[str]] + """ + The button text to display indicating the customer does not agree to the displayed terms. + """ + + decision: typing_extensions.NotRequired[ConfirmationDecisionParams] + """ + The result of the buyer’s actions when presented with the confirmation screen. + """ diff --git a/src/square/requests/coordinates.py b/src/square/requests/coordinates.py new file mode 100644 index 00000000..a38514ed --- /dev/null +++ b/src/square/requests/coordinates.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CoordinatesParams(typing_extensions.TypedDict): + """ + Latitude and longitude coordinates. + """ + + latitude: typing_extensions.NotRequired[typing.Optional[float]] + """ + The latitude of the coordinate expressed in degrees. + """ + + longitude: typing_extensions.NotRequired[typing.Optional[float]] + """ + The longitude of the coordinate expressed in degrees. + """ diff --git a/src/square/requests/create_booking_custom_attribute_definition_response.py b/src/square/requests/create_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..393aed29 --- /dev/null +++ b/src/square/requests/create_booking_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class CreateBookingCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The newly created custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_booking_response.py b/src/square/requests/create_booking_response.py new file mode 100644 index 00000000..2701ebb6 --- /dev/null +++ b/src/square/requests/create_booking_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .booking import BookingParams +import typing +from .error import ErrorParams + + +class CreateBookingResponseParams(typing_extensions.TypedDict): + booking: typing_extensions.NotRequired[BookingParams] + """ + The booking that was created. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/create_break_type_response.py b/src/square/requests/create_break_type_response.py new file mode 100644 index 00000000..980ba009 --- /dev/null +++ b/src/square/requests/create_break_type_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .break_type import BreakTypeParams +import typing +from .error import ErrorParams + + +class CreateBreakTypeResponseParams(typing_extensions.TypedDict): + """ + The response to the request to create a `BreakType`. The response contains + the created `BreakType` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_type: typing_extensions.NotRequired[BreakTypeParams] + """ + The `BreakType` that was created by the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_card_response.py b/src/square/requests/create_card_response.py new file mode 100644 index 00000000..a6c38a95 --- /dev/null +++ b/src/square/requests/create_card_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .card import CardParams + + +class CreateCardResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [CreateCard](api-endpoint:Cards-CreateCard) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors resulting from the request. + """ + + card: typing_extensions.NotRequired[CardParams] + """ + The card created by the request. + """ diff --git a/src/square/requests/create_catalog_image_request.py b/src/square/requests/create_catalog_image_request.py new file mode 100644 index 00000000..ed2c7751 --- /dev/null +++ b/src/square/requests/create_catalog_image_request.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .catalog_object import CatalogObjectParams + + +class CreateCatalogImageRequestParams(typing_extensions.TypedDict): + idempotency_key: str + """ + A unique string that identifies this CreateCatalogImage request. + Keys can be any valid string but must be unique for every CreateCatalogImage request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + """ + + object_id: typing_extensions.NotRequired[str] + """ + Unique ID of the `CatalogObject` to attach this `CatalogImage` object to. Leave this + field empty to create unattached images, for example if you are building an integration + where an image can be attached to catalog items at a later time. + """ + + image: CatalogObjectParams + """ + The new `CatalogObject` of the `IMAGE` type, namely, a `CatalogImage` object, to encapsulate the specified image file. + """ + + is_primary: typing_extensions.NotRequired[bool] + """ + If this is set to `true`, the image created will be the primary, or first image of the object referenced by `object_id`. + If the `CatalogObject` already has a primary `CatalogImage`, setting this field to `true` will replace the primary image. + If this is set to `false` and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of `image_ids` on the object. + + With Square API version 2021-12-15 or later, the default value is `false`. Otherwise, the effective default value is `true`. + """ diff --git a/src/square/requests/create_catalog_image_response.py b/src/square/requests/create_catalog_image_response.py new file mode 100644 index 00000000..f9bb3e2d --- /dev/null +++ b/src/square/requests/create_catalog_image_response.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class CreateCatalogImageResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + image: typing_extensions.NotRequired[CatalogObjectParams] + """ + The newly created `CatalogImage` including a Square-generated + URL for the encapsulated image file. + """ diff --git a/src/square/requests/create_checkout_response.py b/src/square/requests/create_checkout_response.py new file mode 100644 index 00000000..a0c20d6d --- /dev/null +++ b/src/square/requests/create_checkout_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .checkout import CheckoutParams +import typing +from .error import ErrorParams + + +class CreateCheckoutResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `CreateCheckout` endpoint. + """ + + checkout: typing_extensions.NotRequired[CheckoutParams] + """ + The newly created `checkout` object associated with the provided idempotency key. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_customer_card_response.py b/src/square/requests/create_customer_card_response.py new file mode 100644 index 00000000..3de25ecc --- /dev/null +++ b/src/square/requests/create_customer_card_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .card import CardParams + + +class CreateCustomerCardResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `CreateCustomerCard` endpoint. + + Either `errors` or `card` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + card: typing_extensions.NotRequired[CardParams] + """ + The created card on file. + """ diff --git a/src/square/requests/create_customer_custom_attribute_definition_response.py b/src/square/requests/create_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..f2720b46 --- /dev/null +++ b/src/square/requests/create_customer_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class CreateCustomerCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The new custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_customer_group_response.py b/src/square/requests/create_customer_group_response.py new file mode 100644 index 00000000..b9562c8a --- /dev/null +++ b/src/square/requests/create_customer_group_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer_group import CustomerGroupParams + + +class CreateCustomerGroupResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) endpoint. + + Either `errors` or `group` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + group: typing_extensions.NotRequired[CustomerGroupParams] + """ + The successfully created customer group. + """ diff --git a/src/square/requests/create_customer_response.py b/src/square/requests/create_customer_response.py new file mode 100644 index 00000000..4f344184 --- /dev/null +++ b/src/square/requests/create_customer_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer import CustomerParams + + +class CreateCustomerResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [CreateCustomer](api-endpoint:Customers-CreateCustomer) or + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint. + + Either `errors` or `customer` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + customer: typing_extensions.NotRequired[CustomerParams] + """ + The created customer. + """ diff --git a/src/square/requests/create_device_code_response.py b/src/square/requests/create_device_code_response.py new file mode 100644 index 00000000..b5063389 --- /dev/null +++ b/src/square/requests/create_device_code_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .device_code import DeviceCodeParams + + +class CreateDeviceCodeResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + device_code: typing_extensions.NotRequired[DeviceCodeParams] + """ + The created DeviceCode object containing the device code string. + """ diff --git a/src/square/requests/create_dispute_evidence_file_request.py b/src/square/requests/create_dispute_evidence_file_request.py new file mode 100644 index 00000000..aab11da4 --- /dev/null +++ b/src/square/requests/create_dispute_evidence_file_request.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.dispute_evidence_type import DisputeEvidenceType + + +class CreateDisputeEvidenceFileRequestParams(typing_extensions.TypedDict): + """ + Defines the parameters for a `CreateDisputeEvidenceFile` request. + """ + + idempotency_key: str + """ + A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + """ + + evidence_type: typing_extensions.NotRequired[DisputeEvidenceType] + """ + The type of evidence you are uploading. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + """ + + content_type: typing_extensions.NotRequired[str] + """ + The MIME type of the uploaded file. + The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff. + """ diff --git a/src/square/requests/create_dispute_evidence_file_response.py b/src/square/requests/create_dispute_evidence_file_response.py new file mode 100644 index 00000000..1517e8ab --- /dev/null +++ b/src/square/requests/create_dispute_evidence_file_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute_evidence import DisputeEvidenceParams + + +class CreateDisputeEvidenceFileResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in a `CreateDisputeEvidenceFile` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + evidence: typing_extensions.NotRequired[DisputeEvidenceParams] + """ + The metadata of the newly uploaded dispute evidence. + """ diff --git a/src/square/requests/create_dispute_evidence_text_response.py b/src/square/requests/create_dispute_evidence_text_response.py new file mode 100644 index 00000000..94001032 --- /dev/null +++ b/src/square/requests/create_dispute_evidence_text_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute_evidence import DisputeEvidenceParams + + +class CreateDisputeEvidenceTextResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in a `CreateDisputeEvidenceText` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + evidence: typing_extensions.NotRequired[DisputeEvidenceParams] + """ + The newly uploaded dispute evidence metadata. + """ diff --git a/src/square/requests/create_gift_card_activity_response.py b/src/square/requests/create_gift_card_activity_response.py new file mode 100644 index 00000000..675e07b8 --- /dev/null +++ b/src/square/requests/create_gift_card_activity_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card_activity import GiftCardActivityParams + + +class CreateGiftCardActivityResponseParams(typing_extensions.TypedDict): + """ + A response that contains a `GiftCardActivity` that was created. + The response might contain a set of `Error` objects if the request resulted in errors. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card_activity: typing_extensions.NotRequired[GiftCardActivityParams] + """ + The gift card activity that was created. + """ diff --git a/src/square/requests/create_gift_card_response.py b/src/square/requests/create_gift_card_response.py new file mode 100644 index 00000000..1c6c94ea --- /dev/null +++ b/src/square/requests/create_gift_card_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class CreateGiftCardResponseParams(typing_extensions.TypedDict): + """ + A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request + resulted in errors. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card: typing_extensions.NotRequired[GiftCardParams] + """ + The new gift card. + """ diff --git a/src/square/requests/create_invoice_attachment_response.py b/src/square/requests/create_invoice_attachment_response.py new file mode 100644 index 00000000..dbc54026 --- /dev/null +++ b/src/square/requests/create_invoice_attachment_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .invoice_attachment import InvoiceAttachmentParams +import typing +from .error import ErrorParams + + +class CreateInvoiceAttachmentResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) response. + """ + + attachment: typing_extensions.NotRequired[InvoiceAttachmentParams] + """ + Metadata about the attachment that was added to the invoice. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/create_invoice_response.py b/src/square/requests/create_invoice_response.py new file mode 100644 index 00000000..71eeda4c --- /dev/null +++ b/src/square/requests/create_invoice_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .invoice import InvoiceParams +import typing +from .error import ErrorParams + + +class CreateInvoiceResponseParams(typing_extensions.TypedDict): + """ + The response returned by the `CreateInvoice` request. + """ + + invoice: typing_extensions.NotRequired[InvoiceParams] + """ + The newly created invoice. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/create_job_response.py b/src/square/requests/create_job_response.py new file mode 100644 index 00000000..725ccf13 --- /dev/null +++ b/src/square/requests/create_job_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .job import JobParams +import typing +from .error import ErrorParams + + +class CreateJobResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateJob](api-endpoint:Team-CreateJob) response. Either `job` or `errors` + is present in the response. + """ + + job: typing_extensions.NotRequired[JobParams] + """ + The new job. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/create_location_custom_attribute_definition_response.py b/src/square/requests/create_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..2fdd7078 --- /dev/null +++ b/src/square/requests/create_location_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class CreateLocationCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The new custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_location_response.py b/src/square/requests/create_location_response.py new file mode 100644 index 00000000..5ff1b7ad --- /dev/null +++ b/src/square/requests/create_location_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .location import LocationParams + + +class CreateLocationResponseParams(typing_extensions.TypedDict): + """ + The response object returned by the [CreateLocation](api-endpoint:Locations-CreateLocation) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request. + """ + + location: typing_extensions.NotRequired[LocationParams] + """ + The newly created `Location` object. + """ diff --git a/src/square/requests/create_loyalty_account_response.py b/src/square/requests/create_loyalty_account_response.py new file mode 100644 index 00000000..2747b258 --- /dev/null +++ b/src/square/requests/create_loyalty_account_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_account import LoyaltyAccountParams + + +class CreateLoyaltyAccountResponseParams(typing_extensions.TypedDict): + """ + A response that includes loyalty account created. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_account: typing_extensions.NotRequired[LoyaltyAccountParams] + """ + The newly created loyalty account. + """ diff --git a/src/square/requests/create_loyalty_promotion_response.py b/src/square/requests/create_loyalty_promotion_response.py new file mode 100644 index 00000000..e87e983b --- /dev/null +++ b/src/square/requests/create_loyalty_promotion_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_promotion import LoyaltyPromotionParams + + +class CreateLoyaltyPromotionResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) response. + Either `loyalty_promotion` or `errors` is present in the response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_promotion: typing_extensions.NotRequired[LoyaltyPromotionParams] + """ + The new loyalty promotion. + """ diff --git a/src/square/requests/create_loyalty_reward_response.py b/src/square/requests/create_loyalty_reward_response.py new file mode 100644 index 00000000..8525f25e --- /dev/null +++ b/src/square/requests/create_loyalty_reward_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_reward import LoyaltyRewardParams + + +class CreateLoyaltyRewardResponseParams(typing_extensions.TypedDict): + """ + A response that includes the loyalty reward created. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + reward: typing_extensions.NotRequired[LoyaltyRewardParams] + """ + The loyalty reward created. + """ diff --git a/src/square/requests/create_merchant_custom_attribute_definition_response.py b/src/square/requests/create_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..45a0597e --- /dev/null +++ b/src/square/requests/create_merchant_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class CreateMerchantCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The new custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_mobile_authorization_code_response.py b/src/square/requests/create_mobile_authorization_code_response.py new file mode 100644 index 00000000..e29247d3 --- /dev/null +++ b/src/square/requests/create_mobile_authorization_code_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class CreateMobileAuthorizationCodeResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `CreateMobileAuthorizationCode` endpoint. + """ + + authorization_code: typing_extensions.NotRequired[str] + """ + The generated authorization code that connects a mobile application instance + to a Square account. + """ + + expires_at: typing_extensions.NotRequired[str] + """ + The timestamp when `authorization_code` expires, in + [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, "2016-09-04T23:59:33.123Z"). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_order_custom_attribute_definition_response.py b/src/square/requests/create_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..0d6d7e34 --- /dev/null +++ b/src/square/requests/create_order_custom_attribute_definition_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class CreateOrderCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from creating an order custom attribute definition. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The new custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_order_request.py b/src/square/requests/create_order_request.py new file mode 100644 index 00000000..d9b7cbc6 --- /dev/null +++ b/src/square/requests/create_order_request.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .order import OrderParams + + +class CreateOrderRequestParams(typing_extensions.TypedDict): + order: typing_extensions.NotRequired[OrderParams] + """ + The order to create. If this field is set, the only other top-level field that can be + set is the `idempotency_key`. + """ + + idempotency_key: typing_extensions.NotRequired[str] + """ + A value you specify that uniquely identifies this + order among orders you have created. + + If you are unsure whether a particular order was created successfully, + you can try it again with the same idempotency key without + worrying about creating duplicate orders. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ diff --git a/src/square/requests/create_order_response.py b/src/square/requests/create_order_response.py new file mode 100644 index 00000000..5b29a766 --- /dev/null +++ b/src/square/requests/create_order_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .order import OrderParams +import typing +from .error import ErrorParams + + +class CreateOrderResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `CreateOrder` endpoint. + + Either `errors` or `order` is present in a given response, but never both. + """ + + order: typing_extensions.NotRequired[OrderParams] + """ + The newly created order. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_payment_link_response.py b/src/square/requests/create_payment_link_response.py new file mode 100644 index 00000000..66a9a03c --- /dev/null +++ b/src/square/requests/create_payment_link_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_link import PaymentLinkParams +from .payment_link_related_resources import PaymentLinkRelatedResourcesParams + + +class CreatePaymentLinkResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + payment_link: typing_extensions.NotRequired[PaymentLinkParams] + """ + The created payment link. + """ + + related_resources: typing_extensions.NotRequired[PaymentLinkRelatedResourcesParams] + """ + The list of related objects. + """ diff --git a/src/square/requests/create_payment_response.py b/src/square/requests/create_payment_response.py new file mode 100644 index 00000000..d252c1d7 --- /dev/null +++ b/src/square/requests/create_payment_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment import PaymentParams + + +class CreatePaymentResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by [CreatePayment](api-endpoint:Payments-CreatePayment). + + If there are errors processing the request, the `payment` field might not be + present, or it might be present with a status of `FAILED`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + payment: typing_extensions.NotRequired[PaymentParams] + """ + The newly created payment. + """ diff --git a/src/square/requests/create_shift_response.py b/src/square/requests/create_shift_response.py new file mode 100644 index 00000000..1b3008d0 --- /dev/null +++ b/src/square/requests/create_shift_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .shift import ShiftParams +import typing +from .error import ErrorParams + + +class CreateShiftResponseParams(typing_extensions.TypedDict): + """ + The response to a request to create a `Shift`. The response contains + the created `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shift: typing_extensions.NotRequired[ShiftParams] + """ + The `Shift` that was created on the request. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/create_subscription_response.py b/src/square/requests/create_subscription_response.py new file mode 100644 index 00000000..06455c66 --- /dev/null +++ b/src/square/requests/create_subscription_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams + + +class CreateSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The newly created subscription. + + For more information, see + [Subscription object](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#subscription-object). + """ diff --git a/src/square/requests/create_team_member_request.py b/src/square/requests/create_team_member_request.py new file mode 100644 index 00000000..73fac371 --- /dev/null +++ b/src/square/requests/create_team_member_request.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member import TeamMemberParams + + +class CreateTeamMemberRequestParams(typing_extensions.TypedDict): + """ + Represents a create request for a `TeamMember` object. + """ + + idempotency_key: typing_extensions.NotRequired[str] + """ + A unique string that identifies this `CreateTeamMember` request. + Keys can be any valid string, but must be unique for every request. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + The minimum length is 1 and the maximum length is 45. + """ + + team_member: typing_extensions.NotRequired[TeamMemberParams] + """ + **Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + """ diff --git a/src/square/requests/create_team_member_response.py b/src/square/requests/create_team_member_response.py new file mode 100644 index 00000000..7711a9c3 --- /dev/null +++ b/src/square/requests/create_team_member_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member import TeamMemberParams +import typing +from .error import ErrorParams + + +class CreateTeamMemberResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a create request containing the created `TeamMember` object or error messages. + """ + + team_member: typing_extensions.NotRequired[TeamMemberParams] + """ + The successfully created `TeamMember` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/create_terminal_action_response.py b/src/square/requests/create_terminal_action_response.py new file mode 100644 index 00000000..bbd69990 --- /dev/null +++ b/src/square/requests/create_terminal_action_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_action import TerminalActionParams + + +class CreateTerminalActionResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + action: typing_extensions.NotRequired[TerminalActionParams] + """ + The created `TerminalAction` + """ diff --git a/src/square/requests/create_terminal_checkout_response.py b/src/square/requests/create_terminal_checkout_response.py new file mode 100644 index 00000000..517a509f --- /dev/null +++ b/src/square/requests/create_terminal_checkout_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_checkout import TerminalCheckoutParams + + +class CreateTerminalCheckoutResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + checkout: typing_extensions.NotRequired[TerminalCheckoutParams] + """ + The created `TerminalCheckout`. + """ diff --git a/src/square/requests/create_terminal_refund_response.py b/src/square/requests/create_terminal_refund_response.py new file mode 100644 index 00000000..e96b39ac --- /dev/null +++ b/src/square/requests/create_terminal_refund_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_refund import TerminalRefundParams + + +class CreateTerminalRefundResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refund: typing_extensions.NotRequired[TerminalRefundParams] + """ + The created `TerminalRefund`. + """ diff --git a/src/square/requests/create_vendor_response.py b/src/square/requests/create_vendor_response.py new file mode 100644 index 00000000..bc2778e2 --- /dev/null +++ b/src/square/requests/create_vendor_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .vendor import VendorParams + + +class CreateVendorResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [CreateVendor](api-endpoint:Vendors-CreateVendor). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered when the request fails. + """ + + vendor: typing_extensions.NotRequired[VendorParams] + """ + The successfully created [Vendor](entity:Vendor) object. + """ diff --git a/src/square/requests/create_webhook_subscription_response.py b/src/square/requests/create_webhook_subscription_response.py new file mode 100644 index 00000000..de341ccb --- /dev/null +++ b/src/square/requests/create_webhook_subscription_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .webhook_subscription import WebhookSubscriptionParams + + +class CreateWebhookSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) endpoint. + + Note: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[WebhookSubscriptionParams] + """ + The new [Subscription](entity:WebhookSubscription). + """ diff --git a/src/square/requests/custom_attribute.py b/src/square/requests/custom_attribute.py new file mode 100644 index 00000000..0df6d42c --- /dev/null +++ b/src/square/requests/custom_attribute.py @@ -0,0 +1,63 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.custom_attribute_definition_visibility import CustomAttributeDefinitionVisibility +from .custom_attribute_definition import CustomAttributeDefinitionParams + + +class CustomAttributeParams(typing_extensions.TypedDict): + """ + A custom attribute value. Each custom attribute value has a corresponding + `CustomAttributeDefinition` object. + """ + + key: typing_extensions.NotRequired[typing.Optional[str]] + """ + The identifier + of the custom attribute definition and its corresponding custom attributes. This value + can be a simple key, which is the key that is provided when the custom attribute definition + is created, or a qualified key, if the requesting + application is not the definition owner. The qualified key consists of the application ID + of the custom attribute definition owner + followed by the simple key that was provided when the definition was created. It has the + format application_id:simple key. + + The value for a simple key can contain up to 60 alphanumeric characters, periods (.), + underscores (_), and hyphens (-). + """ + + value: typing_extensions.NotRequired[typing.Optional[typing.Any]] + version: typing_extensions.NotRequired[int] + """ + Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed. + When updating an existing custom attribute value, you can provide this field + and specify the current version of the custom attribute to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). + This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, + see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + """ + + visibility: typing_extensions.NotRequired[CustomAttributeDefinitionVisibility] + """ + A copy of the `visibility` field value for the associated custom attribute definition. + See [CustomAttributeDefinitionVisibility](#type-customattributedefinitionvisibility) for possible values + """ + + definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + A copy of the associated custom attribute definition object. This field is only set when + the optional field is specified on the request. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp that indicates when the custom attribute was created or was most recently + updated, in RFC 3339 format. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp that indicates when the custom attribute was created, in RFC 3339 format. + """ diff --git a/src/square/requests/custom_attribute_definition.py b/src/square/requests/custom_attribute_definition.py new file mode 100644 index 00000000..1ccf0655 --- /dev/null +++ b/src/square/requests/custom_attribute_definition.py @@ -0,0 +1,84 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.custom_attribute_definition_visibility import CustomAttributeDefinitionVisibility + + +class CustomAttributeDefinitionParams(typing_extensions.TypedDict): + """ + Represents a definition for custom attribute values. A custom attribute definition + specifies the key, visibility, schema, and other properties for a custom attribute. + """ + + key: typing_extensions.NotRequired[typing.Optional[str]] + """ + The identifier + of the custom attribute definition and its corresponding custom attributes. This value + can be a simple key, which is the key that is provided when the custom attribute definition + is created, or a qualified key, if the requesting + application is not the definition owner. The qualified key consists of the application ID + of the custom attribute definition owner + followed by the simple key that was provided when the definition was created. It has the + format application_id:simple key. + + The value for a simple key can contain up to 60 alphanumeric characters, periods (.), + underscores (_), and hyphens (-). + + This field can not be changed + after the custom attribute definition is created. This field is required when creating + a definition and must be unique per application, seller, and resource type. + """ + + schema: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]] + """ + The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information, + see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the custom attribute definition for API and seller-facing UI purposes. The name must + be unique within the seller and application pair. This field is required if the + `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + Seller-oriented description of the custom attribute definition, including any constraints + that the seller should observe. May be displayed as a tooltip in Square UIs. This field is + required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + """ + + visibility: typing_extensions.NotRequired[CustomAttributeDefinitionVisibility] + """ + Specifies how the custom attribute definition and its values should be shared with + the seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`. + See [Visibility](#type-visibility) for possible values + """ + + version: typing_extensions.NotRequired[int] + """ + Read only. The current version of the custom attribute definition. + The value is incremented each time the custom attribute definition is updated. + When updating a custom attribute definition, you can provide this field + and specify the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). + + On writes, this field must be set to the latest version. Stale writes are rejected. + + This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, + see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp that indicates when the custom attribute definition was created or most recently updated, + in RFC 3339 format. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format. + """ diff --git a/src/square/requests/custom_attribute_filter.py b/src/square/requests/custom_attribute_filter.py new file mode 100644 index 00000000..c832879e --- /dev/null +++ b/src/square/requests/custom_attribute_filter.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .range import RangeParams + + +class CustomAttributeFilterParams(typing_extensions.TypedDict): + """ + Supported custom attribute query expressions for calling the + [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint to search for items or item variations. + """ + + custom_attribute_definition_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A query expression to filter items or item variations by matching their custom attributes' + `custom_attribute_definition_id` property value against the the specified id. + Exactly one of `custom_attribute_definition_id` or `key` must be specified. + """ + + key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A query expression to filter items or item variations by matching their custom attributes' + `key` property value against the specified key. + Exactly one of `custom_attribute_definition_id` or `key` must be specified. + """ + + string_filter: typing_extensions.NotRequired[typing.Optional[str]] + """ + A query expression to filter items or item variations by matching their custom attributes' + `string_value` property value against the specified text. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + number_filter: typing_extensions.NotRequired[RangeParams] + """ + A query expression to filter items or item variations with their custom attributes + containing a number value within the specified range. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + selection_uids_filter: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A query expression to filter items or item variations by matching their custom attributes' + `selection_uid_values` values against the specified selection uids. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + bool_filter: typing_extensions.NotRequired[typing.Optional[bool]] + """ + A query expression to filter items or item variations by matching their custom attributes' + `boolean_value` property values against the specified Boolean expression. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ diff --git a/src/square/requests/custom_field.py b/src/square/requests/custom_field.py new file mode 100644 index 00000000..5db33835 --- /dev/null +++ b/src/square/requests/custom_field.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class CustomFieldParams(typing_extensions.TypedDict): + """ + Describes a custom form field to add to the checkout page to collect more information from buyers during checkout. + For more information, + see [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1). + """ + + title: str + """ + The title of the custom field. + """ diff --git a/src/square/requests/customer.py b/src/square/requests/customer.py new file mode 100644 index 00000000..64544fb7 --- /dev/null +++ b/src/square/requests/customer.py @@ -0,0 +1,117 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from .customer_preferences import CustomerPreferencesParams +from ..types.customer_creation_source import CustomerCreationSource +from .customer_tax_ids import CustomerTaxIdsParams + + +class CustomerParams(typing_extensions.TypedDict): + """ + Represents a Square customer profile in the Customer Directory of a Square seller. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique Square-assigned ID for the customer profile. + + If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers) + or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the customer profile was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the customer profile was last updated, in RFC 3339 format. + """ + + given_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The given name (that is, the first name) associated with the customer profile. + """ + + family_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The family name (that is, the last name) associated with the customer profile. + """ + + nickname: typing_extensions.NotRequired[typing.Optional[str]] + """ + A nickname for the customer profile. + """ + + company_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A business name associated with the customer profile. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address associated with the customer profile. + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The physical address associated with the customer profile. + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number associated with the customer profile. + """ + + birthday: typing_extensions.NotRequired[typing.Optional[str]] + """ + The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21` + represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year). + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional second ID used to associate the customer profile with an + entity in another system. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A custom note associated with the customer profile. + """ + + preferences: typing_extensions.NotRequired[CustomerPreferencesParams] + """ + Represents general customer preferences. + """ + + creation_source: typing_extensions.NotRequired[CustomerCreationSource] + """ + The method used to create the customer profile. + See [CustomerCreationSource](#type-customercreationsource) for possible values + """ + + group_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of [customer groups](entity:CustomerGroup) the customer belongs to. + """ + + segment_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of [customer segments](entity:CustomerSegment) the customer belongs to. + """ + + version: typing_extensions.NotRequired[int] + """ + The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership. + """ + + tax_ids: typing_extensions.NotRequired[CustomerTaxIdsParams] + """ + The tax ID associated with the customer profile. This field is present only for customers of sellers in EU countries or the United Kingdom. + For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ diff --git a/src/square/requests/customer_address_filter.py b/src/square/requests/customer_address_filter.py new file mode 100644 index 00000000..36c16811 --- /dev/null +++ b/src/square/requests/customer_address_filter.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .customer_text_filter import CustomerTextFilterParams +from ..types.country import Country + + +class CustomerAddressFilterParams(typing_extensions.TypedDict): + """ + The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when + searching by an `Address`-type custom attribute. + """ + + postal_code: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + The postal code to search for. Only an `exact` match is supported. + """ + + country: typing_extensions.NotRequired[Country] + """ + The country code to search for. + See [Country](#type-country) for possible values + """ diff --git a/src/square/requests/customer_creation_source_filter.py b/src/square/requests/customer_creation_source_filter.py new file mode 100644 index 00000000..155c807e --- /dev/null +++ b/src/square/requests/customer_creation_source_filter.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.customer_creation_source import CustomerCreationSource +from ..types.customer_inclusion_exclusion import CustomerInclusionExclusion + + +class CustomerCreationSourceFilterParams(typing_extensions.TypedDict): + """ + The creation source filter. + + If one or more creation sources are set, customer profiles are included in, + or excluded from, the result if they match at least one of the filter criteria. + """ + + values: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CustomerCreationSource]]] + """ + The list of creation sources used as filtering criteria. + See [CustomerCreationSource](#type-customercreationsource) for possible values + """ + + rule: typing_extensions.NotRequired[CustomerInclusionExclusion] + """ + Indicates whether a customer profile matching the filter criteria + should be included in the result or excluded from the result. + + Default: `INCLUDE`. + See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values + """ diff --git a/src/square/requests/customer_custom_attribute_filter.py b/src/square/requests/customer_custom_attribute_filter.py new file mode 100644 index 00000000..4c612c10 --- /dev/null +++ b/src/square/requests/customer_custom_attribute_filter.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .customer_custom_attribute_filter_value import CustomerCustomAttributeFilterValueParams +from .time_range import TimeRangeParams + + +class CustomerCustomAttributeFilterParams(typing_extensions.TypedDict): + """ + The custom attribute filter. Use this filter in a set of [custom attribute filters](entity:CustomerCustomAttributeFilters) to search + based on the value or last updated date of a customer-related [custom attribute](entity:CustomAttribute). + """ + + key: str + """ + The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute + (and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes). + """ + + filter: typing_extensions.NotRequired[CustomerCustomAttributeFilterValueParams] + """ + A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to + search based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition, + which can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes). + + You must provide this `filter` field, the `updated_at` field, or both. + """ + + updated_at: typing_extensions.NotRequired[TimeRangeParams] + """ + The date range for when the custom attribute was last updated. The date range can include `start_at`, `end_at`, or + both. Range boundaries are inclusive. Dates are specified as RFC 3339 timestamps. + + You must provide this `updated_at` field, the `filter` field, or both. + """ diff --git a/src/square/requests/customer_custom_attribute_filter_value.py b/src/square/requests/customer_custom_attribute_filter_value.py new file mode 100644 index 00000000..1763316b --- /dev/null +++ b/src/square/requests/customer_custom_attribute_filter_value.py @@ -0,0 +1,98 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .customer_text_filter import CustomerTextFilterParams +from .filter_value import FilterValueParams +from .time_range import TimeRangeParams +from .float_number_range import FloatNumberRangeParams +import typing +from .customer_address_filter import CustomerAddressFilterParams + + +class CustomerCustomAttributeFilterValueParams(typing_extensions.TypedDict): + """ + A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value + of a customer-related [custom attribute](entity:CustomAttribute). + """ + + email: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + A filter for a query based on the value of an `Email`-type custom attribute. This filter is case-insensitive and can + include `exact` or `fuzzy`, but not both. + + For an `exact` match, provide the complete email address. + + For a `fuzzy` match, provide a query expression containing one or more query tokens to match against the email address. Square removes + any punctuation (including periods (.), underscores (_), and the @ symbol) and tokenizes the email addresses on spaces. A match is found + if a tokenized email address contains all the tokens in the search query, irrespective of the token order. For example, `Steven gmail` + matches steven.jones@gmail.com and mygmail@stevensbakery.com. + """ + + phone: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + A filter for a query based on the value of a `PhoneNumber`-type custom attribute. This filter is case-insensitive and + can include `exact` or `fuzzy`, but not both. + + For an `exact` match, provide the complete phone number. This is always an E.164-compliant phone number that starts + with the + sign followed by the country code and subscriber number. For example, the format for a US phone number is +12061112222. + + For a `fuzzy` match, provide a query expression containing one or more query tokens to match against the phone number. + Square removes any punctuation and tokenizes the expression on spaces. A match is found if a tokenized phone number contains + all the tokens in the search query, irrespective of the token order. For example, `415 123 45` is tokenized to `415`, `123`, and `45`, + which matches +14151234567 and +12345674158, but does not match +1234156780. Similarly, the expression `415` matches + +14151234567, +12345674158, and +1234156780. + """ + + text: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + A filter for a query based on the value of a `String`-type custom attribute. This filter is case-insensitive and + can include `exact` or `fuzzy`, but not both. + + For an `exact` match, provide the complete string. + + For a `fuzzy` match, provide a query expression containing one or more query tokens in any order that contain complete words + to match against the string. Square tokenizes the expression using a grammar-based tokenizer. For example, the expressions `quick brown`, + `brown quick`, and `quick fox` match "The quick brown fox jumps over the lazy dog". However, `quick foxes` and `qui` do not match. + """ + + selection: typing_extensions.NotRequired[FilterValueParams] + """ + A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive + and can contain `any`, `all`, or both. The `none` condition is not supported. + + Provide the display name of each item that you want to search for. To find the display names for the selection, use the + [Customer Custom Attributes API](api:CustomerCustomAttributes) to retrieve the corresponding custom attribute definition + and then check the `schema.items.names` field. For more information, see + [Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection). + + Note that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one + or more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller. + """ + + date: typing_extensions.NotRequired[TimeRangeParams] + """ + A filter for a query based on the value of a `Date`-type custom attribute. + + Provide a date range for this filter using `start_at`, `end_at`, or both. Range boundaries are inclusive. Dates can be specified + in `YYYY-MM-DD` format or as RFC 3339 timestamps. + """ + + number: typing_extensions.NotRequired[FloatNumberRangeParams] + """ + A filter for a query based on the value of a `Number`-type custom attribute, which can be an integer or a decimal with up to + 5 digits of precision. + + Provide a numerical range for this filter using `start_at`, `end_at`, or both. Range boundaries are inclusive. Numbers are specified + as decimals or integers. The absolute value of range boundaries must not exceed `(2^63-1)/10^5`, or 92233720368547. + """ + + boolean: typing_extensions.NotRequired[typing.Optional[bool]] + """ + A filter for a query based on the value of a `Boolean`-type custom attribute. + """ + + address: typing_extensions.NotRequired[CustomerAddressFilterParams] + """ + A filter for a query based on the value of an `Address`-type custom attribute. The filter can include `postal_code`, `country`, or both. + """ diff --git a/src/square/requests/customer_custom_attribute_filters.py b/src/square/requests/customer_custom_attribute_filters.py new file mode 100644 index 00000000..b414b422 --- /dev/null +++ b/src/square/requests/customer_custom_attribute_filters.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .customer_custom_attribute_filter import CustomerCustomAttributeFilterParams + + +class CustomerCustomAttributeFiltersParams(typing_extensions.TypedDict): + """ + The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter + to search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see + [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). + """ + + filters: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CustomerCustomAttributeFilterParams]]] + """ + The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter, + the `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters. + """ diff --git a/src/square/requests/customer_details.py b/src/square/requests/customer_details.py new file mode 100644 index 00000000..f89a2e76 --- /dev/null +++ b/src/square/requests/customer_details.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CustomerDetailsParams(typing_extensions.TypedDict): + """ + Details about the customer making the payment. + """ + + customer_initiated: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the customer initiated the payment. + """ + + seller_keyed_in: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates that the seller keyed in payment details on behalf of the customer. + This is used to flag a payment as Mail Order / Telephone Order (MOTO). + """ diff --git a/src/square/requests/customer_filter.py b/src/square/requests/customer_filter.py new file mode 100644 index 00000000..46386c38 --- /dev/null +++ b/src/square/requests/customer_filter.py @@ -0,0 +1,145 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .customer_creation_source_filter import CustomerCreationSourceFilterParams +from .time_range import TimeRangeParams +from .customer_text_filter import CustomerTextFilterParams +from .filter_value import FilterValueParams +from .customer_custom_attribute_filters import CustomerCustomAttributeFiltersParams + + +class CustomerFilterParams(typing_extensions.TypedDict): + """ + Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter + customer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results. + """ + + creation_source: typing_extensions.NotRequired[CustomerCreationSourceFilterParams] + """ + A filter to select customers based on their creation source. + """ + + created_at: typing_extensions.NotRequired[TimeRangeParams] + """ + A filter to select customers based on when they were created. + """ + + updated_at: typing_extensions.NotRequired[TimeRangeParams] + """ + A filter to select customers based on when they were last updated. + """ + + email_address: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + A filter to [select customers by their email address](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-email-address) + visible to the seller. + This filter is case-insensitive. + + For [exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-email-address), this + filter causes the search to return customer profiles + whose `email_address` field value are identical to the email address provided + in the query. + + For [fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-email-address), + this filter causes the search to return customer profiles + whose `email_address` field value has a token-wise partial match against the filtering + expression in the query. For example, with `Steven gmail` provided in a search + query, the search returns customers whose email address is `steven.johnson@gmail.com` + or `mygmail@stevensbakery.com`. Square removes any punctuation (including periods (.), + underscores (_), and the @ symbol) and tokenizes the email addresses on spaces. A match is + found if a tokenized email address contains all the tokens in the search query, + irrespective of the token order. + """ + + phone_number: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + A filter to [select customers by their phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-phone-number) + visible to the seller. + + For [exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-phone-number), + this filter returns customers whose phone number matches the specified query expression. The number in the query must be of an + E.164-compliant form. In particular, it must include the leading `+` sign followed by a country code and then a subscriber number. + For example, the standard E.164 form of a US phone number is `+12062223333` and an E.164-compliant variation is `+1 (206) 222-3333`. + To match the query expression, stored customer phone numbers are converted to the standard E.164 form. + + For [fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-phone-number), + this filter returns customers whose phone number matches the token or tokens provided in the query expression. For example, with `415` + provided in a search query, the search returns customers with the phone numbers `+1-415-212-1200`, `+1-212-415-1234`, and `+1 (551) 234-1567`. + Similarly, a search query of `415 123` returns customers with the phone numbers `+1-212-415-1234` and `+1 (551) 234-1567` but not + `+1-212-415-1200`. A match is found if a tokenized phone number contains all the tokens in the search query, irrespective of the token order. + """ + + reference_id: typing_extensions.NotRequired[CustomerTextFilterParams] + """ + A filter to [select customers by their reference IDs](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-reference-id). + This filter is case-insensitive. + + [Exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-reference-id) + of a customer's reference ID against a query's reference ID is evaluated as an + exact match between two strings, character by character in the given order. + + [Fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-reference-id) + of stored reference IDs against queried reference IDs works + exactly the same as fuzzy matching on email addresses. Non-alphanumeric characters + are replaced by spaces to tokenize stored and queried reference IDs. A match is found + if a tokenized stored reference ID contains all tokens specified in any order in the query. For example, + a query of `NYC M` matches customer profiles with the `reference_id` value of `NYC_M_35_JOHNSON` + and `NYC_27_MURRAY`. + """ + + group_ids: typing_extensions.NotRequired[FilterValueParams] + """ + A filter to select customers based on the [groups](entity:CustomerGroup) they belong to. + Group membership is controlled by sellers and developers. + + The `group_ids` filter has the following syntax: + ``` + "group_ids": { + "any": ["{group_a_id}", "{group_b_id}", ...], + "all": ["{group_1_id}", "{group_2_id}", ...], + "none": ["{group_i_id}", "{group_ii_id}", ...] + } + ``` + + You can use any combination of the `any`, `all`, and `none` fields in the filter. + With `any`, the search returns customers in groups `a` or `b` or any other group specified in the list. + With `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list. + With `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list. + + If any of the search conditions are not met, including when an invalid or non-existent group ID is provided, + the result is an empty object (`{}`). + """ + + custom_attribute: typing_extensions.NotRequired[CustomerCustomAttributeFiltersParams] + """ + A filter to select customers based on one or more custom attributes. + This filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom + attribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation. + + To be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries, + see [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). + + Square returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes, + use the [Customer Custom Attributes API](api:CustomerCustomAttributes). For example, you can call + [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) using a customer ID from the result set. + """ + + segment_ids: typing_extensions.NotRequired[FilterValueParams] + """ + A filter to select customers based on the [segments](entity:CustomerSegment) they belong to. + Segment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria. + + You can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields. + For the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C. + + ``` + "segment_ids": { + "all": ["{segment_A_id}", "{segment_B_id}"], + "none": ["{segment_C_id}"] + } + ``` + + If an invalid or non-existent segment ID is provided in the filter, Square stops processing the request + and returns a `400 BAD_REQUEST` error that includes the segment ID. + """ diff --git a/src/square/requests/customer_group.py b/src/square/requests/customer_group.py new file mode 100644 index 00000000..4c02a2cb --- /dev/null +++ b/src/square/requests/customer_group.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class CustomerGroupParams(typing_extensions.TypedDict): + """ + Represents a group of customer profiles. + + Customer groups can be created, be modified, and have their membership defined using + the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique Square-generated ID for the customer group. + """ + + name: str + """ + The name of the customer group. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the customer group was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the customer group was last updated, in RFC 3339 format. + """ diff --git a/src/square/requests/customer_preferences.py b/src/square/requests/customer_preferences.py new file mode 100644 index 00000000..a60a9ee7 --- /dev/null +++ b/src/square/requests/customer_preferences.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CustomerPreferencesParams(typing_extensions.TypedDict): + """ + Represents communication preferences for the customer profile. + """ + + email_unsubscribed: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the customer has unsubscribed from marketing campaign emails. A value of `true` means that the customer chose to opt out of email marketing from the current Square seller or from all Square sellers. This value is read-only from the Customers API. + """ diff --git a/src/square/requests/customer_query.py b/src/square/requests/customer_query.py new file mode 100644 index 00000000..60d8237f --- /dev/null +++ b/src/square/requests/customer_query.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .customer_filter import CustomerFilterParams +from .customer_sort import CustomerSortParams + + +class CustomerQueryParams(typing_extensions.TypedDict): + """ + Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request. + """ + + filter: typing_extensions.NotRequired[CustomerFilterParams] + """ + The filtering criteria for the search query. A query can contain multiple filters in any combination. + Multiple filters are combined as `AND` statements. + + __Note:__ Combining multiple filters as `OR` statements is not supported. Instead, send multiple single-filter + searches and join the result sets. + """ + + sort: typing_extensions.NotRequired[CustomerSortParams] + """ + Sorting criteria for query results. The default behavior is to sort + customers alphabetically by `given_name` and `family_name`. + """ diff --git a/src/square/requests/customer_segment.py b/src/square/requests/customer_segment.py new file mode 100644 index 00000000..a4ace77b --- /dev/null +++ b/src/square/requests/customer_segment.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class CustomerSegmentParams(typing_extensions.TypedDict): + """ + Represents a group of customer profiles that match one or more predefined filter criteria. + + Segments (also known as Smart Groups) are defined and created within the Customer Directory in the + Square Seller Dashboard or Point of Sale. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique Square-generated ID for the segment. + """ + + name: str + """ + The name of the segment. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the segment was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the segment was last updated, in RFC 3339 format. + """ diff --git a/src/square/requests/customer_sort.py b/src/square/requests/customer_sort.py new file mode 100644 index 00000000..7757edae --- /dev/null +++ b/src/square/requests/customer_sort.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.customer_sort_field import CustomerSortField +from ..types.sort_order import SortOrder + + +class CustomerSortParams(typing_extensions.TypedDict): + """ + Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort + customer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results. + """ + + field: typing_extensions.NotRequired[CustomerSortField] + """ + Indicates the fields to use as the sort key, which is either the default set of fields or `created_at`. + + The default value is `DEFAULT`. + See [CustomerSortField](#type-customersortfield) for possible values + """ + + order: typing_extensions.NotRequired[SortOrder] + """ + Indicates the order in which results should be sorted based on the + sort field value. Strings use standard alphabetic comparison + to determine order. Strings representing numbers are sorted as strings. + + The default value is `ASC`. + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/customer_tax_ids.py b/src/square/requests/customer_tax_ids.py new file mode 100644 index 00000000..4aa726ad --- /dev/null +++ b/src/square/requests/customer_tax_ids.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CustomerTaxIdsParams(typing_extensions.TypedDict): + """ + Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. + For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ + + eu_vat: typing_extensions.NotRequired[typing.Optional[str]] + """ + The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only. + """ diff --git a/src/square/requests/customer_text_filter.py b/src/square/requests/customer_text_filter.py new file mode 100644 index 00000000..cf84c05a --- /dev/null +++ b/src/square/requests/customer_text_filter.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class CustomerTextFilterParams(typing_extensions.TypedDict): + """ + A filter to select customers based on exact or fuzzy matching of + customer attributes against a specified query. Depending on the customer attributes, + the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. + """ + + exact: typing_extensions.NotRequired[typing.Optional[str]] + """ + Use the exact filter to select customers whose attributes match exactly the specified query. + """ + + fuzzy: typing_extensions.NotRequired[typing.Optional[str]] + """ + Use the fuzzy filter to select customers whose attributes match the specified query + in a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then + each query token must be matched somewhere in the searched attribute. For single token queries, + this is effectively the same behavior as a partial match operation. + """ diff --git a/src/square/requests/data_collection_options.py b/src/square/requests/data_collection_options.py new file mode 100644 index 00000000..a4d02718 --- /dev/null +++ b/src/square/requests/data_collection_options.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.data_collection_options_input_type import DataCollectionOptionsInputType +import typing_extensions +from .collected_data import CollectedDataParams + + +class DataCollectionOptionsParams(typing_extensions.TypedDict): + title: str + """ + The title text to display in the data collection flow on the Terminal. + """ + + body: str + """ + The body text to display under the title in the data collection screen flow on the + Terminal. + """ + + input_type: DataCollectionOptionsInputType + """ + Represents the type of the input text. + See [InputType](#type-inputtype) for possible values + """ + + collected_data: typing_extensions.NotRequired[CollectedDataParams] + """ + The buyer’s input text from the data collection screen. + """ diff --git a/src/square/requests/date_range.py b/src/square/requests/date_range.py new file mode 100644 index 00000000..43fc699e --- /dev/null +++ b/src/square/requests/date_range.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DateRangeParams(typing_extensions.TypedDict): + """ + A range defined by two dates. Used for filtering a query for Connect v2 + objects that have date properties. + """ + + start_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601 + extended format for calendar dates. + The beginning of a date range (inclusive). + """ + + end_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601 + extended format for calendar dates. + The end of a date range (inclusive). + """ diff --git a/src/square/requests/delete_booking_custom_attribute_definition_response.py b/src/square/requests/delete_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..afe62fa2 --- /dev/null +++ b/src/square/requests/delete_booking_custom_attribute_definition_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteBookingCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition) response + containing error messages when errors occurred during the request. The successful response does not contain any payload. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_booking_custom_attribute_response.py b/src/square/requests/delete_booking_custom_attribute_response.py new file mode 100644 index 00000000..452bd238 --- /dev/null +++ b/src/square/requests/delete_booking_custom_attribute_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteBookingCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_break_type_response.py b/src/square/requests/delete_break_type_response.py new file mode 100644 index 00000000..5d7638f4 --- /dev/null +++ b/src/square/requests/delete_break_type_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteBreakTypeResponseParams(typing_extensions.TypedDict): + """ + The response to a request to delete a `BreakType`. The response might contain a set + of `Error` objects if the request resulted in errors. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_catalog_object_response.py b/src/square/requests/delete_catalog_object_response.py new file mode 100644 index 00000000..f1075b53 --- /dev/null +++ b/src/square/requests/delete_catalog_object_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteCatalogObjectResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + deleted_object_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The IDs of all catalog objects deleted by this request. + Multiple IDs may be returned when associated objects are also deleted, for example + a catalog item variation will be deleted (and its ID included in this field) + when its parent catalog item is deleted. + """ + + deleted_at: typing_extensions.NotRequired[str] + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + """ diff --git a/src/square/requests/delete_customer_card_response.py b/src/square/requests/delete_customer_card_response.py new file mode 100644 index 00000000..070a10e6 --- /dev/null +++ b/src/square/requests/delete_customer_card_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteCustomerCardResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `DeleteCustomerCard` endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_customer_custom_attribute_definition_response.py b/src/square/requests/delete_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..70d68852 --- /dev/null +++ b/src/square/requests/delete_customer_custom_attribute_definition_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteCustomerCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a delete request containing error messages if there are any. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_customer_custom_attribute_response.py b/src/square/requests/delete_customer_custom_attribute_response.py new file mode 100644 index 00000000..e3825a78 --- /dev/null +++ b/src/square/requests/delete_customer_custom_attribute_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteCustomerCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_customer_group_response.py b/src/square/requests/delete_customer_group_response.py new file mode 100644 index 00000000..55640355 --- /dev/null +++ b/src/square/requests/delete_customer_group_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteCustomerGroupResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_customer_response.py b/src/square/requests/delete_customer_response.py new file mode 100644 index 00000000..fc9fc26b --- /dev/null +++ b/src/square/requests/delete_customer_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteCustomerResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `DeleteCustomer` endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_dispute_evidence_response.py b/src/square/requests/delete_dispute_evidence_response.py new file mode 100644 index 00000000..c480f554 --- /dev/null +++ b/src/square/requests/delete_dispute_evidence_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteDisputeEvidenceResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in a `DeleteDisputeEvidence` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/delete_invoice_attachment_response.py b/src/square/requests/delete_invoice_attachment_response.py new file mode 100644 index 00000000..2131e9b8 --- /dev/null +++ b/src/square/requests/delete_invoice_attachment_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteInvoiceAttachmentResponseParams(typing_extensions.TypedDict): + """ + Represents a [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/delete_invoice_response.py b/src/square/requests/delete_invoice_response.py new file mode 100644 index 00000000..4e12ae19 --- /dev/null +++ b/src/square/requests/delete_invoice_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteInvoiceResponseParams(typing_extensions.TypedDict): + """ + Describes a `DeleteInvoice` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/delete_location_custom_attribute_definition_response.py b/src/square/requests/delete_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..c3b9d441 --- /dev/null +++ b/src/square/requests/delete_location_custom_attribute_definition_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteLocationCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a delete request containing error messages if there are any. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_location_custom_attribute_response.py b/src/square/requests/delete_location_custom_attribute_response.py new file mode 100644 index 00000000..f4daa091 --- /dev/null +++ b/src/square/requests/delete_location_custom_attribute_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteLocationCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [DeleteLocationCustomAttribute](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_loyalty_reward_response.py b/src/square/requests/delete_loyalty_reward_response.py new file mode 100644 index 00000000..541a9d54 --- /dev/null +++ b/src/square/requests/delete_loyalty_reward_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteLoyaltyRewardResponseParams(typing_extensions.TypedDict): + """ + A response returned by the API call. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_merchant_custom_attribute_definition_response.py b/src/square/requests/delete_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..72283214 --- /dev/null +++ b/src/square/requests/delete_merchant_custom_attribute_definition_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteMerchantCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a delete request containing error messages if there are any. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_merchant_custom_attribute_response.py b/src/square/requests/delete_merchant_custom_attribute_response.py new file mode 100644 index 00000000..5eb7ff8b --- /dev/null +++ b/src/square/requests/delete_merchant_custom_attribute_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteMerchantCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [DeleteMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_order_custom_attribute_definition_response.py b/src/square/requests/delete_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..df172019 --- /dev/null +++ b/src/square/requests/delete_order_custom_attribute_definition_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteOrderCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from deleting an order custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_order_custom_attribute_response.py b/src/square/requests/delete_order_custom_attribute_response.py new file mode 100644 index 00000000..4d5f6f86 --- /dev/null +++ b/src/square/requests/delete_order_custom_attribute_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteOrderCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a response from deleting an order custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_payment_link_response.py b/src/square/requests/delete_payment_link_response.py new file mode 100644 index 00000000..2d355787 --- /dev/null +++ b/src/square/requests/delete_payment_link_response.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeletePaymentLinkResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + id: typing_extensions.NotRequired[str] + """ + The ID of the link that is deleted. + """ + + cancelled_order_id: typing_extensions.NotRequired[str] + """ + The ID of the order that is canceled. When a payment link is deleted, Square updates the + the `state` (of the order that the checkout link created) to CANCELED. + """ diff --git a/src/square/requests/delete_shift_response.py b/src/square/requests/delete_shift_response.py new file mode 100644 index 00000000..a3a250c2 --- /dev/null +++ b/src/square/requests/delete_shift_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteShiftResponseParams(typing_extensions.TypedDict): + """ + The response to a request to delete a `Shift`. The response might contain a set of + `Error` objects if the request resulted in errors. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_snippet_response.py b/src/square/requests/delete_snippet_response.py new file mode 100644 index 00000000..da9a4d7b --- /dev/null +++ b/src/square/requests/delete_snippet_response.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteSnippetResponseParams(typing_extensions.TypedDict): + """ + Represents a `DeleteSnippet` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/delete_subscription_action_response.py b/src/square/requests/delete_subscription_action_response.py new file mode 100644 index 00000000..39023a7d --- /dev/null +++ b/src/square/requests/delete_subscription_action_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams + + +class DeleteSubscriptionActionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response of the [DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction) + endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The subscription that has the specified action deleted. + """ diff --git a/src/square/requests/delete_webhook_subscription_response.py b/src/square/requests/delete_webhook_subscription_response.py new file mode 100644 index 00000000..ed0ae662 --- /dev/null +++ b/src/square/requests/delete_webhook_subscription_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DeleteWebhookSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [DeleteWebhookSubscription](api-endpoint:WebhookSubscriptions-DeleteWebhookSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ diff --git a/src/square/requests/destination.py b/src/square/requests/destination.py new file mode 100644 index 00000000..e00126ec --- /dev/null +++ b/src/square/requests/destination.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.destination_type import DestinationType + + +class DestinationParams(typing_extensions.TypedDict): + """ + Information about the destination against which the payout was made. + """ + + type: typing_extensions.NotRequired[DestinationType] + """ + Type of the destination such as a bank account or debit card. + See [DestinationType](#type-destinationtype) for possible values + """ + + id: typing_extensions.NotRequired[str] + """ + Square issued unique ID (also known as the instrument ID) associated with this destination. + """ diff --git a/src/square/requests/destination_details.py b/src/square/requests/destination_details.py new file mode 100644 index 00000000..fa163c6d --- /dev/null +++ b/src/square/requests/destination_details.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .destination_details_card_refund_details import DestinationDetailsCardRefundDetailsParams +from .destination_details_cash_refund_details import DestinationDetailsCashRefundDetailsParams +from .destination_details_external_refund_details import DestinationDetailsExternalRefundDetailsParams + + +class DestinationDetailsParams(typing_extensions.TypedDict): + """ + Details about a refund's destination. + """ + + card_details: typing_extensions.NotRequired[DestinationDetailsCardRefundDetailsParams] + """ + Details about a card refund. Only populated if the destination_type is `CARD`. + """ + + cash_details: typing_extensions.NotRequired[DestinationDetailsCashRefundDetailsParams] + """ + Details about a cash refund. Only populated if the destination_type is `CASH`. + """ + + external_details: typing_extensions.NotRequired[DestinationDetailsExternalRefundDetailsParams] + """ + Details about an external refund. Only populated if the destination_type is `EXTERNAL`. + """ diff --git a/src/square/requests/destination_details_card_refund_details.py b/src/square/requests/destination_details_card_refund_details.py new file mode 100644 index 00000000..165552f0 --- /dev/null +++ b/src/square/requests/destination_details_card_refund_details.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .card import CardParams +import typing + + +class DestinationDetailsCardRefundDetailsParams(typing_extensions.TypedDict): + card: typing_extensions.NotRequired[CardParams] + """ + The card's non-confidential details. + """ + + entry_method: typing_extensions.NotRequired[typing.Optional[str]] + """ + The method used to enter the card's details for the refund. The method can be + `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + """ + + auth_result_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The authorization code provided by the issuer when a refund is approved. + """ diff --git a/src/square/requests/destination_details_cash_refund_details.py b/src/square/requests/destination_details_cash_refund_details.py new file mode 100644 index 00000000..4387744c --- /dev/null +++ b/src/square/requests/destination_details_cash_refund_details.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +import typing_extensions + + +class DestinationDetailsCashRefundDetailsParams(typing_extensions.TypedDict): + """ + Stores details about a cash refund. Contains only non-confidential information. + """ + + seller_supplied_money: MoneyParams + """ + The amount and currency of the money supplied by the seller. + """ + + change_back_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of change due back to the seller. + This read-only field is calculated + from the `amount_money` and `seller_supplied_money` fields. + """ diff --git a/src/square/requests/destination_details_external_refund_details.py b/src/square/requests/destination_details_external_refund_details.py new file mode 100644 index 00000000..06055c6a --- /dev/null +++ b/src/square/requests/destination_details_external_refund_details.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DestinationDetailsExternalRefundDetailsParams(typing_extensions.TypedDict): + """ + Stores details about an external refund. Contains only non-confidential information. + """ + + type: str + """ + The type of external refund the seller paid to the buyer. It can be one of the + following: + - CHECK - Refunded using a physical check. + - BANK_TRANSFER - Refunded using external bank transfer. + - OTHER\_GIFT\_CARD - Refunded using a non-Square gift card. + - CRYPTO - Refunded using a crypto currency. + - SQUARE_CASH - Refunded using Square Cash App. + - SOCIAL - Refunded using peer-to-peer payment applications. + - EXTERNAL - A third-party application gathered this refund outside of Square. + - EMONEY - Refunded using an E-money provider. + - CARD - A credit or debit card that Square does not support. + - STORED_BALANCE - Use for house accounts, store credit, and so forth. + - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals + - OTHER - A type not listed here. + """ + + source: str + """ + A description of the external refund source. For example, + "Food Delivery Service". + """ + + source_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An ID to associate the refund to its originating source. + """ diff --git a/src/square/requests/device.py b/src/square/requests/device.py new file mode 100644 index 00000000..37fbdcba --- /dev/null +++ b/src/square/requests/device.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .device_attributes import DeviceAttributesParams +import typing +from .component import ComponentParams +from .device_status import DeviceStatusParams + + +class DeviceParams(typing_extensions.TypedDict): + id: typing_extensions.NotRequired[str] + """ + A synthetic identifier for the device. The identifier includes a standardized prefix and + is otherwise an opaque id generated from key device fields. + """ + + attributes: DeviceAttributesParams + """ + A collection of DeviceAttributes representing the device. + """ + + components: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ComponentParams]]] + """ + A list of components applicable to the device. + """ + + status: typing_extensions.NotRequired[DeviceStatusParams] + """ + The current status of the device. + """ diff --git a/src/square/requests/device_attributes.py b/src/square/requests/device_attributes.py new file mode 100644 index 00000000..7609eb45 --- /dev/null +++ b/src/square/requests/device_attributes.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.device_attributes_device_type import DeviceAttributesDeviceType +import typing_extensions +import typing + + +class DeviceAttributesParams(typing_extensions.TypedDict): + type: DeviceAttributesDeviceType + """ + The device type. + See [DeviceType](#type-devicetype) for possible values + """ + + manufacturer: str + """ + The maker of the device. + """ + + model: typing_extensions.NotRequired[typing.Optional[str]] + """ + The specific model of the device. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A seller-specified name for the device. + """ + + manufacturers_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The manufacturer-supplied identifier for the device (where available). In many cases, + this identifier will be a serial number. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The RFC 3339-formatted value of the most recent update to the device information. + (Could represent any field update on the device.) + """ + + version: typing_extensions.NotRequired[str] + """ + The current version of software installed on the device. + """ + + merchant_token: typing_extensions.NotRequired[typing.Optional[str]] + """ + The merchant_token identifying the merchant controlling the device. + """ diff --git a/src/square/requests/device_checkout_options.py b/src/square/requests/device_checkout_options.py new file mode 100644 index 00000000..38f7cc04 --- /dev/null +++ b/src/square/requests/device_checkout_options.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .tip_settings import TipSettingsParams + + +class DeviceCheckoutOptionsParams(typing_extensions.TypedDict): + device_id: str + """ + The unique ID of the device intended for this `TerminalCheckout`. + A list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint. + Match a `DeviceCode.device_id` value with `device_id` to get the associated device code. + """ + + skip_receipt_screen: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Instructs the device to skip the receipt screen. Defaults to false. + """ + + collect_signature: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates that signature collection is desired during checkout. Defaults to false. + """ + + tip_settings: typing_extensions.NotRequired[TipSettingsParams] + """ + Tip-specific settings. + """ + + show_itemized_cart: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Show the itemization screen prior to taking a payment. This field is only meaningful when the + checkout includes an order ID. Defaults to true. + """ diff --git a/src/square/requests/device_code.py b/src/square/requests/device_code.py new file mode 100644 index 00000000..5a187010 --- /dev/null +++ b/src/square/requests/device_code.py @@ -0,0 +1,65 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.product_type import ProductType +from ..types.device_code_status import DeviceCodeStatus + + +class DeviceCodeParams(typing_extensions.TypedDict): + id: typing_extensions.NotRequired[str] + """ + The unique id for this device code. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional user-defined name for the device code. + """ + + code: typing_extensions.NotRequired[str] + """ + The unique code that can be used to login. + """ + + device_id: typing_extensions.NotRequired[str] + """ + The unique id of the device that used this code. Populated when the device is paired up. + """ + + product_type: ProductType + """ + The targeting product type of the device code. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The location assigned to this code. + """ + + status: typing_extensions.NotRequired[DeviceCodeStatus] + """ + The pairing status of the device code. + See [DeviceCodeStatus](#type-devicecodestatus) for possible values + """ + + pair_by: typing_extensions.NotRequired[str] + """ + When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format. + """ + + created_at: typing_extensions.NotRequired[str] + """ + When this DeviceCode was created. Timestamp in RFC 3339 format. + """ + + status_changed_at: typing_extensions.NotRequired[str] + """ + When this DeviceCode's status was last changed. Timestamp in RFC 3339 format. + """ + + paired_at: typing_extensions.NotRequired[str] + """ + When this DeviceCode was paired. Timestamp in RFC 3339 format. + """ diff --git a/src/square/requests/device_component_details_application_details.py b/src/square/requests/device_component_details_application_details.py new file mode 100644 index 00000000..3942e7ab --- /dev/null +++ b/src/square/requests/device_component_details_application_details.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.application_type import ApplicationType +import typing + + +class DeviceComponentDetailsApplicationDetailsParams(typing_extensions.TypedDict): + application_type: typing_extensions.NotRequired[ApplicationType] + """ + The type of application. + See [ApplicationType](#type-applicationtype) for possible values + """ + + version: typing_extensions.NotRequired[str] + """ + The version of the application. + """ + + session_location: typing_extensions.NotRequired[typing.Optional[str]] + """ + The location_id of the session for the application. + """ + + device_code_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The id of the device code that was used to log in to the device. + """ diff --git a/src/square/requests/device_component_details_battery_details.py b/src/square/requests/device_component_details_battery_details.py new file mode 100644 index 00000000..6764b47a --- /dev/null +++ b/src/square/requests/device_component_details_battery_details.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.device_component_details_external_power import DeviceComponentDetailsExternalPower + + +class DeviceComponentDetailsBatteryDetailsParams(typing_extensions.TypedDict): + visible_percent: typing_extensions.NotRequired[typing.Optional[int]] + """ + The battery charge percentage as displayed on the device. + """ + + external_power: typing_extensions.NotRequired[DeviceComponentDetailsExternalPower] + """ + The status of external_power. + See [ExternalPower](#type-externalpower) for possible values + """ diff --git a/src/square/requests/device_component_details_card_reader_details.py b/src/square/requests/device_component_details_card_reader_details.py new file mode 100644 index 00000000..c4ef09a1 --- /dev/null +++ b/src/square/requests/device_component_details_card_reader_details.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class DeviceComponentDetailsCardReaderDetailsParams(typing_extensions.TypedDict): + version: typing_extensions.NotRequired[str] + """ + The version of the card reader. + """ diff --git a/src/square/requests/device_component_details_ethernet_details.py b/src/square/requests/device_component_details_ethernet_details.py new file mode 100644 index 00000000..0b595ede --- /dev/null +++ b/src/square/requests/device_component_details_ethernet_details.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DeviceComponentDetailsEthernetDetailsParams(typing_extensions.TypedDict): + active: typing_extensions.NotRequired[typing.Optional[bool]] + """ + A boolean to represent whether the Ethernet interface is currently active. + """ + + ip_address_v4: typing_extensions.NotRequired[typing.Optional[str]] + """ + The string representation of the device’s IPv4 address. + """ diff --git a/src/square/requests/device_component_details_measurement.py b/src/square/requests/device_component_details_measurement.py new file mode 100644 index 00000000..a6a2a6cb --- /dev/null +++ b/src/square/requests/device_component_details_measurement.py @@ -0,0 +1,13 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DeviceComponentDetailsMeasurementParams(typing_extensions.TypedDict): + """ + A value qualified by unit of measure. + """ + + value: typing_extensions.NotRequired[typing.Optional[int]] diff --git a/src/square/requests/device_component_details_wi_fi_details.py b/src/square/requests/device_component_details_wi_fi_details.py new file mode 100644 index 00000000..50dfe5be --- /dev/null +++ b/src/square/requests/device_component_details_wi_fi_details.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .device_component_details_measurement import DeviceComponentDetailsMeasurementParams + + +class DeviceComponentDetailsWiFiDetailsParams(typing_extensions.TypedDict): + active: typing_extensions.NotRequired[typing.Optional[bool]] + """ + A boolean to represent whether the WiFI interface is currently active. + """ + + ssid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the connected WIFI network. + """ + + ip_address_v4: typing_extensions.NotRequired[typing.Optional[str]] + """ + The string representation of the device’s IPv4 address. + """ + + secure_connection: typing_extensions.NotRequired[typing.Optional[str]] + """ + The security protocol for a secure connection (e.g. WPA2). None provided if the connection + is unsecured. + """ + + signal_strength: typing_extensions.NotRequired[DeviceComponentDetailsMeasurementParams] + """ + A representation of signal strength of the WIFI network connection. + """ diff --git a/src/square/requests/device_details.py b/src/square/requests/device_details.py new file mode 100644 index 00000000..3182f48b --- /dev/null +++ b/src/square/requests/device_details.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DeviceDetailsParams(typing_extensions.TypedDict): + """ + Details about the device that took the payment. + """ + + device_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-issued ID of the device. + """ + + device_installation_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-issued installation ID for the device. + """ + + device_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the device set by the seller. + """ diff --git a/src/square/requests/device_metadata.py b/src/square/requests/device_metadata.py new file mode 100644 index 00000000..d223e797 --- /dev/null +++ b/src/square/requests/device_metadata.py @@ -0,0 +1,71 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DeviceMetadataParams(typing_extensions.TypedDict): + battery_percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Terminal’s remaining battery percentage, between 1-100. + """ + + charging_state: typing_extensions.NotRequired[typing.Optional[str]] + """ + The current charging state of the Terminal. + Options: `CHARGING`, `NOT_CHARGING` + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the Square seller business location associated with the Terminal. + """ + + merchant_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the Square merchant account that is currently signed-in to the Terminal. + """ + + network_connection_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Terminal’s current network connection type. + Options: `WIFI`, `ETHERNET` + """ + + payment_region: typing_extensions.NotRequired[typing.Optional[str]] + """ + The country in which the Terminal is authorized to take payments. + """ + + serial_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique identifier assigned to the Terminal, which can be found on the lower back + of the device. + """ + + os_version: typing_extensions.NotRequired[typing.Optional[str]] + """ + The current version of the Terminal’s operating system. + """ + + app_version: typing_extensions.NotRequired[typing.Optional[str]] + """ + The current version of the application running on the Terminal. + """ + + wifi_network_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the Wi-Fi network to which the Terminal is connected. + """ + + wifi_network_strength: typing_extensions.NotRequired[typing.Optional[str]] + """ + The signal strength of the Wi-FI network connection. + Options: `POOR`, `FAIR`, `GOOD`, `EXCELLENT` + """ + + ip_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The IP address of the Terminal. + """ diff --git a/src/square/requests/device_status.py b/src/square/requests/device_status.py new file mode 100644 index 00000000..d1cb7da0 --- /dev/null +++ b/src/square/requests/device_status.py @@ -0,0 +1,13 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.device_status_category import DeviceStatusCategory + + +class DeviceStatusParams(typing_extensions.TypedDict): + category: typing_extensions.NotRequired[DeviceStatusCategory] + """ + + See [Category](#type-category) for possible values + """ diff --git a/src/square/requests/digital_wallet_details.py b/src/square/requests/digital_wallet_details.py new file mode 100644 index 00000000..24437416 --- /dev/null +++ b/src/square/requests/digital_wallet_details.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .cash_app_details import CashAppDetailsParams + + +class DigitalWalletDetailsParams(typing_extensions.TypedDict): + """ + Additional details about `WALLET` type payments. Contains only non-confidential information. + """ + + status: typing_extensions.NotRequired[typing.Optional[str]] + """ + The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or + `FAILED`. + """ + + brand: typing_extensions.NotRequired[typing.Optional[str]] + """ + The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`, + `RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`. + """ + + cash_app_details: typing_extensions.NotRequired[CashAppDetailsParams] + """ + Brand-specific details for payments with the `brand` of `CASH_APP`. + """ diff --git a/src/square/requests/disable_card_response.py b/src/square/requests/disable_card_response.py new file mode 100644 index 00000000..82d89e7f --- /dev/null +++ b/src/square/requests/disable_card_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .card import CardParams + + +class DisableCardResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [DisableCard](api-endpoint:Cards-DisableCard) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + card: typing_extensions.NotRequired[CardParams] + """ + The retrieved card. + """ diff --git a/src/square/requests/disable_events_response.py b/src/square/requests/disable_events_response.py new file mode 100644 index 00000000..72187950 --- /dev/null +++ b/src/square/requests/disable_events_response.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class DisableEventsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [DisableEvents](api-endpoint:Events-DisableEvents) endpoint. + + Note: if there are errors processing the request, the events field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ diff --git a/src/square/requests/dismiss_terminal_action_response.py b/src/square/requests/dismiss_terminal_action_response.py new file mode 100644 index 00000000..f9b74711 --- /dev/null +++ b/src/square/requests/dismiss_terminal_action_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_action import TerminalActionParams + + +class DismissTerminalActionResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + action: typing_extensions.NotRequired[TerminalActionParams] + """ + Current state of the action to be dismissed. + """ diff --git a/src/square/requests/dismiss_terminal_checkout_response.py b/src/square/requests/dismiss_terminal_checkout_response.py new file mode 100644 index 00000000..fefcb3c2 --- /dev/null +++ b/src/square/requests/dismiss_terminal_checkout_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_checkout import TerminalCheckoutParams + + +class DismissTerminalCheckoutResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + checkout: typing_extensions.NotRequired[TerminalCheckoutParams] + """ + Current state of the checkout to be dismissed. + """ diff --git a/src/square/requests/dismiss_terminal_refund_response.py b/src/square/requests/dismiss_terminal_refund_response.py new file mode 100644 index 00000000..b9c558c2 --- /dev/null +++ b/src/square/requests/dismiss_terminal_refund_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_refund import TerminalRefundParams + + +class DismissTerminalRefundResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + refund: typing_extensions.NotRequired[TerminalRefundParams] + """ + Current state of the refund to be dismissed. + """ diff --git a/src/square/requests/dispute.py b/src/square/requests/dispute.py new file mode 100644 index 00000000..33d31696 --- /dev/null +++ b/src/square/requests/dispute.py @@ -0,0 +1,100 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from ..types.dispute_reason import DisputeReason +from ..types.dispute_state import DisputeState +from .disputed_payment import DisputedPaymentParams +from ..types.card_brand import CardBrand + + +class DisputeParams(typing_extensions.TypedDict): + """ + Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank. + """ + + dispute_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique ID for this `Dispute`, generated by Square. + """ + + id: typing_extensions.NotRequired[str] + """ + The unique ID for this `Dispute`, generated by Square. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The disputed amount, which can be less than the total transaction amount. + For instance, if multiple items were purchased but the cardholder only initiates a dispute over some of the items. + """ + + reason: typing_extensions.NotRequired[DisputeReason] + """ + The reason why the cardholder initiated the dispute. + See [DisputeReason](#type-disputereason) for possible values + """ + + state: typing_extensions.NotRequired[DisputeState] + """ + The current state of this dispute. + See [DisputeState](#type-disputestate) for possible values + """ + + due_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The deadline by which the seller must respond to the dispute, in [RFC 3339 format](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates). + """ + + disputed_payment: typing_extensions.NotRequired[DisputedPaymentParams] + """ + The payment challenged in this dispute. + """ + + evidence_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of the evidence associated with the dispute. + """ + + card_brand: typing_extensions.NotRequired[CardBrand] + """ + The card brand used in the disputed payment. + See [CardBrand](#type-cardbrand) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the dispute was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the dispute was last updated, in RFC 3339 format. + """ + + brand_dispute_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the dispute in the card brand system, generated by the card brand. + """ + + reported_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the dispute was reported, in RFC 3339 format. + """ + + reported_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the dispute was reported, in RFC 3339 format. + """ + + version: typing_extensions.NotRequired[int] + """ + The current version of the `Dispute`. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the location where the dispute originated. + """ diff --git a/src/square/requests/dispute_evidence.py b/src/square/requests/dispute_evidence.py new file mode 100644 index 00000000..c86e8c1c --- /dev/null +++ b/src/square/requests/dispute_evidence.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .dispute_evidence_file import DisputeEvidenceFileParams +from ..types.dispute_evidence_type import DisputeEvidenceType + + +class DisputeEvidenceParams(typing_extensions.TypedDict): + evidence_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the evidence. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-generated ID of the evidence. + """ + + dispute_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the dispute the evidence is associated with. + """ + + evidence_file: typing_extensions.NotRequired[DisputeEvidenceFileParams] + """ + Image, PDF, TXT + """ + + evidence_text: typing_extensions.NotRequired[typing.Optional[str]] + """ + Raw text + """ + + uploaded_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the evidence was uploaded, in RFC 3339 format. + """ + + evidence_type: typing_extensions.NotRequired[DisputeEvidenceType] + """ + The type of the evidence. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + """ diff --git a/src/square/requests/dispute_evidence_file.py b/src/square/requests/dispute_evidence_file.py new file mode 100644 index 00000000..6a07b069 --- /dev/null +++ b/src/square/requests/dispute_evidence_file.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DisputeEvidenceFileParams(typing_extensions.TypedDict): + """ + A file to be uploaded as dispute evidence. + """ + + filename: typing_extensions.NotRequired[typing.Optional[str]] + """ + The file name including the file extension. For example: "receipt.tiff". + """ + + filetype: typing_extensions.NotRequired[typing.Optional[str]] + """ + Dispute evidence files must be application/pdf, image/heic, image/heif, image/jpeg, image/png, or image/tiff formats. + """ diff --git a/src/square/requests/disputed_payment.py b/src/square/requests/disputed_payment.py new file mode 100644 index 00000000..0a3debff --- /dev/null +++ b/src/square/requests/disputed_payment.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class DisputedPaymentParams(typing_extensions.TypedDict): + """ + The payment the cardholder disputed. + """ + + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + Square-generated unique ID of the payment being disputed. + """ diff --git a/src/square/requests/employee.py b/src/square/requests/employee.py new file mode 100644 index 00000000..3166bcaa --- /dev/null +++ b/src/square/requests/employee.py @@ -0,0 +1,67 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.employee_status import EmployeeStatus + + +class EmployeeParams(typing_extensions.TypedDict): + """ + An employee object that is used by the external API. + + DEPRECATED at version 2020-08-26. Replaced by [TeamMember](entity:TeamMember). + """ + + id: typing_extensions.NotRequired[str] + """ + UUID for this object. + """ + + first_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The employee's first name. + """ + + last_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The employee's last name. + """ + + email: typing_extensions.NotRequired[typing.Optional[str]] + """ + The employee's email address + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The employee's phone number in E.164 format, i.e. "+12125554250" + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of location IDs where this employee has access to. + """ + + status: typing_extensions.NotRequired[EmployeeStatus] + """ + Specifies the status of the employees being fetched. + See [EmployeeStatus](#type-employeestatus) for possible values + """ + + is_owner: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether this employee is the owner of the merchant. Each merchant + has one owner employee, and that employee has full authority over + the account. + """ + + created_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format. + """ diff --git a/src/square/requests/employee_wage.py b/src/square/requests/employee_wage.py new file mode 100644 index 00000000..f5bc26a8 --- /dev/null +++ b/src/square/requests/employee_wage.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class EmployeeWageParams(typing_extensions.TypedDict): + """ + The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](entity:TeamMemberWage). + """ + + id: typing_extensions.NotRequired[str] + """ + The UUID for this object. + """ + + employee_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `Employee` that this wage is assigned to. + """ + + title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The job title that this wage relates to. + """ + + hourly_rate: typing_extensions.NotRequired[MoneyParams] + """ + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + """ diff --git a/src/square/requests/enable_events_response.py b/src/square/requests/enable_events_response.py new file mode 100644 index 00000000..c78ba8d9 --- /dev/null +++ b/src/square/requests/enable_events_response.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class EnableEventsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [EnableEvents](api-endpoint:Events-EnableEvents) endpoint. + + Note: if there are errors processing the request, the events field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ diff --git a/src/square/requests/error.py b/src/square/requests/error.py new file mode 100644 index 00000000..5bd17414 --- /dev/null +++ b/src/square/requests/error.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.error_category import ErrorCategory +from ..types.error_code import ErrorCode +import typing_extensions + + +class ErrorParams(typing_extensions.TypedDict): + """ + Represents an error encountered during a request to the Connect API. + + See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information. + """ + + category: ErrorCategory + """ + The high-level category for the error. + See [ErrorCategory](#type-errorcategory) for possible values + """ + + code: ErrorCode + """ + The specific code of the error. + See [ErrorCode](#type-errorcode) for possible values + """ + + detail: typing_extensions.NotRequired[str] + """ + A human-readable description of the error for debugging purposes. + """ + + field: typing_extensions.NotRequired[str] + """ + The name of the field provided in the original request (if any) that + the error pertains to. + """ diff --git a/src/square/requests/event.py b/src/square/requests/event.py new file mode 100644 index 00000000..8c22db82 --- /dev/null +++ b/src/square/requests/event.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .event_data import EventDataParams + + +class EventParams(typing_extensions.TypedDict): + merchant_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the target merchant associated with the event. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the target location associated with the event. + """ + + type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The type of event this represents. + """ + + event_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID for the event. + """ + + created_at: typing_extensions.NotRequired[str] + """ + Timestamp of when the event was created, in RFC 3339 format. + """ + + data: typing_extensions.NotRequired[EventDataParams] + """ + The data associated with the event. + """ diff --git a/src/square/requests/event_data.py b/src/square/requests/event_data.py new file mode 100644 index 00000000..9c0b453c --- /dev/null +++ b/src/square/requests/event_data.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class EventDataParams(typing_extensions.TypedDict): + type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the affected object’s type. + """ + + id: typing_extensions.NotRequired[str] + """ + The ID of the affected object. + """ + + deleted: typing_extensions.NotRequired[typing.Optional[bool]] + """ + This is true if the affected object has been deleted; otherwise, it's absent. + """ + + object: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]] + """ + An object containing fields and values relevant to the event. It is absent if the affected object has been deleted. + """ diff --git a/src/square/requests/event_metadata.py b/src/square/requests/event_metadata.py new file mode 100644 index 00000000..13555b4c --- /dev/null +++ b/src/square/requests/event_metadata.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class EventMetadataParams(typing_extensions.TypedDict): + """ + Contains metadata about a particular [Event](entity:Event). + """ + + event_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID for the event. + """ + + api_version: typing_extensions.NotRequired[typing.Optional[str]] + """ + The API version of the event. This corresponds to the default API version of the developer application at the time when the event was created. + """ diff --git a/src/square/requests/event_type_metadata.py b/src/square/requests/event_type_metadata.py new file mode 100644 index 00000000..a86369e5 --- /dev/null +++ b/src/square/requests/event_type_metadata.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class EventTypeMetadataParams(typing_extensions.TypedDict): + """ + Contains the metadata of a webhook event type. + """ + + event_type: typing_extensions.NotRequired[str] + """ + The event type. + """ + + api_version_introduced: typing_extensions.NotRequired[str] + """ + The API version at which the event type was introduced. + """ + + release_status: typing_extensions.NotRequired[str] + """ + The release status of the event type. + """ diff --git a/src/square/requests/external_payment_details.py b/src/square/requests/external_payment_details.py new file mode 100644 index 00000000..3278cc0f --- /dev/null +++ b/src/square/requests/external_payment_details.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class ExternalPaymentDetailsParams(typing_extensions.TypedDict): + """ + Stores details about an external payment. Contains only non-confidential information. + For more information, see + [Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments). + """ + + type: str + """ + The type of external payment the seller received. It can be one of the following: + - CHECK - Paid using a physical check. + - BANK_TRANSFER - Paid using external bank transfer. + - OTHER\_GIFT\_CARD - Paid using a non-Square gift card. + - CRYPTO - Paid using a crypto currency. + - SQUARE_CASH - Paid using Square Cash App. + - SOCIAL - Paid using peer-to-peer payment applications. + - EXTERNAL - A third-party application gathered this payment outside of Square. + - EMONEY - Paid using an E-money provider. + - CARD - A credit or debit card that Square does not support. + - STORED_BALANCE - Use for house accounts, store credit, and so forth. + - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals + - OTHER - A type not listed here. + """ + + source: str + """ + A description of the external payment source. For example, + "Food Delivery Service". + """ + + source_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An ID to associate the payment to its originating source. + """ + + source_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The fees paid to the source. The `amount_money` minus this field is + the net amount seller receives. + """ diff --git a/src/square/requests/filter_value.py b/src/square/requests/filter_value.py new file mode 100644 index 00000000..825d367b --- /dev/null +++ b/src/square/requests/filter_value.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..core.serialization import FieldMetadata + + +class FilterValueParams(typing_extensions.TypedDict): + """ + A filter to select resources based on an exact field value. For any given + value, the value can only be in one property. Depending on the field, either + all properties can be set or only a subset will be available. + + Refer to the documentation of the field. + """ + + all_: typing_extensions.NotRequired[ + typing_extensions.Annotated[typing.Optional[typing.Sequence[str]], FieldMetadata(alias="all")] + ] + """ + A list of terms that must be present on the field of the resource. + """ + + any: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of terms where at least one of them must be present on the + field of the resource. + """ + + none: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of terms that must not be present on the field the resource + """ diff --git a/src/square/requests/float_number_range.py b/src/square/requests/float_number_range.py new file mode 100644 index 00000000..3c1787b7 --- /dev/null +++ b/src/square/requests/float_number_range.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class FloatNumberRangeParams(typing_extensions.TypedDict): + """ + Specifies a decimal number range. + """ + + start_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A decimal value indicating where the range starts. + """ + + end_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A decimal value indicating where the range ends. + """ diff --git a/src/square/requests/fulfillment.py b/src/square/requests/fulfillment.py new file mode 100644 index 00000000..3bbcf55b --- /dev/null +++ b/src/square/requests/fulfillment.py @@ -0,0 +1,106 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.fulfillment_type import FulfillmentType +from ..types.fulfillment_state import FulfillmentState +from ..types.fulfillment_fulfillment_line_item_application import FulfillmentFulfillmentLineItemApplication +from .fulfillment_fulfillment_entry import FulfillmentFulfillmentEntryParams +from .fulfillment_pickup_details import FulfillmentPickupDetailsParams +from .fulfillment_shipment_details import FulfillmentShipmentDetailsParams +from .fulfillment_delivery_details import FulfillmentDeliveryDetailsParams + + +class FulfillmentParams(typing_extensions.TypedDict): + """ + Contains details about how to fulfill this order. + Orders can only be created with at most one fulfillment using the API. + However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the fulfillment only within this order. + """ + + type: typing_extensions.NotRequired[FulfillmentType] + """ + The type of the fulfillment. + See [FulfillmentType](#type-fulfillmenttype) for possible values + """ + + state: typing_extensions.NotRequired[FulfillmentState] + """ + The state of the fulfillment. + See [FulfillmentState](#type-fulfillmentstate) for possible values + """ + + line_item_application: typing_extensions.NotRequired[FulfillmentFulfillmentLineItemApplication] + """ + Describes what order line items this fulfillment applies to. + It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries. + See [FulfillmentFulfillmentLineItemApplication](#type-fulfillmentfulfillmentlineitemapplication) for possible values + """ + + entries: typing_extensions.NotRequired[typing.Sequence[FulfillmentFulfillmentEntryParams]] + """ + A list of entries pertaining to the fulfillment of an order. Each entry must reference + a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to + fulfill. + + Multiple entries can reference the same line item `uid`, as long as the total quantity among + all fulfillment entries referencing a single line item does not exceed the quantity of the + order's line item itself. + + An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`, + `CANCELED`, or `FAILED`. Fulfillments can be created and completed independently + before order completion. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this fulfillment. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + pickup_details: typing_extensions.NotRequired[FulfillmentPickupDetailsParams] + """ + Contains details for a pickup fulfillment. These details are required when the fulfillment + type is `PICKUP`. + """ + + shipment_details: typing_extensions.NotRequired[FulfillmentShipmentDetailsParams] + """ + Contains details for a shipment fulfillment. These details are required when the fulfillment type + is `SHIPMENT`. + + A shipment fulfillment's relationship to fulfillment `state`: + `PROPOSED`: A shipment is requested. + `RESERVED`: Fulfillment in progress. Shipment processing. + `PREPARED`: Shipment packaged. Shipping label created. + `COMPLETED`: Package has been shipped. + `CANCELED`: Shipment has been canceled. + `FAILED`: Shipment has failed. + """ + + delivery_details: typing_extensions.NotRequired[FulfillmentDeliveryDetailsParams] + """ + Describes delivery details of an order fulfillment. + """ diff --git a/src/square/requests/fulfillment_delivery_details.py b/src/square/requests/fulfillment_delivery_details.py new file mode 100644 index 00000000..7543919a --- /dev/null +++ b/src/square/requests/fulfillment_delivery_details.py @@ -0,0 +1,175 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .fulfillment_recipient import FulfillmentRecipientParams +from ..types.fulfillment_delivery_details_order_fulfillment_delivery_details_schedule_type import ( + FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType, +) +import typing + + +class FulfillmentDeliveryDetailsParams(typing_extensions.TypedDict): + """ + Describes delivery details of an order fulfillment. + """ + + recipient: typing_extensions.NotRequired[FulfillmentRecipientParams] + """ + The contact information for the person to receive the fulfillment. + """ + + schedule_type: typing_extensions.NotRequired[FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType] + """ + Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then + `deliver_at` is required. If `ASAP`, then `prep_time_duration` is required. The default is `SCHEDULED`. + See [OrderFulfillmentDeliveryDetailsScheduleType](#type-orderfulfillmentdeliverydetailsscheduletype) for possible values + """ + + placed_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was placed. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + + Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". + """ + + deliver_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + that represents the start of the delivery period. + When the fulfillment `schedule_type` is `ASAP`, the field is automatically + set to the current time plus the `prep_time_duration`. + Otherwise, the application can set this field while the fulfillment `state` is + `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the + terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`). + + The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + prep_time_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The duration of time it takes to prepare and deliver this fulfillment. + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + delivery_window_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time period after `deliver_at` in which to deliver the order. + Applications can set this field when the fulfillment `state` is + `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state + such as `COMPLETED`, `CANCELED`, and `FAILED`). + + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + Provides additional instructions about the delivery fulfillment. + It is displayed in the Square Point of Sale application and set by the API. + """ + + completed_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicates when the seller completed the fulfillment. + This field is automatically set when fulfillment `state` changes to `COMPLETED`. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + in_progress_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicates when the seller started processing the fulfillment. + This field is automatically set when the fulfillment `state` changes to `RESERVED`. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + rejected_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was rejected. This field is + automatically set when the fulfillment `state` changes to `FAILED`. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + ready_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the seller marked the fulfillment as ready for + courier pickup. This field is automatically set when the fulfillment `state` changes + to PREPARED. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + delivered_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was delivered to the recipient. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + canceled_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was canceled. This field is automatically + set when the fulfillment `state` changes to `CANCELED`. + + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + cancel_reason: typing_extensions.NotRequired[typing.Optional[str]] + """ + The delivery cancellation reason. Max length: 100 characters. + """ + + courier_pickup_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when an order can be picked up by the courier for delivery. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + courier_pickup_window_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time period after `courier_pickup_at` in which the courier should pick up the order. + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + is_no_contact_delivery: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether the delivery is preferred to be no contact. + """ + + dropoff_notes: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note to provide additional instructions about how to deliver the order. + """ + + courier_provider_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the courier provider. + """ + + courier_support_phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The support phone number of the courier. + """ + + square_delivery_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The identifier for the delivery created by Square. + """ + + external_delivery_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The identifier for the delivery created by the third-party courier service. + """ + + managed_delivery: typing_extensions.NotRequired[typing.Optional[bool]] + """ + The flag to indicate the delivery is managed by a third party (ie DoorDash), which means + we may not receive all recipient information for PII purposes. + """ diff --git a/src/square/requests/fulfillment_fulfillment_entry.py b/src/square/requests/fulfillment_fulfillment_entry.py new file mode 100644 index 00000000..995a98c6 --- /dev/null +++ b/src/square/requests/fulfillment_fulfillment_entry.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class FulfillmentFulfillmentEntryParams(typing_extensions.TypedDict): + """ + Links an order line item to a fulfillment. Each entry must reference + a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to + fulfill. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the fulfillment entry only within this order. + """ + + line_item_uid: str + """ + The `uid` from the order line item. + """ + + quantity: str + """ + The quantity of the line item being fulfilled, formatted as a decimal number. + For example, `"3"`. + + Fulfillments for line items with a `quantity_unit` can have non-integer quantities. + For example, `"1.70000"`. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this fulfillment entry. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ diff --git a/src/square/requests/fulfillment_pickup_details.py b/src/square/requests/fulfillment_pickup_details.py new file mode 100644 index 00000000..49e32c40 --- /dev/null +++ b/src/square/requests/fulfillment_pickup_details.py @@ -0,0 +1,136 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .fulfillment_recipient import FulfillmentRecipientParams +import typing +from ..types.fulfillment_pickup_details_schedule_type import FulfillmentPickupDetailsScheduleType +from .fulfillment_pickup_details_curbside_pickup_details import FulfillmentPickupDetailsCurbsidePickupDetailsParams + + +class FulfillmentPickupDetailsParams(typing_extensions.TypedDict): + """ + Contains details necessary to fulfill a pickup order. + """ + + recipient: typing_extensions.NotRequired[FulfillmentRecipientParams] + """ + Information about the person to pick up this fulfillment from a physical + location. + """ + + expires_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment expires if it is not marked in progress. The timestamp must be + in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set + up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order + are automatically completed. + """ + + auto_complete_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The duration of time after which an in progress pickup fulfillment is automatically moved + to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D"). + + If not set, this pickup fulfillment remains in progress until it is canceled or completed. + """ + + schedule_type: typing_extensions.NotRequired[FulfillmentPickupDetailsScheduleType] + """ + The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. + See [FulfillmentPickupDetailsScheduleType](#type-fulfillmentpickupdetailsscheduletype) for possible values + """ + + pickup_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., + "2016-09-04T23:59:33.123Z". + + For fulfillments with the schedule type `ASAP`, this is automatically set + to the current time plus the expected duration to prepare the fulfillment. + """ + + pickup_window_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The window of time in which the order should be picked up after the `pickup_at` timestamp. + Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an + informational guideline for merchants. + """ + + prep_time_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The duration of time it takes to prepare this fulfillment. + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note to provide additional instructions about the pickup + fulfillment displayed in the Square Point of Sale application and set by the API. + """ + + placed_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + accepted_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + rejected_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + ready_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + expired_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment expired. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + picked_up_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + canceled_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + cancel_reason: typing_extensions.NotRequired[typing.Optional[str]] + """ + A description of why the pickup was canceled. The maximum length: 100 characters. + """ + + is_curbside_pickup: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup. + """ + + curbside_pickup_details: typing_extensions.NotRequired[FulfillmentPickupDetailsCurbsidePickupDetailsParams] + """ + Specific details for curbside pickup. These details can only be populated if `is_curbside_pickup` is set to `true`. + """ diff --git a/src/square/requests/fulfillment_pickup_details_curbside_pickup_details.py b/src/square/requests/fulfillment_pickup_details_curbside_pickup_details.py new file mode 100644 index 00000000..92cc67ef --- /dev/null +++ b/src/square/requests/fulfillment_pickup_details_curbside_pickup_details.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class FulfillmentPickupDetailsCurbsidePickupDetailsParams(typing_extensions.TypedDict): + """ + Specific details for curbside pickup. + """ + + curbside_details: typing_extensions.NotRequired[typing.Optional[str]] + """ + Specific details for curbside pickup, such as parking number and vehicle model. + """ + + buyer_arrived_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ diff --git a/src/square/requests/fulfillment_recipient.py b/src/square/requests/fulfillment_recipient.py new file mode 100644 index 00000000..974e30db --- /dev/null +++ b/src/square/requests/fulfillment_recipient.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams + + +class FulfillmentRecipientParams(typing_extensions.TypedDict): + """ + Information about the fulfillment recipient. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the customer associated with the fulfillment. + + If `customer_id` is provided, the fulfillment recipient's `display_name`, + `email_address`, and `phone_number` are automatically populated from the + targeted customer profile. If these fields are set in the request, the request + values override the information from the customer profile. If the + targeted customer profile does not contain the necessary information and + these fields are left unset, the request results in an error. + """ + + display_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The display name of the fulfillment recipient. This field is required. + + If provided, the display name overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address of the fulfillment recipient. + + If provided, the email address overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number of the fulfillment recipient. This field is required. + + If provided, the phone number overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The address of the fulfillment recipient. This field is required. + + If provided, the address overrides the corresponding customer profile value + indicated by `customer_id`. + """ diff --git a/src/square/requests/fulfillment_shipment_details.py b/src/square/requests/fulfillment_shipment_details.py new file mode 100644 index 00000000..89353fdc --- /dev/null +++ b/src/square/requests/fulfillment_shipment_details.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .fulfillment_recipient import FulfillmentRecipientParams +import typing + + +class FulfillmentShipmentDetailsParams(typing_extensions.TypedDict): + """ + Contains the details necessary to fulfill a shipment order. + """ + + recipient: typing_extensions.NotRequired[FulfillmentRecipientParams] + """ + Information about the person to receive this shipment fulfillment. + """ + + carrier: typing_extensions.NotRequired[typing.Optional[str]] + """ + The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS). + """ + + shipping_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note with additional information for the shipping carrier. + """ + + shipping_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + A description of the type of shipping product purchased from the carrier + (such as First Class, Priority, or Express). + """ + + tracking_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The reference number provided by the carrier to track the shipment's progress. + """ + + tracking_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + A link to the tracking webpage on the carrier's website. + """ + + placed_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the shipment was requested. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + in_progress_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation + of this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + packaged_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the + fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + expected_shipped_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the shipment is expected to be delivered to the shipping carrier. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + shipped_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that + the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + canceled_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating the shipment was canceled. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + cancel_reason: typing_extensions.NotRequired[typing.Optional[str]] + """ + A description of why the shipment was canceled. + """ + + failed_at: typing_extensions.NotRequired[str] + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + failure_reason: typing_extensions.NotRequired[typing.Optional[str]] + """ + A description of why the shipment failed to be completed. + """ diff --git a/src/square/requests/get_bank_account_by_v1id_response.py b/src/square/requests/get_bank_account_by_v1id_response.py new file mode 100644 index 00000000..d53f18c6 --- /dev/null +++ b/src/square/requests/get_bank_account_by_v1id_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .bank_account import BankAccountParams + + +class GetBankAccountByV1IdResponseParams(typing_extensions.TypedDict): + """ + Response object returned by GetBankAccountByV1Id. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + bank_account: typing_extensions.NotRequired[BankAccountParams] + """ + The requested `BankAccount` object. + """ diff --git a/src/square/requests/get_bank_account_response.py b/src/square/requests/get_bank_account_response.py new file mode 100644 index 00000000..984ce4e0 --- /dev/null +++ b/src/square/requests/get_bank_account_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .bank_account import BankAccountParams + + +class GetBankAccountResponseParams(typing_extensions.TypedDict): + """ + Response object returned by `GetBankAccount`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + bank_account: typing_extensions.NotRequired[BankAccountParams] + """ + The requested `BankAccount` object. + """ diff --git a/src/square/requests/get_booking_response.py b/src/square/requests/get_booking_response.py new file mode 100644 index 00000000..2a806bf5 --- /dev/null +++ b/src/square/requests/get_booking_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .booking import BookingParams +import typing +from .error import ErrorParams + + +class GetBookingResponseParams(typing_extensions.TypedDict): + booking: typing_extensions.NotRequired[BookingParams] + """ + The booking that was requested. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/get_break_type_response.py b/src/square/requests/get_break_type_response.py new file mode 100644 index 00000000..09ab8647 --- /dev/null +++ b/src/square/requests/get_break_type_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .break_type import BreakTypeParams +import typing +from .error import ErrorParams + + +class GetBreakTypeResponseParams(typing_extensions.TypedDict): + """ + The response to a request to get a `BreakType`. The response contains + the requested `BreakType` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_type: typing_extensions.NotRequired[BreakTypeParams] + """ + The response object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_business_booking_profile_response.py b/src/square/requests/get_business_booking_profile_response.py new file mode 100644 index 00000000..e3a9f309 --- /dev/null +++ b/src/square/requests/get_business_booking_profile_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .business_booking_profile import BusinessBookingProfileParams +import typing +from .error import ErrorParams + + +class GetBusinessBookingProfileResponseParams(typing_extensions.TypedDict): + business_booking_profile: typing_extensions.NotRequired[BusinessBookingProfileParams] + """ + The seller's booking profile. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/get_card_response.py b/src/square/requests/get_card_response.py new file mode 100644 index 00000000..b64d34b7 --- /dev/null +++ b/src/square/requests/get_card_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .card import CardParams + + +class GetCardResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveCard](api-endpoint:Cards-RetrieveCard) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + card: typing_extensions.NotRequired[CardParams] + """ + The retrieved card. + """ diff --git a/src/square/requests/get_cash_drawer_shift_response.py b/src/square/requests/get_cash_drawer_shift_response.py new file mode 100644 index 00000000..d7a71ce7 --- /dev/null +++ b/src/square/requests/get_cash_drawer_shift_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .cash_drawer_shift import CashDrawerShiftParams +import typing +from .error import ErrorParams + + +class GetCashDrawerShiftResponseParams(typing_extensions.TypedDict): + cash_drawer_shift: typing_extensions.NotRequired[CashDrawerShiftParams] + """ + The cash drawer shift queried for. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_catalog_object_response.py b/src/square/requests/get_catalog_object_response.py new file mode 100644 index 00000000..bbaa75f2 --- /dev/null +++ b/src/square/requests/get_catalog_object_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class GetCatalogObjectResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + object: typing_extensions.NotRequired[CatalogObjectParams] + """ + The `CatalogObject`s returned. + """ + + related_objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + A list of `CatalogObject`s referenced by the object in the `object` field. + """ diff --git a/src/square/requests/get_customer_custom_attribute_definition_response.py b/src/square/requests/get_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..44feb856 --- /dev/null +++ b/src/square/requests/get_customer_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class GetCustomerCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The retrieved custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_customer_custom_attribute_response.py b/src/square/requests/get_customer_custom_attribute_response.py new file mode 100644 index 00000000..0f1438e4 --- /dev/null +++ b/src/square/requests/get_customer_custom_attribute_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class GetCustomerCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_customer_group_response.py b/src/square/requests/get_customer_group_response.py new file mode 100644 index 00000000..615209dc --- /dev/null +++ b/src/square/requests/get_customer_group_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer_group import CustomerGroupParams + + +class GetCustomerGroupResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveCustomerGroup](api-endpoint:CustomerGroups-RetrieveCustomerGroup) endpoint. + + Either `errors` or `group` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + group: typing_extensions.NotRequired[CustomerGroupParams] + """ + The retrieved customer group. + """ diff --git a/src/square/requests/get_customer_response.py b/src/square/requests/get_customer_response.py new file mode 100644 index 00000000..56a8a33b --- /dev/null +++ b/src/square/requests/get_customer_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer import CustomerParams + + +class GetCustomerResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `RetrieveCustomer` endpoint. + + Either `errors` or `customer` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + customer: typing_extensions.NotRequired[CustomerParams] + """ + The requested customer. + """ diff --git a/src/square/requests/get_customer_segment_response.py b/src/square/requests/get_customer_segment_response.py new file mode 100644 index 00000000..d01d8d4f --- /dev/null +++ b/src/square/requests/get_customer_segment_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer_segment import CustomerSegmentParams + + +class GetCustomerSegmentResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body for requests to the `RetrieveCustomerSegment` endpoint. + + Either `errors` or `segment` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + segment: typing_extensions.NotRequired[CustomerSegmentParams] + """ + The retrieved customer segment. + """ diff --git a/src/square/requests/get_device_code_response.py b/src/square/requests/get_device_code_response.py new file mode 100644 index 00000000..353793b6 --- /dev/null +++ b/src/square/requests/get_device_code_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .device_code import DeviceCodeParams + + +class GetDeviceCodeResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + device_code: typing_extensions.NotRequired[DeviceCodeParams] + """ + The queried DeviceCode. + """ diff --git a/src/square/requests/get_device_response.py b/src/square/requests/get_device_response.py new file mode 100644 index 00000000..d8de606e --- /dev/null +++ b/src/square/requests/get_device_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .device import DeviceParams + + +class GetDeviceResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + device: typing_extensions.NotRequired[DeviceParams] + """ + The requested `Device`. + """ diff --git a/src/square/requests/get_dispute_evidence_response.py b/src/square/requests/get_dispute_evidence_response.py new file mode 100644 index 00000000..48a6bc91 --- /dev/null +++ b/src/square/requests/get_dispute_evidence_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute_evidence import DisputeEvidenceParams + + +class GetDisputeEvidenceResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in a `RetrieveDisputeEvidence` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + evidence: typing_extensions.NotRequired[DisputeEvidenceParams] + """ + Metadata about the dispute evidence file. + """ diff --git a/src/square/requests/get_dispute_response.py b/src/square/requests/get_dispute_response.py new file mode 100644 index 00000000..3952f3ae --- /dev/null +++ b/src/square/requests/get_dispute_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute import DisputeParams + + +class GetDisputeResponseParams(typing_extensions.TypedDict): + """ + Defines fields in a `RetrieveDispute` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + dispute: typing_extensions.NotRequired[DisputeParams] + """ + Details about the requested `Dispute`. + """ diff --git a/src/square/requests/get_employee_response.py b/src/square/requests/get_employee_response.py new file mode 100644 index 00000000..7bf6c3d3 --- /dev/null +++ b/src/square/requests/get_employee_response.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .employee import EmployeeParams +import typing +from .error import ErrorParams + + +class GetEmployeeResponseParams(typing_extensions.TypedDict): + employee: typing_extensions.NotRequired[EmployeeParams] + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_employee_wage_response.py b/src/square/requests/get_employee_wage_response.py new file mode 100644 index 00000000..e4e99196 --- /dev/null +++ b/src/square/requests/get_employee_wage_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .employee_wage import EmployeeWageParams +import typing +from .error import ErrorParams + + +class GetEmployeeWageResponseParams(typing_extensions.TypedDict): + """ + A response to a request to get an `EmployeeWage`. The response contains + the requested `EmployeeWage` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + employee_wage: typing_extensions.NotRequired[EmployeeWageParams] + """ + The requested `EmployeeWage` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_gift_card_from_gan_response.py b/src/square/requests/get_gift_card_from_gan_response.py new file mode 100644 index 00000000..7f598c9f --- /dev/null +++ b/src/square/requests/get_gift_card_from_gan_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class GetGiftCardFromGanResponseParams(typing_extensions.TypedDict): + """ + A response that contains a `GiftCard`. This response might contain a set of `Error` objects + if the request resulted in errors. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card: typing_extensions.NotRequired[GiftCardParams] + """ + A gift card that was fetched, if present. It returns empty if an error occurred. + """ diff --git a/src/square/requests/get_gift_card_from_nonce_response.py b/src/square/requests/get_gift_card_from_nonce_response.py new file mode 100644 index 00000000..c4ea7103 --- /dev/null +++ b/src/square/requests/get_gift_card_from_nonce_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class GetGiftCardFromNonceResponseParams(typing_extensions.TypedDict): + """ + A response that contains a `GiftCard` object. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card: typing_extensions.NotRequired[GiftCardParams] + """ + The retrieved gift card. + """ diff --git a/src/square/requests/get_gift_card_response.py b/src/square/requests/get_gift_card_response.py new file mode 100644 index 00000000..93eff8ef --- /dev/null +++ b/src/square/requests/get_gift_card_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class GetGiftCardResponseParams(typing_extensions.TypedDict): + """ + A response that contains a `GiftCard`. The response might contain a set of `Error` objects + if the request resulted in errors. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card: typing_extensions.NotRequired[GiftCardParams] + """ + The gift card retrieved. + """ diff --git a/src/square/requests/get_inventory_adjustment_response.py b/src/square/requests/get_inventory_adjustment_response.py new file mode 100644 index 00000000..749527d9 --- /dev/null +++ b/src/square/requests/get_inventory_adjustment_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_adjustment import InventoryAdjustmentParams + + +class GetInventoryAdjustmentResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + adjustment: typing_extensions.NotRequired[InventoryAdjustmentParams] + """ + The requested [InventoryAdjustment](entity:InventoryAdjustment). + """ diff --git a/src/square/requests/get_inventory_changes_response.py b/src/square/requests/get_inventory_changes_response.py new file mode 100644 index 00000000..d2fea3c0 --- /dev/null +++ b/src/square/requests/get_inventory_changes_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_change import InventoryChangeParams + + +class GetInventoryChangesResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + changes: typing_extensions.NotRequired[typing.Sequence[InventoryChangeParams]] + """ + The set of inventory changes for the requested object and locations. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ diff --git a/src/square/requests/get_inventory_count_response.py b/src/square/requests/get_inventory_count_response.py new file mode 100644 index 00000000..80fdab5d --- /dev/null +++ b/src/square/requests/get_inventory_count_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_count import InventoryCountParams + + +class GetInventoryCountResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + counts: typing_extensions.NotRequired[typing.Sequence[InventoryCountParams]] + """ + The current calculated inventory counts for the requested object and + locations. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ diff --git a/src/square/requests/get_inventory_physical_count_response.py b/src/square/requests/get_inventory_physical_count_response.py new file mode 100644 index 00000000..9b828080 --- /dev/null +++ b/src/square/requests/get_inventory_physical_count_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_physical_count import InventoryPhysicalCountParams + + +class GetInventoryPhysicalCountResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + count: typing_extensions.NotRequired[InventoryPhysicalCountParams] + """ + The requested [InventoryPhysicalCount](entity:InventoryPhysicalCount). + """ diff --git a/src/square/requests/get_inventory_transfer_response.py b/src/square/requests/get_inventory_transfer_response.py new file mode 100644 index 00000000..a68cab1f --- /dev/null +++ b/src/square/requests/get_inventory_transfer_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .inventory_transfer import InventoryTransferParams + + +class GetInventoryTransferResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + transfer: typing_extensions.NotRequired[InventoryTransferParams] + """ + The requested [InventoryTransfer](entity:InventoryTransfer). + """ diff --git a/src/square/requests/get_invoice_response.py b/src/square/requests/get_invoice_response.py new file mode 100644 index 00000000..ff8e43d5 --- /dev/null +++ b/src/square/requests/get_invoice_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .invoice import InvoiceParams +import typing +from .error import ErrorParams + + +class GetInvoiceResponseParams(typing_extensions.TypedDict): + """ + Describes a `GetInvoice` response. + """ + + invoice: typing_extensions.NotRequired[InvoiceParams] + """ + The invoice requested. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/get_location_response.py b/src/square/requests/get_location_response.py new file mode 100644 index 00000000..35980cba --- /dev/null +++ b/src/square/requests/get_location_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .location import LocationParams + + +class GetLocationResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that the [RetrieveLocation](api-endpoint:Locations-RetrieveLocation) + endpoint returns in a response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + location: typing_extensions.NotRequired[LocationParams] + """ + The requested location. + """ diff --git a/src/square/requests/get_loyalty_account_response.py b/src/square/requests/get_loyalty_account_response.py new file mode 100644 index 00000000..f726f45b --- /dev/null +++ b/src/square/requests/get_loyalty_account_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_account import LoyaltyAccountParams + + +class GetLoyaltyAccountResponseParams(typing_extensions.TypedDict): + """ + A response that includes the loyalty account. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_account: typing_extensions.NotRequired[LoyaltyAccountParams] + """ + The loyalty account. + """ diff --git a/src/square/requests/get_loyalty_program_response.py b/src/square/requests/get_loyalty_program_response.py new file mode 100644 index 00000000..49e7d8e0 --- /dev/null +++ b/src/square/requests/get_loyalty_program_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_program import LoyaltyProgramParams + + +class GetLoyaltyProgramResponseParams(typing_extensions.TypedDict): + """ + A response that contains the loyalty program. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + program: typing_extensions.NotRequired[LoyaltyProgramParams] + """ + The loyalty program that was requested. + """ diff --git a/src/square/requests/get_loyalty_promotion_response.py b/src/square/requests/get_loyalty_promotion_response.py new file mode 100644 index 00000000..2fb2eba1 --- /dev/null +++ b/src/square/requests/get_loyalty_promotion_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_promotion import LoyaltyPromotionParams + + +class GetLoyaltyPromotionResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion) response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_promotion: typing_extensions.NotRequired[LoyaltyPromotionParams] + """ + The retrieved loyalty promotion. + """ diff --git a/src/square/requests/get_loyalty_reward_response.py b/src/square/requests/get_loyalty_reward_response.py new file mode 100644 index 00000000..7ea8680e --- /dev/null +++ b/src/square/requests/get_loyalty_reward_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_reward import LoyaltyRewardParams + + +class GetLoyaltyRewardResponseParams(typing_extensions.TypedDict): + """ + A response that includes the loyalty reward. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + reward: typing_extensions.NotRequired[LoyaltyRewardParams] + """ + The loyalty reward retrieved. + """ diff --git a/src/square/requests/get_merchant_response.py b/src/square/requests/get_merchant_response.py new file mode 100644 index 00000000..47feec63 --- /dev/null +++ b/src/square/requests/get_merchant_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .merchant import MerchantParams + + +class GetMerchantResponseParams(typing_extensions.TypedDict): + """ + The response object returned by the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + merchant: typing_extensions.NotRequired[MerchantParams] + """ + The requested `Merchant` object. + """ diff --git a/src/square/requests/get_order_response.py b/src/square/requests/get_order_response.py new file mode 100644 index 00000000..ea07e619 --- /dev/null +++ b/src/square/requests/get_order_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .order import OrderParams +import typing +from .error import ErrorParams + + +class GetOrderResponseParams(typing_extensions.TypedDict): + order: typing_extensions.NotRequired[OrderParams] + """ + The requested order. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_payment_link_response.py b/src/square/requests/get_payment_link_response.py new file mode 100644 index 00000000..7e6fb922 --- /dev/null +++ b/src/square/requests/get_payment_link_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_link import PaymentLinkParams + + +class GetPaymentLinkResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + payment_link: typing_extensions.NotRequired[PaymentLinkParams] + """ + The payment link that is retrieved. + """ diff --git a/src/square/requests/get_payment_refund_response.py b/src/square/requests/get_payment_refund_response.py new file mode 100644 index 00000000..27016ac1 --- /dev/null +++ b/src/square/requests/get_payment_refund_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_refund import PaymentRefundParams + + +class GetPaymentRefundResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by [GetRefund](api-endpoint:Refunds-GetPaymentRefund). + + Note: If there are errors processing the request, the refund field might not be + present or it might be present in a FAILED state. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refund: typing_extensions.NotRequired[PaymentRefundParams] + """ + The requested `PaymentRefund`. + """ diff --git a/src/square/requests/get_payment_response.py b/src/square/requests/get_payment_response.py new file mode 100644 index 00000000..a89a9001 --- /dev/null +++ b/src/square/requests/get_payment_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment import PaymentParams + + +class GetPaymentResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by [GetPayment](api-endpoint:Payments-GetPayment). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + payment: typing_extensions.NotRequired[PaymentParams] + """ + The requested `Payment`. + """ diff --git a/src/square/requests/get_payout_response.py b/src/square/requests/get_payout_response.py new file mode 100644 index 00000000..a2f202fa --- /dev/null +++ b/src/square/requests/get_payout_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .payout import PayoutParams +import typing +from .error import ErrorParams + + +class GetPayoutResponseParams(typing_extensions.TypedDict): + payout: typing_extensions.NotRequired[PayoutParams] + """ + The requested payout. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/get_shift_response.py b/src/square/requests/get_shift_response.py new file mode 100644 index 00000000..418b94c4 --- /dev/null +++ b/src/square/requests/get_shift_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .shift import ShiftParams +import typing +from .error import ErrorParams + + +class GetShiftResponseParams(typing_extensions.TypedDict): + """ + A response to a request to get a `Shift`. The response contains + the requested `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shift: typing_extensions.NotRequired[ShiftParams] + """ + The requested `Shift`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_snippet_response.py b/src/square/requests/get_snippet_response.py new file mode 100644 index 00000000..efd72d2e --- /dev/null +++ b/src/square/requests/get_snippet_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .snippet import SnippetParams + + +class GetSnippetResponseParams(typing_extensions.TypedDict): + """ + Represents a `RetrieveSnippet` response. The response can include either `snippet` or `errors`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + snippet: typing_extensions.NotRequired[SnippetParams] + """ + The retrieved snippet. + """ diff --git a/src/square/requests/get_subscription_response.py b/src/square/requests/get_subscription_response.py new file mode 100644 index 00000000..34df0330 --- /dev/null +++ b/src/square/requests/get_subscription_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams + + +class GetSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The subscription retrieved. + """ diff --git a/src/square/requests/get_team_member_booking_profile_response.py b/src/square/requests/get_team_member_booking_profile_response.py new file mode 100644 index 00000000..754d5999 --- /dev/null +++ b/src/square/requests/get_team_member_booking_profile_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member_booking_profile import TeamMemberBookingProfileParams +import typing +from .error import ErrorParams + + +class GetTeamMemberBookingProfileResponseParams(typing_extensions.TypedDict): + team_member_booking_profile: typing_extensions.NotRequired[TeamMemberBookingProfileParams] + """ + The returned team member booking profile. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/get_team_member_response.py b/src/square/requests/get_team_member_response.py new file mode 100644 index 00000000..38f684d4 --- /dev/null +++ b/src/square/requests/get_team_member_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member import TeamMemberParams +import typing +from .error import ErrorParams + + +class GetTeamMemberResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a retrieve request containing a `TeamMember` object or error messages. + """ + + team_member: typing_extensions.NotRequired[TeamMemberParams] + """ + The successfully retrieved `TeamMember` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/get_team_member_wage_response.py b/src/square/requests/get_team_member_wage_response.py new file mode 100644 index 00000000..e9b44031 --- /dev/null +++ b/src/square/requests/get_team_member_wage_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member_wage import TeamMemberWageParams +import typing +from .error import ErrorParams + + +class GetTeamMemberWageResponseParams(typing_extensions.TypedDict): + """ + A response to a request to get a `TeamMemberWage`. The response contains + the requested `TeamMemberWage` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + team_member_wage: typing_extensions.NotRequired[TeamMemberWageParams] + """ + The requested `TeamMemberWage` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/get_terminal_action_response.py b/src/square/requests/get_terminal_action_response.py new file mode 100644 index 00000000..9ec90205 --- /dev/null +++ b/src/square/requests/get_terminal_action_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_action import TerminalActionParams + + +class GetTerminalActionResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + action: typing_extensions.NotRequired[TerminalActionParams] + """ + The requested `TerminalAction` + """ diff --git a/src/square/requests/get_terminal_checkout_response.py b/src/square/requests/get_terminal_checkout_response.py new file mode 100644 index 00000000..d3644296 --- /dev/null +++ b/src/square/requests/get_terminal_checkout_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_checkout import TerminalCheckoutParams + + +class GetTerminalCheckoutResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + checkout: typing_extensions.NotRequired[TerminalCheckoutParams] + """ + The requested `TerminalCheckout`. + """ diff --git a/src/square/requests/get_terminal_refund_response.py b/src/square/requests/get_terminal_refund_response.py new file mode 100644 index 00000000..e79a9fa7 --- /dev/null +++ b/src/square/requests/get_terminal_refund_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_refund import TerminalRefundParams + + +class GetTerminalRefundResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refund: typing_extensions.NotRequired[TerminalRefundParams] + """ + The requested `Refund`. + """ diff --git a/src/square/requests/get_transaction_response.py b/src/square/requests/get_transaction_response.py new file mode 100644 index 00000000..87522023 --- /dev/null +++ b/src/square/requests/get_transaction_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .transaction import TransactionParams + + +class GetTransactionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint. + + One of `errors` or `transaction` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + transaction: typing_extensions.NotRequired[TransactionParams] + """ + The requested transaction. + """ diff --git a/src/square/requests/get_vendor_response.py b/src/square/requests/get_vendor_response.py new file mode 100644 index 00000000..8f461879 --- /dev/null +++ b/src/square/requests/get_vendor_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .vendor import VendorParams + + +class GetVendorResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered when the request fails. + """ + + vendor: typing_extensions.NotRequired[VendorParams] + """ + The successfully retrieved [Vendor](entity:Vendor) object. + """ diff --git a/src/square/requests/get_wage_setting_response.py b/src/square/requests/get_wage_setting_response.py new file mode 100644 index 00000000..4e0c6ae8 --- /dev/null +++ b/src/square/requests/get_wage_setting_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .wage_setting import WageSettingParams +import typing +from .error import ErrorParams + + +class GetWageSettingResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a retrieve request containing the specified `WageSetting` object or error messages. + """ + + wage_setting: typing_extensions.NotRequired[WageSettingParams] + """ + The successfully retrieved `WageSetting` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/get_webhook_subscription_response.py b/src/square/requests/get_webhook_subscription_response.py new file mode 100644 index 00000000..c0e41df1 --- /dev/null +++ b/src/square/requests/get_webhook_subscription_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .webhook_subscription import WebhookSubscriptionParams + + +class GetWebhookSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveWebhookSubscription](api-endpoint:WebhookSubscriptions-RetrieveWebhookSubscription) endpoint. + + Note: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[WebhookSubscriptionParams] + """ + The requested [Subscription](entity:WebhookSubscription). + """ diff --git a/src/square/requests/gift_card.py b/src/square/requests/gift_card.py new file mode 100644 index 00000000..84a063a1 --- /dev/null +++ b/src/square/requests/gift_card.py @@ -0,0 +1,63 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.gift_card_type import GiftCardType +from ..types.gift_card_gan_source import GiftCardGanSource +from ..types.gift_card_status import GiftCardStatus +from .money import MoneyParams +import typing + + +class GiftCardParams(typing_extensions.TypedDict): + """ + Represents a Square gift card. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the gift card. + """ + + type: GiftCardType + """ + The gift card type. + See [Type](#type-type) for possible values + """ + + gan_source: typing_extensions.NotRequired[GiftCardGanSource] + """ + The source that generated the gift card account number (GAN). The default value is `SQUARE`. + See [GANSource](#type-gansource) for possible values + """ + + state: typing_extensions.NotRequired[GiftCardStatus] + """ + The current gift card state. + See [Status](#type-status) for possible values + """ + + balance_money: typing_extensions.NotRequired[MoneyParams] + """ + The current gift card balance. This balance is always greater than or equal to zero. + """ + + gan: typing_extensions.NotRequired[typing.Optional[str]] + """ + The gift card account number (GAN). Buyers can use the GAN to make purchases or check + the gift card balance. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the gift card was created, in RFC 3339 format. + In the case of a digital gift card, it is the time when you create a card + (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API). + In the case of a plastic gift card, it is the time when Square associates the card with the + seller at the time of activation. + """ + + customer_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked. + """ diff --git a/src/square/requests/gift_card_activity.py b/src/square/requests/gift_card_activity.py new file mode 100644 index 00000000..e20ae638 --- /dev/null +++ b/src/square/requests/gift_card_activity.py @@ -0,0 +1,165 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.gift_card_activity_type import GiftCardActivityType +import typing +from .money import MoneyParams +from .gift_card_activity_load import GiftCardActivityLoadParams +from .gift_card_activity_activate import GiftCardActivityActivateParams +from .gift_card_activity_redeem import GiftCardActivityRedeemParams +from .gift_card_activity_clear_balance import GiftCardActivityClearBalanceParams +from .gift_card_activity_deactivate import GiftCardActivityDeactivateParams +from .gift_card_activity_adjust_increment import GiftCardActivityAdjustIncrementParams +from .gift_card_activity_adjust_decrement import GiftCardActivityAdjustDecrementParams +from .gift_card_activity_refund import GiftCardActivityRefundParams +from .gift_card_activity_unlinked_activity_refund import GiftCardActivityUnlinkedActivityRefundParams +from .gift_card_activity_import import GiftCardActivityImportParams +from .gift_card_activity_block import GiftCardActivityBlockParams +from .gift_card_activity_unblock import GiftCardActivityUnblockParams +from .gift_card_activity_import_reversal import GiftCardActivityImportReversalParams +from .gift_card_activity_transfer_balance_to import GiftCardActivityTransferBalanceToParams +from .gift_card_activity_transfer_balance_from import GiftCardActivityTransferBalanceFromParams + + +class GiftCardActivityParams(typing_extensions.TypedDict): + """ + Represents an action performed on a [gift card](entity:GiftCard) that affects its state or balance. + A gift card activity contains information about a specific activity type. For example, a `REDEEM` activity + includes a `redeem_activity_details` field that contains information about the redemption. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the gift card activity. + """ + + type: GiftCardActivityType + """ + The type of gift card activity. + See [Type](#type-type) for possible values + """ + + location_id: str + """ + The ID of the [business location](entity:Location) where the activity occurred. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the gift card activity was created, in RFC 3339 format. + """ + + gift_card_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The gift card ID. When creating a gift card activity, `gift_card_id` is not required if + `gift_card_gan` is specified. + """ + + gift_card_gan: typing_extensions.NotRequired[typing.Optional[str]] + """ + The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` + is not required if `gift_card_id` is specified. + """ + + gift_card_balance_money: typing_extensions.NotRequired[MoneyParams] + """ + The final balance on the gift card after the action is completed. + """ + + load_activity_details: typing_extensions.NotRequired[GiftCardActivityLoadParams] + """ + Additional details about a `LOAD` activity, which is used to reload money onto a gift card. + """ + + activate_activity_details: typing_extensions.NotRequired[GiftCardActivityActivateParams] + """ + Additional details about an `ACTIVATE` activity, which is used to activate a gift card with + an initial balance. + """ + + redeem_activity_details: typing_extensions.NotRequired[GiftCardActivityRedeemParams] + """ + Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase. + + For applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that + updates the gift card balance after the corresponding [CreatePayment](api-endpoint:Payments-CreatePayment) + request is completed. Applications that use a custom payment processing system must call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REDEEM` activity. + """ + + clear_balance_activity_details: typing_extensions.NotRequired[GiftCardActivityClearBalanceParams] + """ + Additional details about a `CLEAR_BALANCE` activity, which is used to set the balance of a gift card to zero. + """ + + deactivate_activity_details: typing_extensions.NotRequired[GiftCardActivityDeactivateParams] + """ + Additional details about a `DEACTIVATE` activity, which is used to deactivate a gift card. + """ + + adjust_increment_activity_details: typing_extensions.NotRequired[GiftCardActivityAdjustIncrementParams] + """ + Additional details about an `ADJUST_INCREMENT` activity, which is used to add money to a gift card + outside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow. + """ + + adjust_decrement_activity_details: typing_extensions.NotRequired[GiftCardActivityAdjustDecrementParams] + """ + Additional details about an `ADJUST_DECREMENT` activity, which is used to deduct money from a gift + card outside of a typical `REDEEM` activity flow. + """ + + refund_activity_details: typing_extensions.NotRequired[GiftCardActivityRefundParams] + """ + Additional details about a `REFUND` activity, which is used to add money to a gift card when + refunding a payment. + + For applications that refund payments to a gift card using the Square Refunds API, Square automatically + creates a `REFUND` activity that updates the gift card balance after a [RefundPayment](api-endpoint:Refunds-RefundPayment) + request is completed. Applications that use a custom processing system must call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REFUND` activity. + """ + + unlinked_activity_refund_activity_details: typing_extensions.NotRequired[ + GiftCardActivityUnlinkedActivityRefundParams + ] + """ + Additional details about an `UNLINKED_ACTIVITY_REFUND` activity. This activity is used to add money + to a gift card when refunding a payment that was processed using a custom payment processing system + and not linked to the gift card. + """ + + import_activity_details: typing_extensions.NotRequired[GiftCardActivityImportParams] + """ + Additional details about an `IMPORT` activity, which Square uses to import a third-party + gift card with a balance. + """ + + block_activity_details: typing_extensions.NotRequired[GiftCardActivityBlockParams] + """ + Additional details about a `BLOCK` activity, which Square uses to temporarily block a gift card. + """ + + unblock_activity_details: typing_extensions.NotRequired[GiftCardActivityUnblockParams] + """ + Additional details about an `UNBLOCK` activity, which Square uses to unblock a gift card. + """ + + import_reversal_activity_details: typing_extensions.NotRequired[GiftCardActivityImportReversalParams] + """ + Additional details about an `IMPORT_REVERSAL` activity, which Square uses to reverse the + import of a third-party gift card. + """ + + transfer_balance_to_activity_details: typing_extensions.NotRequired[GiftCardActivityTransferBalanceToParams] + """ + Additional details about a `TRANSFER_BALANCE_TO` activity, which Square uses to add money to + a gift card as the result of a transfer from another gift card. + """ + + transfer_balance_from_activity_details: typing_extensions.NotRequired[GiftCardActivityTransferBalanceFromParams] + """ + Additional details about a `TRANSFER_BALANCE_FROM` activity, which Square uses to deduct money from + a gift as the result of a transfer to another gift card. + """ diff --git a/src/square/requests/gift_card_activity_activate.py b/src/square/requests/gift_card_activity_activate.py new file mode 100644 index 00000000..ddfe1e91 --- /dev/null +++ b/src/square/requests/gift_card_activity_activate.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +import typing + + +class GiftCardActivityActivateParams(typing_extensions.TypedDict): + """ + Represents details about an `ACTIVATE` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount added to the gift card. This value is a positive integer. + + Applications that use a custom order processing system must specify this amount in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item. + + Applications that use the Square Orders API to process orders must specify the order ID + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + line_item_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase. + + Applications that use the Square Orders API to process orders must specify the line item UID + in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-specified ID that associates the gift card activity with an entity in another system. + + Applications that use a custom order processing system can use this field to track information + related to an order or payment. + """ + + buyer_payment_instrument_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The payment instrument IDs used to process the gift card purchase, such as a credit card ID + or bank account ID. + + Applications that use a custom order processing system must specify payment instrument IDs in + the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + Square uses this information to perform compliance checks. + + For applications that use the Square Orders API to process payments, Square has the necessary + instrument IDs to perform compliance checks. + + Each buyer payment instrument ID can contain a maximum of 255 characters. + """ diff --git a/src/square/requests/gift_card_activity_adjust_decrement.py b/src/square/requests/gift_card_activity_adjust_decrement.py new file mode 100644 index 00000000..69c06609 --- /dev/null +++ b/src/square/requests/gift_card_activity_adjust_decrement.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +from ..types.gift_card_activity_adjust_decrement_reason import GiftCardActivityAdjustDecrementReason + + +class GiftCardActivityAdjustDecrementParams(typing_extensions.TypedDict): + """ + Represents details about an `ADJUST_DECREMENT` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: MoneyParams + """ + The amount deducted from the gift card balance. This value is a positive integer. + """ + + reason: GiftCardActivityAdjustDecrementReason + """ + The reason the gift card balance was adjusted. + See [Reason](#type-reason) for possible values + """ diff --git a/src/square/requests/gift_card_activity_adjust_increment.py b/src/square/requests/gift_card_activity_adjust_increment.py new file mode 100644 index 00000000..47ec6b66 --- /dev/null +++ b/src/square/requests/gift_card_activity_adjust_increment.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +from ..types.gift_card_activity_adjust_increment_reason import GiftCardActivityAdjustIncrementReason + + +class GiftCardActivityAdjustIncrementParams(typing_extensions.TypedDict): + """ + Represents details about an `ADJUST_INCREMENT` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: MoneyParams + """ + The amount added to the gift card balance. This value is a positive integer. + """ + + reason: GiftCardActivityAdjustIncrementReason + """ + The reason the gift card balance was adjusted. + See [Reason](#type-reason) for possible values + """ diff --git a/src/square/requests/gift_card_activity_block.py b/src/square/requests/gift_card_activity_block.py new file mode 100644 index 00000000..1de87927 --- /dev/null +++ b/src/square/requests/gift_card_activity_block.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.gift_card_activity_block_reason import GiftCardActivityBlockReason + + +class GiftCardActivityBlockParams(typing_extensions.TypedDict): + """ + Represents details about a `BLOCK` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityBlockReason + """ + The reason the gift card was blocked. + See [Reason](#type-reason) for possible values + """ diff --git a/src/square/requests/gift_card_activity_clear_balance.py b/src/square/requests/gift_card_activity_clear_balance.py new file mode 100644 index 00000000..20f74ee7 --- /dev/null +++ b/src/square/requests/gift_card_activity_clear_balance.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.gift_card_activity_clear_balance_reason import GiftCardActivityClearBalanceReason + + +class GiftCardActivityClearBalanceParams(typing_extensions.TypedDict): + """ + Represents details about a `CLEAR_BALANCE` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityClearBalanceReason + """ + The reason the gift card balance was cleared. + See [Reason](#type-reason) for possible values + """ diff --git a/src/square/requests/gift_card_activity_deactivate.py b/src/square/requests/gift_card_activity_deactivate.py new file mode 100644 index 00000000..a006a960 --- /dev/null +++ b/src/square/requests/gift_card_activity_deactivate.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.gift_card_activity_deactivate_reason import GiftCardActivityDeactivateReason + + +class GiftCardActivityDeactivateParams(typing_extensions.TypedDict): + """ + Represents details about a `DEACTIVATE` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityDeactivateReason + """ + The reason the gift card was deactivated. + See [Reason](#type-reason) for possible values + """ diff --git a/src/square/requests/gift_card_activity_import.py b/src/square/requests/gift_card_activity_import.py new file mode 100644 index 00000000..1ceb4bcb --- /dev/null +++ b/src/square/requests/gift_card_activity_import.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class GiftCardActivityImportParams(typing_extensions.TypedDict): + """ + Represents details about an `IMPORT` [gift card activity type](entity:GiftCardActivityType). + This activity type is used when Square imports a third-party gift card, in which case the + `gan_source` of the gift card is set to `OTHER`. + """ + + amount_money: MoneyParams + """ + The balance amount on the imported gift card. + """ diff --git a/src/square/requests/gift_card_activity_import_reversal.py b/src/square/requests/gift_card_activity_import_reversal.py new file mode 100644 index 00000000..e07be00b --- /dev/null +++ b/src/square/requests/gift_card_activity_import_reversal.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class GiftCardActivityImportReversalParams(typing_extensions.TypedDict): + """ + Represents details about an `IMPORT_REVERSAL` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: MoneyParams + """ + The amount of money cleared from the third-party gift card when + the import was reversed. + """ diff --git a/src/square/requests/gift_card_activity_load.py b/src/square/requests/gift_card_activity_load.py new file mode 100644 index 00000000..32dcb1df --- /dev/null +++ b/src/square/requests/gift_card_activity_load.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +import typing + + +class GiftCardActivityLoadParams(typing_extensions.TypedDict): + """ + Represents details about a `LOAD` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount added to the gift card. This value is a positive integer. + + Applications that use a custom order processing system must specify this amount in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item. + + Applications that use the Square Orders API to process orders must specify the order ID in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + line_item_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card. + + Applications that use the Square Orders API to process orders must specify the line item UID + in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-specified ID that associates the gift card activity with an entity in another system. + + Applications that use a custom order processing system can use this field to track information related to + an order or payment. + """ + + buyer_payment_instrument_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The payment instrument IDs used to process the order for the additional funds, such as a credit card ID + or bank account ID. + + Applications that use a custom order processing system must specify payment instrument IDs in + the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + Square uses this information to perform compliance checks. + + For applications that use the Square Orders API to process payments, Square has the necessary + instrument IDs to perform compliance checks. + + Each buyer payment instrument ID can contain a maximum of 255 characters. + """ diff --git a/src/square/requests/gift_card_activity_redeem.py b/src/square/requests/gift_card_activity_redeem.py new file mode 100644 index 00000000..eb1d2fc4 --- /dev/null +++ b/src/square/requests/gift_card_activity_redeem.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +import typing_extensions +import typing +from ..types.gift_card_activity_redeem_status import GiftCardActivityRedeemStatus + + +class GiftCardActivityRedeemParams(typing_extensions.TypedDict): + """ + Represents details about a `REDEEM` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: MoneyParams + """ + The amount deducted from the gift card for the redemption. This value is a positive integer. + + Applications that use a custom payment processing system must specify this amount in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + payment_id: typing_extensions.NotRequired[str] + """ + The ID of the payment that represents the gift card redemption. Square populates this field + if the payment was processed by Square. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-specified ID that associates the gift card activity with an entity in another system. + + Applications that use a custom payment processing system can use this field to track information + related to an order or payment. + """ + + status: typing_extensions.NotRequired[GiftCardActivityRedeemStatus] + """ + The status of the gift card redemption. Gift cards redeemed from Square Point of Sale or the + Square Seller Dashboard use a two-state process: `PENDING` + to `COMPLETED` or `PENDING` to `CANCELED`. Gift cards redeemed using the Gift Card Activities API + always have a `COMPLETED` status. + See [Status](#type-status) for possible values + """ diff --git a/src/square/requests/gift_card_activity_refund.py b/src/square/requests/gift_card_activity_refund.py new file mode 100644 index 00000000..47bb24fc --- /dev/null +++ b/src/square/requests/gift_card_activity_refund.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class GiftCardActivityRefundParams(typing_extensions.TypedDict): + """ + Represents details about a `REFUND` [gift card activity type](entity:GiftCardActivityType). + """ + + redeem_activity_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the refunded `REDEEM` gift card activity. Square populates this field if the + `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request + represents a gift card redemption. + + For applications that use a custom payment processing system, this field is required when creating + a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount added to the gift card for the refund. This value is a positive integer. + + This field is required when creating a `REFUND` activity. The amount can represent a full or partial refund. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-specified ID that associates the gift card activity with an entity in another system. + """ + + payment_id: typing_extensions.NotRequired[str] + """ + The ID of the refunded payment. Square populates this field if the refund is for a + payment processed by Square. This field matches the `payment_id` in the corresponding + [RefundPayment](api-endpoint:Refunds-RefundPayment) request. + """ diff --git a/src/square/requests/gift_card_activity_transfer_balance_from.py b/src/square/requests/gift_card_activity_transfer_balance_from.py new file mode 100644 index 00000000..2bdfc78a --- /dev/null +++ b/src/square/requests/gift_card_activity_transfer_balance_from.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class GiftCardActivityTransferBalanceFromParams(typing_extensions.TypedDict): + """ + Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](entity:GiftCardActivityType). + """ + + transfer_to_gift_card_id: str + """ + The ID of the gift card to which the specified amount was transferred. + """ + + amount_money: MoneyParams + """ + The amount deducted from the gift card for the transfer. This value is a positive integer. + """ diff --git a/src/square/requests/gift_card_activity_transfer_balance_to.py b/src/square/requests/gift_card_activity_transfer_balance_to.py new file mode 100644 index 00000000..3953168a --- /dev/null +++ b/src/square/requests/gift_card_activity_transfer_balance_to.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class GiftCardActivityTransferBalanceToParams(typing_extensions.TypedDict): + """ + Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](entity:GiftCardActivityType). + """ + + transfer_from_gift_card_id: str + """ + The ID of the gift card from which the specified amount was transferred. + """ + + amount_money: MoneyParams + """ + The amount added to the gift card balance for the transfer. This value is a positive integer. + """ diff --git a/src/square/requests/gift_card_activity_unblock.py b/src/square/requests/gift_card_activity_unblock.py new file mode 100644 index 00000000..c1a8dd96 --- /dev/null +++ b/src/square/requests/gift_card_activity_unblock.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.gift_card_activity_unblock_reason import GiftCardActivityUnblockReason + + +class GiftCardActivityUnblockParams(typing_extensions.TypedDict): + """ + Represents details about an `UNBLOCK` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityUnblockReason + """ + The reason the gift card was unblocked. + See [Reason](#type-reason) for possible values + """ diff --git a/src/square/requests/gift_card_activity_unlinked_activity_refund.py b/src/square/requests/gift_card_activity_unlinked_activity_refund.py new file mode 100644 index 00000000..8e28e967 --- /dev/null +++ b/src/square/requests/gift_card_activity_unlinked_activity_refund.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +import typing_extensions +import typing + + +class GiftCardActivityUnlinkedActivityRefundParams(typing_extensions.TypedDict): + """ + Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: MoneyParams + """ + The amount added to the gift card for the refund. This value is a positive integer. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-specified ID that associates the gift card activity with an entity in another system. + """ + + payment_id: typing_extensions.NotRequired[str] + """ + The ID of the refunded payment. This field is not used starting in Square version 2022-06-16. + """ diff --git a/src/square/requests/inventory_adjustment.py b/src/square/requests/inventory_adjustment.py new file mode 100644 index 00000000..97e8a5ff --- /dev/null +++ b/src/square/requests/inventory_adjustment.py @@ -0,0 +1,140 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.inventory_state import InventoryState +from .money import MoneyParams +from .source_application import SourceApplicationParams +from .inventory_adjustment_group import InventoryAdjustmentGroupParams + + +class InventoryAdjustmentParams(typing_extensions.TypedDict): + """ + Represents a change in state or quantity of product inventory at a + particular time and location. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID generated by Square for the + `InventoryAdjustment`. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional ID provided by the application to tie the + `InventoryAdjustment` to an external + system. + """ + + from_state: typing_extensions.NotRequired[InventoryState] + """ + The [inventory state](entity:InventoryState) of the related quantity + of items before the adjustment. + See [InventoryState](#type-inventorystate) for possible values + """ + + to_state: typing_extensions.NotRequired[InventoryState] + """ + The [inventory state](entity:InventoryState) of the related quantity + of items after the adjustment. + See [InventoryState](#type-inventorystate) for possible values + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items is being tracked. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + quantity: typing_extensions.NotRequired[typing.Optional[str]] + """ + The number of items affected by the adjustment as a decimal string. + Can support up to 5 digits after the decimal point. + """ + + total_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The total price paid for goods associated with the + adjustment. Present if and only if `to_state` is `SOLD`. Always + non-negative. + """ + + occurred_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-generated RFC 3339-formatted timestamp that indicates when + the inventory adjustment took place. For inventory adjustment updates, the `occurred_at` + timestamp cannot be older than 24 hours or in the future relative to the + time of the request. + """ + + created_at: typing_extensions.NotRequired[str] + """ + An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received. + """ + + source: typing_extensions.NotRequired[SourceApplicationParams] + """ + Information about the application that caused the + inventory adjustment. + """ + + employee_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Employee](entity:Employee) responsible for the + inventory adjustment. + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the + inventory adjustment. + """ + + transaction_id: typing_extensions.NotRequired[str] + """ + The Square-generated ID of the [Transaction](entity:Transaction) that + caused the adjustment. Only relevant for payment-related state + transitions. + """ + + refund_id: typing_extensions.NotRequired[str] + """ + The Square-generated ID of the [Refund](entity:Refund) that + caused the adjustment. Only relevant for refund-related state + transitions. + """ + + purchase_order_id: typing_extensions.NotRequired[str] + """ + The Square-generated ID of the purchase order that caused the + adjustment. Only relevant for state transitions from the Square for Retail + app. + """ + + goods_receipt_id: typing_extensions.NotRequired[str] + """ + The Square-generated ID of the goods receipt that caused the + adjustment. Only relevant for state transitions from the Square for Retail + app. + """ + + adjustment_group: typing_extensions.NotRequired[InventoryAdjustmentGroupParams] + """ + An adjustment group bundling the related adjustments of item variations through stock conversions in a single inventory event. + """ diff --git a/src/square/requests/inventory_adjustment_group.py b/src/square/requests/inventory_adjustment_group.py new file mode 100644 index 00000000..89a5dd2d --- /dev/null +++ b/src/square/requests/inventory_adjustment_group.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.inventory_state import InventoryState + + +class InventoryAdjustmentGroupParams(typing_extensions.TypedDict): + id: typing_extensions.NotRequired[str] + """ + A unique ID generated by Square for the + `InventoryAdjustmentGroup`. + """ + + root_adjustment_id: typing_extensions.NotRequired[str] + """ + The inventory adjustment of the composed variation. + """ + + from_state: typing_extensions.NotRequired[InventoryState] + """ + Representative `from_state` for adjustments within the group. For example, for a group adjustment from `IN_STOCK` to `SOLD`, + there can be two component adjustments in the group: one from `IN_STOCK`to `COMPOSED` and the other one from `COMPOSED` to `SOLD`. + Here, the representative `from_state` for the `InventoryAdjustmentGroup` is `IN_STOCK`. + See [InventoryState](#type-inventorystate) for possible values + """ + + to_state: typing_extensions.NotRequired[InventoryState] + """ + Representative `to_state` for adjustments within group. For example, for a group adjustment from `IN_STOCK` to `SOLD`, + the two component adjustments in the group can be from `IN_STOCK` to `COMPOSED` and from `COMPOSED` to `SOLD`. + Here, the representative `to_state` of the `InventoryAdjustmentGroup` is `SOLD`. + See [InventoryState](#type-inventorystate) for possible values + """ diff --git a/src/square/requests/inventory_change.py b/src/square/requests/inventory_change.py new file mode 100644 index 00000000..ba506b17 --- /dev/null +++ b/src/square/requests/inventory_change.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.inventory_change_type import InventoryChangeType +from .inventory_physical_count import InventoryPhysicalCountParams +from .inventory_adjustment import InventoryAdjustmentParams +from .inventory_transfer import InventoryTransferParams +from .catalog_measurement_unit import CatalogMeasurementUnitParams + + +class InventoryChangeParams(typing_extensions.TypedDict): + """ + Represents a single physical count, inventory, adjustment, or transfer + that is part of the history of inventory changes for a particular + [CatalogObject](entity:CatalogObject) instance. + """ + + type: typing_extensions.NotRequired[InventoryChangeType] + """ + Indicates how the inventory change is applied. See + [InventoryChangeType](entity:InventoryChangeType) for all possible values. + See [InventoryChangeType](#type-inventorychangetype) for possible values + """ + + physical_count: typing_extensions.NotRequired[InventoryPhysicalCountParams] + """ + Contains details about the physical count when `type` is + `PHYSICAL_COUNT`, and is unset for all other change types. + """ + + adjustment: typing_extensions.NotRequired[InventoryAdjustmentParams] + """ + Contains details about the inventory adjustment when `type` is + `ADJUSTMENT`, and is unset for all other change types. + """ + + transfer: typing_extensions.NotRequired[InventoryTransferParams] + """ + Contains details about the inventory transfer when `type` is + `TRANSFER`, and is unset for all other change types. + + _Note:_ An [InventoryTransfer](entity:InventoryTransfer) object can only be set in the input to the + [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) endpoint when the seller has an active Retail Plus subscription. + """ + + measurement_unit: typing_extensions.NotRequired[CatalogMeasurementUnitParams] + """ + The [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. + """ + + measurement_unit_id: typing_extensions.NotRequired[str] + """ + The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. + """ diff --git a/src/square/requests/inventory_count.py b/src/square/requests/inventory_count.py new file mode 100644 index 00000000..4b24d864 --- /dev/null +++ b/src/square/requests/inventory_count.py @@ -0,0 +1,62 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.inventory_state import InventoryState + + +class InventoryCountParams(typing_extensions.TypedDict): + """ + Represents Square-estimated quantity of items in a particular state at a + particular seller location based on the known history of physical counts and + inventory adjustments. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + state: typing_extensions.NotRequired[InventoryState] + """ + The current [inventory state](entity:InventoryState) for the related + quantity of items. + See [InventoryState](#type-inventorystate) for possible values + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items is being tracked. + """ + + quantity: typing_extensions.NotRequired[typing.Optional[str]] + """ + The number of items affected by the estimated count as a decimal string. + Can support up to 5 digits after the decimal point. + """ + + calculated_at: typing_extensions.NotRequired[str] + """ + An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting + the estimated count is received. + """ + + is_estimated: typing_extensions.NotRequired[bool] + """ + Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of + any of these endpoints: [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory), + [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges), + [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts), and + [RetrieveInventoryChanges](api-endpoint:Inventory-RetrieveInventoryChanges). + """ diff --git a/src/square/requests/inventory_physical_count.py b/src/square/requests/inventory_physical_count.py new file mode 100644 index 00000000..2c0e28bd --- /dev/null +++ b/src/square/requests/inventory_physical_count.py @@ -0,0 +1,93 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.inventory_state import InventoryState +from .source_application import SourceApplicationParams + + +class InventoryPhysicalCountParams(typing_extensions.TypedDict): + """ + Represents the quantity of an item variation that is physically present + at a specific location, verified by a seller or a seller's employee. For example, + a physical count might come from an employee counting the item variations on + hand or from syncing with an external system. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique Square-generated ID for the + [InventoryPhysicalCount](entity:InventoryPhysicalCount). + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional ID provided by the application to tie the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external + system. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + state: typing_extensions.NotRequired[InventoryState] + """ + The current [inventory state](entity:InventoryState) for the related + quantity of items. + See [InventoryState](#type-inventorystate) for possible values + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items is being tracked. + """ + + quantity: typing_extensions.NotRequired[typing.Optional[str]] + """ + The number of items affected by the physical count as a decimal string. + The number can support up to 5 digits after the decimal point. + """ + + source: typing_extensions.NotRequired[SourceApplicationParams] + """ + Information about the application with which the + physical count is submitted. + """ + + employee_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Employee](entity:Employee) responsible for the + physical count. + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the + physical count. + """ + + occurred_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-generated RFC 3339-formatted timestamp that indicates when + the physical count was examined. For physical count updates, the `occurred_at` + timestamp cannot be older than 24 hours or in the future relative to the + time of the request. + """ + + created_at: typing_extensions.NotRequired[str] + """ + An RFC 3339-formatted timestamp that indicates when the physical count is received. + """ diff --git a/src/square/requests/inventory_transfer.py b/src/square/requests/inventory_transfer.py new file mode 100644 index 00000000..722bbd42 --- /dev/null +++ b/src/square/requests/inventory_transfer.py @@ -0,0 +1,97 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.inventory_state import InventoryState +from .source_application import SourceApplicationParams + + +class InventoryTransferParams(typing_extensions.TypedDict): + """ + Represents the transfer of a quantity of product inventory at a + particular time from one location to another. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID generated by Square for the + `InventoryTransfer`. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional ID provided by the application to tie the + `InventoryTransfer` to an external system. + """ + + state: typing_extensions.NotRequired[InventoryState] + """ + The [inventory state](entity:InventoryState) for the quantity of + items being transferred. + See [InventoryState](#type-inventorystate) for possible values + """ + + from_location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items was tracked before the transfer. + """ + + to_location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items was tracked after the transfer. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + quantity: typing_extensions.NotRequired[typing.Optional[str]] + """ + The number of items affected by the transfer as a decimal string. + Can support up to 5 digits after the decimal point. + """ + + occurred_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-generated RFC 3339-formatted timestamp that indicates when + the transfer took place. For write actions, the `occurred_at` timestamp + cannot be older than 24 hours or in the future relative to the time of the + request. + """ + + created_at: typing_extensions.NotRequired[str] + """ + An RFC 3339-formatted timestamp that indicates when Square + received the transfer request. + """ + + source: typing_extensions.NotRequired[SourceApplicationParams] + """ + Information about the application that initiated the + inventory transfer. + """ + + employee_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Employee](entity:Employee) responsible for the + inventory transfer. + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the + inventory transfer. + """ diff --git a/src/square/requests/invoice.py b/src/square/requests/invoice.py new file mode 100644 index 00000000..e8bf725a --- /dev/null +++ b/src/square/requests/invoice.py @@ -0,0 +1,215 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .invoice_recipient import InvoiceRecipientParams +from .invoice_payment_request import InvoicePaymentRequestParams +from ..types.invoice_delivery_method import InvoiceDeliveryMethod +from .money import MoneyParams +from ..types.invoice_status import InvoiceStatus +from .invoice_accepted_payment_methods import InvoiceAcceptedPaymentMethodsParams +from .invoice_custom_field import InvoiceCustomFieldParams +from .invoice_attachment import InvoiceAttachmentParams + + +class InvoiceParams(typing_extensions.TypedDict): + """ + Stores information about an invoice. You use the Invoices API to create and manage + invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the invoice. + """ + + version: typing_extensions.NotRequired[int] + """ + The Square-assigned version number, which is incremented each time an update is committed to the invoice. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the location that this invoice is associated with. + + If specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [order](entity:Order) for which the invoice is created. + This field is required when creating an invoice, and the order must be in the `OPEN` state. + + To view the line items and other information for the associated order, call the + [RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID. + """ + + primary_recipient: typing_extensions.NotRequired[InvoiceRecipientParams] + """ + The customer who receives the invoice. This customer data is displayed on the invoice and used by Square to deliver the invoice. + + This field is required to publish an invoice, and it must specify the `customer_id`. + """ + + payment_requests: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InvoicePaymentRequestParams]]] + """ + The payment schedule for the invoice, represented by one or more payment requests that + define payment settings, such as amount due and due date. An invoice supports the following payment request combinations: + - One balance + - One deposit with one balance + - 2–12 installments + - One deposit with 2–12 installments + + This field is required when creating an invoice. It must contain at least one payment request. + All payment requests for the invoice must equal the total order amount. For more information, see + [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + + Adding `INSTALLMENT` payment requests to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + """ + + delivery_method: typing_extensions.NotRequired[InvoiceDeliveryMethod] + """ + The delivery method that Square uses to send the invoice, reminders, and receipts to + the customer. After the invoice is published, Square processes the invoice based on the delivery + method and payment request settings, either immediately or on the `scheduled_at` date, if specified. + For example, Square might send the invoice or receipt for an automatic payment. For invoices with + automatic payments, this field must be set to `EMAIL`. + + One of the following is required when creating an invoice: + - (Recommended) This `delivery_method` field. To configure an automatic payment, the + `automatic_payment_source` field of the payment request is also required. + - The deprecated `request_method` field of the payment request. Note that `invoice` + objects returned in responses do not include `request_method`. + See [InvoiceDeliveryMethod](#type-invoicedeliverymethod) for possible values + """ + + invoice_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + A user-friendly invoice number that is displayed on the invoice. The value is unique within a location. + If not provided when creating an invoice, Square assigns a value. + It increments from 1 and is padded with zeros making it 7 characters long + (for example, 0000001 and 0000002). + """ + + title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The title of the invoice, which is displayed on the invoice. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The description of the invoice, which is displayed on the invoice. + """ + + scheduled_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the invoice is scheduled for processing, in RFC 3339 format. + After the invoice is published, Square processes the invoice on the specified date, + according to the delivery method and payment request settings. + + If the field is not set, Square processes the invoice immediately after it is published. + """ + + public_url: typing_extensions.NotRequired[str] + """ + A temporary link to the Square-hosted payment page where the customer can pay the + invoice. If the link expires, customers can provide the email address or phone number + associated with the invoice and request a new link directly from the expired payment page. + + This field is added after the invoice is published and reaches the scheduled date + (if one is defined). + """ + + next_payment_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The current amount due for the invoice. In addition to the + amount due on the next payment request, this includes any overdue payment amounts. + """ + + status: typing_extensions.NotRequired[InvoiceStatus] + """ + The status of the invoice. + See [InvoiceStatus](#type-invoicestatus) for possible values + """ + + timezone: typing_extensions.NotRequired[str] + """ + The time zone used to interpret calendar dates on the invoice, such as `due_date`. + When an invoice is created, this field is set to the `timezone` specified for the seller + location. The value cannot be changed. + + For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\_Angeles + becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC timestamp + of 2021-03-10T08:00:00Z). + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the invoice was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the invoice was last updated, in RFC 3339 format. + """ + + accepted_payment_methods: typing_extensions.NotRequired[InvoiceAcceptedPaymentMethodsParams] + """ + The payment methods that customers can use to pay the invoice on the Square-hosted + invoice page. This setting is independent of any automatic payment requests for the invoice. + + This field is required when creating an invoice and must set at least one payment method to `true`. + """ + + custom_fields: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InvoiceCustomFieldParams]]] + """ + Additional seller-defined fields that are displayed on the invoice. For more information, see + [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). + + Adding custom fields to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + + Max: 2 custom fields + """ + + subscription_id: typing_extensions.NotRequired[str] + """ + The ID of the [subscription](entity:Subscription) associated with the invoice. + This field is present only on subscription billing invoices. + """ + + sale_or_service_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format. + This field can be used to specify a past or future date which is displayed on the invoice. + """ + + payment_conditions: typing_extensions.NotRequired[typing.Optional[str]] + """ + **France only.** The payment terms and conditions that are displayed on the invoice. For more information, + see [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions). + + For countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and + "Payment conditions are not supported for this location's country" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests. + """ + + store_payment_method_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a + bank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the + invoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`. + """ + + attachments: typing_extensions.NotRequired[typing.Sequence[InvoiceAttachmentParams]] + """ + Metadata about the attachments on the invoice. Invoice attachments are managed using the + [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints. + """ + + creator_team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the [team member](entity:TeamMember) who created the invoice. + This field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member. + """ diff --git a/src/square/requests/invoice_accepted_payment_methods.py b/src/square/requests/invoice_accepted_payment_methods.py new file mode 100644 index 00000000..9c0e2b3d --- /dev/null +++ b/src/square/requests/invoice_accepted_payment_methods.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class InvoiceAcceptedPaymentMethodsParams(typing_extensions.TypedDict): + """ + The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page. + """ + + card: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether credit card or debit card payments are accepted. The default value is `false`. + """ + + square_gift_card: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether Square gift card payments are accepted. The default value is `false`. + """ + + bank_account: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether ACH bank transfer payments are accepted. The default value is `false`. + """ + + buy_now_pay_later: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`. + + This option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is + supported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay + invoice payments are supported. As a best practice, consider enabling an additional payment method when allowing + `buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see + [Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later). + """ + + cash_app_pay: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether Cash App payments are accepted. The default value is `false`. + + This payment method is supported only for seller [locations](entity:Location) in the United States. + """ diff --git a/src/square/requests/invoice_attachment.py b/src/square/requests/invoice_attachment.py new file mode 100644 index 00000000..16cc3e4b --- /dev/null +++ b/src/square/requests/invoice_attachment.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class InvoiceAttachmentParams(typing_extensions.TypedDict): + """ + Represents a file attached to an [invoice](entity:Invoice). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the attachment. + """ + + filename: typing_extensions.NotRequired[str] + """ + The file name of the attachment, which is displayed on the invoice. + """ + + description: typing_extensions.NotRequired[str] + """ + The description of the attachment, which is displayed on the invoice. + This field maps to the seller-defined **Message** field. + """ + + filesize: typing_extensions.NotRequired[int] + """ + The file size of the attachment in bytes. + """ + + hash: typing_extensions.NotRequired[str] + """ + The MD5 hash that was generated from the file contents. + """ + + mime_type: typing_extensions.NotRequired[str] + """ + The mime type of the attachment. + The following mime types are supported: + image/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf. + """ + + uploaded_at: typing_extensions.NotRequired[str] + """ + The timestamp when the attachment was uploaded, in RFC 3339 format. + """ diff --git a/src/square/requests/invoice_custom_field.py b/src/square/requests/invoice_custom_field.py new file mode 100644 index 00000000..a8143b09 --- /dev/null +++ b/src/square/requests/invoice_custom_field.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.invoice_custom_field_placement import InvoiceCustomFieldPlacement + + +class InvoiceCustomFieldParams(typing_extensions.TypedDict): + """ + An additional seller-defined and customer-facing field to include on the invoice. For more information, + see [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). + + Adding custom fields to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + """ + + label: typing_extensions.NotRequired[typing.Optional[str]] + """ + The label or title of the custom field. This field is required for a custom field. + """ + + value: typing_extensions.NotRequired[typing.Optional[str]] + """ + The text of the custom field. If omitted, only the label is rendered. + """ + + placement: typing_extensions.NotRequired[InvoiceCustomFieldPlacement] + """ + The location of the custom field on the invoice. This field is required for a custom field. + See [InvoiceCustomFieldPlacement](#type-invoicecustomfieldplacement) for possible values + """ diff --git a/src/square/requests/invoice_filter.py b/src/square/requests/invoice_filter.py new file mode 100644 index 00000000..5146e5d7 --- /dev/null +++ b/src/square/requests/invoice_filter.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +import typing_extensions + + +class InvoiceFilterParams(typing_extensions.TypedDict): + """ + Describes query filters to apply. + """ + + location_ids: typing.Sequence[str] + """ + Limits the search to the specified locations. A location is required. + In the current implementation, only one location can be specified. + """ + + customer_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Limits the search to the specified customers, within the specified locations. + Specifying a customer is optional. In the current implementation, + a maximum of one customer can be specified. + """ diff --git a/src/square/requests/invoice_payment_reminder.py b/src/square/requests/invoice_payment_reminder.py new file mode 100644 index 00000000..fa65a564 --- /dev/null +++ b/src/square/requests/invoice_payment_reminder.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.invoice_payment_reminder_status import InvoicePaymentReminderStatus + + +class InvoicePaymentReminderParams(typing_extensions.TypedDict): + """ + Describes a payment request reminder (automatic notification) that Square sends + to the customer. You configure a reminder relative to the payment request + `due_date`. + """ + + uid: typing_extensions.NotRequired[str] + """ + A Square-assigned ID that uniquely identifies the reminder within the + `InvoicePaymentRequest`. + """ + + relative_scheduled_days: typing_extensions.NotRequired[typing.Optional[int]] + """ + The number of days before (a negative number) or after (a positive number) + the payment request `due_date` when the reminder is sent. For example, -3 indicates that + the reminder should be sent 3 days before the payment request `due_date`. + """ + + message: typing_extensions.NotRequired[typing.Optional[str]] + """ + The reminder message. + """ + + status: typing_extensions.NotRequired[InvoicePaymentReminderStatus] + """ + The status of the reminder. + See [InvoicePaymentReminderStatus](#type-invoicepaymentreminderstatus) for possible values + """ + + sent_at: typing_extensions.NotRequired[str] + """ + If sent, the timestamp when the reminder was sent, in RFC 3339 format. + """ diff --git a/src/square/requests/invoice_payment_request.py b/src/square/requests/invoice_payment_request.py new file mode 100644 index 00000000..c8b45c1c --- /dev/null +++ b/src/square/requests/invoice_payment_request.py @@ -0,0 +1,127 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.invoice_request_method import InvoiceRequestMethod +from ..types.invoice_request_type import InvoiceRequestType +from .money import MoneyParams +from ..types.invoice_automatic_payment_source import InvoiceAutomaticPaymentSource +from .invoice_payment_reminder import InvoicePaymentReminderParams + + +class InvoicePaymentRequestParams(typing_extensions.TypedDict): + """ + Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum + of 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, + see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + + Adding `INSTALLMENT` payment requests to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-generated ID of the payment request in an [invoice](entity:Invoice). + """ + + request_method: typing_extensions.NotRequired[InvoiceRequestMethod] + """ + Indicates how Square processes the payment request. DEPRECATED at version 2021-01-21. Replaced by the + `Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields. + + One of the following is required when creating an invoice: + - (Recommended) The `delivery_method` field of the invoice. To configure an automatic payment, the + `automatic_payment_source` field of the payment request is also required. + - This `request_method` field. Note that `invoice` objects returned in responses do not include `request_method`. + See [InvoiceRequestMethod](#type-invoicerequestmethod) for possible values + """ + + request_type: typing_extensions.NotRequired[InvoiceRequestType] + """ + Identifies the payment request type. This type defines how the payment request amount is determined. + This field is required to create a payment request. + See [InvoiceRequestType](#type-invoicerequesttype) for possible values + """ + + due_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field + is required to create a payment request. If an `automatic_payment_source` is defined for the request, Square + charges the payment source on this date. + + After this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone` + of America/Los\_Angeles becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC + timestamp of 2021-03-10T08:00:00Z). + """ + + fixed_amount_requested_money: typing_extensions.NotRequired[MoneyParams] + """ + If the payment request specifies `DEPOSIT` or `INSTALLMENT` as the `request_type`, + this indicates the request amount. + You cannot specify this when `request_type` is `BALANCE` or when the + payment request includes the `percentage_requested` field. + """ + + percentage_requested: typing_extensions.NotRequired[typing.Optional[str]] + """ + Specifies the amount for the payment request in percentage: + + - When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount. + - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less + the deposit, if requested. The sum of the `percentage_requested` in all installment + payment requests must be equal to 100. + + You cannot specify this when the payment `request_type` is `BALANCE` or when the + payment request specifies the `fixed_amount_requested_money` field. + """ + + tipping_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) + provides a place for the customer to pay a tip. + + This field is allowed only on the final payment request + and the payment `request_type` must be `BALANCE` or `INSTALLMENT`. + """ + + automatic_payment_source: typing_extensions.NotRequired[InvoiceAutomaticPaymentSource] + """ + The payment method for an automatic payment. + + The default value is `NONE`. + See [InvoiceAutomaticPaymentSource](#type-invoiceautomaticpaymentsource) for possible values + """ + + card_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer, + call [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient. + """ + + reminders: typing_extensions.NotRequired[typing.Optional[typing.Sequence[InvoicePaymentReminderParams]]] + """ + A list of one or more reminders to send for the payment request. + """ + + computed_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of the payment request, computed using the order amount and information from the various payment + request fields (`request_type`, `fixed_amount_requested_money`, and `percentage_requested`). + """ + + total_completed_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money already paid for the specific payment request. + This amount might include a rounding adjustment if the most recent invoice payment + was in cash in a currency that rounds cash payments (such as, `CAD` or `AUD`). + """ + + rounding_adjustment_included_money: typing_extensions.NotRequired[MoneyParams] + """ + If the most recent payment was a cash payment + in a currency that rounds cash payments (such as, `CAD` or `AUD`) and the payment + is rounded from `computed_amount_money` in the payment request, then this + field specifies the rounding adjustment applied. This amount + might be negative. + """ diff --git a/src/square/requests/invoice_query.py b/src/square/requests/invoice_query.py new file mode 100644 index 00000000..25106a3a --- /dev/null +++ b/src/square/requests/invoice_query.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .invoice_filter import InvoiceFilterParams +import typing_extensions +from .invoice_sort import InvoiceSortParams + + +class InvoiceQueryParams(typing_extensions.TypedDict): + """ + Describes query criteria for searching invoices. + """ + + filter: InvoiceFilterParams + """ + Query filters to apply in searching invoices. + For more information, see [Search for invoices](https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices#search-invoices). + """ + + sort: typing_extensions.NotRequired[InvoiceSortParams] + """ + Describes the sort order for the search result. + """ diff --git a/src/square/requests/invoice_recipient.py b/src/square/requests/invoice_recipient.py new file mode 100644 index 00000000..42ae51c7 --- /dev/null +++ b/src/square/requests/invoice_recipient.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from .invoice_recipient_tax_ids import InvoiceRecipientTaxIdsParams + + +class InvoiceRecipientParams(typing_extensions.TypedDict): + """ + Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice + and that Square uses to deliver the invoice. + + When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates + the remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. + Square updates the customer ID in response to a merge operation, but does not update other fields. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the customer. This is the customer profile ID that + you provide when creating a draft invoice. + """ + + given_name: typing_extensions.NotRequired[str] + """ + The recipient's given (that is, first) name. + """ + + family_name: typing_extensions.NotRequired[str] + """ + The recipient's family (that is, last) name. + """ + + email_address: typing_extensions.NotRequired[str] + """ + The recipient's email address. + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The recipient's physical address. + """ + + phone_number: typing_extensions.NotRequired[str] + """ + The recipient's phone number. + """ + + company_name: typing_extensions.NotRequired[str] + """ + The name of the recipient's company. + """ + + tax_ids: typing_extensions.NotRequired[InvoiceRecipientTaxIdsParams] + """ + The recipient's tax IDs. The country of the seller account determines whether this field + is available for the customer. For more information, see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). + """ diff --git a/src/square/requests/invoice_recipient_tax_ids.py b/src/square/requests/invoice_recipient_tax_ids.py new file mode 100644 index 00000000..6c7af866 --- /dev/null +++ b/src/square/requests/invoice_recipient_tax_ids.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class InvoiceRecipientTaxIdsParams(typing_extensions.TypedDict): + """ + Represents the tax IDs for an invoice recipient. The country of the seller account determines + whether the corresponding `tax_ids` field is available for the customer. For more information, + see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). + """ + + eu_vat: typing_extensions.NotRequired[str] + """ + The EU VAT identification number for the invoice recipient. For example, `IE3426675K`. + """ diff --git a/src/square/requests/invoice_sort.py b/src/square/requests/invoice_sort.py new file mode 100644 index 00000000..d55e6ecb --- /dev/null +++ b/src/square/requests/invoice_sort.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.invoice_sort_field import InvoiceSortField +import typing_extensions +from ..types.sort_order import SortOrder + + +class InvoiceSortParams(typing_extensions.TypedDict): + """ + Identifies the sort field and sort order. + """ + + field: InvoiceSortField + """ + The field to use for sorting. + See [InvoiceSortField](#type-invoicesortfield) for possible values + """ + + order: typing_extensions.NotRequired[SortOrder] + """ + The order to use for sorting the results. + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/item_variation_location_overrides.py b/src/square/requests/item_variation_location_overrides.py new file mode 100644 index 00000000..8cd26d28 --- /dev/null +++ b/src/square/requests/item_variation_location_overrides.py @@ -0,0 +1,68 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from ..types.catalog_pricing_type import CatalogPricingType +from ..types.inventory_alert_type import InventoryAlertType + + +class ItemVariationLocationOverridesParams(typing_extensions.TypedDict): + """ + Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the `Location`. This can include locations that are deactivated. + """ + + price_money: typing_extensions.NotRequired[MoneyParams] + """ + The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. + """ + + pricing_type: typing_extensions.NotRequired[CatalogPricingType] + """ + The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. + See [CatalogPricingType](#type-catalogpricingtype) for possible values + """ + + track_inventory: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. + """ + + inventory_alert_type: typing_extensions.NotRequired[InventoryAlertType] + """ + Indicates whether the `CatalogItemVariation` displays an alert when its inventory + quantity is less than or equal to its `inventory_alert_threshold`. + See [InventoryAlertType](#type-inventoryalerttype) for possible values + """ + + inventory_alert_threshold: typing_extensions.NotRequired[typing.Optional[int]] + """ + If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` + is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. + + This value is always an integer. + """ + + sold_out: typing_extensions.NotRequired[bool] + """ + Indicates whether the overridden item variation is sold out at the specified location. + + When inventory tracking is enabled on the item variation either globally or at the specified location, + the item variation is automatically marked as sold out when its inventory count reaches zero. The seller + can manually set the item variation as sold out even when the inventory count is greater than zero. + Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set, + applications should treat its inventory count as zero when this attribute value is `true`. + """ + + sold_out_valid_until: typing_extensions.NotRequired[str] + """ + The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation + becomes available again at the specified location. Attempts by an application to set this attribute are ignored. + When the current time is later than this attribute value, the affected item variation is no longer sold out. + """ diff --git a/src/square/requests/job.py b/src/square/requests/job.py new file mode 100644 index 00000000..8a91559b --- /dev/null +++ b/src/square/requests/job.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class JobParams(typing_extensions.TypedDict): + """ + Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the + job's title and tip eligibility. Compensation is defined in a [job assignment](entity:JobAssignment) + in a team member's wage setting. + """ + + id: typing_extensions.NotRequired[str] + """ + **Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request, + call [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job. + You can also get job IDs from a team member's wage setting. + """ + + title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The title of the job. + """ + + is_tip_eligible: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether team members can earn tips for the job. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the job was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the job was last updated, in RFC 3339 format. + """ + + version: typing_extensions.NotRequired[int] + """ + **Read only** The current version of the job. Include this field in `UpdateJob` requests to enable + [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) + control and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't + match the server version at the time of the request. + """ diff --git a/src/square/requests/job_assignment.py b/src/square/requests/job_assignment.py new file mode 100644 index 00000000..751ab86d --- /dev/null +++ b/src/square/requests/job_assignment.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.job_assignment_pay_type import JobAssignmentPayType +from .money import MoneyParams + + +class JobAssignmentParams(typing_extensions.TypedDict): + """ + Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team + member earns for the job. Job assignments are listed in the team member's [wage setting](entity:WageSetting). + """ + + job_title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The title of the job. + """ + + pay_type: JobAssignmentPayType + """ + The current pay type for the job assignment used to + calculate the pay amount in a pay period. + See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values + """ + + hourly_rate: typing_extensions.NotRequired[MoneyParams] + """ + The hourly pay rate of the job. For `SALARY` pay types, Square calculates the hourly rate based on + `annual_rate` and `weekly_hours`. + """ + + annual_rate: typing_extensions.NotRequired[MoneyParams] + """ + The total pay amount for a 12-month period on the job. Set if the job `PayType` is `SALARY`. + """ + + weekly_hours: typing_extensions.NotRequired[typing.Optional[int]] + """ + The planned hours per week for the job. Set if the job `PayType` is `SALARY`. + """ + + job_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [job](entity:Job). + """ diff --git a/src/square/requests/link_customer_to_gift_card_response.py b/src/square/requests/link_customer_to_gift_card_response.py new file mode 100644 index 00000000..32575733 --- /dev/null +++ b/src/square/requests/link_customer_to_gift_card_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class LinkCustomerToGiftCardResponseParams(typing_extensions.TypedDict): + """ + A response that contains the linked `GiftCard` object. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card: typing_extensions.NotRequired[GiftCardParams] + """ + The gift card with the ID of the linked customer listed in the `customer_ids` field. + """ diff --git a/src/square/requests/list_bank_accounts_response.py b/src/square/requests/list_bank_accounts_response.py new file mode 100644 index 00000000..e0fb8e04 --- /dev/null +++ b/src/square/requests/list_bank_accounts_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .bank_account import BankAccountParams + + +class ListBankAccountsResponseParams(typing_extensions.TypedDict): + """ + Response object returned by ListBankAccounts. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + bank_accounts: typing_extensions.NotRequired[typing.Sequence[BankAccountParams]] + """ + List of BankAccounts associated with this account. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can + use in a subsequent request to fetch next set of bank accounts. + If empty, this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ diff --git a/src/square/requests/list_booking_custom_attribute_definitions_response.py b/src/square/requests/list_booking_custom_attribute_definitions_response.py new file mode 100644 index 00000000..5883022e --- /dev/null +++ b/src/square/requests/list_booking_custom_attribute_definitions_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute_definition import CustomAttributeDefinitionParams +from .error import ErrorParams + + +class ListBookingCustomAttributeDefinitionsResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing_extensions.NotRequired[typing.Sequence[CustomAttributeDefinitionParams]] + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_booking_custom_attributes_response.py b/src/square/requests/list_booking_custom_attributes_response.py new file mode 100644 index 00000000..85558b7d --- /dev/null +++ b/src/square/requests/list_booking_custom_attributes_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute import CustomAttributeParams +from .error import ErrorParams + + +class ListBookingCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing_extensions.NotRequired[typing.Sequence[CustomAttributeParams]] + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_bookings_response.py b/src/square/requests/list_bookings_response.py new file mode 100644 index 00000000..87c639fe --- /dev/null +++ b/src/square/requests/list_bookings_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .booking import BookingParams +from .error import ErrorParams + + +class ListBookingsResponseParams(typing_extensions.TypedDict): + bookings: typing_extensions.NotRequired[typing.Sequence[BookingParams]] + """ + The list of targeted bookings. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/list_break_types_response.py b/src/square/requests/list_break_types_response.py new file mode 100644 index 00000000..fbbd8db1 --- /dev/null +++ b/src/square/requests/list_break_types_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .break_type import BreakTypeParams +from .error import ErrorParams + + +class ListBreakTypesResponseParams(typing_extensions.TypedDict): + """ + The response to a request for a set of `BreakType` objects. The response contains + the requested `BreakType` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_types: typing_extensions.NotRequired[typing.Sequence[BreakTypeParams]] + """ + A page of `BreakType` results. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The value supplied in the subsequent request to fetch the next page + of `BreakType` results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_cards_response.py b/src/square/requests/list_cards_response.py new file mode 100644 index 00000000..36e7a8a3 --- /dev/null +++ b/src/square/requests/list_cards_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .card import CardParams + + +class ListCardsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [ListCards](api-endpoint:Cards-ListCards) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + cards: typing_extensions.NotRequired[typing.Sequence[CardParams]] + """ + The requested list of `Card`s. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ diff --git a/src/square/requests/list_cash_drawer_shift_events_response.py b/src/square/requests/list_cash_drawer_shift_events_response.py new file mode 100644 index 00000000..6cb01a67 --- /dev/null +++ b/src/square/requests/list_cash_drawer_shift_events_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .cash_drawer_shift_event import CashDrawerShiftEventParams + + +class ListCashDrawerShiftEventsResponseParams(typing_extensions.TypedDict): + cursor: typing_extensions.NotRequired[str] + """ + Opaque cursor for fetching the next page. Cursor is not present in + the last page of results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + cash_drawer_shift_events: typing_extensions.NotRequired[typing.Sequence[CashDrawerShiftEventParams]] + """ + All of the events (payments, refunds, etc.) for a cash drawer during + the shift. + """ diff --git a/src/square/requests/list_cash_drawer_shifts_response.py b/src/square/requests/list_cash_drawer_shifts_response.py new file mode 100644 index 00000000..c2ce477f --- /dev/null +++ b/src/square/requests/list_cash_drawer_shifts_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .cash_drawer_shift_summary import CashDrawerShiftSummaryParams + + +class ListCashDrawerShiftsResponseParams(typing_extensions.TypedDict): + cursor: typing_extensions.NotRequired[str] + """ + Opaque cursor for fetching the next page of results. Cursor is not + present in the last page of results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + cash_drawer_shifts: typing_extensions.NotRequired[typing.Sequence[CashDrawerShiftSummaryParams]] + """ + A collection of CashDrawerShiftSummary objects for shifts that match + the query. + """ diff --git a/src/square/requests/list_catalog_response.py b/src/square/requests/list_catalog_response.py new file mode 100644 index 00000000..baf4328d --- /dev/null +++ b/src/square/requests/list_catalog_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class ListCatalogResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, this is the final response. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + The CatalogObjects returned. + """ diff --git a/src/square/requests/list_customer_custom_attribute_definitions_response.py b/src/square/requests/list_customer_custom_attribute_definitions_response.py new file mode 100644 index 00000000..14569e7e --- /dev/null +++ b/src/square/requests/list_customer_custom_attribute_definitions_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute_definition import CustomAttributeDefinitionParams +from .error import ErrorParams + + +class ListCustomerCustomAttributeDefinitionsResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListCustomerCustomAttributeDefinitions](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing_extensions.NotRequired[typing.Sequence[CustomAttributeDefinitionParams]] + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_customer_custom_attributes_response.py b/src/square/requests/list_customer_custom_attributes_response.py new file mode 100644 index 00000000..87329e55 --- /dev/null +++ b/src/square/requests/list_customer_custom_attributes_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute import CustomAttributeParams +from .error import ErrorParams + + +class ListCustomerCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing_extensions.NotRequired[typing.Sequence[CustomAttributeParams]] + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_customer_groups_response.py b/src/square/requests/list_customer_groups_response.py new file mode 100644 index 00000000..b0d6493f --- /dev/null +++ b/src/square/requests/list_customer_groups_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer_group import CustomerGroupParams + + +class ListCustomerGroupsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [ListCustomerGroups](api-endpoint:CustomerGroups-ListCustomerGroups) endpoint. + + Either `errors` or `groups` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + groups: typing_extensions.NotRequired[typing.Sequence[CustomerGroupParams]] + """ + A list of customer groups belonging to the current seller. + """ + + cursor: typing_extensions.NotRequired[str] + """ + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. This value is present only if the request + succeeded and additional results are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_customer_segments_response.py b/src/square/requests/list_customer_segments_response.py new file mode 100644 index 00000000..d45450ac --- /dev/null +++ b/src/square/requests/list_customer_segments_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer_segment import CustomerSegmentParams + + +class ListCustomerSegmentsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body for requests to the `ListCustomerSegments` endpoint. + + Either `errors` or `segments` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + segments: typing_extensions.NotRequired[typing.Sequence[CustomerSegmentParams]] + """ + The list of customer segments belonging to the associated Square account. + """ + + cursor: typing_extensions.NotRequired[str] + """ + A pagination cursor to be used in subsequent calls to `ListCustomerSegments` + to retrieve the next set of query results. The cursor is only present if the request succeeded and + additional results are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_customers_response.py b/src/square/requests/list_customers_response.py new file mode 100644 index 00000000..abec80e3 --- /dev/null +++ b/src/square/requests/list_customers_response.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer import CustomerParams + + +class ListCustomersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `ListCustomers` endpoint. + + Either `errors` or `customers` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + customers: typing_extensions.NotRequired[typing.Sequence[CustomerParams]] + """ + The customer profiles associated with the Square account or an empty object (`{}`) if none are found. + Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or + `phone_number`) are included in the response. + """ + + cursor: typing_extensions.NotRequired[str] + """ + A pagination cursor to retrieve the next set of results for the + original query. A cursor is only present if the request succeeded and additional results + are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + count: typing_extensions.NotRequired[int] + """ + The total count of customers associated with the Square account. Only customer profiles with public information + (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present + only if `count` is set to `true` in the request. + """ diff --git a/src/square/requests/list_device_codes_response.py b/src/square/requests/list_device_codes_response.py new file mode 100644 index 00000000..b32cb9fb --- /dev/null +++ b/src/square/requests/list_device_codes_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .device_code import DeviceCodeParams + + +class ListDeviceCodesResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + device_codes: typing_extensions.NotRequired[typing.Sequence[DeviceCodeParams]] + """ + The queried DeviceCode. + """ + + cursor: typing_extensions.NotRequired[str] + """ + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. This value is present only if the request + succeeded and additional results are available. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + """ diff --git a/src/square/requests/list_devices_response.py b/src/square/requests/list_devices_response.py new file mode 100644 index 00000000..26a5b8a2 --- /dev/null +++ b/src/square/requests/list_devices_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .device import DeviceParams + + +class ListDevicesResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors that occurred during the request. + """ + + devices: typing_extensions.NotRequired[typing.Sequence[DeviceParams]] + """ + The requested list of `Device` objects. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ diff --git a/src/square/requests/list_dispute_evidence_response.py b/src/square/requests/list_dispute_evidence_response.py new file mode 100644 index 00000000..1a324d96 --- /dev/null +++ b/src/square/requests/list_dispute_evidence_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .dispute_evidence import DisputeEvidenceParams +from .error import ErrorParams + + +class ListDisputeEvidenceResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in a `ListDisputeEvidence` response. + """ + + evidence: typing_extensions.NotRequired[typing.Sequence[DisputeEvidenceParams]] + """ + The list of evidence previously uploaded to the specified dispute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. + If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_disputes_response.py b/src/square/requests/list_disputes_response.py new file mode 100644 index 00000000..a4b14505 --- /dev/null +++ b/src/square/requests/list_disputes_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute import DisputeParams + + +class ListDisputesResponseParams(typing_extensions.TypedDict): + """ + Defines fields in a `ListDisputes` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + disputes: typing_extensions.NotRequired[typing.Sequence[DisputeParams]] + """ + The list of disputes. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. + If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_employee_wages_response.py b/src/square/requests/list_employee_wages_response.py new file mode 100644 index 00000000..cf69d75a --- /dev/null +++ b/src/square/requests/list_employee_wages_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .employee_wage import EmployeeWageParams +from .error import ErrorParams + + +class ListEmployeeWagesResponseParams(typing_extensions.TypedDict): + """ + The response to a request for a set of `EmployeeWage` objects. The response contains + a set of `EmployeeWage` objects. + """ + + employee_wages: typing_extensions.NotRequired[typing.Sequence[EmployeeWageParams]] + """ + A page of `EmployeeWage` results. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The value supplied in the subsequent request to fetch the next page + of `EmployeeWage` results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_employees_response.py b/src/square/requests/list_employees_response.py new file mode 100644 index 00000000..fa99d4fb --- /dev/null +++ b/src/square/requests/list_employees_response.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .employee import EmployeeParams +from .error import ErrorParams + + +class ListEmployeesResponseParams(typing_extensions.TypedDict): + employees: typing_extensions.NotRequired[typing.Sequence[EmployeeParams]] + cursor: typing_extensions.NotRequired[str] + """ + The token to be used to retrieve the next page of results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_event_types_response.py b/src/square/requests/list_event_types_response.py new file mode 100644 index 00000000..a35185ad --- /dev/null +++ b/src/square/requests/list_event_types_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .event_type_metadata import EventTypeMetadataParams + + +class ListEventTypesResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [ListEventTypes](api-endpoint:Events-ListEventTypes) endpoint. + + Note: if there are errors processing the request, the event types field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + event_types: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The list of event types. + """ + + metadata: typing_extensions.NotRequired[typing.Sequence[EventTypeMetadataParams]] + """ + Contains the metadata of an event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). + """ diff --git a/src/square/requests/list_gift_card_activities_response.py b/src/square/requests/list_gift_card_activities_response.py new file mode 100644 index 00000000..0f03a1f7 --- /dev/null +++ b/src/square/requests/list_gift_card_activities_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card_activity import GiftCardActivityParams + + +class ListGiftCardActivitiesResponseParams(typing_extensions.TypedDict): + """ + A response that contains a list of `GiftCardActivity` objects. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card_activities: typing_extensions.NotRequired[typing.Sequence[GiftCardActivityParams]] + """ + The requested gift card activities or an empty object if none are found. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to retrieve the next set of activities. If a cursor is not present, this is + the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ diff --git a/src/square/requests/list_gift_cards_response.py b/src/square/requests/list_gift_cards_response.py new file mode 100644 index 00000000..6ea4e97d --- /dev/null +++ b/src/square/requests/list_gift_cards_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class ListGiftCardsResponseParams(typing_extensions.TypedDict): + """ + A response that contains a list of `GiftCard` objects. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_cards: typing_extensions.NotRequired[typing.Sequence[GiftCardParams]] + """ + The requested gift cards or an empty object if none are found. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is + the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ diff --git a/src/square/requests/list_invoices_response.py b/src/square/requests/list_invoices_response.py new file mode 100644 index 00000000..186ef518 --- /dev/null +++ b/src/square/requests/list_invoices_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .invoice import InvoiceParams +from .error import ErrorParams + + +class ListInvoicesResponseParams(typing_extensions.TypedDict): + """ + Describes a `ListInvoice` response. + """ + + invoices: typing_extensions.NotRequired[typing.Sequence[InvoiceParams]] + """ + The invoices retrieved. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to retrieve the next set of invoices. If empty, this is the final + response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/list_jobs_response.py b/src/square/requests/list_jobs_response.py new file mode 100644 index 00000000..f85815aa --- /dev/null +++ b/src/square/requests/list_jobs_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .job import JobParams +from .error import ErrorParams + + +class ListJobsResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListJobs](api-endpoint:Team-ListJobs) response. Either `jobs` or `errors` + is present in the response. If additional results are available, the `cursor` field is also present. + """ + + jobs: typing_extensions.NotRequired[typing.Sequence[JobParams]] + """ + The retrieved jobs. A single paged response contains up to 100 jobs. + """ + + cursor: typing_extensions.NotRequired[str] + """ + An opaque cursor used to retrieve the next page of results. This field is present only + if the request succeeded and additional results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/list_location_booking_profiles_response.py b/src/square/requests/list_location_booking_profiles_response.py new file mode 100644 index 00000000..0f4eee92 --- /dev/null +++ b/src/square/requests/list_location_booking_profiles_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .location_booking_profile import LocationBookingProfileParams +from .error import ErrorParams + + +class ListLocationBookingProfilesResponseParams(typing_extensions.TypedDict): + location_booking_profiles: typing_extensions.NotRequired[typing.Sequence[LocationBookingProfileParams]] + """ + The list of a seller's location booking profiles. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/list_location_custom_attribute_definitions_response.py b/src/square/requests/list_location_custom_attribute_definitions_response.py new file mode 100644 index 00000000..b977a671 --- /dev/null +++ b/src/square/requests/list_location_custom_attribute_definitions_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute_definition import CustomAttributeDefinitionParams +from .error import ErrorParams + + +class ListLocationCustomAttributeDefinitionsResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListLocationCustomAttributeDefinitions](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing_extensions.NotRequired[typing.Sequence[CustomAttributeDefinitionParams]] + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_location_custom_attributes_response.py b/src/square/requests/list_location_custom_attributes_response.py new file mode 100644 index 00000000..b0813958 --- /dev/null +++ b/src/square/requests/list_location_custom_attributes_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute import CustomAttributeParams +from .error import ErrorParams + + +class ListLocationCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListLocationCustomAttributes](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing_extensions.NotRequired[typing.Sequence[CustomAttributeParams]] + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_locations_response.py b/src/square/requests/list_locations_response.py new file mode 100644 index 00000000..d6f6b9e0 --- /dev/null +++ b/src/square/requests/list_locations_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .location import LocationParams + + +class ListLocationsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of a request + to the [ListLocations](api-endpoint:Locations-ListLocations) endpoint. + + Either `errors` or `locations` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + locations: typing_extensions.NotRequired[typing.Sequence[LocationParams]] + """ + The business locations. + """ diff --git a/src/square/requests/list_loyalty_programs_response.py b/src/square/requests/list_loyalty_programs_response.py new file mode 100644 index 00000000..c0c786ba --- /dev/null +++ b/src/square/requests/list_loyalty_programs_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_program import LoyaltyProgramParams + + +class ListLoyaltyProgramsResponseParams(typing_extensions.TypedDict): + """ + A response that contains all loyalty programs. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + programs: typing_extensions.NotRequired[typing.Sequence[LoyaltyProgramParams]] + """ + A list of `LoyaltyProgram` for the merchant. + """ diff --git a/src/square/requests/list_loyalty_promotions_response.py b/src/square/requests/list_loyalty_promotions_response.py new file mode 100644 index 00000000..f2ca878d --- /dev/null +++ b/src/square/requests/list_loyalty_promotions_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_promotion import LoyaltyPromotionParams + + +class ListLoyaltyPromotionsResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) response. + One of `loyalty_promotions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `loyalty_promotions`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_promotions: typing_extensions.NotRequired[typing.Sequence[LoyaltyPromotionParams]] + """ + The retrieved loyalty promotions. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_merchant_custom_attribute_definitions_response.py b/src/square/requests/list_merchant_custom_attribute_definitions_response.py new file mode 100644 index 00000000..a1fa6fd3 --- /dev/null +++ b/src/square/requests/list_merchant_custom_attribute_definitions_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute_definition import CustomAttributeDefinitionParams +from .error import ErrorParams + + +class ListMerchantCustomAttributeDefinitionsResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListMerchantCustomAttributeDefinitions](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing_extensions.NotRequired[typing.Sequence[CustomAttributeDefinitionParams]] + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_merchant_custom_attributes_response.py b/src/square/requests/list_merchant_custom_attributes_response.py new file mode 100644 index 00000000..376d8b9d --- /dev/null +++ b/src/square/requests/list_merchant_custom_attributes_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute import CustomAttributeParams +from .error import ErrorParams + + +class ListMerchantCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a [ListMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing_extensions.NotRequired[typing.Sequence[CustomAttributeParams]] + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_merchants_response.py b/src/square/requests/list_merchants_response.py new file mode 100644 index 00000000..d715ab2c --- /dev/null +++ b/src/square/requests/list_merchants_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .merchant import MerchantParams + + +class ListMerchantsResponseParams(typing_extensions.TypedDict): + """ + The response object returned by the [ListMerchant](api-endpoint:Merchants-ListMerchants) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + merchant: typing_extensions.NotRequired[typing.Sequence[MerchantParams]] + """ + The requested `Merchant` entities. + """ + + cursor: typing_extensions.NotRequired[int] + """ + If the response is truncated, the cursor to use in next request to fetch next set of objects. + """ diff --git a/src/square/requests/list_order_custom_attribute_definitions_response.py b/src/square/requests/list_order_custom_attribute_definitions_response.py new file mode 100644 index 00000000..a5ebea0f --- /dev/null +++ b/src/square/requests/list_order_custom_attribute_definitions_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing_extensions +from .error import ErrorParams + + +class ListOrderCustomAttributeDefinitionsResponseParams(typing_extensions.TypedDict): + """ + Represents a response from listing order custom attribute definitions. + """ + + custom_attribute_definitions: typing.Sequence[CustomAttributeDefinitionParams] + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. + This field is present only if the request succeeded and additional results are available. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_order_custom_attributes_response.py b/src/square/requests/list_order_custom_attributes_response.py new file mode 100644 index 00000000..5d6c601a --- /dev/null +++ b/src/square/requests/list_order_custom_attributes_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .custom_attribute import CustomAttributeParams +from .error import ErrorParams + + +class ListOrderCustomAttributesResponseParams(typing_extensions.TypedDict): + """ + Represents a response from listing order custom attributes. + """ + + custom_attributes: typing_extensions.NotRequired[typing.Sequence[CustomAttributeParams]] + """ + The retrieved custom attributes. If no custom attribute are found, Square returns an empty object (`{}`). + """ + + cursor: typing_extensions.NotRequired[str] + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. + This field is present only if the request succeeded and additional results are available. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_payment_links_response.py b/src/square/requests/list_payment_links_response.py new file mode 100644 index 00000000..475c4fc5 --- /dev/null +++ b/src/square/requests/list_payment_links_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_link import PaymentLinkParams + + +class ListPaymentLinksResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ + + payment_links: typing_extensions.NotRequired[typing.Sequence[PaymentLinkParams]] + """ + The list of payment links. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can use in a subsequent request + to retrieve the next set of gift cards. If a cursor is not present, this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_payment_refunds_response.py b/src/square/requests/list_payment_refunds_response.py new file mode 100644 index 00000000..168b07f8 --- /dev/null +++ b/src/square/requests/list_payment_refunds_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_refund import PaymentRefundParams + + +class ListPaymentRefundsResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds). + + Either `errors` or `refunds` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refunds: typing_extensions.NotRequired[typing.Sequence[PaymentRefundParams]] + """ + The list of requested refunds. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_payments_response.py b/src/square/requests/list_payments_response.py new file mode 100644 index 00000000..7dde3c8e --- /dev/null +++ b/src/square/requests/list_payments_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment import PaymentParams + + +class ListPaymentsResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by [ListPayments](api-endpoint:Payments-ListPayments). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + payments: typing_extensions.NotRequired[typing.Sequence[PaymentParams]] + """ + The requested list of payments. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_payout_entries_response.py b/src/square/requests/list_payout_entries_response.py new file mode 100644 index 00000000..51c9c053 --- /dev/null +++ b/src/square/requests/list_payout_entries_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .payout_entry import PayoutEntryParams +from .error import ErrorParams + + +class ListPayoutEntriesResponseParams(typing_extensions.TypedDict): + """ + The response to retrieve payout records entries. + """ + + payout_entries: typing_extensions.NotRequired[typing.Sequence[PayoutEntryParams]] + """ + The requested list of payout entries, ordered with the given or default sort order. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/list_payouts_response.py b/src/square/requests/list_payouts_response.py new file mode 100644 index 00000000..05b80b25 --- /dev/null +++ b/src/square/requests/list_payouts_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .payout import PayoutParams +from .error import ErrorParams + + +class ListPayoutsResponseParams(typing_extensions.TypedDict): + """ + The response to retrieve payout records entries. + """ + + payouts: typing_extensions.NotRequired[typing.Sequence[PayoutParams]] + """ + The requested list of payouts. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/list_sites_response.py b/src/square/requests/list_sites_response.py new file mode 100644 index 00000000..7e08ebdb --- /dev/null +++ b/src/square/requests/list_sites_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .site import SiteParams + + +class ListSitesResponseParams(typing_extensions.TypedDict): + """ + Represents a `ListSites` response. The response can include either `sites` or `errors`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + sites: typing_extensions.NotRequired[typing.Sequence[SiteParams]] + """ + The sites that belong to the seller. + """ diff --git a/src/square/requests/list_subscription_events_response.py b/src/square/requests/list_subscription_events_response.py new file mode 100644 index 00000000..464496ca --- /dev/null +++ b/src/square/requests/list_subscription_events_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription_event import SubscriptionEventParams + + +class ListSubscriptionEventsResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription_events: typing_extensions.NotRequired[typing.Sequence[SubscriptionEventParams]] + """ + The retrieved subscription events. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When the total number of resulting subscription events exceeds the limit of a paged response, + the response includes a cursor for you to use in a subsequent request to fetch the next set of events. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_team_member_booking_profiles_response.py b/src/square/requests/list_team_member_booking_profiles_response.py new file mode 100644 index 00000000..b0d5227d --- /dev/null +++ b/src/square/requests/list_team_member_booking_profiles_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .team_member_booking_profile import TeamMemberBookingProfileParams +from .error import ErrorParams + + +class ListTeamMemberBookingProfilesResponseParams(typing_extensions.TypedDict): + team_member_booking_profiles: typing_extensions.NotRequired[typing.Sequence[TeamMemberBookingProfileParams]] + """ + The list of team member booking profiles. The results are returned in the ascending order of the time + when the team member booking profiles were last updated. Multiple booking profiles updated at the same time + are further sorted in the ascending order of their IDs. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/list_team_member_wages_response.py b/src/square/requests/list_team_member_wages_response.py new file mode 100644 index 00000000..1b8738e8 --- /dev/null +++ b/src/square/requests/list_team_member_wages_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .team_member_wage import TeamMemberWageParams +from .error import ErrorParams + + +class ListTeamMemberWagesResponseParams(typing_extensions.TypedDict): + """ + The response to a request for a set of `TeamMemberWage` objects. The response contains + a set of `TeamMemberWage` objects. + """ + + team_member_wages: typing_extensions.NotRequired[typing.Sequence[TeamMemberWageParams]] + """ + A page of `TeamMemberWage` results. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The value supplied in the subsequent request to fetch the next page + of `TeamMemberWage` results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/list_transactions_response.py b/src/square/requests/list_transactions_response.py new file mode 100644 index 00000000..ef54b484 --- /dev/null +++ b/src/square/requests/list_transactions_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .transaction import TransactionParams + + +class ListTransactionsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. + + One of `errors` or `transactions` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + transactions: typing_extensions.NotRequired[typing.Sequence[TransactionParams]] + """ + An array of transactions that match your query. + """ + + cursor: typing_extensions.NotRequired[str] + """ + A pagination cursor for retrieving the next set of results, + if any remain. Provide this value as the `cursor` parameter in a subsequent + request to this endpoint. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + """ diff --git a/src/square/requests/list_webhook_event_types_response.py b/src/square/requests/list_webhook_event_types_response.py new file mode 100644 index 00000000..6daf0201 --- /dev/null +++ b/src/square/requests/list_webhook_event_types_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .event_type_metadata import EventTypeMetadataParams + + +class ListWebhookEventTypesResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [ListWebhookEventTypes](api-endpoint:WebhookSubscriptions-ListWebhookEventTypes) endpoint. + + Note: if there are errors processing the request, the event types field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + event_types: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The list of event types. + """ + + metadata: typing_extensions.NotRequired[typing.Sequence[EventTypeMetadataParams]] + """ + Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). + """ diff --git a/src/square/requests/list_webhook_subscriptions_response.py b/src/square/requests/list_webhook_subscriptions_response.py new file mode 100644 index 00000000..6a9e33f1 --- /dev/null +++ b/src/square/requests/list_webhook_subscriptions_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .webhook_subscription import WebhookSubscriptionParams + + +class ListWebhookSubscriptionsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [ListWebhookSubscriptions](api-endpoint:WebhookSubscriptions-ListWebhookSubscriptions) endpoint. + + Note: if there are errors processing the request, the subscriptions field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + subscriptions: typing_extensions.NotRequired[typing.Sequence[WebhookSubscriptionParams]] + """ + The requested list of [Subscription](entity:WebhookSubscription)s. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/list_workweek_configs_response.py b/src/square/requests/list_workweek_configs_response.py new file mode 100644 index 00000000..c7f1de6e --- /dev/null +++ b/src/square/requests/list_workweek_configs_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .workweek_config import WorkweekConfigParams +from .error import ErrorParams + + +class ListWorkweekConfigsResponseParams(typing_extensions.TypedDict): + """ + The response to a request for a set of `WorkweekConfig` objects. The response contains + the requested `WorkweekConfig` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + workweek_configs: typing_extensions.NotRequired[typing.Sequence[WorkweekConfigParams]] + """ + A page of `WorkweekConfig` results. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The value supplied in the subsequent request to fetch the next page of + `WorkweekConfig` results. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/location.py b/src/square/requests/location.py new file mode 100644 index 00000000..554b90b9 --- /dev/null +++ b/src/square/requests/location.py @@ -0,0 +1,177 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from ..types.location_capability import LocationCapability +from ..types.location_status import LocationStatus +from ..types.country import Country +from ..types.currency import Currency +from ..types.location_type import LocationType +from .business_hours import BusinessHoursParams +from .coordinates import CoordinatesParams +from .tax_ids import TaxIdsParams + + +class LocationParams(typing_extensions.TypedDict): + """ + Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). + """ + + id: typing_extensions.NotRequired[str] + """ + A short generated string of letters and numbers that uniquely identifies this location instance. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the location. + This information appears in the Seller Dashboard as the nickname. + A location name must be unique within a seller account. + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The physical address of the location. + """ + + timezone: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [IANA time zone](https://www.iana.org/time-zones) identifier for + the time zone of the location. For example, `America/Los_Angeles`. + """ + + capabilities: typing_extensions.NotRequired[typing.Sequence[LocationCapability]] + """ + The Square features that are enabled for the location. + See [LocationCapability](entity:LocationCapability) for possible values. + See [LocationCapability](#type-locationcapability) for possible values + """ + + status: typing_extensions.NotRequired[LocationStatus] + """ + The status of the location. + See [LocationStatus](#type-locationstatus) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the location was created, in RFC 3339 format. + For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). + """ + + merchant_id: typing_extensions.NotRequired[str] + """ + The ID of the merchant that owns the location. + """ + + country: typing_extensions.NotRequired[Country] + """ + The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`. + + See [Country](entity:Country) for possible values. + See [Country](#type-country) for possible values + """ + + language_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The language associated with the location, in + [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). + For more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences). + """ + + currency: typing_extensions.NotRequired[Currency] + """ + The currency used for all transactions at this location, + in ISO 4217 format. For example, the currency code for US dollars is `USD`. + See [Currency](entity:Currency) for possible values. + See [Currency](#type-currency) for possible values + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number of the location. For example, `+1 855-700-6000`. + """ + + business_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period. + """ + + type: typing_extensions.NotRequired[LocationType] + """ + The type of the location. + See [LocationType](#type-locationtype) for possible values + """ + + website_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The website URL of the location. For example, `https://squareup.com`. + """ + + business_hours: typing_extensions.NotRequired[BusinessHoursParams] + """ + The hours of operation for the location. + """ + + business_email: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The description of the location. For example, `Main Street location`. + """ + + twitter_username: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Twitter username of the location without the '@' symbol. For example, `Square`. + """ + + instagram_username: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Instagram username of the location without the '@' symbol. For example, `square`. + """ + + facebook_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`. + """ + + coordinates: typing_extensions.NotRequired[CoordinatesParams] + """ + The physical coordinates (latitude and longitude) of the location. + """ + + logo_url: typing_extensions.NotRequired[str] + """ + The URL of the logo image for the location. When configured in the Seller + Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. + This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels. + """ + + pos_background_url: typing_extensions.NotRequired[str] + """ + The URL of the Point of Sale background image for the location. + """ + + mcc: typing_extensions.NotRequired[typing.Optional[str]] + """ + A four-digit number that describes the kind of goods or services sold at the location. + The [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245. + For example, `5045`, for a location that sells computer goods and software. + """ + + full_format_logo_url: typing_extensions.NotRequired[str] + """ + The URL of a full-format logo image for the location. When configured in the Seller + Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. + This image can be wider than it is tall and should be at least 1280x648 pixels. + """ + + tax_ids: typing_extensions.NotRequired[TaxIdsParams] + """ + The tax IDs for this location. + """ diff --git a/src/square/requests/location_booking_profile.py b/src/square/requests/location_booking_profile.py new file mode 100644 index 00000000..27881d17 --- /dev/null +++ b/src/square/requests/location_booking_profile.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class LocationBookingProfileParams(typing_extensions.TypedDict): + """ + The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [location](entity:Location). + """ + + booking_site_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + Url for the online booking site for this location. + """ + + online_booking_enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the location is enabled for online booking. + """ diff --git a/src/square/requests/loyalty_account.py b/src/square/requests/loyalty_account.py new file mode 100644 index 00000000..2f8db9d7 --- /dev/null +++ b/src/square/requests/loyalty_account.py @@ -0,0 +1,80 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .loyalty_account_mapping import LoyaltyAccountMappingParams +from .loyalty_account_expiring_point_deadline import LoyaltyAccountExpiringPointDeadlineParams + + +class LoyaltyAccountParams(typing_extensions.TypedDict): + """ + Describes a loyalty account in a [loyalty program](entity:LoyaltyProgram). For more information, see + [Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the loyalty account. + """ + + program_id: str + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) to which the account belongs. + """ + + balance: typing_extensions.NotRequired[int] + """ + The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field. + + Your application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange. + """ + + lifetime_points: typing_extensions.NotRequired[int] + """ + The total points accrued during the lifetime of the account. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-assigned ID of the [customer](entity:Customer) that is associated with the account. + """ + + enrolled_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products. + + If this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer's first action on their account + (when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale. + + This field is typically specified in a `CreateLoyaltyAccount` request when creating a loyalty account for a buyer who already interacted with their account. + For example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the loyalty account was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the loyalty account was last updated, in RFC 3339 format. + """ + + mapping: typing_extensions.NotRequired[LoyaltyAccountMappingParams] + """ + The mapping that associates the loyalty account with a buyer. Currently, + a loyalty account can only be mapped to a buyer by phone number. + + To create a loyalty account, you must specify the `mapping` field, with the buyer's phone number + in the `phone_number` field. + """ + + expiring_point_deadlines: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[LoyaltyAccountExpiringPointDeadlineParams]] + ] + """ + The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. + + The total number of points in this field equals the number of points in the `balance` field. + """ diff --git a/src/square/requests/loyalty_account_expiring_point_deadline.py b/src/square/requests/loyalty_account_expiring_point_deadline.py new file mode 100644 index 00000000..3dab6c8b --- /dev/null +++ b/src/square/requests/loyalty_account_expiring_point_deadline.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyAccountExpiringPointDeadlineParams(typing_extensions.TypedDict): + """ + Represents a set of points for a loyalty account that are scheduled to expire on a specific date. + """ + + points: int + """ + The number of points scheduled to expire at the `expires_at` timestamp. + """ + + expires_at: str + """ + The timestamp of when the points are scheduled to expire, in RFC 3339 format. + """ diff --git a/src/square/requests/loyalty_account_mapping.py b/src/square/requests/loyalty_account_mapping.py new file mode 100644 index 00000000..d0ff32a6 --- /dev/null +++ b/src/square/requests/loyalty_account_mapping.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class LoyaltyAccountMappingParams(typing_extensions.TypedDict): + """ + Represents the mapping that associates a loyalty account with a buyer. + + Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see + [Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the mapping. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the mapping was created, in RFC 3339 format. + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number of the buyer, in E.164 format. For example, "+14155551111". + """ diff --git a/src/square/requests/loyalty_event.py b/src/square/requests/loyalty_event.py new file mode 100644 index 00000000..cb5a9148 --- /dev/null +++ b/src/square/requests/loyalty_event.py @@ -0,0 +1,93 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.loyalty_event_type import LoyaltyEventType +import typing_extensions +from .loyalty_event_accumulate_points import LoyaltyEventAccumulatePointsParams +from .loyalty_event_create_reward import LoyaltyEventCreateRewardParams +from .loyalty_event_redeem_reward import LoyaltyEventRedeemRewardParams +from .loyalty_event_delete_reward import LoyaltyEventDeleteRewardParams +from .loyalty_event_adjust_points import LoyaltyEventAdjustPointsParams +from ..types.loyalty_event_source import LoyaltyEventSource +from .loyalty_event_expire_points import LoyaltyEventExpirePointsParams +from .loyalty_event_other import LoyaltyEventOtherParams +from .loyalty_event_accumulate_promotion_points import LoyaltyEventAccumulatePromotionPointsParams + + +class LoyaltyEventParams(typing_extensions.TypedDict): + """ + Provides information about a loyalty event. + For more information, see [Search for Balance-Changing Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events). + """ + + id: str + """ + The Square-assigned ID of the loyalty event. + """ + + type: LoyaltyEventType + """ + The type of the loyalty event. + See [LoyaltyEventType](#type-loyaltyeventtype) for possible values + """ + + created_at: str + """ + The timestamp when the event was created, in RFC 3339 format. + """ + + accumulate_points: typing_extensions.NotRequired[LoyaltyEventAccumulatePointsParams] + """ + Provides metadata when the event `type` is `ACCUMULATE_POINTS`. + """ + + create_reward: typing_extensions.NotRequired[LoyaltyEventCreateRewardParams] + """ + Provides metadata when the event `type` is `CREATE_REWARD`. + """ + + redeem_reward: typing_extensions.NotRequired[LoyaltyEventRedeemRewardParams] + """ + Provides metadata when the event `type` is `REDEEM_REWARD`. + """ + + delete_reward: typing_extensions.NotRequired[LoyaltyEventDeleteRewardParams] + """ + Provides metadata when the event `type` is `DELETE_REWARD`. + """ + + adjust_points: typing_extensions.NotRequired[LoyaltyEventAdjustPointsParams] + """ + Provides metadata when the event `type` is `ADJUST_POINTS`. + """ + + loyalty_account_id: str + """ + The ID of the [loyalty account](entity:LoyaltyAccount) associated with the event. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the [location](entity:Location) where the event occurred. + """ + + source: LoyaltyEventSource + """ + Defines whether the event was generated by the Square Point of Sale. + See [LoyaltyEventSource](#type-loyaltyeventsource) for possible values + """ + + expire_points: typing_extensions.NotRequired[LoyaltyEventExpirePointsParams] + """ + Provides metadata when the event `type` is `EXPIRE_POINTS`. + """ + + other_event: typing_extensions.NotRequired[LoyaltyEventOtherParams] + """ + Provides metadata when the event `type` is `OTHER`. + """ + + accumulate_promotion_points: typing_extensions.NotRequired[LoyaltyEventAccumulatePromotionPointsParams] + """ + Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. + """ diff --git a/src/square/requests/loyalty_event_accumulate_points.py b/src/square/requests/loyalty_event_accumulate_points.py new file mode 100644 index 00000000..4426c7ca --- /dev/null +++ b/src/square/requests/loyalty_event_accumulate_points.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class LoyaltyEventAccumulatePointsParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `ACCUMULATE_POINTS`. + """ + + loyalty_program_id: typing_extensions.NotRequired[str] + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: typing_extensions.NotRequired[typing.Optional[int]] + """ + The number of points accumulated by the event. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [order](entity:Order) for which the buyer accumulated the points. + This field is returned only if the Orders API is used to process orders. + """ diff --git a/src/square/requests/loyalty_event_accumulate_promotion_points.py b/src/square/requests/loyalty_event_accumulate_promotion_points.py new file mode 100644 index 00000000..8f597298 --- /dev/null +++ b/src/square/requests/loyalty_event_accumulate_promotion_points.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class LoyaltyEventAccumulatePromotionPointsParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. + """ + + loyalty_program_id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + loyalty_promotion_id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion). + """ + + points: int + """ + The number of points earned by the event. + """ + + order_id: str + """ + The ID of the [order](entity:Order) for which the buyer earned the promotion points. + Only applications that use the Orders API to process orders can trigger this event. + """ diff --git a/src/square/requests/loyalty_event_adjust_points.py b/src/square/requests/loyalty_event_adjust_points.py new file mode 100644 index 00000000..37fb9af5 --- /dev/null +++ b/src/square/requests/loyalty_event_adjust_points.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class LoyaltyEventAdjustPointsParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `ADJUST_POINTS`. + """ + + loyalty_program_id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: int + """ + The number of points added or removed. + """ + + reason: typing_extensions.NotRequired[typing.Optional[str]] + """ + The reason for the adjustment of points. + """ diff --git a/src/square/requests/loyalty_event_create_reward.py b/src/square/requests/loyalty_event_create_reward.py new file mode 100644 index 00000000..0203ecd7 --- /dev/null +++ b/src/square/requests/loyalty_event_create_reward.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class LoyaltyEventCreateRewardParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `CREATE_REWARD`. + """ + + loyalty_program_id: str + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + reward_id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the created [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + """ + + points: int + """ + The loyalty points used to create the reward. + """ diff --git a/src/square/requests/loyalty_event_date_time_filter.py b/src/square/requests/loyalty_event_date_time_filter.py new file mode 100644 index 00000000..7847f79e --- /dev/null +++ b/src/square/requests/loyalty_event_date_time_filter.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .time_range import TimeRangeParams + + +class LoyaltyEventDateTimeFilterParams(typing_extensions.TypedDict): + """ + Filter events by date time range. + """ + + created_at: TimeRangeParams + """ + The `created_at` date time range used to filter the result. + """ diff --git a/src/square/requests/loyalty_event_delete_reward.py b/src/square/requests/loyalty_event_delete_reward.py new file mode 100644 index 00000000..57187878 --- /dev/null +++ b/src/square/requests/loyalty_event_delete_reward.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class LoyaltyEventDeleteRewardParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `DELETE_REWARD`. + """ + + loyalty_program_id: str + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + reward_id: typing_extensions.NotRequired[str] + """ + The ID of the deleted [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + """ + + points: int + """ + The number of points returned to the loyalty account. + """ diff --git a/src/square/requests/loyalty_event_expire_points.py b/src/square/requests/loyalty_event_expire_points.py new file mode 100644 index 00000000..5743ff27 --- /dev/null +++ b/src/square/requests/loyalty_event_expire_points.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyEventExpirePointsParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `EXPIRE_POINTS`. + """ + + loyalty_program_id: str + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: int + """ + The number of points expired. + """ diff --git a/src/square/requests/loyalty_event_filter.py b/src/square/requests/loyalty_event_filter.py new file mode 100644 index 00000000..8f65a2c9 --- /dev/null +++ b/src/square/requests/loyalty_event_filter.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .loyalty_event_loyalty_account_filter import LoyaltyEventLoyaltyAccountFilterParams +from .loyalty_event_type_filter import LoyaltyEventTypeFilterParams +from .loyalty_event_date_time_filter import LoyaltyEventDateTimeFilterParams +from .loyalty_event_location_filter import LoyaltyEventLocationFilterParams +from .loyalty_event_order_filter import LoyaltyEventOrderFilterParams + + +class LoyaltyEventFilterParams(typing_extensions.TypedDict): + """ + The filtering criteria. If the request specifies multiple filters, + the endpoint uses a logical AND to evaluate them. + """ + + loyalty_account_filter: typing_extensions.NotRequired[LoyaltyEventLoyaltyAccountFilterParams] + """ + Filter events by loyalty account. + """ + + type_filter: typing_extensions.NotRequired[LoyaltyEventTypeFilterParams] + """ + Filter events by event type. + """ + + date_time_filter: typing_extensions.NotRequired[LoyaltyEventDateTimeFilterParams] + """ + Filter events by date time range. + For each range, the start time is inclusive and the end time + is exclusive. + """ + + location_filter: typing_extensions.NotRequired[LoyaltyEventLocationFilterParams] + """ + Filter events by location. + """ + + order_filter: typing_extensions.NotRequired[LoyaltyEventOrderFilterParams] + """ + Filter events by the order associated with the event. + """ diff --git a/src/square/requests/loyalty_event_location_filter.py b/src/square/requests/loyalty_event_location_filter.py new file mode 100644 index 00000000..76fddec9 --- /dev/null +++ b/src/square/requests/loyalty_event_location_filter.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing + + +class LoyaltyEventLocationFilterParams(typing_extensions.TypedDict): + """ + Filter events by location. + """ + + location_ids: typing.Sequence[str] + """ + The [location](entity:Location) IDs for loyalty events to query. + If multiple values are specified, the endpoint uses + a logical OR to combine them. + """ diff --git a/src/square/requests/loyalty_event_loyalty_account_filter.py b/src/square/requests/loyalty_event_loyalty_account_filter.py new file mode 100644 index 00000000..36f356f2 --- /dev/null +++ b/src/square/requests/loyalty_event_loyalty_account_filter.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyEventLoyaltyAccountFilterParams(typing_extensions.TypedDict): + """ + Filter events by loyalty account. + """ + + loyalty_account_id: str + """ + The ID of the [loyalty account](entity:LoyaltyAccount) associated with loyalty events. + """ diff --git a/src/square/requests/loyalty_event_order_filter.py b/src/square/requests/loyalty_event_order_filter.py new file mode 100644 index 00000000..456381d4 --- /dev/null +++ b/src/square/requests/loyalty_event_order_filter.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyEventOrderFilterParams(typing_extensions.TypedDict): + """ + Filter events by the order associated with the event. + """ + + order_id: str + """ + The ID of the [order](entity:Order) associated with the event. + """ diff --git a/src/square/requests/loyalty_event_other.py b/src/square/requests/loyalty_event_other.py new file mode 100644 index 00000000..0f180ca9 --- /dev/null +++ b/src/square/requests/loyalty_event_other.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyEventOtherParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `OTHER`. + """ + + loyalty_program_id: str + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: int + """ + The number of points added or removed. + """ diff --git a/src/square/requests/loyalty_event_query.py b/src/square/requests/loyalty_event_query.py new file mode 100644 index 00000000..1d370c18 --- /dev/null +++ b/src/square/requests/loyalty_event_query.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .loyalty_event_filter import LoyaltyEventFilterParams + + +class LoyaltyEventQueryParams(typing_extensions.TypedDict): + """ + Represents a query used to search for loyalty events. + """ + + filter: typing_extensions.NotRequired[LoyaltyEventFilterParams] + """ + The query filter criteria. + """ diff --git a/src/square/requests/loyalty_event_redeem_reward.py b/src/square/requests/loyalty_event_redeem_reward.py new file mode 100644 index 00000000..f691fcc1 --- /dev/null +++ b/src/square/requests/loyalty_event_redeem_reward.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class LoyaltyEventRedeemRewardParams(typing_extensions.TypedDict): + """ + Provides metadata when the event `type` is `REDEEM_REWARD`. + """ + + loyalty_program_id: str + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + reward_id: typing_extensions.NotRequired[str] + """ + The ID of the redeemed [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + """ + + order_id: typing_extensions.NotRequired[str] + """ + The ID of the [order](entity:Order) that redeemed the reward. + This field is returned only if the Orders API is used to process orders. + """ diff --git a/src/square/requests/loyalty_event_type_filter.py b/src/square/requests/loyalty_event_type_filter.py new file mode 100644 index 00000000..5de613b5 --- /dev/null +++ b/src/square/requests/loyalty_event_type_filter.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from ..types.loyalty_event_type import LoyaltyEventType + + +class LoyaltyEventTypeFilterParams(typing_extensions.TypedDict): + """ + Filter events by event type. + """ + + types: typing.Sequence[LoyaltyEventType] + """ + The loyalty event types used to filter the result. + If multiple values are specified, the endpoint uses a + logical OR to combine them. + See [LoyaltyEventType](#type-loyaltyeventtype) for possible values + """ diff --git a/src/square/requests/loyalty_program.py b/src/square/requests/loyalty_program.py new file mode 100644 index 00000000..aedbce71 --- /dev/null +++ b/src/square/requests/loyalty_program.py @@ -0,0 +1,67 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.loyalty_program_status import LoyaltyProgramStatus +import typing +from .loyalty_program_reward_tier import LoyaltyProgramRewardTierParams +from .loyalty_program_expiration_policy import LoyaltyProgramExpirationPolicyParams +from .loyalty_program_terminology import LoyaltyProgramTerminologyParams +from .loyalty_program_accrual_rule import LoyaltyProgramAccrualRuleParams + + +class LoyaltyProgramParams(typing_extensions.TypedDict): + """ + Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. + Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. + For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the loyalty program. Updates to + the loyalty program do not modify the identifier. + """ + + status: typing_extensions.NotRequired[LoyaltyProgramStatus] + """ + Whether the program is currently active. + See [LoyaltyProgramStatus](#type-loyaltyprogramstatus) for possible values + """ + + reward_tiers: typing_extensions.NotRequired[typing.Optional[typing.Sequence[LoyaltyProgramRewardTierParams]]] + """ + The list of rewards for buyers, sorted by ascending points. + """ + + expiration_policy: typing_extensions.NotRequired[LoyaltyProgramExpirationPolicyParams] + """ + If present, details for how points expire. + """ + + terminology: typing_extensions.NotRequired[LoyaltyProgramTerminologyParams] + """ + A cosmetic name for the “points” currency. + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The [locations](entity:Location) at which the program is active. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the program was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the reward was last updated, in RFC 3339 format. + """ + + accrual_rules: typing_extensions.NotRequired[typing.Optional[typing.Sequence[LoyaltyProgramAccrualRuleParams]]] + """ + Defines how buyers can earn loyalty points from the base loyalty program. + To check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable + buyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions). + """ diff --git a/src/square/requests/loyalty_program_accrual_rule.py b/src/square/requests/loyalty_program_accrual_rule.py new file mode 100644 index 00000000..1d987987 --- /dev/null +++ b/src/square/requests/loyalty_program_accrual_rule.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.loyalty_program_accrual_rule_type import LoyaltyProgramAccrualRuleType +import typing_extensions +import typing +from .loyalty_program_accrual_rule_visit_data import LoyaltyProgramAccrualRuleVisitDataParams +from .loyalty_program_accrual_rule_spend_data import LoyaltyProgramAccrualRuleSpendDataParams +from .loyalty_program_accrual_rule_item_variation_data import LoyaltyProgramAccrualRuleItemVariationDataParams +from .loyalty_program_accrual_rule_category_data import LoyaltyProgramAccrualRuleCategoryDataParams + + +class LoyaltyProgramAccrualRuleParams(typing_extensions.TypedDict): + """ + Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](entity:LoyaltyProgram). + """ + + accrual_type: LoyaltyProgramAccrualRuleType + """ + The type of the accrual rule that defines how buyers can earn points. + See [LoyaltyProgramAccrualRuleType](#type-loyaltyprogramaccrualruletype) for possible values + """ + + points: typing_extensions.NotRequired[typing.Optional[int]] + """ + The number of points that + buyers earn based on the `accrual_type`. + """ + + visit_data: typing_extensions.NotRequired[LoyaltyProgramAccrualRuleVisitDataParams] + """ + Additional data for rules with the `VISIT` accrual type. + """ + + spend_data: typing_extensions.NotRequired[LoyaltyProgramAccrualRuleSpendDataParams] + """ + Additional data for rules with the `SPEND` accrual type. + """ + + item_variation_data: typing_extensions.NotRequired[LoyaltyProgramAccrualRuleItemVariationDataParams] + """ + Additional data for rules with the `ITEM_VARIATION` accrual type. + """ + + category_data: typing_extensions.NotRequired[LoyaltyProgramAccrualRuleCategoryDataParams] + """ + Additional data for rules with the `CATEGORY` accrual type. + """ diff --git a/src/square/requests/loyalty_program_accrual_rule_category_data.py b/src/square/requests/loyalty_program_accrual_rule_category_data.py new file mode 100644 index 00000000..a3caa89d --- /dev/null +++ b/src/square/requests/loyalty_program_accrual_rule_category_data.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyProgramAccrualRuleCategoryDataParams(typing_extensions.TypedDict): + """ + Represents additional data for rules with the `CATEGORY` accrual type. + """ + + category_id: str + """ + The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn + points. + """ diff --git a/src/square/requests/loyalty_program_accrual_rule_item_variation_data.py b/src/square/requests/loyalty_program_accrual_rule_item_variation_data.py new file mode 100644 index 00000000..2a1b2103 --- /dev/null +++ b/src/square/requests/loyalty_program_accrual_rule_item_variation_data.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyProgramAccrualRuleItemVariationDataParams(typing_extensions.TypedDict): + """ + Represents additional data for rules with the `ITEM_VARIATION` accrual type. + """ + + item_variation_id: str + """ + The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn + points. + """ diff --git a/src/square/requests/loyalty_program_accrual_rule_spend_data.py b/src/square/requests/loyalty_program_accrual_rule_spend_data.py new file mode 100644 index 00000000..53dfd43a --- /dev/null +++ b/src/square/requests/loyalty_program_accrual_rule_spend_data.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams +import typing_extensions +import typing +from ..types.loyalty_program_accrual_rule_tax_mode import LoyaltyProgramAccrualRuleTaxMode + + +class LoyaltyProgramAccrualRuleSpendDataParams(typing_extensions.TypedDict): + """ + Represents additional data for rules with the `SPEND` accrual type. + """ + + amount_money: MoneyParams + """ + The amount that buyers must spend to earn points. + For example, given an "Earn 1 point for every $10 spent" accrual rule, a buyer who spends $105 earns 10 points. + """ + + excluded_category_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of any `CATEGORY` catalog objects that are excluded from points accrual. + + You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) + endpoint to retrieve information about the excluded categories. + """ + + excluded_item_variation_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual. + + You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) + endpoint to retrieve information about the excluded item variations. + """ + + tax_mode: LoyaltyProgramAccrualRuleTaxMode + """ + Indicates how taxes should be treated when calculating the purchase amount used for points accrual. + See [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) for possible values + """ diff --git a/src/square/requests/loyalty_program_accrual_rule_visit_data.py b/src/square/requests/loyalty_program_accrual_rule_visit_data.py new file mode 100644 index 00000000..3565947b --- /dev/null +++ b/src/square/requests/loyalty_program_accrual_rule_visit_data.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +from ..types.loyalty_program_accrual_rule_tax_mode import LoyaltyProgramAccrualRuleTaxMode + + +class LoyaltyProgramAccrualRuleVisitDataParams(typing_extensions.TypedDict): + """ + Represents additional data for rules with the `VISIT` accrual type. + """ + + minimum_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The minimum purchase required during the visit to quality for points. + """ + + tax_mode: LoyaltyProgramAccrualRuleTaxMode + """ + Indicates how taxes should be treated when calculating the purchase amount to determine whether the visit qualifies for points. + This setting applies only if `minimum_amount_money` is specified. + See [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) for possible values + """ diff --git a/src/square/requests/loyalty_program_expiration_policy.py b/src/square/requests/loyalty_program_expiration_policy.py new file mode 100644 index 00000000..749a1b78 --- /dev/null +++ b/src/square/requests/loyalty_program_expiration_policy.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyProgramExpirationPolicyParams(typing_extensions.TypedDict): + """ + Describes when the loyalty program expires. + """ + + expiration_duration: str + """ + The number of months before points expire, in `P[n]M` RFC 3339 duration format. For example, a value of `P12M` represents a duration of 12 months. + Points are valid through the last day of the month in which they are scheduled to expire. For example, with a `P12M` duration, points earned on July 6, 2020 expire on August 1, 2021. + """ diff --git a/src/square/requests/loyalty_program_reward_definition.py b/src/square/requests/loyalty_program_reward_definition.py new file mode 100644 index 00000000..bc576429 --- /dev/null +++ b/src/square/requests/loyalty_program_reward_definition.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.loyalty_program_reward_definition_scope import LoyaltyProgramRewardDefinitionScope +from ..types.loyalty_program_reward_definition_type import LoyaltyProgramRewardDefinitionType +import typing_extensions +import typing +from .money import MoneyParams + + +class LoyaltyProgramRewardDefinitionParams(typing_extensions.TypedDict): + """ + Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details + are now defined using a catalog pricing rule and other catalog objects. For more information, see + [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + """ + + scope: LoyaltyProgramRewardDefinitionScope + """ + Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. You can find this information in the + `product_set_data` field of the `PRODUCT_SET` catalog object referenced by the pricing rule. For `ORDER` scopes, + `all_products` is true. For `ITEM_VARIATION` or `CATEGORY` scopes, `product_ids_any` is a list of + catalog object IDs of the given type. + See [LoyaltyProgramRewardDefinitionScope](#type-loyaltyprogramrewarddefinitionscope) for possible values + """ + + discount_type: LoyaltyProgramRewardDefinitionType + """ + The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. You can find this information + in the `discount_data.discount_type` field of the `DISCOUNT` catalog object referenced by the pricing rule. + See [LoyaltyProgramRewardDefinitionType](#type-loyaltyprogramrewarddefinitiontype) for possible values + """ + + percentage_discount: typing_extensions.NotRequired[str] + """ + The fixed percentage of the discount. Present if `discount_type` is `FIXED_PERCENTAGE`. + For example, a 7.25% off discount will be represented as "7.25". DEPRECATED at version 2020-12-16. You can find this + information in the `discount_data.percentage` field of the `DISCOUNT` catalog object referenced by the pricing rule. + """ + + catalog_object_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the `type` field. + DEPRECATED at version 2020-12-16. You can find this information in the `product_set_data.product_ids_any` field + of the `PRODUCT_SET` catalog object referenced by the pricing rule. + """ + + fixed_discount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of the discount. Present if `discount_type` is `FIXED_AMOUNT`. For example, $5 off. + DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.amount_money` field of the + `DISCOUNT` catalog object referenced by the pricing rule. + """ + + max_discount_money: typing_extensions.NotRequired[MoneyParams] + """ + When `discount_type` is `FIXED_PERCENTAGE`, the maximum discount amount that can be applied. + DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.maximum_amount_money` field + of the `DISCOUNT` catalog object referenced by the the pricing rule. + """ diff --git a/src/square/requests/loyalty_program_reward_tier.py b/src/square/requests/loyalty_program_reward_tier.py new file mode 100644 index 00000000..edfeaaad --- /dev/null +++ b/src/square/requests/loyalty_program_reward_tier.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .loyalty_program_reward_definition import LoyaltyProgramRewardDefinitionParams +from .catalog_object_reference import CatalogObjectReferenceParams + + +class LoyaltyProgramRewardTierParams(typing_extensions.TypedDict): + """ + Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the reward tier. + """ + + points: int + """ + The points exchanged for the reward tier. + """ + + name: typing_extensions.NotRequired[str] + """ + The name of the reward tier. + """ + + definition: typing_extensions.NotRequired[LoyaltyProgramRewardDefinitionParams] + """ + Provides details about the reward tier definition. + DEPRECATED at version 2020-12-16. Replaced by the `pricing_rule_reference` field. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the reward tier was created, in RFC 3339 format. + """ + + pricing_rule_reference: CatalogObjectReferenceParams + """ + A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount. + + Use `object_id` and `catalog_version` with the [RetrieveCatalogObject](api-endpoint:Catalog-RetrieveCatalogObject) endpoint + to get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects + that define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + """ diff --git a/src/square/requests/loyalty_program_terminology.py b/src/square/requests/loyalty_program_terminology.py new file mode 100644 index 00000000..7b238ffa --- /dev/null +++ b/src/square/requests/loyalty_program_terminology.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyProgramTerminologyParams(typing_extensions.TypedDict): + """ + Represents the naming used for loyalty points. + """ + + one: str + """ + A singular unit for a point (for example, 1 point is called 1 star). + """ + + other: str + """ + A plural unit for point (for example, 10 points is called 10 stars). + """ diff --git a/src/square/requests/loyalty_promotion.py b/src/square/requests/loyalty_promotion.py new file mode 100644 index 00000000..0640bc67 --- /dev/null +++ b/src/square/requests/loyalty_promotion.py @@ -0,0 +1,99 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .loyalty_promotion_incentive import LoyaltyPromotionIncentiveParams +from .loyalty_promotion_available_time_data import LoyaltyPromotionAvailableTimeDataParams +from .loyalty_promotion_trigger_limit import LoyaltyPromotionTriggerLimitParams +from ..types.loyalty_promotion_status import LoyaltyPromotionStatus +from .money import MoneyParams +import typing + + +class LoyaltyPromotionParams(typing_extensions.TypedDict): + """ + Represents a promotion for a [loyalty program](entity:LoyaltyProgram). Loyalty promotions enable buyers + to earn extra points on top of those earned from the base program. + + A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the promotion. + """ + + name: str + """ + The name of the promotion. + """ + + incentive: LoyaltyPromotionIncentiveParams + """ + The points incentive for the promotion. This field defines whether promotion points + are earned by multiplying base program points or by adding a specified number of points. + """ + + available_time: LoyaltyPromotionAvailableTimeDataParams + """ + The scheduling information that defines when purchases can qualify to earn points from an `ACTIVE` promotion. + """ + + trigger_limit: typing_extensions.NotRequired[LoyaltyPromotionTriggerLimitParams] + """ + The number of times a buyer can earn promotion points during a specified interval. + If not specified, buyers can trigger the promotion an unlimited number of times. + """ + + status: typing_extensions.NotRequired[LoyaltyPromotionStatus] + """ + The current status of the promotion. + See [LoyaltyPromotionStatus](#type-loyaltypromotionstatus) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the promotion was created, in RFC 3339 format. + """ + + canceled_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the promotion was canceled, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the promotion was last updated, in RFC 3339 format. + """ + + loyalty_program_id: typing_extensions.NotRequired[str] + """ + The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion. + """ + + minimum_spend_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The minimum purchase amount required to earn promotion points. If specified, this amount is positive. + """ + + qualifying_item_variation_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified, + the purchase must include at least one of these items to qualify for the promotion. + + This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. + With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. + + You can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both. + """ + + qualifying_category_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified, + the purchase must include at least one item from one of these categories to qualify for the promotion. + + This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. + With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. + + You can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both. + """ diff --git a/src/square/requests/loyalty_promotion_available_time_data.py b/src/square/requests/loyalty_promotion_available_time_data.py new file mode 100644 index 00000000..0baaa907 --- /dev/null +++ b/src/square/requests/loyalty_promotion_available_time_data.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class LoyaltyPromotionAvailableTimeDataParams(typing_extensions.TypedDict): + """ + Represents scheduling information that determines when purchases can qualify to earn points + from a [loyalty promotion](entity:LoyaltyPromotion). + """ + + start_date: typing_extensions.NotRequired[str] + """ + The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field + based on the provided `time_periods`. + """ + + end_date: typing_extensions.NotRequired[str] + """ + The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field + based on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion + remains available until it is canceled. + """ + + time_periods: typing.Sequence[str] + """ + A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1) + (`VEVENT`). Each event represents an available time period per day or days of the week. + A day can have a maximum of one available time period. + + Only `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and + timestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions, + an end date (using the `UNTIL` keyword), or both. For more information, see + [Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time). + + Note that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request + but are always included in the response. + """ diff --git a/src/square/requests/loyalty_promotion_incentive.py b/src/square/requests/loyalty_promotion_incentive.py new file mode 100644 index 00000000..a47c59ac --- /dev/null +++ b/src/square/requests/loyalty_promotion_incentive.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.loyalty_promotion_incentive_type import LoyaltyPromotionIncentiveType +import typing_extensions +from .loyalty_promotion_incentive_points_multiplier_data import LoyaltyPromotionIncentivePointsMultiplierDataParams +from .loyalty_promotion_incentive_points_addition_data import LoyaltyPromotionIncentivePointsAdditionDataParams + + +class LoyaltyPromotionIncentiveParams(typing_extensions.TypedDict): + """ + Represents how points for a [loyalty promotion](entity:LoyaltyPromotion) are calculated, + either by multiplying the points earned from the base program or by adding a specified number + of points to the points earned from the base program. + """ + + type: LoyaltyPromotionIncentiveType + """ + The type of points incentive. + See [LoyaltyPromotionIncentiveType](#type-loyaltypromotionincentivetype) for possible values + """ + + points_multiplier_data: typing_extensions.NotRequired[LoyaltyPromotionIncentivePointsMultiplierDataParams] + """ + Additional data for a `POINTS_MULTIPLIER` incentive type. + """ + + points_addition_data: typing_extensions.NotRequired[LoyaltyPromotionIncentivePointsAdditionDataParams] + """ + Additional data for a `POINTS_ADDITION` incentive type. + """ diff --git a/src/square/requests/loyalty_promotion_incentive_points_addition_data.py b/src/square/requests/loyalty_promotion_incentive_points_addition_data.py new file mode 100644 index 00000000..e2362e00 --- /dev/null +++ b/src/square/requests/loyalty_promotion_incentive_points_addition_data.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class LoyaltyPromotionIncentivePointsAdditionDataParams(typing_extensions.TypedDict): + """ + Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive). + """ + + points_addition: int + """ + The number of additional points to earn each time the promotion is triggered. For example, + suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also + qualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer + earns a total of 8 points (5 program points + 3 promotion points = 8 points). + """ diff --git a/src/square/requests/loyalty_promotion_incentive_points_multiplier_data.py b/src/square/requests/loyalty_promotion_incentive_points_multiplier_data.py new file mode 100644 index 00000000..2f727e28 --- /dev/null +++ b/src/square/requests/loyalty_promotion_incentive_points_multiplier_data.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class LoyaltyPromotionIncentivePointsMultiplierDataParams(typing_extensions.TypedDict): + """ + Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive). + """ + + points_multiplier: typing_extensions.NotRequired[typing.Optional[int]] + """ + The multiplier used to calculate the number of points earned each time the promotion + is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program. + If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier` + of 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points). + + DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field. + + One of the following is required when specifying a points multiplier: + - (Recommended) The `multiplier` field. + - This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` + with the equivalent value. + """ + + multiplier: typing_extensions.NotRequired[typing.Optional[str]] + """ + The multiplier used to calculate the number of points earned each time the promotion is triggered, + specified as a string representation of a decimal. Square supports multipliers up to 10x, with three + point precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the + base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a + `multiplier` of "1.5", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points). + Fractional points are dropped. + + One of the following is required when specifying a points multiplier: + - (Recommended) This `multiplier` field. + - The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` + with the equivalent value. + """ diff --git a/src/square/requests/loyalty_promotion_trigger_limit.py b/src/square/requests/loyalty_promotion_trigger_limit.py new file mode 100644 index 00000000..8742d882 --- /dev/null +++ b/src/square/requests/loyalty_promotion_trigger_limit.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.loyalty_promotion_trigger_limit_interval import LoyaltyPromotionTriggerLimitInterval + + +class LoyaltyPromotionTriggerLimitParams(typing_extensions.TypedDict): + """ + Represents the number of times a buyer can earn points during a [loyalty promotion](entity:LoyaltyPromotion). + If this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during + the time that the promotion is available. + + A purchase that is disqualified from earning points because of this limit might qualify for another active promotion. + """ + + times: int + """ + The maximum number of times a buyer can trigger the promotion during the specified `interval`. + """ + + interval: typing_extensions.NotRequired[LoyaltyPromotionTriggerLimitInterval] + """ + The time period the limit applies to. + See [LoyaltyPromotionTriggerLimitInterval](#type-loyaltypromotiontriggerlimitinterval) for possible values + """ diff --git a/src/square/requests/loyalty_reward.py b/src/square/requests/loyalty_reward.py new file mode 100644 index 00000000..b838475e --- /dev/null +++ b/src/square/requests/loyalty_reward.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.loyalty_reward_status import LoyaltyRewardStatus +import typing + + +class LoyaltyRewardParams(typing_extensions.TypedDict): + """ + Represents a contract to redeem loyalty points for a [reward tier](entity:LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. + For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the loyalty reward. + """ + + status: typing_extensions.NotRequired[LoyaltyRewardStatus] + """ + The status of a loyalty reward. + See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values + """ + + loyalty_account_id: str + """ + The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount) to which the reward belongs. + """ + + reward_tier_id: str + """ + The Square-assigned ID of the [reward tier](entity:LoyaltyProgramRewardTier) used to create the reward. + """ + + points: typing_extensions.NotRequired[int] + """ + The number of loyalty points used for the reward. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-assigned ID of the [order](entity:Order) to which the reward is attached. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the reward was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the reward was last updated, in RFC 3339 format. + """ + + redeemed_at: typing_extensions.NotRequired[str] + """ + The timestamp when the reward was redeemed, in RFC 3339 format. + """ diff --git a/src/square/requests/measurement_unit.py b/src/square/requests/measurement_unit.py new file mode 100644 index 00000000..161506af --- /dev/null +++ b/src/square/requests/measurement_unit.py @@ -0,0 +1,68 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .measurement_unit_custom import MeasurementUnitCustomParams +from ..types.measurement_unit_area import MeasurementUnitArea +from ..types.measurement_unit_length import MeasurementUnitLength +from ..types.measurement_unit_volume import MeasurementUnitVolume +from ..types.measurement_unit_weight import MeasurementUnitWeight +from ..types.measurement_unit_generic import MeasurementUnitGeneric +from ..types.measurement_unit_time import MeasurementUnitTime +from ..types.measurement_unit_unit_type import MeasurementUnitUnitType + + +class MeasurementUnitParams(typing_extensions.TypedDict): + """ + Represents a unit of measurement to use with a quantity, such as ounces + or inches. Exactly one of the following fields are required: `custom_unit`, + `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. + """ + + custom_unit: typing_extensions.NotRequired[MeasurementUnitCustomParams] + """ + A custom unit of measurement defined by the seller using the Point of Sale + app or ad-hoc as an order line item. + """ + + area_unit: typing_extensions.NotRequired[MeasurementUnitArea] + """ + Represents a standard area unit. + See [MeasurementUnitArea](#type-measurementunitarea) for possible values + """ + + length_unit: typing_extensions.NotRequired[MeasurementUnitLength] + """ + Represents a standard length unit. + See [MeasurementUnitLength](#type-measurementunitlength) for possible values + """ + + volume_unit: typing_extensions.NotRequired[MeasurementUnitVolume] + """ + Represents a standard volume unit. + See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values + """ + + weight_unit: typing_extensions.NotRequired[MeasurementUnitWeight] + """ + Represents a standard unit of weight or mass. + See [MeasurementUnitWeight](#type-measurementunitweight) for possible values + """ + + generic_unit: typing_extensions.NotRequired[MeasurementUnitGeneric] + """ + Reserved for API integrations that lack the ability to specify a real measurement unit + See [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values + """ + + time_unit: typing_extensions.NotRequired[MeasurementUnitTime] + """ + Represents a standard unit of time. + See [MeasurementUnitTime](#type-measurementunittime) for possible values + """ + + type: typing_extensions.NotRequired[MeasurementUnitUnitType] + """ + Represents the type of the measurement unit. + See [MeasurementUnitUnitType](#type-measurementunitunittype) for possible values + """ diff --git a/src/square/requests/measurement_unit_custom.py b/src/square/requests/measurement_unit_custom.py new file mode 100644 index 00000000..cd45f37c --- /dev/null +++ b/src/square/requests/measurement_unit_custom.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class MeasurementUnitCustomParams(typing_extensions.TypedDict): + """ + The information needed to define a custom unit, provided by the seller. + """ + + name: str + """ + The name of the custom unit, for example "bushel". + """ + + abbreviation: str + """ + The abbreviation of the custom unit, such as "bsh" (bushel). This appears + in the cart for the Point of Sale app, and in reports. + """ diff --git a/src/square/requests/merchant.py b/src/square/requests/merchant.py new file mode 100644 index 00000000..ac2e498d --- /dev/null +++ b/src/square/requests/merchant.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.country import Country +from ..types.currency import Currency +from ..types.merchant_status import MerchantStatus + + +class MerchantParams(typing_extensions.TypedDict): + """ + Represents a business that sells with Square. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-issued ID of the merchant. + """ + + business_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the merchant's overall business. + """ + + country: Country + """ + The country code associated with the merchant, in the two-letter format of ISO 3166. For example, `US` or `JP`. + See [Country](#type-country) for possible values + """ + + language_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The code indicating the [language preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`. + """ + + currency: typing_extensions.NotRequired[Currency] + """ + The currency associated with the merchant, in ISO 4217 format. For example, the currency code for US dollars is `USD`. + See [Currency](#type-currency) for possible values + """ + + status: typing_extensions.NotRequired[MerchantStatus] + """ + The merchant's status. + See [MerchantStatus](#type-merchantstatus) for possible values + """ + + main_location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-location) for this merchant. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the merchant was created, in RFC 3339 format. + For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). + """ diff --git a/src/square/requests/modifier_location_overrides.py b/src/square/requests/modifier_location_overrides.py new file mode 100644 index 00000000..6b9a397b --- /dev/null +++ b/src/square/requests/modifier_location_overrides.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class ModifierLocationOverridesParams(typing_extensions.TypedDict): + """ + Location-specific overrides for specified properties of a `CatalogModifier` object. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the `Location` object representing the location. This can include a deactivated location. + """ + + price_money: typing_extensions.NotRequired[MoneyParams] + """ + The overridden price at the specified location. If this is unspecified, the modifier price is not overridden. + The modifier becomes free of charge at the specified location, when this `price_money` field is set to 0. + """ + + sold_out: typing_extensions.NotRequired[bool] + """ + Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out. + The seller can manually set this sold out status. Attempts by an application to set this attribute are ignored. + """ diff --git a/src/square/requests/money.py b/src/square/requests/money.py new file mode 100644 index 00000000..4d034a09 --- /dev/null +++ b/src/square/requests/money.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.currency import Currency + + +class MoneyParams(typing_extensions.TypedDict): + """ + Represents an amount of money. `Money` fields can be signed or unsigned. + Fields that do not explicitly define whether they are signed or unsigned are + considered unsigned and can only hold positive amounts. For signed fields, the + sign of the value indicates the purpose of the money transfer. See + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) + for more information. + """ + + amount: typing_extensions.NotRequired[typing.Optional[int]] + """ + The amount of money, in the smallest denomination of the currency + indicated by `currency`. For example, when `currency` is `USD`, `amount` is + in cents. Monetary amounts can be positive or negative. See the specific + field description to determine the meaning of the sign in a particular case. + """ + + currency: typing_extensions.NotRequired[Currency] + """ + The type of currency, in __ISO 4217 format__. For example, the currency + code for US dollars is `USD`. + + See [Currency](entity:Currency) for possible values. + See [Currency](#type-currency) for possible values + """ diff --git a/src/square/requests/obtain_token_response.py b/src/square/requests/obtain_token_response.py new file mode 100644 index 00000000..debf7560 --- /dev/null +++ b/src/square/requests/obtain_token_response.py @@ -0,0 +1,93 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class ObtainTokenResponseParams(typing_extensions.TypedDict): + """ + Represents an [ObtainToken](api-endpoint:OAuth-ObtainToken) response. + """ + + access_token: typing_extensions.NotRequired[str] + """ + An OAuth access token used to authorize Square API requests on behalf of the seller. + Include this token as a bearer token in the `Authorization` header of your API requests. + + OAuth access tokens expire in 30 days (except `short_lived` access tokens). You should call + `ObtainToken` and provide the returned `refresh_token` to get a new access token well before + the current one expires. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough). + """ + + token_type: typing_extensions.NotRequired[str] + """ + The type of access token. This value is always `bearer`. + """ + + expires_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. + """ + + merchant_id: typing_extensions.NotRequired[str] + """ + The ID of the authorizing [merchant](entity:Merchant) (seller), which represents a business. + """ + + subscription_id: typing_extensions.NotRequired[str] + """ + __LEGACY__ The ID of merchant's subscription. + The ID is only present if the merchant signed up for a subscription plan during authorization. + """ + + plan_id: typing_extensions.NotRequired[str] + """ + __LEGACY__ The ID of the subscription plan the merchant signed + up for. The ID is only present if the merchant signed up for a subscription plan during + authorization. + """ + + id_token: typing_extensions.NotRequired[str] + """ + The OpenID token that belongs to this person. This token is only present if the + `OPENID` scope is included in the authorization request. + + Deprecated at version 2021-09-15. Square doesn't support OpenID or other single sign-on (SSO) + protocols on top of OAuth. + """ + + refresh_token: typing_extensions.NotRequired[str] + """ + A refresh token that can be used in an `ObtainToken` request to generate a new access token. + + With the code flow: + - For the `authorization_code` grant type, the refresh token is multi-use and never expires. + - For the `refresh_token` grant type, the response returns the same refresh token. + + With the PKCE flow: + - For the `authorization_code` grant type, the refresh token is single-use and expires in 90 days. + - For the `refresh_token` grant type, the refresh token is a new single-use refresh token that expires in 90 days. + + For more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope). + """ + + short_lived: typing_extensions.NotRequired[bool] + """ + Indicates whether the access_token is short lived. If `true`, the access token expires + in 24 hours. If `false`, the access token expires in 30 days. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + refresh_token_expires_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) + format. + + This field is only returned for the PKCE flow. + """ diff --git a/src/square/requests/offline_payment_details.py b/src/square/requests/offline_payment_details.py new file mode 100644 index 00000000..9e76b90a --- /dev/null +++ b/src/square/requests/offline_payment_details.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class OfflinePaymentDetailsParams(typing_extensions.TypedDict): + """ + Details specific to offline payments. + """ + + client_created_at: typing_extensions.NotRequired[str] + """ + The client-side timestamp of when the offline payment was created, in RFC 3339 format. + """ diff --git a/src/square/requests/order.py b/src/square/requests/order.py new file mode 100644 index 00000000..52658a8f --- /dev/null +++ b/src/square/requests/order.py @@ -0,0 +1,246 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order_source import OrderSourceParams +from .order_line_item import OrderLineItemParams +from .order_line_item_tax import OrderLineItemTaxParams +from .order_line_item_discount import OrderLineItemDiscountParams +from .order_service_charge import OrderServiceChargeParams +from .fulfillment import FulfillmentParams +from .order_return import OrderReturnParams +from .order_money_amounts import OrderMoneyAmountsParams +from .order_rounding_adjustment import OrderRoundingAdjustmentParams +from .tender import TenderParams +from .refund import RefundParams +from ..types.order_state import OrderState +from .money import MoneyParams +from .order_pricing_options import OrderPricingOptionsParams +from .order_reward import OrderRewardParams + + +class OrderParams(typing_extensions.TypedDict): + """ + Contains all information related to a single order to process with Square, + including line items that specify the products to purchase. `Order` objects also + include information about any associated tenders, refunds, and returns. + + All Connect V2 Transactions have all been converted to Orders including all associated + itemization data. + """ + + id: typing_extensions.NotRequired[str] + """ + The order's unique ID. + """ + + location_id: str + """ + The ID of the seller location that this order is associated with. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-specified ID to associate an entity in another system + with this order. + """ + + source: typing_extensions.NotRequired[OrderSourceParams] + """ + The origination details of the order. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [customer](entity:Customer) associated with the order. + + You should specify a `customer_id` on the order (or the payment) to ensure that transactions + are reliably linked to customers. Omitting this field might result in the creation of new + [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + """ + + line_items: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemParams]]] + """ + The line items included in the order. + """ + + taxes: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemTaxParams]]] + """ + The list of all taxes associated with the order. + + Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an + `OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes + with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item. + + On reads, each tax in the list includes the total amount of that tax applied to the order. + + __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated + `line_items.taxes` field results in an error. Use `line_items.applied_taxes` + instead. + """ + + discounts: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemDiscountParams]]] + """ + The list of all discounts associated with the order. + + Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`, + an `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to. + For discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount` + for every line item. + + __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated + `line_items.discounts` field results in an error. Use `line_items.applied_discounts` + instead. + """ + + service_charges: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderServiceChargeParams]]] + """ + A list of service charges applied to the order. + """ + + fulfillments: typing_extensions.NotRequired[typing.Optional[typing.Sequence[FulfillmentParams]]] + """ + Details about order fulfillment. + + Orders can only be created with at most one fulfillment. However, orders returned + by the API might contain multiple fulfillments. + """ + + returns: typing_extensions.NotRequired[typing.Sequence[OrderReturnParams]] + """ + A collection of items from sale orders being returned in this one. Normally part of an + itemized return or exchange. There is exactly one `Return` object per sale `Order` being + referenced. + """ + + return_amounts: typing_extensions.NotRequired[OrderMoneyAmountsParams] + """ + The rollup of the returned money amounts. + """ + + net_amounts: typing_extensions.NotRequired[OrderMoneyAmountsParams] + """ + The net money amounts (sale money - return money). + """ + + rounding_adjustment: typing_extensions.NotRequired[OrderRoundingAdjustmentParams] + """ + A positive rounding adjustment to the total of the order. This adjustment is commonly + used to apply cash rounding when the minimum unit of account is smaller than the lowest physical + denomination of the currency. + """ + + tenders: typing_extensions.NotRequired[typing.Sequence[TenderParams]] + """ + The tenders that were used to pay for the order. + """ + + refunds: typing_extensions.NotRequired[typing.Sequence[RefundParams]] + """ + The refunds that are part of this order. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this order. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + closed_at: typing_extensions.NotRequired[str] + """ + The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). + """ + + state: typing_extensions.NotRequired[OrderState] + """ + The current state of the order. + See [OrderState](#type-orderstate) for possible values + """ + + version: typing_extensions.NotRequired[int] + """ + The version number, which is incremented each time an update is committed to the order. + Orders not created through the API do not include a version number and + therefore cannot be updated. + + [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders). + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of money to collect for the order. + """ + + total_tax_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of tax money to collect for the order. + """ + + total_discount_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of discount money to collect for the order. + """ + + total_tip_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of tip money to collect for the order. + """ + + total_service_charge_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of money collected in service charges for the order. + + Note: `total_service_charge_money` is the sum of `applied_money` fields for each individual + service charge. Therefore, `total_service_charge_money` only includes inclusive tax amounts, + not additive tax amounts. + """ + + ticket_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A short-term identifier for the order (such as a customer first name, + table number, or auto-generated order number that resets daily). + """ + + pricing_options: typing_extensions.NotRequired[OrderPricingOptionsParams] + """ + Pricing options for an order. The options affect how the order's price is calculated. + They can be used, for example, to apply automatic price adjustments that are based on + preconfigured [pricing rules](entity:CatalogPricingRule). + """ + + rewards: typing_extensions.NotRequired[typing.Sequence[OrderRewardParams]] + """ + A set-like list of Rewards that have been added to the Order. + """ + + net_amount_due_money: typing_extensions.NotRequired[MoneyParams] + """ + The net amount of money due on the order. + """ diff --git a/src/square/requests/order_entry.py b/src/square/requests/order_entry.py new file mode 100644 index 00000000..5982eff4 --- /dev/null +++ b/src/square/requests/order_entry.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class OrderEntryParams(typing_extensions.TypedDict): + """ + A lightweight description of an [order](entity:Order) that is returned when + `returned_entries` is `true` on a [SearchOrdersRequest](api-endpoint:Orders-SearchOrders). + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the order. + """ + + version: typing_extensions.NotRequired[int] + """ + The version number, which is incremented each time an update is committed to the order. + Orders that were not created through the API do not include a version number and + therefore cannot be updated. + + [Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The location ID the order belongs to. + """ diff --git a/src/square/requests/order_line_item.py b/src/square/requests/order_line_item.py new file mode 100644 index 00000000..b73d0b0e --- /dev/null +++ b/src/square/requests/order_line_item.py @@ -0,0 +1,194 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order_quantity_unit import OrderQuantityUnitParams +from ..types.order_line_item_item_type import OrderLineItemItemType +from .order_line_item_modifier import OrderLineItemModifierParams +from .order_line_item_applied_tax import OrderLineItemAppliedTaxParams +from .order_line_item_applied_discount import OrderLineItemAppliedDiscountParams +from .order_line_item_applied_service_charge import OrderLineItemAppliedServiceChargeParams +from .money import MoneyParams +from .order_line_item_pricing_blocklists import OrderLineItemPricingBlocklistsParams + + +class OrderLineItemParams(typing_extensions.TypedDict): + """ + Represents a line item in an order. Each line item describes a different + product to purchase, with its own quantity and price details. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the line item only within this order. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the line item. + """ + + quantity: str + """ + The count, or measurement, of a line item being purchased: + + If `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count. For example: `3` apples. + + If `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement. For example: `2.25` pounds of broccoli. + + For more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit). + + Line items with a quantity of `0` are automatically removed + when paying for or otherwise completing the order. + """ + + quantity_unit: typing_extensions.NotRequired[OrderQuantityUnitParams] + """ + The measurement unit and decimal precision that this line item's quantity is measured in. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional note associated with the line item. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item. + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this line item references. + """ + + variation_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the variation applied to this line item. + """ + + item_type: typing_extensions.NotRequired[OrderLineItemItemType] + """ + The type of line item: an itemized sale, a non-itemized sale (custom amount), or the + activation or reloading of a gift card. + See [OrderLineItemItemType](#type-orderlineitemitemtype) for possible values + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this line item. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + modifiers: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemModifierParams]]] + """ + The [CatalogModifier](entity:CatalogModifier)s applied to this line item. + """ + + applied_taxes: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemAppliedTaxParams]]] + """ + The list of references to taxes applied to this line item. Each + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a + top-level `OrderLineItemTax` applied to the line item. On reads, the + amount applied is populated. + + An `OrderLineItemAppliedTax` is automatically created on every line + item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` + records for `LINE_ITEM` scoped taxes must be added in requests for the tax + to apply to any line items. + + To change the amount of a tax, modify the referenced top-level tax. + """ + + applied_discounts: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderLineItemAppliedDiscountParams]] + ] + """ + The list of references to discounts applied to this line item. Each + `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level + `OrderLineItemDiscounts` applied to the line item. On reads, the amount + applied is populated. + + An `OrderLineItemAppliedDiscount` is automatically created on every line item for all + `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records + for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any + line items. + + To change the amount of a discount, modify the referenced top-level discount. + """ + + applied_service_charges: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderLineItemAppliedServiceChargeParams]] + ] + """ + The list of references to service charges applied to this line item. Each + `OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a + top-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is + populated. + + To change the amount of a service charge, modify the referenced top-level service charge. + """ + + base_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The base price for a single unit of the line item. + """ + + variation_total_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The total price of all item variations sold in this line item. + The price is calculated as `base_price_money` multiplied by `quantity`. + It does not include modifiers. + """ + + gross_sales_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money made in gross sales for this line item. + The amount is calculated as the sum of the variation's total price and each modifier's total price. + For inclusive tax items in the US, Canada, and Japan, tax is deducted from `gross_sales_money`. For Europe and + Australia, inclusive tax remains as part of the gross sale calculation. + """ + + total_tax_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of tax money to collect for the line item. + """ + + total_discount_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of discount money to collect for the line item. + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of money to collect for this line item. + """ + + pricing_blocklists: typing_extensions.NotRequired[OrderLineItemPricingBlocklistsParams] + """ + Describes pricing adjustments that are blocked from automatic + application to a line item. For more information, see + [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). + """ + + total_service_charge_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of apportioned service charge money to collect for the line item. + """ diff --git a/src/square/requests/order_line_item_applied_discount.py b/src/square/requests/order_line_item_applied_discount.py new file mode 100644 index 00000000..65846c1c --- /dev/null +++ b/src/square/requests/order_line_item_applied_discount.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderLineItemAppliedDiscountParams(typing_extensions.TypedDict): + """ + Represents an applied portion of a discount to a line item in an order. + + Order scoped discounts have automatically applied discounts present for each line item. + Line-item scoped discounts must have applied discounts added manually for any applicable line + items. The corresponding applied money is automatically computed based on participating + line items. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the applied discount only within this order. + """ + + discount_uid: str + """ + The `uid` of the discount that the applied discount represents. It must + reference a discount present in the `order.discounts` field. + + This field is immutable. To change which discounts apply to a line item, + you must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied by the discount to the line item. + """ diff --git a/src/square/requests/order_line_item_applied_service_charge.py b/src/square/requests/order_line_item_applied_service_charge.py new file mode 100644 index 00000000..831fd65f --- /dev/null +++ b/src/square/requests/order_line_item_applied_service_charge.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderLineItemAppliedServiceChargeParams(typing_extensions.TypedDict): + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the applied service charge only within this order. + """ + + service_charge_uid: str + """ + The `uid` of the service charge that the applied service charge represents. It must + reference a service charge present in the `order.service_charges` field. + + This field is immutable. To change which service charges apply to a line item, + delete and add a new `OrderLineItemAppliedServiceCharge`. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied by the service charge to the line item. + """ diff --git a/src/square/requests/order_line_item_applied_tax.py b/src/square/requests/order_line_item_applied_tax.py new file mode 100644 index 00000000..9ad533be --- /dev/null +++ b/src/square/requests/order_line_item_applied_tax.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderLineItemAppliedTaxParams(typing_extensions.TypedDict): + """ + Represents an applied portion of a tax to a line item in an order. + + Order-scoped taxes automatically include the applied taxes in each line item. + Line item taxes must be referenced from any applicable line items. + The corresponding applied money is automatically computed, based on the + set of participating line items. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the applied tax only within this order. + """ + + tax_uid: str + """ + The `uid` of the tax for which this applied tax represents. It must reference + a tax present in the `order.taxes` field. + + This field is immutable. To change which taxes apply to a line item, delete and add a new + `OrderLineItemAppliedTax`. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied by the tax to the line item. + """ diff --git a/src/square/requests/order_line_item_discount.py b/src/square/requests/order_line_item_discount.py new file mode 100644 index 00000000..2e16566d --- /dev/null +++ b/src/square/requests/order_line_item_discount.py @@ -0,0 +1,124 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.order_line_item_discount_type import OrderLineItemDiscountType +from .money import MoneyParams +from ..types.order_line_item_discount_scope import OrderLineItemDiscountScope + + +class OrderLineItemDiscountParams(typing_extensions.TypedDict): + """ + Represents a discount that applies to one or more line items in an + order. + + Fixed-amount, order-scoped discounts are distributed across all non-zero line item totals. + The amount distributed to each line item is relative to the + amount contributed by the item to the order subtotal. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the discount only within this order. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this discount references. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The discount's name. + """ + + type: typing_extensions.NotRequired[OrderLineItemDiscountType] + """ + The type of the discount. + + Discounts that do not reference a catalog object ID must have a type of + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the discount, as a string representation of a decimal number. + A value of `7.25` corresponds to a percentage of 7.25%. + + `percentage` is not set for amount-based discounts. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The total declared monetary amount of the discount. + + `amount_money` is not set for percentage-based discounts. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of discount actually applied to the line item. + + The amount represents the amount of money applied as a line-item scoped discount. + When an amount-based discount is scoped to the entire order, the value + of `applied_money` is different than `amount_money` because the total + amount of the discount is distributed across all line items. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this discount. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + scope: typing_extensions.NotRequired[OrderLineItemDiscountScope] + """ + Indicates the level at which the discount applies. For `ORDER` scoped discounts, + Square generates references in `applied_discounts` on all order line items that do + not have them. For `LINE_ITEM` scoped discounts, the discount only applies to line items + with a discount reference in their `applied_discounts` field. + + This field is immutable. To change the scope of a discount, you must delete + the discount and re-add it as a new discount. + See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values + """ + + reward_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The reward IDs corresponding to this discount. The application and + specification of discounts that have `reward_ids` are completely controlled by the backing + criteria corresponding to the reward tiers of the rewards that are added to the order + through the Loyalty API. To manually unapply discounts that are the result of added rewards, + the rewards must be removed from the order through the Loyalty API. + """ + + pricing_rule_id: typing_extensions.NotRequired[str] + """ + The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied + automatically to this discount. The specification and application of the discounts, to + which a `pricing_rule_id` is assigned, are completely controlled by the corresponding + pricing rule. + """ diff --git a/src/square/requests/order_line_item_modifier.py b/src/square/requests/order_line_item_modifier.py new file mode 100644 index 00000000..01e024b2 --- /dev/null +++ b/src/square/requests/order_line_item_modifier.py @@ -0,0 +1,80 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderLineItemModifierParams(typing_extensions.TypedDict): + """ + A [CatalogModifier](entity:CatalogModifier). + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the modifier only within this order. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing [CatalogModifier](entity:CatalogModifier). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this modifier references. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the item modifier. + """ + + quantity: typing_extensions.NotRequired[typing.Optional[str]] + """ + The quantity of the line item modifier. The modifier quantity can be 0 or more. + For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders + this item, the restaurant records the purchase by creating an `Order` object with a line item + for a burger. The line item includes a line item modifier: the name is cheese and the quantity + is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses + the extra cheese option, the modifier quantity increases to 2. If the buyer does not want + any cheese, the modifier quantity is set to 0. + """ + + base_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The base price for the modifier. + + `base_price_money` is required for ad hoc modifiers. + If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will + override the predefined [CatalogModifier](entity:CatalogModifier) price. + """ + + total_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The total price of the item modifier for its line item. + This is the modifier's `base_price_money` multiplied by the line item's quantity. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this order. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ diff --git a/src/square/requests/order_line_item_pricing_blocklists.py b/src/square/requests/order_line_item_pricing_blocklists.py new file mode 100644 index 00000000..fb3b6373 --- /dev/null +++ b/src/square/requests/order_line_item_pricing_blocklists.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order_line_item_pricing_blocklists_blocked_discount import OrderLineItemPricingBlocklistsBlockedDiscountParams +from .order_line_item_pricing_blocklists_blocked_tax import OrderLineItemPricingBlocklistsBlockedTaxParams + + +class OrderLineItemPricingBlocklistsParams(typing_extensions.TypedDict): + """ + Describes pricing adjustments that are blocked from automatic + application to a line item. For more information, see + [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). + """ + + blocked_discounts: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderLineItemPricingBlocklistsBlockedDiscountParams]] + ] + """ + A list of discounts blocked from applying to the line item. + Discounts can be blocked by the `discount_uid` (for ad hoc discounts) or + the `discount_catalog_object_id` (for catalog discounts). + """ + + blocked_taxes: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderLineItemPricingBlocklistsBlockedTaxParams]] + ] + """ + A list of taxes blocked from applying to the line item. + Taxes can be blocked by the `tax_uid` (for ad hoc taxes) or + the `tax_catalog_object_id` (for catalog taxes). + """ diff --git a/src/square/requests/order_line_item_pricing_blocklists_blocked_discount.py b/src/square/requests/order_line_item_pricing_blocklists_blocked_discount.py new file mode 100644 index 00000000..b957c317 --- /dev/null +++ b/src/square/requests/order_line_item_pricing_blocklists_blocked_discount.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class OrderLineItemPricingBlocklistsBlockedDiscountParams(typing_extensions.TypedDict): + """ + A discount to block from applying to a line item. The discount must be + identified by either `discount_uid` or `discount_catalog_object_id`, but not both. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID of the `BlockedDiscount` within the order. + """ + + discount_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `uid` of the discount that should be blocked. Use this field to block + ad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field. + """ + + discount_catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `catalog_object_id` of the discount that should be blocked. + Use this field to block catalog discounts. For ad hoc discounts, use the + `discount_uid` field. + """ diff --git a/src/square/requests/order_line_item_pricing_blocklists_blocked_tax.py b/src/square/requests/order_line_item_pricing_blocklists_blocked_tax.py new file mode 100644 index 00000000..8b18190a --- /dev/null +++ b/src/square/requests/order_line_item_pricing_blocklists_blocked_tax.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class OrderLineItemPricingBlocklistsBlockedTaxParams(typing_extensions.TypedDict): + """ + A tax to block from applying to a line item. The tax must be + identified by either `tax_uid` or `tax_catalog_object_id`, but not both. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID of the `BlockedTax` within the order. + """ + + tax_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `uid` of the tax that should be blocked. Use this field to block + ad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field. + """ + + tax_catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `catalog_object_id` of the tax that should be blocked. + Use this field to block catalog taxes. For ad hoc taxes, use the + `tax_uid` field. + """ diff --git a/src/square/requests/order_line_item_tax.py b/src/square/requests/order_line_item_tax.py new file mode 100644 index 00000000..025eefc1 --- /dev/null +++ b/src/square/requests/order_line_item_tax.py @@ -0,0 +1,100 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.order_line_item_tax_type import OrderLineItemTaxType +from .money import MoneyParams +from ..types.order_line_item_tax_scope import OrderLineItemTaxScope + + +class OrderLineItemTaxParams(typing_extensions.TypedDict): + """ + Represents a tax that applies to one or more line item in the order. + + Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. + The amount distributed to each line item is relative to the amount the item + contributes to the order subtotal. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the tax only within this order. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing [CatalogTax](entity:CatalogTax). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this tax references. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tax's name. + """ + + type: typing_extensions.NotRequired[OrderLineItemTaxType] + """ + Indicates the calculation method used to apply the tax. + See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the tax, as a string representation of a decimal + number. For example, a value of `"7.25"` corresponds to a percentage of + 7.25%. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this tax. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied to the order by the tax. + + - For percentage-based taxes, `applied_money` is the money + calculated using the percentage. + """ + + scope: typing_extensions.NotRequired[OrderLineItemTaxScope] + """ + Indicates the level at which the tax applies. For `ORDER` scoped taxes, + Square generates references in `applied_taxes` on all order line items that do + not have them. For `LINE_ITEM` scoped taxes, the tax only applies to line items + with references in their `applied_taxes` field. + + This field is immutable. To change the scope, you must delete the tax and + re-add it as a new tax. + See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values + """ + + auto_applied: typing_extensions.NotRequired[bool] + """ + Determines whether the tax was automatically applied to the order based on + the catalog configuration. For an example, see + [Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes). + """ diff --git a/src/square/requests/order_money_amounts.py b/src/square/requests/order_money_amounts.py new file mode 100644 index 00000000..33c1ac38 --- /dev/null +++ b/src/square/requests/order_money_amounts.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams + + +class OrderMoneyAmountsParams(typing_extensions.TypedDict): + """ + A collection of various money amounts. + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total money. + """ + + tax_money: typing_extensions.NotRequired[MoneyParams] + """ + The money associated with taxes. + """ + + discount_money: typing_extensions.NotRequired[MoneyParams] + """ + The money associated with discounts. + """ + + tip_money: typing_extensions.NotRequired[MoneyParams] + """ + The money associated with tips. + """ + + service_charge_money: typing_extensions.NotRequired[MoneyParams] + """ + The money associated with service charges. + """ diff --git a/src/square/requests/order_pricing_options.py b/src/square/requests/order_pricing_options.py new file mode 100644 index 00000000..e8e539fd --- /dev/null +++ b/src/square/requests/order_pricing_options.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class OrderPricingOptionsParams(typing_extensions.TypedDict): + """ + Pricing options for an order. The options affect how the order's price is calculated. + They can be used, for example, to apply automatic price adjustments that are based on preconfigured + [pricing rules](entity:CatalogPricingRule). + """ + + auto_apply_discounts: typing_extensions.NotRequired[typing.Optional[bool]] + """ + The option to determine whether pricing rule-based + discounts are automatically applied to an order. + """ + + auto_apply_taxes: typing_extensions.NotRequired[typing.Optional[bool]] + """ + The option to determine whether rule-based taxes are automatically + applied to an order when the criteria of the corresponding rules are met. + """ diff --git a/src/square/requests/order_quantity_unit.py b/src/square/requests/order_quantity_unit.py new file mode 100644 index 00000000..cbc71bc6 --- /dev/null +++ b/src/square/requests/order_quantity_unit.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .measurement_unit import MeasurementUnitParams +import typing + + +class OrderQuantityUnitParams(typing_extensions.TypedDict): + """ + Contains the measurement unit for a quantity and a precision that + specifies the number of digits after the decimal point for decimal quantities. + """ + + measurement_unit: typing_extensions.NotRequired[MeasurementUnitParams] + """ + A [MeasurementUnit](entity:MeasurementUnit) that represents the + unit of measure for the quantity. + """ + + precision: typing_extensions.NotRequired[typing.Optional[int]] + """ + For non-integer quantities, represents the number of digits after the decimal point that are + recorded for this quantity. + + For example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`. + + Min: 0. Max: 5. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing the + [CatalogMeasurementUnit](entity:CatalogMeasurementUnit). + + This field is set when this is a catalog-backed measurement unit. + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this measurement unit references. + + This field is set when this is a catalog-backed measurement unit. + """ diff --git a/src/square/requests/order_return.py b/src/square/requests/order_return.py new file mode 100644 index 00000000..7b08d29d --- /dev/null +++ b/src/square/requests/order_return.py @@ -0,0 +1,72 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order_return_line_item import OrderReturnLineItemParams +from .order_return_service_charge import OrderReturnServiceChargeParams +from .order_return_tax import OrderReturnTaxParams +from .order_return_discount import OrderReturnDiscountParams +from .order_return_tip import OrderReturnTipParams +from .order_rounding_adjustment import OrderRoundingAdjustmentParams +from .order_money_amounts import OrderMoneyAmountsParams + + +class OrderReturnParams(typing_extensions.TypedDict): + """ + The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the return only within this order. + """ + + source_order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An order that contains the original sale of these return line items. This is unset + for unlinked returns. + """ + + return_line_items: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderReturnLineItemParams]]] + """ + A collection of line items that are being returned. + """ + + return_service_charges: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderReturnServiceChargeParams]] + ] + """ + A collection of service charges that are being returned. + """ + + return_taxes: typing_extensions.NotRequired[typing.Sequence[OrderReturnTaxParams]] + """ + A collection of references to taxes being returned for an order, including the total + applied tax amount to be returned. The taxes must reference a top-level tax ID from the source + order. + """ + + return_discounts: typing_extensions.NotRequired[typing.Sequence[OrderReturnDiscountParams]] + """ + A collection of references to discounts being returned for an order, including the total + applied discount amount to be returned. The discounts must reference a top-level discount ID + from the source order. + """ + + return_tips: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderReturnTipParams]]] + """ + A collection of references to tips being returned for an order. + """ + + rounding_adjustment: typing_extensions.NotRequired[OrderRoundingAdjustmentParams] + """ + A positive or negative rounding adjustment to the total value being returned. Adjustments are commonly + used to apply cash rounding when the minimum unit of the account is smaller than the lowest + physical denomination of the currency. + """ + + return_amounts: typing_extensions.NotRequired[OrderMoneyAmountsParams] + """ + An aggregate monetary value being returned by this return entry. + """ diff --git a/src/square/requests/order_return_discount.py b/src/square/requests/order_return_discount.py new file mode 100644 index 00000000..341223fc --- /dev/null +++ b/src/square/requests/order_return_discount.py @@ -0,0 +1,84 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.order_line_item_discount_type import OrderLineItemDiscountType +from .money import MoneyParams +from ..types.order_line_item_discount_scope import OrderLineItemDiscountScope + + +class OrderReturnDiscountParams(typing_extensions.TypedDict): + """ + Represents a discount being returned that applies to one or more return line items in an + order. + + Fixed-amount, order-scoped discounts are distributed across all non-zero return line item totals. + The amount distributed to each return line item is relative to that item’s contribution to the + order subtotal. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the returned discount only within this order. + """ + + source_discount_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The discount `uid` from the order that contains the original application of this discount. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this discount references. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The discount's name. + """ + + type: typing_extensions.NotRequired[OrderLineItemDiscountType] + """ + The type of the discount. If it is created by the API, it is `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + + Discounts that do not reference a catalog object ID must have a type of + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the tax, as a string representation of a decimal number. + A value of `"7.25"` corresponds to a percentage of 7.25%. + + `percentage` is not set for amount-based discounts. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The total declared monetary amount of the discount. + + `amount_money` is not set for percentage-based discounts. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of discount actually applied to this line item. When an amount-based + discount is at the order level, this value is different from `amount_money` because the discount + is distributed across the line items. + """ + + scope: typing_extensions.NotRequired[OrderLineItemDiscountScope] + """ + Indicates the level at which the `OrderReturnDiscount` applies. For `ORDER` scoped + discounts, the server generates references in `applied_discounts` on all + `OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount is only applied to + `OrderReturnLineItem`s with references in their `applied_discounts` field. + See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values + """ diff --git a/src/square/requests/order_return_line_item.py b/src/square/requests/order_return_line_item.py new file mode 100644 index 00000000..18505b2e --- /dev/null +++ b/src/square/requests/order_return_line_item.py @@ -0,0 +1,144 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order_quantity_unit import OrderQuantityUnitParams +from ..types.order_line_item_item_type import OrderLineItemItemType +from .order_return_line_item_modifier import OrderReturnLineItemModifierParams +from .order_line_item_applied_tax import OrderLineItemAppliedTaxParams +from .order_line_item_applied_discount import OrderLineItemAppliedDiscountParams +from .money import MoneyParams +from .order_line_item_applied_service_charge import OrderLineItemAppliedServiceChargeParams + + +class OrderReturnLineItemParams(typing_extensions.TypedDict): + """ + The line item being returned in an order. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID for this return line-item entry. + """ + + source_line_item_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `uid` of the line item in the original sale order. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the line item. + """ + + quantity: str + """ + The quantity returned, formatted as a decimal number. + For example, `"3"`. + + Line items with a `quantity_unit` can have non-integer quantities. + For example, `"1.70000"`. + """ + + quantity_unit: typing_extensions.NotRequired[OrderQuantityUnitParams] + """ + The unit and precision that this return line item's quantity is measured in. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + The note of the return line item. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item. + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this line item references. + """ + + variation_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the variation applied to this return line item. + """ + + item_type: typing_extensions.NotRequired[OrderLineItemItemType] + """ + The type of line item: an itemized return, a non-itemized return (custom amount), + or the return of an unactivated gift card sale. + See [OrderLineItemItemType](#type-orderlineitemitemtype) for possible values + """ + + return_modifiers: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderReturnLineItemModifierParams]]] + """ + The [CatalogModifier](entity:CatalogModifier)s applied to this line item. + """ + + applied_taxes: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemAppliedTaxParams]]] + """ + The list of references to `OrderReturnTax` entities applied to the return line item. Each + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level + `OrderReturnTax` applied to the return line item. On reads, the applied amount + is populated. + """ + + applied_discounts: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderLineItemAppliedDiscountParams]] + ] + """ + The list of references to `OrderReturnDiscount` entities applied to the return line item. Each + `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level + `OrderReturnDiscount` applied to the return line item. On reads, the applied amount + is populated. + """ + + base_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The base price for a single unit of the line item. + """ + + variation_total_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The total price of all item variations returned in this line item. + The price is calculated as `base_price_money` multiplied by `quantity` and + does not include modifiers. + """ + + gross_return_money: typing_extensions.NotRequired[MoneyParams] + """ + The gross return amount of money calculated as (item base price + modifiers price) * quantity. + """ + + total_tax_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of tax money to return for the line item. + """ + + total_discount_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of discount money to return for the line item. + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of money to return for this line item. + """ + + applied_service_charges: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[OrderLineItemAppliedServiceChargeParams]] + ] + """ + The list of references to `OrderReturnServiceCharge` entities applied to the return + line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that + references the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line + item. On reads, the applied amount is populated. + """ + + total_service_charge_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of apportioned service charge money to return for the line item. + """ diff --git a/src/square/requests/order_return_line_item_modifier.py b/src/square/requests/order_return_line_item_modifier.py new file mode 100644 index 00000000..2efce772 --- /dev/null +++ b/src/square/requests/order_return_line_item_modifier.py @@ -0,0 +1,63 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderReturnLineItemModifierParams(typing_extensions.TypedDict): + """ + A line item modifier being returned. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the return modifier only within this order. + """ + + source_modifier_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The modifier `uid` from the order's line item that contains the + original sale of this line item modifier. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing [CatalogModifier](entity:CatalogModifier). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this line item modifier references. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the item modifier. + """ + + base_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The base price for the modifier. + + `base_price_money` is required for ad hoc modifiers. + If both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](entity:CatalogModifier) price. + """ + + total_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The total price of the item modifier for its line item. + This is the modifier's `base_price_money` multiplied by the line item's quantity. + """ + + quantity: typing_extensions.NotRequired[typing.Optional[str]] + """ + The quantity of the line item modifier. The modifier quantity can be 0 or more. + For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders + this item, the restaurant records the purchase by creating an `Order` object with a line item + for a burger. The line item includes a line item modifier: the name is cheese and the quantity + is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses + the extra cheese option, the modifier quantity increases to 2. If the buyer does not want + any cheese, the modifier quantity is set to 0. + """ diff --git a/src/square/requests/order_return_service_charge.py b/src/square/requests/order_return_service_charge.py new file mode 100644 index 00000000..2e8e538c --- /dev/null +++ b/src/square/requests/order_return_service_charge.py @@ -0,0 +1,122 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from ..types.order_service_charge_calculation_phase import OrderServiceChargeCalculationPhase +from .order_line_item_applied_tax import OrderLineItemAppliedTaxParams +from ..types.order_service_charge_treatment_type import OrderServiceChargeTreatmentType +from ..types.order_service_charge_scope import OrderServiceChargeScope + + +class OrderReturnServiceChargeParams(typing_extensions.TypedDict): + """ + Represents the service charge applied to the original order. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the return service charge only within this order. + """ + + source_service_charge_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The service charge `uid` from the order containing the original + service charge. `source_service_charge_uid` is `null` for + unlinked returns. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the service charge. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this service charge references. + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the service charge, as a string representation of + a decimal number. For example, a value of `"7.25"` corresponds to a + percentage of 7.25%. + + Either `percentage` or `amount_money` should be set, but not both. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of a non-percentage-based service charge. + + Either `percentage` or `amount_money` should be set, but not both. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied to the order by the service charge, including + any inclusive tax amounts, as calculated by Square. + + - For fixed-amount service charges, `applied_money` is equal to `amount_money`. + - For percentage-based service charges, `applied_money` is the money calculated using the percentage. + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of money to collect for the service charge. + + __NOTE__: If an inclusive tax is applied to the service charge, `total_money` + does not equal `applied_money` plus `total_tax_money` because the inclusive + tax amount is already included in both `applied_money` and `total_tax_money`. + """ + + total_tax_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of tax money to collect for the service charge. + """ + + calculation_phase: typing_extensions.NotRequired[OrderServiceChargeCalculationPhase] + """ + The calculation phase after which to apply the service charge. + See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values + """ + + taxable: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the surcharge can be taxed. Service charges + calculated in the `TOTAL_PHASE` cannot be marked as taxable. + """ + + applied_taxes: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemAppliedTaxParams]]] + """ + The list of references to `OrderReturnTax` entities applied to the + `OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid` + that references the `uid` of a top-level `OrderReturnTax` that is being + applied to the `OrderReturnServiceCharge`. On reads, the applied amount is + populated. + """ + + treatment_type: typing_extensions.NotRequired[OrderServiceChargeTreatmentType] + """ + The treatment type of the service charge. + See [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) for possible values + """ + + scope: typing_extensions.NotRequired[OrderServiceChargeScope] + """ + Indicates the level at which the apportioned service charge applies. For `ORDER` + scoped service charges, Square generates references in `applied_service_charges` on + all order line items that do not have them. For `LINE_ITEM` scoped service charges, + the service charge only applies to line items with a service charge reference in their + `applied_service_charges` field. + + This field is immutable. To change the scope of an apportioned service charge, you must delete + the apportioned service charge and re-add it as a new apportioned service charge. + See [OrderServiceChargeScope](#type-orderservicechargescope) for possible values + """ diff --git a/src/square/requests/order_return_tax.py b/src/square/requests/order_return_tax.py new file mode 100644 index 00000000..1b5e059a --- /dev/null +++ b/src/square/requests/order_return_tax.py @@ -0,0 +1,69 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.order_line_item_tax_type import OrderLineItemTaxType +from .money import MoneyParams +from ..types.order_line_item_tax_scope import OrderLineItemTaxScope + + +class OrderReturnTaxParams(typing_extensions.TypedDict): + """ + Represents a tax being returned that applies to one or more return line items in an order. + + Fixed-amount, order-scoped taxes are distributed across all non-zero return line item totals. + The amount distributed to each return line item is relative to that item’s contribution to the + order subtotal. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the returned tax only within this order. + """ + + source_tax_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tax `uid` from the order that contains the original tax charge. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing [CatalogTax](entity:CatalogTax). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this tax references. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tax's name. + """ + + type: typing_extensions.NotRequired[OrderLineItemTaxType] + """ + Indicates the calculation method used to apply the tax. + See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The percentage of the tax, as a string representation of a decimal number. + For example, a value of `"7.25"` corresponds to a percentage of 7.25%. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied by the tax in an order. + """ + + scope: typing_extensions.NotRequired[OrderLineItemTaxScope] + """ + Indicates the level at which the `OrderReturnTax` applies. For `ORDER` scoped + taxes, Square generates references in `applied_taxes` on all + `OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax is only applied to + `OrderReturnLineItem`s with references in their `applied_discounts` field. + See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values + """ diff --git a/src/square/requests/order_return_tip.py b/src/square/requests/order_return_tip.py new file mode 100644 index 00000000..d567b10c --- /dev/null +++ b/src/square/requests/order_return_tip.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderReturnTipParams(typing_extensions.TypedDict): + """ + A tip being returned. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the tip only within this order. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of tip being returned + -- + """ + + source_tender_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tender `uid` from the order that contains the original application of this tip. + """ + + source_tender_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tender `id` from the order that contains the original application of this tip. + """ diff --git a/src/square/requests/order_reward.py b/src/square/requests/order_reward.py new file mode 100644 index 00000000..3c07f390 --- /dev/null +++ b/src/square/requests/order_reward.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class OrderRewardParams(typing_extensions.TypedDict): + """ + Represents a reward that can be applied to an order if the necessary + reward tier criteria are met. Rewards are created through the Loyalty API. + """ + + id: str + """ + The identifier of the reward. + """ + + reward_tier_id: str + """ + The identifier of the reward tier corresponding to this reward. + """ diff --git a/src/square/requests/order_rounding_adjustment.py b/src/square/requests/order_rounding_adjustment.py new file mode 100644 index 00000000..8cff0218 --- /dev/null +++ b/src/square/requests/order_rounding_adjustment.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class OrderRoundingAdjustmentParams(typing_extensions.TypedDict): + """ + A rounding adjustment of the money being returned. Commonly used to apply cash rounding + when the minimum unit of the account is smaller than the lowest physical denomination of the currency. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the rounding adjustment only within this order. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the rounding adjustment from the original sale order. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The actual rounding adjustment amount. + """ diff --git a/src/square/requests/order_service_charge.py b/src/square/requests/order_service_charge.py new file mode 100644 index 00000000..28042c33 --- /dev/null +++ b/src/square/requests/order_service_charge.py @@ -0,0 +1,153 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from ..types.order_service_charge_calculation_phase import OrderServiceChargeCalculationPhase +from .order_line_item_applied_tax import OrderLineItemAppliedTaxParams +from ..types.order_service_charge_type import OrderServiceChargeType +from ..types.order_service_charge_treatment_type import OrderServiceChargeTreatmentType +from ..types.order_service_charge_scope import OrderServiceChargeScope + + +class OrderServiceChargeParams(typing_extensions.TypedDict): + """ + Represents a service charge applied to an order. + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID that identifies the service charge only within this order. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the service charge. + """ + + catalog_object_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject). + """ + + catalog_version: typing_extensions.NotRequired[typing.Optional[int]] + """ + The version of the catalog object that this service charge references. + """ + + percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The service charge percentage as a string representation of a + decimal number. For example, `"7.25"` indicates a service charge of 7.25%. + + Exactly 1 of `percentage` or `amount_money` should be set. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of a non-percentage-based service charge. + + Exactly one of `percentage` or `amount_money` should be set. + """ + + applied_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money applied to the order by the service charge, + including any inclusive tax amounts, as calculated by Square. + + - For fixed-amount service charges, `applied_money` is equal to `amount_money`. + - For percentage-based service charges, `applied_money` is the money + calculated using the percentage. + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of money to collect for the service charge. + + __Note__: If an inclusive tax is applied to the service charge, + `total_money` does not equal `applied_money` plus `total_tax_money` + because the inclusive tax amount is already included in both + `applied_money` and `total_tax_money`. + """ + + total_tax_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of tax money to collect for the service charge. + """ + + calculation_phase: typing_extensions.NotRequired[OrderServiceChargeCalculationPhase] + """ + The calculation phase at which to apply the service charge. + See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values + """ + + taxable: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the service charge can be taxed. If set to `true`, + order-level taxes automatically apply to the service charge. Note that + service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable. + """ + + applied_taxes: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderLineItemAppliedTaxParams]]] + """ + The list of references to the taxes applied to this service charge. Each + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level + `OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied + is populated. + + An `OrderLineItemAppliedTax` is automatically created on every taxable service charge + for all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records + for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable + service charge. Taxable service charges have the `taxable` field set to `true` and calculated + in the `SUBTOTAL_PHASE`. + + To change the amount of a tax, modify the referenced top-level tax. + """ + + metadata: typing_extensions.NotRequired[typing.Optional[typing.Dict[str, typing.Optional[str]]]] + """ + Application-defined data attached to this service charge. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + type: typing_extensions.NotRequired[OrderServiceChargeType] + """ + The type of the service charge. + See [OrderServiceChargeType](#type-orderservicechargetype) for possible values + """ + + treatment_type: typing_extensions.NotRequired[OrderServiceChargeTreatmentType] + """ + The treatment type of the service charge. + See [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) for possible values + """ + + scope: typing_extensions.NotRequired[OrderServiceChargeScope] + """ + Indicates the level at which the apportioned service charge applies. For `ORDER` + scoped service charges, Square generates references in `applied_service_charges` on + all order line items that do not have them. For `LINE_ITEM` scoped service charges, + the service charge only applies to line items with a service charge reference in their + `applied_service_charges` field. + + This field is immutable. To change the scope of an apportioned service charge, you must delete + the apportioned service charge and re-add it as a new apportioned service charge. + See [OrderServiceChargeScope](#type-orderservicechargescope) for possible values + """ diff --git a/src/square/requests/order_source.py b/src/square/requests/order_source.py new file mode 100644 index 00000000..74f6e7e3 --- /dev/null +++ b/src/square/requests/order_source.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class OrderSourceParams(typing_extensions.TypedDict): + """ + Represents the origination details of an order. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name used to identify the place (physical or digital) that an order originates. + If unset, the name defaults to the name of the application that created the order. + """ diff --git a/src/square/requests/pause_subscription_response.py b/src/square/requests/pause_subscription_response.py new file mode 100644 index 00000000..acc74d82 --- /dev/null +++ b/src/square/requests/pause_subscription_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams +from .subscription_action import SubscriptionActionParams + + +class PauseSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The subscription to be paused by the scheduled `PAUSE` action. + """ + + actions: typing_extensions.NotRequired[typing.Sequence[SubscriptionActionParams]] + """ + The list of a `PAUSE` action and a possible `RESUME` action created by the request. + """ diff --git a/src/square/requests/pay_order_response.py b/src/square/requests/pay_order_response.py new file mode 100644 index 00000000..aed21b54 --- /dev/null +++ b/src/square/requests/pay_order_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .order import OrderParams + + +class PayOrderResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of a request to the + [PayOrder](api-endpoint:Orders-PayOrder) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + order: typing_extensions.NotRequired[OrderParams] + """ + The paid, updated [order](entity:Order). + """ diff --git a/src/square/requests/payment.py b/src/square/requests/payment.py new file mode 100644 index 00000000..a274d9f4 --- /dev/null +++ b/src/square/requests/payment.py @@ -0,0 +1,327 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +import typing +from .processing_fee import ProcessingFeeParams +from .card_payment_details import CardPaymentDetailsParams +from .cash_payment_details import CashPaymentDetailsParams +from .bank_account_payment_details import BankAccountPaymentDetailsParams +from .external_payment_details import ExternalPaymentDetailsParams +from .digital_wallet_details import DigitalWalletDetailsParams +from .buy_now_pay_later_details import BuyNowPayLaterDetailsParams +from .square_account_details import SquareAccountDetailsParams +from .risk_evaluation import RiskEvaluationParams +from .address import AddressParams +from .device_details import DeviceDetailsParams +from .application_details import ApplicationDetailsParams +from .offline_payment_details import OfflinePaymentDetailsParams + + +class PaymentParams(typing_extensions.TypedDict): + """ + Represents a payment processed by the Square API. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID for the payment. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the payment was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the payment was last updated, in RFC 3339 format. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount processed for this payment, not including `tip_money`. + + The amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + tip_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount designated as a tip. + + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + total_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount for the payment, including `amount_money` and `tip_money`. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + app_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount the developer is taking as a fee for facilitating the payment on behalf + of the seller. This amount is specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, + see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + The amount cannot be more than 90% of the `total_money` value. + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + """ + + approved_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money approved for this payment. This value may change if Square chooses to + obtain reauthorization as part of a call to [UpdatePayment](api-endpoint:Payments-UpdatePayment). + """ + + processing_fee: typing_extensions.NotRequired[typing.Sequence[ProcessingFeeParams]] + """ + The processing fees and fee adjustments assessed by Square for this payment. + """ + + refunded_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of the payment refunded to date. + + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). + """ + + status: typing_extensions.NotRequired[str] + """ + Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED. + """ + + delay_duration: typing_extensions.NotRequired[str] + """ + The duration of time after the payment's creation when Square automatically applies the + `delay_action` to the payment. This automatic `delay_action` applies only to payments that + do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` + time period. + + This field is specified as a time duration, in RFC 3339 format. + + Notes: + This feature is only supported for card payments. + + Default: + + - Card-present payments: "PT36H" (36 hours) from the creation time. + - Card-not-present payments: "P7D" (7 days) from the creation time. + """ + + delay_action: typing_extensions.NotRequired[typing.Optional[str]] + """ + The action to be applied to the payment when the `delay_duration` has elapsed. + + Current values include `CANCEL` and `COMPLETE`. + """ + + delayed_until: typing_extensions.NotRequired[str] + """ + The read-only timestamp of when the `delay_action` is automatically applied, + in RFC 3339 format. + + Note that this field is calculated by summing the payment's `delay_duration` and `created_at` + fields. The `created_at` field is generated by Square and might not exactly match the + time on your local machine. + """ + + source_type: typing_extensions.NotRequired[str] + """ + The source type for this payment. + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`, + `CASH` and `EXTERNAL`. For information about these payment source types, + see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + """ + + card_details: typing_extensions.NotRequired[CardPaymentDetailsParams] + """ + Details about a card payment. These details are only populated if the source_type is `CARD`. + """ + + cash_details: typing_extensions.NotRequired[CashPaymentDetailsParams] + """ + Details about a cash payment. These details are only populated if the source_type is `CASH`. + """ + + bank_account_details: typing_extensions.NotRequired[BankAccountPaymentDetailsParams] + """ + Details about a bank account payment. These details are only populated if the source_type is `BANK_ACCOUNT`. + """ + + external_details: typing_extensions.NotRequired[ExternalPaymentDetailsParams] + """ + Details about an external payment. The details are only populated + if the `source_type` is `EXTERNAL`. + """ + + wallet_details: typing_extensions.NotRequired[DigitalWalletDetailsParams] + """ + Details about an wallet payment. The details are only populated + if the `source_type` is `WALLET`. + """ + + buy_now_pay_later_details: typing_extensions.NotRequired[BuyNowPayLaterDetailsParams] + """ + Details about a Buy Now Pay Later payment. The details are only populated + if the `source_type` is `BUY_NOW_PAY_LATER`. For more information, see + [Afterpay Payments](https://developer.squareup.com/docs/payments-api/take-payments/afterpay-payments). + """ + + square_account_details: typing_extensions.NotRequired[SquareAccountDetailsParams] + """ + Details about a Square Account payment. The details are only populated + if the `source_type` is `SQUARE_ACCOUNT`. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location associated with the payment. + """ + + order_id: typing_extensions.NotRequired[str] + """ + The ID of the order associated with the payment. + """ + + reference_id: typing_extensions.NotRequired[str] + """ + An optional ID that associates the payment with an entity in + another system. + """ + + customer_id: typing_extensions.NotRequired[str] + """ + The ID of the customer associated with the payment. If the ID is + not provided in the `CreatePayment` request that was used to create the `Payment`, + Square may use information in the request + (such as the billing and shipping address, email address, and payment source) + to identify a matching customer profile in the Customer Directory. + If found, the profile ID is used. If a profile is not found, the + API attempts to create an + [instant profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + If the API cannot create an + instant profile (either because the seller has disabled it or the + seller's region prevents creating it), this field remains unset. Note that + this process is asynchronous and it may take some time before a + customer ID is added to the payment. + """ + + employee_id: typing_extensions.NotRequired[str] + """ + __Deprecated__: Use `Payment.team_member_id` instead. + + An optional ID of the employee associated with taking the payment. + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment. + """ + + refund_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + A list of `refund_id`s identifying refunds for the payment. + """ + + risk_evaluation: typing_extensions.NotRequired[RiskEvaluationParams] + """ + Provides information about the risk associated with the payment, as determined by Square. + This field is present for payments to sellers that have opted in to receive risk + evaluations. + """ + + terminal_checkout_id: typing_extensions.NotRequired[str] + """ + An optional ID for a Terminal checkout that is associated with the payment. + """ + + buyer_email_address: typing_extensions.NotRequired[str] + """ + The buyer's email address. + """ + + billing_address: typing_extensions.NotRequired[AddressParams] + """ + The buyer's billing address. + """ + + shipping_address: typing_extensions.NotRequired[AddressParams] + """ + The buyer's shipping address. + """ + + note: typing_extensions.NotRequired[str] + """ + An optional note to include when creating a payment. + """ + + statement_description_identifier: typing_extensions.NotRequired[str] + """ + Additional payment information that gets added to the customer's card statement + as part of the statement description. + + Note that the `statement_description_identifier` might get truncated on the statement description + to fit the required information including the Square identifier (SQ *) and the name of the + seller taking the payment. + """ + + capabilities: typing_extensions.NotRequired[typing.Sequence[str]] + """ + Actions that can be performed on this payment: + - `EDIT_AMOUNT_UP` - The payment amount can be edited up. + - `EDIT_AMOUNT_DOWN` - The payment amount can be edited down. + - `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up. + - `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down. + - `EDIT_DELAY_ACTION` - The delay_action can be edited. + """ + + receipt_number: typing_extensions.NotRequired[str] + """ + The payment's receipt number. + The field is missing if a payment is canceled. + """ + + receipt_url: typing_extensions.NotRequired[str] + """ + The URL for the payment's receipt. + The field is only populated for COMPLETED payments. + """ + + device_details: typing_extensions.NotRequired[DeviceDetailsParams] + """ + Details about the device that took the payment. + """ + + application_details: typing_extensions.NotRequired[ApplicationDetailsParams] + """ + Details about the application that took the payment. + """ + + is_offline_payment: typing_extensions.NotRequired[bool] + """ + Whether or not this payment was taken offline. + """ + + offline_payment_details: typing_extensions.NotRequired[OfflinePaymentDetailsParams] + """ + Additional information about the payment if it was taken offline. + """ + + version_token: typing_extensions.NotRequired[typing.Optional[str]] + """ + Used for optimistic concurrency. This opaque token identifies a specific version of the + `Payment` object. + """ diff --git a/src/square/requests/payment_balance_activity_app_fee_refund_detail.py b/src/square/requests/payment_balance_activity_app_fee_refund_detail.py new file mode 100644 index 00000000..22905824 --- /dev/null +++ b/src/square/requests/payment_balance_activity_app_fee_refund_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityAppFeeRefundDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + refund_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the refund associated with this activity. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the location of the merchant associated with the payment refund activity + """ diff --git a/src/square/requests/payment_balance_activity_app_fee_revenue_detail.py b/src/square/requests/payment_balance_activity_app_fee_revenue_detail.py new file mode 100644 index 00000000..45c421b3 --- /dev/null +++ b/src/square/requests/payment_balance_activity_app_fee_revenue_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityAppFeeRevenueDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the location of the merchant associated with the payment activity + """ diff --git a/src/square/requests/payment_balance_activity_automatic_savings_detail.py b/src/square/requests/payment_balance_activity_automatic_savings_detail.py new file mode 100644 index 00000000..77a35b4b --- /dev/null +++ b/src/square/requests/payment_balance_activity_automatic_savings_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityAutomaticSavingsDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + payout_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payout associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_automatic_savings_reversed_detail.py b/src/square/requests/payment_balance_activity_automatic_savings_reversed_detail.py new file mode 100644 index 00000000..43f422a3 --- /dev/null +++ b/src/square/requests/payment_balance_activity_automatic_savings_reversed_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityAutomaticSavingsReversedDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + payout_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payout associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_charge_detail.py b/src/square/requests/payment_balance_activity_charge_detail.py new file mode 100644 index 00000000..1104fe0f --- /dev/null +++ b/src/square/requests/payment_balance_activity_charge_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityChargeDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_deposit_fee_detail.py b/src/square/requests/payment_balance_activity_deposit_fee_detail.py new file mode 100644 index 00000000..5b06cdc1 --- /dev/null +++ b/src/square/requests/payment_balance_activity_deposit_fee_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityDepositFeeDetailParams(typing_extensions.TypedDict): + payout_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payout that triggered this deposit fee activity. + """ diff --git a/src/square/requests/payment_balance_activity_deposit_fee_reversed_detail.py b/src/square/requests/payment_balance_activity_deposit_fee_reversed_detail.py new file mode 100644 index 00000000..e33eca45 --- /dev/null +++ b/src/square/requests/payment_balance_activity_deposit_fee_reversed_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityDepositFeeReversedDetailParams(typing_extensions.TypedDict): + payout_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payout that triggered this deposit fee activity. + """ diff --git a/src/square/requests/payment_balance_activity_dispute_detail.py b/src/square/requests/payment_balance_activity_dispute_detail.py new file mode 100644 index 00000000..4cb66a20 --- /dev/null +++ b/src/square/requests/payment_balance_activity_dispute_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityDisputeDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + dispute_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the dispute associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_fee_detail.py b/src/square/requests/payment_balance_activity_fee_detail.py new file mode 100644 index 00000000..51b97e58 --- /dev/null +++ b/src/square/requests/payment_balance_activity_fee_detail.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityFeeDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity + This will only be populated when a principal LedgerEntryToken is also populated. + If the fee is independent (there is no principal LedgerEntryToken) then this will likely not + be populated. + """ diff --git a/src/square/requests/payment_balance_activity_free_processing_detail.py b/src/square/requests/payment_balance_activity_free_processing_detail.py new file mode 100644 index 00000000..59908278 --- /dev/null +++ b/src/square/requests/payment_balance_activity_free_processing_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityFreeProcessingDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_hold_adjustment_detail.py b/src/square/requests/payment_balance_activity_hold_adjustment_detail.py new file mode 100644 index 00000000..8b4d729c --- /dev/null +++ b/src/square/requests/payment_balance_activity_hold_adjustment_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityHoldAdjustmentDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_open_dispute_detail.py b/src/square/requests/payment_balance_activity_open_dispute_detail.py new file mode 100644 index 00000000..2be98265 --- /dev/null +++ b/src/square/requests/payment_balance_activity_open_dispute_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityOpenDisputeDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + dispute_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the dispute associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_other_adjustment_detail.py b/src/square/requests/payment_balance_activity_other_adjustment_detail.py new file mode 100644 index 00000000..ce35d891 --- /dev/null +++ b/src/square/requests/payment_balance_activity_other_adjustment_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityOtherAdjustmentDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_other_detail.py b/src/square/requests/payment_balance_activity_other_detail.py new file mode 100644 index 00000000..630e23da --- /dev/null +++ b/src/square/requests/payment_balance_activity_other_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityOtherDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_refund_detail.py b/src/square/requests/payment_balance_activity_refund_detail.py new file mode 100644 index 00000000..0f8b1f90 --- /dev/null +++ b/src/square/requests/payment_balance_activity_refund_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityRefundDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + refund_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the refund associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_release_adjustment_detail.py b/src/square/requests/payment_balance_activity_release_adjustment_detail.py new file mode 100644 index 00000000..6b92f80f --- /dev/null +++ b/src/square/requests/payment_balance_activity_release_adjustment_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityReleaseAdjustmentDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_reserve_hold_detail.py b/src/square/requests/payment_balance_activity_reserve_hold_detail.py new file mode 100644 index 00000000..9a95d2f2 --- /dev/null +++ b/src/square/requests/payment_balance_activity_reserve_hold_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityReserveHoldDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_reserve_release_detail.py b/src/square/requests/payment_balance_activity_reserve_release_detail.py new file mode 100644 index 00000000..da039f70 --- /dev/null +++ b/src/square/requests/payment_balance_activity_reserve_release_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityReserveReleaseDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_square_capital_payment_detail.py b/src/square/requests/payment_balance_activity_square_capital_payment_detail.py new file mode 100644 index 00000000..0d96f731 --- /dev/null +++ b/src/square/requests/payment_balance_activity_square_capital_payment_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivitySquareCapitalPaymentDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_square_capital_reversed_payment_detail.py b/src/square/requests/payment_balance_activity_square_capital_reversed_payment_detail.py new file mode 100644 index 00000000..37953dfe --- /dev/null +++ b/src/square/requests/payment_balance_activity_square_capital_reversed_payment_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivitySquareCapitalReversedPaymentDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_square_payroll_transfer_detail.py b/src/square/requests/payment_balance_activity_square_payroll_transfer_detail.py new file mode 100644 index 00000000..968ecf17 --- /dev/null +++ b/src/square/requests/payment_balance_activity_square_payroll_transfer_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivitySquarePayrollTransferDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_square_payroll_transfer_reversed_detail.py b/src/square/requests/payment_balance_activity_square_payroll_transfer_reversed_detail.py new file mode 100644 index 00000000..43a75176 --- /dev/null +++ b/src/square/requests/payment_balance_activity_square_payroll_transfer_reversed_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivitySquarePayrollTransferReversedDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_tax_on_fee_detail.py b/src/square/requests/payment_balance_activity_tax_on_fee_detail.py new file mode 100644 index 00000000..3556955d --- /dev/null +++ b/src/square/requests/payment_balance_activity_tax_on_fee_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityTaxOnFeeDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + tax_rate_description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The description of the tax rate being applied. For example: "GST", "HST". + """ diff --git a/src/square/requests/payment_balance_activity_third_party_fee_detail.py b/src/square/requests/payment_balance_activity_third_party_fee_detail.py new file mode 100644 index 00000000..b0fd275b --- /dev/null +++ b/src/square/requests/payment_balance_activity_third_party_fee_detail.py @@ -0,0 +1,12 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityThirdPartyFeeDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ diff --git a/src/square/requests/payment_balance_activity_third_party_fee_refund_detail.py b/src/square/requests/payment_balance_activity_third_party_fee_refund_detail.py new file mode 100644 index 00000000..2a725fb3 --- /dev/null +++ b/src/square/requests/payment_balance_activity_third_party_fee_refund_detail.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PaymentBalanceActivityThirdPartyFeeRefundDetailParams(typing_extensions.TypedDict): + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this activity. + """ + + refund_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The public refund id associated with this activity. + """ diff --git a/src/square/requests/payment_link.py b/src/square/requests/payment_link.py new file mode 100644 index 00000000..6397f6b7 --- /dev/null +++ b/src/square/requests/payment_link.py @@ -0,0 +1,68 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .checkout_options import CheckoutOptionsParams +from .pre_populated_data import PrePopulatedDataParams + + +class PaymentLinkParams(typing_extensions.TypedDict): + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the payment link. + """ + + version: int + """ + The Square-assigned version number, which is incremented each time an update is committed to the payment link. + """ + + description: typing_extensions.NotRequired[typing.Optional[str]] + """ + The optional description of the `payment_link` object. + It is primarily for use by your application and is not used anywhere. + """ + + order_id: typing_extensions.NotRequired[str] + """ + The ID of the order associated with the payment link. + """ + + checkout_options: typing_extensions.NotRequired[CheckoutOptionsParams] + """ + The checkout options configured for the payment link. + For more information, see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + """ + + pre_populated_data: typing_extensions.NotRequired[PrePopulatedDataParams] + """ + Describes buyer data to prepopulate + on the checkout page. + """ + + url: typing_extensions.NotRequired[str] + """ + The shortened URL of the payment link. + """ + + long_url: typing_extensions.NotRequired[str] + """ + The long URL of the payment link. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the payment link was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the payment link was last updated, in RFC 3339 format. + """ + + payment_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional note. After Square processes the payment, this note is added to the + resulting `Payment`. + """ diff --git a/src/square/requests/payment_link_related_resources.py b/src/square/requests/payment_link_related_resources.py new file mode 100644 index 00000000..f30988b9 --- /dev/null +++ b/src/square/requests/payment_link_related_resources.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order import OrderParams +from .catalog_object import CatalogObjectParams + + +class PaymentLinkRelatedResourcesParams(typing_extensions.TypedDict): + orders: typing_extensions.NotRequired[typing.Optional[typing.Sequence[OrderParams]]] + """ + The order associated with the payment link. + """ + + subscription_plans: typing_extensions.NotRequired[typing.Optional[typing.Sequence[CatalogObjectParams]]] + """ + The subscription plan associated with the payment link. + """ diff --git a/src/square/requests/payment_options.py b/src/square/requests/payment_options.py new file mode 100644 index 00000000..67a5eec5 --- /dev/null +++ b/src/square/requests/payment_options.py @@ -0,0 +1,61 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.payment_options_delay_action import PaymentOptionsDelayAction + + +class PaymentOptionsParams(typing_extensions.TypedDict): + autocomplete: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the `Payment` objects created from this `TerminalCheckout` are + automatically `COMPLETED` or left in an `APPROVED` state for later modification. + + Default: true + """ + + delay_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The duration of time after the payment's creation when Square automatically resolves the + payment. This automatic resolution applies only to payments that do not reach a terminal state + (`COMPLETED` or `CANCELED`) before the `delay_duration` time period. + + This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value + of 1 minute and a maximum value of 36 hours. This feature is only supported for card payments, + and all payments will be considered card-present. + + This parameter can only be set for a delayed capture payment (`autocomplete=false`). For more + information, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: "PT36H" (36 hours) from the creation time + """ + + accept_partial_authorization: typing_extensions.NotRequired[typing.Optional[bool]] + """ + If set to `true` and charging a Square Gift Card, a payment might be returned with + `amount_money` equal to less than what was requested. For example, a request for $20 when charging + a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose + to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card + payment. + + This parameter can only be set for a delayed capture payment (`autocomplete=false`). + + For more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards). + + Default: false + """ + + delay_action: typing_extensions.NotRequired[PaymentOptionsDelayAction] + """ + The action to be applied to the `Payment` when the delay_duration has elapsed. + The action must be CANCEL or COMPLETE. + + The action cannot be set to COMPLETE if an `order_id` is present on the TerminalCheckout. + + This parameter can only be set for a delayed capture payment (`autocomplete=false`). For more + information, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: CANCEL + See [DelayAction](#type-delayaction) for possible values + """ diff --git a/src/square/requests/payment_refund.py b/src/square/requests/payment_refund.py new file mode 100644 index 00000000..bb865ffe --- /dev/null +++ b/src/square/requests/payment_refund.py @@ -0,0 +1,107 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .destination_details import DestinationDetailsParams +from .money import MoneyParams +from .processing_fee import ProcessingFeeParams + + +class PaymentRefundParams(typing_extensions.TypedDict): + """ + Represents a refund of a payment made using Square. Contains information about + the original payment and the amount of money refunded. + """ + + id: str + """ + The unique ID for this refund, generated by Square. + """ + + status: typing_extensions.NotRequired[typing.Optional[str]] + """ + The refund's status: + - `PENDING` - Awaiting approval. + - `COMPLETED` - Successfully completed. + - `REJECTED` - The refund was rejected. + - `FAILED` - An error occurred. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The location ID associated with the payment this refund is attached to. + """ + + unlinked: typing_extensions.NotRequired[bool] + """ + Flag indicating whether or not the refund is linked to an existing payment in Square. + """ + + destination_type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The destination type for this refund. + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`, + `EXTERNAL`, and `SQUARE_ACCOUNT`. + """ + + destination_details: typing_extensions.NotRequired[DestinationDetailsParams] + """ + Contains information about the refund destination. This field is populated only if + `destination_id` is defined in the `RefundPayment` request. + """ + + amount_money: MoneyParams + """ + The amount of money refunded. This amount is specified in the smallest denomination + of the applicable currency (for example, US dollar amounts are specified in cents). + """ + + app_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money the application developer contributed to help cover the refunded amount. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + processing_fee: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ProcessingFeeParams]]] + """ + Processing fees and fee adjustments assessed by Square for this refund. + """ + + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the payment associated with this refund. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the order associated with the refund. + """ + + reason: typing_extensions.NotRequired[typing.Optional[str]] + """ + The reason for the refund. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the refund was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the refund was last updated, in RFC 3339 format. + """ + + team_member_id: typing_extensions.NotRequired[str] + """ + An optional ID of the team member associated with taking the payment. + """ + + terminal_refund_id: typing_extensions.NotRequired[str] + """ + An optional ID for a Terminal refund. + """ diff --git a/src/square/requests/payout.py b/src/square/requests/payout.py new file mode 100644 index 00000000..36bff55c --- /dev/null +++ b/src/square/requests/payout.py @@ -0,0 +1,81 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.payout_status import PayoutStatus +from .money import MoneyParams +from .destination import DestinationParams +from ..types.payout_type import PayoutType +import typing +from .payout_fee import PayoutFeeParams + + +class PayoutParams(typing_extensions.TypedDict): + """ + An accounting of the amount owed the seller and record of the actual transfer to their + external bank account or to the Square balance. + """ + + id: str + """ + A unique ID for the payout. + """ + + status: typing_extensions.NotRequired[PayoutStatus] + """ + Indicates the payout status. + See [PayoutStatus](#type-payoutstatus) for possible values + """ + + location_id: str + """ + The ID of the location associated with the payout. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the payout was last updated, in RFC 3339 format. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money involved in the payout. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero. + """ + + destination: typing_extensions.NotRequired[DestinationParams] + """ + Information about the banking destination (such as a bank account, Square checking account, or debit card) + against which the payout was made. + """ + + version: typing_extensions.NotRequired[int] + """ + The version number, which is incremented each time an update is made to this payout record. + The version number helps developers receive event notifications or feeds out of order. + """ + + type: typing_extensions.NotRequired[PayoutType] + """ + Indicates the payout type. + See [PayoutType](#type-payouttype) for possible values + """ + + payout_fee: typing_extensions.NotRequired[typing.Optional[typing.Sequence[PayoutFeeParams]]] + """ + A list of transfer fees and any taxes on the fees assessed by Square for this payout. + """ + + arrival_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. + """ + + end_to_end_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement. + """ diff --git a/src/square/requests/payout_entry.py b/src/square/requests/payout_entry.py new file mode 100644 index 00000000..58d33b09 --- /dev/null +++ b/src/square/requests/payout_entry.py @@ -0,0 +1,226 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.activity_type import ActivityType +from .money import MoneyParams +from .payment_balance_activity_app_fee_revenue_detail import PaymentBalanceActivityAppFeeRevenueDetailParams +from .payment_balance_activity_app_fee_refund_detail import PaymentBalanceActivityAppFeeRefundDetailParams +from .payment_balance_activity_automatic_savings_detail import PaymentBalanceActivityAutomaticSavingsDetailParams +from .payment_balance_activity_automatic_savings_reversed_detail import ( + PaymentBalanceActivityAutomaticSavingsReversedDetailParams, +) +from .payment_balance_activity_charge_detail import PaymentBalanceActivityChargeDetailParams +from .payment_balance_activity_deposit_fee_detail import PaymentBalanceActivityDepositFeeDetailParams +from .payment_balance_activity_deposit_fee_reversed_detail import PaymentBalanceActivityDepositFeeReversedDetailParams +from .payment_balance_activity_dispute_detail import PaymentBalanceActivityDisputeDetailParams +from .payment_balance_activity_fee_detail import PaymentBalanceActivityFeeDetailParams +from .payment_balance_activity_free_processing_detail import PaymentBalanceActivityFreeProcessingDetailParams +from .payment_balance_activity_hold_adjustment_detail import PaymentBalanceActivityHoldAdjustmentDetailParams +from .payment_balance_activity_open_dispute_detail import PaymentBalanceActivityOpenDisputeDetailParams +from .payment_balance_activity_other_detail import PaymentBalanceActivityOtherDetailParams +from .payment_balance_activity_other_adjustment_detail import PaymentBalanceActivityOtherAdjustmentDetailParams +from .payment_balance_activity_refund_detail import PaymentBalanceActivityRefundDetailParams +from .payment_balance_activity_release_adjustment_detail import PaymentBalanceActivityReleaseAdjustmentDetailParams +from .payment_balance_activity_reserve_hold_detail import PaymentBalanceActivityReserveHoldDetailParams +from .payment_balance_activity_reserve_release_detail import PaymentBalanceActivityReserveReleaseDetailParams +from .payment_balance_activity_square_capital_payment_detail import ( + PaymentBalanceActivitySquareCapitalPaymentDetailParams, +) +from .payment_balance_activity_square_capital_reversed_payment_detail import ( + PaymentBalanceActivitySquareCapitalReversedPaymentDetailParams, +) +from .payment_balance_activity_tax_on_fee_detail import PaymentBalanceActivityTaxOnFeeDetailParams +from .payment_balance_activity_third_party_fee_detail import PaymentBalanceActivityThirdPartyFeeDetailParams +from .payment_balance_activity_third_party_fee_refund_detail import ( + PaymentBalanceActivityThirdPartyFeeRefundDetailParams, +) +from .payment_balance_activity_square_payroll_transfer_detail import ( + PaymentBalanceActivitySquarePayrollTransferDetailParams, +) +from .payment_balance_activity_square_payroll_transfer_reversed_detail import ( + PaymentBalanceActivitySquarePayrollTransferReversedDetailParams, +) + + +class PayoutEntryParams(typing_extensions.TypedDict): + """ + One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity. + The total amount of the payout will equal the sum of the payout entries for a batch payout + """ + + id: str + """ + A unique ID for the payout entry. + """ + + payout_id: str + """ + The ID of the payout entries’ associated payout. + """ + + effective_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp of when the payout entry affected the balance, in RFC 3339 format. + """ + + type: typing_extensions.NotRequired[ActivityType] + """ + The type of activity associated with this payout entry. + See [ActivityType](#type-activitytype) for possible values + """ + + gross_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of money involved in this payout entry. + """ + + fee_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of Square fees associated with this payout entry. + """ + + net_amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The net proceeds from this transaction after any fees. + """ + + type_app_fee_revenue_details: typing_extensions.NotRequired[PaymentBalanceActivityAppFeeRevenueDetailParams] + """ + Details of any developer app fee revenue generated on a payment. + """ + + type_app_fee_refund_details: typing_extensions.NotRequired[PaymentBalanceActivityAppFeeRefundDetailParams] + """ + Details of a refund for an app fee on a payment. + """ + + type_automatic_savings_details: typing_extensions.NotRequired[PaymentBalanceActivityAutomaticSavingsDetailParams] + """ + Details of any automatic transfer from the payment processing balance to the Square Savings account. These are, generally, proportional to the merchant's sales. + """ + + type_automatic_savings_reversed_details: typing_extensions.NotRequired[ + PaymentBalanceActivityAutomaticSavingsReversedDetailParams + ] + """ + Details of any automatic transfer from the Square Savings account back to the processing balance. These are, generally, proportional to the merchant's refunds. + """ + + type_charge_details: typing_extensions.NotRequired[PaymentBalanceActivityChargeDetailParams] + """ + Details of credit card payment captures. + """ + + type_deposit_fee_details: typing_extensions.NotRequired[PaymentBalanceActivityDepositFeeDetailParams] + """ + Details of any fees involved with deposits such as for instant deposits. + """ + + type_deposit_fee_reversed_details: typing_extensions.NotRequired[ + PaymentBalanceActivityDepositFeeReversedDetailParams + ] + """ + Details of any reversal or refund of fees involved with deposits such as for instant deposits. + """ + + type_dispute_details: typing_extensions.NotRequired[PaymentBalanceActivityDisputeDetailParams] + """ + Details of any balance change due to a dispute event. + """ + + type_fee_details: typing_extensions.NotRequired[PaymentBalanceActivityFeeDetailParams] + """ + Details of adjustments due to the Square processing fee. + """ + + type_free_processing_details: typing_extensions.NotRequired[PaymentBalanceActivityFreeProcessingDetailParams] + """ + Square offers Free Payments Processing for a variety of business scenarios including seller referral or when Square wants to apologize for a bug, customer service, repricing complication, and so on. This entry represents details of any credit to the merchant for the purposes of Free Processing. + """ + + type_hold_adjustment_details: typing_extensions.NotRequired[PaymentBalanceActivityHoldAdjustmentDetailParams] + """ + Details of any adjustment made by Square related to the holding or releasing of a payment. + """ + + type_open_dispute_details: typing_extensions.NotRequired[PaymentBalanceActivityOpenDisputeDetailParams] + """ + Details of any open disputes. + """ + + type_other_details: typing_extensions.NotRequired[PaymentBalanceActivityOtherDetailParams] + """ + Details of any other type that does not belong in the rest of the types. + """ + + type_other_adjustment_details: typing_extensions.NotRequired[PaymentBalanceActivityOtherAdjustmentDetailParams] + """ + Details of any other type of adjustments that don't fall under existing types. + """ + + type_refund_details: typing_extensions.NotRequired[PaymentBalanceActivityRefundDetailParams] + """ + Details of a refund for an existing card payment. + """ + + type_release_adjustment_details: typing_extensions.NotRequired[PaymentBalanceActivityReleaseAdjustmentDetailParams] + """ + Details of fees released for adjustments. + """ + + type_reserve_hold_details: typing_extensions.NotRequired[PaymentBalanceActivityReserveHoldDetailParams] + """ + Details of fees paid for funding risk reserve. + """ + + type_reserve_release_details: typing_extensions.NotRequired[PaymentBalanceActivityReserveReleaseDetailParams] + """ + Details of fees released from risk reserve. + """ + + type_square_capital_payment_details: typing_extensions.NotRequired[ + PaymentBalanceActivitySquareCapitalPaymentDetailParams + ] + """ + Details of capital merchant cash advance (MCA) assessments. These are, generally, proportional to the merchant's sales but may be issued for other reasons related to the MCA. + """ + + type_square_capital_reversed_payment_details: typing_extensions.NotRequired[ + PaymentBalanceActivitySquareCapitalReversedPaymentDetailParams + ] + """ + Details of capital merchant cash advance (MCA) assessment refunds. These are, generally, proportional to the merchant's refunds but may be issued for other reasons related to the MCA. + """ + + type_tax_on_fee_details: typing_extensions.NotRequired[PaymentBalanceActivityTaxOnFeeDetailParams] + """ + Details of tax paid on fee amounts. + """ + + type_third_party_fee_details: typing_extensions.NotRequired[PaymentBalanceActivityThirdPartyFeeDetailParams] + """ + Details of fees collected by a 3rd party platform. + """ + + type_third_party_fee_refund_details: typing_extensions.NotRequired[ + PaymentBalanceActivityThirdPartyFeeRefundDetailParams + ] + """ + Details of refunded fees from a 3rd party platform. + """ + + type_square_payroll_transfer_details: typing_extensions.NotRequired[ + PaymentBalanceActivitySquarePayrollTransferDetailParams + ] + """ + Details of a payroll payment that was transferred to a team member’s bank account. + """ + + type_square_payroll_transfer_reversed_details: typing_extensions.NotRequired[ + PaymentBalanceActivitySquarePayrollTransferReversedDetailParams + ] + """ + Details of a payroll payment to a team member’s bank account that was deposited back to the seller’s account by Square. + """ diff --git a/src/square/requests/payout_fee.py b/src/square/requests/payout_fee.py new file mode 100644 index 00000000..ae5d9682 --- /dev/null +++ b/src/square/requests/payout_fee.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +import typing +from ..types.payout_fee_type import PayoutFeeType + + +class PayoutFeeParams(typing_extensions.TypedDict): + """ + Represents a payout fee that can incur as part of a payout. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The money amount of the payout fee. + """ + + effective_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp of when the fee takes effect, in RFC 3339 format. + """ + + type: typing_extensions.NotRequired[PayoutFeeType] + """ + The type of fee assessed as part of the payout. + See [PayoutFeeType](#type-payoutfeetype) for possible values + """ diff --git a/src/square/requests/phase.py b/src/square/requests/phase.py new file mode 100644 index 00000000..80d3ffb6 --- /dev/null +++ b/src/square/requests/phase.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PhaseParams(typing_extensions.TypedDict): + """ + Represents a phase, which can override subscription phases as defined by plan_id + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + id of subscription phase + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + index of phase in total subscription plan + """ + + order_template_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + id of order to be used in billing + """ + + plan_phase_uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + the uid from the plan's phase in catalog + """ diff --git a/src/square/requests/phase_input.py b/src/square/requests/phase_input.py new file mode 100644 index 00000000..4c36efb1 --- /dev/null +++ b/src/square/requests/phase_input.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class PhaseInputParams(typing_extensions.TypedDict): + """ + Represents the arguments used to construct a new phase. + """ + + ordinal: int + """ + index of phase in total subscription plan + """ + + order_template_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + id of order to be used in billing + """ diff --git a/src/square/requests/pre_populated_data.py b/src/square/requests/pre_populated_data.py new file mode 100644 index 00000000..379e57b4 --- /dev/null +++ b/src/square/requests/pre_populated_data.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams + + +class PrePopulatedDataParams(typing_extensions.TypedDict): + """ + Describes buyer data to prepopulate in the payment form. + For more information, + see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + """ + + buyer_email: typing_extensions.NotRequired[typing.Optional[str]] + """ + The buyer email to prepopulate in the payment form. + """ + + buyer_phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The buyer phone number to prepopulate in the payment form. + """ + + buyer_address: typing_extensions.NotRequired[AddressParams] + """ + The buyer address to prepopulate in the payment form. + """ diff --git a/src/square/requests/processing_fee.py b/src/square/requests/processing_fee.py new file mode 100644 index 00000000..34c7c7e0 --- /dev/null +++ b/src/square/requests/processing_fee.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class ProcessingFeeParams(typing_extensions.TypedDict): + """ + Represents the Square processing fee. + """ + + effective_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timestamp of when the fee takes effect, in RFC 3339 format. + """ + + type: typing_extensions.NotRequired[typing.Optional[str]] + """ + The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The fee amount, which might be negative, that is assessed or adjusted by Square. + + Positive values represent funds being assessed, while negative values represent + funds being returned. + """ diff --git a/src/square/requests/publish_invoice_response.py b/src/square/requests/publish_invoice_response.py new file mode 100644 index 00000000..e2fe3b3b --- /dev/null +++ b/src/square/requests/publish_invoice_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .invoice import InvoiceParams +import typing +from .error import ErrorParams + + +class PublishInvoiceResponseParams(typing_extensions.TypedDict): + """ + Describes a `PublishInvoice` response. + """ + + invoice: typing_extensions.NotRequired[InvoiceParams] + """ + The published invoice. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/qr_code_options.py b/src/square/requests/qr_code_options.py new file mode 100644 index 00000000..10331dab --- /dev/null +++ b/src/square/requests/qr_code_options.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class QrCodeOptionsParams(typing_extensions.TypedDict): + """ + Fields to describe the action that displays QR-Codes. + """ + + title: str + """ + The title text to display in the QR code flow on the Terminal. + """ + + body: str + """ + The body text to display in the QR code flow on the Terminal. + """ + + barcode_contents: str + """ + The text representation of the data to show in the QR code + as UTF8-encoded data. + """ diff --git a/src/square/requests/quick_pay.py b/src/square/requests/quick_pay.py new file mode 100644 index 00000000..712635c4 --- /dev/null +++ b/src/square/requests/quick_pay.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .money import MoneyParams + + +class QuickPayParams(typing_extensions.TypedDict): + """ + Describes an ad hoc item and price to generate a quick pay checkout link. + For more information, + see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + """ + + name: str + """ + The ad hoc item name. In the resulting `Order`, this name appears as the line item name. + """ + + price_money: MoneyParams + """ + The price of the item. + """ + + location_id: str + """ + The ID of the business location the checkout is associated with. + """ diff --git a/src/square/requests/range.py b/src/square/requests/range.py new file mode 100644 index 00000000..c4515928 --- /dev/null +++ b/src/square/requests/range.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class RangeParams(typing_extensions.TypedDict): + """ + The range of a number value between the specified lower and upper bounds. + """ + + min: typing_extensions.NotRequired[typing.Optional[str]] + """ + The lower bound of the number range. At least one of `min` or `max` must be specified. + If unspecified, the results will have no minimum value. + """ + + max: typing_extensions.NotRequired[typing.Optional[str]] + """ + The upper bound of the number range. At least one of `min` or `max` must be specified. + If unspecified, the results will have no maximum value. + """ diff --git a/src/square/requests/receipt_options.py b/src/square/requests/receipt_options.py new file mode 100644 index 00000000..4db5f4ed --- /dev/null +++ b/src/square/requests/receipt_options.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class ReceiptOptionsParams(typing_extensions.TypedDict): + """ + Describes receipt action fields. + """ + + payment_id: str + """ + The reference to the Square payment ID for the receipt. + """ + + print_only: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Instructs the device to print the receipt without displaying the receipt selection screen. + Requires `printer_enabled` set to true. + Defaults to false. + """ + + is_duplicate: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Identify the receipt as a reprint rather than an original receipt. + Defaults to false. + """ diff --git a/src/square/requests/redeem_loyalty_reward_response.py b/src/square/requests/redeem_loyalty_reward_response.py new file mode 100644 index 00000000..1047a1c1 --- /dev/null +++ b/src/square/requests/redeem_loyalty_reward_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_event import LoyaltyEventParams + + +class RedeemLoyaltyRewardResponseParams(typing_extensions.TypedDict): + """ + A response that includes the `LoyaltyEvent` published for redeeming the reward. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + event: typing_extensions.NotRequired[LoyaltyEventParams] + """ + The `LoyaltyEvent` for redeeming the reward. + """ diff --git a/src/square/requests/refund.py b/src/square/requests/refund.py new file mode 100644 index 00000000..426ed696 --- /dev/null +++ b/src/square/requests/refund.py @@ -0,0 +1,67 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from ..types.refund_status import RefundStatus +from .additional_recipient import AdditionalRecipientParams + + +class RefundParams(typing_extensions.TypedDict): + """ + Represents a refund processed for a Square transaction. + """ + + id: str + """ + The refund's unique ID. + """ + + location_id: str + """ + The ID of the refund's associated location. + """ + + transaction_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the transaction that the refunded tender is part of. + """ + + tender_id: str + """ + The ID of the refunded tender. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp for when the refund was created, in RFC 3339 format. + """ + + reason: str + """ + The reason for the refund being issued. + """ + + amount_money: MoneyParams + """ + The amount of money refunded to the buyer. + """ + + status: RefundStatus + """ + The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, + or `FAILED`). + See [RefundStatus](#type-refundstatus) for possible values + """ + + processing_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of Square processing fee money refunded to the *merchant*. + """ + + additional_recipients: typing_extensions.NotRequired[typing.Optional[typing.Sequence[AdditionalRecipientParams]]] + """ + Additional recipients (other than the merchant) receiving a portion of this refund. + For example, fees assessed on a refund of a purchase by a third party integration. + """ diff --git a/src/square/requests/refund_payment_response.py b/src/square/requests/refund_payment_response.py new file mode 100644 index 00000000..bc6aa8cd --- /dev/null +++ b/src/square/requests/refund_payment_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_refund import PaymentRefundParams + + +class RefundPaymentResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by + [RefundPayment](api-endpoint:Refunds-RefundPayment). + + If there are errors processing the request, the `refund` field might not be + present, or it might be present with a status of `FAILED`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refund: typing_extensions.NotRequired[PaymentRefundParams] + """ + The successfully created `PaymentRefund`. + """ diff --git a/src/square/requests/register_domain_response.py b/src/square/requests/register_domain_response.py new file mode 100644 index 00000000..7663b138 --- /dev/null +++ b/src/square/requests/register_domain_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from ..types.register_domain_response_status import RegisterDomainResponseStatus + + +class RegisterDomainResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain) endpoint. + + Either `errors` or `status` are present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + status: typing_extensions.NotRequired[RegisterDomainResponseStatus] + """ + The status of the domain registration. + + See [RegisterDomainResponseStatus](entity:RegisterDomainResponseStatus) for possible values. + See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values + """ diff --git a/src/square/requests/remove_group_from_customer_response.py b/src/square/requests/remove_group_from_customer_response.py new file mode 100644 index 00000000..dbe2f8cb --- /dev/null +++ b/src/square/requests/remove_group_from_customer_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class RemoveGroupFromCustomerResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer) + endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/resume_subscription_response.py b/src/square/requests/resume_subscription_response.py new file mode 100644 index 00000000..c71dadb1 --- /dev/null +++ b/src/square/requests/resume_subscription_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams +from .subscription_action import SubscriptionActionParams + + +class ResumeSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The resumed subscription. + """ + + actions: typing_extensions.NotRequired[typing.Sequence[SubscriptionActionParams]] + """ + A list of `RESUME` actions created by the request and scheduled for the subscription. + """ diff --git a/src/square/requests/retrieve_booking_custom_attribute_definition_response.py b/src/square/requests/retrieve_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..c53196cb --- /dev/null +++ b/src/square/requests/retrieve_booking_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class RetrieveBookingCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The retrieved custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_booking_custom_attribute_response.py b/src/square/requests/retrieve_booking_custom_attribute_response.py new file mode 100644 index 00000000..8a5b0d41 --- /dev/null +++ b/src/square/requests/retrieve_booking_custom_attribute_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class RetrieveBookingCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_job_response.py b/src/square/requests/retrieve_job_response.py new file mode 100644 index 00000000..b3f63846 --- /dev/null +++ b/src/square/requests/retrieve_job_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .job import JobParams +import typing +from .error import ErrorParams + + +class RetrieveJobResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) response. Either `job` or `errors` + is present in the response. + """ + + job: typing_extensions.NotRequired[JobParams] + """ + The retrieved job. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_location_booking_profile_response.py b/src/square/requests/retrieve_location_booking_profile_response.py new file mode 100644 index 00000000..9f388db3 --- /dev/null +++ b/src/square/requests/retrieve_location_booking_profile_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .location_booking_profile import LocationBookingProfileParams +import typing +from .error import ErrorParams + + +class RetrieveLocationBookingProfileResponseParams(typing_extensions.TypedDict): + location_booking_profile: typing_extensions.NotRequired[LocationBookingProfileParams] + """ + The requested location booking profile. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_location_custom_attribute_definition_response.py b/src/square/requests/retrieve_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..e1baac74 --- /dev/null +++ b/src/square/requests/retrieve_location_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class RetrieveLocationCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The retrieved custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_location_custom_attribute_response.py b/src/square/requests/retrieve_location_custom_attribute_response.py new file mode 100644 index 00000000..3b9027d4 --- /dev/null +++ b/src/square/requests/retrieve_location_custom_attribute_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class RetrieveLocationCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveLocationCustomAttribute](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_location_settings_response.py b/src/square/requests/retrieve_location_settings_response.py new file mode 100644 index 00000000..b9963397 --- /dev/null +++ b/src/square/requests/retrieve_location_settings_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .checkout_location_settings import CheckoutLocationSettingsParams + + +class RetrieveLocationSettingsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + location_settings: typing_extensions.NotRequired[CheckoutLocationSettingsParams] + """ + The location settings. + """ diff --git a/src/square/requests/retrieve_merchant_custom_attribute_definition_response.py b/src/square/requests/retrieve_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..d3716e5c --- /dev/null +++ b/src/square/requests/retrieve_merchant_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class RetrieveMerchantCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The retrieved custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_merchant_custom_attribute_response.py b/src/square/requests/retrieve_merchant_custom_attribute_response.py new file mode 100644 index 00000000..51e2276f --- /dev/null +++ b/src/square/requests/retrieve_merchant_custom_attribute_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class RetrieveMerchantCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_merchant_settings_response.py b/src/square/requests/retrieve_merchant_settings_response.py new file mode 100644 index 00000000..59e93198 --- /dev/null +++ b/src/square/requests/retrieve_merchant_settings_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .checkout_merchant_settings import CheckoutMerchantSettingsParams + + +class RetrieveMerchantSettingsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + merchant_settings: typing_extensions.NotRequired[CheckoutMerchantSettingsParams] + """ + The merchant settings. + """ diff --git a/src/square/requests/retrieve_order_custom_attribute_definition_response.py b/src/square/requests/retrieve_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..43dd63f9 --- /dev/null +++ b/src/square/requests/retrieve_order_custom_attribute_definition_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class RetrieveOrderCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from getting an order custom attribute definition. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The retrieved custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_order_custom_attribute_response.py b/src/square/requests/retrieve_order_custom_attribute_response.py new file mode 100644 index 00000000..5ec697b1 --- /dev/null +++ b/src/square/requests/retrieve_order_custom_attribute_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class RetrieveOrderCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a response from getting an order custom attribute. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, the custom attribute definition is returned in the `definition field. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/retrieve_token_status_response.py b/src/square/requests/retrieve_token_status_response.py new file mode 100644 index 00000000..4c0dc37d --- /dev/null +++ b/src/square/requests/retrieve_token_status_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class RetrieveTokenStatusResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `RetrieveTokenStatus` endpoint. + """ + + scopes: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The list of scopes associated with an access token. + """ + + expires_at: typing_extensions.NotRequired[str] + """ + The date and time when the `access_token` expires, in RFC 3339 format. Empty if the token never expires. + """ + + client_id: typing_extensions.NotRequired[str] + """ + The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token. + """ + + merchant_id: typing_extensions.NotRequired[str] + """ + The ID of the authorizing merchant's business. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/revoke_token_response.py b/src/square/requests/revoke_token_response.py new file mode 100644 index 00000000..f6caf213 --- /dev/null +++ b/src/square/requests/revoke_token_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class RevokeTokenResponseParams(typing_extensions.TypedDict): + success: typing_extensions.NotRequired[bool] + """ + If the request is successful, this is `true`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/risk_evaluation.py b/src/square/requests/risk_evaluation.py new file mode 100644 index 00000000..c46b8409 --- /dev/null +++ b/src/square/requests/risk_evaluation.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.risk_evaluation_risk_level import RiskEvaluationRiskLevel + + +class RiskEvaluationParams(typing_extensions.TypedDict): + """ + Represents fraud risk information for the associated payment. + + When you take a payment through Square's Payments API (using the `CreatePayment` + endpoint), Square evaluates it and assigns a risk level to the payment. Sellers + can use this information to determine the course of action (for example, + provide the goods/services or refund the payment). + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when payment risk was evaluated, in RFC 3339 format. + """ + + risk_level: typing_extensions.NotRequired[RiskEvaluationRiskLevel] + """ + The risk level associated with the payment + See [RiskEvaluationRiskLevel](#type-riskevaluationrisklevel) for possible values + """ diff --git a/src/square/requests/save_card_options.py b/src/square/requests/save_card_options.py new file mode 100644 index 00000000..21669437 --- /dev/null +++ b/src/square/requests/save_card_options.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SaveCardOptionsParams(typing_extensions.TypedDict): + """ + Describes save-card action fields. + """ + + customer_id: str + """ + The square-assigned ID of the customer linked to the saved card. + """ + + card_id: typing_extensions.NotRequired[str] + """ + The id of the created card-on-file. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional user-defined reference ID that can be used to associate + this `Card` to another entity in an external system. For example, a customer + ID generated by a third-party system. + """ diff --git a/src/square/requests/search_availability_filter.py b/src/square/requests/search_availability_filter.py new file mode 100644 index 00000000..9b5f4891 --- /dev/null +++ b/src/square/requests/search_availability_filter.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .time_range import TimeRangeParams +import typing_extensions +import typing +from .segment_filter import SegmentFilterParams + + +class SearchAvailabilityFilterParams(typing_extensions.TypedDict): + """ + A query filter to search for buyer-accessible availabilities by. + """ + + start_at_range: TimeRangeParams + """ + The query expression to search for buy-accessible availabilities with their starting times falling within the specified time range. + The time range must be at least 24 hours and at most 32 days long. + For waitlist availabilities, the time range can be 0 or more up to 367 days long. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID. + This query expression cannot be set if `booking_id` is set. + """ + + segment_filters: typing_extensions.NotRequired[typing.Optional[typing.Sequence[SegmentFilterParams]]] + """ + The query expression to search for buyer-accessible availabilities matching the specified list of segment filters. + If the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability. + + This query expression cannot be set if `booking_id` is set. + """ + + booking_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value. + This is commonly used to reschedule an appointment. + If this expression is set, the `location_id` and `segment_filters` expressions cannot be set. + """ diff --git a/src/square/requests/search_availability_query.py b/src/square/requests/search_availability_query.py new file mode 100644 index 00000000..5e703e33 --- /dev/null +++ b/src/square/requests/search_availability_query.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from .search_availability_filter import SearchAvailabilityFilterParams + + +class SearchAvailabilityQueryParams(typing_extensions.TypedDict): + """ + The query used to search for buyer-accessible availabilities of bookings. + """ + + filter: SearchAvailabilityFilterParams + """ + The query filter to search for buyer-accessible availabilities of existing bookings. + """ diff --git a/src/square/requests/search_availability_response.py b/src/square/requests/search_availability_response.py new file mode 100644 index 00000000..f9bae6a2 --- /dev/null +++ b/src/square/requests/search_availability_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .availability import AvailabilityParams +from .error import ErrorParams + + +class SearchAvailabilityResponseParams(typing_extensions.TypedDict): + availabilities: typing_extensions.NotRequired[typing.Sequence[AvailabilityParams]] + """ + List of appointment slots available for booking. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/search_catalog_items_response.py b/src/square/requests/search_catalog_items_response.py new file mode 100644 index 00000000..e6fd0e23 --- /dev/null +++ b/src/square/requests/search_catalog_items_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class SearchCatalogItemsResponseParams(typing_extensions.TypedDict): + """ + Defines the response body returned from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + items: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + Returned items matching the specified query expressions. + """ + + cursor: typing_extensions.NotRequired[str] + """ + Pagination token used in the next request to return more of the search result. + """ + + matched_variation_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + Ids of returned item variations matching the specified query expression. + """ diff --git a/src/square/requests/search_catalog_objects_response.py b/src/square/requests/search_catalog_objects_response.py new file mode 100644 index 00000000..53c915a8 --- /dev/null +++ b/src/square/requests/search_catalog_objects_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class SearchCatalogObjectsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, this is the final response. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + The CatalogObjects returned. + """ + + related_objects: typing_extensions.NotRequired[typing.Sequence[CatalogObjectParams]] + """ + A list of CatalogObjects referenced by the objects in the `objects` field. + """ + + latest_time: typing_extensions.NotRequired[str] + """ + When the associated product catalog was last updated. Will + match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. + """ diff --git a/src/square/requests/search_customers_response.py b/src/square/requests/search_customers_response.py new file mode 100644 index 00000000..c63303c5 --- /dev/null +++ b/src/square/requests/search_customers_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer import CustomerParams + + +class SearchCustomersResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the `SearchCustomers` endpoint. + + Either `errors` or `customers` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + customers: typing_extensions.NotRequired[typing.Sequence[CustomerParams]] + """ + The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`). + Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) + are included in the response. + """ + + cursor: typing_extensions.NotRequired[str] + """ + A pagination cursor that can be used during subsequent calls + to `SearchCustomers` to retrieve the next set of results associated + with the original query. Pagination cursors are only present when + a request succeeds and additional results are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + count: typing_extensions.NotRequired[int] + """ + The total count of customers associated with the Square account that match the search query. Only customer profiles with + public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is + present only if `count` is set to `true` in the request. + """ diff --git a/src/square/requests/search_events_filter.py b/src/square/requests/search_events_filter.py new file mode 100644 index 00000000..ac74dd08 --- /dev/null +++ b/src/square/requests/search_events_filter.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .time_range import TimeRangeParams + + +class SearchEventsFilterParams(typing_extensions.TypedDict): + """ + Criteria to filter events by. + """ + + event_types: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Filter events by event types. + """ + + merchant_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Filter events by merchant. + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Filter events by location. + """ + + created_at: typing_extensions.NotRequired[TimeRangeParams] + """ + Filter events by when they were created. + """ diff --git a/src/square/requests/search_events_query.py b/src/square/requests/search_events_query.py new file mode 100644 index 00000000..331af398 --- /dev/null +++ b/src/square/requests/search_events_query.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .search_events_filter import SearchEventsFilterParams +from .search_events_sort import SearchEventsSortParams + + +class SearchEventsQueryParams(typing_extensions.TypedDict): + """ + Contains query criteria for the search. + """ + + filter: typing_extensions.NotRequired[SearchEventsFilterParams] + """ + Criteria to filter events by. + """ + + sort: typing_extensions.NotRequired[SearchEventsSortParams] + """ + Criteria to sort events by. + """ diff --git a/src/square/requests/search_events_response.py b/src/square/requests/search_events_response.py new file mode 100644 index 00000000..ebfbc4a3 --- /dev/null +++ b/src/square/requests/search_events_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .event import EventParams +from .event_metadata import EventMetadataParams + + +class SearchEventsResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [SearchEvents](api-endpoint:Events-SearchEvents) endpoint. + + Note: if there are errors processing the request, the events field will not be + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + events: typing_extensions.NotRequired[typing.Sequence[EventParams]] + """ + The list of [Event](entity:Event)s returned by the search. + """ + + metadata: typing_extensions.NotRequired[typing.Sequence[EventMetadataParams]] + """ + Contains the metadata of an event. For more information, see [Event](entity:Event). + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/search_events_sort.py b/src/square/requests/search_events_sort.py new file mode 100644 index 00000000..967fe5a0 --- /dev/null +++ b/src/square/requests/search_events_sort.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.search_events_sort_field import SearchEventsSortField +from ..types.sort_order import SortOrder + + +class SearchEventsSortParams(typing_extensions.TypedDict): + """ + Criteria to sort events by. + """ + + field: typing_extensions.NotRequired[SearchEventsSortField] + """ + Sort events by event types. + See [SearchEventsSortField](#type-searcheventssortfield) for possible values + """ + + order: typing_extensions.NotRequired[SortOrder] + """ + The order to use for sorting the events. + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/search_invoices_response.py b/src/square/requests/search_invoices_response.py new file mode 100644 index 00000000..79dba59a --- /dev/null +++ b/src/square/requests/search_invoices_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .invoice import InvoiceParams +from .error import ErrorParams + + +class SearchInvoicesResponseParams(typing_extensions.TypedDict): + """ + Describes a `SearchInvoices` response. + """ + + invoices: typing_extensions.NotRequired[typing.Sequence[InvoiceParams]] + """ + The list of invoices returned by the search. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to fetch the next set of invoices. If empty, this is the final + response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/search_loyalty_accounts_request_loyalty_account_query.py b/src/square/requests/search_loyalty_accounts_request_loyalty_account_query.py new file mode 100644 index 00000000..439ea77c --- /dev/null +++ b/src/square/requests/search_loyalty_accounts_request_loyalty_account_query.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .loyalty_account_mapping import LoyaltyAccountMappingParams + + +class SearchLoyaltyAccountsRequestLoyaltyAccountQueryParams(typing_extensions.TypedDict): + """ + The search criteria for the loyalty accounts. + """ + + mappings: typing_extensions.NotRequired[typing.Optional[typing.Sequence[LoyaltyAccountMappingParams]]] + """ + The set of mappings to use in the loyalty account search. + + This cannot be combined with `customer_ids`. + + Max: 30 mappings + """ + + customer_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The set of customer IDs to use in the loyalty account search. + + This cannot be combined with `mappings`. + + Max: 30 customer IDs + """ diff --git a/src/square/requests/search_loyalty_accounts_response.py b/src/square/requests/search_loyalty_accounts_response.py new file mode 100644 index 00000000..17893705 --- /dev/null +++ b/src/square/requests/search_loyalty_accounts_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_account import LoyaltyAccountParams + + +class SearchLoyaltyAccountsResponseParams(typing_extensions.TypedDict): + """ + A response that includes loyalty accounts that satisfy the search criteria. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + loyalty_accounts: typing_extensions.NotRequired[typing.Sequence[LoyaltyAccountParams]] + """ + The loyalty accounts that met the search criteria, + in order of creation date. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to use in a subsequent + request. If empty, this is the final response. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/search_loyalty_events_response.py b/src/square/requests/search_loyalty_events_response.py new file mode 100644 index 00000000..f4467bcc --- /dev/null +++ b/src/square/requests/search_loyalty_events_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_event import LoyaltyEventParams + + +class SearchLoyaltyEventsResponseParams(typing_extensions.TypedDict): + """ + A response that contains loyalty events that satisfy the search + criteria, in order by the `created_at` date. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + events: typing_extensions.NotRequired[typing.Sequence[LoyaltyEventParams]] + """ + The loyalty events that satisfy the search criteria. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent + request. If empty, this is the final response. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/search_loyalty_rewards_request_loyalty_reward_query.py b/src/square/requests/search_loyalty_rewards_request_loyalty_reward_query.py new file mode 100644 index 00000000..13ab21fd --- /dev/null +++ b/src/square/requests/search_loyalty_rewards_request_loyalty_reward_query.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.loyalty_reward_status import LoyaltyRewardStatus + + +class SearchLoyaltyRewardsRequestLoyaltyRewardQueryParams(typing_extensions.TypedDict): + """ + The set of search requirements. + """ + + loyalty_account_id: str + """ + The ID of the [loyalty account](entity:LoyaltyAccount) to which the loyalty reward belongs. + """ + + status: typing_extensions.NotRequired[LoyaltyRewardStatus] + """ + The status of the loyalty reward. + See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values + """ diff --git a/src/square/requests/search_loyalty_rewards_response.py b/src/square/requests/search_loyalty_rewards_response.py new file mode 100644 index 00000000..421260f0 --- /dev/null +++ b/src/square/requests/search_loyalty_rewards_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .loyalty_reward import LoyaltyRewardParams + + +class SearchLoyaltyRewardsResponseParams(typing_extensions.TypedDict): + """ + A response that includes the loyalty rewards satisfying the search criteria. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + rewards: typing_extensions.NotRequired[typing.Sequence[LoyaltyRewardParams]] + """ + The loyalty rewards that satisfy the search criteria. + These are returned in descending order by `updated_at`. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent + request. If empty, this is the final response. + """ diff --git a/src/square/requests/search_orders_customer_filter.py b/src/square/requests/search_orders_customer_filter.py new file mode 100644 index 00000000..0cabb7a8 --- /dev/null +++ b/src/square/requests/search_orders_customer_filter.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SearchOrdersCustomerFilterParams(typing_extensions.TypedDict): + """ + A filter based on the order `customer_id` and any tender `customer_id` + associated with the order. It does not filter based on the + [FulfillmentRecipient](entity:FulfillmentRecipient) `customer_id`. + """ + + customer_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A list of customer IDs to filter by. + + Max: 10 customer ids. + """ diff --git a/src/square/requests/search_orders_date_time_filter.py b/src/square/requests/search_orders_date_time_filter.py new file mode 100644 index 00000000..c2a66eba --- /dev/null +++ b/src/square/requests/search_orders_date_time_filter.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .time_range import TimeRangeParams + + +class SearchOrdersDateTimeFilterParams(typing_extensions.TypedDict): + """ + Filter for `Order` objects based on whether their `CREATED_AT`, + `CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range. + You can specify the time range and which timestamp to filter for. You can filter + for only one time range at a time. + + For each time range, the start time and end time are inclusive. If the end time + is absent, it defaults to the time of the first request for the cursor. + + __Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query, + you must set the `sort_field` in [OrdersSort](entity:SearchOrdersSort) + to the same field you filter for. For example, if you set the `CLOSED_AT` field + in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to + `CLOSED_AT`. Otherwise, `SearchOrders` throws an error. + [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) + """ + + created_at: typing_extensions.NotRequired[TimeRangeParams] + """ + The time range for filtering on the `created_at` timestamp. If you use this + value, you must set the `sort_field` in the `OrdersSearchSort` object to + `CREATED_AT`. + """ + + updated_at: typing_extensions.NotRequired[TimeRangeParams] + """ + The time range for filtering on the `updated_at` timestamp. If you use this + value, you must set the `sort_field` in the `OrdersSearchSort` object to + `UPDATED_AT`. + """ + + closed_at: typing_extensions.NotRequired[TimeRangeParams] + """ + The time range for filtering on the `closed_at` timestamp. If you use this + value, you must set the `sort_field` in the `OrdersSearchSort` object to + `CLOSED_AT`. + """ diff --git a/src/square/requests/search_orders_filter.py b/src/square/requests/search_orders_filter.py new file mode 100644 index 00000000..793a2ae6 --- /dev/null +++ b/src/square/requests/search_orders_filter.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .search_orders_state_filter import SearchOrdersStateFilterParams +from .search_orders_date_time_filter import SearchOrdersDateTimeFilterParams +from .search_orders_fulfillment_filter import SearchOrdersFulfillmentFilterParams +from .search_orders_source_filter import SearchOrdersSourceFilterParams +from .search_orders_customer_filter import SearchOrdersCustomerFilterParams + + +class SearchOrdersFilterParams(typing_extensions.TypedDict): + """ + Filtering criteria to use for a `SearchOrders` request. Multiple filters + are ANDed together. + """ + + state_filter: typing_extensions.NotRequired[SearchOrdersStateFilterParams] + """ + Filter by [OrderState](entity:OrderState). + """ + + date_time_filter: typing_extensions.NotRequired[SearchOrdersDateTimeFilterParams] + """ + Filter for results within a time range. + + __Important:__ If you filter for orders by time range, you must set `SearchOrdersSort` + to sort by the same field. + [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) + """ + + fulfillment_filter: typing_extensions.NotRequired[SearchOrdersFulfillmentFilterParams] + """ + Filter by the fulfillment type or state. + """ + + source_filter: typing_extensions.NotRequired[SearchOrdersSourceFilterParams] + """ + Filter by the source of the order. + """ + + customer_filter: typing_extensions.NotRequired[SearchOrdersCustomerFilterParams] + """ + Filter by customers associated with the order. + """ diff --git a/src/square/requests/search_orders_fulfillment_filter.py b/src/square/requests/search_orders_fulfillment_filter.py new file mode 100644 index 00000000..72449b18 --- /dev/null +++ b/src/square/requests/search_orders_fulfillment_filter.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.fulfillment_type import FulfillmentType +from ..types.fulfillment_state import FulfillmentState + + +class SearchOrdersFulfillmentFilterParams(typing_extensions.TypedDict): + """ + Filter based on [order fulfillment](entity:Fulfillment) information. + """ + + fulfillment_types: typing_extensions.NotRequired[typing.Optional[typing.Sequence[FulfillmentType]]] + """ + A list of [fulfillment types](entity:FulfillmentType) to filter + for. The list returns orders if any of its fulfillments match any of the fulfillment types + listed in this field. + See [FulfillmentType](#type-fulfillmenttype) for possible values + """ + + fulfillment_states: typing_extensions.NotRequired[typing.Optional[typing.Sequence[FulfillmentState]]] + """ + A list of [fulfillment states](entity:FulfillmentState) to filter + for. The list returns orders if any of its fulfillments match any of the + fulfillment states listed in this field. + See [FulfillmentState](#type-fulfillmentstate) for possible values + """ diff --git a/src/square/requests/search_orders_query.py b/src/square/requests/search_orders_query.py new file mode 100644 index 00000000..41f1f5f7 --- /dev/null +++ b/src/square/requests/search_orders_query.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .search_orders_filter import SearchOrdersFilterParams +from .search_orders_sort import SearchOrdersSortParams + + +class SearchOrdersQueryParams(typing_extensions.TypedDict): + """ + Contains query criteria for the search. + """ + + filter: typing_extensions.NotRequired[SearchOrdersFilterParams] + """ + Criteria to filter results by. + """ + + sort: typing_extensions.NotRequired[SearchOrdersSortParams] + """ + Criteria to sort results by. + """ diff --git a/src/square/requests/search_orders_response.py b/src/square/requests/search_orders_response.py new file mode 100644 index 00000000..3ed5bb65 --- /dev/null +++ b/src/square/requests/search_orders_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .order_entry import OrderEntryParams +from .order import OrderParams +from .error import ErrorParams + + +class SearchOrdersResponseParams(typing_extensions.TypedDict): + """ + Either the `order_entries` or `orders` field is set, depending on whether + `return_entries` is set on the [SearchOrdersRequest](api-endpoint:Orders-SearchOrders). + """ + + order_entries: typing_extensions.NotRequired[typing.Sequence[OrderEntryParams]] + """ + A list of [OrderEntries](entity:OrderEntry) that fit the query + conditions. The list is populated only if `return_entries` is set to `true` in the request. + """ + + orders: typing_extensions.NotRequired[typing.Sequence[OrderParams]] + """ + A list of + [Order](entity:Order) objects that match the query conditions. The list is populated only if + `return_entries` is set to `false` in the request. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + [Errors](entity:Error) encountered during the search. + """ diff --git a/src/square/requests/search_orders_sort.py b/src/square/requests/search_orders_sort.py new file mode 100644 index 00000000..2efc3d85 --- /dev/null +++ b/src/square/requests/search_orders_sort.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.search_orders_sort_field import SearchOrdersSortField +import typing_extensions +from ..types.sort_order import SortOrder + + +class SearchOrdersSortParams(typing_extensions.TypedDict): + """ + Sorting criteria for a `SearchOrders` request. Results can only be sorted + by a timestamp field. + """ + + sort_field: SearchOrdersSortField + """ + The field to sort by. + + __Important:__ When using a [DateTimeFilter](entity:SearchOrdersFilter), + `sort_field` must match the timestamp field that the `DateTimeFilter` uses to + filter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a + `DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date. + If this field does not match the timestamp field in `DateTimeFilter`, + `SearchOrders` returns an error. + + Default: `CREATED_AT`. + See [SearchOrdersSortField](#type-searchorderssortfield) for possible values + """ + + sort_order: typing_extensions.NotRequired[SortOrder] + """ + The chronological order in which results are returned. Defaults to `DESC`. + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/search_orders_source_filter.py b/src/square/requests/search_orders_source_filter.py new file mode 100644 index 00000000..05a8a92c --- /dev/null +++ b/src/square/requests/search_orders_source_filter.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SearchOrdersSourceFilterParams(typing_extensions.TypedDict): + """ + A filter based on order `source` information. + """ + + source_names: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Filters by the [Source](entity:OrderSource) `name`. The filter returns any orders + with a `source.name` that matches any of the listed source names. + + Max: 10 source names. + """ diff --git a/src/square/requests/search_orders_state_filter.py b/src/square/requests/search_orders_state_filter.py new file mode 100644 index 00000000..e43825dc --- /dev/null +++ b/src/square/requests/search_orders_state_filter.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from ..types.order_state import OrderState + + +class SearchOrdersStateFilterParams(typing_extensions.TypedDict): + """ + Filter by the current order `state`. + """ + + states: typing.Sequence[OrderState] + """ + States to filter for. + See [OrderState](#type-orderstate) for possible values + """ diff --git a/src/square/requests/search_shifts_response.py b/src/square/requests/search_shifts_response.py new file mode 100644 index 00000000..8ce6a38b --- /dev/null +++ b/src/square/requests/search_shifts_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .shift import ShiftParams +from .error import ErrorParams + + +class SearchShiftsResponseParams(typing_extensions.TypedDict): + """ + The response to a request for `Shift` objects. The response contains + the requested `Shift` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shifts: typing_extensions.NotRequired[typing.Sequence[ShiftParams]] + """ + Shifts. + """ + + cursor: typing_extensions.NotRequired[str] + """ + An opaque cursor for fetching the next page. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/search_subscriptions_filter.py b/src/square/requests/search_subscriptions_filter.py new file mode 100644 index 00000000..32f4ec74 --- /dev/null +++ b/src/square/requests/search_subscriptions_filter.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SearchSubscriptionsFilterParams(typing_extensions.TypedDict): + """ + Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by + the [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint. + """ + + customer_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A filter to select subscriptions based on the subscribing customer IDs. + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A filter to select subscriptions based on the location. + """ + + source_names: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + A filter to select subscriptions based on the source application. + """ diff --git a/src/square/requests/search_subscriptions_query.py b/src/square/requests/search_subscriptions_query.py new file mode 100644 index 00000000..b5c3e435 --- /dev/null +++ b/src/square/requests/search_subscriptions_query.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .search_subscriptions_filter import SearchSubscriptionsFilterParams + + +class SearchSubscriptionsQueryParams(typing_extensions.TypedDict): + """ + Represents a query, consisting of specified query expressions, used to search for subscriptions. + """ + + filter: typing_extensions.NotRequired[SearchSubscriptionsFilterParams] + """ + A list of query expressions. + """ diff --git a/src/square/requests/search_subscriptions_response.py b/src/square/requests/search_subscriptions_response.py new file mode 100644 index 00000000..e2489cc7 --- /dev/null +++ b/src/square/requests/search_subscriptions_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams + + +class SearchSubscriptionsResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscriptions: typing_extensions.NotRequired[typing.Sequence[SubscriptionParams]] + """ + The subscriptions matching the specified query expressions. + """ + + cursor: typing_extensions.NotRequired[str] + """ + When the total number of resulting subscription exceeds the limit of a paged response, + the response includes a cursor for you to use in a subsequent request to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ diff --git a/src/square/requests/search_team_members_filter.py b/src/square/requests/search_team_members_filter.py new file mode 100644 index 00000000..ce7427f9 --- /dev/null +++ b/src/square/requests/search_team_members_filter.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.team_member_status import TeamMemberStatus + + +class SearchTeamMembersFilterParams(typing_extensions.TypedDict): + """ + Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied + between the individual fields, and `OR` logic is applied within list-based fields. + For example, setting this filter value: + ``` + filter = (locations_ids = ["A", "B"], status = ACTIVE) + ``` + returns only active team members assigned to either location "A" or "B". + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + When present, filters by team members assigned to the specified locations. + When empty, includes team members assigned to any location. + """ + + status: typing_extensions.NotRequired[TeamMemberStatus] + """ + When present, filters by team members who match the given status. + When empty, includes team members of all statuses. + See [TeamMemberStatus](#type-teammemberstatus) for possible values + """ + + is_owner: typing_extensions.NotRequired[typing.Optional[bool]] + """ + When present and set to true, returns the team member who is the owner of the Square account. + """ diff --git a/src/square/requests/search_team_members_query.py b/src/square/requests/search_team_members_query.py new file mode 100644 index 00000000..95965e03 --- /dev/null +++ b/src/square/requests/search_team_members_query.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .search_team_members_filter import SearchTeamMembersFilterParams + + +class SearchTeamMembersQueryParams(typing_extensions.TypedDict): + """ + Represents the parameters in a search for `TeamMember` objects. + """ + + filter: typing_extensions.NotRequired[SearchTeamMembersFilterParams] + """ + The options to filter by. + """ diff --git a/src/square/requests/search_team_members_response.py b/src/square/requests/search_team_members_response.py new file mode 100644 index 00000000..1db13d28 --- /dev/null +++ b/src/square/requests/search_team_members_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .team_member import TeamMemberParams +from .error import ErrorParams + + +class SearchTeamMembersResponseParams(typing_extensions.TypedDict): + """ + Represents a response from a search request containing a filtered list of `TeamMember` objects. + """ + + team_members: typing_extensions.NotRequired[typing.Sequence[TeamMemberParams]] + """ + The filtered list of `TeamMember` objects. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The opaque cursor for fetching the next page. For more information, see + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/search_terminal_actions_response.py b/src/square/requests/search_terminal_actions_response.py new file mode 100644 index 00000000..66d3ceae --- /dev/null +++ b/src/square/requests/search_terminal_actions_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_action import TerminalActionParams + + +class SearchTerminalActionsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + action: typing_extensions.NotRequired[typing.Sequence[TerminalActionParams]] + """ + The requested search result of `TerminalAction`s. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more + information. + """ diff --git a/src/square/requests/search_terminal_checkouts_response.py b/src/square/requests/search_terminal_checkouts_response.py new file mode 100644 index 00000000..85eb1317 --- /dev/null +++ b/src/square/requests/search_terminal_checkouts_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_checkout import TerminalCheckoutParams + + +class SearchTerminalCheckoutsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + checkouts: typing_extensions.NotRequired[typing.Sequence[TerminalCheckoutParams]] + """ + The requested search result of `TerminalCheckout` objects. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ diff --git a/src/square/requests/search_terminal_refunds_response.py b/src/square/requests/search_terminal_refunds_response.py new file mode 100644 index 00000000..c578c273 --- /dev/null +++ b/src/square/requests/search_terminal_refunds_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .terminal_refund import TerminalRefundParams + + +class SearchTerminalRefundsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + refunds: typing_extensions.NotRequired[typing.Sequence[TerminalRefundParams]] + """ + The requested search result of `TerminalRefund` objects. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ diff --git a/src/square/requests/search_vendors_request_filter.py b/src/square/requests/search_vendors_request_filter.py new file mode 100644 index 00000000..9179f6d8 --- /dev/null +++ b/src/square/requests/search_vendors_request_filter.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.vendor_status import VendorStatus + + +class SearchVendorsRequestFilterParams(typing_extensions.TypedDict): + """ + Defines supported query expressions to search for vendors by. + """ + + name: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The names of the [Vendor](entity:Vendor) objects to retrieve. + """ + + status: typing_extensions.NotRequired[typing.Optional[typing.Sequence[VendorStatus]]] + """ + The statuses of the [Vendor](entity:Vendor) objects to retrieve. + See [VendorStatus](#type-vendorstatus) for possible values + """ diff --git a/src/square/requests/search_vendors_request_sort.py b/src/square/requests/search_vendors_request_sort.py new file mode 100644 index 00000000..666ec42b --- /dev/null +++ b/src/square/requests/search_vendors_request_sort.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.search_vendors_request_sort_field import SearchVendorsRequestSortField +from ..types.sort_order import SortOrder + + +class SearchVendorsRequestSortParams(typing_extensions.TypedDict): + """ + Defines a sorter used to sort results from [SearchVendors](api-endpoint:Vendors-SearchVendors). + """ + + field: typing_extensions.NotRequired[SearchVendorsRequestSortField] + """ + Specifies the sort key to sort the returned vendors. + See [Field](#type-field) for possible values + """ + + order: typing_extensions.NotRequired[SortOrder] + """ + Specifies the sort order for the returned vendors. + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/search_vendors_response.py b/src/square/requests/search_vendors_response.py new file mode 100644 index 00000000..1db5871d --- /dev/null +++ b/src/square/requests/search_vendors_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .vendor import VendorParams + + +class SearchVendorsResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [SearchVendors](api-endpoint:Vendors-SearchVendors). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered when the request fails. + """ + + vendors: typing_extensions.NotRequired[typing.Sequence[VendorParams]] + """ + The [Vendor](entity:Vendor) objects matching the specified search filter. + """ + + cursor: typing_extensions.NotRequired[str] + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ diff --git a/src/square/requests/segment_filter.py b/src/square/requests/segment_filter.py new file mode 100644 index 00000000..d1637315 --- /dev/null +++ b/src/square/requests/segment_filter.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .filter_value import FilterValueParams + + +class SegmentFilterParams(typing_extensions.TypedDict): + """ + A query filter to search for buyer-accessible appointment segments by. + """ + + service_variation_id: str + """ + The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment. + """ + + team_member_id_filter: typing_extensions.NotRequired[FilterValueParams] + """ + A query filter to search for buyer-accessible appointment segments with service-providing team members matching the specified list of team member IDs. Supported query expressions are + - `ANY`: return the appointment segments with team members whose IDs match any member in this list. + - `NONE`: return the appointment segments with team members whose IDs are not in this list. + - `ALL`: not supported. + + When no expression is specified, any service-providing team member is eligible to fulfill the Booking. + """ diff --git a/src/square/requests/select_option.py b/src/square/requests/select_option.py new file mode 100644 index 00000000..e7cedd64 --- /dev/null +++ b/src/square/requests/select_option.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class SelectOptionParams(typing_extensions.TypedDict): + reference_id: str + """ + The reference id for the option. + """ + + title: str + """ + The title text that displays in the select option button. + """ diff --git a/src/square/requests/select_options.py b/src/square/requests/select_options.py new file mode 100644 index 00000000..529f527c --- /dev/null +++ b/src/square/requests/select_options.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +from .select_option import SelectOptionParams +import typing_extensions + + +class SelectOptionsParams(typing_extensions.TypedDict): + title: str + """ + The title text to display in the select flow on the Terminal. + """ + + body: str + """ + The body text to display in the select flow on the Terminal. + """ + + options: typing.Sequence[SelectOptionParams] + """ + Represents the buttons/options that should be displayed in the select flow on the Terminal. + """ + + selected_option: typing_extensions.NotRequired[SelectOptionParams] + """ + The buyer’s selected option. + """ diff --git a/src/square/requests/shift.py b/src/square/requests/shift.py new file mode 100644 index 00000000..c8f0dea5 --- /dev/null +++ b/src/square/requests/shift.py @@ -0,0 +1,98 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .shift_wage import ShiftWageParams +from .break_ import BreakParams +from ..types.shift_status import ShiftStatus +from .money import MoneyParams + + +class ShiftParams(typing_extensions.TypedDict): + """ + A record of the hourly rate, start, and end times for a single work shift + for an employee. This might include a record of the start and end times for breaks + taken during the shift. + """ + + id: typing_extensions.NotRequired[str] + """ + The UUID for this object. + """ + + employee_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead. + """ + + location_id: str + """ + The ID of the location this shift occurred at. The location should be based on + where the employee clocked in. + """ + + timezone: typing_extensions.NotRequired[typing.Optional[str]] + """ + The read-only convenience value that is calculated from the location based + on the `location_id`. Format: the IANA timezone database identifier for the + location timezone. + """ + + start_at: str + """ + RFC 3339; shifted to the location timezone + offset. Precision up to the + minute is respected; seconds are truncated. + """ + + end_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + RFC 3339; shifted to the timezone + offset. Precision up to the minute is + respected; seconds are truncated. + """ + + wage: typing_extensions.NotRequired[ShiftWageParams] + """ + Job and pay related information. If the wage is not set on create, it defaults to a wage + of zero. If the title is not set on create, it defaults to the name of the role the employee + is assigned to, if any. + """ + + breaks: typing_extensions.NotRequired[typing.Optional[typing.Sequence[BreakParams]]] + """ + A list of all the paid or unpaid breaks that were taken during this shift. + """ + + status: typing_extensions.NotRequired[ShiftStatus] + """ + Describes the working state of the current `Shift`. + See [ShiftStatus](#type-shiftstatus) for possible values + """ + + version: typing_extensions.NotRequired[int] + """ + Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If not provided, + Square executes a blind write; potentially overwriting data from another + write. + """ + + created_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26". + """ + + declared_cash_tip_money: typing_extensions.NotRequired[MoneyParams] + """ + The tips declared by the team member for the shift. + """ diff --git a/src/square/requests/shift_filter.py b/src/square/requests/shift_filter.py new file mode 100644 index 00000000..89effaab --- /dev/null +++ b/src/square/requests/shift_filter.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.shift_filter_status import ShiftFilterStatus +from .time_range import TimeRangeParams +from .shift_workday import ShiftWorkdayParams + + +class ShiftFilterParams(typing_extensions.TypedDict): + """ + Defines a filter used in a search for `Shift` records. `AND` logic is + used by Square's servers to apply each filter property specified. + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Fetch shifts for the specified location. + """ + + employee_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead. + """ + + status: typing_extensions.NotRequired[ShiftFilterStatus] + """ + Fetch a `Shift` instance by `Shift.status`. + See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values + """ + + start: typing_extensions.NotRequired[TimeRangeParams] + """ + Fetch `Shift` instances that start in the time range - Inclusive. + """ + + end: typing_extensions.NotRequired[TimeRangeParams] + """ + Fetch the `Shift` instances that end in the time range - Inclusive. + """ + + workday: typing_extensions.NotRequired[ShiftWorkdayParams] + """ + Fetch the `Shift` instances based on the workday date range. + """ + + team_member_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + Fetch shifts for the specified team members. Replaced `employee_ids` at version "2020-08-26". + """ diff --git a/src/square/requests/shift_query.py b/src/square/requests/shift_query.py new file mode 100644 index 00000000..7d35a903 --- /dev/null +++ b/src/square/requests/shift_query.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .shift_filter import ShiftFilterParams +from .shift_sort import ShiftSortParams + + +class ShiftQueryParams(typing_extensions.TypedDict): + """ + The parameters of a `Shift` search query, which includes filter and sort options. + """ + + filter: typing_extensions.NotRequired[ShiftFilterParams] + """ + Query filter options. + """ + + sort: typing_extensions.NotRequired[ShiftSortParams] + """ + Sort order details. + """ diff --git a/src/square/requests/shift_sort.py b/src/square/requests/shift_sort.py new file mode 100644 index 00000000..fecd99c0 --- /dev/null +++ b/src/square/requests/shift_sort.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.shift_sort_field import ShiftSortField +from ..types.sort_order import SortOrder + + +class ShiftSortParams(typing_extensions.TypedDict): + """ + Sets the sort order of search results. + """ + + field: typing_extensions.NotRequired[ShiftSortField] + """ + The field to sort on. + See [ShiftSortField](#type-shiftsortfield) for possible values + """ + + order: typing_extensions.NotRequired[SortOrder] + """ + The order in which results are returned. Defaults to DESC. + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/shift_wage.py b/src/square/requests/shift_wage.py new file mode 100644 index 00000000..0aaf7feb --- /dev/null +++ b/src/square/requests/shift_wage.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class ShiftWageParams(typing_extensions.TypedDict): + """ + The hourly wage rate used to compensate an employee for this shift. + """ + + title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the job performed during this shift. + """ + + hourly_rate: typing_extensions.NotRequired[MoneyParams] + """ + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + """ + + job_id: typing_extensions.NotRequired[str] + """ + The id of the job performed during this shift. Square + labor-reporting UIs might group shifts together by id. This cannot be used to retrieve the job. + """ + + tip_eligible: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether team members are eligible for tips when working this job. + """ diff --git a/src/square/requests/shift_workday.py b/src/square/requests/shift_workday.py new file mode 100644 index 00000000..bda678d3 --- /dev/null +++ b/src/square/requests/shift_workday.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .date_range import DateRangeParams +from ..types.shift_workday_matcher import ShiftWorkdayMatcher +import typing + + +class ShiftWorkdayParams(typing_extensions.TypedDict): + """ + A `Shift` search query filter parameter that sets a range of days that + a `Shift` must start or end in before passing the filter condition. + """ + + date_range: typing_extensions.NotRequired[DateRangeParams] + """ + Dates for fetching the shifts. + """ + + match_shifts_by: typing_extensions.NotRequired[ShiftWorkdayMatcher] + """ + The strategy on which the dates are applied. + See [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible values + """ + + default_timezone: typing_extensions.NotRequired[typing.Optional[str]] + """ + Location-specific timezones convert workdays to datetime filters. + Every location included in the query must have a timezone or this field + must be provided as a fallback. Format: the IANA timezone database + identifier for the relevant timezone. + """ diff --git a/src/square/requests/shipping_fee.py b/src/square/requests/shipping_fee.py new file mode 100644 index 00000000..8eab3f4e --- /dev/null +++ b/src/square/requests/shipping_fee.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class ShippingFeeParams(typing_extensions.TypedDict): + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name for the shipping fee. + """ + + charge: MoneyParams + """ + The amount and currency for the shipping fee. + """ diff --git a/src/square/requests/signature_image.py b/src/square/requests/signature_image.py new file mode 100644 index 00000000..ceaa8beb --- /dev/null +++ b/src/square/requests/signature_image.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class SignatureImageParams(typing_extensions.TypedDict): + image_type: typing_extensions.NotRequired[str] + """ + The mime/type of the image data. + Use `image/png;base64` for png. + """ + + data: typing_extensions.NotRequired[str] + """ + The base64 representation of the image. + """ diff --git a/src/square/requests/signature_options.py b/src/square/requests/signature_options.py new file mode 100644 index 00000000..f7dcedfa --- /dev/null +++ b/src/square/requests/signature_options.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .signature_image import SignatureImageParams + + +class SignatureOptionsParams(typing_extensions.TypedDict): + title: str + """ + The title text to display in the signature capture flow on the Terminal. + """ + + body: str + """ + The body text to display in the signature capture flow on the Terminal. + """ + + signature: typing_extensions.NotRequired[typing.Sequence[SignatureImageParams]] + """ + An image representation of the collected signature. + """ diff --git a/src/square/requests/site.py b/src/square/requests/site.py new file mode 100644 index 00000000..07448c1e --- /dev/null +++ b/src/square/requests/site.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SiteParams(typing_extensions.TypedDict): + """ + Represents a Square Online site, which is an online store for a Square seller. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the site. + """ + + site_title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The title of the site. + """ + + domain: typing_extensions.NotRequired[typing.Optional[str]] + """ + The domain of the site (without the protocol). For example, `mysite1.square.site`. + """ + + is_published: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the site is published. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the site was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the site was last updated, in RFC 3339 format. + """ diff --git a/src/square/requests/snippet.py b/src/square/requests/snippet.py new file mode 100644 index 00000000..b8c82ad6 --- /dev/null +++ b/src/square/requests/snippet.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class SnippetParams(typing_extensions.TypedDict): + """ + Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages. + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID for the snippet. + """ + + site_id: typing_extensions.NotRequired[str] + """ + The ID of the site that contains the snippet. + """ + + content: str + """ + The snippet code, which can contain valid HTML, JavaScript, or both. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the snippet was initially added to the site, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the snippet was last updated on the site, in RFC 3339 format. + """ diff --git a/src/square/requests/source_application.py b/src/square/requests/source_application.py new file mode 100644 index 00000000..581e159e --- /dev/null +++ b/src/square/requests/source_application.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.product import Product +import typing + + +class SourceApplicationParams(typing_extensions.TypedDict): + """ + Represents information about the application used to generate a change. + """ + + product: typing_extensions.NotRequired[Product] + """ + __Read only__ The [product](entity:Product) type of the application. + See [Product](#type-product) for possible values + """ + + application_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + __Read only__ The Square-assigned ID of the application. This field is used only if the + [product](entity:Product) type is `EXTERNAL_API`. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + __Read only__ The display name of the application + (for example, `"Custom Application"` or `"Square POS 4.74 for Android"`). + """ diff --git a/src/square/requests/square_account_details.py b/src/square/requests/square_account_details.py new file mode 100644 index 00000000..1e00023e --- /dev/null +++ b/src/square/requests/square_account_details.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class SquareAccountDetailsParams(typing_extensions.TypedDict): + """ + Additional details about Square Account payments. + """ + + payment_source_token: typing_extensions.NotRequired[typing.Optional[str]] + """ + Unique identifier for the payment source used for this payment. + """ + + errors: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ErrorParams]]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/standard_unit_description.py b/src/square/requests/standard_unit_description.py new file mode 100644 index 00000000..88550059 --- /dev/null +++ b/src/square/requests/standard_unit_description.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .measurement_unit import MeasurementUnitParams +import typing + + +class StandardUnitDescriptionParams(typing_extensions.TypedDict): + """ + Contains the name and abbreviation for standard measurement unit. + """ + + unit: typing_extensions.NotRequired[MeasurementUnitParams] + """ + Identifies the measurement unit being described. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + UI display name of the measurement unit. For example, 'Pound'. + """ + + abbreviation: typing_extensions.NotRequired[typing.Optional[str]] + """ + UI display abbreviation for the measurement unit. For example, 'lb'. + """ diff --git a/src/square/requests/standard_unit_description_group.py b/src/square/requests/standard_unit_description_group.py new file mode 100644 index 00000000..1d149127 --- /dev/null +++ b/src/square/requests/standard_unit_description_group.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .standard_unit_description import StandardUnitDescriptionParams + + +class StandardUnitDescriptionGroupParams(typing_extensions.TypedDict): + """ + Group of standard measurement units. + """ + + standard_unit_descriptions: typing_extensions.NotRequired[ + typing.Optional[typing.Sequence[StandardUnitDescriptionParams]] + ] + """ + List of standard (non-custom) measurement units in this description group. + """ + + language_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + IETF language tag. + """ diff --git a/src/square/requests/submit_evidence_response.py b/src/square/requests/submit_evidence_response.py new file mode 100644 index 00000000..49c25291 --- /dev/null +++ b/src/square/requests/submit_evidence_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .dispute import DisputeParams + + +class SubmitEvidenceResponseParams(typing_extensions.TypedDict): + """ + Defines the fields in a `SubmitEvidence` response. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + dispute: typing_extensions.NotRequired[DisputeParams] + """ + The `Dispute` for which evidence was submitted. + """ diff --git a/src/square/requests/subscription.py b/src/square/requests/subscription.py new file mode 100644 index 00000000..7df62b03 --- /dev/null +++ b/src/square/requests/subscription.py @@ -0,0 +1,144 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.subscription_status import SubscriptionStatus +from .money import MoneyParams +from .subscription_source import SubscriptionSourceParams +from .subscription_action import SubscriptionActionParams +from .phase import PhaseParams + + +class SubscriptionParams(typing_extensions.TypedDict): + """ + Represents a subscription purchased by a customer. + + For more information, see + [Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). + """ + + id: typing_extensions.NotRequired[str] + """ + The Square-assigned ID of the subscription. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The ID of the location associated with the subscription. + """ + + plan_variation_id: typing_extensions.NotRequired[str] + """ + The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation). + """ + + customer_id: typing_extensions.NotRequired[str] + """ + The ID of the subscribing [customer](entity:Customer) profile. + """ + + start_date: typing_extensions.NotRequired[str] + """ + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription. + """ + + canceled_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription, + when the subscription status changes to `CANCELED` and the subscription billing stops. + + If this field is not set, the subscription ends according its subscription plan. + + This field cannot be updated, other than being cleared. + """ + + charged_through_date: typing_extensions.NotRequired[str] + """ + The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the + subscription. + + After the invoice is sent for a given billing period, + this date will be the last day of the billing period. + For example, + suppose for the month of May a subscriber gets an invoice + (or charged the card) on May 1. For the monthly billing scenario, + this date is then set to May 31. + """ + + status: typing_extensions.NotRequired[SubscriptionStatus] + """ + The current status of the subscription. + See [SubscriptionStatus](#type-subscriptionstatus) for possible values + """ + + tax_percentage: typing_extensions.NotRequired[typing.Optional[str]] + """ + The tax amount applied when billing the subscription. The + percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of `7.5` + corresponds to 7.5%. + """ + + invoice_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + The IDs of the [invoices](entity:Invoice) created for the + subscription, listed in order when the invoices were created + (newest invoices appear first). + """ + + price_override_money: typing_extensions.NotRequired[MoneyParams] + """ + A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. + This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, + you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + """ + + version: typing_extensions.NotRequired[int] + """ + The version of the object. When updating an object, the version + supplied must match the version in the database, otherwise the write will + be rejected as conflicting. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the subscription was created, in RFC 3339 format. + """ + + card_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [subscriber's](entity:Customer) [card](entity:Card) + used to charge for the subscription. + """ + + timezone: typing_extensions.NotRequired[str] + """ + Timezone that will be used in date calculations for the subscription. + Defaults to the timezone of the location based on `location_id`. + Format: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`). + """ + + source: typing_extensions.NotRequired[SubscriptionSourceParams] + """ + The origination details of the subscription. + """ + + actions: typing_extensions.NotRequired[typing.Optional[typing.Sequence[SubscriptionActionParams]]] + """ + The list of scheduled actions on this subscription. It is set only in the response from + [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) with the query parameter + of `include=actions` or from + [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) with the input parameter + of `include:["actions"]`. + """ + + monthly_billing_anchor_date: typing_extensions.NotRequired[int] + """ + The day of the month on which the subscription will issue invoices and publish orders. + """ + + phases: typing_extensions.NotRequired[typing.Sequence[PhaseParams]] + """ + array of phases for this subscription + """ diff --git a/src/square/requests/subscription_action.py b/src/square/requests/subscription_action.py new file mode 100644 index 00000000..9c6be863 --- /dev/null +++ b/src/square/requests/subscription_action.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.subscription_action_type import SubscriptionActionType +import typing +from .phase import PhaseParams + + +class SubscriptionActionParams(typing_extensions.TypedDict): + """ + Represents an action as a pending change to a subscription. + """ + + id: typing_extensions.NotRequired[str] + """ + The ID of an action scoped to a subscription. + """ + + type: typing_extensions.NotRequired[SubscriptionActionType] + """ + The type of the action. + See [SubscriptionActionType](#type-subscriptionactiontype) for possible values + """ + + effective_date: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `YYYY-MM-DD`-formatted date when the action occurs on the subscription. + """ + + monthly_billing_anchor_date: typing_extensions.NotRequired[typing.Optional[int]] + """ + The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action. + """ + + phases: typing_extensions.NotRequired[typing.Optional[typing.Sequence[PhaseParams]]] + """ + A list of Phases, to pass phase-specific information used in the swap. + """ + + new_plan_variation_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action. + """ diff --git a/src/square/requests/subscription_event.py b/src/square/requests/subscription_event.py new file mode 100644 index 00000000..71effc95 --- /dev/null +++ b/src/square/requests/subscription_event.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +from ..types.subscription_event_subscription_event_type import SubscriptionEventSubscriptionEventType +import typing_extensions +from .subscription_event_info import SubscriptionEventInfoParams +import typing +from .phase import PhaseParams + + +class SubscriptionEventParams(typing_extensions.TypedDict): + """ + Describes changes to a subscription and the subscription status. + """ + + id: str + """ + The ID of the subscription event. + """ + + subscription_event_type: SubscriptionEventSubscriptionEventType + """ + Type of the subscription event. + See [SubscriptionEventSubscriptionEventType](#type-subscriptioneventsubscriptioneventtype) for possible values + """ + + effective_date: str + """ + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the subscription event occurred. + """ + + monthly_billing_anchor_date: typing_extensions.NotRequired[int] + """ + The day-of-the-month the billing anchor date was changed to, if applicable. + """ + + info: typing_extensions.NotRequired[SubscriptionEventInfoParams] + """ + Additional information about the subscription event. + """ + + phases: typing_extensions.NotRequired[typing.Optional[typing.Sequence[PhaseParams]]] + """ + A list of Phases, to pass phase-specific information used in the swap. + """ + + plan_variation_id: str + """ + The ID of the subscription plan variation associated with the subscription. + """ diff --git a/src/square/requests/subscription_event_info.py b/src/square/requests/subscription_event_info.py new file mode 100644 index 00000000..ab0267a3 --- /dev/null +++ b/src/square/requests/subscription_event_info.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.subscription_event_info_code import SubscriptionEventInfoCode + + +class SubscriptionEventInfoParams(typing_extensions.TypedDict): + """ + Provides information about the subscription event. + """ + + detail: typing_extensions.NotRequired[typing.Optional[str]] + """ + A human-readable explanation for the event. + """ + + code: typing_extensions.NotRequired[SubscriptionEventInfoCode] + """ + An info code indicating the subscription event that occurred. + See [InfoCode](#type-infocode) for possible values + """ diff --git a/src/square/requests/subscription_phase.py b/src/square/requests/subscription_phase.py new file mode 100644 index 00000000..7819cf86 --- /dev/null +++ b/src/square/requests/subscription_phase.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.subscription_cadence import SubscriptionCadence +from .money import MoneyParams +from .subscription_pricing import SubscriptionPricingParams + + +class SubscriptionPhaseParams(typing_extensions.TypedDict): + """ + Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + """ + + uid: typing_extensions.NotRequired[typing.Optional[str]] + """ + The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created. + """ + + cadence: SubscriptionCadence + """ + The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created. + See [SubscriptionCadence](#type-subscriptioncadence) for possible values + """ + + periods: typing_extensions.NotRequired[typing.Optional[int]] + """ + The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created. + """ + + recurring_price_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount to bill for each `cadence`. Failure to specify this field results in a `MISSING_REQUIRED_PARAMETER` error at runtime. + """ + + ordinal: typing_extensions.NotRequired[typing.Optional[int]] + """ + The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created. + """ + + pricing: typing_extensions.NotRequired[SubscriptionPricingParams] + """ + The subscription pricing. + """ diff --git a/src/square/requests/subscription_pricing.py b/src/square/requests/subscription_pricing.py new file mode 100644 index 00000000..fe18bd2b --- /dev/null +++ b/src/square/requests/subscription_pricing.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.subscription_pricing_type import SubscriptionPricingType +import typing +from .money import MoneyParams + + +class SubscriptionPricingParams(typing_extensions.TypedDict): + """ + Describes the pricing for the subscription. + """ + + type: typing_extensions.NotRequired[SubscriptionPricingType] + """ + RELATIVE or STATIC + See [SubscriptionPricingType](#type-subscriptionpricingtype) for possible values + """ + + discount_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The ids of the discount catalog objects + """ + + price_money: typing_extensions.NotRequired[MoneyParams] + """ + The price of the subscription, if STATIC + """ diff --git a/src/square/requests/subscription_source.py b/src/square/requests/subscription_source.py new file mode 100644 index 00000000..d47cde83 --- /dev/null +++ b/src/square/requests/subscription_source.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SubscriptionSourceParams(typing_extensions.TypedDict): + """ + The origination details of the subscription. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name used to identify the place (physical or digital) that + a subscription originates. If unset, the name defaults to the name + of the application that created the subscription. + """ diff --git a/src/square/requests/subscription_test_result.py b/src/square/requests/subscription_test_result.py new file mode 100644 index 00000000..b4f852c3 --- /dev/null +++ b/src/square/requests/subscription_test_result.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class SubscriptionTestResultParams(typing_extensions.TypedDict): + """ + Represents the details of a webhook subscription, including notification URL, + event types, and signature key. + """ + + id: typing_extensions.NotRequired[str] + """ + A Square-generated unique ID for the subscription test result. + """ + + status_code: typing_extensions.NotRequired[typing.Optional[int]] + """ + The status code returned by the subscription notification URL. + """ + + payload: typing_extensions.NotRequired[typing.Optional[str]] + """ + An object containing the payload of the test event. For example, a `payment.created` event. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the subscription was created, in RFC 3339 format. + For example, "2016-09-04T23:59:33.123Z". + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the subscription was updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". + Because a subscription test result is unique, this field is the same as the `created_at` field. + """ diff --git a/src/square/requests/swap_plan_response.py b/src/square/requests/swap_plan_response.py new file mode 100644 index 00000000..5270c11b --- /dev/null +++ b/src/square/requests/swap_plan_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams +from .subscription_action import SubscriptionActionParams + + +class SwapPlanResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response of the + [SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The subscription with the updated subscription plan. + """ + + actions: typing_extensions.NotRequired[typing.Sequence[SubscriptionActionParams]] + """ + A list of a `SWAP_PLAN` action created by the request. + """ diff --git a/src/square/requests/tax_ids.py b/src/square/requests/tax_ids.py new file mode 100644 index 00000000..d50377c4 --- /dev/null +++ b/src/square/requests/tax_ids.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class TaxIdsParams(typing_extensions.TypedDict): + """ + Identifiers for the location used by various governments for tax purposes. + """ + + eu_vat: typing_extensions.NotRequired[str] + """ + The EU VAT number for this location. For example, `IE3426675K`. + If the EU VAT number is present, it is well-formed and has been + validated with VIES, the VAT Information Exchange System. + """ + + fr_siret: typing_extensions.NotRequired[str] + """ + The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements) + number is a 14-digit code issued by the French INSEE. For example, `39922799000021`. + """ + + fr_naf: typing_extensions.NotRequired[str] + """ + The French government uses the NAF (Nomenclature des Activités Françaises) to display and + track economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code. + For example, `6910Z`. + """ + + es_nif: typing_extensions.NotRequired[str] + """ + The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain. + If it is present, it has been validated. For example, `73628495A`. + """ + + jp_qii: typing_extensions.NotRequired[str] + """ + The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan. + For example, `T1234567890123`. + """ diff --git a/src/square/requests/team_member.py b/src/square/requests/team_member.py new file mode 100644 index 00000000..98036314 --- /dev/null +++ b/src/square/requests/team_member.py @@ -0,0 +1,78 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.team_member_status import TeamMemberStatus +from .team_member_assigned_locations import TeamMemberAssignedLocationsParams +from .wage_setting import WageSettingParams + + +class TeamMemberParams(typing_extensions.TypedDict): + """ + A record representing an individual team member for a business. + """ + + id: typing_extensions.NotRequired[str] + """ + The unique ID for the team member. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + A second ID used to associate the team member with an entity in another system. + """ + + is_owner: typing_extensions.NotRequired[bool] + """ + Whether the team member is the owner of the Square account. + """ + + status: typing_extensions.NotRequired[TeamMemberStatus] + """ + Describes the status of the team member. + See [TeamMemberStatus](#type-teammemberstatus) for possible values + """ + + given_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The given name (that is, the first name) associated with the team member. + """ + + family_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The family name (that is, the last name) associated with the team member. + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address associated with the team member. After accepting the invitation + from Square, only the team member can change this value. + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The team member's phone number, in E.164 format. For example: + +14155552671 - the country code is 1 for US + +551155256325 - the country code is 55 for BR + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the team member was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the team member was last updated, in RFC 3339 format. + """ + + assigned_locations: typing_extensions.NotRequired[TeamMemberAssignedLocationsParams] + """ + Describes the team member's assigned locations. + """ + + wage_setting: typing_extensions.NotRequired[WageSettingParams] + """ + Information about the team member's overtime exemption status, job assignments, and compensation. + """ diff --git a/src/square/requests/team_member_assigned_locations.py b/src/square/requests/team_member_assigned_locations.py new file mode 100644 index 00000000..5e9748d8 --- /dev/null +++ b/src/square/requests/team_member_assigned_locations.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.team_member_assigned_locations_assignment_type import TeamMemberAssignedLocationsAssignmentType +import typing + + +class TeamMemberAssignedLocationsParams(typing_extensions.TypedDict): + """ + An object that represents a team member's assignment to locations. + """ + + assignment_type: typing_extensions.NotRequired[TeamMemberAssignedLocationsAssignmentType] + """ + The current assignment type of the team member. + See [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) for possible values + """ + + location_ids: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The explicit locations that the team member is assigned to. + """ diff --git a/src/square/requests/team_member_booking_profile.py b/src/square/requests/team_member_booking_profile.py new file mode 100644 index 00000000..93e11c7e --- /dev/null +++ b/src/square/requests/team_member_booking_profile.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class TeamMemberBookingProfileParams(typing_extensions.TypedDict): + """ + The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider. + """ + + team_member_id: typing_extensions.NotRequired[str] + """ + The ID of the [TeamMember](entity:TeamMember) object for the team member associated with the booking profile. + """ + + description: typing_extensions.NotRequired[str] + """ + The description of the team member. + """ + + display_name: typing_extensions.NotRequired[str] + """ + The display name of the team member. + """ + + is_bookable: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true`) or not (`false`). + """ + + profile_image_url: typing_extensions.NotRequired[str] + """ + The URL of the team member's image for the bookings profile. + """ diff --git a/src/square/requests/team_member_wage.py b/src/square/requests/team_member_wage.py new file mode 100644 index 00000000..a088bf14 --- /dev/null +++ b/src/square/requests/team_member_wage.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams + + +class TeamMemberWageParams(typing_extensions.TypedDict): + """ + The hourly wage rate that a team member earns on a `Shift` for doing the job + specified by the `title` property of this object. + """ + + id: typing_extensions.NotRequired[str] + """ + The UUID for this object. + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `TeamMember` that this wage is assigned to. + """ + + title: typing_extensions.NotRequired[typing.Optional[str]] + """ + The job title that this wage relates to. + """ + + hourly_rate: typing_extensions.NotRequired[MoneyParams] + """ + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + """ + + job_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An identifier for the job that this wage relates to. This cannot be + used to retrieve the job. + """ + + tip_eligible: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether team members are eligible for tips when working this job. + """ diff --git a/src/square/requests/tender.py b/src/square/requests/tender.py new file mode 100644 index 00000000..0fc703fd --- /dev/null +++ b/src/square/requests/tender.py @@ -0,0 +1,123 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .money import MoneyParams +from ..types.tender_type import TenderType +from .tender_card_details import TenderCardDetailsParams +from .tender_cash_details import TenderCashDetailsParams +from .tender_bank_account_details import TenderBankAccountDetailsParams +from .tender_buy_now_pay_later_details import TenderBuyNowPayLaterDetailsParams +from .tender_square_account_details import TenderSquareAccountDetailsParams +from .additional_recipient import AdditionalRecipientParams + + +class TenderParams(typing_extensions.TypedDict): + """ + Represents a tender (i.e., a method of payment) used in a Square transaction. + """ + + id: typing_extensions.NotRequired[str] + """ + The tender's unique ID. It is the associated payment ID. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the transaction's associated location. + """ + + transaction_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the tender's associated transaction. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp for when the tender was created, in RFC 3339 format. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional note associated with the tender at the time of payment. + """ + + amount_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, + the `total_money` of the corresponding [Payment](entity:Payment) will be equal to the + `amount_money` of the tender. + """ + + tip_money: typing_extensions.NotRequired[MoneyParams] + """ + The tip's amount of the tender. + """ + + processing_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of any Square processing fees applied to the tender. + + This field is not immediately populated when a new transaction is created. + It is usually available after about ten seconds. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + If the tender is associated with a customer or represents a customer's card on file, + this is the ID of the associated customer. + """ + + type: TenderType + """ + The type of tender, such as `CARD` or `CASH`. + See [TenderType](#type-tendertype) for possible values + """ + + card_details: typing_extensions.NotRequired[TenderCardDetailsParams] + """ + The details of the card tender. + + This value is present only if the value of `type` is `CARD`. + """ + + cash_details: typing_extensions.NotRequired[TenderCashDetailsParams] + """ + The details of the cash tender. + + This value is present only if the value of `type` is `CASH`. + """ + + bank_account_details: typing_extensions.NotRequired[TenderBankAccountDetailsParams] + """ + The details of the bank account tender. + + This value is present only if the value of `type` is `BANK_ACCOUNT`. + """ + + buy_now_pay_later_details: typing_extensions.NotRequired[TenderBuyNowPayLaterDetailsParams] + """ + The details of a Buy Now Pay Later tender. + + This value is present only if the value of `type` is `BUY_NOW_PAY_LATER`. + """ + + square_account_details: typing_extensions.NotRequired[TenderSquareAccountDetailsParams] + """ + The details of a Square Account tender. + + This value is present only if the value of `type` is `SQUARE_ACCOUNT`. + """ + + additional_recipients: typing_extensions.NotRequired[typing.Optional[typing.Sequence[AdditionalRecipientParams]]] + """ + Additional recipients (other than the merchant) receiving a portion of this tender. + For example, fees assessed on the purchase by a third party integration. + """ + + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the [Payment](entity:Payment) that corresponds to this tender. + This value is only present for payments created with the v2 Payments API. + """ diff --git a/src/square/requests/tender_bank_account_details.py b/src/square/requests/tender_bank_account_details.py new file mode 100644 index 00000000..bbef9618 --- /dev/null +++ b/src/square/requests/tender_bank_account_details.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.tender_bank_account_details_status import TenderBankAccountDetailsStatus + + +class TenderBankAccountDetailsParams(typing_extensions.TypedDict): + """ + Represents the details of a tender with `type` `BANK_ACCOUNT`. + + See [BankAccountPaymentDetails](entity:BankAccountPaymentDetails) + for more exposed details of a bank account payment. + """ + + status: typing_extensions.NotRequired[TenderBankAccountDetailsStatus] + """ + The bank account payment's current state. + + See [TenderBankAccountPaymentDetailsStatus](entity:TenderBankAccountDetailsStatus) for possible values. + See [TenderBankAccountDetailsStatus](#type-tenderbankaccountdetailsstatus) for possible values + """ diff --git a/src/square/requests/tender_buy_now_pay_later_details.py b/src/square/requests/tender_buy_now_pay_later_details.py new file mode 100644 index 00000000..51c90413 --- /dev/null +++ b/src/square/requests/tender_buy_now_pay_later_details.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.tender_buy_now_pay_later_details_brand import TenderBuyNowPayLaterDetailsBrand +from ..types.tender_buy_now_pay_later_details_status import TenderBuyNowPayLaterDetailsStatus + + +class TenderBuyNowPayLaterDetailsParams(typing_extensions.TypedDict): + """ + Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`. + """ + + buy_now_pay_later_brand: typing_extensions.NotRequired[TenderBuyNowPayLaterDetailsBrand] + """ + The Buy Now Pay Later brand. + See [Brand](#type-brand) for possible values + """ + + status: typing_extensions.NotRequired[TenderBuyNowPayLaterDetailsStatus] + """ + The buy now pay later payment's current state (such as `AUTHORIZED` or + `CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](entity:TenderBuyNowPayLaterDetailsStatus) + for possible values. + See [Status](#type-status) for possible values + """ diff --git a/src/square/requests/tender_card_details.py b/src/square/requests/tender_card_details.py new file mode 100644 index 00000000..fa3b0720 --- /dev/null +++ b/src/square/requests/tender_card_details.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.tender_card_details_status import TenderCardDetailsStatus +from .card import CardParams +from ..types.tender_card_details_entry_method import TenderCardDetailsEntryMethod + + +class TenderCardDetailsParams(typing_extensions.TypedDict): + """ + Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` + """ + + status: typing_extensions.NotRequired[TenderCardDetailsStatus] + """ + The credit card payment's current state (such as `AUTHORIZED` or + `CAPTURED`). See [TenderCardDetailsStatus](entity:TenderCardDetailsStatus) + for possible values. + See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values + """ + + card: typing_extensions.NotRequired[CardParams] + """ + The credit card's non-confidential details. + """ + + entry_method: typing_extensions.NotRequired[TenderCardDetailsEntryMethod] + """ + The method used to enter the card's details for the transaction. + See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values + """ diff --git a/src/square/requests/tender_cash_details.py b/src/square/requests/tender_cash_details.py new file mode 100644 index 00000000..e0a56d35 --- /dev/null +++ b/src/square/requests/tender_cash_details.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams + + +class TenderCashDetailsParams(typing_extensions.TypedDict): + """ + Represents the details of a tender with `type` `CASH`. + """ + + buyer_tendered_money: typing_extensions.NotRequired[MoneyParams] + """ + The total amount of cash provided by the buyer, before change is given. + """ + + change_back_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount of change returned to the buyer. + """ diff --git a/src/square/requests/tender_square_account_details.py b/src/square/requests/tender_square_account_details.py new file mode 100644 index 00000000..f40227b3 --- /dev/null +++ b/src/square/requests/tender_square_account_details.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.tender_square_account_details_status import TenderSquareAccountDetailsStatus + + +class TenderSquareAccountDetailsParams(typing_extensions.TypedDict): + """ + Represents the details of a tender with `type` `SQUARE_ACCOUNT`. + """ + + status: typing_extensions.NotRequired[TenderSquareAccountDetailsStatus] + """ + The Square Account payment's current state (such as `AUTHORIZED` or + `CAPTURED`). See [TenderSquareAccountDetailsStatus](entity:TenderSquareAccountDetailsStatus) + for possible values. + See [Status](#type-status) for possible values + """ diff --git a/src/square/requests/terminal_action.py b/src/square/requests/terminal_action.py new file mode 100644 index 00000000..54b54627 --- /dev/null +++ b/src/square/requests/terminal_action.py @@ -0,0 +1,142 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.action_cancel_reason import ActionCancelReason +from ..types.terminal_action_action_type import TerminalActionActionType +from .qr_code_options import QrCodeOptionsParams +from .save_card_options import SaveCardOptionsParams +from .signature_options import SignatureOptionsParams +from .confirmation_options import ConfirmationOptionsParams +from .receipt_options import ReceiptOptionsParams +from .data_collection_options import DataCollectionOptionsParams +from .select_options import SelectOptionsParams +from .device_metadata import DeviceMetadataParams + + +class TerminalActionParams(typing_extensions.TypedDict): + """ + Represents an action processed by the Square Terminal. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID for this `TerminalAction`. + """ + + device_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique Id of the device intended for this `TerminalAction`. + The Id can be retrieved from /v2/devices api. + """ + + deadline_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The duration as an RFC 3339 duration, after which the action will be automatically canceled. + TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason + of `TIMED_OUT` + + Default: 5 minutes from creation + + Maximum: 5 minutes + """ + + status: typing_extensions.NotRequired[str] + """ + The status of the `TerminalAction`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + cancel_reason: typing_extensions.NotRequired[ActionCancelReason] + """ + The reason why `TerminalAction` is canceled. Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the `TerminalAction` was created as an RFC 3339 timestamp. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The time when the `TerminalAction` was last updated as an RFC 3339 timestamp. + """ + + app_id: typing_extensions.NotRequired[str] + """ + The ID of the application that created the action. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The location id the action is attached to, if a link can be made. + """ + + type: typing_extensions.NotRequired[TerminalActionActionType] + """ + Represents the type of the action. + See [ActionType](#type-actiontype) for possible values + """ + + qr_code_options: typing_extensions.NotRequired[QrCodeOptionsParams] + """ + Describes configuration for the QR code action. Requires `QR_CODE` type. + """ + + save_card_options: typing_extensions.NotRequired[SaveCardOptionsParams] + """ + Describes configuration for the save-card action. Requires `SAVE_CARD` type. + """ + + signature_options: typing_extensions.NotRequired[SignatureOptionsParams] + """ + Describes configuration for the signature capture action. Requires `SIGNATURE` type. + """ + + confirmation_options: typing_extensions.NotRequired[ConfirmationOptionsParams] + """ + Describes configuration for the confirmation action. Requires `CONFIRMATION` type. + """ + + receipt_options: typing_extensions.NotRequired[ReceiptOptionsParams] + """ + Describes configuration for the receipt action. Requires `RECEIPT` type. + """ + + data_collection_options: typing_extensions.NotRequired[DataCollectionOptionsParams] + """ + Describes configuration for the data collection action. Requires `DATA_COLLECTION` type. + """ + + select_options: typing_extensions.NotRequired[SelectOptionsParams] + """ + Describes configuration for the select action. Requires `SELECT` type. + """ + + device_metadata: typing_extensions.NotRequired[DeviceMetadataParams] + """ + Details about the Terminal that received the action request (such as battery level, + operating system version, and network connection settings). + + Only available for `PING` action type. + """ + + await_next_action: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates the action will be linked to another action and requires a waiting dialog to be + displayed instead of returning to the idle screen on completion of the action. + + Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types. + """ + + await_next_action_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The timeout duration of the waiting dialog as an RFC 3339 duration, after which the + waiting dialog will no longer be displayed and the Terminal will return to the idle screen. + + Default: 5 minutes from when the waiting dialog is displayed + + Maximum: 5 minutes + """ diff --git a/src/square/requests/terminal_action_query.py b/src/square/requests/terminal_action_query.py new file mode 100644 index 00000000..7b8a2f5b --- /dev/null +++ b/src/square/requests/terminal_action_query.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .terminal_action_query_filter import TerminalActionQueryFilterParams +from .terminal_action_query_sort import TerminalActionQuerySortParams + + +class TerminalActionQueryParams(typing_extensions.TypedDict): + filter: typing_extensions.NotRequired[TerminalActionQueryFilterParams] + """ + Options for filtering returned `TerminalAction`s + """ + + sort: typing_extensions.NotRequired[TerminalActionQuerySortParams] + """ + Option for sorting returned `TerminalAction` objects. + """ diff --git a/src/square/requests/terminal_action_query_filter.py b/src/square/requests/terminal_action_query_filter.py new file mode 100644 index 00000000..36a76a4f --- /dev/null +++ b/src/square/requests/terminal_action_query_filter.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .time_range import TimeRangeParams +from ..types.terminal_action_action_type import TerminalActionActionType + + +class TerminalActionQueryFilterParams(typing_extensions.TypedDict): + device_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + `TerminalAction`s associated with a specific device. If no device is specified then all + `TerminalAction`s for the merchant will be displayed. + """ + + created_at: typing_extensions.NotRequired[TimeRangeParams] + """ + Time range for the beginning of the reporting period. Inclusive. + Default value: The current time minus one day. + Note that `TerminalAction`s are available for 30 days after creation. + """ + + status: typing_extensions.NotRequired[typing.Optional[str]] + """ + Filter results with the desired status of the `TerminalAction` + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + type: typing_extensions.NotRequired[TerminalActionActionType] + """ + Filter results with the requested ActionType. + See [TerminalActionActionType](#type-terminalactionactiontype) for possible values + """ diff --git a/src/square/requests/terminal_action_query_sort.py b/src/square/requests/terminal_action_query_sort.py new file mode 100644 index 00000000..bc732dc8 --- /dev/null +++ b/src/square/requests/terminal_action_query_sort.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.sort_order import SortOrder + + +class TerminalActionQuerySortParams(typing_extensions.TypedDict): + sort_order: typing_extensions.NotRequired[SortOrder] + """ + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/terminal_checkout.py b/src/square/requests/terminal_checkout.py new file mode 100644 index 00000000..8655cabf --- /dev/null +++ b/src/square/requests/terminal_checkout.py @@ -0,0 +1,148 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +import typing +from .payment_options import PaymentOptionsParams +from .device_checkout_options import DeviceCheckoutOptionsParams +from ..types.action_cancel_reason import ActionCancelReason +from ..types.checkout_options_payment_type import CheckoutOptionsPaymentType + + +class TerminalCheckoutParams(typing_extensions.TypedDict): + """ + Represents a checkout processed by the Square Terminal. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID for this `TerminalCheckout`. + """ + + amount_money: MoneyParams + """ + The amount of money (including the tax amount) that the Square Terminal device should try to collect. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional user-defined reference ID that can be used to associate + this `TerminalCheckout` to another entity in an external system. For example, an order + ID generated by a third-party shopping cart. The ID is also associated with any payments + used to complete the checkout. + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional note to associate with the checkout, as well as with any payments used to complete the checkout. + Note: maximum 500 characters + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The reference to the Square order ID for the checkout request. + """ + + payment_options: typing_extensions.NotRequired[PaymentOptionsParams] + """ + Payment-specific options for the checkout request. + """ + + device_options: DeviceCheckoutOptionsParams + """ + Options to control the display and behavior of the Square Terminal device. + """ + + deadline_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + An RFC 3339 duration, after which the checkout is automatically canceled. + A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason + of `TIMED_OUT`. + + Default: 5 minutes from creation + + Maximum: 5 minutes + """ + + status: typing_extensions.NotRequired[str] + """ + The status of the `TerminalCheckout`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + cancel_reason: typing_extensions.NotRequired[ActionCancelReason] + """ + The reason why `TerminalCheckout` is canceled. Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + """ + + payment_ids: typing_extensions.NotRequired[typing.Sequence[str]] + """ + A list of IDs for payments created by this `TerminalCheckout`. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp. + """ + + app_id: typing_extensions.NotRequired[str] + """ + The ID of the application that created the checkout. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The location of the device where the `TerminalCheckout` was directed. + """ + + payment_type: typing_extensions.NotRequired[CheckoutOptionsPaymentType] + """ + The type of payment the terminal should attempt to capture from. Defaults to `CARD_PRESENT`. + See [CheckoutOptionsPaymentType](#type-checkoutoptionspaymenttype) for possible values + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional ID of the team member associated with creating the checkout. + """ + + customer_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + An optional ID of the customer associated with the checkout. + """ + + app_fee_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount the developer is taking as a fee for facilitating the payment on behalf + of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. + + For more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + """ + + statement_description_identifier: typing_extensions.NotRequired[typing.Optional[str]] + """ + Optional additional payment information to include on the customer's card statement as + part of the statement description. This can be, for example, an invoice number, ticket number, + or short description that uniquely identifies the purchase. + """ + + tip_money: typing_extensions.NotRequired[MoneyParams] + """ + The amount designated as a tip, in addition to `amount_money`. This may only be set for a + checkout that has tipping disabled (`tip_settings.allow_tipping` is `false`). + """ diff --git a/src/square/requests/terminal_checkout_query.py b/src/square/requests/terminal_checkout_query.py new file mode 100644 index 00000000..eb53834a --- /dev/null +++ b/src/square/requests/terminal_checkout_query.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .terminal_checkout_query_filter import TerminalCheckoutQueryFilterParams +from .terminal_checkout_query_sort import TerminalCheckoutQuerySortParams + + +class TerminalCheckoutQueryParams(typing_extensions.TypedDict): + filter: typing_extensions.NotRequired[TerminalCheckoutQueryFilterParams] + """ + Options for filtering returned `TerminalCheckout` objects. + """ + + sort: typing_extensions.NotRequired[TerminalCheckoutQuerySortParams] + """ + Option for sorting returned `TerminalCheckout` objects. + """ diff --git a/src/square/requests/terminal_checkout_query_filter.py b/src/square/requests/terminal_checkout_query_filter.py new file mode 100644 index 00000000..d9f22a97 --- /dev/null +++ b/src/square/requests/terminal_checkout_query_filter.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .time_range import TimeRangeParams + + +class TerminalCheckoutQueryFilterParams(typing_extensions.TypedDict): + device_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all + `TerminalCheckout` objects for the merchant are displayed. + """ + + created_at: typing_extensions.NotRequired[TimeRangeParams] + """ + The time range for the beginning of the reporting period, which is inclusive. + Default value: The current time minus one day. + Note that `TerminalCheckout`s are available for 30 days after creation. + """ + + status: typing_extensions.NotRequired[typing.Optional[str]] + """ + Filtered results with the desired status of the `TerminalCheckout`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ diff --git a/src/square/requests/terminal_checkout_query_sort.py b/src/square/requests/terminal_checkout_query_sort.py new file mode 100644 index 00000000..48108b5d --- /dev/null +++ b/src/square/requests/terminal_checkout_query_sort.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.sort_order import SortOrder + + +class TerminalCheckoutQuerySortParams(typing_extensions.TypedDict): + sort_order: typing_extensions.NotRequired[SortOrder] + """ + The order in which results are listed. + Default: `DESC` + See [SortOrder](#type-sortorder) for possible values + """ diff --git a/src/square/requests/terminal_refund.py b/src/square/requests/terminal_refund.py new file mode 100644 index 00000000..277f13da --- /dev/null +++ b/src/square/requests/terminal_refund.py @@ -0,0 +1,94 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .money import MoneyParams +import typing +from ..types.action_cancel_reason import ActionCancelReason + + +class TerminalRefundParams(typing_extensions.TypedDict): + """ + Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique ID for this `TerminalRefund`. + """ + + refund_id: typing_extensions.NotRequired[str] + """ + The reference to the payment refund created by completing this `TerminalRefund`. + """ + + payment_id: str + """ + The unique ID of the payment being refunded. + """ + + order_id: typing_extensions.NotRequired[str] + """ + The reference to the Square order ID for the payment identified by the `payment_id`. + """ + + amount_money: MoneyParams + """ + The amount of money, inclusive of `tax_money`, that the `TerminalRefund` should return. + This value is limited to the amount taken in the original payment minus any completed or + pending refunds. + """ + + reason: str + """ + A description of the reason for the refund. + """ + + device_id: str + """ + The unique ID of the device intended for this `TerminalRefund`. + The Id can be retrieved from /v2/devices api. + """ + + deadline_duration: typing_extensions.NotRequired[typing.Optional[str]] + """ + The RFC 3339 duration, after which the refund is automatically canceled. + A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason + of `TIMED_OUT`. + + Default: 5 minutes from creation. + + Maximum: 5 minutes + """ + + status: typing_extensions.NotRequired[str] + """ + The status of the `TerminalRefund`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. + """ + + cancel_reason: typing_extensions.NotRequired[ActionCancelReason] + """ + Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the `TerminalRefund` was created, as an RFC 3339 timestamp. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp. + """ + + app_id: typing_extensions.NotRequired[str] + """ + The ID of the application that created the refund. + """ + + location_id: typing_extensions.NotRequired[str] + """ + The location of the device where the `TerminalRefund` was directed. + """ diff --git a/src/square/requests/terminal_refund_query.py b/src/square/requests/terminal_refund_query.py new file mode 100644 index 00000000..7365aad9 --- /dev/null +++ b/src/square/requests/terminal_refund_query.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .terminal_refund_query_filter import TerminalRefundQueryFilterParams +from .terminal_refund_query_sort import TerminalRefundQuerySortParams + + +class TerminalRefundQueryParams(typing_extensions.TypedDict): + filter: typing_extensions.NotRequired[TerminalRefundQueryFilterParams] + """ + The filter for the Terminal refund query. + """ + + sort: typing_extensions.NotRequired[TerminalRefundQuerySortParams] + """ + The sort order for the Terminal refund query. + """ diff --git a/src/square/requests/terminal_refund_query_filter.py b/src/square/requests/terminal_refund_query_filter.py new file mode 100644 index 00000000..59932733 --- /dev/null +++ b/src/square/requests/terminal_refund_query_filter.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .time_range import TimeRangeParams + + +class TerminalRefundQueryFilterParams(typing_extensions.TypedDict): + device_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + `TerminalRefund` objects associated with a specific device. If no device is specified, then all + `TerminalRefund` objects for the signed-in account are displayed. + """ + + created_at: typing_extensions.NotRequired[TimeRangeParams] + """ + The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. + Default value: The current time minus one day. + Note that `TerminalRefund`s are available for 30 days after creation. + """ + + status: typing_extensions.NotRequired[typing.Optional[str]] + """ + Filtered results with the desired status of the `TerminalRefund`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. + """ diff --git a/src/square/requests/terminal_refund_query_sort.py b/src/square/requests/terminal_refund_query_sort.py new file mode 100644 index 00000000..2dd8de16 --- /dev/null +++ b/src/square/requests/terminal_refund_query_sort.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class TerminalRefundQuerySortParams(typing_extensions.TypedDict): + sort_order: typing_extensions.NotRequired[typing.Optional[str]] + """ + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + """ diff --git a/src/square/requests/test_webhook_subscription_response.py b/src/square/requests/test_webhook_subscription_response.py new file mode 100644 index 00000000..77e779de --- /dev/null +++ b/src/square/requests/test_webhook_subscription_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription_test_result import SubscriptionTestResultParams + + +class TestWebhookSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) endpoint. + + Note: If there are errors processing the request, the [SubscriptionTestResult](entity:SubscriptionTestResult) field is not + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + subscription_test_result: typing_extensions.NotRequired[SubscriptionTestResultParams] + """ + The [SubscriptionTestResult](entity:SubscriptionTestResult). + """ diff --git a/src/square/requests/time_range.py b/src/square/requests/time_range.py new file mode 100644 index 00000000..b2e14704 --- /dev/null +++ b/src/square/requests/time_range.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class TimeRangeParams(typing_extensions.TypedDict): + """ + Represents a generic time range. The start and end values are + represented in RFC 3339 format. Time ranges are customized to be + inclusive or exclusive based on the needs of a particular endpoint. + Refer to the relevant endpoint-specific documentation to determine + how time ranges are handled. + """ + + start_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A datetime value in RFC 3339 format indicating when the time range + starts. + """ + + end_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + A datetime value in RFC 3339 format indicating when the time range + ends. + """ diff --git a/src/square/requests/tip_settings.py b/src/square/requests/tip_settings.py new file mode 100644 index 00000000..75b4cc86 --- /dev/null +++ b/src/square/requests/tip_settings.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class TipSettingsParams(typing_extensions.TypedDict): + allow_tipping: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether tipping is enabled for this checkout. Defaults to false. + """ + + separate_tip_screen: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether tip options should be presented on the screen before presenting + the signature screen during card payment. Defaults to false. + """ + + custom_tip_field: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false. + """ + + tip_percentages: typing_extensions.NotRequired[typing.Optional[typing.Sequence[int]]] + """ + A list of tip percentages that should be presented during the checkout flow, specified as + up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25. + """ + + smart_tipping: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Enables the "Smart Tip Amounts" behavior. + Exact tipping options depend on the region in which the Square seller is active. + + For payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00. + + For payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%. + + If set to true, the `tip_percentages` settings is ignored. + Defaults to false. + + To learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app). + """ diff --git a/src/square/requests/transaction.py b/src/square/requests/transaction.py new file mode 100644 index 00000000..e90896f1 --- /dev/null +++ b/src/square/requests/transaction.py @@ -0,0 +1,81 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .tender import TenderParams +from .refund import RefundParams +from ..types.transaction_product import TransactionProduct +from .address import AddressParams + + +class TransactionParams(typing_extensions.TypedDict): + """ + Represents a transaction processed with Square, either with the + Connect API or with Square Point of Sale. + + The `tenders` field of this object lists all methods of payment used to pay in + the transaction. + """ + + id: typing_extensions.NotRequired[str] + """ + The transaction's unique ID, issued by Square payments servers. + """ + + location_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the transaction's associated location. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp for when the transaction was created, in RFC 3339 format. + """ + + tenders: typing_extensions.NotRequired[typing.Optional[typing.Sequence[TenderParams]]] + """ + The tenders used to pay in the transaction. + """ + + refunds: typing_extensions.NotRequired[typing.Optional[typing.Sequence[RefundParams]]] + """ + Refunds that have been applied to any tender in the transaction. + """ + + reference_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + If the transaction was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint, this value is the same as the value provided for the `reference_id` + parameter in the request to that endpoint. Otherwise, it is not set. + """ + + product: typing_extensions.NotRequired[TransactionProduct] + """ + The Square product that processed the transaction. + See [TransactionProduct](#type-transactionproduct) for possible values + """ + + client_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + If the transaction was created in the Square Point of Sale app, this value + is the ID generated for the transaction by Square Point of Sale. + + This ID has no relationship to the transaction's canonical `id`, which is + generated by Square's backend servers. This value is generated for bookkeeping + purposes, in case the transaction cannot immediately be completed (for example, + if the transaction is processed in offline mode). + + It is not currently possible with the Connect API to perform a transaction + lookup by this value. + """ + + shipping_address: typing_extensions.NotRequired[AddressParams] + """ + The shipping address provided in the request, if any. + """ + + order_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The order_id is an identifier for the order associated with this transaction, if any. + """ diff --git a/src/square/requests/unlink_customer_from_gift_card_response.py b/src/square/requests/unlink_customer_from_gift_card_response.py new file mode 100644 index 00000000..6c8bdd96 --- /dev/null +++ b/src/square/requests/unlink_customer_from_gift_card_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .gift_card import GiftCardParams + + +class UnlinkCustomerFromGiftCardResponseParams(typing_extensions.TypedDict): + """ + A response that contains the unlinked `GiftCard` object. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + gift_card: typing_extensions.NotRequired[GiftCardParams] + """ + The gift card with the ID of the unlinked customer removed from the `customer_ids` field. + If no other customers are linked, the `customer_ids` field is also removed. + """ diff --git a/src/square/requests/update_booking_custom_attribute_definition_response.py b/src/square/requests/update_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..384e4289 --- /dev/null +++ b/src/square/requests/update_booking_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class UpdateBookingCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The updated custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_booking_response.py b/src/square/requests/update_booking_response.py new file mode 100644 index 00000000..0e6f9a3a --- /dev/null +++ b/src/square/requests/update_booking_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .booking import BookingParams +import typing +from .error import ErrorParams + + +class UpdateBookingResponseParams(typing_extensions.TypedDict): + booking: typing_extensions.NotRequired[BookingParams] + """ + The booking that was updated. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors that occurred during the request. + """ diff --git a/src/square/requests/update_break_type_response.py b/src/square/requests/update_break_type_response.py new file mode 100644 index 00000000..88080a68 --- /dev/null +++ b/src/square/requests/update_break_type_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .break_type import BreakTypeParams +import typing +from .error import ErrorParams + + +class UpdateBreakTypeResponseParams(typing_extensions.TypedDict): + """ + A response to a request to update a `BreakType`. The response contains + the requested `BreakType` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_type: typing_extensions.NotRequired[BreakTypeParams] + """ + The response object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_catalog_image_request.py b/src/square/requests/update_catalog_image_request.py new file mode 100644 index 00000000..22452dc4 --- /dev/null +++ b/src/square/requests/update_catalog_image_request.py @@ -0,0 +1,13 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions + + +class UpdateCatalogImageRequestParams(typing_extensions.TypedDict): + idempotency_key: str + """ + A unique string that identifies this UpdateCatalogImage request. + Keys can be any valid string but must be unique for every UpdateCatalogImage request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + """ diff --git a/src/square/requests/update_catalog_image_response.py b/src/square/requests/update_catalog_image_response.py new file mode 100644 index 00000000..744425c8 --- /dev/null +++ b/src/square/requests/update_catalog_image_response.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams + + +class UpdateCatalogImageResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + image: typing_extensions.NotRequired[CatalogObjectParams] + """ + The newly updated `CatalogImage` including a Square-generated + URL for the encapsulated image file. + """ diff --git a/src/square/requests/update_customer_custom_attribute_definition_response.py b/src/square/requests/update_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..fbdac86d --- /dev/null +++ b/src/square/requests/update_customer_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class UpdateCustomerCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The updated custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_customer_group_response.py b/src/square/requests/update_customer_group_response.py new file mode 100644 index 00000000..fb13daa2 --- /dev/null +++ b/src/square/requests/update_customer_group_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer_group import CustomerGroupParams + + +class UpdateCustomerGroupResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [UpdateCustomerGroup](api-endpoint:CustomerGroups-UpdateCustomerGroup) endpoint. + + Either `errors` or `group` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + group: typing_extensions.NotRequired[CustomerGroupParams] + """ + The successfully updated customer group. + """ diff --git a/src/square/requests/update_customer_response.py b/src/square/requests/update_customer_response.py new file mode 100644 index 00000000..6ab19543 --- /dev/null +++ b/src/square/requests/update_customer_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .customer import CustomerParams + + +class UpdateCustomerResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [UpdateCustomer](api-endpoint:Customers-UpdateCustomer) or + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint. + + Either `errors` or `customer` is present in a given response (never both). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + customer: typing_extensions.NotRequired[CustomerParams] + """ + The updated customer. + """ diff --git a/src/square/requests/update_invoice_response.py b/src/square/requests/update_invoice_response.py new file mode 100644 index 00000000..c5e0f5a6 --- /dev/null +++ b/src/square/requests/update_invoice_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .invoice import InvoiceParams +import typing +from .error import ErrorParams + + +class UpdateInvoiceResponseParams(typing_extensions.TypedDict): + """ + Describes a `UpdateInvoice` response. + """ + + invoice: typing_extensions.NotRequired[InvoiceParams] + """ + The updated invoice. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ diff --git a/src/square/requests/update_item_modifier_lists_response.py b/src/square/requests/update_item_modifier_lists_response.py new file mode 100644 index 00000000..effa0f67 --- /dev/null +++ b/src/square/requests/update_item_modifier_lists_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class UpdateItemModifierListsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + """ diff --git a/src/square/requests/update_item_taxes_response.py b/src/square/requests/update_item_taxes_response.py new file mode 100644 index 00000000..57fdb7e4 --- /dev/null +++ b/src/square/requests/update_item_taxes_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class UpdateItemTaxesResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + """ diff --git a/src/square/requests/update_job_response.py b/src/square/requests/update_job_response.py new file mode 100644 index 00000000..26aac973 --- /dev/null +++ b/src/square/requests/update_job_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .job import JobParams +import typing +from .error import ErrorParams + + +class UpdateJobResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpdateJob](api-endpoint:Team-UpdateJob) response. Either `job` or `errors` + is present in the response. + """ + + job: typing_extensions.NotRequired[JobParams] + """ + The updated job. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/update_location_custom_attribute_definition_response.py b/src/square/requests/update_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..fc30eaa1 --- /dev/null +++ b/src/square/requests/update_location_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class UpdateLocationCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The updated custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_location_response.py b/src/square/requests/update_location_response.py new file mode 100644 index 00000000..012f6e40 --- /dev/null +++ b/src/square/requests/update_location_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .location import LocationParams + + +class UpdateLocationResponseParams(typing_extensions.TypedDict): + """ + The response object returned by the [UpdateLocation](api-endpoint:Locations-UpdateLocation) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information about errors encountered during the request. + """ + + location: typing_extensions.NotRequired[LocationParams] + """ + The updated `Location` object. + """ diff --git a/src/square/requests/update_location_settings_response.py b/src/square/requests/update_location_settings_response.py new file mode 100644 index 00000000..e6f8162a --- /dev/null +++ b/src/square/requests/update_location_settings_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .checkout_location_settings import CheckoutLocationSettingsParams + + +class UpdateLocationSettingsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred when updating the location settings. + """ + + location_settings: typing_extensions.NotRequired[CheckoutLocationSettingsParams] + """ + The updated location settings. + """ diff --git a/src/square/requests/update_merchant_custom_attribute_definition_response.py b/src/square/requests/update_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..45836a30 --- /dev/null +++ b/src/square/requests/update_merchant_custom_attribute_definition_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class UpdateMerchantCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The updated custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_merchant_settings_response.py b/src/square/requests/update_merchant_settings_response.py new file mode 100644 index 00000000..d0470471 --- /dev/null +++ b/src/square/requests/update_merchant_settings_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .checkout_merchant_settings import CheckoutMerchantSettingsParams + + +class UpdateMerchantSettingsResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred when updating the merchant settings. + """ + + merchant_settings: typing_extensions.NotRequired[CheckoutMerchantSettingsParams] + """ + The updated merchant settings. + """ diff --git a/src/square/requests/update_order_custom_attribute_definition_response.py b/src/square/requests/update_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..7355c1d0 --- /dev/null +++ b/src/square/requests/update_order_custom_attribute_definition_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute_definition import CustomAttributeDefinitionParams +import typing +from .error import ErrorParams + + +class UpdateOrderCustomAttributeDefinitionResponseParams(typing_extensions.TypedDict): + """ + Represents a response from updating an order custom attribute definition. + """ + + custom_attribute_definition: typing_extensions.NotRequired[CustomAttributeDefinitionParams] + """ + The updated order custom attribute definition. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_order_response.py b/src/square/requests/update_order_response.py new file mode 100644 index 00000000..6a1bb6dc --- /dev/null +++ b/src/square/requests/update_order_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .order import OrderParams +import typing +from .error import ErrorParams + + +class UpdateOrderResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + """ + + order: typing_extensions.NotRequired[OrderParams] + """ + The updated order. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_payment_link_response.py b/src/square/requests/update_payment_link_response.py new file mode 100644 index 00000000..da847e4e --- /dev/null +++ b/src/square/requests/update_payment_link_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment_link import PaymentLinkParams + + +class UpdatePaymentLinkResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred when updating the payment link. + """ + + payment_link: typing_extensions.NotRequired[PaymentLinkParams] + """ + The updated payment link. + """ diff --git a/src/square/requests/update_payment_response.py b/src/square/requests/update_payment_response.py new file mode 100644 index 00000000..ab511b34 --- /dev/null +++ b/src/square/requests/update_payment_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .payment import PaymentParams + + +class UpdatePaymentResponseParams(typing_extensions.TypedDict): + """ + Defines the response returned by + [UpdatePayment](api-endpoint:Payments-UpdatePayment). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + payment: typing_extensions.NotRequired[PaymentParams] + """ + The updated payment. + """ diff --git a/src/square/requests/update_shift_response.py b/src/square/requests/update_shift_response.py new file mode 100644 index 00000000..1749ba06 --- /dev/null +++ b/src/square/requests/update_shift_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .shift import ShiftParams +import typing +from .error import ErrorParams + + +class UpdateShiftResponseParams(typing_extensions.TypedDict): + """ + The response to a request to update a `Shift`. The response contains + the updated `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shift: typing_extensions.NotRequired[ShiftParams] + """ + The updated `Shift`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/update_subscription_response.py b/src/square/requests/update_subscription_response.py new file mode 100644 index 00000000..3dd0e07f --- /dev/null +++ b/src/square/requests/update_subscription_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .subscription import SubscriptionParams + + +class UpdateSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines output parameters in a response from the + [UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[SubscriptionParams] + """ + The updated subscription. + """ diff --git a/src/square/requests/update_team_member_request.py b/src/square/requests/update_team_member_request.py new file mode 100644 index 00000000..d03dfcff --- /dev/null +++ b/src/square/requests/update_team_member_request.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member import TeamMemberParams + + +class UpdateTeamMemberRequestParams(typing_extensions.TypedDict): + """ + Represents an update request for a `TeamMember` object. + """ + + team_member: typing_extensions.NotRequired[TeamMemberParams] + """ + The team member fields to add, change, or clear. Fields can be cleared using a null value. To update + `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + """ diff --git a/src/square/requests/update_team_member_response.py b/src/square/requests/update_team_member_response.py new file mode 100644 index 00000000..39f6ee3b --- /dev/null +++ b/src/square/requests/update_team_member_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .team_member import TeamMemberParams +import typing +from .error import ErrorParams + + +class UpdateTeamMemberResponseParams(typing_extensions.TypedDict): + """ + Represents a response from an update request containing the updated `TeamMember` object or error messages. + """ + + team_member: typing_extensions.NotRequired[TeamMemberParams] + """ + The successfully updated `TeamMember` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/update_vendor_request.py b/src/square/requests/update_vendor_request.py new file mode 100644 index 00000000..743d10d1 --- /dev/null +++ b/src/square/requests/update_vendor_request.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .vendor import VendorParams + + +class UpdateVendorRequestParams(typing_extensions.TypedDict): + """ + Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor). + """ + + idempotency_key: typing_extensions.NotRequired[typing.Optional[str]] + """ + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + """ + + vendor: VendorParams + """ + The specified [Vendor](entity:Vendor) to be updated. + """ diff --git a/src/square/requests/update_vendor_response.py b/src/square/requests/update_vendor_response.py new file mode 100644 index 00000000..7f650293 --- /dev/null +++ b/src/square/requests/update_vendor_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .vendor import VendorParams + + +class UpdateVendorResponseParams(typing_extensions.TypedDict): + """ + Represents an output from a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor). + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Errors occurred when the request fails. + """ + + vendor: typing_extensions.NotRequired[VendorParams] + """ + The [Vendor](entity:Vendor) that has been updated. + """ diff --git a/src/square/requests/update_wage_setting_response.py b/src/square/requests/update_wage_setting_response.py new file mode 100644 index 00000000..78cc16a1 --- /dev/null +++ b/src/square/requests/update_wage_setting_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .wage_setting import WageSettingParams +import typing +from .error import ErrorParams + + +class UpdateWageSettingResponseParams(typing_extensions.TypedDict): + """ + Represents a response from an update request containing the updated `WageSetting` object + or error messages. + """ + + wage_setting: typing_extensions.NotRequired[WageSettingParams] + """ + The successfully updated `WageSetting` object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + The errors that occurred during the request. + """ diff --git a/src/square/requests/update_webhook_subscription_response.py b/src/square/requests/update_webhook_subscription_response.py new file mode 100644 index 00000000..35207ef1 --- /dev/null +++ b/src/square/requests/update_webhook_subscription_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .webhook_subscription import WebhookSubscriptionParams + + +class UpdateWebhookSubscriptionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription) endpoint. + + Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + subscription: typing_extensions.NotRequired[WebhookSubscriptionParams] + """ + The updated [Subscription](entity:WebhookSubscription). + """ diff --git a/src/square/requests/update_webhook_subscription_signature_key_response.py b/src/square/requests/update_webhook_subscription_signature_key_response.py new file mode 100644 index 00000000..7c32029e --- /dev/null +++ b/src/square/requests/update_webhook_subscription_signature_key_response.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class UpdateWebhookSubscriptionSignatureKeyResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) endpoint. + + Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not + present. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Information on errors encountered during the request. + """ + + signature_key: typing_extensions.NotRequired[str] + """ + The new Square-generated signature key used to validate the origin of the webhook event. + """ diff --git a/src/square/requests/update_workweek_config_response.py b/src/square/requests/update_workweek_config_response.py new file mode 100644 index 00000000..81f65126 --- /dev/null +++ b/src/square/requests/update_workweek_config_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .workweek_config import WorkweekConfigParams +import typing +from .error import ErrorParams + + +class UpdateWorkweekConfigResponseParams(typing_extensions.TypedDict): + """ + The response to a request to update a `WorkweekConfig` object. The response contains + the updated `WorkweekConfig` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + workweek_config: typing_extensions.NotRequired[WorkweekConfigParams] + """ + The response object. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/upsert_booking_custom_attribute_response.py b/src/square/requests/upsert_booking_custom_attribute_response.py new file mode 100644 index 00000000..b6f5f746 --- /dev/null +++ b/src/square/requests/upsert_booking_custom_attribute_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class UpsertBookingCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/upsert_catalog_object_response.py b/src/square/requests/upsert_catalog_object_response.py new file mode 100644 index 00000000..eb5e362f --- /dev/null +++ b/src/square/requests/upsert_catalog_object_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .catalog_object import CatalogObjectParams +from .catalog_id_mapping import CatalogIdMappingParams + + +class UpsertCatalogObjectResponseParams(typing_extensions.TypedDict): + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + catalog_object: typing_extensions.NotRequired[CatalogObjectParams] + """ + The successfully created or updated CatalogObject. + """ + + id_mappings: typing_extensions.NotRequired[typing.Sequence[CatalogIdMappingParams]] + """ + The mapping between client and server IDs for this upsert. + """ diff --git a/src/square/requests/upsert_customer_custom_attribute_response.py b/src/square/requests/upsert_customer_custom_attribute_response.py new file mode 100644 index 00000000..23b67899 --- /dev/null +++ b/src/square/requests/upsert_customer_custom_attribute_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class UpsertCustomerCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/upsert_location_custom_attribute_response.py b/src/square/requests/upsert_location_custom_attribute_response.py new file mode 100644 index 00000000..7db6da5b --- /dev/null +++ b/src/square/requests/upsert_location_custom_attribute_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class UpsertLocationCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/upsert_merchant_custom_attribute_response.py b/src/square/requests/upsert_merchant_custom_attribute_response.py new file mode 100644 index 00000000..27d98a1e --- /dev/null +++ b/src/square/requests/upsert_merchant_custom_attribute_response.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class UpsertMerchantCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The new or updated custom attribute. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/upsert_order_custom_attribute_response.py b/src/square/requests/upsert_order_custom_attribute_response.py new file mode 100644 index 00000000..0719be3c --- /dev/null +++ b/src/square/requests/upsert_order_custom_attribute_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from .custom_attribute import CustomAttributeParams +import typing +from .error import ErrorParams + + +class UpsertOrderCustomAttributeResponseParams(typing_extensions.TypedDict): + """ + Represents a response from upserting order custom attribute definitions. + """ + + custom_attribute: typing_extensions.NotRequired[CustomAttributeParams] + """ + The order custom attribute that was created or modified. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/upsert_snippet_response.py b/src/square/requests/upsert_snippet_response.py new file mode 100644 index 00000000..3adff5bf --- /dev/null +++ b/src/square/requests/upsert_snippet_response.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from .snippet import SnippetParams + + +class UpsertSnippetResponseParams(typing_extensions.TypedDict): + """ + Represents an `UpsertSnippet` response. The response can include either `snippet` or `errors`. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ + + snippet: typing_extensions.NotRequired[SnippetParams] + """ + The new or updated snippet. + """ diff --git a/src/square/requests/v1money.py b/src/square/requests/v1money.py new file mode 100644 index 00000000..edf44a20 --- /dev/null +++ b/src/square/requests/v1money.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from ..types.currency import Currency + + +class V1MoneyParams(typing_extensions.TypedDict): + amount: typing_extensions.NotRequired[typing.Optional[int]] + """ + Amount in the lowest denominated value of this Currency. E.g. in USD + these are cents, in JPY they are Yen (which do not have a 'cent' concept). + """ + + currency_code: typing_extensions.NotRequired[Currency] + """ + + See [Currency](#type-currency) for possible values + """ diff --git a/src/square/requests/v1order.py b/src/square/requests/v1order.py new file mode 100644 index 00000000..d9a68c9c --- /dev/null +++ b/src/square/requests/v1order.py @@ -0,0 +1,143 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams +from ..types.v1order_state import V1OrderState +from .address import AddressParams +from .v1money import V1MoneyParams +from .v1tender import V1TenderParams +from .v1order_history_entry import V1OrderHistoryEntryParams + + +class V1OrderParams(typing_extensions.TypedDict): + """ + V1Order + """ + + errors: typing_extensions.NotRequired[typing.Optional[typing.Sequence[ErrorParams]]] + """ + Any errors that occurred during the request. + """ + + id: typing_extensions.NotRequired[str] + """ + The order's unique identifier. + """ + + buyer_email: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address of the order's buyer. + """ + + recipient_name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the order's buyer. + """ + + recipient_phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number to use for the order's delivery. + """ + + state: typing_extensions.NotRequired[V1OrderState] + """ + Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. + See [V1OrderState](#type-v1orderstate) for possible values + """ + + shipping_address: typing_extensions.NotRequired[AddressParams] + """ + The address to ship the order to. + """ + + subtotal_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The amount of all items purchased in the order, before taxes and shipping. + """ + + total_shipping_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The shipping cost for the order. + """ + + total_tax_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The total of all taxes applied to the order. + """ + + total_price_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The total cost of the order. + """ + + total_discount_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The total of all discounts applied to the order. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the order was created, in ISO 8601 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The time when the order was last modified, in ISO 8601 format. + """ + + expires_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the order expires if no action is taken, in ISO 8601 format. + """ + + payment_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The unique identifier of the payment associated with the order. + """ + + buyer_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note provided by the buyer when the order was created, if any. + """ + + completed_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note provided by the merchant when the order's state was set to COMPLETED, if any + """ + + refunded_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note provided by the merchant when the order's state was set to REFUNDED, if any. + """ + + canceled_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note provided by the merchant when the order's state was set to CANCELED, if any. + """ + + tender: typing_extensions.NotRequired[V1TenderParams] + """ + The tender used to pay for the order. + """ + + order_history: typing_extensions.NotRequired[typing.Optional[typing.Sequence[V1OrderHistoryEntryParams]]] + """ + The history of actions associated with the order. + """ + + promo_code: typing_extensions.NotRequired[typing.Optional[str]] + """ + The promo code provided by the buyer, if any. + """ + + btc_receive_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + For Bitcoin transactions, the address that the buyer sent Bitcoin to. + """ + + btc_price_satoshi: typing_extensions.NotRequired[typing.Optional[float]] + """ + For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC). + """ diff --git a/src/square/requests/v1order_history_entry.py b/src/square/requests/v1order_history_entry.py new file mode 100644 index 00000000..6ee178be --- /dev/null +++ b/src/square/requests/v1order_history_entry.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.v1order_history_entry_action import V1OrderHistoryEntryAction + + +class V1OrderHistoryEntryParams(typing_extensions.TypedDict): + """ + V1OrderHistoryEntry + """ + + action: typing_extensions.NotRequired[V1OrderHistoryEntryAction] + """ + The type of action performed on the order. + See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values + """ + + created_at: typing_extensions.NotRequired[str] + """ + The time when the action was performed, in ISO 8601 format. + """ diff --git a/src/square/requests/v1tender.py b/src/square/requests/v1tender.py new file mode 100644 index 00000000..63c1b9f9 --- /dev/null +++ b/src/square/requests/v1tender.py @@ -0,0 +1,119 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.v1tender_type import V1TenderType +import typing +from ..types.v1tender_card_brand import V1TenderCardBrand +from ..types.v1tender_entry_method import V1TenderEntryMethod +from .v1money import V1MoneyParams + + +class V1TenderParams(typing_extensions.TypedDict): + """ + A tender represents a discrete monetary exchange. Square represents this + exchange as a money object with a specific currency and amount, where the + amount is given in the smallest denomination of the given currency. + + Square POS can accept more than one form of tender for a single payment (such + as by splitting a bill between a credit card and a gift card). The `tender` + field of the Payment object lists all forms of tender used for the payment. + + Split tender payments behave slightly differently from single tender payments: + + The receipt_url for a split tender corresponds only to the first tender listed + in the tender field. To get the receipt URLs for the remaining tenders, use + the receipt_url fields of the corresponding Tender objects. + + *A note on gift cards**: when a customer purchases a Square gift card from a + merchant, the merchant receives the full amount of the gift card in the + associated payment. + + When that gift card is used as a tender, the balance of the gift card is + reduced and the merchant receives no funds. A `Tender` object with a type of + `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the + associated payment. + """ + + id: typing_extensions.NotRequired[str] + """ + The tender's unique ID. + """ + + type: typing_extensions.NotRequired[V1TenderType] + """ + The type of tender. + See [V1TenderType](#type-v1tendertype) for possible values + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + A human-readable description of the tender. + """ + + employee_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the employee that processed the tender. + """ + + receipt_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The URL of the receipt for the tender. + """ + + card_brand: typing_extensions.NotRequired[V1TenderCardBrand] + """ + The brand of credit card provided. + See [V1TenderCardBrand](#type-v1tendercardbrand) for possible values + """ + + pan_suffix: typing_extensions.NotRequired[typing.Optional[str]] + """ + The last four digits of the provided credit card's account number. + """ + + entry_method: typing_extensions.NotRequired[V1TenderEntryMethod] + """ + The tender's unique ID. + See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values + """ + + payment_note: typing_extensions.NotRequired[typing.Optional[str]] + """ + Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. + """ + + total_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The total amount of money provided in this form of tender. + """ + + tendered_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The amount of total_money applied to the payment. + """ + + tendered_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the tender was created, in ISO 8601 format. + """ + + settled_at: typing_extensions.NotRequired[typing.Optional[str]] + """ + The time when the tender was settled, in ISO 8601 format. + """ + + change_back_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The amount of total_money returned to the buyer as change. + """ + + refunded_money: typing_extensions.NotRequired[V1MoneyParams] + """ + The total of all refunds applied to this tender. This amount is always negative or zero. + """ + + is_exchange: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange. + """ diff --git a/src/square/requests/vendor.py b/src/square/requests/vendor.py new file mode 100644 index 00000000..7e2db184 --- /dev/null +++ b/src/square/requests/vendor.py @@ -0,0 +1,69 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .address import AddressParams +from .vendor_contact import VendorContactParams +from ..types.vendor_status import VendorStatus + + +class VendorParams(typing_extensions.TypedDict): + """ + Represents a supplier to a seller. + """ + + id: typing_extensions.NotRequired[str] + """ + A unique Square-generated ID for the [Vendor](entity:Vendor). + This field is required when attempting to update a [Vendor](entity:Vendor). + """ + + created_at: typing_extensions.NotRequired[str] + """ + An RFC 3339-formatted timestamp that indicates when the + [Vendor](entity:Vendor) was created. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + An RFC 3339-formatted timestamp that indicates when the + [Vendor](entity:Vendor) was last updated. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the [Vendor](entity:Vendor). + This field is required when attempting to create or update a [Vendor](entity:Vendor). + """ + + address: typing_extensions.NotRequired[AddressParams] + """ + The address of the [Vendor](entity:Vendor). + """ + + contacts: typing_extensions.NotRequired[typing.Optional[typing.Sequence[VendorContactParams]]] + """ + The contacts of the [Vendor](entity:Vendor). + """ + + account_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The account number of the [Vendor](entity:Vendor). + """ + + note: typing_extensions.NotRequired[typing.Optional[str]] + """ + A note detailing information about the [Vendor](entity:Vendor). + """ + + version: typing_extensions.NotRequired[int] + """ + The version of the [Vendor](entity:Vendor). + """ + + status: typing_extensions.NotRequired[VendorStatus] + """ + The status of the [Vendor](entity:Vendor). + See [Status](#type-status) for possible values + """ diff --git a/src/square/requests/vendor_contact.py b/src/square/requests/vendor_contact.py new file mode 100644 index 00000000..bb0b7cc0 --- /dev/null +++ b/src/square/requests/vendor_contact.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class VendorContactParams(typing_extensions.TypedDict): + """ + Represents a contact of a [Vendor](entity:Vendor). + """ + + id: typing_extensions.NotRequired[str] + """ + A unique Square-generated ID for the [VendorContact](entity:VendorContact). + This field is required when attempting to update a [VendorContact](entity:VendorContact). + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of the [VendorContact](entity:VendorContact). + This field is required when attempting to create a [Vendor](entity:Vendor). + """ + + email_address: typing_extensions.NotRequired[typing.Optional[str]] + """ + The email address of the [VendorContact](entity:VendorContact). + """ + + phone_number: typing_extensions.NotRequired[typing.Optional[str]] + """ + The phone number of the [VendorContact](entity:VendorContact). + """ + + removed: typing_extensions.NotRequired[typing.Optional[bool]] + """ + The state of the [VendorContact](entity:VendorContact). + """ + + ordinal: int + """ + The ordinal of the [VendorContact](entity:VendorContact). + """ diff --git a/src/square/requests/void_transaction_response.py b/src/square/requests/void_transaction_response.py new file mode 100644 index 00000000..cf83738f --- /dev/null +++ b/src/square/requests/void_transaction_response.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .error import ErrorParams + + +class VoidTransactionResponseParams(typing_extensions.TypedDict): + """ + Defines the fields that are included in the response body of + a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint. + """ + + errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]] + """ + Any errors that occurred during the request. + """ diff --git a/src/square/requests/wage_setting.py b/src/square/requests/wage_setting.py new file mode 100644 index 00000000..823db935 --- /dev/null +++ b/src/square/requests/wage_setting.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing +from .job_assignment import JobAssignmentParams + + +class WageSettingParams(typing_extensions.TypedDict): + """ + Represents information about the overtime exemption status, job assignments, and compensation + for a [team member](entity:TeamMember). + """ + + team_member_id: typing_extensions.NotRequired[typing.Optional[str]] + """ + The ID of the team member associated with the wage setting. + """ + + job_assignments: typing_extensions.NotRequired[typing.Optional[typing.Sequence[JobAssignmentParams]]] + """ + **Required** The ordered list of jobs that the team member is assigned to. + The first job assignment is considered the team member's primary job. + """ + + is_overtime_exempt: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Whether the team member is exempt from the overtime rules of the seller's country. + """ + + version: typing_extensions.NotRequired[int] + """ + **Read only** Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If not provided, + Square executes a blind write, potentially overwriting data from another write. For more information, + see [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency). + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp when the wage setting was created, in RFC 3339 format. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp when the wage setting was last updated, in RFC 3339 format. + """ diff --git a/src/square/requests/webhook_subscription.py b/src/square/requests/webhook_subscription.py new file mode 100644 index 00000000..e479801e --- /dev/null +++ b/src/square/requests/webhook_subscription.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +import typing + + +class WebhookSubscriptionParams(typing_extensions.TypedDict): + """ + Represents the details of a webhook subscription, including notification URL, + event types, and signature key. + """ + + id: typing_extensions.NotRequired[str] + """ + A Square-generated unique ID for the subscription. + """ + + name: typing_extensions.NotRequired[typing.Optional[str]] + """ + The name of this subscription. + """ + + enabled: typing_extensions.NotRequired[typing.Optional[bool]] + """ + Indicates whether the subscription is enabled (`true`) or not (`false`). + """ + + event_types: typing_extensions.NotRequired[typing.Optional[typing.Sequence[str]]] + """ + The event types associated with this subscription. + """ + + notification_url: typing_extensions.NotRequired[typing.Optional[str]] + """ + The URL to which webhooks are sent. + """ + + api_version: typing_extensions.NotRequired[typing.Optional[str]] + """ + The API version of the subscription. + This field is optional for `CreateWebhookSubscription`. + The value defaults to the API version used by the application. + """ + + signature_key: typing_extensions.NotRequired[str] + """ + The Square-generated signature key used to validate the origin of the webhook event. + """ + + created_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". + """ + + updated_at: typing_extensions.NotRequired[str] + """ + The timestamp of when the subscription was last updated, in RFC 3339 format. + For example, "2016-09-04T23:59:33.123Z". + """ diff --git a/src/square/requests/workweek_config.py b/src/square/requests/workweek_config.py new file mode 100644 index 00000000..defc9435 --- /dev/null +++ b/src/square/requests/workweek_config.py @@ -0,0 +1,49 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from ..types.weekday import Weekday + + +class WorkweekConfigParams(typing_extensions.TypedDict): + """ + Sets the day of the week and hour of the day that a business starts a + workweek. This is used to calculate overtime pay. + """ + + id: typing_extensions.NotRequired[str] + """ + The UUID for this object. + """ + + start_of_week: Weekday + """ + The day of the week on which a business week starts for + compensation purposes. + See [Weekday](#type-weekday) for possible values + """ + + start_of_day_local_time: str + """ + The local time at which a business week starts. Represented as a + string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are + truncated). + """ + + version: typing_extensions.NotRequired[int] + """ + Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If not provided, + Square executes a blind write; potentially overwriting data from another + write. + """ + + created_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + updated_at: typing_extensions.NotRequired[str] + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ diff --git a/src/square/sites/__init__.py b/src/square/sites/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/sites/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/sites/client.py b/src/square/sites/client.py new file mode 100644 index 00000000..4cecbc39 --- /dev/null +++ b/src/square/sites/client.py @@ -0,0 +1,107 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawSitesClient +import typing +from ..core.request_options import RequestOptions +from ..types.list_sites_response import ListSitesResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawSitesClient + + +class SitesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawSitesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawSitesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawSitesClient + """ + return self._raw_client + + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListSitesResponse: + """ + Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListSitesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.sites.list() + """ + response = self._raw_client.list(request_options=request_options) + return response.data + + +class AsyncSitesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawSitesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawSitesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawSitesClient + """ + return self._raw_client + + async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListSitesResponse: + """ + Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListSitesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.sites.list() + + + asyncio.run(main()) + """ + response = await self._raw_client.list(request_options=request_options) + return response.data diff --git a/src/square/sites/raw_client.py b/src/square/sites/raw_client.py new file mode 100644 index 00000000..b9804ed4 --- /dev/null +++ b/src/square/sites/raw_client.py @@ -0,0 +1,98 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.list_sites_response import ListSitesResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawSitesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[ListSitesResponse]: + """ + Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListSitesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/sites", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListSitesResponse, + construct_type( + type_=ListSitesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawSitesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ListSitesResponse]: + """ + Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListSitesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/sites", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListSitesResponse, + construct_type( + type_=ListSitesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/snippets/__init__.py b/src/square/snippets/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/snippets/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/snippets/client.py b/src/square/snippets/client.py new file mode 100644 index 00000000..cd80df90 --- /dev/null +++ b/src/square/snippets/client.py @@ -0,0 +1,303 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawSnippetsClient +from ..core.request_options import RequestOptions +from ..types.get_snippet_response import GetSnippetResponse +from ..requests.snippet import SnippetParams +from ..types.upsert_snippet_response import UpsertSnippetResponse +from ..types.delete_snippet_response import DeleteSnippetResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawSnippetsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class SnippetsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawSnippetsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawSnippetsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawSnippetsClient + """ + return self._raw_client + + def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetSnippetResponse: + """ + Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetSnippetResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.snippets.get( + site_id="site_id", + ) + """ + response = self._raw_client.get(site_id, request_options=request_options) + return response.data + + def upsert( + self, site_id: str, *, snippet: SnippetParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpsertSnippetResponse: + """ + Adds a snippet to a Square Online site or updates the existing snippet on the site. + The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site where you want to add or update the snippet. + + snippet : SnippetParams + The snippet for the site. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertSnippetResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.snippets.upsert( + site_id="site_id", + snippet={"content": ""}, + ) + """ + response = self._raw_client.upsert(site_id, snippet=snippet, request_options=request_options) + return response.data + + def delete(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteSnippetResponse: + """ + Removes your snippet from a Square Online site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteSnippetResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.snippets.delete( + site_id="site_id", + ) + """ + response = self._raw_client.delete(site_id, request_options=request_options) + return response.data + + +class AsyncSnippetsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawSnippetsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawSnippetsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawSnippetsClient + """ + return self._raw_client + + async def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetSnippetResponse: + """ + Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetSnippetResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.snippets.get( + site_id="site_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(site_id, request_options=request_options) + return response.data + + async def upsert( + self, site_id: str, *, snippet: SnippetParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpsertSnippetResponse: + """ + Adds a snippet to a Square Online site or updates the existing snippet on the site. + The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site where you want to add or update the snippet. + + snippet : SnippetParams + The snippet for the site. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpsertSnippetResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.snippets.upsert( + site_id="site_id", + snippet={"content": ""}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.upsert(site_id, snippet=snippet, request_options=request_options) + return response.data + + async def delete( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteSnippetResponse: + """ + Removes your snippet from a Square Online site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteSnippetResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.snippets.delete( + site_id="site_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(site_id, request_options=request_options) + return response.data diff --git a/src/square/snippets/raw_client.py b/src/square/snippets/raw_client.py new file mode 100644 index 00000000..bc576437 --- /dev/null +++ b/src/square/snippets/raw_client.py @@ -0,0 +1,320 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.get_snippet_response import GetSnippetResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.snippet import SnippetParams +from ..types.upsert_snippet_response import UpsertSnippetResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..types.delete_snippet_response import DeleteSnippetResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawSnippetsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetSnippetResponse]: + """ + Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetSnippetResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/sites/{jsonable_encoder(site_id)}/snippet", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetSnippetResponse, + construct_type( + type_=GetSnippetResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def upsert( + self, site_id: str, *, snippet: SnippetParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpsertSnippetResponse]: + """ + Adds a snippet to a Square Online site or updates the existing snippet on the site. + The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site where you want to add or update the snippet. + + snippet : SnippetParams + The snippet for the site. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpsertSnippetResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/sites/{jsonable_encoder(site_id)}/snippet", + method="POST", + json={ + "snippet": convert_and_respect_annotation_metadata( + object_=snippet, annotation=SnippetParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertSnippetResponse, + construct_type( + type_=UpsertSnippetResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteSnippetResponse]: + """ + Removes your snippet from a Square Online site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteSnippetResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/sites/{jsonable_encoder(site_id)}/snippet", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteSnippetResponse, + construct_type( + type_=DeleteSnippetResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawSnippetsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetSnippetResponse]: + """ + Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetSnippetResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/sites/{jsonable_encoder(site_id)}/snippet", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetSnippetResponse, + construct_type( + type_=GetSnippetResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def upsert( + self, site_id: str, *, snippet: SnippetParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpsertSnippetResponse]: + """ + Adds a snippet to a Square Online site or updates the existing snippet on the site. + The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site where you want to add or update the snippet. + + snippet : SnippetParams + The snippet for the site. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpsertSnippetResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/sites/{jsonable_encoder(site_id)}/snippet", + method="POST", + json={ + "snippet": convert_and_respect_annotation_metadata( + object_=snippet, annotation=SnippetParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpsertSnippetResponse, + construct_type( + type_=UpsertSnippetResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteSnippetResponse]: + """ + Removes your snippet from a Square Online site. + + You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller. + + + __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis). + + Parameters + ---------- + site_id : str + The ID of the site that contains the snippet. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteSnippetResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/sites/{jsonable_encoder(site_id)}/snippet", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteSnippetResponse, + construct_type( + type_=DeleteSnippetResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/subscriptions/__init__.py b/src/square/subscriptions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/subscriptions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/subscriptions/client.py b/src/square/subscriptions/client.py new file mode 100644 index 00000000..858ec776 --- /dev/null +++ b/src/square/subscriptions/client.py @@ -0,0 +1,1669 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawSubscriptionsClient +from ..requests.money import MoneyParams +from ..requests.subscription_source import SubscriptionSourceParams +from ..requests.phase import PhaseParams +from ..core.request_options import RequestOptions +from ..types.create_subscription_response import CreateSubscriptionResponse +from ..types.bulk_swap_plan_response import BulkSwapPlanResponse +from ..requests.search_subscriptions_query import SearchSubscriptionsQueryParams +from ..types.search_subscriptions_response import SearchSubscriptionsResponse +from ..types.get_subscription_response import GetSubscriptionResponse +from ..requests.subscription import SubscriptionParams +from ..types.update_subscription_response import UpdateSubscriptionResponse +from ..types.delete_subscription_action_response import DeleteSubscriptionActionResponse +from ..types.change_billing_anchor_date_response import ChangeBillingAnchorDateResponse +from ..types.cancel_subscription_response import CancelSubscriptionResponse +from ..core.pagination import SyncPager +from ..types.subscription_event import SubscriptionEvent +from ..core.jsonable_encoder import jsonable_encoder +from ..types.list_subscription_events_response import ListSubscriptionEventsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.change_timing import ChangeTiming +from ..types.pause_subscription_response import PauseSubscriptionResponse +from ..types.resume_subscription_response import ResumeSubscriptionResponse +from ..requests.phase_input import PhaseInputParams +from ..types.swap_plan_response import SwapPlanResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawSubscriptionsClient +from ..core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class SubscriptionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawSubscriptionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawSubscriptionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawSubscriptionsClient + """ + return self._raw_client + + def create( + self, + *, + location_id: str, + customer_id: str, + idempotency_key: typing.Optional[str] = OMIT, + plan_variation_id: typing.Optional[str] = OMIT, + start_date: typing.Optional[str] = OMIT, + canceled_date: typing.Optional[str] = OMIT, + tax_percentage: typing.Optional[str] = OMIT, + price_override_money: typing.Optional[MoneyParams] = OMIT, + card_id: typing.Optional[str] = OMIT, + timezone: typing.Optional[str] = OMIT, + source: typing.Optional[SubscriptionSourceParams] = OMIT, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateSubscriptionResponse: + """ + Enrolls a customer in a subscription. + + If you provide a card on file in the request, Square charges the card for + the subscription. Otherwise, Square sends an invoice to the customer's email + address. The subscription starts immediately, unless the request includes + the optional `start_date`. Each individual subscription is associated with a particular location. + + For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription). + + Parameters + ---------- + location_id : str + The ID of the location the subscription is associated with. + + customer_id : str + The ID of the [customer](entity:Customer) subscribing to the subscription plan variation. + + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateSubscription` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + plan_variation_id : typing.Optional[str] + The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. + + start_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date to start the subscription. + If it is unspecified, the subscription starts immediately. + + canceled_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. + + This date overrides the cancellation date set in the plan variation configuration. + If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops + at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. + + When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` + occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription + stops through the end of the last cycle. + + tax_percentage : typing.Optional[str] + The tax to add when billing the subscription. + The percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of 7.5 + corresponds to 7.5%. + + price_override_money : typing.Optional[MoneyParams] + A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. + This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, + you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + + card_id : typing.Optional[str] + The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge. + If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription. + + timezone : typing.Optional[str] + The timezone that is used in date calculations for the subscription. If unset, defaults to + the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". + Format: the IANA Timezone Database identifier for the location timezone. For + a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + + source : typing.Optional[SubscriptionSourceParams] + The origination details of the subscription. + + monthly_billing_anchor_date : typing.Optional[int] + The day-of-the-month to change the billing date to. + + phases : typing.Optional[typing.Sequence[PhaseParams]] + array of phases for this subscription + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.create( + idempotency_key="8193148c-9586-11e6-99f9-28cfe92138cf", + location_id="S8GWD5R9QB376", + plan_variation_id="6JHXF3B2CW3YKHDV4XEM674H", + customer_id="CHFGVKYY8RSV93M5KCYTG4PN0G", + start_date="2023-06-20", + card_id="ccof:qy5x8hHGYsgLrp4Q4GB", + timezone="America/Los_Angeles", + source={"name": "My Application"}, + phases=[ + {"ordinal": 0, "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY"} + ], + ) + """ + response = self._raw_client.create( + location_id=location_id, + customer_id=customer_id, + idempotency_key=idempotency_key, + plan_variation_id=plan_variation_id, + start_date=start_date, + canceled_date=canceled_date, + tax_percentage=tax_percentage, + price_override_money=price_override_money, + card_id=card_id, + timezone=timezone, + source=source, + monthly_billing_anchor_date=monthly_billing_anchor_date, + phases=phases, + request_options=request_options, + ) + return response.data + + def bulk_swap_plan( + self, + *, + new_plan_variation_id: str, + old_plan_variation_id: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkSwapPlanResponse: + """ + Schedules a plan variation change for all active subscriptions under a given plan + variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + new_plan_variation_id : str + The ID of the new subscription plan variation. + + This field is required. + + old_plan_variation_id : str + The ID of the plan variation whose subscriptions should be swapped. Active subscriptions + using this plan variation will be subscribed to the new plan variation on their next billing + day. + + location_id : str + The ID of the location to associate with the swapped subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkSwapPlanResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.bulk_swap_plan( + new_plan_variation_id="FQ7CDXXWSLUJRPM3GFJSJGZ7", + old_plan_variation_id="6JHXF3B2CW3YKHDV4XEM674H", + location_id="S8GWD5R9QB376", + ) + """ + response = self._raw_client.bulk_swap_plan( + new_plan_variation_id=new_plan_variation_id, + old_plan_variation_id=old_plan_variation_id, + location_id=location_id, + request_options=request_options, + ) + return response.data + + def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchSubscriptionsQueryParams] = OMIT, + include: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchSubscriptionsResponse: + """ + Searches for subscriptions. + + Results are ordered chronologically by subscription creation date. If + the request specifies more than one location ID, + the endpoint orders the result + by location ID, and then by creation date within each location. If no locations are given + in the query, all locations are searched. + + You can also optionally specify `customer_ids` to search by customer. + If left unset, all customers + associated with the specified locations are returned. + If the request specifies customer IDs, the endpoint orders results + first by location, within location by customer ID, and within + customer by subscription creation date. + + Parameters + ---------- + cursor : typing.Optional[str] + When the total number of resulting subscriptions exceeds the limit of a paged response, + specify the cursor returned from a preceding response here to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The upper limit on the number of subscriptions to return + in a paged response. + + query : typing.Optional[SearchSubscriptionsQueryParams] + A subscription query consisting of specified filtering conditions. + + If this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions. + + include : typing.Optional[typing.Sequence[str]] + An option to include related information in the response. + + The supported values are: + + - `actions`: to include scheduled actions on the targeted subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchSubscriptionsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.search( + query={ + "filter": { + "customer_ids": ["CHFGVKYY8RSV93M5KCYTG4PN0G"], + "location_ids": ["S8GWD5R9QB376"], + "source_names": ["My App"], + } + }, + ) + """ + response = self._raw_client.search( + cursor=cursor, limit=limit, query=query, include=include, request_options=request_options + ) + return response.data + + def get( + self, + subscription_id: str, + *, + include: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> GetSubscriptionResponse: + """ + Retrieves a specific subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to retrieve. + + include : typing.Optional[str] + A query parameter to specify related information to be included in the response. + + The supported query parameter values are: + + - `actions`: to include scheduled actions on the targeted subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.get( + subscription_id="subscription_id", + ) + """ + response = self._raw_client.get(subscription_id, include=include, request_options=request_options) + return response.data + + def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[SubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateSubscriptionResponse: + """ + Updates a subscription by modifying or clearing `subscription` field values. + To clear a field, set its value to `null`. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update. + + subscription : typing.Optional[SubscriptionParams] + The subscription object containing the current version, and fields to update. + Unset fields will be left at their current server values, and JSON `null` values will + be treated as a request to clear the relevant data. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.update( + subscription_id="subscription_id", + subscription={"card_id": "{NEW CARD ID}"}, + ) + """ + response = self._raw_client.update(subscription_id, subscription=subscription, request_options=request_options) + return response.data + + def delete_action( + self, subscription_id: str, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteSubscriptionActionResponse: + """ + Deletes a scheduled action for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription the targeted action is to act upon. + + action_id : str + The ID of the targeted action to be deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteSubscriptionActionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.delete_action( + subscription_id="subscription_id", + action_id="action_id", + ) + """ + response = self._raw_client.delete_action(subscription_id, action_id, request_options=request_options) + return response.data + + def change_billing_anchor_date( + self, + subscription_id: str, + *, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + effective_date: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> ChangeBillingAnchorDateResponse: + """ + Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) + for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update the billing anchor date. + + monthly_billing_anchor_date : typing.Optional[int] + The anchor day for the billing cycle. + + effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes + place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the billing anchor date + is changed immediately. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ChangeBillingAnchorDateResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.change_billing_anchor_date( + subscription_id="subscription_id", + monthly_billing_anchor_date=1, + ) + """ + response = self._raw_client.change_billing_anchor_date( + subscription_id, + monthly_billing_anchor_date=monthly_billing_anchor_date, + effective_date=effective_date, + request_options=request_options, + ) + return response.data + + def cancel( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelSubscriptionResponse: + """ + Schedules a `CANCEL` action to cancel an active subscription. This + sets the `canceled_date` field to the end of the active billing period. After this date, + the subscription status changes from ACTIVE to CANCELED. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.cancel( + subscription_id="subscription_id", + ) + """ + response = self._raw_client.cancel(subscription_id, request_options=request_options) + return response.data + + def list_events( + self, + subscription_id: str, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[SubscriptionEvent]: + """ + Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to retrieve the events for. + + cursor : typing.Optional[str] + When the total number of resulting subscription events exceeds the limit of a paged response, + specify the cursor returned from a preceding response here to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The upper limit on the number of subscription events to return + in a paged response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[SubscriptionEvent] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.subscriptions.list_events( + subscription_id="subscription_id", + ) + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/events", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListSubscriptionEventsResponse, + construct_type( + type_=ListSubscriptionEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list_events( + subscription_id, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.subscription_events + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def pause( + self, + subscription_id: str, + *, + pause_effective_date: typing.Optional[str] = OMIT, + pause_cycle_duration: typing.Optional[int] = OMIT, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + pause_reason: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> PauseSubscriptionResponse: + """ + Schedules a `PAUSE` action to pause an active subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to pause. + + pause_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the subscription is paused + on the starting date of the next billing cycle. + + pause_cycle_duration : typing.Optional[int] + The number of billing cycles the subscription will be paused before it is reactivated. + + When this is set, a `RESUME` action is also scheduled to take place on the subscription at + the end of the specified pause cycle duration. In this case, neither `resume_effective_date` + nor `resume_change_timing` may be specified. + + resume_effective_date : typing.Optional[str] + The date when the subscription is reactivated by a scheduled `RESUME` action. + This date must be at least one billing cycle ahead of `pause_effective_date`. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to + `resume_effective_date`. + See [ChangeTiming](#type-changetiming) for possible values + + pause_reason : typing.Optional[str] + The user-provided reason to pause the subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + PauseSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.pause( + subscription_id="subscription_id", + ) + """ + response = self._raw_client.pause( + subscription_id, + pause_effective_date=pause_effective_date, + pause_cycle_duration=pause_cycle_duration, + resume_effective_date=resume_effective_date, + resume_change_timing=resume_change_timing, + pause_reason=pause_reason, + request_options=request_options, + ) + return response.data + + def resume( + self, + subscription_id: str, + *, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> ResumeSubscriptionResponse: + """ + Schedules a `RESUME` action to resume a paused or a deactivated subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to resume. + + resume_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the subscription reactivated. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing to resume a subscription, relative to the specified + `resume_effective_date` attribute value. + See [ChangeTiming](#type-changetiming) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ResumeSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.resume( + subscription_id="subscription_id", + ) + """ + response = self._raw_client.resume( + subscription_id, + resume_effective_date=resume_effective_date, + resume_change_timing=resume_change_timing, + request_options=request_options, + ) + return response.data + + def swap_plan( + self, + subscription_id: str, + *, + new_plan_variation_id: typing.Optional[str] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseInputParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SwapPlanResponse: + """ + Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. + For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + subscription_id : str + The ID of the subscription to swap the subscription plan for. + + new_plan_variation_id : typing.Optional[str] + The ID of the new subscription plan variation. + + This field is required. + + phases : typing.Optional[typing.Sequence[PhaseInputParams]] + A list of PhaseInputs, to pass phase-specific information used in the swap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SwapPlanResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.subscriptions.swap_plan( + subscription_id="subscription_id", + new_plan_variation_id="FQ7CDXXWSLUJRPM3GFJSJGZ7", + phases=[ + {"ordinal": 0, "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY"} + ], + ) + """ + response = self._raw_client.swap_plan( + subscription_id, new_plan_variation_id=new_plan_variation_id, phases=phases, request_options=request_options + ) + return response.data + + +class AsyncSubscriptionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawSubscriptionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawSubscriptionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawSubscriptionsClient + """ + return self._raw_client + + async def create( + self, + *, + location_id: str, + customer_id: str, + idempotency_key: typing.Optional[str] = OMIT, + plan_variation_id: typing.Optional[str] = OMIT, + start_date: typing.Optional[str] = OMIT, + canceled_date: typing.Optional[str] = OMIT, + tax_percentage: typing.Optional[str] = OMIT, + price_override_money: typing.Optional[MoneyParams] = OMIT, + card_id: typing.Optional[str] = OMIT, + timezone: typing.Optional[str] = OMIT, + source: typing.Optional[SubscriptionSourceParams] = OMIT, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateSubscriptionResponse: + """ + Enrolls a customer in a subscription. + + If you provide a card on file in the request, Square charges the card for + the subscription. Otherwise, Square sends an invoice to the customer's email + address. The subscription starts immediately, unless the request includes + the optional `start_date`. Each individual subscription is associated with a particular location. + + For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription). + + Parameters + ---------- + location_id : str + The ID of the location the subscription is associated with. + + customer_id : str + The ID of the [customer](entity:Customer) subscribing to the subscription plan variation. + + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateSubscription` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + plan_variation_id : typing.Optional[str] + The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. + + start_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date to start the subscription. + If it is unspecified, the subscription starts immediately. + + canceled_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. + + This date overrides the cancellation date set in the plan variation configuration. + If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops + at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. + + When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` + occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription + stops through the end of the last cycle. + + tax_percentage : typing.Optional[str] + The tax to add when billing the subscription. + The percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of 7.5 + corresponds to 7.5%. + + price_override_money : typing.Optional[MoneyParams] + A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. + This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, + you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + + card_id : typing.Optional[str] + The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge. + If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription. + + timezone : typing.Optional[str] + The timezone that is used in date calculations for the subscription. If unset, defaults to + the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". + Format: the IANA Timezone Database identifier for the location timezone. For + a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + + source : typing.Optional[SubscriptionSourceParams] + The origination details of the subscription. + + monthly_billing_anchor_date : typing.Optional[int] + The day-of-the-month to change the billing date to. + + phases : typing.Optional[typing.Sequence[PhaseParams]] + array of phases for this subscription + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.create( + idempotency_key="8193148c-9586-11e6-99f9-28cfe92138cf", + location_id="S8GWD5R9QB376", + plan_variation_id="6JHXF3B2CW3YKHDV4XEM674H", + customer_id="CHFGVKYY8RSV93M5KCYTG4PN0G", + start_date="2023-06-20", + card_id="ccof:qy5x8hHGYsgLrp4Q4GB", + timezone="America/Los_Angeles", + source={"name": "My Application"}, + phases=[ + {"ordinal": 0, "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY"} + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + location_id=location_id, + customer_id=customer_id, + idempotency_key=idempotency_key, + plan_variation_id=plan_variation_id, + start_date=start_date, + canceled_date=canceled_date, + tax_percentage=tax_percentage, + price_override_money=price_override_money, + card_id=card_id, + timezone=timezone, + source=source, + monthly_billing_anchor_date=monthly_billing_anchor_date, + phases=phases, + request_options=request_options, + ) + return response.data + + async def bulk_swap_plan( + self, + *, + new_plan_variation_id: str, + old_plan_variation_id: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> BulkSwapPlanResponse: + """ + Schedules a plan variation change for all active subscriptions under a given plan + variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + new_plan_variation_id : str + The ID of the new subscription plan variation. + + This field is required. + + old_plan_variation_id : str + The ID of the plan variation whose subscriptions should be swapped. Active subscriptions + using this plan variation will be subscribed to the new plan variation on their next billing + day. + + location_id : str + The ID of the location to associate with the swapped subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BulkSwapPlanResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.bulk_swap_plan( + new_plan_variation_id="FQ7CDXXWSLUJRPM3GFJSJGZ7", + old_plan_variation_id="6JHXF3B2CW3YKHDV4XEM674H", + location_id="S8GWD5R9QB376", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.bulk_swap_plan( + new_plan_variation_id=new_plan_variation_id, + old_plan_variation_id=old_plan_variation_id, + location_id=location_id, + request_options=request_options, + ) + return response.data + + async def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchSubscriptionsQueryParams] = OMIT, + include: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchSubscriptionsResponse: + """ + Searches for subscriptions. + + Results are ordered chronologically by subscription creation date. If + the request specifies more than one location ID, + the endpoint orders the result + by location ID, and then by creation date within each location. If no locations are given + in the query, all locations are searched. + + You can also optionally specify `customer_ids` to search by customer. + If left unset, all customers + associated with the specified locations are returned. + If the request specifies customer IDs, the endpoint orders results + first by location, within location by customer ID, and within + customer by subscription creation date. + + Parameters + ---------- + cursor : typing.Optional[str] + When the total number of resulting subscriptions exceeds the limit of a paged response, + specify the cursor returned from a preceding response here to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The upper limit on the number of subscriptions to return + in a paged response. + + query : typing.Optional[SearchSubscriptionsQueryParams] + A subscription query consisting of specified filtering conditions. + + If this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions. + + include : typing.Optional[typing.Sequence[str]] + An option to include related information in the response. + + The supported values are: + + - `actions`: to include scheduled actions on the targeted subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchSubscriptionsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.search( + query={ + "filter": { + "customer_ids": ["CHFGVKYY8RSV93M5KCYTG4PN0G"], + "location_ids": ["S8GWD5R9QB376"], + "source_names": ["My App"], + } + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + cursor=cursor, limit=limit, query=query, include=include, request_options=request_options + ) + return response.data + + async def get( + self, + subscription_id: str, + *, + include: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> GetSubscriptionResponse: + """ + Retrieves a specific subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to retrieve. + + include : typing.Optional[str] + A query parameter to specify related information to be included in the response. + + The supported query parameter values are: + + - `actions`: to include scheduled actions on the targeted subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.get( + subscription_id="subscription_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(subscription_id, include=include, request_options=request_options) + return response.data + + async def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[SubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateSubscriptionResponse: + """ + Updates a subscription by modifying or clearing `subscription` field values. + To clear a field, set its value to `null`. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update. + + subscription : typing.Optional[SubscriptionParams] + The subscription object containing the current version, and fields to update. + Unset fields will be left at their current server values, and JSON `null` values will + be treated as a request to clear the relevant data. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.update( + subscription_id="subscription_id", + subscription={"card_id": "{NEW CARD ID}"}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + subscription_id, subscription=subscription, request_options=request_options + ) + return response.data + + async def delete_action( + self, subscription_id: str, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteSubscriptionActionResponse: + """ + Deletes a scheduled action for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription the targeted action is to act upon. + + action_id : str + The ID of the targeted action to be deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteSubscriptionActionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.delete_action( + subscription_id="subscription_id", + action_id="action_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete_action(subscription_id, action_id, request_options=request_options) + return response.data + + async def change_billing_anchor_date( + self, + subscription_id: str, + *, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + effective_date: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> ChangeBillingAnchorDateResponse: + """ + Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) + for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update the billing anchor date. + + monthly_billing_anchor_date : typing.Optional[int] + The anchor day for the billing cycle. + + effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes + place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the billing anchor date + is changed immediately. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ChangeBillingAnchorDateResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.change_billing_anchor_date( + subscription_id="subscription_id", + monthly_billing_anchor_date=1, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.change_billing_anchor_date( + subscription_id, + monthly_billing_anchor_date=monthly_billing_anchor_date, + effective_date=effective_date, + request_options=request_options, + ) + return response.data + + async def cancel( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelSubscriptionResponse: + """ + Schedules a `CANCEL` action to cancel an active subscription. This + sets the `canceled_date` field to the end of the active billing period. After this date, + the subscription status changes from ACTIVE to CANCELED. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.cancel( + subscription_id="subscription_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(subscription_id, request_options=request_options) + return response.data + + async def list_events( + self, + subscription_id: str, + *, + cursor: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[SubscriptionEvent]: + """ + Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to retrieve the events for. + + cursor : typing.Optional[str] + When the total number of resulting subscription events exceeds the limit of a paged response, + specify the cursor returned from a preceding response here to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The upper limit on the number of subscription events to return + in a paged response. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[SubscriptionEvent] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.subscriptions.list_events( + subscription_id="subscription_id", + ) + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/events", + method="GET", + params={ + "cursor": cursor, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListSubscriptionEventsResponse, + construct_type( + type_=ListSubscriptionEventsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list_events( + subscription_id, + cursor=_parsed_next, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.subscription_events + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def pause( + self, + subscription_id: str, + *, + pause_effective_date: typing.Optional[str] = OMIT, + pause_cycle_duration: typing.Optional[int] = OMIT, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + pause_reason: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> PauseSubscriptionResponse: + """ + Schedules a `PAUSE` action to pause an active subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to pause. + + pause_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the subscription is paused + on the starting date of the next billing cycle. + + pause_cycle_duration : typing.Optional[int] + The number of billing cycles the subscription will be paused before it is reactivated. + + When this is set, a `RESUME` action is also scheduled to take place on the subscription at + the end of the specified pause cycle duration. In this case, neither `resume_effective_date` + nor `resume_change_timing` may be specified. + + resume_effective_date : typing.Optional[str] + The date when the subscription is reactivated by a scheduled `RESUME` action. + This date must be at least one billing cycle ahead of `pause_effective_date`. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to + `resume_effective_date`. + See [ChangeTiming](#type-changetiming) for possible values + + pause_reason : typing.Optional[str] + The user-provided reason to pause the subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + PauseSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.pause( + subscription_id="subscription_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.pause( + subscription_id, + pause_effective_date=pause_effective_date, + pause_cycle_duration=pause_cycle_duration, + resume_effective_date=resume_effective_date, + resume_change_timing=resume_change_timing, + pause_reason=pause_reason, + request_options=request_options, + ) + return response.data + + async def resume( + self, + subscription_id: str, + *, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> ResumeSubscriptionResponse: + """ + Schedules a `RESUME` action to resume a paused or a deactivated subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to resume. + + resume_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the subscription reactivated. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing to resume a subscription, relative to the specified + `resume_effective_date` attribute value. + See [ChangeTiming](#type-changetiming) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ResumeSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.resume( + subscription_id="subscription_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.resume( + subscription_id, + resume_effective_date=resume_effective_date, + resume_change_timing=resume_change_timing, + request_options=request_options, + ) + return response.data + + async def swap_plan( + self, + subscription_id: str, + *, + new_plan_variation_id: typing.Optional[str] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseInputParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SwapPlanResponse: + """ + Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. + For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + subscription_id : str + The ID of the subscription to swap the subscription plan for. + + new_plan_variation_id : typing.Optional[str] + The ID of the new subscription plan variation. + + This field is required. + + phases : typing.Optional[typing.Sequence[PhaseInputParams]] + A list of PhaseInputs, to pass phase-specific information used in the swap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SwapPlanResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.subscriptions.swap_plan( + subscription_id="subscription_id", + new_plan_variation_id="FQ7CDXXWSLUJRPM3GFJSJGZ7", + phases=[ + {"ordinal": 0, "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY"} + ], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.swap_plan( + subscription_id, new_plan_variation_id=new_plan_variation_id, phases=phases, request_options=request_options + ) + return response.data diff --git a/src/square/subscriptions/raw_client.py b/src/square/subscriptions/raw_client.py new file mode 100644 index 00000000..299bfa56 --- /dev/null +++ b/src/square/subscriptions/raw_client.py @@ -0,0 +1,1566 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.money import MoneyParams +from ..requests.subscription_source import SubscriptionSourceParams +from ..requests.phase import PhaseParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_subscription_response import CreateSubscriptionResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.bulk_swap_plan_response import BulkSwapPlanResponse +from ..requests.search_subscriptions_query import SearchSubscriptionsQueryParams +from ..types.search_subscriptions_response import SearchSubscriptionsResponse +from ..types.get_subscription_response import GetSubscriptionResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..requests.subscription import SubscriptionParams +from ..types.update_subscription_response import UpdateSubscriptionResponse +from ..types.delete_subscription_action_response import DeleteSubscriptionActionResponse +from ..types.change_billing_anchor_date_response import ChangeBillingAnchorDateResponse +from ..types.cancel_subscription_response import CancelSubscriptionResponse +from ..types.change_timing import ChangeTiming +from ..types.pause_subscription_response import PauseSubscriptionResponse +from ..types.resume_subscription_response import ResumeSubscriptionResponse +from ..requests.phase_input import PhaseInputParams +from ..types.swap_plan_response import SwapPlanResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawSubscriptionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + location_id: str, + customer_id: str, + idempotency_key: typing.Optional[str] = OMIT, + plan_variation_id: typing.Optional[str] = OMIT, + start_date: typing.Optional[str] = OMIT, + canceled_date: typing.Optional[str] = OMIT, + tax_percentage: typing.Optional[str] = OMIT, + price_override_money: typing.Optional[MoneyParams] = OMIT, + card_id: typing.Optional[str] = OMIT, + timezone: typing.Optional[str] = OMIT, + source: typing.Optional[SubscriptionSourceParams] = OMIT, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateSubscriptionResponse]: + """ + Enrolls a customer in a subscription. + + If you provide a card on file in the request, Square charges the card for + the subscription. Otherwise, Square sends an invoice to the customer's email + address. The subscription starts immediately, unless the request includes + the optional `start_date`. Each individual subscription is associated with a particular location. + + For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription). + + Parameters + ---------- + location_id : str + The ID of the location the subscription is associated with. + + customer_id : str + The ID of the [customer](entity:Customer) subscribing to the subscription plan variation. + + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateSubscription` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + plan_variation_id : typing.Optional[str] + The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. + + start_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date to start the subscription. + If it is unspecified, the subscription starts immediately. + + canceled_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. + + This date overrides the cancellation date set in the plan variation configuration. + If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops + at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. + + When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` + occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription + stops through the end of the last cycle. + + tax_percentage : typing.Optional[str] + The tax to add when billing the subscription. + The percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of 7.5 + corresponds to 7.5%. + + price_override_money : typing.Optional[MoneyParams] + A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. + This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, + you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + + card_id : typing.Optional[str] + The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge. + If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription. + + timezone : typing.Optional[str] + The timezone that is used in date calculations for the subscription. If unset, defaults to + the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". + Format: the IANA Timezone Database identifier for the location timezone. For + a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + + source : typing.Optional[SubscriptionSourceParams] + The origination details of the subscription. + + monthly_billing_anchor_date : typing.Optional[int] + The day-of-the-month to change the billing date to. + + phases : typing.Optional[typing.Sequence[PhaseParams]] + array of phases for this subscription + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/subscriptions", + method="POST", + json={ + "idempotency_key": idempotency_key, + "location_id": location_id, + "plan_variation_id": plan_variation_id, + "customer_id": customer_id, + "start_date": start_date, + "canceled_date": canceled_date, + "tax_percentage": tax_percentage, + "price_override_money": convert_and_respect_annotation_metadata( + object_=price_override_money, annotation=MoneyParams, direction="write" + ), + "card_id": card_id, + "timezone": timezone, + "source": convert_and_respect_annotation_metadata( + object_=source, annotation=SubscriptionSourceParams, direction="write" + ), + "monthly_billing_anchor_date": monthly_billing_anchor_date, + "phases": convert_and_respect_annotation_metadata( + object_=phases, annotation=typing.Sequence[PhaseParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateSubscriptionResponse, + construct_type( + type_=CreateSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def bulk_swap_plan( + self, + *, + new_plan_variation_id: str, + old_plan_variation_id: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkSwapPlanResponse]: + """ + Schedules a plan variation change for all active subscriptions under a given plan + variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + new_plan_variation_id : str + The ID of the new subscription plan variation. + + This field is required. + + old_plan_variation_id : str + The ID of the plan variation whose subscriptions should be swapped. Active subscriptions + using this plan variation will be subscribed to the new plan variation on their next billing + day. + + location_id : str + The ID of the location to associate with the swapped subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkSwapPlanResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/subscriptions/bulk-swap-plan", + method="POST", + json={ + "new_plan_variation_id": new_plan_variation_id, + "old_plan_variation_id": old_plan_variation_id, + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkSwapPlanResponse, + construct_type( + type_=BulkSwapPlanResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchSubscriptionsQueryParams] = OMIT, + include: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchSubscriptionsResponse]: + """ + Searches for subscriptions. + + Results are ordered chronologically by subscription creation date. If + the request specifies more than one location ID, + the endpoint orders the result + by location ID, and then by creation date within each location. If no locations are given + in the query, all locations are searched. + + You can also optionally specify `customer_ids` to search by customer. + If left unset, all customers + associated with the specified locations are returned. + If the request specifies customer IDs, the endpoint orders results + first by location, within location by customer ID, and within + customer by subscription creation date. + + Parameters + ---------- + cursor : typing.Optional[str] + When the total number of resulting subscriptions exceeds the limit of a paged response, + specify the cursor returned from a preceding response here to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The upper limit on the number of subscriptions to return + in a paged response. + + query : typing.Optional[SearchSubscriptionsQueryParams] + A subscription query consisting of specified filtering conditions. + + If this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions. + + include : typing.Optional[typing.Sequence[str]] + An option to include related information in the response. + + The supported values are: + + - `actions`: to include scheduled actions on the targeted subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchSubscriptionsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/subscriptions/search", + method="POST", + json={ + "cursor": cursor, + "limit": limit, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchSubscriptionsQueryParams, direction="write" + ), + "include": include, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchSubscriptionsResponse, + construct_type( + type_=SearchSubscriptionsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, + subscription_id: str, + *, + include: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[GetSubscriptionResponse]: + """ + Retrieves a specific subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to retrieve. + + include : typing.Optional[str] + A query parameter to specify related information to be included in the response. + + The supported query parameter values are: + + - `actions`: to include scheduled actions on the targeted subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}", + method="GET", + params={ + "include": include, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetSubscriptionResponse, + construct_type( + type_=GetSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[SubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateSubscriptionResponse]: + """ + Updates a subscription by modifying or clearing `subscription` field values. + To clear a field, set its value to `null`. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update. + + subscription : typing.Optional[SubscriptionParams] + The subscription object containing the current version, and fields to update. + Unset fields will be left at their current server values, and JSON `null` values will + be treated as a request to clear the relevant data. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}", + method="PUT", + json={ + "subscription": convert_and_respect_annotation_metadata( + object_=subscription, annotation=SubscriptionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateSubscriptionResponse, + construct_type( + type_=UpdateSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete_action( + self, subscription_id: str, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteSubscriptionActionResponse]: + """ + Deletes a scheduled action for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription the targeted action is to act upon. + + action_id : str + The ID of the targeted action to be deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteSubscriptionActionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/actions/{jsonable_encoder(action_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteSubscriptionActionResponse, + construct_type( + type_=DeleteSubscriptionActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def change_billing_anchor_date( + self, + subscription_id: str, + *, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + effective_date: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ChangeBillingAnchorDateResponse]: + """ + Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) + for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update the billing anchor date. + + monthly_billing_anchor_date : typing.Optional[int] + The anchor day for the billing cycle. + + effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes + place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the billing anchor date + is changed immediately. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ChangeBillingAnchorDateResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/billing-anchor", + method="POST", + json={ + "monthly_billing_anchor_date": monthly_billing_anchor_date, + "effective_date": effective_date, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ChangeBillingAnchorDateResponse, + construct_type( + type_=ChangeBillingAnchorDateResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelSubscriptionResponse]: + """ + Schedules a `CANCEL` action to cancel an active subscription. This + sets the `canceled_date` field to the end of the active billing period. After this date, + the subscription status changes from ACTIVE to CANCELED. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelSubscriptionResponse, + construct_type( + type_=CancelSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def pause( + self, + subscription_id: str, + *, + pause_effective_date: typing.Optional[str] = OMIT, + pause_cycle_duration: typing.Optional[int] = OMIT, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + pause_reason: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[PauseSubscriptionResponse]: + """ + Schedules a `PAUSE` action to pause an active subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to pause. + + pause_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the subscription is paused + on the starting date of the next billing cycle. + + pause_cycle_duration : typing.Optional[int] + The number of billing cycles the subscription will be paused before it is reactivated. + + When this is set, a `RESUME` action is also scheduled to take place on the subscription at + the end of the specified pause cycle duration. In this case, neither `resume_effective_date` + nor `resume_change_timing` may be specified. + + resume_effective_date : typing.Optional[str] + The date when the subscription is reactivated by a scheduled `RESUME` action. + This date must be at least one billing cycle ahead of `pause_effective_date`. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to + `resume_effective_date`. + See [ChangeTiming](#type-changetiming) for possible values + + pause_reason : typing.Optional[str] + The user-provided reason to pause the subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[PauseSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/pause", + method="POST", + json={ + "pause_effective_date": pause_effective_date, + "pause_cycle_duration": pause_cycle_duration, + "resume_effective_date": resume_effective_date, + "resume_change_timing": resume_change_timing, + "pause_reason": pause_reason, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PauseSubscriptionResponse, + construct_type( + type_=PauseSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def resume( + self, + subscription_id: str, + *, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ResumeSubscriptionResponse]: + """ + Schedules a `RESUME` action to resume a paused or a deactivated subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to resume. + + resume_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the subscription reactivated. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing to resume a subscription, relative to the specified + `resume_effective_date` attribute value. + See [ChangeTiming](#type-changetiming) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ResumeSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/resume", + method="POST", + json={ + "resume_effective_date": resume_effective_date, + "resume_change_timing": resume_change_timing, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ResumeSubscriptionResponse, + construct_type( + type_=ResumeSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def swap_plan( + self, + subscription_id: str, + *, + new_plan_variation_id: typing.Optional[str] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseInputParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SwapPlanResponse]: + """ + Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. + For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + subscription_id : str + The ID of the subscription to swap the subscription plan for. + + new_plan_variation_id : typing.Optional[str] + The ID of the new subscription plan variation. + + This field is required. + + phases : typing.Optional[typing.Sequence[PhaseInputParams]] + A list of PhaseInputs, to pass phase-specific information used in the swap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SwapPlanResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/swap-plan", + method="POST", + json={ + "new_plan_variation_id": new_plan_variation_id, + "phases": convert_and_respect_annotation_metadata( + object_=phases, annotation=typing.Optional[typing.Sequence[PhaseInputParams]], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SwapPlanResponse, + construct_type( + type_=SwapPlanResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawSubscriptionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + location_id: str, + customer_id: str, + idempotency_key: typing.Optional[str] = OMIT, + plan_variation_id: typing.Optional[str] = OMIT, + start_date: typing.Optional[str] = OMIT, + canceled_date: typing.Optional[str] = OMIT, + tax_percentage: typing.Optional[str] = OMIT, + price_override_money: typing.Optional[MoneyParams] = OMIT, + card_id: typing.Optional[str] = OMIT, + timezone: typing.Optional[str] = OMIT, + source: typing.Optional[SubscriptionSourceParams] = OMIT, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateSubscriptionResponse]: + """ + Enrolls a customer in a subscription. + + If you provide a card on file in the request, Square charges the card for + the subscription. Otherwise, Square sends an invoice to the customer's email + address. The subscription starts immediately, unless the request includes + the optional `start_date`. Each individual subscription is associated with a particular location. + + For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription). + + Parameters + ---------- + location_id : str + The ID of the location the subscription is associated with. + + customer_id : str + The ID of the [customer](entity:Customer) subscribing to the subscription plan variation. + + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateSubscription` request. + If you do not provide a unique string (or provide an empty string as the value), + the endpoint treats each request as independent. + + For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + plan_variation_id : typing.Optional[str] + The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. + + start_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date to start the subscription. + If it is unspecified, the subscription starts immediately. + + canceled_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. + + This date overrides the cancellation date set in the plan variation configuration. + If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops + at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. + + When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` + occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription + stops through the end of the last cycle. + + tax_percentage : typing.Optional[str] + The tax to add when billing the subscription. + The percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of 7.5 + corresponds to 7.5%. + + price_override_money : typing.Optional[MoneyParams] + A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. + This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, + you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + + card_id : typing.Optional[str] + The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge. + If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription. + + timezone : typing.Optional[str] + The timezone that is used in date calculations for the subscription. If unset, defaults to + the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". + Format: the IANA Timezone Database identifier for the location timezone. For + a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + + source : typing.Optional[SubscriptionSourceParams] + The origination details of the subscription. + + monthly_billing_anchor_date : typing.Optional[int] + The day-of-the-month to change the billing date to. + + phases : typing.Optional[typing.Sequence[PhaseParams]] + array of phases for this subscription + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/subscriptions", + method="POST", + json={ + "idempotency_key": idempotency_key, + "location_id": location_id, + "plan_variation_id": plan_variation_id, + "customer_id": customer_id, + "start_date": start_date, + "canceled_date": canceled_date, + "tax_percentage": tax_percentage, + "price_override_money": convert_and_respect_annotation_metadata( + object_=price_override_money, annotation=MoneyParams, direction="write" + ), + "card_id": card_id, + "timezone": timezone, + "source": convert_and_respect_annotation_metadata( + object_=source, annotation=SubscriptionSourceParams, direction="write" + ), + "monthly_billing_anchor_date": monthly_billing_anchor_date, + "phases": convert_and_respect_annotation_metadata( + object_=phases, annotation=typing.Sequence[PhaseParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateSubscriptionResponse, + construct_type( + type_=CreateSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def bulk_swap_plan( + self, + *, + new_plan_variation_id: str, + old_plan_variation_id: str, + location_id: str, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkSwapPlanResponse]: + """ + Schedules a plan variation change for all active subscriptions under a given plan + variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + new_plan_variation_id : str + The ID of the new subscription plan variation. + + This field is required. + + old_plan_variation_id : str + The ID of the plan variation whose subscriptions should be swapped. Active subscriptions + using this plan variation will be subscribed to the new plan variation on their next billing + day. + + location_id : str + The ID of the location to associate with the swapped subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkSwapPlanResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/subscriptions/bulk-swap-plan", + method="POST", + json={ + "new_plan_variation_id": new_plan_variation_id, + "old_plan_variation_id": old_plan_variation_id, + "location_id": location_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkSwapPlanResponse, + construct_type( + type_=BulkSwapPlanResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + query: typing.Optional[SearchSubscriptionsQueryParams] = OMIT, + include: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchSubscriptionsResponse]: + """ + Searches for subscriptions. + + Results are ordered chronologically by subscription creation date. If + the request specifies more than one location ID, + the endpoint orders the result + by location ID, and then by creation date within each location. If no locations are given + in the query, all locations are searched. + + You can also optionally specify `customer_ids` to search by customer. + If left unset, all customers + associated with the specified locations are returned. + If the request specifies customer IDs, the endpoint orders results + first by location, within location by customer ID, and within + customer by subscription creation date. + + Parameters + ---------- + cursor : typing.Optional[str] + When the total number of resulting subscriptions exceeds the limit of a paged response, + specify the cursor returned from a preceding response here to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + limit : typing.Optional[int] + The upper limit on the number of subscriptions to return + in a paged response. + + query : typing.Optional[SearchSubscriptionsQueryParams] + A subscription query consisting of specified filtering conditions. + + If this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions. + + include : typing.Optional[typing.Sequence[str]] + An option to include related information in the response. + + The supported values are: + + - `actions`: to include scheduled actions on the targeted subscriptions. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchSubscriptionsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/subscriptions/search", + method="POST", + json={ + "cursor": cursor, + "limit": limit, + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchSubscriptionsQueryParams, direction="write" + ), + "include": include, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchSubscriptionsResponse, + construct_type( + type_=SearchSubscriptionsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, + subscription_id: str, + *, + include: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[GetSubscriptionResponse]: + """ + Retrieves a specific subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to retrieve. + + include : typing.Optional[str] + A query parameter to specify related information to be included in the response. + + The supported query parameter values are: + + - `actions`: to include scheduled actions on the targeted subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}", + method="GET", + params={ + "include": include, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetSubscriptionResponse, + construct_type( + type_=GetSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[SubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateSubscriptionResponse]: + """ + Updates a subscription by modifying or clearing `subscription` field values. + To clear a field, set its value to `null`. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update. + + subscription : typing.Optional[SubscriptionParams] + The subscription object containing the current version, and fields to update. + Unset fields will be left at their current server values, and JSON `null` values will + be treated as a request to clear the relevant data. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}", + method="PUT", + json={ + "subscription": convert_and_respect_annotation_metadata( + object_=subscription, annotation=SubscriptionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateSubscriptionResponse, + construct_type( + type_=UpdateSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete_action( + self, subscription_id: str, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteSubscriptionActionResponse]: + """ + Deletes a scheduled action for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription the targeted action is to act upon. + + action_id : str + The ID of the targeted action to be deleted. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteSubscriptionActionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/actions/{jsonable_encoder(action_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteSubscriptionActionResponse, + construct_type( + type_=DeleteSubscriptionActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def change_billing_anchor_date( + self, + subscription_id: str, + *, + monthly_billing_anchor_date: typing.Optional[int] = OMIT, + effective_date: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ChangeBillingAnchorDateResponse]: + """ + Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) + for a subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to update the billing anchor date. + + monthly_billing_anchor_date : typing.Optional[int] + The anchor day for the billing cycle. + + effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes + place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the billing anchor date + is changed immediately. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ChangeBillingAnchorDateResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/billing-anchor", + method="POST", + json={ + "monthly_billing_anchor_date": monthly_billing_anchor_date, + "effective_date": effective_date, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ChangeBillingAnchorDateResponse, + construct_type( + type_=ChangeBillingAnchorDateResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelSubscriptionResponse]: + """ + Schedules a `CANCEL` action to cancel an active subscription. This + sets the `canceled_date` field to the end of the active billing period. After this date, + the subscription status changes from ACTIVE to CANCELED. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to cancel. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelSubscriptionResponse, + construct_type( + type_=CancelSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def pause( + self, + subscription_id: str, + *, + pause_effective_date: typing.Optional[str] = OMIT, + pause_cycle_duration: typing.Optional[int] = OMIT, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + pause_reason: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[PauseSubscriptionResponse]: + """ + Schedules a `PAUSE` action to pause an active subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to pause. + + pause_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. + + When this date is unspecified or falls within the current billing cycle, the subscription is paused + on the starting date of the next billing cycle. + + pause_cycle_duration : typing.Optional[int] + The number of billing cycles the subscription will be paused before it is reactivated. + + When this is set, a `RESUME` action is also scheduled to take place on the subscription at + the end of the specified pause cycle duration. In this case, neither `resume_effective_date` + nor `resume_change_timing` may be specified. + + resume_effective_date : typing.Optional[str] + The date when the subscription is reactivated by a scheduled `RESUME` action. + This date must be at least one billing cycle ahead of `pause_effective_date`. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to + `resume_effective_date`. + See [ChangeTiming](#type-changetiming) for possible values + + pause_reason : typing.Optional[str] + The user-provided reason to pause the subscription. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[PauseSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/pause", + method="POST", + json={ + "pause_effective_date": pause_effective_date, + "pause_cycle_duration": pause_cycle_duration, + "resume_effective_date": resume_effective_date, + "resume_change_timing": resume_change_timing, + "pause_reason": pause_reason, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PauseSubscriptionResponse, + construct_type( + type_=PauseSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def resume( + self, + subscription_id: str, + *, + resume_effective_date: typing.Optional[str] = OMIT, + resume_change_timing: typing.Optional[ChangeTiming] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ResumeSubscriptionResponse]: + """ + Schedules a `RESUME` action to resume a paused or a deactivated subscription. + + Parameters + ---------- + subscription_id : str + The ID of the subscription to resume. + + resume_effective_date : typing.Optional[str] + The `YYYY-MM-DD`-formatted date when the subscription reactivated. + + resume_change_timing : typing.Optional[ChangeTiming] + The timing to resume a subscription, relative to the specified + `resume_effective_date` attribute value. + See [ChangeTiming](#type-changetiming) for possible values + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ResumeSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/resume", + method="POST", + json={ + "resume_effective_date": resume_effective_date, + "resume_change_timing": resume_change_timing, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ResumeSubscriptionResponse, + construct_type( + type_=ResumeSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def swap_plan( + self, + subscription_id: str, + *, + new_plan_variation_id: typing.Optional[str] = OMIT, + phases: typing.Optional[typing.Sequence[PhaseInputParams]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SwapPlanResponse]: + """ + Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. + For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations). + + Parameters + ---------- + subscription_id : str + The ID of the subscription to swap the subscription plan for. + + new_plan_variation_id : typing.Optional[str] + The ID of the new subscription plan variation. + + This field is required. + + phases : typing.Optional[typing.Sequence[PhaseInputParams]] + A list of PhaseInputs, to pass phase-specific information used in the swap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SwapPlanResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/subscriptions/{jsonable_encoder(subscription_id)}/swap-plan", + method="POST", + json={ + "new_plan_variation_id": new_plan_variation_id, + "phases": convert_and_respect_annotation_metadata( + object_=phases, annotation=typing.Optional[typing.Sequence[PhaseInputParams]], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SwapPlanResponse, + construct_type( + type_=SwapPlanResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/team/__init__.py b/src/square/team/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/team/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/team/client.py b/src/square/team/client.py new file mode 100644 index 00000000..67504970 --- /dev/null +++ b/src/square/team/client.py @@ -0,0 +1,376 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawTeamClient +from ..core.request_options import RequestOptions +from ..types.list_jobs_response import ListJobsResponse +from ..requests.job import JobParams +from ..types.create_job_response import CreateJobResponse +from ..types.retrieve_job_response import RetrieveJobResponse +from ..types.update_job_response import UpdateJobResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawTeamClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class TeamClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTeamClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTeamClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTeamClient + """ + return self._raw_client + + def list_jobs( + self, *, cursor: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> ListJobsResponse: + """ + Lists jobs in a seller account. Results are sorted by title in ascending order. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned by the previous call to this endpoint. Provide this + cursor to retrieve the next page of results for your original request. For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListJobsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team.list_jobs() + """ + response = self._raw_client.list_jobs(cursor=cursor, request_options=request_options) + return response.data + + def create_job( + self, *, job: JobParams, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> CreateJobResponse: + """ + Creates a job in a seller account. A job defines a title and tip eligibility. Note that + compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting. + + Parameters + ---------- + job : JobParams + The job to create. The `title` field is required and `is_tip_eligible` defaults to true. + + idempotency_key : str + A unique identifier for the `CreateJob` request. Keys can be any valid string, + but must be unique for each request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateJobResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team.create_job( + job={"title": "Cashier", "is_tip_eligible": True}, + idempotency_key="idempotency-key-0", + ) + """ + response = self._raw_client.create_job( + job=job, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def retrieve_job( + self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveJobResponse: + """ + Retrieves a specified job. + + Parameters + ---------- + job_id : str + The ID of the job to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveJobResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team.retrieve_job( + job_id="job_id", + ) + """ + response = self._raw_client.retrieve_job(job_id, request_options=request_options) + return response.data + + def update_job( + self, job_id: str, *, job: JobParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateJobResponse: + """ + Updates the title or tip eligibility of a job. Changes to the title propagate to all + `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to + tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID. + + Parameters + ---------- + job_id : str + The ID of the job to update. + + job : JobParams + The job with the updated fields, either `title`, `is_tip_eligible`, or both. Only changed fields need + to be included in the request. Optionally include `version` to enable optimistic concurrency control. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateJobResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team.update_job( + job_id="job_id", + job={"title": "Cashier 1", "is_tip_eligible": True}, + ) + """ + response = self._raw_client.update_job(job_id, job=job, request_options=request_options) + return response.data + + +class AsyncTeamClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTeamClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTeamClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTeamClient + """ + return self._raw_client + + async def list_jobs( + self, *, cursor: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> ListJobsResponse: + """ + Lists jobs in a seller account. Results are sorted by title in ascending order. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned by the previous call to this endpoint. Provide this + cursor to retrieve the next page of results for your original request. For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListJobsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team.list_jobs() + + + asyncio.run(main()) + """ + response = await self._raw_client.list_jobs(cursor=cursor, request_options=request_options) + return response.data + + async def create_job( + self, *, job: JobParams, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> CreateJobResponse: + """ + Creates a job in a seller account. A job defines a title and tip eligibility. Note that + compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting. + + Parameters + ---------- + job : JobParams + The job to create. The `title` field is required and `is_tip_eligible` defaults to true. + + idempotency_key : str + A unique identifier for the `CreateJob` request. Keys can be any valid string, + but must be unique for each request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateJobResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team.create_job( + job={"title": "Cashier", "is_tip_eligible": True}, + idempotency_key="idempotency-key-0", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create_job( + job=job, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def retrieve_job( + self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> RetrieveJobResponse: + """ + Retrieves a specified job. + + Parameters + ---------- + job_id : str + The ID of the job to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + RetrieveJobResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team.retrieve_job( + job_id="job_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.retrieve_job(job_id, request_options=request_options) + return response.data + + async def update_job( + self, job_id: str, *, job: JobParams, request_options: typing.Optional[RequestOptions] = None + ) -> UpdateJobResponse: + """ + Updates the title or tip eligibility of a job. Changes to the title propagate to all + `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to + tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID. + + Parameters + ---------- + job_id : str + The ID of the job to update. + + job : JobParams + The job with the updated fields, either `title`, `is_tip_eligible`, or both. Only changed fields need + to be included in the request. Optionally include `version` to enable optimistic concurrency control. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateJobResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team.update_job( + job_id="job_id", + job={"title": "Cashier 1", "is_tip_eligible": True}, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update_job(job_id, job=job, request_options=request_options) + return response.data diff --git a/src/square/team/raw_client.py b/src/square/team/raw_client.py new file mode 100644 index 00000000..f614e329 --- /dev/null +++ b/src/square/team/raw_client.py @@ -0,0 +1,407 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.list_jobs_response import ListJobsResponse +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.job import JobParams +from ..types.create_job_response import CreateJobResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..types.retrieve_job_response import RetrieveJobResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_job_response import UpdateJobResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawTeamClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list_jobs( + self, *, cursor: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ListJobsResponse]: + """ + Lists jobs in a seller account. Results are sorted by title in ascending order. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned by the previous call to this endpoint. Provide this + cursor to retrieve the next page of results for your original request. For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListJobsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/team-members/jobs", + method="GET", + params={ + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListJobsResponse, + construct_type( + type_=ListJobsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create_job( + self, *, job: JobParams, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CreateJobResponse]: + """ + Creates a job in a seller account. A job defines a title and tip eligibility. Note that + compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting. + + Parameters + ---------- + job : JobParams + The job to create. The `title` field is required and `is_tip_eligible` defaults to true. + + idempotency_key : str + A unique identifier for the `CreateJob` request. Keys can be any valid string, + but must be unique for each request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateJobResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/team-members/jobs", + method="POST", + json={ + "job": convert_and_respect_annotation_metadata(object_=job, annotation=JobParams, direction="write"), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateJobResponse, + construct_type( + type_=CreateJobResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def retrieve_job( + self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RetrieveJobResponse]: + """ + Retrieves a specified job. + + Parameters + ---------- + job_id : str + The ID of the job to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RetrieveJobResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/team-members/jobs/{jsonable_encoder(job_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveJobResponse, + construct_type( + type_=RetrieveJobResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update_job( + self, job_id: str, *, job: JobParams, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[UpdateJobResponse]: + """ + Updates the title or tip eligibility of a job. Changes to the title propagate to all + `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to + tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID. + + Parameters + ---------- + job_id : str + The ID of the job to update. + + job : JobParams + The job with the updated fields, either `title`, `is_tip_eligible`, or both. Only changed fields need + to be included in the request. Optionally include `version` to enable optimistic concurrency control. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateJobResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/team-members/jobs/{jsonable_encoder(job_id)}", + method="PUT", + json={ + "job": convert_and_respect_annotation_metadata(object_=job, annotation=JobParams, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateJobResponse, + construct_type( + type_=UpdateJobResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawTeamClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list_jobs( + self, *, cursor: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ListJobsResponse]: + """ + Lists jobs in a seller account. Results are sorted by title in ascending order. + + Parameters + ---------- + cursor : typing.Optional[str] + The pagination cursor returned by the previous call to this endpoint. Provide this + cursor to retrieve the next page of results for your original request. For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListJobsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/team-members/jobs", + method="GET", + params={ + "cursor": cursor, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListJobsResponse, + construct_type( + type_=ListJobsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create_job( + self, *, job: JobParams, idempotency_key: str, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CreateJobResponse]: + """ + Creates a job in a seller account. A job defines a title and tip eligibility. Note that + compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting. + + Parameters + ---------- + job : JobParams + The job to create. The `title` field is required and `is_tip_eligible` defaults to true. + + idempotency_key : str + A unique identifier for the `CreateJob` request. Keys can be any valid string, + but must be unique for each request. For more information, see + [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateJobResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/team-members/jobs", + method="POST", + json={ + "job": convert_and_respect_annotation_metadata(object_=job, annotation=JobParams, direction="write"), + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateJobResponse, + construct_type( + type_=CreateJobResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def retrieve_job( + self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RetrieveJobResponse]: + """ + Retrieves a specified job. + + Parameters + ---------- + job_id : str + The ID of the job to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RetrieveJobResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/team-members/jobs/{jsonable_encoder(job_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RetrieveJobResponse, + construct_type( + type_=RetrieveJobResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update_job( + self, job_id: str, *, job: JobParams, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[UpdateJobResponse]: + """ + Updates the title or tip eligibility of a job. Changes to the title propagate to all + `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to + tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID. + + Parameters + ---------- + job_id : str + The ID of the job to update. + + job : JobParams + The job with the updated fields, either `title`, `is_tip_eligible`, or both. Only changed fields need + to be included in the request. Optionally include `version` to enable optimistic concurrency control. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateJobResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/team-members/jobs/{jsonable_encoder(job_id)}", + method="PUT", + json={ + "job": convert_and_respect_annotation_metadata(object_=job, annotation=JobParams, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateJobResponse, + construct_type( + type_=UpdateJobResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/team_members/__init__.py b/src/square/team_members/__init__.py new file mode 100644 index 00000000..437b8e02 --- /dev/null +++ b/src/square/team_members/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import wage_setting + +__all__ = ["wage_setting"] diff --git a/src/square/team_members/client.py b/src/square/team_members/client.py new file mode 100644 index 00000000..75ba050f --- /dev/null +++ b/src/square/team_members/client.py @@ -0,0 +1,869 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawTeamMembersClient +from .wage_setting.client import WageSettingClient +from ..requests.team_member import TeamMemberParams +from ..core.request_options import RequestOptions +from ..types.create_team_member_response import CreateTeamMemberResponse +from ..requests.create_team_member_request import CreateTeamMemberRequestParams +from ..types.batch_create_team_members_response import BatchCreateTeamMembersResponse +from ..requests.update_team_member_request import UpdateTeamMemberRequestParams +from ..types.batch_update_team_members_response import BatchUpdateTeamMembersResponse +from ..requests.search_team_members_query import SearchTeamMembersQueryParams +from ..types.search_team_members_response import SearchTeamMembersResponse +from ..types.get_team_member_response import GetTeamMemberResponse +from ..types.update_team_member_response import UpdateTeamMemberResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawTeamMembersClient +from .wage_setting.client import AsyncWageSettingClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class TeamMembersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTeamMembersClient(client_wrapper=client_wrapper) + self.wage_setting = WageSettingClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTeamMembersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTeamMembersClient + """ + return self._raw_client + + def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTeamMemberResponse: + """ + Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates. + You must provide the following values in your request to this endpoint: + - `given_name` + - `family_name` + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember). + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateTeamMember` request. + Keys can be any valid string, but must be unique for every request. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + The minimum length is 1 and the maximum length is 45. + + team_member : typing.Optional[TeamMemberParams] + **Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTeamMemberResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.create( + idempotency_key="idempotency-key-0", + team_member={ + "reference_id": "reference_id_1", + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + "wage_setting": { + "job_assignments": [ + { + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + }, + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2000, "currency": "USD"}, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + }, + ], + "is_overtime_exempt": True, + }, + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, team_member=team_member, request_options=request_options + ) + return response.data + + def batch_create( + self, + *, + team_members: typing.Dict[str, CreateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchCreateTeamMembersResponse: + """ + Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates. + This process is non-transactional and processes as much of the request as possible. If one of the creates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed create. + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, CreateTeamMemberRequestParams] + The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + The maximum number of create objects is 25. + + If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, + call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchCreateTeamMembersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.batch_create( + team_members={ + "idempotency-key-1": { + "team_member": { + "reference_id": "reference_id_1", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + } + }, + "idempotency-key-2": { + "team_member": { + "reference_id": "reference_id_2", + "given_name": "Jane", + "family_name": "Smith", + "email_address": "jane_smith@gmail.com", + "phone_number": "+14159223334", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + } + }, + }, + ) + """ + response = self._raw_client.batch_create(team_members=team_members, request_options=request_options) + return response.data + + def batch_update( + self, + *, + team_members: typing.Dict[str, UpdateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpdateTeamMembersResponse: + """ + Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates. + This process is non-transactional and processes as much of the request as possible. If one of the updates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed update. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, UpdateTeamMemberRequestParams] + The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + The maximum number of update objects is 25. + + For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. + To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, + call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpdateTeamMembersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.batch_update( + team_members={ + "AFMwA08kR-MIF-3Vs0OE": { + "team_member": { + "reference_id": "reference_id_2", + "is_owner": False, + "status": "ACTIVE", + "given_name": "Jane", + "family_name": "Smith", + "email_address": "jane_smith@gmail.com", + "phone_number": "+14159223334", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + } + }, + "fpgteZNMaf0qOK-a4t6P": { + "team_member": { + "reference_id": "reference_id_1", + "is_owner": False, + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + } + }, + }, + ) + """ + response = self._raw_client.batch_update(team_members=team_members, request_options=request_options) + return response.data + + def search( + self, + *, + query: typing.Optional[SearchTeamMembersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTeamMembersResponse: + """ + Returns a paginated list of `TeamMember` objects for a business. + The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether + the team member is the Square account owner. + + Parameters + ---------- + query : typing.Optional[SearchTeamMembersQueryParams] + The query parameters. + + limit : typing.Optional[int] + The maximum number of `TeamMember` objects in a page (100 by default). + + cursor : typing.Optional[str] + The opaque cursor for fetching the next page. For more information, see + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTeamMembersResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.search( + query={"filter": {"location_ids": ["0G5P3VGACMMQZ"], "status": "ACTIVE"}}, + limit=10, + ) + """ + response = self._raw_client.search(query=query, limit=limit, cursor=cursor, request_options=request_options) + return response.data + + def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTeamMemberResponse: + """ + Retrieves a `TeamMember` object for the given `TeamMember.id`. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTeamMemberResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.get( + team_member_id="team_member_id", + ) + """ + response = self._raw_client.get(team_member_id, request_options=request_options) + return response.data + + def update( + self, + team_member_id: str, + *, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateTeamMemberResponse: + """ + Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to update. + + team_member : typing.Optional[TeamMemberParams] + The team member fields to add, change, or clear. Fields can be cleared using a null value. To update + `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateTeamMemberResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.update( + team_member_id="team_member_id", + team_member={ + "reference_id": "reference_id_1", + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + "wage_setting": { + "job_assignments": [ + { + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + }, + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 1200, "currency": "USD"}, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + }, + ], + "is_overtime_exempt": True, + }, + }, + ) + """ + response = self._raw_client.update(team_member_id, team_member=team_member, request_options=request_options) + return response.data + + +class AsyncTeamMembersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTeamMembersClient(client_wrapper=client_wrapper) + self.wage_setting = AsyncWageSettingClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTeamMembersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTeamMembersClient + """ + return self._raw_client + + async def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTeamMemberResponse: + """ + Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates. + You must provide the following values in your request to this endpoint: + - `given_name` + - `family_name` + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember). + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateTeamMember` request. + Keys can be any valid string, but must be unique for every request. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + The minimum length is 1 and the maximum length is 45. + + team_member : typing.Optional[TeamMemberParams] + **Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTeamMemberResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.create( + idempotency_key="idempotency-key-0", + team_member={ + "reference_id": "reference_id_1", + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + "wage_setting": { + "job_assignments": [ + { + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + }, + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2000, "currency": "USD"}, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + }, + ], + "is_overtime_exempt": True, + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, team_member=team_member, request_options=request_options + ) + return response.data + + async def batch_create( + self, + *, + team_members: typing.Dict[str, CreateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchCreateTeamMembersResponse: + """ + Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates. + This process is non-transactional and processes as much of the request as possible. If one of the creates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed create. + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, CreateTeamMemberRequestParams] + The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + The maximum number of create objects is 25. + + If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, + call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchCreateTeamMembersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.batch_create( + team_members={ + "idempotency-key-1": { + "team_member": { + "reference_id": "reference_id_1", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + } + }, + "idempotency-key-2": { + "team_member": { + "reference_id": "reference_id_2", + "given_name": "Jane", + "family_name": "Smith", + "email_address": "jane_smith@gmail.com", + "phone_number": "+14159223334", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + } + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_create(team_members=team_members, request_options=request_options) + return response.data + + async def batch_update( + self, + *, + team_members: typing.Dict[str, UpdateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpdateTeamMembersResponse: + """ + Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates. + This process is non-transactional and processes as much of the request as possible. If one of the updates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed update. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, UpdateTeamMemberRequestParams] + The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + The maximum number of update objects is 25. + + For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. + To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, + call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpdateTeamMembersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.batch_update( + team_members={ + "AFMwA08kR-MIF-3Vs0OE": { + "team_member": { + "reference_id": "reference_id_2", + "is_owner": False, + "status": "ACTIVE", + "given_name": "Jane", + "family_name": "Smith", + "email_address": "jane_smith@gmail.com", + "phone_number": "+14159223334", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS" + }, + } + }, + "fpgteZNMaf0qOK-a4t6P": { + "team_member": { + "reference_id": "reference_id_1", + "is_owner": False, + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + } + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_update(team_members=team_members, request_options=request_options) + return response.data + + async def search( + self, + *, + query: typing.Optional[SearchTeamMembersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTeamMembersResponse: + """ + Returns a paginated list of `TeamMember` objects for a business. + The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether + the team member is the Square account owner. + + Parameters + ---------- + query : typing.Optional[SearchTeamMembersQueryParams] + The query parameters. + + limit : typing.Optional[int] + The maximum number of `TeamMember` objects in a page (100 by default). + + cursor : typing.Optional[str] + The opaque cursor for fetching the next page. For more information, see + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTeamMembersResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.search( + query={ + "filter": {"location_ids": ["0G5P3VGACMMQZ"], "status": "ACTIVE"} + }, + limit=10, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, limit=limit, cursor=cursor, request_options=request_options + ) + return response.data + + async def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTeamMemberResponse: + """ + Retrieves a `TeamMember` object for the given `TeamMember.id`. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTeamMemberResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.get( + team_member_id="team_member_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(team_member_id, request_options=request_options) + return response.data + + async def update( + self, + team_member_id: str, + *, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateTeamMemberResponse: + """ + Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to update. + + team_member : typing.Optional[TeamMemberParams] + The team member fields to add, change, or clear. Fields can be cleared using a null value. To update + `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateTeamMemberResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.update( + team_member_id="team_member_id", + team_member={ + "reference_id": "reference_id_1", + "status": "ACTIVE", + "given_name": "Joe", + "family_name": "Doe", + "email_address": "joe_doe@gmail.com", + "phone_number": "+14159283333", + "assigned_locations": { + "assignment_type": "EXPLICIT_LOCATIONS", + "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"], + }, + "wage_setting": { + "job_assignments": [ + { + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + "job_id": "FjS8x95cqHiMenw4f1NAUH4P", + }, + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 1200, "currency": "USD"}, + "job_id": "VDNpRv8da51NU8qZFC5zDWpF", + }, + ], + "is_overtime_exempt": True, + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + team_member_id, team_member=team_member, request_options=request_options + ) + return response.data diff --git a/src/square/team_members/raw_client.py b/src/square/team_members/raw_client.py new file mode 100644 index 00000000..5be92401 --- /dev/null +++ b/src/square/team_members/raw_client.py @@ -0,0 +1,720 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.team_member import TeamMemberParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.create_team_member_response import CreateTeamMemberResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..requests.create_team_member_request import CreateTeamMemberRequestParams +from ..types.batch_create_team_members_response import BatchCreateTeamMembersResponse +from ..requests.update_team_member_request import UpdateTeamMemberRequestParams +from ..types.batch_update_team_members_response import BatchUpdateTeamMembersResponse +from ..requests.search_team_members_query import SearchTeamMembersQueryParams +from ..types.search_team_members_response import SearchTeamMembersResponse +from ..types.get_team_member_response import GetTeamMemberResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_team_member_response import UpdateTeamMemberResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawTeamMembersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateTeamMemberResponse]: + """ + Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates. + You must provide the following values in your request to this endpoint: + - `given_name` + - `family_name` + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember). + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateTeamMember` request. + Keys can be any valid string, but must be unique for every request. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + The minimum length is 1 and the maximum length is 45. + + team_member : typing.Optional[TeamMemberParams] + **Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateTeamMemberResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/team-members", + method="POST", + json={ + "idempotency_key": idempotency_key, + "team_member": convert_and_respect_annotation_metadata( + object_=team_member, annotation=TeamMemberParams, direction="write" + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTeamMemberResponse, + construct_type( + type_=CreateTeamMemberResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_create( + self, + *, + team_members: typing.Dict[str, CreateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchCreateTeamMembersResponse]: + """ + Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates. + This process is non-transactional and processes as much of the request as possible. If one of the creates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed create. + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, CreateTeamMemberRequestParams] + The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + The maximum number of create objects is 25. + + If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, + call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchCreateTeamMembersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/team-members/bulk-create", + method="POST", + json={ + "team_members": convert_and_respect_annotation_metadata( + object_=team_members, annotation=typing.Dict[str, CreateTeamMemberRequestParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchCreateTeamMembersResponse, + construct_type( + type_=BatchCreateTeamMembersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_update( + self, + *, + team_members: typing.Dict[str, UpdateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchUpdateTeamMembersResponse]: + """ + Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates. + This process is non-transactional and processes as much of the request as possible. If one of the updates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed update. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, UpdateTeamMemberRequestParams] + The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + The maximum number of update objects is 25. + + For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. + To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, + call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchUpdateTeamMembersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/team-members/bulk-update", + method="POST", + json={ + "team_members": convert_and_respect_annotation_metadata( + object_=team_members, annotation=typing.Dict[str, UpdateTeamMemberRequestParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpdateTeamMembersResponse, + construct_type( + type_=BatchUpdateTeamMembersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[SearchTeamMembersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchTeamMembersResponse]: + """ + Returns a paginated list of `TeamMember` objects for a business. + The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether + the team member is the Square account owner. + + Parameters + ---------- + query : typing.Optional[SearchTeamMembersQueryParams] + The query parameters. + + limit : typing.Optional[int] + The maximum number of `TeamMember` objects in a page (100 by default). + + cursor : typing.Optional[str] + The opaque cursor for fetching the next page. For more information, see + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchTeamMembersResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/team-members/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchTeamMembersQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTeamMembersResponse, + construct_type( + type_=SearchTeamMembersResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTeamMemberResponse]: + """ + Retrieves a `TeamMember` object for the given `TeamMember.id`. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTeamMemberResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTeamMemberResponse, + construct_type( + type_=GetTeamMemberResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + team_member_id: str, + *, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateTeamMemberResponse]: + """ + Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to update. + + team_member : typing.Optional[TeamMemberParams] + The team member fields to add, change, or clear. Fields can be cleared using a null value. To update + `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateTeamMemberResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}", + method="PUT", + json={ + "team_member": convert_and_respect_annotation_metadata( + object_=team_member, annotation=TeamMemberParams, direction="write" + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateTeamMemberResponse, + construct_type( + type_=UpdateTeamMemberResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawTeamMembersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: typing.Optional[str] = OMIT, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateTeamMemberResponse]: + """ + Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates. + You must provide the following values in your request to this endpoint: + - `given_name` + - `family_name` + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember). + + Parameters + ---------- + idempotency_key : typing.Optional[str] + A unique string that identifies this `CreateTeamMember` request. + Keys can be any valid string, but must be unique for every request. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + The minimum length is 1 and the maximum length is 45. + + team_member : typing.Optional[TeamMemberParams] + **Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateTeamMemberResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/team-members", + method="POST", + json={ + "idempotency_key": idempotency_key, + "team_member": convert_and_respect_annotation_metadata( + object_=team_member, annotation=TeamMemberParams, direction="write" + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTeamMemberResponse, + construct_type( + type_=CreateTeamMemberResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_create( + self, + *, + team_members: typing.Dict[str, CreateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchCreateTeamMembersResponse]: + """ + Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates. + This process is non-transactional and processes as much of the request as possible. If one of the creates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed create. + + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, CreateTeamMemberRequestParams] + The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + The maximum number of create objects is 25. + + If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, + call [ListJobs](api-endpoint:Team-ListJobs). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchCreateTeamMembersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/team-members/bulk-create", + method="POST", + json={ + "team_members": convert_and_respect_annotation_metadata( + object_=team_members, annotation=typing.Dict[str, CreateTeamMemberRequestParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchCreateTeamMembersResponse, + construct_type( + type_=BatchCreateTeamMembersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_update( + self, + *, + team_members: typing.Dict[str, UpdateTeamMemberRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchUpdateTeamMembersResponse]: + """ + Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates. + This process is non-transactional and processes as much of the request as possible. If one of the updates in + the request cannot be successfully processed, the request is not marked as failed, but the body of the response + contains explicit error information for the failed update. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members). + + Parameters + ---------- + team_members : typing.Dict[str, UpdateTeamMemberRequestParams] + The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + The maximum number of update objects is 25. + + For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. + To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, + call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchUpdateTeamMembersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/team-members/bulk-update", + method="POST", + json={ + "team_members": convert_and_respect_annotation_metadata( + object_=team_members, annotation=typing.Dict[str, UpdateTeamMemberRequestParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpdateTeamMembersResponse, + construct_type( + type_=BatchUpdateTeamMembersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[SearchTeamMembersQueryParams] = OMIT, + limit: typing.Optional[int] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchTeamMembersResponse]: + """ + Returns a paginated list of `TeamMember` objects for a business. + The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether + the team member is the Square account owner. + + Parameters + ---------- + query : typing.Optional[SearchTeamMembersQueryParams] + The query parameters. + + limit : typing.Optional[int] + The maximum number of `TeamMember` objects in a page (100 by default). + + cursor : typing.Optional[str] + The opaque cursor for fetching the next page. For more information, see + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchTeamMembersResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/team-members/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=SearchTeamMembersQueryParams, direction="write" + ), + "limit": limit, + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTeamMembersResponse, + construct_type( + type_=SearchTeamMembersResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTeamMemberResponse]: + """ + Retrieves a `TeamMember` object for the given `TeamMember.id`. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTeamMemberResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTeamMemberResponse, + construct_type( + type_=GetTeamMemberResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + team_member_id: str, + *, + team_member: typing.Optional[TeamMemberParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateTeamMemberResponse]: + """ + Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. + Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member). + + Parameters + ---------- + team_member_id : str + The ID of the team member to update. + + team_member : typing.Optional[TeamMemberParams] + The team member fields to add, change, or clear. Fields can be cleared using a null value. To update + `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateTeamMemberResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}", + method="PUT", + json={ + "team_member": convert_and_respect_annotation_metadata( + object_=team_member, annotation=TeamMemberParams, direction="write" + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateTeamMemberResponse, + construct_type( + type_=UpdateTeamMemberResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/team_members/wage_setting/__init__.py b/src/square/team_members/wage_setting/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/team_members/wage_setting/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/team_members/wage_setting/client.py b/src/square/team_members/wage_setting/client.py new file mode 100644 index 00000000..d355d32f --- /dev/null +++ b/src/square/team_members/wage_setting/client.py @@ -0,0 +1,274 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawWageSettingClient +from ...core.request_options import RequestOptions +from ...types.get_wage_setting_response import GetWageSettingResponse +from ...requests.wage_setting import WageSettingParams +from ...types.update_wage_setting_response import UpdateWageSettingResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawWageSettingClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class WageSettingClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawWageSettingClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawWageSettingClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawWageSettingClient + """ + return self._raw_client + + def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetWageSettingResponse: + """ + Retrieves a `WageSetting` object for a team member specified + by `TeamMember.id`. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). + + Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) + to get this information directly from the `TeamMember.wage_setting` field. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to retrieve the wage setting. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetWageSettingResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.wage_setting.get( + team_member_id="team_member_id", + ) + """ + response = self._raw_client.get(team_member_id, request_options=request_options) + return response.data + + def update( + self, + team_member_id: str, + *, + wage_setting: WageSettingParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateWageSettingResponse: + """ + Creates or updates a `WageSetting` object. The object is created if a + `WageSetting` with the specified `team_member_id` doesn't exist. Otherwise, + it fully replaces the `WageSetting` object for the team member. + The `WageSetting` is returned on a successful update. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting). + + Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember) + to manage the `TeamMember.wage_setting` field directly. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to update the `WageSetting` object. + + wage_setting : WageSettingParams + The complete `WageSetting` object. For all job assignments, specify one of the following: + - `job_id` (recommended) - If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get a list of all jobs. + Requires Square API version 2024-12-18 or later. + - `job_title` - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job. + This value is ignored if `job_id` is also provided. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWageSettingResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.team_members.wage_setting.update( + team_member_id="team_member_id", + wage_setting={ + "job_assignments": [ + { + "job_title": "Manager", + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + }, + { + "job_title": "Cashier", + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2000, "currency": "USD"}, + }, + ], + "is_overtime_exempt": True, + }, + ) + """ + response = self._raw_client.update(team_member_id, wage_setting=wage_setting, request_options=request_options) + return response.data + + +class AsyncWageSettingClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawWageSettingClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawWageSettingClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawWageSettingClient + """ + return self._raw_client + + async def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetWageSettingResponse: + """ + Retrieves a `WageSetting` object for a team member specified + by `TeamMember.id`. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). + + Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) + to get this information directly from the `TeamMember.wage_setting` field. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to retrieve the wage setting. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetWageSettingResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.wage_setting.get( + team_member_id="team_member_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(team_member_id, request_options=request_options) + return response.data + + async def update( + self, + team_member_id: str, + *, + wage_setting: WageSettingParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateWageSettingResponse: + """ + Creates or updates a `WageSetting` object. The object is created if a + `WageSetting` with the specified `team_member_id` doesn't exist. Otherwise, + it fully replaces the `WageSetting` object for the team member. + The `WageSetting` is returned on a successful update. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting). + + Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember) + to manage the `TeamMember.wage_setting` field directly. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to update the `WageSetting` object. + + wage_setting : WageSettingParams + The complete `WageSetting` object. For all job assignments, specify one of the following: + - `job_id` (recommended) - If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get a list of all jobs. + Requires Square API version 2024-12-18 or later. + - `job_title` - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job. + This value is ignored if `job_id` is also provided. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWageSettingResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.team_members.wage_setting.update( + team_member_id="team_member_id", + wage_setting={ + "job_assignments": [ + { + "job_title": "Manager", + "pay_type": "SALARY", + "annual_rate": {"amount": 3000000, "currency": "USD"}, + "weekly_hours": 40, + }, + { + "job_title": "Cashier", + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2000, "currency": "USD"}, + }, + ], + "is_overtime_exempt": True, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + team_member_id, wage_setting=wage_setting, request_options=request_options + ) + return response.data diff --git a/src/square/team_members/wage_setting/raw_client.py b/src/square/team_members/wage_setting/raw_client.py new file mode 100644 index 00000000..ba1be623 --- /dev/null +++ b/src/square/team_members/wage_setting/raw_client.py @@ -0,0 +1,249 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.get_wage_setting_response import GetWageSettingResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.wage_setting import WageSettingParams +from ...types.update_wage_setting_response import UpdateWageSettingResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawWageSettingClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetWageSettingResponse]: + """ + Retrieves a `WageSetting` object for a team member specified + by `TeamMember.id`. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). + + Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) + to get this information directly from the `TeamMember.wage_setting` field. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to retrieve the wage setting. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetWageSettingResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}/wage-setting", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetWageSettingResponse, + construct_type( + type_=GetWageSettingResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + team_member_id: str, + *, + wage_setting: WageSettingParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateWageSettingResponse]: + """ + Creates or updates a `WageSetting` object. The object is created if a + `WageSetting` with the specified `team_member_id` doesn't exist. Otherwise, + it fully replaces the `WageSetting` object for the team member. + The `WageSetting` is returned on a successful update. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting). + + Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember) + to manage the `TeamMember.wage_setting` field directly. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to update the `WageSetting` object. + + wage_setting : WageSettingParams + The complete `WageSetting` object. For all job assignments, specify one of the following: + - `job_id` (recommended) - If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get a list of all jobs. + Requires Square API version 2024-12-18 or later. + - `job_title` - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job. + This value is ignored if `job_id` is also provided. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateWageSettingResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}/wage-setting", + method="PUT", + json={ + "wage_setting": convert_and_respect_annotation_metadata( + object_=wage_setting, annotation=WageSettingParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWageSettingResponse, + construct_type( + type_=UpdateWageSettingResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawWageSettingClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, team_member_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetWageSettingResponse]: + """ + Retrieves a `WageSetting` object for a team member specified + by `TeamMember.id`. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). + + Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) + to get this information directly from the `TeamMember.wage_setting` field. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to retrieve the wage setting. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetWageSettingResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}/wage-setting", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetWageSettingResponse, + construct_type( + type_=GetWageSettingResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + team_member_id: str, + *, + wage_setting: WageSettingParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateWageSettingResponse]: + """ + Creates or updates a `WageSetting` object. The object is created if a + `WageSetting` with the specified `team_member_id` doesn't exist. Otherwise, + it fully replaces the `WageSetting` object for the team member. + The `WageSetting` is returned on a successful update. For more information, see + [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting). + + Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember) + to manage the `TeamMember.wage_setting` field directly. + + Parameters + ---------- + team_member_id : str + The ID of the team member for which to update the `WageSetting` object. + + wage_setting : WageSettingParams + The complete `WageSetting` object. For all job assignments, specify one of the following: + - `job_id` (recommended) - If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get a list of all jobs. + Requires Square API version 2024-12-18 or later. + - `job_title` - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job. + This value is ignored if `job_id` is also provided. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateWageSettingResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/team-members/{jsonable_encoder(team_member_id)}/wage-setting", + method="PUT", + json={ + "wage_setting": convert_and_respect_annotation_metadata( + object_=wage_setting, annotation=WageSettingParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWageSettingResponse, + construct_type( + type_=UpdateWageSettingResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/terminal/__init__.py b/src/square/terminal/__init__.py new file mode 100644 index 00000000..c12a7ecb --- /dev/null +++ b/src/square/terminal/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import actions, checkouts, refunds + +__all__ = ["actions", "checkouts", "refunds"] diff --git a/src/square/terminal/actions/__init__.py b/src/square/terminal/actions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/terminal/actions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/terminal/actions/client.py b/src/square/terminal/actions/client.py new file mode 100644 index 00000000..126745ec --- /dev/null +++ b/src/square/terminal/actions/client.py @@ -0,0 +1,429 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawActionsClient +from ...requests.terminal_action import TerminalActionParams +from ...core.request_options import RequestOptions +from ...types.create_terminal_action_response import CreateTerminalActionResponse +from ...requests.terminal_action_query import TerminalActionQueryParams +from ...types.search_terminal_actions_response import SearchTerminalActionsResponse +from ...types.get_terminal_action_response import GetTerminalActionResponse +from ...types.cancel_terminal_action_response import CancelTerminalActionResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawActionsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class ActionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawActionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawActionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawActionsClient + """ + return self._raw_client + + def create( + self, + *, + idempotency_key: str, + action: TerminalActionParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTerminalActionResponse: + """ + Creates a Terminal action request and sends it to the specified device. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateAction` request. Keys can be any valid string + but must be unique for every `CreateAction` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more + information. + + action : TerminalActionParams + The Action to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTerminalActionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.actions.create( + idempotency_key="thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e", + action={ + "device_id": "{{DEVICE_ID}}", + "deadline_duration": "PT5M", + "type": "SAVE_CARD", + "save_card_options": { + "customer_id": "{{CUSTOMER_ID}}", + "reference_id": "user-id-1", + }, + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, action=action, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: typing.Optional[TerminalActionQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTerminalActionsResponse: + """ + Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalActionQueryParams] + Queries terminal actions based on given conditions and sort order. + Leaving this unset will return all actions with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more + information. + + limit : typing.Optional[int] + Limit the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTerminalActionsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.actions.search( + query={ + "filter": {"created_at": {"start_at": "2022-04-01T00:00:00.000Z"}}, + "sort": {"sort_order": "DESC"}, + }, + limit=2, + ) + """ + response = self._raw_client.search(query=query, cursor=cursor, limit=limit, request_options=request_options) + return response.data + + def get( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTerminalActionResponse: + """ + Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTerminalActionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.actions.get( + action_id="action_id", + ) + """ + response = self._raw_client.get(action_id, request_options=request_options) + return response.data + + def cancel( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelTerminalActionResponse: + """ + Cancels a Terminal action request if the status of the request permits it. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelTerminalActionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.actions.cancel( + action_id="action_id", + ) + """ + response = self._raw_client.cancel(action_id, request_options=request_options) + return response.data + + +class AsyncActionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawActionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawActionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawActionsClient + """ + return self._raw_client + + async def create( + self, + *, + idempotency_key: str, + action: TerminalActionParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTerminalActionResponse: + """ + Creates a Terminal action request and sends it to the specified device. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateAction` request. Keys can be any valid string + but must be unique for every `CreateAction` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more + information. + + action : TerminalActionParams + The Action to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTerminalActionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.actions.create( + idempotency_key="thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e", + action={ + "device_id": "{{DEVICE_ID}}", + "deadline_duration": "PT5M", + "type": "SAVE_CARD", + "save_card_options": { + "customer_id": "{{CUSTOMER_ID}}", + "reference_id": "user-id-1", + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, action=action, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: typing.Optional[TerminalActionQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTerminalActionsResponse: + """ + Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalActionQueryParams] + Queries terminal actions based on given conditions and sort order. + Leaving this unset will return all actions with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more + information. + + limit : typing.Optional[int] + Limit the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTerminalActionsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.actions.search( + query={ + "filter": {"created_at": {"start_at": "2022-04-01T00:00:00.000Z"}}, + "sort": {"sort_order": "DESC"}, + }, + limit=2, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, cursor=cursor, limit=limit, request_options=request_options + ) + return response.data + + async def get( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTerminalActionResponse: + """ + Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTerminalActionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.actions.get( + action_id="action_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(action_id, request_options=request_options) + return response.data + + async def cancel( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelTerminalActionResponse: + """ + Cancels a Terminal action request if the status of the request permits it. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelTerminalActionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.actions.cancel( + action_id="action_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(action_id, request_options=request_options) + return response.data diff --git a/src/square/terminal/actions/raw_client.py b/src/square/terminal/actions/raw_client.py new file mode 100644 index 00000000..7ad5ea69 --- /dev/null +++ b/src/square/terminal/actions/raw_client.py @@ -0,0 +1,438 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.terminal_action import TerminalActionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_terminal_action_response import CreateTerminalActionResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.terminal_action_query import TerminalActionQueryParams +from ...types.search_terminal_actions_response import SearchTerminalActionsResponse +from ...types.get_terminal_action_response import GetTerminalActionResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.cancel_terminal_action_response import CancelTerminalActionResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawActionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + action: TerminalActionParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateTerminalActionResponse]: + """ + Creates a Terminal action request and sends it to the specified device. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateAction` request. Keys can be any valid string + but must be unique for every `CreateAction` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more + information. + + action : TerminalActionParams + The Action to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateTerminalActionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/terminals/actions", + method="POST", + json={ + "idempotency_key": idempotency_key, + "action": convert_and_respect_annotation_metadata( + object_=action, annotation=TerminalActionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTerminalActionResponse, + construct_type( + type_=CreateTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[TerminalActionQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchTerminalActionsResponse]: + """ + Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalActionQueryParams] + Queries terminal actions based on given conditions and sort order. + Leaving this unset will return all actions with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more + information. + + limit : typing.Optional[int] + Limit the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchTerminalActionsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/terminals/actions/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=TerminalActionQueryParams, direction="write" + ), + "cursor": cursor, + "limit": limit, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTerminalActionsResponse, + construct_type( + type_=SearchTerminalActionsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTerminalActionResponse]: + """ + Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTerminalActionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/actions/{jsonable_encoder(action_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTerminalActionResponse, + construct_type( + type_=GetTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelTerminalActionResponse]: + """ + Cancels a Terminal action request if the status of the request permits it. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelTerminalActionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/actions/{jsonable_encoder(action_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelTerminalActionResponse, + construct_type( + type_=CancelTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawActionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + action: TerminalActionParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateTerminalActionResponse]: + """ + Creates a Terminal action request and sends it to the specified device. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateAction` request. Keys can be any valid string + but must be unique for every `CreateAction` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more + information. + + action : TerminalActionParams + The Action to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateTerminalActionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/terminals/actions", + method="POST", + json={ + "idempotency_key": idempotency_key, + "action": convert_and_respect_annotation_metadata( + object_=action, annotation=TerminalActionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTerminalActionResponse, + construct_type( + type_=CreateTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[TerminalActionQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchTerminalActionsResponse]: + """ + Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalActionQueryParams] + Queries terminal actions based on given conditions and sort order. + Leaving this unset will return all actions with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more + information. + + limit : typing.Optional[int] + Limit the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchTerminalActionsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/terminals/actions/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=TerminalActionQueryParams, direction="write" + ), + "cursor": cursor, + "limit": limit, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTerminalActionsResponse, + construct_type( + type_=SearchTerminalActionsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTerminalActionResponse]: + """ + Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTerminalActionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/actions/{jsonable_encoder(action_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTerminalActionResponse, + construct_type( + type_=GetTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelTerminalActionResponse]: + """ + Cancels a Terminal action request if the status of the request permits it. + + Parameters + ---------- + action_id : str + Unique ID for the desired `TerminalAction`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelTerminalActionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/actions/{jsonable_encoder(action_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelTerminalActionResponse, + construct_type( + type_=CancelTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/terminal/checkouts/__init__.py b/src/square/terminal/checkouts/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/terminal/checkouts/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/terminal/checkouts/client.py b/src/square/terminal/checkouts/client.py new file mode 100644 index 00000000..be752860 --- /dev/null +++ b/src/square/terminal/checkouts/client.py @@ -0,0 +1,417 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawCheckoutsClient +from ...requests.terminal_checkout import TerminalCheckoutParams +from ...core.request_options import RequestOptions +from ...types.create_terminal_checkout_response import CreateTerminalCheckoutResponse +from ...requests.terminal_checkout_query import TerminalCheckoutQueryParams +from ...types.search_terminal_checkouts_response import SearchTerminalCheckoutsResponse +from ...types.get_terminal_checkout_response import GetTerminalCheckoutResponse +from ...types.cancel_terminal_checkout_response import CancelTerminalCheckoutResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawCheckoutsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class CheckoutsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCheckoutsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCheckoutsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCheckoutsClient + """ + return self._raw_client + + def create( + self, + *, + idempotency_key: str, + checkout: TerminalCheckoutParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTerminalCheckoutResponse: + """ + Creates a Terminal checkout request and sends it to the specified device to take a payment + for the requested amount. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but + must be unique for every `CreateCheckout` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + checkout : TerminalCheckoutParams + The checkout to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTerminalCheckoutResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.checkouts.create( + idempotency_key="28a0c3bc-7839-11ea-bc55-0242ac130003", + checkout={ + "amount_money": {"amount": 2610, "currency": "USD"}, + "reference_id": "id11572", + "note": "A brief note", + "device_options": {"device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003"}, + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, checkout=checkout, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: typing.Optional[TerminalCheckoutQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTerminalCheckoutsResponse: + """ + Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalCheckoutQueryParams] + Queries Terminal checkouts based on given conditions and the sort order. + Leaving these unset returns all checkouts with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTerminalCheckoutsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.checkouts.search( + query={"filter": {"status": "COMPLETED"}}, + limit=2, + ) + """ + response = self._raw_client.search(query=query, cursor=cursor, limit=limit, request_options=request_options) + return response.data + + def get( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTerminalCheckoutResponse: + """ + Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTerminalCheckoutResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.checkouts.get( + checkout_id="checkout_id", + ) + """ + response = self._raw_client.get(checkout_id, request_options=request_options) + return response.data + + def cancel( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelTerminalCheckoutResponse: + """ + Cancels a Terminal checkout request if the status of the request permits it. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelTerminalCheckoutResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.checkouts.cancel( + checkout_id="checkout_id", + ) + """ + response = self._raw_client.cancel(checkout_id, request_options=request_options) + return response.data + + +class AsyncCheckoutsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCheckoutsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCheckoutsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCheckoutsClient + """ + return self._raw_client + + async def create( + self, + *, + idempotency_key: str, + checkout: TerminalCheckoutParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTerminalCheckoutResponse: + """ + Creates a Terminal checkout request and sends it to the specified device to take a payment + for the requested amount. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but + must be unique for every `CreateCheckout` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + checkout : TerminalCheckoutParams + The checkout to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTerminalCheckoutResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.checkouts.create( + idempotency_key="28a0c3bc-7839-11ea-bc55-0242ac130003", + checkout={ + "amount_money": {"amount": 2610, "currency": "USD"}, + "reference_id": "id11572", + "note": "A brief note", + "device_options": { + "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003" + }, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, checkout=checkout, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: typing.Optional[TerminalCheckoutQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTerminalCheckoutsResponse: + """ + Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalCheckoutQueryParams] + Queries Terminal checkouts based on given conditions and the sort order. + Leaving these unset returns all checkouts with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTerminalCheckoutsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.checkouts.search( + query={"filter": {"status": "COMPLETED"}}, + limit=2, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, cursor=cursor, limit=limit, request_options=request_options + ) + return response.data + + async def get( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTerminalCheckoutResponse: + """ + Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTerminalCheckoutResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.checkouts.get( + checkout_id="checkout_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(checkout_id, request_options=request_options) + return response.data + + async def cancel( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelTerminalCheckoutResponse: + """ + Cancels a Terminal checkout request if the status of the request permits it. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelTerminalCheckoutResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.checkouts.cancel( + checkout_id="checkout_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(checkout_id, request_options=request_options) + return response.data diff --git a/src/square/terminal/checkouts/raw_client.py b/src/square/terminal/checkouts/raw_client.py new file mode 100644 index 00000000..9567001d --- /dev/null +++ b/src/square/terminal/checkouts/raw_client.py @@ -0,0 +1,436 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.terminal_checkout import TerminalCheckoutParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_terminal_checkout_response import CreateTerminalCheckoutResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.terminal_checkout_query import TerminalCheckoutQueryParams +from ...types.search_terminal_checkouts_response import SearchTerminalCheckoutsResponse +from ...types.get_terminal_checkout_response import GetTerminalCheckoutResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.cancel_terminal_checkout_response import CancelTerminalCheckoutResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCheckoutsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + checkout: TerminalCheckoutParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateTerminalCheckoutResponse]: + """ + Creates a Terminal checkout request and sends it to the specified device to take a payment + for the requested amount. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but + must be unique for every `CreateCheckout` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + checkout : TerminalCheckoutParams + The checkout to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateTerminalCheckoutResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/terminals/checkouts", + method="POST", + json={ + "idempotency_key": idempotency_key, + "checkout": convert_and_respect_annotation_metadata( + object_=checkout, annotation=TerminalCheckoutParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTerminalCheckoutResponse, + construct_type( + type_=CreateTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[TerminalCheckoutQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchTerminalCheckoutsResponse]: + """ + Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalCheckoutQueryParams] + Queries Terminal checkouts based on given conditions and the sort order. + Leaving these unset returns all checkouts with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchTerminalCheckoutsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/terminals/checkouts/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=TerminalCheckoutQueryParams, direction="write" + ), + "cursor": cursor, + "limit": limit, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTerminalCheckoutsResponse, + construct_type( + type_=SearchTerminalCheckoutsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTerminalCheckoutResponse]: + """ + Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTerminalCheckoutResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/checkouts/{jsonable_encoder(checkout_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTerminalCheckoutResponse, + construct_type( + type_=GetTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelTerminalCheckoutResponse]: + """ + Cancels a Terminal checkout request if the status of the request permits it. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelTerminalCheckoutResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/checkouts/{jsonable_encoder(checkout_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelTerminalCheckoutResponse, + construct_type( + type_=CancelTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawCheckoutsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + checkout: TerminalCheckoutParams, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateTerminalCheckoutResponse]: + """ + Creates a Terminal checkout request and sends it to the specified device to take a payment + for the requested amount. + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but + must be unique for every `CreateCheckout` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + checkout : TerminalCheckoutParams + The checkout to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateTerminalCheckoutResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/terminals/checkouts", + method="POST", + json={ + "idempotency_key": idempotency_key, + "checkout": convert_and_respect_annotation_metadata( + object_=checkout, annotation=TerminalCheckoutParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTerminalCheckoutResponse, + construct_type( + type_=CreateTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[TerminalCheckoutQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchTerminalCheckoutsResponse]: + """ + Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalCheckoutQueryParams] + Queries Terminal checkouts based on given conditions and the sort order. + Leaving these unset returns all checkouts with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchTerminalCheckoutsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/terminals/checkouts/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=TerminalCheckoutQueryParams, direction="write" + ), + "cursor": cursor, + "limit": limit, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTerminalCheckoutsResponse, + construct_type( + type_=SearchTerminalCheckoutsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTerminalCheckoutResponse]: + """ + Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTerminalCheckoutResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/checkouts/{jsonable_encoder(checkout_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTerminalCheckoutResponse, + construct_type( + type_=GetTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelTerminalCheckoutResponse]: + """ + Cancels a Terminal checkout request if the status of the request permits it. + + Parameters + ---------- + checkout_id : str + The unique ID for the desired `TerminalCheckout`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelTerminalCheckoutResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/checkouts/{jsonable_encoder(checkout_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelTerminalCheckoutResponse, + construct_type( + type_=CancelTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/terminal/client.py b/src/square/terminal/client.py new file mode 100644 index 00000000..9ab0a2c4 --- /dev/null +++ b/src/square/terminal/client.py @@ -0,0 +1,285 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawTerminalClient +from .actions.client import ActionsClient +from .checkouts.client import CheckoutsClient +from .refunds.client import RefundsClient +import typing +from ..core.request_options import RequestOptions +from ..types.dismiss_terminal_action_response import DismissTerminalActionResponse +from ..types.dismiss_terminal_checkout_response import DismissTerminalCheckoutResponse +from ..types.dismiss_terminal_refund_response import DismissTerminalRefundResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawTerminalClient +from .actions.client import AsyncActionsClient +from .checkouts.client import AsyncCheckoutsClient +from .refunds.client import AsyncRefundsClient + + +class TerminalClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTerminalClient(client_wrapper=client_wrapper) + self.actions = ActionsClient(client_wrapper=client_wrapper) + + self.checkouts = CheckoutsClient(client_wrapper=client_wrapper) + + self.refunds = RefundsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTerminalClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTerminalClient + """ + return self._raw_client + + def dismiss_terminal_action( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DismissTerminalActionResponse: + """ + Dismisses a Terminal action request if the status and type of the request permits it. + + See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details. + + Parameters + ---------- + action_id : str + Unique ID for the `TerminalAction` associated with the action to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DismissTerminalActionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.dismiss_terminal_action( + action_id="action_id", + ) + """ + response = self._raw_client.dismiss_terminal_action(action_id, request_options=request_options) + return response.data + + def dismiss_terminal_checkout( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DismissTerminalCheckoutResponse: + """ + Dismisses a Terminal checkout request if the status and type of the request permits it. + + Parameters + ---------- + checkout_id : str + Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DismissTerminalCheckoutResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.dismiss_terminal_checkout( + checkout_id="checkout_id", + ) + """ + response = self._raw_client.dismiss_terminal_checkout(checkout_id, request_options=request_options) + return response.data + + def dismiss_terminal_refund( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DismissTerminalRefundResponse: + """ + Dismisses a Terminal refund request if the status and type of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + Unique ID for the `TerminalRefund` associated with the refund to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DismissTerminalRefundResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.dismiss_terminal_refund( + terminal_refund_id="terminal_refund_id", + ) + """ + response = self._raw_client.dismiss_terminal_refund(terminal_refund_id, request_options=request_options) + return response.data + + +class AsyncTerminalClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTerminalClient(client_wrapper=client_wrapper) + self.actions = AsyncActionsClient(client_wrapper=client_wrapper) + + self.checkouts = AsyncCheckoutsClient(client_wrapper=client_wrapper) + + self.refunds = AsyncRefundsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTerminalClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTerminalClient + """ + return self._raw_client + + async def dismiss_terminal_action( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DismissTerminalActionResponse: + """ + Dismisses a Terminal action request if the status and type of the request permits it. + + See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details. + + Parameters + ---------- + action_id : str + Unique ID for the `TerminalAction` associated with the action to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DismissTerminalActionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.dismiss_terminal_action( + action_id="action_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.dismiss_terminal_action(action_id, request_options=request_options) + return response.data + + async def dismiss_terminal_checkout( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DismissTerminalCheckoutResponse: + """ + Dismisses a Terminal checkout request if the status and type of the request permits it. + + Parameters + ---------- + checkout_id : str + Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DismissTerminalCheckoutResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.dismiss_terminal_checkout( + checkout_id="checkout_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.dismiss_terminal_checkout(checkout_id, request_options=request_options) + return response.data + + async def dismiss_terminal_refund( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DismissTerminalRefundResponse: + """ + Dismisses a Terminal refund request if the status and type of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + Unique ID for the `TerminalRefund` associated with the refund to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DismissTerminalRefundResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.dismiss_terminal_refund( + terminal_refund_id="terminal_refund_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.dismiss_terminal_refund(terminal_refund_id, request_options=request_options) + return response.data diff --git a/src/square/terminal/raw_client.py b/src/square/terminal/raw_client.py new file mode 100644 index 00000000..96ad6068 --- /dev/null +++ b/src/square/terminal/raw_client.py @@ -0,0 +1,263 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +import typing +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.dismiss_terminal_action_response import DismissTerminalActionResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.dismiss_terminal_checkout_response import DismissTerminalCheckoutResponse +from ..types.dismiss_terminal_refund_response import DismissTerminalRefundResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + + +class RawTerminalClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def dismiss_terminal_action( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DismissTerminalActionResponse]: + """ + Dismisses a Terminal action request if the status and type of the request permits it. + + See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details. + + Parameters + ---------- + action_id : str + Unique ID for the `TerminalAction` associated with the action to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DismissTerminalActionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/actions/{jsonable_encoder(action_id)}/dismiss", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DismissTerminalActionResponse, + construct_type( + type_=DismissTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def dismiss_terminal_checkout( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DismissTerminalCheckoutResponse]: + """ + Dismisses a Terminal checkout request if the status and type of the request permits it. + + Parameters + ---------- + checkout_id : str + Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DismissTerminalCheckoutResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/checkouts/{jsonable_encoder(checkout_id)}/dismiss", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DismissTerminalCheckoutResponse, + construct_type( + type_=DismissTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def dismiss_terminal_refund( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DismissTerminalRefundResponse]: + """ + Dismisses a Terminal refund request if the status and type of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + Unique ID for the `TerminalRefund` associated with the refund to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DismissTerminalRefundResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/refunds/{jsonable_encoder(terminal_refund_id)}/dismiss", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DismissTerminalRefundResponse, + construct_type( + type_=DismissTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawTerminalClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def dismiss_terminal_action( + self, action_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DismissTerminalActionResponse]: + """ + Dismisses a Terminal action request if the status and type of the request permits it. + + See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details. + + Parameters + ---------- + action_id : str + Unique ID for the `TerminalAction` associated with the action to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DismissTerminalActionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/actions/{jsonable_encoder(action_id)}/dismiss", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DismissTerminalActionResponse, + construct_type( + type_=DismissTerminalActionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def dismiss_terminal_checkout( + self, checkout_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DismissTerminalCheckoutResponse]: + """ + Dismisses a Terminal checkout request if the status and type of the request permits it. + + Parameters + ---------- + checkout_id : str + Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DismissTerminalCheckoutResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/checkouts/{jsonable_encoder(checkout_id)}/dismiss", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DismissTerminalCheckoutResponse, + construct_type( + type_=DismissTerminalCheckoutResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def dismiss_terminal_refund( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DismissTerminalRefundResponse]: + """ + Dismisses a Terminal refund request if the status and type of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + Unique ID for the `TerminalRefund` associated with the refund to be dismissed. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DismissTerminalRefundResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/refunds/{jsonable_encoder(terminal_refund_id)}/dismiss", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DismissTerminalRefundResponse, + construct_type( + type_=DismissTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/terminal/refunds/__init__.py b/src/square/terminal/refunds/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/terminal/refunds/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/terminal/refunds/client.py b/src/square/terminal/refunds/client.py new file mode 100644 index 00000000..d900f00c --- /dev/null +++ b/src/square/terminal/refunds/client.py @@ -0,0 +1,413 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawRefundsClient +from ...requests.terminal_refund import TerminalRefundParams +from ...core.request_options import RequestOptions +from ...types.create_terminal_refund_response import CreateTerminalRefundResponse +from ...requests.terminal_refund_query import TerminalRefundQueryParams +from ...types.search_terminal_refunds_response import SearchTerminalRefundsResponse +from ...types.get_terminal_refund_response import GetTerminalRefundResponse +from ...types.cancel_terminal_refund_response import CancelTerminalRefundResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawRefundsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RefundsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawRefundsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawRefundsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawRefundsClient + """ + return self._raw_client + + def create( + self, + *, + idempotency_key: str, + refund: typing.Optional[TerminalRefundParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTerminalRefundResponse: + """ + Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateRefund` request. Keys can be any valid string but + must be unique for every `CreateRefund` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + refund : typing.Optional[TerminalRefundParams] + The refund to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTerminalRefundResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.refunds.create( + idempotency_key="402a640b-b26f-401f-b406-46f839590c04", + refund={ + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "amount_money": {"amount": 111, "currency": "CAD"}, + "reason": "Returning items", + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, refund=refund, request_options=request_options + ) + return response.data + + def search( + self, + *, + query: typing.Optional[TerminalRefundQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTerminalRefundsResponse: + """ + Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalRefundQueryParams] + Queries the Terminal refunds based on given conditions and the sort order. Calling + `SearchTerminalRefunds` without an explicit query parameter returns all available + refunds with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTerminalRefundsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.refunds.search( + query={"filter": {"status": "COMPLETED"}}, + limit=1, + ) + """ + response = self._raw_client.search(query=query, cursor=cursor, limit=limit, request_options=request_options) + return response.data + + def get( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTerminalRefundResponse: + """ + Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTerminalRefundResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.refunds.get( + terminal_refund_id="terminal_refund_id", + ) + """ + response = self._raw_client.get(terminal_refund_id, request_options=request_options) + return response.data + + def cancel( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelTerminalRefundResponse: + """ + Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelTerminalRefundResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.terminal.refunds.cancel( + terminal_refund_id="terminal_refund_id", + ) + """ + response = self._raw_client.cancel(terminal_refund_id, request_options=request_options) + return response.data + + +class AsyncRefundsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawRefundsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawRefundsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawRefundsClient + """ + return self._raw_client + + async def create( + self, + *, + idempotency_key: str, + refund: typing.Optional[TerminalRefundParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateTerminalRefundResponse: + """ + Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateRefund` request. Keys can be any valid string but + must be unique for every `CreateRefund` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + refund : typing.Optional[TerminalRefundParams] + The refund to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateTerminalRefundResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.refunds.create( + idempotency_key="402a640b-b26f-401f-b406-46f839590c04", + refund={ + "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", + "amount_money": {"amount": 111, "currency": "CAD"}, + "reason": "Returning items", + "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, refund=refund, request_options=request_options + ) + return response.data + + async def search( + self, + *, + query: typing.Optional[TerminalRefundQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchTerminalRefundsResponse: + """ + Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalRefundQueryParams] + Queries the Terminal refunds based on given conditions and the sort order. Calling + `SearchTerminalRefunds` without an explicit query parameter returns all available + refunds with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchTerminalRefundsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.refunds.search( + query={"filter": {"status": "COMPLETED"}}, + limit=1, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + query=query, cursor=cursor, limit=limit, request_options=request_options + ) + return response.data + + async def get( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetTerminalRefundResponse: + """ + Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetTerminalRefundResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.refunds.get( + terminal_refund_id="terminal_refund_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(terminal_refund_id, request_options=request_options) + return response.data + + async def cancel( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> CancelTerminalRefundResponse: + """ + Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CancelTerminalRefundResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.terminal.refunds.cancel( + terminal_refund_id="terminal_refund_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.cancel(terminal_refund_id, request_options=request_options) + return response.data diff --git a/src/square/terminal/refunds/raw_client.py b/src/square/terminal/refunds/raw_client.py new file mode 100644 index 00000000..0dc1553d --- /dev/null +++ b/src/square/terminal/refunds/raw_client.py @@ -0,0 +1,434 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.terminal_refund import TerminalRefundParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_terminal_refund_response import CreateTerminalRefundResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.terminal_refund_query import TerminalRefundQueryParams +from ...types.search_terminal_refunds_response import SearchTerminalRefundsResponse +from ...types.get_terminal_refund_response import GetTerminalRefundResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.cancel_terminal_refund_response import CancelTerminalRefundResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawRefundsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + idempotency_key: str, + refund: typing.Optional[TerminalRefundParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateTerminalRefundResponse]: + """ + Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateRefund` request. Keys can be any valid string but + must be unique for every `CreateRefund` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + refund : typing.Optional[TerminalRefundParams] + The refund to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateTerminalRefundResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/terminals/refunds", + method="POST", + json={ + "idempotency_key": idempotency_key, + "refund": convert_and_respect_annotation_metadata( + object_=refund, annotation=TerminalRefundParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTerminalRefundResponse, + construct_type( + type_=CreateTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + query: typing.Optional[TerminalRefundQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchTerminalRefundsResponse]: + """ + Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalRefundQueryParams] + Queries the Terminal refunds based on given conditions and the sort order. Calling + `SearchTerminalRefunds` without an explicit query parameter returns all available + refunds with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchTerminalRefundsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/terminals/refunds/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=TerminalRefundQueryParams, direction="write" + ), + "cursor": cursor, + "limit": limit, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTerminalRefundsResponse, + construct_type( + type_=SearchTerminalRefundsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetTerminalRefundResponse]: + """ + Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetTerminalRefundResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/refunds/{jsonable_encoder(terminal_refund_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTerminalRefundResponse, + construct_type( + type_=GetTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def cancel( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CancelTerminalRefundResponse]: + """ + Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CancelTerminalRefundResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/terminals/refunds/{jsonable_encoder(terminal_refund_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelTerminalRefundResponse, + construct_type( + type_=CancelTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawRefundsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + idempotency_key: str, + refund: typing.Optional[TerminalRefundParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateTerminalRefundResponse]: + """ + Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds). + + Parameters + ---------- + idempotency_key : str + A unique string that identifies this `CreateRefund` request. Keys can be any valid string but + must be unique for every `CreateRefund` request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + + refund : typing.Optional[TerminalRefundParams] + The refund to create. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateTerminalRefundResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/terminals/refunds", + method="POST", + json={ + "idempotency_key": idempotency_key, + "refund": convert_and_respect_annotation_metadata( + object_=refund, annotation=TerminalRefundParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateTerminalRefundResponse, + construct_type( + type_=CreateTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + query: typing.Optional[TerminalRefundQueryParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + limit: typing.Optional[int] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchTerminalRefundsResponse]: + """ + Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days. + + Parameters + ---------- + query : typing.Optional[TerminalRefundQueryParams] + Queries the Terminal refunds based on given conditions and the sort order. Calling + `SearchTerminalRefunds` without an explicit query parameter returns all available + refunds with the default sort order. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this cursor to retrieve the next set of results for the original query. + + limit : typing.Optional[int] + Limits the number of results returned for a single request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchTerminalRefundsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/terminals/refunds/search", + method="POST", + json={ + "query": convert_and_respect_annotation_metadata( + object_=query, annotation=TerminalRefundQueryParams, direction="write" + ), + "cursor": cursor, + "limit": limit, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchTerminalRefundsResponse, + construct_type( + type_=SearchTerminalRefundsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetTerminalRefundResponse]: + """ + Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetTerminalRefundResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/refunds/{jsonable_encoder(terminal_refund_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetTerminalRefundResponse, + construct_type( + type_=GetTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def cancel( + self, terminal_refund_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CancelTerminalRefundResponse]: + """ + Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it. + + Parameters + ---------- + terminal_refund_id : str + The unique ID for the desired `TerminalRefund`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CancelTerminalRefundResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/terminals/refunds/{jsonable_encoder(terminal_refund_id)}/cancel", + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CancelTerminalRefundResponse, + construct_type( + type_=CancelTerminalRefundResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/types/__init__.py b/src/square/types/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/types/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/types/accept_dispute_response.py b/src/square/types/accept_dispute_response.py new file mode 100644 index 00000000..9f0bf8b1 --- /dev/null +++ b/src/square/types/accept_dispute_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute import Dispute +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AcceptDisputeResponse(UncheckedBaseModel): + """ + Defines the fields in an `AcceptDispute` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + dispute: typing.Optional[Dispute] = pydantic.Field(default=None) + """ + Details about the accepted dispute. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/accepted_payment_methods.py b/src/square/types/accepted_payment_methods.py new file mode 100644 index 00000000..77f21b90 --- /dev/null +++ b/src/square/types/accepted_payment_methods.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AcceptedPaymentMethods(UncheckedBaseModel): + apple_pay: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether Apple Pay is accepted at checkout. + """ + + google_pay: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether Google Pay is accepted at checkout. + """ + + cash_app_pay: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether Cash App Pay is accepted at checkout. + """ + + afterpay_clearpay: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether Afterpay/Clearpay is accepted at checkout. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/accumulate_loyalty_points_response.py b/src/square/types/accumulate_loyalty_points_response.py new file mode 100644 index 00000000..e325083f --- /dev/null +++ b/src/square/types/accumulate_loyalty_points_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_event import LoyaltyEvent +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AccumulateLoyaltyPointsResponse(UncheckedBaseModel): + """ + Represents an [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints) response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + event: typing.Optional[LoyaltyEvent] = pydantic.Field(default=None) + """ + The resulting loyalty event. Starting in Square version 2022-08-17, this field is no longer returned. + """ + + events: typing.Optional[typing.List[LoyaltyEvent]] = pydantic.Field(default=None) + """ + The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event + is always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included + if the purchase also qualifies for a loyalty promotion. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/ach_details.py b/src/square/types/ach_details.py new file mode 100644 index 00000000..93008cf2 --- /dev/null +++ b/src/square/types/ach_details.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AchDetails(UncheckedBaseModel): + """ + ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`. + """ + + routing_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The routing number for the bank account. + """ + + account_number_suffix: typing.Optional[str] = pydantic.Field(default=None) + """ + The last few digits of the bank account number. + """ + + account_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The type of the bank account performing the transfer. The account type can be `CHECKING`, + `SAVINGS`, or `UNKNOWN`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/action_cancel_reason.py b/src/square/types/action_cancel_reason.py new file mode 100644 index 00000000..200467ad --- /dev/null +++ b/src/square/types/action_cancel_reason.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ActionCancelReason = typing.Union[typing.Literal["BUYER_CANCELED", "SELLER_CANCELED", "TIMED_OUT"], typing.Any] diff --git a/src/square/types/activity_type.py b/src/square/types/activity_type.py new file mode 100644 index 00000000..c60fab1f --- /dev/null +++ b/src/square/types/activity_type.py @@ -0,0 +1,67 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ActivityType = typing.Union[ + typing.Literal[ + "ADJUSTMENT", + "APP_FEE_REFUND", + "APP_FEE_REVENUE", + "AUTOMATIC_SAVINGS", + "AUTOMATIC_SAVINGS_REVERSED", + "CHARGE", + "DEPOSIT_FEE", + "DEPOSIT_FEE_REVERSED", + "DISPUTE", + "ESCHEATMENT", + "FEE", + "FREE_PROCESSING", + "HOLD_ADJUSTMENT", + "INITIAL_BALANCE_CHANGE", + "MONEY_TRANSFER", + "MONEY_TRANSFER_REVERSAL", + "OPEN_DISPUTE", + "OTHER", + "OTHER_ADJUSTMENT", + "PAID_SERVICE_FEE", + "PAID_SERVICE_FEE_REFUND", + "REDEMPTION_CODE", + "REFUND", + "RELEASE_ADJUSTMENT", + "RESERVE_HOLD", + "RESERVE_RELEASE", + "RETURNED_PAYOUT", + "SQUARE_CAPITAL_PAYMENT", + "SQUARE_CAPITAL_REVERSED_PAYMENT", + "SUBSCRIPTION_FEE", + "SUBSCRIPTION_FEE_PAID_REFUND", + "SUBSCRIPTION_FEE_REFUND", + "TAX_ON_FEE", + "THIRD_PARTY_FEE", + "THIRD_PARTY_FEE_REFUND", + "PAYOUT", + "AUTOMATIC_BITCOIN_CONVERSIONS", + "AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED", + "CREDIT_CARD_REPAYMENT", + "CREDIT_CARD_REPAYMENT_REVERSED", + "LOCAL_OFFERS_CASHBACK", + "LOCAL_OFFERS_FEE", + "PERCENTAGE_PROCESSING_ENROLLMENT", + "PERCENTAGE_PROCESSING_DEACTIVATION", + "PERCENTAGE_PROCESSING_REPAYMENT", + "PERCENTAGE_PROCESSING_REPAYMENT_REVERSED", + "PROCESSING_FEE", + "PROCESSING_FEE_REFUND", + "UNDO_PROCESSING_FEE_REFUND", + "GIFT_CARD_LOAD_FEE", + "GIFT_CARD_LOAD_FEE_REFUND", + "UNDO_GIFT_CARD_LOAD_FEE_REFUND", + "BALANCE_FOLDERS_TRANSFER", + "BALANCE_FOLDERS_TRANSFER_REVERSED", + "GIFT_CARD_POOL_TRANSFER", + "GIFT_CARD_POOL_TRANSFER_REVERSED", + "SQUARE_PAYROLL_TRANSFER", + "SQUARE_PAYROLL_TRANSFER_REVERSED", + ], + typing.Any, +] diff --git a/src/square/types/add_group_to_customer_response.py b/src/square/types/add_group_to_customer_response.py new file mode 100644 index 00000000..024dc6db --- /dev/null +++ b/src/square/types/add_group_to_customer_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AddGroupToCustomerResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/additional_recipient.py b/src/square/types/additional_recipient.py new file mode 100644 index 00000000..e004fd97 --- /dev/null +++ b/src/square/types/additional_recipient.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AdditionalRecipient(UncheckedBaseModel): + """ + Represents an additional recipient (other than the merchant) receiving a portion of this tender. + """ + + location_id: str = pydantic.Field() + """ + The location ID for a recipient (other than the merchant) receiving a portion of this tender. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the additional recipient. + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money distributed to the recipient. + """ + + receivable_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/address.py b/src/square/types/address.py new file mode 100644 index 00000000..e8845466 --- /dev/null +++ b/src/square/types/address.py @@ -0,0 +1,120 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing_extensions +import typing +from ..core.serialization import FieldMetadata +import pydantic +from .country import Country +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Address(UncheckedBaseModel): + """ + Represents a postal address in a country. + For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + address_line1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="address_line_1")] = ( + pydantic.Field(default=None) + ) + """ + The first line of the address. + + Fields that start with `address_line` provide the address's most specific + details, like street number, street name, and building name. They do *not* + provide less specific details like city, state/province, or country (these + details are provided in other fields). + """ + + address_line2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="address_line_2")] = ( + pydantic.Field(default=None) + ) + """ + The second line of the address, if any. + """ + + address_line3: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="address_line_3")] = ( + pydantic.Field(default=None) + ) + """ + The third line of the address, if any. + """ + + locality: typing.Optional[str] = pydantic.Field(default=None) + """ + The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + sublocality: typing.Optional[str] = pydantic.Field(default=None) + """ + A civil region within the address's `locality`, if any. + """ + + sublocality2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="sublocality_2")] = ( + pydantic.Field(default=None) + ) + """ + A civil region within the address's `sublocality`, if any. + """ + + sublocality3: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="sublocality_3")] = ( + pydantic.Field(default=None) + ) + """ + A civil region within the address's `sublocality_2`, if any. + """ + + administrative_district_level1: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="administrative_district_level_1") + ] = pydantic.Field(default=None) + """ + A civil entity within the address's country. In the US, this + is the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + administrative_district_level2: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="administrative_district_level_2") + ] = pydantic.Field(default=None) + """ + A civil entity within the address's `administrative_district_level_1`. + In the US, this is the county. + """ + + administrative_district_level3: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="administrative_district_level_3") + ] = pydantic.Field(default=None) + """ + A civil entity within the address's `administrative_district_level_2`, + if any. + """ + + postal_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). + """ + + country: typing.Optional[Country] = pydantic.Field(default=None) + """ + The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`. + See [Country](#type-country) for possible values + """ + + first_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Optional first name when it's representing recipient. + """ + + last_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Optional last name when it's representing recipient. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/adjust_loyalty_points_response.py b/src/square/types/adjust_loyalty_points_response.py new file mode 100644 index 00000000..f1b92bac --- /dev/null +++ b/src/square/types/adjust_loyalty_points_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_event import LoyaltyEvent +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AdjustLoyaltyPointsResponse(UncheckedBaseModel): + """ + Represents an [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints) request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + event: typing.Optional[LoyaltyEvent] = pydantic.Field(default=None) + """ + The resulting event data for the adjustment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/afterpay_details.py b/src/square/types/afterpay_details.py new file mode 100644 index 00000000..cf691d9b --- /dev/null +++ b/src/square/types/afterpay_details.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AfterpayDetails(UncheckedBaseModel): + """ + Additional details about Afterpay payments. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + Email address on the buyer's Afterpay account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/application_details.py b/src/square/types/application_details.py new file mode 100644 index 00000000..0a040830 --- /dev/null +++ b/src/square/types/application_details.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .application_details_external_square_product import ApplicationDetailsExternalSquareProduct +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ApplicationDetails(UncheckedBaseModel): + """ + Details about the application that took the payment. + """ + + square_product: typing.Optional[ApplicationDetailsExternalSquareProduct] = pydantic.Field(default=None) + """ + The Square product, such as Square Point of Sale (POS), + Square Invoices, or Square Virtual Terminal. + See [ExternalSquareProduct](#type-externalsquareproduct) for possible values + """ + + application_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square ID assigned to the application used to take the payment. + Application developers can use this information to identify payments that + their application processed. + For example, if a developer uses a custom application to process payments, + this field contains the application ID from the Developer Dashboard. + If a seller uses a [Square App Marketplace](https://developer.squareup.com/docs/app-marketplace) + application to process payments, the field contains the corresponding application ID. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/application_details_external_square_product.py b/src/square/types/application_details_external_square_product.py new file mode 100644 index 00000000..fd85383a --- /dev/null +++ b/src/square/types/application_details_external_square_product.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ApplicationDetailsExternalSquareProduct = typing.Union[ + typing.Literal[ + "APPOINTMENTS", + "ECOMMERCE_API", + "INVOICES", + "ONLINE_STORE", + "OTHER", + "RESTAURANTS", + "RETAIL", + "SQUARE_POS", + "TERMINAL_API", + "VIRTUAL_TERMINAL", + ], + typing.Any, +] diff --git a/src/square/types/application_type.py b/src/square/types/application_type.py new file mode 100644 index 00000000..9b5e0515 --- /dev/null +++ b/src/square/types/application_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ApplicationType = typing.Literal["TERMINAL_API"] diff --git a/src/square/types/appointment_segment.py b/src/square/types/appointment_segment.py new file mode 100644 index 00000000..9e8a8b97 --- /dev/null +++ b/src/square/types/appointment_segment.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class AppointmentSegment(UncheckedBaseModel): + """ + Defines an appointment segment of a booking. + """ + + duration_minutes: typing.Optional[int] = pydantic.Field(default=None) + """ + The time span in minutes of an appointment segment. + """ + + service_variation_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment. + """ + + team_member_id: str = pydantic.Field() + """ + The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment. + """ + + service_variation_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The current version of the item variation representing the service booked in this segment. + """ + + intermission_minutes: typing.Optional[int] = pydantic.Field(default=None) + """ + Time between the end of this segment and the beginning of the subsequent segment. + """ + + any_team_member: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the customer accepts any team member, instead of a specific one, to serve this segment. + """ + + resource_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of the seller-accessible resources used for this appointment segment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/archived_state.py b/src/square/types/archived_state.py new file mode 100644 index 00000000..e31bd1ce --- /dev/null +++ b/src/square/types/archived_state.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ArchivedState = typing.Union[ + typing.Literal["ARCHIVED_STATE_NOT_ARCHIVED", "ARCHIVED_STATE_ARCHIVED", "ARCHIVED_STATE_ALL"], typing.Any +] diff --git a/src/square/types/availability.py b/src/square/types/availability.py new file mode 100644 index 00000000..27e210a4 --- /dev/null +++ b/src/square/types/availability.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .appointment_segment import AppointmentSegment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Availability(UncheckedBaseModel): + """ + Defines an appointment slot that encapsulates the appointment segments, location and starting time available for booking. + """ + + start_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339 timestamp specifying the beginning time of the slot available for booking. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location available for booking. + """ + + appointment_segments: typing.Optional[typing.List[AppointmentSegment]] = pydantic.Field(default=None) + """ + The list of appointment segments available for booking + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bank_account.py b/src/square/types/bank_account.py new file mode 100644 index 00000000..6972aa8d --- /dev/null +++ b/src/square/types/bank_account.py @@ -0,0 +1,127 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .country import Country +from .currency import Currency +from .bank_account_type import BankAccountType +import typing +from .bank_account_status import BankAccountStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BankAccount(UncheckedBaseModel): + """ + Represents a bank account. For more information about + linking a bank account to a Square account, see + [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). + """ + + id: str = pydantic.Field() + """ + The unique, Square-issued identifier for the bank account. + """ + + account_number_suffix: str = pydantic.Field() + """ + The last few digits of the account number. + """ + + country: Country = pydantic.Field() + """ + The ISO 3166 Alpha-2 country code where the bank account is based. + See [Country](#type-country) for possible values + """ + + currency: Currency = pydantic.Field() + """ + The 3-character ISO 4217 currency code indicating the operating + currency of the bank account. For example, the currency code for US dollars + is `USD`. + See [Currency](#type-currency) for possible values + """ + + account_type: BankAccountType = pydantic.Field() + """ + The financial purpose of the associated bank account. + See [BankAccountType](#type-bankaccounttype) for possible values + """ + + holder_name: str = pydantic.Field() + """ + Name of the account holder. This name must match the name + on the targeted bank account record. + """ + + primary_bank_identification_number: str = pydantic.Field() + """ + Primary identifier for the bank. For more information, see + [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). + """ + + secondary_bank_identification_number: typing.Optional[str] = pydantic.Field(default=None) + """ + Secondary identifier for the bank. For more information, see + [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). + """ + + debit_mandate_reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Reference identifier that will be displayed to UK bank account owners + when collecting direct debit authorization. Only required for UK bank accounts. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Client-provided identifier for linking the banking account to an entity + in a third-party system (for example, a bank account number or a user identifier). + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location to which the bank account belongs. + """ + + status: BankAccountStatus = pydantic.Field() + """ + Read-only. The current verification status of this BankAccount object. + See [BankAccountStatus](#type-bankaccountstatus) for possible values + """ + + creditable: bool = pydantic.Field() + """ + Indicates whether it is possible for Square to send money to this bank account. + """ + + debitable: bool = pydantic.Field() + """ + Indicates whether it is possible for Square to take money from this + bank account. + """ + + fingerprint: typing.Optional[str] = pydantic.Field(default=None) + """ + A Square-assigned, unique identifier for the bank account based on the + account information. The account fingerprint can be used to compare account + entries and determine if the they represent the same real-world bank account. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The current version of the `BankAccount`. + """ + + bank_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Read only. Name of actual financial institution. + For example "Bank of America". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bank_account_payment_details.py b/src/square/types/bank_account_payment_details.py new file mode 100644 index 00000000..322e9995 --- /dev/null +++ b/src/square/types/bank_account_payment_details.py @@ -0,0 +1,66 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .ach_details import AchDetails +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BankAccountPaymentDetails(UncheckedBaseModel): + """ + Additional details about BANK_ACCOUNT type payments. + """ + + bank_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the bank associated with the bank account. + """ + + transfer_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The type of the bank transfer. The type can be `ACH` or `UNKNOWN`. + """ + + account_ownership_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The ownership type of the bank account performing the transfer. + The type can be `INDIVIDUAL`, `COMPANY`, or `ACCOUNT_TYPE_UNKNOWN`. + """ + + fingerprint: typing.Optional[str] = pydantic.Field(default=None) + """ + Uniquely identifies the bank account for this seller and can be used + to determine if payments are from the same bank account. + """ + + country: typing.Optional[str] = pydantic.Field(default=None) + """ + The two-letter ISO code representing the country the bank account is located in. + """ + + statement_description: typing.Optional[str] = pydantic.Field(default=None) + """ + The statement description as sent to the bank. + """ + + ach_details: typing.Optional[AchDetails] = pydantic.Field(default=None) + """ + ACH-specific information about the transfer. The information is only populated + if the `transfer_type` is `ACH`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bank_account_status.py b/src/square/types/bank_account_status.py new file mode 100644 index 00000000..acb22001 --- /dev/null +++ b/src/square/types/bank_account_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BankAccountStatus = typing.Union[typing.Literal["VERIFICATION_IN_PROGRESS", "VERIFIED", "DISABLED"], typing.Any] diff --git a/src/square/types/bank_account_type.py b/src/square/types/bank_account_type.py new file mode 100644 index 00000000..53626337 --- /dev/null +++ b/src/square/types/bank_account_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BankAccountType = typing.Union[ + typing.Literal["CHECKING", "SAVINGS", "INVESTMENT", "OTHER", "BUSINESS_CHECKING"], typing.Any +] diff --git a/src/square/types/batch_change_inventory_request.py b/src/square/types/batch_change_inventory_request.py new file mode 100644 index 00000000..b07be8df --- /dev/null +++ b/src/square/types/batch_change_inventory_request.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .inventory_change import InventoryChange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchChangeInventoryRequest(UncheckedBaseModel): + idempotency_key: str = pydantic.Field() + """ + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + """ + + changes: typing.Optional[typing.List[InventoryChange]] = pydantic.Field(default=None) + """ + The set of physical counts and inventory adjustments to be made. + Changes are applied based on the client-supplied timestamp and may be sent + out of order. + """ + + ignore_unchanged_counts: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the current physical count should be ignored if + the quantity is unchanged since the last physical count. Default: `true`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_change_inventory_response.py b/src/square/types/batch_change_inventory_response.py new file mode 100644 index 00000000..0f992bab --- /dev/null +++ b/src/square/types/batch_change_inventory_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_count import InventoryCount +from .inventory_change import InventoryChange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchChangeInventoryResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + counts: typing.Optional[typing.List[InventoryCount]] = pydantic.Field(default=None) + """ + The current counts for all objects referenced in the request. + """ + + changes: typing.Optional[typing.List[InventoryChange]] = pydantic.Field(default=None) + """ + Changes created for the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_create_team_members_response.py b/src/square/types/batch_create_team_members_response.py new file mode 100644 index 00000000..19f93d61 --- /dev/null +++ b/src/square/types/batch_create_team_members_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .create_team_member_response import CreateTeamMemberResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchCreateTeamMembersResponse(UncheckedBaseModel): + """ + Represents a response from a bulk create request containing the created `TeamMember` objects or error messages. + """ + + team_members: typing.Optional[typing.Dict[str, CreateTeamMemberResponse]] = pydantic.Field(default=None) + """ + The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_create_vendors_response.py b/src/square/types/batch_create_vendors_response.py new file mode 100644 index 00000000..3ab97f2e --- /dev/null +++ b/src/square/types/batch_create_vendors_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .create_vendor_response import CreateVendorResponse +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchCreateVendorsResponse(UncheckedBaseModel): + """ + Represents an output from a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + responses: typing.Optional[typing.Dict[str, CreateVendorResponse]] = pydantic.Field(default=None) + """ + A set of [CreateVendorResponse](entity:CreateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor) + objects or error responses for failed attempts. The set is represented by + a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified + in the input. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_delete_catalog_objects_response.py b/src/square/types/batch_delete_catalog_objects_response.py new file mode 100644 index 00000000..a59d6ba6 --- /dev/null +++ b/src/square/types/batch_delete_catalog_objects_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchDeleteCatalogObjectsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + deleted_object_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of all CatalogObjects deleted by this request. + """ + + deleted_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_get_catalog_objects_response.py b/src/square/types/batch_get_catalog_objects_response.py new file mode 100644 index 00000000..57ca01ca --- /dev/null +++ b/src/square/types/batch_get_catalog_objects_response.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchGetCatalogObjectsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + A list of [CatalogObject](entity:CatalogObject)s returned. + """ + + related_objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + A list of [CatalogObject](entity:CatalogObject)s referenced by the object in the `objects` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_get_inventory_changes_response.py b/src/square/types/batch_get_inventory_changes_response.py new file mode 100644 index 00000000..6d4225a9 --- /dev/null +++ b/src/square/types/batch_get_inventory_changes_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_change import InventoryChange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchGetInventoryChangesResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + changes: typing.Optional[typing.List[InventoryChange]] = pydantic.Field(default=None) + """ + The current calculated inventory changes for the requested objects + and locations. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_get_inventory_counts_request.py b/src/square/types/batch_get_inventory_counts_request.py new file mode 100644 index 00000000..4b5d166d --- /dev/null +++ b/src/square/types/batch_get_inventory_counts_request.py @@ -0,0 +1,57 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_state import InventoryState +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchGetInventoryCountsRequest(UncheckedBaseModel): + catalog_object_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The filter to return results by `CatalogObject` ID. + The filter is applicable only when set. The default is null. + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The filter to return results by `Location` ID. + This filter is applicable only when set. The default is null. + """ + + updated_after: typing.Optional[str] = pydantic.Field(default=None) + """ + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + states: typing.Optional[typing.List[InventoryState]] = pydantic.Field(default=None) + """ + The filter to return results by `InventoryState`. The filter is only applicable when set. + Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. + The default is null. + """ + + limit: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of [records](entity:InventoryCount) to return. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_get_inventory_counts_response.py b/src/square/types/batch_get_inventory_counts_response.py new file mode 100644 index 00000000..26111e33 --- /dev/null +++ b/src/square/types/batch_get_inventory_counts_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_count import InventoryCount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchGetInventoryCountsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + counts: typing.Optional[typing.List[InventoryCount]] = pydantic.Field(default=None) + """ + The current calculated inventory counts for the requested objects + and locations. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_get_orders_response.py b/src/square/types/batch_get_orders_response.py new file mode 100644 index 00000000..735f6795 --- /dev/null +++ b/src/square/types/batch_get_orders_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchGetOrdersResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `BatchRetrieveOrders` endpoint. + """ + + orders: typing.Optional[typing.List[Order]] = pydantic.Field(default=None) + """ + The requested orders. This will omit any requested orders that do not exist. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_get_vendors_response.py b/src/square/types/batch_get_vendors_response.py new file mode 100644 index 00000000..b88d2efe --- /dev/null +++ b/src/square/types/batch_get_vendors_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .get_vendor_response import GetVendorResponse +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchGetVendorsResponse(UncheckedBaseModel): + """ + Represents an output from a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + responses: typing.Optional[typing.Dict[str, GetVendorResponse]] = pydantic.Field(default=None) + """ + The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](entity:Vendor) + objects or error responses for failed attempts. The set is represented by + a collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_retrieve_inventory_changes_request.py b/src/square/types/batch_retrieve_inventory_changes_request.py new file mode 100644 index 00000000..5659616b --- /dev/null +++ b/src/square/types/batch_retrieve_inventory_changes_request.py @@ -0,0 +1,71 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_change_type import InventoryChangeType +from .inventory_state import InventoryState +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchRetrieveInventoryChangesRequest(UncheckedBaseModel): + catalog_object_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The filter to return results by `CatalogObject` ID. + The filter is only applicable when set. The default value is null. + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The filter to return results by `Location` ID. + The filter is only applicable when set. The default value is null. + """ + + types: typing.Optional[typing.List[InventoryChangeType]] = pydantic.Field(default=None) + """ + The filter to return results by `InventoryChangeType` values other than `TRANSFER`. + The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. + """ + + states: typing.Optional[typing.List[InventoryState]] = pydantic.Field(default=None) + """ + The filter to return `ADJUSTMENT` query results by + `InventoryState`. This filter is only applied when set. + The default value is null. + """ + + updated_after: typing.Optional[str] = pydantic.Field(default=None) + """ + The filter to return results with their `calculated_at` value + after the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + """ + + updated_before: typing.Optional[str] = pydantic.Field(default=None) + """ + The filter to return results with their `created_at` or `calculated_at` value + strictly before the given time as specified in an RFC 3339 timestamp. + The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + limit: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of [records](entity:InventoryChange) to return. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_update_team_members_response.py b/src/square/types/batch_update_team_members_response.py new file mode 100644 index 00000000..479f4a00 --- /dev/null +++ b/src/square/types/batch_update_team_members_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .update_team_member_response import UpdateTeamMemberResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchUpdateTeamMembersResponse(UncheckedBaseModel): + """ + Represents a response from a bulk update request containing the updated `TeamMember` objects or error messages. + """ + + team_members: typing.Optional[typing.Dict[str, UpdateTeamMemberResponse]] = pydantic.Field(default=None) + """ + The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_update_vendors_response.py b/src/square/types/batch_update_vendors_response.py new file mode 100644 index 00000000..dc30f6ca --- /dev/null +++ b/src/square/types/batch_update_vendors_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .update_vendor_response import UpdateVendorResponse +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchUpdateVendorsResponse(UncheckedBaseModel): + """ + Represents an output from a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered when the request fails. + """ + + responses: typing.Optional[typing.Dict[str, UpdateVendorResponse]] = pydantic.Field(default=None) + """ + A set of [UpdateVendorResponse](entity:UpdateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor) + objects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or + `Vendor`-ID/error-object pairs. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_upsert_catalog_objects_response.py b/src/square/types/batch_upsert_catalog_objects_response.py new file mode 100644 index 00000000..64381bcd --- /dev/null +++ b/src/square/types/batch_upsert_catalog_objects_response.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from .catalog_id_mapping import CatalogIdMapping +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchUpsertCatalogObjectsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + The created successfully created CatalogObjects. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". + """ + + id_mappings: typing.Optional[typing.List[CatalogIdMapping]] = pydantic.Field(default=None) + """ + The mapping between client and server IDs for this upsert. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.py b/src/square/types/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.py new file mode 100644 index 00000000..f1419dd7 --- /dev/null +++ b/src/square/types/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .custom_attribute import CustomAttribute +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest(UncheckedBaseModel): + """ + Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) + request. An individual request contains a customer ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + customer_id: str = pydantic.Field() + """ + The ID of the target [customer profile](entity:Customer). + """ + + custom_attribute: CustomAttribute = pydantic.Field() + """ + The custom attribute to create or update, with following fields: + + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for update operations, include this optional field in the request and set the + value to the current version of the custom attribute. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_upsert_customer_custom_attributes_response.py b/src/square/types/batch_upsert_customer_custom_attributes_response.py new file mode 100644 index 00000000..d39627ef --- /dev/null +++ b/src/square/types/batch_upsert_customer_custom_attributes_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response import ( + BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse, +) +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchUpsertCustomerCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing.Optional[ + typing.Dict[str, BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse] + ] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `customer_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.py b/src/square/types/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.py new file mode 100644 index 00000000..52407342 --- /dev/null +++ b/src/square/types/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .custom_attribute import CustomAttribute +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BatchUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse(UncheckedBaseModel): + """ + Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) operation. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the customer profile associated with the custom attribute. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred while processing the individual request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking.py b/src/square/types/booking.py new file mode 100644 index 00000000..54e6f2e0 --- /dev/null +++ b/src/square/types/booking.py @@ -0,0 +1,119 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .booking_status import BookingStatus +from .appointment_segment import AppointmentSegment +from .business_appointment_settings_booking_location_type import BusinessAppointmentSettingsBookingLocationType +from .booking_creator_details import BookingCreatorDetails +from .booking_booking_source import BookingBookingSource +from .address import Address +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Booking(UncheckedBaseModel): + """ + Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service + at a given location to a requesting customer in one or more appointment segments. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID of this object representing a booking. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The revision number for the booking used for optimistic concurrency. + """ + + status: typing.Optional[BookingStatus] = pydantic.Field(default=None) + """ + The status of the booking, describing where the booking stands with respect to the booking state machine. + See [BookingStatus](#type-bookingstatus) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339 timestamp specifying the creation time of this booking. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339 timestamp specifying the most recent update time of this booking. + """ + + start_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339 timestamp specifying the starting time of this booking. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service. + """ + + customer_note: typing.Optional[str] = pydantic.Field(default=None) + """ + The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance. + """ + + seller_note: typing.Optional[str] = pydantic.Field(default=None) + """ + The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance. + This field should not be visible to customers. + """ + + appointment_segments: typing.Optional[typing.List[AppointmentSegment]] = pydantic.Field(default=None) + """ + A list of appointment segments for this booking. + """ + + transition_time_minutes: typing.Optional[int] = pydantic.Field(default=None) + """ + Additional time at the end of a booking. + Applications should not make this field visible to customers of a seller. + """ + + all_day: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the booking is of a full business day. + """ + + location_type: typing.Optional[BusinessAppointmentSettingsBookingLocationType] = pydantic.Field(default=None) + """ + The type of location where the booking is held. + See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values + """ + + creator_details: typing.Optional[BookingCreatorDetails] = pydantic.Field(default=None) + """ + Information about the booking creator. + """ + + source: typing.Optional[BookingBookingSource] = pydantic.Field(default=None) + """ + The source of the booking. + Access to this field requires seller-level permissions. + See [BookingBookingSource](#type-bookingbookingsource) for possible values + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + Stores a customer address if the location type is `CUSTOMER_LOCATION`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking_booking_source.py b/src/square/types/booking_booking_source.py new file mode 100644 index 00000000..c0d34cc0 --- /dev/null +++ b/src/square/types/booking_booking_source.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BookingBookingSource = typing.Union[ + typing.Literal["FIRST_PARTY_MERCHANT", "FIRST_PARTY_BUYER", "THIRD_PARTY_BUYER", "API"], typing.Any +] diff --git a/src/square/types/booking_creator_details.py b/src/square/types/booking_creator_details.py new file mode 100644 index 00000000..9e37b5bd --- /dev/null +++ b/src/square/types/booking_creator_details.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking_creator_details_creator_type import BookingCreatorDetailsCreatorType +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BookingCreatorDetails(UncheckedBaseModel): + """ + Information about a booking creator. + """ + + creator_type: typing.Optional[BookingCreatorDetailsCreatorType] = pydantic.Field(default=None) + """ + The seller-accessible type of the creator of the booking. + See [BookingCreatorDetailsCreatorType](#type-bookingcreatordetailscreatortype) for possible values + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type. + Access to this field requires seller-level permissions. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type. + Access to this field requires seller-level permissions. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking_creator_details_creator_type.py b/src/square/types/booking_creator_details_creator_type.py new file mode 100644 index 00000000..9a6be86e --- /dev/null +++ b/src/square/types/booking_creator_details_creator_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BookingCreatorDetailsCreatorType = typing.Union[typing.Literal["TEAM_MEMBER", "CUSTOMER"], typing.Any] diff --git a/src/square/types/booking_custom_attribute_delete_request.py b/src/square/types/booking_custom_attribute_delete_request.py new file mode 100644 index 00000000..c429f342 --- /dev/null +++ b/src/square/types/booking_custom_attribute_delete_request.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class BookingCustomAttributeDeleteRequest(UncheckedBaseModel): + """ + Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) + request. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key. + """ + + booking_id: str = pydantic.Field() + """ + The ID of the target [booking](entity:Booking). + """ + + key: str = pydantic.Field() + """ + The key of the custom attribute to delete. This key must match the `key` of a + custom attribute definition in the Square seller account. If the requesting application is not + the definition owner, you must use the qualified key. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking_custom_attribute_delete_response.py b/src/square/types/booking_custom_attribute_delete_response.py new file mode 100644 index 00000000..0c1bf332 --- /dev/null +++ b/src/square/types/booking_custom_attribute_delete_response.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BookingCustomAttributeDeleteResponse(UncheckedBaseModel): + """ + Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) operation. + """ + + booking_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [booking](entity:Booking) associated with the custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred while processing the individual request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking_custom_attribute_upsert_request.py b/src/square/types/booking_custom_attribute_upsert_request.py new file mode 100644 index 00000000..23fa6d38 --- /dev/null +++ b/src/square/types/booking_custom_attribute_upsert_request.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .custom_attribute import CustomAttribute +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BookingCustomAttributeUpsertRequest(UncheckedBaseModel): + """ + Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) + request. An individual request contains a booking ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + booking_id: str = pydantic.Field() + """ + The ID of the target [booking](entity:Booking). + """ + + custom_attribute: CustomAttribute = pydantic.Field() + """ + The custom attribute to create or update, with following fields: + + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control for update operations, include this optional field in the request and set the + value to the current version of the custom attribute. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking_custom_attribute_upsert_response.py b/src/square/types/booking_custom_attribute_upsert_response.py new file mode 100644 index 00000000..50f15a02 --- /dev/null +++ b/src/square/types/booking_custom_attribute_upsert_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .custom_attribute import CustomAttribute +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BookingCustomAttributeUpsertResponse(UncheckedBaseModel): + """ + Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) operation. + """ + + booking_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [booking](entity:Booking) associated with the custom attribute. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred while processing the individual request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/booking_status.py b/src/square/types/booking_status.py new file mode 100644 index 00000000..662cbd32 --- /dev/null +++ b/src/square/types/booking_status.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BookingStatus = typing.Union[ + typing.Literal["PENDING", "CANCELLED_BY_CUSTOMER", "CANCELLED_BY_SELLER", "DECLINED", "ACCEPTED", "NO_SHOW"], + typing.Any, +] diff --git a/src/square/types/break_.py b/src/square/types/break_.py new file mode 100644 index 00000000..3dca5691 --- /dev/null +++ b/src/square/types/break_.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Break(UncheckedBaseModel): + """ + A record of an employee's break during a shift. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The UUID for this object. + """ + + start_at: str = pydantic.Field() + """ + RFC 3339; follows the same timezone information as `Shift`. Precision up to + the minute is respected; seconds are truncated. + """ + + end_at: typing.Optional[str] = pydantic.Field(default=None) + """ + RFC 3339; follows the same timezone information as `Shift`. Precision up to + the minute is respected; seconds are truncated. + """ + + break_type_id: str = pydantic.Field() + """ + The `BreakType` that this `Break` was templated on. + """ + + name: str = pydantic.Field() + """ + A human-readable name. + """ + + expected_duration: str = pydantic.Field() + """ + Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of + the break. + """ + + is_paid: bool = pydantic.Field() + """ + Whether this break counts towards time worked for compensation + purposes. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/break_type.py b/src/square/types/break_type.py new file mode 100644 index 00000000..ef2033d4 --- /dev/null +++ b/src/square/types/break_type.py @@ -0,0 +1,70 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BreakType(UncheckedBaseModel): + """ + A defined break template that sets an expectation for possible `Break` + instances on a `Shift`. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The UUID for this object. + """ + + location_id: str = pydantic.Field() + """ + The ID of the business location this type of break applies to. + """ + + break_name: str = pydantic.Field() + """ + A human-readable name for this type of break. The name is displayed to + employees in Square products. + """ + + expected_duration: str = pydantic.Field() + """ + Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of + this break. Precision less than minutes is truncated. + + Example for break expected duration of 15 minutes: T15M + """ + + is_paid: bool = pydantic.Field() + """ + Whether this break counts towards time worked for compensation + purposes. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If a value is not + provided, Square's servers execute a "blind" write; potentially + overwriting another writer's data. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_create_customer_data.py b/src/square/types/bulk_create_customer_data.py new file mode 100644 index 00000000..f1ceff45 --- /dev/null +++ b/src/square/types/bulk_create_customer_data.py @@ -0,0 +1,89 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .customer_tax_ids import CustomerTaxIds +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkCreateCustomerData(UncheckedBaseModel): + """ + Defines the customer data provided in individual create requests for a + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) operation. + """ + + given_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The given name (that is, the first name) associated with the customer profile. + """ + + family_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The family name (that is, the last name) associated with the customer profile. + """ + + company_name: typing.Optional[str] = pydantic.Field(default=None) + """ + A business name associated with the customer profile. + """ + + nickname: typing.Optional[str] = pydantic.Field(default=None) + """ + A nickname for the customer profile. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address associated with the customer profile. + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The physical address associated with the customer profile. For maximum length constraints, + see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number associated with the customer profile. The phone number must be valid + and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, + see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional second ID used to associate the customer profile with an + entity in another system. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + A custom note associated with the customer profile. + """ + + birthday: typing.Optional[str] = pydantic.Field(default=None) + """ + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. + For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. + Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or + `0000` if a birth year is not specified. + """ + + tax_ids: typing.Optional[CustomerTaxIds] = pydantic.Field(default=None) + """ + The tax ID associated with the customer profile. This field is available only for + customers of sellers in EU countries or the United Kingdom. For more information, see + [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_create_customers_response.py b/src/square/types/bulk_create_customers_response.py new file mode 100644 index 00000000..abd227cc --- /dev/null +++ b/src/square/types/bulk_create_customers_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .create_customer_response import CreateCustomerResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkCreateCustomersResponse(UncheckedBaseModel): + """ + Defines the fields included in the response body from the + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint. + """ + + responses: typing.Optional[typing.Dict[str, CreateCustomerResponse]] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual create requests, represented by + key-value pairs. + + Each key is the idempotency key that was provided for a create request and each value + is the corresponding response. + If the request succeeds, the value is the new customer profile. + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any top-level errors that prevented the bulk operation from running. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_booking_custom_attributes_response.py b/src/square/types/bulk_delete_booking_custom_attributes_response.py new file mode 100644 index 00000000..e55207e6 --- /dev/null +++ b/src/square/types/bulk_delete_booking_custom_attributes_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking_custom_attribute_delete_response import BookingCustomAttributeDeleteResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteBookingCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) response, + which contains a map of responses that each corresponds to an individual delete request. + """ + + values: typing.Optional[typing.Dict[str, BookingCustomAttributeDeleteResponse]] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual delete requests. Each response has the + same ID as the corresponding request and contains `booking_id` and `errors` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_customers_response.py b/src/square/types/bulk_delete_customers_response.py new file mode 100644 index 00000000..02e20618 --- /dev/null +++ b/src/square/types/bulk_delete_customers_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .delete_customer_response import DeleteCustomerResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteCustomersResponse(UncheckedBaseModel): + """ + Defines the fields included in the response body from the + [BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) endpoint. + """ + + responses: typing.Optional[typing.Dict[str, DeleteCustomerResponse]] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual delete requests, represented by + key-value pairs. + + Each key is the customer ID that was specified for a delete request and each value + is the corresponding response. + If the request succeeds, the value is an empty object (`{ }`). + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any top-level errors that prevented the bulk operation from running. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.py b/src/square/types/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.py new file mode 100644 index 00000000..83aa75e4 --- /dev/null +++ b/src/square/types/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest(UncheckedBaseModel): + """ + Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + request. An individual request contains an optional ID of the associated custom attribute definition + and optional key of the associated custom attribute definition. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + The key of the associated custom attribute definition. + Represented as a qualified key if the requesting app is not the definition owner. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_location_custom_attributes_response.py b/src/square/types/bulk_delete_location_custom_attributes_response.py new file mode 100644 index 00000000..dd0bfcad --- /dev/null +++ b/src/square/types/bulk_delete_location_custom_attributes_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response import ( + BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse, +) +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteLocationCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) response, + which contains a map of responses that each corresponds to an individual delete request. + """ + + values: typing.Dict[str, BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse] = ( + pydantic.Field() + ) + """ + A map of responses that correspond to individual delete requests. Each response has the + same key as the corresponding request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.py b/src/square/types/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.py new file mode 100644 index 00000000..fb405c65 --- /dev/null +++ b/src/square/types/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse(UncheckedBaseModel): + """ + Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) + request. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location associated with the custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.py b/src/square/types/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.py new file mode 100644 index 00000000..58c44699 --- /dev/null +++ b/src/square/types/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest(UncheckedBaseModel): + """ + Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + request. An individual request contains an optional ID of the associated custom attribute definition + and optional key of the associated custom attribute definition. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + The key of the associated custom attribute definition. + Represented as a qualified key if the requesting app is not the definition owner. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_merchant_custom_attributes_response.py b/src/square/types/bulk_delete_merchant_custom_attributes_response.py new file mode 100644 index 00000000..52f05920 --- /dev/null +++ b/src/square/types/bulk_delete_merchant_custom_attributes_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response import ( + BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse, +) +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteMerchantCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) response, + which contains a map of responses that each corresponds to an individual delete request. + """ + + values: typing.Dict[str, BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse] = ( + pydantic.Field() + ) + """ + A map of responses that correspond to individual delete requests. Each response has the + same key as the corresponding request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.py b/src/square/types/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.py new file mode 100644 index 00000000..e19318b9 --- /dev/null +++ b/src/square/types/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse(UncheckedBaseModel): + """ + Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) + request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred while processing the individual MerchantCustomAttributeDeleteRequest request + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_order_custom_attributes_request_delete_custom_attribute.py b/src/square/types/bulk_delete_order_custom_attributes_request_delete_custom_attribute.py new file mode 100644 index 00000000..bee10c47 --- /dev/null +++ b/src/square/types/bulk_delete_order_custom_attributes_request_delete_custom_attribute.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute(UncheckedBaseModel): + """ + Represents one delete within the bulk operation. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + The key of the custom attribute to delete. This key must match the key + of an existing custom attribute definition. + """ + + order_id: str = pydantic.Field() + """ + The ID of the target [order](entity:Order). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_delete_order_custom_attributes_response.py b/src/square/types/bulk_delete_order_custom_attributes_response.py new file mode 100644 index 00000000..09d1e52c --- /dev/null +++ b/src/square/types/bulk_delete_order_custom_attributes_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .delete_order_custom_attribute_response import DeleteOrderCustomAttributeResponse +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkDeleteOrderCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a response from deleting one or more order custom attributes. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + values: typing.Dict[str, DeleteOrderCustomAttributeResponse] = pydantic.Field() + """ + A map of responses that correspond to individual delete requests. Each response has the same ID + as the corresponding request and contains either a `custom_attribute` or an `errors` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_retrieve_bookings_response.py b/src/square/types/bulk_retrieve_bookings_response.py new file mode 100644 index 00000000..5921446a --- /dev/null +++ b/src/square/types/bulk_retrieve_bookings_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .get_booking_response import GetBookingResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkRetrieveBookingsResponse(UncheckedBaseModel): + """ + Response payload for bulk retrieval of bookings. + """ + + bookings: typing.Optional[typing.Dict[str, GetBookingResponse]] = pydantic.Field(default=None) + """ + Requested bookings returned as a map containing `booking_id` as the key and `RetrieveBookingResponse` as the value. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_retrieve_customers_response.py b/src/square/types/bulk_retrieve_customers_response.py new file mode 100644 index 00000000..37fe6bdc --- /dev/null +++ b/src/square/types/bulk_retrieve_customers_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .get_customer_response import GetCustomerResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkRetrieveCustomersResponse(UncheckedBaseModel): + """ + Defines the fields included in the response body from the + [BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) endpoint. + """ + + responses: typing.Optional[typing.Dict[str, GetCustomerResponse]] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual retrieve requests, represented by + key-value pairs. + + Each key is the customer ID that was specified for a retrieve request and each value + is the corresponding response. + If the request succeeds, the value is the requested customer profile. + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any top-level errors that prevented the bulk operation from running. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_retrieve_team_member_booking_profiles_response.py b/src/square/types/bulk_retrieve_team_member_booking_profiles_response.py new file mode 100644 index 00000000..5c9f6c30 --- /dev/null +++ b/src/square/types/bulk_retrieve_team_member_booking_profiles_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .get_team_member_booking_profile_response import GetTeamMemberBookingProfileResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkRetrieveTeamMemberBookingProfilesResponse(UncheckedBaseModel): + """ + Response payload for the [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles) endpoint. + """ + + team_member_booking_profiles: typing.Optional[typing.Dict[str, GetTeamMemberBookingProfileResponse]] = ( + pydantic.Field(default=None) + ) + """ + The returned team members' booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](entity:TeamMemberBookingProfile) the value. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_swap_plan_response.py b/src/square/types/bulk_swap_plan_response.py new file mode 100644 index 00000000..ed661de4 --- /dev/null +++ b/src/square/types/bulk_swap_plan_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkSwapPlanResponse(UncheckedBaseModel): + """ + Defines output parameters in a response of the + [BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + affected_subscriptions: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of affected subscriptions. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_update_customer_data.py b/src/square/types/bulk_update_customer_data.py new file mode 100644 index 00000000..03236b08 --- /dev/null +++ b/src/square/types/bulk_update_customer_data.py @@ -0,0 +1,98 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .customer_tax_ids import CustomerTaxIds +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpdateCustomerData(UncheckedBaseModel): + """ + Defines the customer data provided in individual update requests for a + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) operation. + """ + + given_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The given name (that is, the first name) associated with the customer profile. + """ + + family_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The family name (that is, the last name) associated with the customer profile. + """ + + company_name: typing.Optional[str] = pydantic.Field(default=None) + """ + A business name associated with the customer profile. + """ + + nickname: typing.Optional[str] = pydantic.Field(default=None) + """ + A nickname for the customer profile. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address associated with the customer profile. + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The physical address associated with the customer profile. For maximum length constraints, + see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). + The `first_name` and `last_name` fields are ignored if they are present in the request. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number associated with the customer profile. The phone number must be valid + and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, + see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional second ID used to associate the customer profile with an + entity in another system. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + An custom note associates with the customer profile. + """ + + birthday: typing.Optional[str] = pydantic.Field(default=None) + """ + The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. + For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. + Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or + `0000` if a birth year is not specified. + """ + + tax_ids: typing.Optional[CustomerTaxIds] = pydantic.Field(default=None) + """ + The tax ID associated with the customer profile. This field is available only for + customers of sellers in EU countries or the United Kingdom. For more information, see + [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The current version of the customer profile. + + As a best practice, you should include this field to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_update_customers_response.py b/src/square/types/bulk_update_customers_response.py new file mode 100644 index 00000000..755cd8bc --- /dev/null +++ b/src/square/types/bulk_update_customers_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .update_customer_response import UpdateCustomerResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpdateCustomersResponse(UncheckedBaseModel): + """ + Defines the fields included in the response body from the + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint. + """ + + responses: typing.Optional[typing.Dict[str, UpdateCustomerResponse]] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual update requests, represented by + key-value pairs. + + Each key is the customer ID that was specified for an update request and each value + is the corresponding response. + If the request succeeds, the value is the updated customer profile. + If the request fails, the value contains any errors that occurred during the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any top-level errors that prevented the bulk operation from running. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_booking_custom_attributes_response.py b/src/square/types/bulk_upsert_booking_custom_attributes_response.py new file mode 100644 index 00000000..e9631e7a --- /dev/null +++ b/src/square/types/bulk_upsert_booking_custom_attributes_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking_custom_attribute_upsert_response import BookingCustomAttributeUpsertResponse +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertBookingCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing.Optional[typing.Dict[str, BookingCustomAttributeUpsertResponse]] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `booking_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.py b/src/square/types/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.py new file mode 100644 index 00000000..c6024c34 --- /dev/null +++ b/src/square/types/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .custom_attribute import CustomAttribute +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest(UncheckedBaseModel): + """ + Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) + request. An individual request contains a location ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + location_id: str = pydantic.Field() + """ + The ID of the target [location](entity:Location). + """ + + custom_attribute: CustomAttribute = pydantic.Field() + """ + The custom attribute to create or update, with following fields: + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types).. + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, specify the current version of the custom attribute. + If this is not important for your application, `version` can be set to -1. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_location_custom_attributes_response.py b/src/square/types/bulk_upsert_location_custom_attributes_response.py new file mode 100644 index 00000000..71212b1d --- /dev/null +++ b/src/square/types/bulk_upsert_location_custom_attributes_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response import ( + BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse, +) +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertLocationCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing.Optional[ + typing.Dict[str, BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse] + ] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `location_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.py b/src/square/types/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.py new file mode 100644 index 00000000..62b7d92b --- /dev/null +++ b/src/square/types/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .custom_attribute import CustomAttribute +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse(UncheckedBaseModel): + """ + Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) operation. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location associated with the custom attribute. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred while processing the individual request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.py b/src/square/types/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.py new file mode 100644 index 00000000..b8c0be43 --- /dev/null +++ b/src/square/types/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .custom_attribute import CustomAttribute +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest(UncheckedBaseModel): + """ + Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) + request. An individual request contains a merchant ID, the custom attribute to create or update, + and an optional idempotency key. + """ + + merchant_id: str = pydantic.Field() + """ + The ID of the target [merchant](entity:Merchant). + """ + + custom_attribute: CustomAttribute = pydantic.Field() + """ + The custom attribute to create or update, with following fields: + - `key`. This key must match the `key` of a custom attribute definition in the Square seller + account. If the requesting application is not the definition owner, you must provide the qualified key. + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Supported data types](https://developer.squareup.com/docs/devtools/customattributes/overview#supported-data-types). + - The version field must match the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique identifier for this individual upsert request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_merchant_custom_attributes_response.py b/src/square/types/bulk_upsert_merchant_custom_attributes_response.py new file mode 100644 index 00000000..65bbe54e --- /dev/null +++ b/src/square/types/bulk_upsert_merchant_custom_attributes_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response import ( + BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse, +) +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertMerchantCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) response, + which contains a map of responses that each corresponds to an individual upsert request. + """ + + values: typing.Optional[ + typing.Dict[str, BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse] + ] = pydantic.Field(default=None) + """ + A map of responses that correspond to individual upsert requests. Each response has the + same ID as the corresponding request and contains either a `merchant_id` and `custom_attribute` or an `errors` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.py b/src/square/types/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.py new file mode 100644 index 00000000..7f890090 --- /dev/null +++ b/src/square/types/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .custom_attribute import CustomAttribute +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse(UncheckedBaseModel): + """ + Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) operation. + """ + + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the merchant associated with the custom attribute. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred while processing the individual request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_order_custom_attributes_request_upsert_custom_attribute.py b/src/square/types/bulk_upsert_order_custom_attributes_request_upsert_custom_attribute.py new file mode 100644 index 00000000..15e06957 --- /dev/null +++ b/src/square/types/bulk_upsert_order_custom_attributes_request_upsert_custom_attribute.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .custom_attribute import CustomAttribute +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute(UncheckedBaseModel): + """ + Represents one upsert within the bulk operation. + """ + + custom_attribute: CustomAttribute = pydantic.Field() + """ + The custom attribute to create or update, with the following fields: + + - `value`. This value must conform to the `schema` specified by the definition. + For more information, see [Value data types](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#value-data-types). + + - `version`. To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) + control, include this optional field and specify the current version of the custom attribute. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique identifier for this request, used to ensure idempotency. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + order_id: str = pydantic.Field() + """ + The ID of the target [order](entity:Order). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/bulk_upsert_order_custom_attributes_response.py b/src/square/types/bulk_upsert_order_custom_attributes_response.py new file mode 100644 index 00000000..4ac16df6 --- /dev/null +++ b/src/square/types/bulk_upsert_order_custom_attributes_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .upsert_order_custom_attribute_response import UpsertOrderCustomAttributeResponse +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BulkUpsertOrderCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a response from a bulk upsert of order custom attributes. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + values: typing.Dict[str, UpsertOrderCustomAttributeResponse] = pydantic.Field() + """ + A map of responses that correspond to individual upsert operations for custom attributes. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/business_appointment_settings.py b/src/square/types/business_appointment_settings.py new file mode 100644 index 00000000..30eddb32 --- /dev/null +++ b/src/square/types/business_appointment_settings.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .business_appointment_settings_booking_location_type import BusinessAppointmentSettingsBookingLocationType +import pydantic +from .business_appointment_settings_alignment_time import BusinessAppointmentSettingsAlignmentTime +from .business_appointment_settings_max_appointments_per_day_limit_type import ( + BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType, +) +from .money import Money +from .business_appointment_settings_cancellation_policy import BusinessAppointmentSettingsCancellationPolicy +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BusinessAppointmentSettings(UncheckedBaseModel): + """ + The service appointment settings, including where and how the service is provided. + """ + + location_types: typing.Optional[typing.List[BusinessAppointmentSettingsBookingLocationType]] = pydantic.Field( + default=None + ) + """ + Types of the location allowed for bookings. + See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values + """ + + alignment_time: typing.Optional[BusinessAppointmentSettingsAlignmentTime] = pydantic.Field(default=None) + """ + The time unit of the service duration for bookings. + See [BusinessAppointmentSettingsAlignmentTime](#type-businessappointmentsettingsalignmenttime) for possible values + """ + + min_booking_lead_time_seconds: typing.Optional[int] = pydantic.Field(default=None) + """ + The minimum lead time in seconds before a service can be booked. A booking must be created at least this amount of time before its starting time. + """ + + max_booking_lead_time_seconds: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum lead time in seconds before a service can be booked. A booking must be created at most this amount of time before its starting time. + """ + + any_team_member_booking_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether a customer can choose from all available time slots and have a staff member assigned + automatically (`true`) or not (`false`). + """ + + multiple_service_booking_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether a customer can book multiple services in a single online booking. + """ + + max_appointments_per_day_limit_type: typing.Optional[BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType] = ( + pydantic.Field(default=None) + ) + """ + Indicates whether the daily appointment limit applies to team members or to + business locations. + See [BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType](#type-businessappointmentsettingsmaxappointmentsperdaylimittype) for possible values + """ + + max_appointments_per_day_limit: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of daily appointments per team member or per location. + """ + + cancellation_window_seconds: typing.Optional[int] = pydantic.Field(default=None) + """ + The cut-off time in seconds for allowing clients to cancel or reschedule an appointment. + """ + + cancellation_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The flat-fee amount charged for a no-show booking. + """ + + cancellation_policy: typing.Optional[BusinessAppointmentSettingsCancellationPolicy] = pydantic.Field(default=None) + """ + The cancellation policy adopted by the seller. + See [BusinessAppointmentSettingsCancellationPolicy](#type-businessappointmentsettingscancellationpolicy) for possible values + """ + + cancellation_policy_text: typing.Optional[str] = pydantic.Field(default=None) + """ + The free-form text of the seller's cancellation policy. + """ + + skip_booking_flow_staff_selection: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether customers has an assigned staff member (`true`) or can select s staff member of their choice (`false`). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/business_appointment_settings_alignment_time.py b/src/square/types/business_appointment_settings_alignment_time.py new file mode 100644 index 00000000..ca455e8f --- /dev/null +++ b/src/square/types/business_appointment_settings_alignment_time.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BusinessAppointmentSettingsAlignmentTime = typing.Union[ + typing.Literal["SERVICE_DURATION", "QUARTER_HOURLY", "HALF_HOURLY", "HOURLY"], typing.Any +] diff --git a/src/square/types/business_appointment_settings_booking_location_type.py b/src/square/types/business_appointment_settings_booking_location_type.py new file mode 100644 index 00000000..7ddd5238 --- /dev/null +++ b/src/square/types/business_appointment_settings_booking_location_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BusinessAppointmentSettingsBookingLocationType = typing.Union[ + typing.Literal["BUSINESS_LOCATION", "CUSTOMER_LOCATION", "PHONE"], typing.Any +] diff --git a/src/square/types/business_appointment_settings_cancellation_policy.py b/src/square/types/business_appointment_settings_cancellation_policy.py new file mode 100644 index 00000000..463117f7 --- /dev/null +++ b/src/square/types/business_appointment_settings_cancellation_policy.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BusinessAppointmentSettingsCancellationPolicy = typing.Union[ + typing.Literal["CANCELLATION_TREATED_AS_NO_SHOW", "CUSTOM_POLICY"], typing.Any +] diff --git a/src/square/types/business_appointment_settings_max_appointments_per_day_limit_type.py b/src/square/types/business_appointment_settings_max_appointments_per_day_limit_type.py new file mode 100644 index 00000000..e5a7680d --- /dev/null +++ b/src/square/types/business_appointment_settings_max_appointments_per_day_limit_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType = typing.Union[ + typing.Literal["PER_TEAM_MEMBER", "PER_LOCATION"], typing.Any +] diff --git a/src/square/types/business_booking_profile.py b/src/square/types/business_booking_profile.py new file mode 100644 index 00000000..3f9fdf40 --- /dev/null +++ b/src/square/types/business_booking_profile.py @@ -0,0 +1,70 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .business_booking_profile_customer_timezone_choice import BusinessBookingProfileCustomerTimezoneChoice +from .business_booking_profile_booking_policy import BusinessBookingProfileBookingPolicy +from .business_appointment_settings import BusinessAppointmentSettings +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BusinessBookingProfile(UncheckedBaseModel): + """ + A seller's business booking profile, including booking policy, appointment settings, etc. + """ + + seller_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the seller, obtainable using the Merchants API. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339 timestamp specifying the booking's creation time. + """ + + booking_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the seller is open for booking. + """ + + customer_timezone_choice: typing.Optional[BusinessBookingProfileCustomerTimezoneChoice] = pydantic.Field( + default=None + ) + """ + The choice of customer's time zone information of a booking. + The Square online booking site and all notifications to customers uses either the seller location’s time zone + or the time zone the customer chooses at booking. + See [BusinessBookingProfileCustomerTimezoneChoice](#type-businessbookingprofilecustomertimezonechoice) for possible values + """ + + booking_policy: typing.Optional[BusinessBookingProfileBookingPolicy] = pydantic.Field(default=None) + """ + The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`). + See [BusinessBookingProfileBookingPolicy](#type-businessbookingprofilebookingpolicy) for possible values + """ + + allow_user_cancel: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether customers can cancel or reschedule their own bookings (`true`) or not (`false`). + """ + + business_appointment_settings: typing.Optional[BusinessAppointmentSettings] = pydantic.Field(default=None) + """ + Settings for appointment-type bookings. + """ + + support_seller_level_writes: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the seller's subscription to Square Appointments supports creating, updating or canceling an appointment through the API (`true`) or not (`false`) using seller permission. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/business_booking_profile_booking_policy.py b/src/square/types/business_booking_profile_booking_policy.py new file mode 100644 index 00000000..4e2be969 --- /dev/null +++ b/src/square/types/business_booking_profile_booking_policy.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BusinessBookingProfileBookingPolicy = typing.Union[typing.Literal["ACCEPT_ALL", "REQUIRES_ACCEPTANCE"], typing.Any] diff --git a/src/square/types/business_booking_profile_customer_timezone_choice.py b/src/square/types/business_booking_profile_customer_timezone_choice.py new file mode 100644 index 00000000..b41e8533 --- /dev/null +++ b/src/square/types/business_booking_profile_customer_timezone_choice.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +BusinessBookingProfileCustomerTimezoneChoice = typing.Union[ + typing.Literal["BUSINESS_LOCATION_TIMEZONE", "CUSTOMER_CHOICE"], typing.Any +] diff --git a/src/square/types/business_hours.py b/src/square/types/business_hours.py new file mode 100644 index 00000000..375eeed8 --- /dev/null +++ b/src/square/types/business_hours.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .business_hours_period import BusinessHoursPeriod +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BusinessHours(UncheckedBaseModel): + """ + The hours of operation for a location. + """ + + periods: typing.Optional[typing.List[BusinessHoursPeriod]] = pydantic.Field(default=None) + """ + The list of time periods during which the business is open. There can be at most 10 periods per day. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/business_hours_period.py b/src/square/types/business_hours_period.py new file mode 100644 index 00000000..d4ca2994 --- /dev/null +++ b/src/square/types/business_hours_period.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .day_of_week import DayOfWeek +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BusinessHoursPeriod(UncheckedBaseModel): + """ + Represents a period of time during which a business location is open. + """ + + day_of_week: typing.Optional[DayOfWeek] = pydantic.Field(default=None) + """ + The day of the week for this time period. + See [DayOfWeek](#type-dayofweek) for possible values + """ + + start_local_time: typing.Optional[str] = pydantic.Field(default=None) + """ + The start time of a business hours period, specified in local time using partial-time + RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + end_local_time: typing.Optional[str] = pydantic.Field(default=None) + """ + The end time of a business hours period, specified in local time using partial-time + RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/buy_now_pay_later_details.py b/src/square/types/buy_now_pay_later_details.py new file mode 100644 index 00000000..26a40cbd --- /dev/null +++ b/src/square/types/buy_now_pay_later_details.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .afterpay_details import AfterpayDetails +from .clearpay_details import ClearpayDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class BuyNowPayLaterDetails(UncheckedBaseModel): + """ + Additional details about a Buy Now Pay Later payment type. + """ + + brand: typing.Optional[str] = pydantic.Field(default=None) + """ + The brand used for the Buy Now Pay Later payment. + The brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`. + """ + + afterpay_details: typing.Optional[AfterpayDetails] = pydantic.Field(default=None) + """ + Details about an Afterpay payment. These details are only populated if the `brand` is + `AFTERPAY`. + """ + + clearpay_details: typing.Optional[ClearpayDetails] = pydantic.Field(default=None) + """ + Details about a Clearpay payment. These details are only populated if the `brand` is + `CLEARPAY`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/calculate_loyalty_points_response.py b/src/square/types/calculate_loyalty_points_response.py new file mode 100644 index 00000000..2afdc678 --- /dev/null +++ b/src/square/types/calculate_loyalty_points_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CalculateLoyaltyPointsResponse(UncheckedBaseModel): + """ + Represents a [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints) response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + points: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of points that the buyer can earn from the base loyalty program. + """ + + promotion_points: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of points that the buyer can earn from a loyalty promotion. To be eligible + to earn promotion points, the purchase must first qualify for program points. When `order_id` + is not provided in the request, this value is always 0. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/calculate_order_response.py b/src/square/types/calculate_order_response.py new file mode 100644 index 00000000..d89ba237 --- /dev/null +++ b/src/square/types/calculate_order_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CalculateOrderResponse(UncheckedBaseModel): + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The calculated version of the order provided in the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_booking_response.py b/src/square/types/cancel_booking_response.py new file mode 100644 index 00000000..ddac7350 --- /dev/null +++ b/src/square/types/cancel_booking_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking import Booking +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelBookingResponse(UncheckedBaseModel): + booking: typing.Optional[Booking] = pydantic.Field(default=None) + """ + The booking that was cancelled. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_invoice_response.py b/src/square/types/cancel_invoice_response.py new file mode 100644 index 00000000..f612eff6 --- /dev/null +++ b/src/square/types/cancel_invoice_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelInvoiceResponse(UncheckedBaseModel): + """ + The response returned by the `CancelInvoice` request. + """ + + invoice: typing.Optional[Invoice] = pydantic.Field(default=None) + """ + The canceled invoice. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_loyalty_promotion_response.py b/src/square/types/cancel_loyalty_promotion_response.py new file mode 100644 index 00000000..d1ade92d --- /dev/null +++ b/src/square/types/cancel_loyalty_promotion_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_promotion import LoyaltyPromotion +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelLoyaltyPromotionResponse(UncheckedBaseModel): + """ + Represents a [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion) response. + Either `loyalty_promotion` or `errors` is present in the response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_promotion: typing.Optional[LoyaltyPromotion] = pydantic.Field(default=None) + """ + The canceled loyalty promotion. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_payment_by_idempotency_key_response.py b/src/square/types/cancel_payment_by_idempotency_key_response.py new file mode 100644 index 00000000..368ec5d3 --- /dev/null +++ b/src/square/types/cancel_payment_by_idempotency_key_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelPaymentByIdempotencyKeyResponse(UncheckedBaseModel): + """ + Defines the response returned by + [CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey). + On success, `errors` is empty. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_payment_response.py b/src/square/types/cancel_payment_response.py new file mode 100644 index 00000000..94a7ac32 --- /dev/null +++ b/src/square/types/cancel_payment_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment import Payment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelPaymentResponse(UncheckedBaseModel): + """ + Defines the response returned by [CancelPayment](api-endpoint:Payments-CancelPayment). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + payment: typing.Optional[Payment] = pydantic.Field(default=None) + """ + The successfully canceled `Payment` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_subscription_response.py b/src/square/types/cancel_subscription_response.py new file mode 100644 index 00000000..63a78284 --- /dev/null +++ b/src/square/types/cancel_subscription_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from .subscription_action import SubscriptionAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelSubscriptionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [CancelSubscription](api-endpoint:Subscriptions-CancelSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The specified subscription scheduled for cancellation according to the action created by the request. + """ + + actions: typing.Optional[typing.List[SubscriptionAction]] = pydantic.Field(default=None) + """ + A list of a single `CANCEL` action scheduled for the subscription. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_terminal_action_response.py b/src/square/types/cancel_terminal_action_response.py new file mode 100644 index 00000000..4e393d9e --- /dev/null +++ b/src/square/types/cancel_terminal_action_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_action import TerminalAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelTerminalActionResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + action: typing.Optional[TerminalAction] = pydantic.Field(default=None) + """ + The canceled `TerminalAction` + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_terminal_checkout_response.py b/src/square/types/cancel_terminal_checkout_response.py new file mode 100644 index 00000000..8a99df36 --- /dev/null +++ b/src/square/types/cancel_terminal_checkout_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_checkout import TerminalCheckout +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelTerminalCheckoutResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + checkout: typing.Optional[TerminalCheckout] = pydantic.Field(default=None) + """ + The canceled `TerminalCheckout`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cancel_terminal_refund_response.py b/src/square/types/cancel_terminal_refund_response.py new file mode 100644 index 00000000..6c73b8af --- /dev/null +++ b/src/square/types/cancel_terminal_refund_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_refund import TerminalRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CancelTerminalRefundResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refund: typing.Optional[TerminalRefund] = pydantic.Field(default=None) + """ + The updated `TerminalRefund`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/capture_transaction_response.py b/src/square/types/capture_transaction_response.py new file mode 100644 index 00000000..a552918f --- /dev/null +++ b/src/square/types/capture_transaction_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CaptureTransactionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/card.py b/src/square/types/card.py new file mode 100644 index 00000000..93aa7eb2 --- /dev/null +++ b/src/square/types/card.py @@ -0,0 +1,156 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .card_brand import CardBrand +import typing_extensions +from ..core.serialization import FieldMetadata +from .address import Address +from .card_type import CardType +from .card_prepaid_type import CardPrepaidType +from .card_co_brand import CardCoBrand +from .card_issuer_alert import CardIssuerAlert +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Card(UncheckedBaseModel): + """ + Represents the payment details of a card to be used for payments. These + details are determined by the payment token generated by Web Payments SDK. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique ID for this card. Generated by Square. + """ + + card_brand: typing.Optional[CardBrand] = pydantic.Field(default=None) + """ + The card's brand. + See [CardBrand](#type-cardbrand) for possible values + """ + + last4: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="last_4")] = pydantic.Field( + default=None + ) + """ + The last 4 digits of the card number. + """ + + exp_month: typing.Optional[int] = pydantic.Field(default=None) + """ + The expiration month of the associated card as an integer between 1 and 12. + """ + + exp_year: typing.Optional[int] = pydantic.Field(default=None) + """ + The four-digit year of the card's expiration date. + """ + + cardholder_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the cardholder. + """ + + billing_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The billing address for this card. `US` postal codes can be provided as a 5-digit zip code + or 9-digit ZIP+4 (example: `12345-6789`). For a full list of field meanings by country, see + [Working with Addresses](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-addresses). + """ + + fingerprint: typing.Optional[str] = pydantic.Field(default=None) + """ + Intended as a Square-assigned identifier, based + on the card number, to identify the card across multiple locations within a + single application. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + **Required** The ID of a [customer](entity:Customer) to be associated with the card. + """ + + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the merchant associated with the card. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional user-defined reference ID that associates this card with + another entity in an external system. For example, a customer ID from an + external customer management system. + """ + + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether or not a card can be used for payments. + """ + + card_type: typing.Optional[CardType] = pydantic.Field(default=None) + """ + The type of the card. + The Card object includes this field only in response to Payments API calls. + See [CardType](#type-cardtype) for possible values + """ + + prepaid_type: typing.Optional[CardPrepaidType] = pydantic.Field(default=None) + """ + Indicates whether the card is prepaid or not. + See [CardPrepaidType](#type-cardprepaidtype) for possible values + """ + + bin: typing.Optional[str] = pydantic.Field(default=None) + """ + The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API + returns this field. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + Current version number of the card. Increments with each card update. Requests to update an + existing Card object will be rejected unless the version in the request matches the current + version for the Card. + """ + + card_co_brand: typing.Optional[CardCoBrand] = pydantic.Field(default=None) + """ + The card's co-brand if available. For example, an Afterpay virtual card would have a + co-brand of AFTERPAY. + See [CardCoBrand](#type-cardcobrand) for possible values + """ + + issuer_alert: typing.Optional[CardIssuerAlert] = pydantic.Field(default=None) + """ + An alert from the issuing bank about the card status. Alerts can indicate whether + future charges to the card are likely to fail. For more information, see + [Manage Card on File Declines](https://developer.squareup.com/docs/cards-api/manage-card-on-file-declines). + + This field is present only if there's an active issuer alert. + See [IssuerAlert](#type-issueralert) for possible values + """ + + issuer_alert_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the current issuer alert was received and processed, in + RFC 3339 format. + + This field is present only if there's an active issuer alert. + """ + + hsa_fsa: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible + Spending Account (FSA), based on the card BIN. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/card_brand.py b/src/square/types/card_brand.py new file mode 100644 index 00000000..b04c28bb --- /dev/null +++ b/src/square/types/card_brand.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CardBrand = typing.Union[ + typing.Literal[ + "OTHER_BRAND", + "VISA", + "MASTERCARD", + "AMERICAN_EXPRESS", + "DISCOVER", + "DISCOVER_DINERS", + "JCB", + "CHINA_UNIONPAY", + "SQUARE_GIFT_CARD", + "SQUARE_CAPITAL_CARD", + "INTERAC", + "EFTPOS", + "FELICA", + "EBT", + ], + typing.Any, +] diff --git a/src/square/types/card_co_brand.py b/src/square/types/card_co_brand.py new file mode 100644 index 00000000..e35b230c --- /dev/null +++ b/src/square/types/card_co_brand.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CardCoBrand = typing.Union[typing.Literal["UNKNOWN", "AFTERPAY", "CLEARPAY"], typing.Any] diff --git a/src/square/types/card_issuer_alert.py b/src/square/types/card_issuer_alert.py new file mode 100644 index 00000000..a5cd6405 --- /dev/null +++ b/src/square/types/card_issuer_alert.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CardIssuerAlert = typing.Literal["ISSUER_ALERT_CARD_CLOSED"] diff --git a/src/square/types/card_payment_details.py b/src/square/types/card_payment_details.py new file mode 100644 index 00000000..8dd7b108 --- /dev/null +++ b/src/square/types/card_payment_details.py @@ -0,0 +1,118 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .card import Card +from .device_details import DeviceDetails +from .card_payment_timeline import CardPaymentTimeline +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CardPaymentDetails(UncheckedBaseModel): + """ + Reflects the current status of a card payment. Contains only non-confidential information. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or + FAILED. + """ + + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The credit card's non-confidential details. + """ + + entry_method: typing.Optional[str] = pydantic.Field(default=None) + """ + The method used to enter the card's details for the payment. The method can be + `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + """ + + cvv_status: typing.Optional[str] = pydantic.Field(default=None) + """ + The status code returned from the Card Verification Value (CVV) check. The code can be + `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`. + """ + + avs_status: typing.Optional[str] = pydantic.Field(default=None) + """ + The status code returned from the Address Verification System (AVS) check. The code can be + `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`. + """ + + auth_result_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The status code returned by the card issuer that describes the payment's + authorization status. + """ + + application_identifier: typing.Optional[str] = pydantic.Field(default=None) + """ + For EMV payments, the application ID identifies the EMV application used for the payment. + """ + + application_name: typing.Optional[str] = pydantic.Field(default=None) + """ + For EMV payments, the human-readable name of the EMV application used for the payment. + """ + + application_cryptogram: typing.Optional[str] = pydantic.Field(default=None) + """ + For EMV payments, the cryptogram generated for the payment. + """ + + verification_method: typing.Optional[str] = pydantic.Field(default=None) + """ + For EMV payments, the method used to verify the cardholder's identity. The method can be + `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. + """ + + verification_results: typing.Optional[str] = pydantic.Field(default=None) + """ + For EMV payments, the results of the cardholder verification. The result can be + `SUCCESS`, `FAILURE`, or `UNKNOWN`. + """ + + statement_description: typing.Optional[str] = pydantic.Field(default=None) + """ + The statement description sent to the card networks. + + Note: The actual statement description varies and is likely to be truncated and appended with + additional information on a per issuer basis. + """ + + device_details: typing.Optional[DeviceDetails] = pydantic.Field(default=None) + """ + __Deprecated__: Use `Payment.device_details` instead. + + Details about the device that took the payment. + """ + + card_payment_timeline: typing.Optional[CardPaymentTimeline] = pydantic.Field(default=None) + """ + The timeline for card payments. + """ + + refund_requires_card_presence: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the card must be physically present for the payment to + be refunded. If set to `true`, the card must be present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/card_payment_timeline.py b/src/square/types/card_payment_timeline.py new file mode 100644 index 00000000..57869896 --- /dev/null +++ b/src/square/types/card_payment_timeline.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CardPaymentTimeline(UncheckedBaseModel): + """ + The timeline for card payments. + """ + + authorized_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the payment was authorized, in RFC 3339 format. + """ + + captured_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the payment was captured, in RFC 3339 format. + """ + + voided_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the payment was voided, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/card_prepaid_type.py b/src/square/types/card_prepaid_type.py new file mode 100644 index 00000000..105ba23e --- /dev/null +++ b/src/square/types/card_prepaid_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CardPrepaidType = typing.Union[typing.Literal["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], typing.Any] diff --git a/src/square/types/card_type.py b/src/square/types/card_type.py new file mode 100644 index 00000000..3fbd004e --- /dev/null +++ b/src/square/types/card_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CardType = typing.Union[typing.Literal["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], typing.Any] diff --git a/src/square/types/cash_app_details.py b/src/square/types/cash_app_details.py new file mode 100644 index 00000000..6d72a572 --- /dev/null +++ b/src/square/types/cash_app_details.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CashAppDetails(UncheckedBaseModel): + """ + Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. + """ + + buyer_full_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the Cash App account holder. + """ + + buyer_country_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The country of the Cash App account holder, in ISO 3166-1-alpha-2 format. + + For possible values, see [Country](entity:Country). + """ + + buyer_cashtag: typing.Optional[str] = pydantic.Field(default=None) + """ + $Cashtag of the Cash App account holder. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cash_drawer_device.py b/src/square/types/cash_drawer_device.py new file mode 100644 index 00000000..7515396d --- /dev/null +++ b/src/square/types/cash_drawer_device.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CashDrawerDevice(UncheckedBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The device Square-issued ID + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The device merchant-specified name. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cash_drawer_event_type.py b/src/square/types/cash_drawer_event_type.py new file mode 100644 index 00000000..2e9944b1 --- /dev/null +++ b/src/square/types/cash_drawer_event_type.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CashDrawerEventType = typing.Union[ + typing.Literal[ + "NO_SALE", + "CASH_TENDER_PAYMENT", + "OTHER_TENDER_PAYMENT", + "CASH_TENDER_CANCELLED_PAYMENT", + "OTHER_TENDER_CANCELLED_PAYMENT", + "CASH_TENDER_REFUND", + "OTHER_TENDER_REFUND", + "PAID_IN", + "PAID_OUT", + ], + typing.Any, +] diff --git a/src/square/types/cash_drawer_shift.py b/src/square/types/cash_drawer_shift.py new file mode 100644 index 00000000..a222d903 --- /dev/null +++ b/src/square/types/cash_drawer_shift.py @@ -0,0 +1,152 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .cash_drawer_shift_state import CashDrawerShiftState +from .money import Money +from .cash_drawer_device import CashDrawerDevice +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CashDrawerShift(UncheckedBaseModel): + """ + This model gives the details of a cash drawer shift. + The cash_payment_money, cash_refund_money, cash_paid_in_money, + and cash_paid_out_money fields are all computed by summing their respective + event types. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift unique ID. + """ + + state: typing.Optional[CashDrawerShiftState] = pydantic.Field(default=None) + """ + The shift current state. + See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values + """ + + opened_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the shift began, in ISO 8601 format. + """ + + ended_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the shift ended, in ISO 8601 format. + """ + + closed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the shift was closed, in ISO 8601 format. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The free-form text description of a cash drawer by an employee. + """ + + opened_cash_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money in the cash drawer at the start of the shift. + The amount must be greater than or equal to zero. + """ + + cash_payment_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money added to the cash drawer from cash payments. + This is computed by summing all events with the types CASH_TENDER_PAYMENT and + CASH_TENDER_CANCELED_PAYMENT. The amount is always greater than or equal to + zero. + """ + + cash_refunds_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money removed from the cash drawer from cash refunds. + It is computed by summing the events of type CASH_TENDER_REFUND. The amount + is always greater than or equal to zero. + """ + + cash_paid_in_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money added to the cash drawer for reasons other than cash + payments. It is computed by summing the events of type PAID_IN. The amount is + always greater than or equal to zero. + """ + + cash_paid_out_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money removed from the cash drawer for reasons other than + cash refunds. It is computed by summing the events of type PAID_OUT. The amount + is always greater than or equal to zero. + """ + + expected_cash_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money that should be in the cash drawer at the end of the + shift, based on the shift's other money amounts. + This can be negative if employees have not correctly recorded all the events + on the cash drawer. + cash_paid_out_money is a summation of amounts from cash_payment_money (zero + or positive), cash_refunds_money (zero or negative), cash_paid_in_money (zero + or positive), and cash_paid_out_money (zero or negative) event types. + """ + + closed_cash_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money found in the cash drawer at the end of the shift + by an auditing employee. The amount should be positive. + """ + + device: typing.Optional[CashDrawerDevice] = pydantic.Field(default=None) + """ + The device running Square Point of Sale that was connected to the cash drawer. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift start time in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift updated at time in RFC 3339 format. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location the cash drawer shift belongs to. + """ + + team_member_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of all team members that were logged into Square Point of Sale at any + point while the cash drawer shift was open. + """ + + opening_team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member that started the cash drawer shift. + """ + + ending_team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member that ended the cash drawer shift. + """ + + closing_team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member that closed the cash drawer shift by auditing + the cash drawer contents. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cash_drawer_shift_event.py b/src/square/types/cash_drawer_shift_event.py new file mode 100644 index 00000000..e239a85b --- /dev/null +++ b/src/square/types/cash_drawer_shift_event.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .cash_drawer_event_type import CashDrawerEventType +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CashDrawerShiftEvent(UncheckedBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique ID of the event. + """ + + event_type: typing.Optional[CashDrawerEventType] = pydantic.Field(default=None) + """ + The type of cash drawer shift event. + See [CashDrawerEventType](#type-cashdrawereventtype) for possible values + """ + + event_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money that was added to or removed from the cash drawer + in the event. The amount can be positive (for added money) + or zero (for other tender type payments). The addition or removal of money can be determined by + by the event type. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The event time in RFC 3339 format. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional description of the event, entered by the employee that + created the event. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member that created the event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cash_drawer_shift_state.py b/src/square/types/cash_drawer_shift_state.py new file mode 100644 index 00000000..b8b834a2 --- /dev/null +++ b/src/square/types/cash_drawer_shift_state.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CashDrawerShiftState = typing.Union[typing.Literal["OPEN", "ENDED", "CLOSED"], typing.Any] diff --git a/src/square/types/cash_drawer_shift_summary.py b/src/square/types/cash_drawer_shift_summary.py new file mode 100644 index 00000000..7005c6c4 --- /dev/null +++ b/src/square/types/cash_drawer_shift_summary.py @@ -0,0 +1,93 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .cash_drawer_shift_state import CashDrawerShiftState +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CashDrawerShiftSummary(UncheckedBaseModel): + """ + The summary of a closed cash drawer shift. + This model contains only the money counted to start a cash drawer shift, counted + at the end of the shift, and the amount that should be in the drawer at shift + end based on summing all cash drawer shift events. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift unique ID. + """ + + state: typing.Optional[CashDrawerShiftState] = pydantic.Field(default=None) + """ + The shift current state. + See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values + """ + + opened_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift start time in ISO 8601 format. + """ + + ended_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift end time in ISO 8601 format. + """ + + closed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift close time in ISO 8601 format. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + An employee free-text description of a cash drawer shift. + """ + + opened_cash_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money in the cash drawer at the start of the shift. This + must be a positive amount. + """ + + expected_cash_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money that should be in the cash drawer at the end of the + shift, based on the cash drawer events on the shift. + The amount is correct if all shift employees accurately recorded their + cash drawer shift events. Unrecorded events and events with the wrong amount + result in an incorrect expected_cash_money amount that can be negative. + """ + + closed_cash_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money found in the cash drawer at the end of the shift by + an auditing employee. The amount must be greater than or equal to zero. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift start time in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The shift updated at time in RFC 3339 format. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location the cash drawer shift belongs to. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/cash_payment_details.py b/src/square/types/cash_payment_details.py new file mode 100644 index 00000000..bc0fd033 --- /dev/null +++ b/src/square/types/cash_payment_details.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CashPaymentDetails(UncheckedBaseModel): + """ + Stores details about a cash payment. Contains only non-confidential information. For more information, see + [Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments). + """ + + buyer_supplied_money: Money = pydantic.Field() + """ + The amount and currency of the money supplied by the buyer. + """ + + change_back_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of change due back to the buyer. + This read-only field is calculated + from the `amount_money` and `buyer_supplied_money` fields. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_availability_period.py b/src/square/types/catalog_availability_period.py new file mode 100644 index 00000000..64d21261 --- /dev/null +++ b/src/square/types/catalog_availability_period.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .day_of_week import DayOfWeek +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogAvailabilityPeriod(UncheckedBaseModel): + """ + Represents a time period of availability. + """ + + start_local_time: typing.Optional[str] = pydantic.Field(default=None) + """ + The start time of an availability period, specified in local time using partial-time + RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + end_local_time: typing.Optional[str] = pydantic.Field(default=None) + """ + The end time of an availability period, specified in local time using partial-time + RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening. + Note that the seconds value is always :00, but it is appended for conformance to the RFC. + """ + + day_of_week: typing.Optional[DayOfWeek] = pydantic.Field(default=None) + """ + The day of the week for this availability period. + See [DayOfWeek](#type-dayofweek) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_category.py b/src/square/types/catalog_category.py new file mode 100644 index 00000000..2a185f17 --- /dev/null +++ b/src/square/types/catalog_category.py @@ -0,0 +1,89 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_category_type import CatalogCategoryType +from .catalog_ecom_seo_data import CatalogEcomSeoData +from .category_path_to_root_node import CategoryPathToRootNode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogCategory(UncheckedBaseModel): + """ + A category to which a `CatalogItem` instance belongs. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + image_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of images associated with this `CatalogCategory` instance. + Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications. + """ + + category_type: typing.Optional[CatalogCategoryType] = pydantic.Field(default=None) + """ + The type of the category. + See [CatalogCategoryType](#type-catalogcategorytype) for possible values + """ + + parent_category: typing.Optional["CatalogObjectCategory"] = pydantic.Field(default=None) + """ + The ID of the parent category of this category instance. + """ + + is_top_level: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether a category is a top level category, which does not have any parent_category. + """ + + channels: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of IDs representing channels, such as a Square Online site, where the category can be made visible. + """ + + availability_period_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of the `CatalogAvailabilityPeriod` objects associated with the category. + """ + + online_visibility: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites. + """ + + root_category: typing.Optional[str] = pydantic.Field(default=None) + """ + The top-level category in a category hierarchy. + """ + + ecom_seo_data: typing.Optional[CatalogEcomSeoData] = pydantic.Field(default=None) + """ + The SEO data for a seller's Square Online store. + """ + + path_to_root: typing.Optional[typing.List[CategoryPathToRootNode]] = pydantic.Field(default=None) + """ + The path from the category to its root category. The first node of the path is the parent of the category + and the last is the root category. The path is empty if the category is a root category. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_object_category import CatalogObjectCategory # noqa: E402 + +update_forward_refs(CatalogCategory) diff --git a/src/square/types/catalog_category_type.py b/src/square/types/catalog_category_type.py new file mode 100644 index 00000000..5a34272d --- /dev/null +++ b/src/square/types/catalog_category_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogCategoryType = typing.Union[typing.Literal["REGULAR_CATEGORY", "MENU_CATEGORY", "KITCHEN_CATEGORY"], typing.Any] diff --git a/src/square/types/catalog_custom_attribute_definition.py b/src/square/types/catalog_custom_attribute_definition.py new file mode 100644 index 00000000..d4fe0883 --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition.py @@ -0,0 +1,111 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_custom_attribute_definition_type import CatalogCustomAttributeDefinitionType +import pydantic +import typing +from .source_application import SourceApplication +from .catalog_object_type import CatalogObjectType +from .catalog_custom_attribute_definition_seller_visibility import CatalogCustomAttributeDefinitionSellerVisibility +from .catalog_custom_attribute_definition_app_visibility import CatalogCustomAttributeDefinitionAppVisibility +from .catalog_custom_attribute_definition_string_config import CatalogCustomAttributeDefinitionStringConfig +from .catalog_custom_attribute_definition_number_config import CatalogCustomAttributeDefinitionNumberConfig +from .catalog_custom_attribute_definition_selection_config import CatalogCustomAttributeDefinitionSelectionConfig +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogCustomAttributeDefinition(UncheckedBaseModel): + """ + Contains information defining a custom attribute. Custom attributes are + intended to store additional information about a catalog object or to associate a + catalog object with an entity in another system. Do not use custom attributes + to store any sensitive information (personally identifiable information, card details, etc.). + [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes) + """ + + type: CatalogCustomAttributeDefinitionType = pydantic.Field() + """ + The type of this custom attribute. Cannot be modified after creation. + Required. + See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values + """ + + name: str = pydantic.Field() + """ + The name of this definition for API and seller-facing UI purposes. + The name must be unique within the (merchant, application) pair. Required. + May not be empty and may not exceed 255 characters. Can be modified after creation. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + Seller-oriented description of the meaning of this Custom Attribute, + any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs. + """ + + source_application: typing.Optional[SourceApplication] = pydantic.Field(default=None) + """ + __Read only.__ Contains information about the application that + created this custom attribute definition. + """ + + allowed_object_types: typing.List[CatalogObjectType] = pydantic.Field() + """ + The set of `CatalogObject` types that this custom atttribute may be applied to. + Currently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included. + See [CatalogObjectType](#type-catalogobjecttype) for possible values + """ + + seller_visibility: typing.Optional[CatalogCustomAttributeDefinitionSellerVisibility] = pydantic.Field(default=None) + """ + The visibility of a custom attribute in seller-facing UIs (including Square Point + of Sale applications and Square Dashboard). May be modified. + See [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) for possible values + """ + + app_visibility: typing.Optional[CatalogCustomAttributeDefinitionAppVisibility] = pydantic.Field(default=None) + """ + The visibility of a custom attribute to applications other than the application + that created the attribute. + See [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) for possible values + """ + + string_config: typing.Optional[CatalogCustomAttributeDefinitionStringConfig] = pydantic.Field(default=None) + """ + Optionally, populated when `type` = `STRING`, unset otherwise. + """ + + number_config: typing.Optional[CatalogCustomAttributeDefinitionNumberConfig] = pydantic.Field(default=None) + """ + Optionally, populated when `type` = `NUMBER`, unset otherwise. + """ + + selection_config: typing.Optional[CatalogCustomAttributeDefinitionSelectionConfig] = pydantic.Field(default=None) + """ + Populated when `type` is set to `SELECTION`, unset otherwise. + """ + + custom_attribute_usage_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of custom attributes that reference this + custom attribute definition. Set by the server in response to a ListCatalog + request with `include_counts` set to `true`. If the actual count is greater + than 100, `custom_attribute_usage_count` will be set to `100`. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the desired custom attribute key that can be used to access + the custom attribute value on catalog objects. Cannot be modified after the + custom attribute definition has been created. + Must be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_custom_attribute_definition_app_visibility.py b/src/square/types/catalog_custom_attribute_definition_app_visibility.py new file mode 100644 index 00000000..1133675a --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_app_visibility.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogCustomAttributeDefinitionAppVisibility = typing.Union[ + typing.Literal["APP_VISIBILITY_HIDDEN", "APP_VISIBILITY_READ_ONLY", "APP_VISIBILITY_READ_WRITE_VALUES"], typing.Any +] diff --git a/src/square/types/catalog_custom_attribute_definition_number_config.py b/src/square/types/catalog_custom_attribute_definition_number_config.py new file mode 100644 index 00000000..4869d458 --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_number_config.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogCustomAttributeDefinitionNumberConfig(UncheckedBaseModel): + precision: typing.Optional[int] = pydantic.Field(default=None) + """ + An integer between 0 and 5 that represents the maximum number of + positions allowed after the decimal in number custom attribute values + For example: + + - if the precision is 0, the quantity can be 1, 2, 3, etc. + - if the precision is 1, the quantity can be 0.1, 0.2, etc. + - if the precision is 2, the quantity can be 0.01, 0.12, etc. + + Default: 5 + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_custom_attribute_definition_selection_config.py b/src/square/types/catalog_custom_attribute_definition_selection_config.py new file mode 100644 index 00000000..34e42e21 --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_selection_config.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_custom_attribute_definition_selection_config_custom_attribute_selection import ( + CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection, +) +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogCustomAttributeDefinitionSelectionConfig(UncheckedBaseModel): + """ + Configuration associated with `SELECTION`-type custom attribute definitions. + """ + + max_allowed_selections: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of selections that can be set. The maximum value for this + attribute is 100. The default value is 1. The value can be modified, but changing the value will not + affect existing custom attribute values on objects. Clients need to + handle custom attributes with more selected values than allowed by this limit. + """ + + allowed_selections: typing.Optional[ + typing.List[CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection] + ] = pydantic.Field(default=None) + """ + The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100 + selections can be defined. Can be modified. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_custom_attribute_definition_selection_config_custom_attribute_selection.py b/src/square/types/catalog_custom_attribute_definition_selection_config_custom_attribute_selection.py new file mode 100644 index 00000000..cda11f87 --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_selection_config_custom_attribute_selection.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection(UncheckedBaseModel): + """ + A named selection for this `SELECTION`-type custom attribute definition. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique ID set by Square. + """ + + name: str = pydantic.Field() + """ + Selection name, unique within `allowed_selections`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_custom_attribute_definition_seller_visibility.py b/src/square/types/catalog_custom_attribute_definition_seller_visibility.py new file mode 100644 index 00000000..d56f41dd --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_seller_visibility.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogCustomAttributeDefinitionSellerVisibility = typing.Union[ + typing.Literal["SELLER_VISIBILITY_HIDDEN", "SELLER_VISIBILITY_READ_WRITE_VALUES"], typing.Any +] diff --git a/src/square/types/catalog_custom_attribute_definition_string_config.py b/src/square/types/catalog_custom_attribute_definition_string_config.py new file mode 100644 index 00000000..eac438ba --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_string_config.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogCustomAttributeDefinitionStringConfig(UncheckedBaseModel): + """ + Configuration associated with Custom Attribute Definitions of type `STRING`. + """ + + enforce_uniqueness: typing.Optional[bool] = pydantic.Field(default=None) + """ + If true, each Custom Attribute instance associated with this Custom Attribute + Definition must have a unique value within the seller's catalog. For + example, this may be used for a value like a SKU that should not be + duplicated within a seller's catalog. May not be modified after the + definition has been created. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_custom_attribute_definition_type.py b/src/square/types/catalog_custom_attribute_definition_type.py new file mode 100644 index 00000000..ce74f8ad --- /dev/null +++ b/src/square/types/catalog_custom_attribute_definition_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogCustomAttributeDefinitionType = typing.Union[ + typing.Literal["STRING", "BOOLEAN", "NUMBER", "SELECTION"], typing.Any +] diff --git a/src/square/types/catalog_custom_attribute_value.py b/src/square/types/catalog_custom_attribute_value.py new file mode 100644 index 00000000..519f60bb --- /dev/null +++ b/src/square/types/catalog_custom_attribute_value.py @@ -0,0 +1,68 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_custom_attribute_definition_type import CatalogCustomAttributeDefinitionType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogCustomAttributeValue(UncheckedBaseModel): + """ + An instance of a custom attribute. Custom attributes can be defined and + added to `ITEM` and `ITEM_VARIATION` type catalog objects. + [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes). + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the custom attribute. + """ + + string_value: typing.Optional[str] = pydantic.Field(default=None) + """ + The string value of the custom attribute. Populated if `type` = `STRING`. + """ + + custom_attribute_definition_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to. + """ + + type: typing.Optional[CatalogCustomAttributeDefinitionType] = pydantic.Field(default=None) + """ + A copy of type from the associated `CatalogCustomAttributeDefinition`. + See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values + """ + + number_value: typing.Optional[str] = pydantic.Field(default=None) + """ + Populated if `type` = `NUMBER`. Contains a string + representation of a decimal number, using a `.` as the decimal separator. + """ + + boolean_value: typing.Optional[bool] = pydantic.Field(default=None) + """ + A `true` or `false` value. Populated if `type` = `BOOLEAN`. + """ + + selection_uid_values: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID. + For example, if the CatalogCustomAttributeDefinition has a key attribute of "cocoa_brand" and the defining application ID is "abcd1234", this key is "abcd1234:cocoa_brand" + when the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_discount.py b/src/square/types/catalog_discount.py new file mode 100644 index 00000000..66179f39 --- /dev/null +++ b/src/square/types/catalog_discount.py @@ -0,0 +1,84 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_discount_type import CatalogDiscountType +from .money import Money +from .catalog_discount_modify_tax_basis import CatalogDiscountModifyTaxBasis +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogDiscount(UncheckedBaseModel): + """ + A discount applicable to items. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + discount_type: typing.Optional[CatalogDiscountType] = pydantic.Field(default=None) + """ + Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. + See [CatalogDiscountType](#type-catalogdiscounttype) for possible values + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal + separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` + is `VARIABLE_PERCENTAGE`. + + Do not use this field for amount-based or variable discounts. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. + + Do not use this field for percentage-based or variable discounts. + """ + + pin_required: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether a mobile staff member needs to enter their PIN to apply the + discount to a payment in the Square Point of Sale app. + """ + + label_color: typing.Optional[str] = pydantic.Field(default=None) + """ + The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. + """ + + modify_tax_basis: typing.Optional[CatalogDiscountModifyTaxBasis] = pydantic.Field(default=None) + """ + Indicates whether this discount should reduce the price used to calculate tax. + + Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must + be calculated based on an item's price, ignoring a particular discount. For example, + in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a + customer pays but does not reduce the sale price used to calculate how much sales tax is + due. In this case, the discount representing that manufacturer coupon should have + `DO_NOT_MODIFY_TAX_BASIS` for this field. + + If you are unsure whether you need to use this field, consult your tax professional. + See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values + """ + + maximum_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + For a percentage discount, the maximum absolute value of the discount. For example, if a + 50% discount has a `maximum_amount_money` of $20, a $100 purchase will yield a $20 discount, + not a $50 discount. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_discount_modify_tax_basis.py b/src/square/types/catalog_discount_modify_tax_basis.py new file mode 100644 index 00000000..2e0b1885 --- /dev/null +++ b/src/square/types/catalog_discount_modify_tax_basis.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogDiscountModifyTaxBasis = typing.Union[typing.Literal["MODIFY_TAX_BASIS", "DO_NOT_MODIFY_TAX_BASIS"], typing.Any] diff --git a/src/square/types/catalog_discount_type.py b/src/square/types/catalog_discount_type.py new file mode 100644 index 00000000..d4156094 --- /dev/null +++ b/src/square/types/catalog_discount_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogDiscountType = typing.Union[ + typing.Literal["FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], typing.Any +] diff --git a/src/square/types/catalog_ecom_seo_data.py b/src/square/types/catalog_ecom_seo_data.py new file mode 100644 index 00000000..f6ac1540 --- /dev/null +++ b/src/square/types/catalog_ecom_seo_data.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogEcomSeoData(UncheckedBaseModel): + """ + SEO data for for a seller's Square Online store. + """ + + page_title: typing.Optional[str] = pydantic.Field(default=None) + """ + The SEO title used for the Square Online store. + """ + + page_description: typing.Optional[str] = pydantic.Field(default=None) + """ + The SEO description used for the Square Online store. + """ + + permalink: typing.Optional[str] = pydantic.Field(default=None) + """ + The SEO permalink used for the Square Online store. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_id_mapping.py b/src/square/types/catalog_id_mapping.py new file mode 100644 index 00000000..6a146a50 --- /dev/null +++ b/src/square/types/catalog_id_mapping.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogIdMapping(UncheckedBaseModel): + """ + A mapping between a temporary client-supplied ID and a permanent server-generated ID. + + When calling [UpsertCatalogObject](api-endpoint:Catalog-UpsertCatalogObject) or + [BatchUpsertCatalogObjects](api-endpoint:Catalog-BatchUpsertCatalogObjects) to + create a [CatalogObject](entity:CatalogObject) instance, you can supply + a temporary ID for the to-be-created object, especially when the object is to be referenced + elsewhere in the same request body. This temporary ID can be any string unique within + the call, but must be prefixed by "#". + + After the request is submitted and the object created, a permanent server-generated ID is assigned + to the new object. The permanent ID is unique across the Square catalog. + """ + + client_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The client-supplied temporary `#`-prefixed ID for a new `CatalogObject`. + """ + + object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The permanent ID for the CatalogObject created by the server. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_image.py b/src/square/types/catalog_image.py new file mode 100644 index 00000000..5628e596 --- /dev/null +++ b/src/square/types/catalog_image.py @@ -0,0 +1,53 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogImage(UncheckedBaseModel): + """ + An image file to use in Square catalogs. It can be associated with + `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects. + Only the images on items and item variations are exposed in Dashboard. + Only the first image on an item is displayed in Square Point of Sale (SPOS). + Images on items and variations are displayed through Square Online Store. + Images on other object types are for use by 3rd party application developers. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The internal name to identify this image in calls to the Square API. + This is a searchable attribute for use in applicable query filters + using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + It is not unique and should not be shown in a buyer facing context. + """ + + url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of this image, generated by Square after an image is uploaded + using the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint. + To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field. + """ + + caption: typing.Optional[str] = pydantic.Field(default=None) + """ + A caption that describes what is shown in the image. Displayed in the + Square Online Store. This is a searchable attribute for use in applicable query filters + using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + """ + + photo_studio_order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The immutable order ID for this image object created by the Photo Studio service in Square Online Store. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_info_response.py b/src/square/types/catalog_info_response.py new file mode 100644 index 00000000..01adbd1b --- /dev/null +++ b/src/square/types/catalog_info_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .catalog_info_response_limits import CatalogInfoResponseLimits +from .standard_unit_description_group import StandardUnitDescriptionGroup +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogInfoResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + limits: typing.Optional[CatalogInfoResponseLimits] = pydantic.Field(default=None) + """ + Limits that apply to this API. + """ + + standard_unit_description_group: typing.Optional[StandardUnitDescriptionGroup] = pydantic.Field(default=None) + """ + Names and abbreviations for standard units. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_info_response_limits.py b/src/square/types/catalog_info_response_limits.py new file mode 100644 index 00000000..4a603979 --- /dev/null +++ b/src/square/types/catalog_info_response_limits.py @@ -0,0 +1,83 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogInfoResponseLimits(UncheckedBaseModel): + batch_upsert_max_objects_per_batch: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of objects that may appear within a single batch in a + `/v2/catalog/batch-upsert` request. + """ + + batch_upsert_max_total_objects: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of objects that may appear across all batches in a + `/v2/catalog/batch-upsert` request. + """ + + batch_retrieve_max_object_ids: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve` + request. + """ + + search_max_page_limit: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of results that may be returned in a page of a + `/v2/catalog/search` response. + """ + + batch_delete_max_object_ids: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of object IDs that may be included in a single + `/v2/catalog/batch-delete` request. + """ + + update_item_taxes_max_item_ids: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of item IDs that may be included in a single + `/v2/catalog/update-item-taxes` request. + """ + + update_item_taxes_max_taxes_to_enable: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of tax IDs to be enabled that may be included in a single + `/v2/catalog/update-item-taxes` request. + """ + + update_item_taxes_max_taxes_to_disable: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of tax IDs to be disabled that may be included in a single + `/v2/catalog/update-item-taxes` request. + """ + + update_item_modifier_lists_max_item_ids: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of item IDs that may be included in a single + `/v2/catalog/update-item-modifier-lists` request. + """ + + update_item_modifier_lists_max_modifier_lists_to_enable: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of modifier list IDs to be enabled that may be included in + a single `/v2/catalog/update-item-modifier-lists` request. + """ + + update_item_modifier_lists_max_modifier_lists_to_disable: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum number of modifier list IDs to be disabled that may be included in + a single `/v2/catalog/update-item-modifier-lists` request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item.py b/src/square/types/catalog_item.py new file mode 100644 index 00000000..e46c06ce --- /dev/null +++ b/src/square/types/catalog_item.py @@ -0,0 +1,223 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from .catalog_item_modifier_list_info import CatalogItemModifierListInfo +from .catalog_item_product_type import CatalogItemProductType +from .catalog_item_option_for_item import CatalogItemOptionForItem +from .catalog_ecom_seo_data import CatalogEcomSeoData +from .catalog_item_food_and_beverage_details import CatalogItemFoodAndBeverageDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogItem(UncheckedBaseModel): + """ + A [CatalogObject](entity:CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + + Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description + of the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to + set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, + except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null + does not nullify `description_html`. + """ + + abbreviation: typing.Optional[str] = pydantic.Field(default=None) + """ + The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. + This attribute is searchable, and its value length is of Unicode code points. + """ + + label_color: typing.Optional[str] = pydantic.Field(default=None) + """ + The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. + """ + + is_taxable: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the item is taxable (`true`) or non-taxable (`false`). Default is `true`. + """ + + category_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the item's category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead. + """ + + tax_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A set of IDs indicating the taxes enabled for + this item. When updating an item, any taxes listed here will be added to the item. + Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. + """ + + modifier_list_info: typing.Optional[typing.List[CatalogItemModifierListInfo]] = pydantic.Field(default=None) + """ + A set of `CatalogItemModifierListInfo` objects + representing the modifier lists that apply to this item, along with the overrides and min + and max limits that are specific to this item. Modifier lists + may also be added to or deleted from an item using `UpdateItemModifierLists`. + """ + + variations: typing.Optional[typing.List["CatalogObject"]] = pydantic.Field(default=None) + """ + A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have + at least one variation. + """ + + product_type: typing.Optional[CatalogItemProductType] = pydantic.Field(default=None) + """ + The product type of the item. Once set, the `product_type` value cannot be modified. + + Items of the `LEGACY_SQUARE_ONLINE_SERVICE` and `LEGACY_SQUARE_ONLINE_MEMBERSHIP` product types can be updated + but cannot be created using the API. + See [CatalogItemProductType](#type-catalogitemproducttype) for possible values + """ + + skip_modifier_screen: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `false`, the Square Point of Sale app will present the `CatalogItem`'s + details screen immediately, allowing the merchant to choose `CatalogModifier`s + before adding the item to the cart. This is the default behavior. + + If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected + modifiers, and merchants can edit modifiers by drilling down onto the item's details. + + Third-party clients are encouraged to implement similar behaviors. + """ + + item_options: typing.Optional[typing.List[CatalogItemOptionForItem]] = pydantic.Field(default=None) + """ + List of item options IDs for this item. Used to manage and group item + variations in a specified order. + + Maximum: 6 item options. + """ + + ecom_uri: typing.Optional[str] = pydantic.Field(default=None) + """ + Deprecated; see go/ecomUriUseCases. A URI pointing to a published e-commerce product page for the Item. + """ + + ecom_image_uris: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Deprecated; see go/ecomUriUseCases. A comma-separated list of encoded URIs pointing to a set of published e-commerce images for the Item. + """ + + image_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of images associated with this `CatalogItem` instance. + These images will be shown to customers in Square Online Store. + The first image will show up as the icon for this item in POS. + """ + + sort_name: typing.Optional[str] = pydantic.Field(default=None) + """ + A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting. + Its value must not be empty. + + It is currently supported for sellers of the Japanese locale only. + """ + + categories: typing.Optional[typing.List[CatalogObjectCategory]] = pydantic.Field(default=None) + """ + The list of categories. + """ + + description_html: typing.Optional[str] = pydantic.Field(default=None) + """ + The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags, + is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or + unsupported HTML elements or attributes are ignored. + + Supported HTML elements include: + - `a`: Link. Supports linking to website URLs, email address, and telephone numbers. + - `b`, `strong`: Bold text + - `br`: Line break + - `code`: Computer code + - `div`: Section + - `h1-h6`: Headings + - `i`, `em`: Italics + - `li`: List element + - `ol`: Numbered list + - `p`: Paragraph + - `ul`: Bullet list + - `u`: Underline + + + Supported HTML attributes include: + - `align`: Alignment of the text content + - `href`: Link destination + - `rel`: Relationship between link's target and source + - `target`: Place to open the linked document + """ + + description_plaintext: typing.Optional[str] = pydantic.Field(default=None) + """ + A server-generated plaintext version of the `description_html` field, without formatting tags. + """ + + channels: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available. + This field is read only and cannot be edited. + """ + + is_archived: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether this item is archived (`true`) or not (`false`). + """ + + ecom_seo_data: typing.Optional[CatalogEcomSeoData] = pydantic.Field(default=None) + """ + The SEO data for a seller's Square Online store. + """ + + food_and_beverage_details: typing.Optional[CatalogItemFoodAndBeverageDetails] = pydantic.Field(default=None) + """ + The food and beverage-specific details for the `FOOD_AND_BEV` item. + """ + + reporting_category: typing.Optional[CatalogObjectCategory] = pydantic.Field(default=None) + """ + The item's reporting category. + """ + + is_alcoholic: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether this item is alcoholic (`true`) or not (`false`). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 +from .catalog_object import CatalogObject # noqa: E402 + +update_forward_refs(CatalogItem) diff --git a/src/square/types/catalog_item_food_and_beverage_details.py b/src/square/types/catalog_item_food_and_beverage_details.py new file mode 100644 index 00000000..56041d08 --- /dev/null +++ b/src/square/types/catalog_item_food_and_beverage_details.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_item_food_and_beverage_details_dietary_preference import ( + CatalogItemFoodAndBeverageDetailsDietaryPreference, +) +from .catalog_item_food_and_beverage_details_ingredient import CatalogItemFoodAndBeverageDetailsIngredient +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemFoodAndBeverageDetails(UncheckedBaseModel): + """ + The food and beverage-specific details of a `FOOD_AND_BEV` item. + """ + + calorie_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of items. + """ + + dietary_preferences: typing.Optional[typing.List[CatalogItemFoodAndBeverageDetailsDietaryPreference]] = ( + pydantic.Field(default=None) + ) + """ + The dietary preferences for the `FOOD_AND_BEV` item. + """ + + ingredients: typing.Optional[typing.List[CatalogItemFoodAndBeverageDetailsIngredient]] = pydantic.Field( + default=None + ) + """ + The ingredients for the `FOOD_AND_BEV` type item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_food_and_beverage_details_dietary_preference.py b/src/square/types/catalog_item_food_and_beverage_details_dietary_preference.py new file mode 100644 index 00000000..282ba86f --- /dev/null +++ b/src/square/types/catalog_item_food_and_beverage_details_dietary_preference.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .catalog_item_food_and_beverage_details_dietary_preference_type import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceType, +) +import pydantic +from .catalog_item_food_and_beverage_details_dietary_preference_standard_dietary_preference import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference, +) +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemFoodAndBeverageDetailsDietaryPreference(UncheckedBaseModel): + """ + Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its ingredients. + """ + + type: typing.Optional[CatalogItemFoodAndBeverageDetailsDietaryPreferenceType] = pydantic.Field(default=None) + """ + The dietary preference type. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`. + See [DietaryPreferenceType](#type-dietarypreferencetype) for possible values + """ + + standard_name: typing.Optional[CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference] = ( + pydantic.Field(default=None) + ) + """ + The name of the dietary preference from a standard pre-defined list. This should be null if it's a custom dietary preference. + See [StandardDietaryPreference](#type-standarddietarypreference) for possible values + """ + + custom_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of a user-defined custom dietary preference. This should be null if it's a standard dietary preference. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_food_and_beverage_details_dietary_preference_standard_dietary_preference.py b/src/square/types/catalog_item_food_and_beverage_details_dietary_preference_standard_dietary_preference.py new file mode 100644 index 00000000..f23d0b67 --- /dev/null +++ b/src/square/types/catalog_item_food_and_beverage_details_dietary_preference_standard_dietary_preference.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = typing.Union[ + typing.Literal["DAIRY_FREE", "GLUTEN_FREE", "HALAL", "KOSHER", "NUT_FREE", "VEGAN", "VEGETARIAN"], typing.Any +] diff --git a/src/square/types/catalog_item_food_and_beverage_details_dietary_preference_type.py b/src/square/types/catalog_item_food_and_beverage_details_dietary_preference_type.py new file mode 100644 index 00000000..524dbd7a --- /dev/null +++ b/src/square/types/catalog_item_food_and_beverage_details_dietary_preference_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogItemFoodAndBeverageDetailsDietaryPreferenceType = typing.Union[typing.Literal["STANDARD", "CUSTOM"], typing.Any] diff --git a/src/square/types/catalog_item_food_and_beverage_details_ingredient.py b/src/square/types/catalog_item_food_and_beverage_details_ingredient.py new file mode 100644 index 00000000..7a4bdc7c --- /dev/null +++ b/src/square/types/catalog_item_food_and_beverage_details_ingredient.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .catalog_item_food_and_beverage_details_dietary_preference_type import ( + CatalogItemFoodAndBeverageDetailsDietaryPreferenceType, +) +import pydantic +from .catalog_item_food_and_beverage_details_ingredient_standard_ingredient import ( + CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient, +) +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemFoodAndBeverageDetailsIngredient(UncheckedBaseModel): + """ + Describes the ingredient used in a `FOOD_AND_BEV` item. + """ + + type: typing.Optional[CatalogItemFoodAndBeverageDetailsDietaryPreferenceType] = pydantic.Field(default=None) + """ + The dietary preference type of the ingredient. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`. + See [DietaryPreferenceType](#type-dietarypreferencetype) for possible values + """ + + standard_name: typing.Optional[CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient] = pydantic.Field( + default=None + ) + """ + The name of the ingredient from a standard pre-defined list. This should be null if it's a custom dietary preference. + See [StandardIngredient](#type-standardingredient) for possible values + """ + + custom_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of a custom user-defined ingredient. This should be null if it's a standard dietary preference. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_food_and_beverage_details_ingredient_standard_ingredient.py b/src/square/types/catalog_item_food_and_beverage_details_ingredient_standard_ingredient.py new file mode 100644 index 00000000..9812c925 --- /dev/null +++ b/src/square/types/catalog_item_food_and_beverage_details_ingredient_standard_ingredient.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = typing.Union[ + typing.Literal[ + "CELERY", + "CRUSTACEANS", + "EGGS", + "FISH", + "GLUTEN", + "LUPIN", + "MILK", + "MOLLUSCS", + "MUSTARD", + "PEANUTS", + "SESAME", + "SOY", + "SULPHITES", + "TREE_NUTS", + ], + typing.Any, +] diff --git a/src/square/types/catalog_item_modifier_list_info.py b/src/square/types/catalog_item_modifier_list_info.py new file mode 100644 index 00000000..6120c518 --- /dev/null +++ b/src/square/types/catalog_item_modifier_list_info.py @@ -0,0 +1,72 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .catalog_modifier_override import CatalogModifierOverride +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemModifierListInfo(UncheckedBaseModel): + """ + References a text-based modifier or a list of non text-based modifiers applied to a `CatalogItem` instance + and specifies supported behaviors of the application. + """ + + modifier_list_id: str = pydantic.Field() + """ + The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. + """ + + modifier_overrides: typing.Optional[typing.List[CatalogModifierOverride]] = pydantic.Field(default=None) + """ + A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. + """ + + min_selected_modifiers: typing.Optional[int] = pydantic.Field(default=None) + """ + If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. + The default value is `-1`. + + When `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of + the `CatalogModifierList` can be selected from the `CatalogModifierList`. + + When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in + and can be selected from the `CatalogModifierList` + """ + + max_selected_modifiers: typing.Optional[int] = pydantic.Field(default=None) + """ + If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. + The default value is `-1`. + + When `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of + the `CatalogModifierList` can be selected from the `CatalogModifierList`. + + When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` + and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in + and can be selected from the `CatalogModifierList` + """ + + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, enable this `CatalogModifierList`. The default value is `true`. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied + to a `CatalogItem` instance. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_option.py b/src/square/types/catalog_item_option.py new file mode 100644 index 00000000..20514637 --- /dev/null +++ b/src/square/types/catalog_item_option.py @@ -0,0 +1,66 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogItemOption(UncheckedBaseModel): + """ + A group of variations for a `CatalogItem`. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The item option's display name for the seller. Must be unique across + all item options. This is a searchable attribute for use in applicable query filters. + """ + + display_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The item option's display name for the customer. This is a searchable attribute for use in applicable query filters. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The item option's human-readable description. Displayed in the Square + Point of Sale app for the seller and in the Online Store or on receipts for + the buyer. This is a searchable attribute for use in applicable query filters. + """ + + show_colors: typing.Optional[bool] = pydantic.Field(default=None) + """ + If true, display colors for entries in `values` when present. + """ + + values: typing.Optional[typing.List["CatalogObject"]] = pydantic.Field(default=None) + """ + A list of CatalogObjects containing the + `CatalogItemOptionValue`s for this item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 +from .catalog_object import CatalogObject # noqa: E402 + +update_forward_refs(CatalogItemOption) diff --git a/src/square/types/catalog_item_option_for_item.py b/src/square/types/catalog_item_option_for_item.py new file mode 100644 index 00000000..b08ad542 --- /dev/null +++ b/src/square/types/catalog_item_option_for_item.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemOptionForItem(UncheckedBaseModel): + """ + An option that can be assigned to an item. + For example, a t-shirt item may offer a color option or a size option. + """ + + item_option_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique id of the item option, used to form the dimensions of the item option matrix in a specified order. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_option_value.py b/src/square/types/catalog_item_option_value.py new file mode 100644 index 00000000..426de7c5 --- /dev/null +++ b/src/square/types/catalog_item_option_value.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemOptionValue(UncheckedBaseModel): + """ + An enumerated value that can link a + `CatalogItemVariation` to an item option as one of + its item option values. + """ + + item_option_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique ID of the associated item option. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + Name of this item option value. This is a searchable attribute for use in applicable query filters. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + A human-readable description for the option value. This is a searchable attribute for use in applicable query filters. + """ + + color: typing.Optional[str] = pydantic.Field(default=None) + """ + The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). + Only displayed if `show_colors` is enabled on the parent `ItemOption`. When + left unset, `color` defaults to white ("#ffffff") when `show_colors` is + enabled on the parent `ItemOption`. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + Determines where this option value appears in a list of option values. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_option_value_for_item_variation.py b/src/square/types/catalog_item_option_value_for_item_variation.py new file mode 100644 index 00000000..058ab819 --- /dev/null +++ b/src/square/types/catalog_item_option_value_for_item_variation.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemOptionValueForItemVariation(UncheckedBaseModel): + """ + A `CatalogItemOptionValue` links an item variation to an item option as + an item option value. For example, a t-shirt item may offer a color option and + a size option. An item option value would represent each variation of t-shirt: + For example, "Color:Red, Size:Small" or "Color:Blue, Size:Medium". + """ + + item_option_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique id of an item option. + """ + + item_option_value_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique id of the selected value for the item option. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_item_product_type.py b/src/square/types/catalog_item_product_type.py new file mode 100644 index 00000000..5c4e2791 --- /dev/null +++ b/src/square/types/catalog_item_product_type.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogItemProductType = typing.Union[ + typing.Literal[ + "REGULAR", + "GIFT_CARD", + "APPOINTMENTS_SERVICE", + "FOOD_AND_BEV", + "EVENT", + "DIGITAL", + "DONATION", + "LEGACY_SQUARE_ONLINE_SERVICE", + "LEGACY_SQUARE_ONLINE_MEMBERSHIP", + ], + typing.Any, +] diff --git a/src/square/types/catalog_item_variation.py b/src/square/types/catalog_item_variation.py new file mode 100644 index 00000000..1c9b658c --- /dev/null +++ b/src/square/types/catalog_item_variation.py @@ -0,0 +1,178 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_pricing_type import CatalogPricingType +from .money import Money +from .item_variation_location_overrides import ItemVariationLocationOverrides +from .inventory_alert_type import InventoryAlertType +from .catalog_item_option_value_for_item_variation import CatalogItemOptionValueForItemVariation +from .catalog_stock_conversion import CatalogStockConversion +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogItemVariation(UncheckedBaseModel): + """ + An item variation, representing a product for sale, in the Catalog object model. Each [item](entity:CatalogItem) must have at least one + item variation and can have at most 250 item variations. + + An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked + number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both + stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass + variation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be + converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes + the `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count + decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion. + """ + + item_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the `CatalogItem` associated with this item variation. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The item variation's name. This is a searchable attribute for use in applicable query filters. + + Its value has a maximum length of 255 Unicode code points. However, when the parent [item](entity:CatalogItem) + uses [item options](entity:CatalogItemOption), this attribute is auto-generated, read-only, and can be + longer than 255 Unicode code points. + """ + + sku: typing.Optional[str] = pydantic.Field(default=None) + """ + The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters. + """ + + upc: typing.Optional[str] = pydantic.Field(default=None) + """ + The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters. + + The value of this attribute should be a number of 12-14 digits long. This restriction is enforced on the Square Seller Dashboard, + Square Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned + to this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps + unless it is updated to fit the expected format. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal + for each item variation within a parent `CatalogItem` is set according to the item variations's + position. On reads, the value is not guaranteed to be sequential or unique. + """ + + pricing_type: typing.Optional[CatalogPricingType] = pydantic.Field(default=None) + """ + Indicates whether the item variation's price is fixed or determined at the time + of sale. + See [CatalogPricingType](#type-catalogpricingtype) for possible values + """ + + price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The item variation's price, if fixed pricing is used. + """ + + location_overrides: typing.Optional[typing.List[ItemVariationLocationOverrides]] = pydantic.Field(default=None) + """ + Per-location price and inventory overrides. + """ + + track_inventory: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, inventory tracking is active for the variation. + """ + + inventory_alert_type: typing.Optional[InventoryAlertType] = pydantic.Field(default=None) + """ + Indicates whether the item variation displays an alert when its inventory quantity is less than or equal + to its `inventory_alert_threshold`. + See [InventoryAlertType](#type-inventoryalerttype) for possible values + """ + + inventory_alert_threshold: typing.Optional[int] = pydantic.Field(default=None) + """ + If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` + is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. + + This value is always an integer. + """ + + user_data: typing.Optional[str] = pydantic.Field(default=None) + """ + Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points. + """ + + service_duration: typing.Optional[int] = pydantic.Field(default=None) + """ + If the `CatalogItem` that owns this item variation is of type + `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For + example, a 30 minute appointment would have the value `1800000`, which is equal to + 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). + """ + + available_for_booking: typing.Optional[bool] = pydantic.Field(default=None) + """ + If the `CatalogItem` that owns this item variation is of type + `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking. + """ + + item_option_values: typing.Optional[typing.List[CatalogItemOptionValueForItemVariation]] = pydantic.Field( + default=None + ) + """ + List of item option values associated with this item variation. Listed + in the same order as the item options of the parent item. + """ + + measurement_unit_id: typing.Optional[str] = pydantic.Field(default=None) + """ + ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity + sold of this item variation. If left unset, the item will be sold in + whole quantities. + """ + + sellable: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether this variation can be sold. The inventory count of a sellable variation indicates + the number of units available for sale. When a variation is both stockable and sellable, + its sellable inventory count can be smaller than or equal to its stockable count. + """ + + stockable: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE). + When a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock + and is not an indicator of the number of units of the variation that can be sold. + """ + + image_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of images associated with this `CatalogItemVariation` instance. + These images will be shown to customers in Square Online Store. + """ + + team_member_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Tokens of employees that can perform the service represented by this variation. Only valid for + variations of type `APPOINTMENTS_SERVICE`. + """ + + stockable_conversion: typing.Optional[CatalogStockConversion] = pydantic.Field(default=None) + """ + The unit conversion rule, as prescribed by the [CatalogStockConversion](entity:CatalogStockConversion) type, + that describes how this non-stockable (i.e., sellable/receivable) item variation is converted + to/from the stockable item variation sharing the same parent item. With the stock conversion, + you can accurately track inventory when an item variation is sold in one unit, but stocked in + another unit. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_measurement_unit.py b/src/square/types/catalog_measurement_unit.py new file mode 100644 index 00000000..fd659c6d --- /dev/null +++ b/src/square/types/catalog_measurement_unit.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .measurement_unit import MeasurementUnit +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogMeasurementUnit(UncheckedBaseModel): + """ + Represents the unit used to measure a `CatalogItemVariation` and + specifies the precision for decimal quantities. + """ + + measurement_unit: typing.Optional[MeasurementUnit] = pydantic.Field(default=None) + """ + Indicates the unit used to measure the quantity of a catalog item variation. + """ + + precision: typing.Optional[int] = pydantic.Field(default=None) + """ + An integer between 0 and 5 that represents the maximum number of + positions allowed after the decimal in quantities measured with this unit. + For example: + + - if the precision is 0, the quantity can be 1, 2, 3, etc. + - if the precision is 1, the quantity can be 0.1, 0.2, etc. + - if the precision is 2, the quantity can be 0.01, 0.12, etc. + + Default: 3 + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_modifier.py b/src/square/types/catalog_modifier.py new file mode 100644 index 00000000..e43e6fb4 --- /dev/null +++ b/src/square/types/catalog_modifier.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .modifier_location_overrides import ModifierLocationOverrides +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogModifier(UncheckedBaseModel): + """ + A modifier applicable to items at the time of sale. An example of a modifier is a Cheese add-on to a Burger item. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The modifier name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The modifier price. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + Determines where this `CatalogModifier` appears in the `CatalogModifierList`. + """ + + modifier_list_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the `CatalogModifierList` associated with this modifier. + """ + + location_overrides: typing.Optional[typing.List[ModifierLocationOverrides]] = pydantic.Field(default=None) + """ + Location-specific price overrides. + """ + + image_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the image associated with this `CatalogModifier` instance. + Currently this image is not displayed by Square, but is free to be displayed in 3rd party applications. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_modifier_list.py b/src/square/types/catalog_modifier_list.py new file mode 100644 index 00000000..cd9bfc1c --- /dev/null +++ b/src/square/types/catalog_modifier_list.py @@ -0,0 +1,123 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from .catalog_modifier_list_selection_type import CatalogModifierListSelectionType +from .catalog_modifier_list_modifier_type import CatalogModifierListModifierType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogModifierList(UncheckedBaseModel): + """ + For a text-based modifier, this encapsulates the modifier's text when its `modifier_type` is `TEXT`. + For example, to sell T-shirts with custom prints, a text-based modifier can be used to capture the buyer-supplied + text string to be selected for the T-shirt at the time of sale. + + For non text-based modifiers, this encapsulates a non-empty list of modifiers applicable to items + at the time of sale. Each element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type. + For example, a "Condiments" modifier list applicable to a "Hot Dog" item + may contain "Ketchup", "Mustard", and "Relish" modifiers. + + A non text-based modifier can be applied to the modified item once or multiple times, if the `selection_type` field + is set to `SINGLE` or `MULTIPLE`, respectively. On the other hand, a text-based modifier can be applied to the item + only once and the `selection_type` field is always set to `SINGLE`. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of + Unicode code points. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + The position of this `CatalogModifierList` within a list of `CatalogModifierList` instances. + """ + + selection_type: typing.Optional[CatalogModifierListSelectionType] = pydantic.Field(default=None) + """ + Indicates whether a single (`SINGLE`) or multiple (`MULTIPLE`) modifiers from the list + can be applied to a single `CatalogItem`. + + For text-based modifiers, the `selection_type` attribute is always `SINGLE`. The other value is ignored. + See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values + """ + + modifiers: typing.Optional[typing.List["CatalogObject"]] = pydantic.Field(default=None) + """ + A non-empty list of `CatalogModifier` objects to be included in the `CatalogModifierList`, + for non text-based modifiers when the `modifier_type` attribute is `LIST`. Each element of this list + is a `CatalogObject` instance of the `MODIFIER` type, containing the following attributes: + ``` + { + "id": "{{catalog_modifier_id}}", + "type": "MODIFIER", + "modifier_data": {{a CatalogModifier instance>}} + } + ``` + """ + + image_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of images associated with this `CatalogModifierList` instance. + Currently these images are not displayed on Square products, but may be displayed in 3rd-party applications. + """ + + modifier_type: typing.Optional[CatalogModifierListModifierType] = pydantic.Field(default=None) + """ + The type of the modifier. + + When this `modifier_type` value is `TEXT`, the `CatalogModifierList` represents a text-based modifier. + When this `modifier_type` value is `LIST`, the `CatalogModifierList` contains a list of `CatalogModifier` objects. + See [CatalogModifierListModifierType](#type-catalogmodifierlistmodifiertype) for possible values + """ + + max_length: typing.Optional[int] = pydantic.Field(default=None) + """ + The maximum length, in Unicode points, of the text string of the text-based modifier as represented by + this `CatalogModifierList` object with the `modifier_type` set to `TEXT`. + """ + + text_required: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the text string must be a non-empty string (`true`) or not (`false`) for a text-based modifier + as represented by this `CatalogModifierList` object with the `modifier_type` set to `TEXT`. + """ + + internal_name: typing.Optional[str] = pydantic.Field(default=None) + """ + A note for internal use by the business. + + For example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of "Hello, Kitty!" + is to be printed on the T-shirt, this `internal_name` attribute can be "Use italic face" as + an instruction for the business to follow. + + For non text-based modifiers, this `internal_name` attribute can be + used to include SKUs, internal codes, or supplemental descriptions for internal use. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 +from .catalog_object import CatalogObject # noqa: E402 + +update_forward_refs(CatalogModifierList) diff --git a/src/square/types/catalog_modifier_list_modifier_type.py b/src/square/types/catalog_modifier_list_modifier_type.py new file mode 100644 index 00000000..9077a76b --- /dev/null +++ b/src/square/types/catalog_modifier_list_modifier_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogModifierListModifierType = typing.Union[typing.Literal["LIST", "TEXT"], typing.Any] diff --git a/src/square/types/catalog_modifier_list_selection_type.py b/src/square/types/catalog_modifier_list_selection_type.py new file mode 100644 index 00000000..8dbafe7a --- /dev/null +++ b/src/square/types/catalog_modifier_list_selection_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogModifierListSelectionType = typing.Union[typing.Literal["SINGLE", "MULTIPLE"], typing.Any] diff --git a/src/square/types/catalog_modifier_override.py b/src/square/types/catalog_modifier_override.py new file mode 100644 index 00000000..43bdba1e --- /dev/null +++ b/src/square/types/catalog_modifier_override.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogModifierOverride(UncheckedBaseModel): + """ + Options to control how to override the default behavior of the specified modifier. + """ + + modifier_id: str = pydantic.Field() + """ + The ID of the `CatalogModifier` whose default behavior is being overridden. + """ + + on_by_default: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object.py b/src/square/types/catalog_object.py new file mode 100644 index 00000000..1ec9fd1e --- /dev/null +++ b/src/square/types/catalog_object.py @@ -0,0 +1,65 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing +from .catalog_object_image import CatalogObjectImage +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item_variation import CatalogObjectItemVariation +from .catalog_object_tax import CatalogObjectTax +from .catalog_object_discount import CatalogObjectDiscount +from .catalog_object_modifier import CatalogObjectModifier +from .catalog_object_dining_option import CatalogObjectDiningOption +from .catalog_object_tax_exemption import CatalogObjectTaxExemption +from .catalog_object_service_charge import CatalogObjectServiceCharge +from .catalog_object_pricing_rule import CatalogObjectPricingRule +from .catalog_object_product_set import CatalogObjectProductSet +from .catalog_object_time_period import CatalogObjectTimePeriod +from .catalog_object_measurement_unit import CatalogObjectMeasurementUnit +from .catalog_object_item_option_value import CatalogObjectItemOptionValue +from .catalog_object_custom_attribute_definition import CatalogObjectCustomAttributeDefinition +from .catalog_object_quick_amounts_settings import CatalogObjectQuickAmountsSettings +from .catalog_object_component import CatalogObjectComponent +from .catalog_object_composition import CatalogObjectComposition +from .catalog_object_resource import CatalogObjectResource +from .catalog_object_checkout_link import CatalogObjectCheckoutLink +from .catalog_object_address import CatalogObjectAddress +from .catalog_object_subscription_product import CatalogObjectSubscriptionProduct +from .catalog_object_subscription_plan_variation import CatalogObjectSubscriptionPlanVariation +from .catalog_object_availability_period import CatalogObjectAvailabilityPeriod +import typing + +if typing.TYPE_CHECKING: + from .catalog_object_item import CatalogObjectItem + from .catalog_object_modifier_list import CatalogObjectModifierList + from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan + from .catalog_object_item_option import CatalogObjectItemOption +CatalogObject = typing.Union[ + "CatalogObjectItem", + CatalogObjectImage, + CatalogObjectCategory, + CatalogObjectItemVariation, + CatalogObjectTax, + CatalogObjectDiscount, + "CatalogObjectModifierList", + CatalogObjectModifier, + CatalogObjectDiningOption, + CatalogObjectTaxExemption, + CatalogObjectServiceCharge, + CatalogObjectPricingRule, + CatalogObjectProductSet, + CatalogObjectTimePeriod, + CatalogObjectMeasurementUnit, + "CatalogObjectSubscriptionPlan", + "CatalogObjectItemOption", + CatalogObjectItemOptionValue, + CatalogObjectCustomAttributeDefinition, + CatalogObjectQuickAmountsSettings, + CatalogObjectComponent, + CatalogObjectComposition, + CatalogObjectResource, + CatalogObjectCheckoutLink, + CatalogObjectAddress, + CatalogObjectSubscriptionProduct, + CatalogObjectSubscriptionPlanVariation, + CatalogObjectAvailabilityPeriod, +] diff --git a/src/square/types/catalog_object_address.py b/src/square/types/catalog_object_address.py new file mode 100644 index 00000000..3ed110ec --- /dev/null +++ b/src/square/types/catalog_object_address.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectAddress(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_availability_period.py b/src/square/types/catalog_object_availability_period.py new file mode 100644 index 00000000..0b8417a2 --- /dev/null +++ b/src/square/types/catalog_object_availability_period.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_availability_period import CatalogAvailabilityPeriod +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectAvailabilityPeriod(CatalogObjectBase): + availability_period_data: typing.Optional[CatalogAvailabilityPeriod] = pydantic.Field(default=None) + """ + Structured data for a `CatalogAvailabilityPeriod`, set for CatalogObjects of type `AVAILABILITY_PERIOD`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_base.py b/src/square/types/catalog_object_base.py new file mode 100644 index 00000000..3e1a69f1 --- /dev/null +++ b/src/square/types/catalog_object_base.py @@ -0,0 +1,113 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_object_type import CatalogObjectType +import pydantic +import typing +from .catalog_custom_attribute_value import CatalogCustomAttributeValue +import typing_extensions +from .catalog_v1id import CatalogV1Id +from ..core.serialization import FieldMetadata +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectBase(UncheckedBaseModel): + type: CatalogObjectType = pydantic.Field() + """ + The type of this object. Each object type has expected + properties expressed in a structured format within its corresponding `*_data` field below. + See [CatalogObjectType](#type-catalogobjecttype) for possible values + """ + + id: str = pydantic.Field() + """ + An identifier to reference this object in the catalog. When a new `CatalogObject` + is inserted, the client should set the id to a temporary identifier starting with + a "`#`" character. Other objects being inserted or updated within the same request + may use this identifier to refer to the new object. + + When the server receives the new object, it will supply a unique identifier that + replaces the temporary identifier for all future references. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` + would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the object. When updating an object, the version supplied + must match the version in the database, otherwise the write will be rejected as conflicting. + """ + + is_deleted: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, the object has been deleted from the database. Must be `false` for new objects + being inserted. When deleted, the `updated_at` field will equal the deletion time. + """ + + custom_attribute_values: typing.Optional[typing.Dict[str, CatalogCustomAttributeValue]] = pydantic.Field( + default=None + ) + """ + A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair + is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute + value defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + object defined by the application making the request. + + If the `CatalogCustomAttributeDefinition` object is + defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by + the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of + `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"` + if the application making the request is different from the application defining the custom attribute definition. + Otherwise, the key used in the map is simply `"cocoa_brand"`. + + Application-defined custom attributes are set at a global (location-independent) level. + Custom attribute values are intended to store additional information about a catalog object + or associations with an entity in another system. Do not use custom attributes + to store any sensitive information (personally identifiable information, card details, etc.). + """ + + catalog_v1ids: typing_extensions.Annotated[ + typing.Optional[typing.List[CatalogV1Id]], FieldMetadata(alias="catalog_v1_ids") + ] = pydantic.Field(default=None) + """ + The Connect v1 IDs for this object at each location where it is present, where they + differ from the object's Connect V2 ID. The field will only be present for objects that + have been created or modified by legacy APIs. + """ + + present_at_all_locations: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, this object is present at all locations (including future locations), except where specified in + the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), + except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. + """ + + present_at_location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of locations where the object is present, even if `present_at_all_locations` is `false`. + This can include locations that are deactivated. + """ + + absent_at_location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of locations where the object is not present, even if `present_at_all_locations` is `true`. + This can include locations that are deactivated. + """ + + image_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Identifies the `CatalogImage` attached to this `CatalogObject`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_batch.py b/src/square/types/catalog_object_batch.py new file mode 100644 index 00000000..4b16a125 --- /dev/null +++ b/src/square/types/catalog_object_batch.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .catalog_object import CatalogObject +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectBatch(UncheckedBaseModel): + """ + A batch of catalog objects. + """ + + objects: typing.List[CatalogObject] = pydantic.Field() + """ + A list of CatalogObjects belonging to this batch. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_category.py b/src/square/types/catalog_object_category.py new file mode 100644 index 00000000..17ad0089 --- /dev/null +++ b/src/square/types/catalog_object_category.py @@ -0,0 +1,130 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .catalog_object_type import CatalogObjectType +from .catalog_custom_attribute_value import CatalogCustomAttributeValue +import typing_extensions +from .catalog_v1id import CatalogV1Id +from ..core.serialization import FieldMetadata +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogObjectCategory(UncheckedBaseModel): + """ + A category that can be assigned to an item or a parent category that can be assigned + to another category. For example, a clothing category can be assigned to a t-shirt item or + be made as the parent category to the pants category. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the object's category. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + The order of the object within the context of the category. + """ + + category_data: typing.Optional["CatalogCategory"] = pydantic.Field(default=None) + """ + Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`. + """ + + type: CatalogObjectType = pydantic.Field() + """ + The type of this object. Each object type has expected + properties expressed in a structured format within its corresponding `*_data` field below. + See [CatalogObjectType](#type-catalogobjecttype) for possible values + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` + would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the object. When updating an object, the version supplied + must match the version in the database, otherwise the write will be rejected as conflicting. + """ + + is_deleted: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, the object has been deleted from the database. Must be `false` for new objects + being inserted. When deleted, the `updated_at` field will equal the deletion time. + """ + + custom_attribute_values: typing.Optional[typing.Dict[str, CatalogCustomAttributeValue]] = pydantic.Field( + default=None + ) + """ + A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair + is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute + value defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) + object defined by the application making the request. + + If the `CatalogCustomAttributeDefinition` object is + defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by + the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of + `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"` + if the application making the request is different from the application defining the custom attribute definition. + Otherwise, the key used in the map is simply `"cocoa_brand"`. + + Application-defined custom attributes are set at a global (location-independent) level. + Custom attribute values are intended to store additional information about a catalog object + or associations with an entity in another system. Do not use custom attributes + to store any sensitive information (personally identifiable information, card details, etc.). + """ + + catalog_v1ids: typing_extensions.Annotated[ + typing.Optional[typing.List[CatalogV1Id]], FieldMetadata(alias="catalog_v1_ids") + ] = pydantic.Field(default=None) + """ + The Connect v1 IDs for this object at each location where it is present, where they + differ from the object's Connect V2 ID. The field will only be present for objects that + have been created or modified by legacy APIs. + """ + + present_at_all_locations: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, this object is present at all locations (including future locations), except where specified in + the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), + except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. + """ + + present_at_location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of locations where the object is present, even if `present_at_all_locations` is `false`. + This can include locations that are deactivated. + """ + + absent_at_location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of locations where the object is not present, even if `present_at_all_locations` is `true`. + This can include locations that are deactivated. + """ + + image_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Identifies the `CatalogImage` attached to this `CatalogObject`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_category import CatalogCategory # noqa: E402 + +update_forward_refs(CatalogObjectCategory) diff --git a/src/square/types/catalog_object_checkout_link.py b/src/square/types/catalog_object_checkout_link.py new file mode 100644 index 00000000..ce46ed0b --- /dev/null +++ b/src/square/types/catalog_object_checkout_link.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectCheckoutLink(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_component.py b/src/square/types/catalog_object_component.py new file mode 100644 index 00000000..0dc0a061 --- /dev/null +++ b/src/square/types/catalog_object_component.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectComponent(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_composition.py b/src/square/types/catalog_object_composition.py new file mode 100644 index 00000000..f4a31909 --- /dev/null +++ b/src/square/types/catalog_object_composition.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectComposition(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_custom_attribute_definition.py b/src/square/types/catalog_object_custom_attribute_definition.py new file mode 100644 index 00000000..d88f60c2 --- /dev/null +++ b/src/square/types/catalog_object_custom_attribute_definition.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_custom_attribute_definition import CatalogCustomAttributeDefinition +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectCustomAttributeDefinition(CatalogObjectBase): + custom_attribute_definition_data: typing.Optional[CatalogCustomAttributeDefinition] = pydantic.Field(default=None) + """ + Structured data for a `CatalogCustomAttributeDefinition`, set for CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_dining_option.py b/src/square/types/catalog_object_dining_option.py new file mode 100644 index 00000000..43226db3 --- /dev/null +++ b/src/square/types/catalog_object_dining_option.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectDiningOption(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_discount.py b/src/square/types/catalog_object_discount.py new file mode 100644 index 00000000..41d7bb70 --- /dev/null +++ b/src/square/types/catalog_object_discount.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_discount import CatalogDiscount +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectDiscount(CatalogObjectBase): + discount_data: typing.Optional[CatalogDiscount] = pydantic.Field(default=None) + """ + Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_image.py b/src/square/types/catalog_object_image.py new file mode 100644 index 00000000..cce313d7 --- /dev/null +++ b/src/square/types/catalog_object_image.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_image import CatalogImage +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectImage(CatalogObjectBase): + image_data: typing.Optional[CatalogImage] = pydantic.Field(default=None) + """ + Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_item.py b/src/square/types/catalog_object_item.py new file mode 100644 index 00000000..49c706b4 --- /dev/null +++ b/src/square/types/catalog_object_item.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBase +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogObjectItem(CatalogObjectBase): + item_data: typing.Optional["CatalogItem"] = pydantic.Field(default=None) + """ + Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 + +update_forward_refs(CatalogObjectItem) diff --git a/src/square/types/catalog_object_item_option.py b/src/square/types/catalog_object_item_option.py new file mode 100644 index 00000000..4341458d --- /dev/null +++ b/src/square/types/catalog_object_item_option.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBase +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogObjectItemOption(CatalogObjectBase): + item_option_data: typing.Optional["CatalogItemOption"] = pydantic.Field(default=None) + """ + Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 + +update_forward_refs(CatalogObjectItemOption) diff --git a/src/square/types/catalog_object_item_option_value.py b/src/square/types/catalog_object_item_option_value.py new file mode 100644 index 00000000..c41e11ab --- /dev/null +++ b/src/square/types/catalog_object_item_option_value.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_item_option_value import CatalogItemOptionValue +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectItemOptionValue(CatalogObjectBase): + item_option_value_data: typing.Optional[CatalogItemOptionValue] = pydantic.Field(default=None) + """ + Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_item_variation.py b/src/square/types/catalog_object_item_variation.py new file mode 100644 index 00000000..0b0e6d9a --- /dev/null +++ b/src/square/types/catalog_object_item_variation.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_item_variation import CatalogItemVariation +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectItemVariation(CatalogObjectBase): + item_variation_data: typing.Optional[CatalogItemVariation] = pydantic.Field(default=None) + """ + Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_measurement_unit.py b/src/square/types/catalog_object_measurement_unit.py new file mode 100644 index 00000000..95cf47de --- /dev/null +++ b/src/square/types/catalog_object_measurement_unit.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_measurement_unit import CatalogMeasurementUnit +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectMeasurementUnit(CatalogObjectBase): + measurement_unit_data: typing.Optional[CatalogMeasurementUnit] = pydantic.Field(default=None) + """ + Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_modifier.py b/src/square/types/catalog_object_modifier.py new file mode 100644 index 00000000..d2a8750c --- /dev/null +++ b/src/square/types/catalog_object_modifier.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_modifier import CatalogModifier +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectModifier(CatalogObjectBase): + modifier_data: typing.Optional[CatalogModifier] = pydantic.Field(default=None) + """ + Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_modifier_list.py b/src/square/types/catalog_object_modifier_list.py new file mode 100644 index 00000000..15e95381 --- /dev/null +++ b/src/square/types/catalog_object_modifier_list.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBase +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogObjectModifierList(CatalogObjectBase): + modifier_list_data: typing.Optional["CatalogModifierList"] = pydantic.Field(default=None) + """ + Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 + +update_forward_refs(CatalogObjectModifierList) diff --git a/src/square/types/catalog_object_pricing_rule.py b/src/square/types/catalog_object_pricing_rule.py new file mode 100644 index 00000000..7630e738 --- /dev/null +++ b/src/square/types/catalog_object_pricing_rule.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_pricing_rule import CatalogPricingRule +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectPricingRule(CatalogObjectBase): + pricing_rule_data: typing.Optional[CatalogPricingRule] = pydantic.Field(default=None) + """ + Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. + A `CatalogPricingRule` object often works with a `CatalogProductSet` object or a `CatalogTimePeriod` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_product_set.py b/src/square/types/catalog_object_product_set.py new file mode 100644 index 00000000..56ba2313 --- /dev/null +++ b/src/square/types/catalog_object_product_set.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_product_set import CatalogProductSet +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectProductSet(CatalogObjectBase): + product_set_data: typing.Optional[CatalogProductSet] = pydantic.Field(default=None) + """ + Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_quick_amounts_settings.py b/src/square/types/catalog_object_quick_amounts_settings.py new file mode 100644 index 00000000..c95cfdd3 --- /dev/null +++ b/src/square/types/catalog_object_quick_amounts_settings.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_quick_amounts_settings import CatalogQuickAmountsSettings +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectQuickAmountsSettings(CatalogObjectBase): + quick_amounts_settings_data: typing.Optional[CatalogQuickAmountsSettings] = pydantic.Field(default=None) + """ + Structured data for a `CatalogQuickAmountsSettings`, set for CatalogObjects of type `QUICK_AMOUNTS_SETTINGS`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_reference.py b/src/square/types/catalog_object_reference.py new file mode 100644 index 00000000..66efefe9 --- /dev/null +++ b/src/square/types/catalog_object_reference.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectReference(UncheckedBaseModel): + """ + A reference to a Catalog object at a specific version. In general this is + used as an entry point into a graph of catalog objects, where the objects exist + at a specific version. + """ + + object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the referenced object. + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_resource.py b/src/square/types/catalog_object_resource.py new file mode 100644 index 00000000..debf6aa5 --- /dev/null +++ b/src/square/types/catalog_object_resource.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectResource(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_service_charge.py b/src/square/types/catalog_object_service_charge.py new file mode 100644 index 00000000..0b2897c8 --- /dev/null +++ b/src/square/types/catalog_object_service_charge.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectServiceCharge(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_subscription_plan.py b/src/square/types/catalog_object_subscription_plan.py new file mode 100644 index 00000000..bd039e22 --- /dev/null +++ b/src/square/types/catalog_object_subscription_plan.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from .catalog_object_base import CatalogObjectBase +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogObjectSubscriptionPlan(CatalogObjectBase): + subscription_plan_data: typing.Optional["CatalogSubscriptionPlan"] = pydantic.Field(default=None) + """ + Structured data for a `CatalogSubscriptionPlan`, set for CatalogObjects of type `SUBSCRIPTION_PLAN`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_subscription_plan import CatalogSubscriptionPlan # noqa: E402 + +update_forward_refs(CatalogObjectSubscriptionPlan) diff --git a/src/square/types/catalog_object_subscription_plan_variation.py b/src/square/types/catalog_object_subscription_plan_variation.py new file mode 100644 index 00000000..99795306 --- /dev/null +++ b/src/square/types/catalog_object_subscription_plan_variation.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_subscription_plan_variation import CatalogSubscriptionPlanVariation +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectSubscriptionPlanVariation(CatalogObjectBase): + subscription_plan_variation_data: typing.Optional[CatalogSubscriptionPlanVariation] = pydantic.Field(default=None) + """ + Structured data for a `CatalogSubscriptionPlanVariation`, set for CatalogObjects of type `SUBSCRIPTION_PLAN_VARIATION`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_subscription_product.py b/src/square/types/catalog_object_subscription_product.py new file mode 100644 index 00000000..bb91c161 --- /dev/null +++ b/src/square/types/catalog_object_subscription_product.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectSubscriptionProduct(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_tax.py b/src/square/types/catalog_object_tax.py new file mode 100644 index 00000000..fea644a3 --- /dev/null +++ b/src/square/types/catalog_object_tax.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_tax import CatalogTax +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectTax(CatalogObjectBase): + tax_data: typing.Optional[CatalogTax] = pydantic.Field(default=None) + """ + Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_tax_exemption.py b/src/square/types/catalog_object_tax_exemption.py new file mode 100644 index 00000000..25fbee62 --- /dev/null +++ b/src/square/types/catalog_object_tax_exemption.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CatalogObjectTaxExemption(CatalogObjectBase): + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_time_period.py b/src/square/types/catalog_object_time_period.py new file mode 100644 index 00000000..eb975d58 --- /dev/null +++ b/src/square/types/catalog_object_time_period.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from .catalog_object_base import CatalogObjectBase +import typing +from .catalog_time_period import CatalogTimePeriod +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogObjectTimePeriod(CatalogObjectBase): + time_period_data: typing.Optional[CatalogTimePeriod] = pydantic.Field(default=None) + """ + Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_object_type.py b/src/square/types/catalog_object_type.py new file mode 100644 index 00000000..0aa97f65 --- /dev/null +++ b/src/square/types/catalog_object_type.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogObjectType = typing.Union[ + typing.Literal[ + "ITEM", + "IMAGE", + "CATEGORY", + "ITEM_VARIATION", + "TAX", + "DISCOUNT", + "MODIFIER_LIST", + "MODIFIER", + "PRICING_RULE", + "PRODUCT_SET", + "TIME_PERIOD", + "MEASUREMENT_UNIT", + "SUBSCRIPTION_PLAN_VARIATION", + "ITEM_OPTION", + "ITEM_OPTION_VAL", + "CUSTOM_ATTRIBUTE_DEFINITION", + "QUICK_AMOUNTS_SETTINGS", + "SUBSCRIPTION_PLAN", + "AVAILABILITY_PERIOD", + ], + typing.Any, +] diff --git a/src/square/types/catalog_pricing_rule.py b/src/square/types/catalog_pricing_rule.py new file mode 100644 index 00000000..6ac864f8 --- /dev/null +++ b/src/square/types/catalog_pricing_rule.py @@ -0,0 +1,117 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .exclude_strategy import ExcludeStrategy +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogPricingRule(UncheckedBaseModel): + """ + Defines how discounts are automatically applied to a set of items that match the pricing rule + during the active time period. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + User-defined name for the pricing rule. For example, "Buy one get one + free" or "10% off". + """ + + time_period_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of unique IDs for the catalog time periods when + this pricing rule is in effect. If left unset, the pricing rule is always + in effect. + """ + + discount_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique ID for the `CatalogDiscount` to take off + the price of all matched items. + """ + + match_products_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule + matches within the entire cart, and can match multiple times. This field will always be set. + """ + + apply_products_id: typing.Optional[str] = pydantic.Field(default=None) + """ + __Deprecated__: Please use the `exclude_products_id` field to apply + an exclude set instead. Exclude sets allow better control over quantity + ranges and offer more flexibility for which matched items receive a discount. + + `CatalogProductSet` to apply the pricing to. + An apply rule matches within the subset of the cart that fits the match rules (the match set). + An apply rule can only match once in the match set. + If not supplied, the pricing will be applied to all products in the match set. + Other products retain their base price, or a price generated by other rules. + """ + + exclude_products_id: typing.Optional[str] = pydantic.Field(default=None) + """ + `CatalogProductSet` to exclude from the pricing rule. + An exclude rule matches within the subset of the cart that fits the match rules (the match set). + An exclude rule can only match once in the match set. + If not supplied, the pricing will be applied to all products in the match set. + Other products retain their base price, or a price generated by other rules. + """ + + valid_from_date: typing.Optional[str] = pydantic.Field(default=None) + """ + Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD). + """ + + valid_from_local_time: typing.Optional[str] = pydantic.Field(default=None) + """ + Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format + (HH:MM:SS). Partial seconds will be truncated. + """ + + valid_until_date: typing.Optional[str] = pydantic.Field(default=None) + """ + Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD). + """ + + valid_until_local_time: typing.Optional[str] = pydantic.Field(default=None) + """ + Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format + (HH:MM:SS). Partial seconds will be truncated. + """ + + exclude_strategy: typing.Optional[ExcludeStrategy] = pydantic.Field(default=None) + """ + If an `exclude_products_id` was given, controls which subset of matched + products is excluded from any discounts. + + Default value: `LEAST_EXPENSIVE` + See [ExcludeStrategy](#type-excludestrategy) for possible values + """ + + minimum_order_subtotal_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The minimum order subtotal (before discounts or taxes are applied) + that must be met before this rule may be applied. + """ + + customer_group_ids_any: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule. + Notice that a group ID is generated by the Customers API. + If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer + has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount + applies only to matched products sold to customers belonging to the specified customer groups. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_pricing_type.py b/src/square/types/catalog_pricing_type.py new file mode 100644 index 00000000..e81b7c9e --- /dev/null +++ b/src/square/types/catalog_pricing_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogPricingType = typing.Union[typing.Literal["FIXED_PRICING", "VARIABLE_PRICING"], typing.Any] diff --git a/src/square/types/catalog_product_set.py b/src/square/types/catalog_product_set.py new file mode 100644 index 00000000..059d5b62 --- /dev/null +++ b/src/square/types/catalog_product_set.py @@ -0,0 +1,82 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogProductSet(UncheckedBaseModel): + """ + Represents a collection of catalog objects for the purpose of applying a + `PricingRule`. Including a catalog object will include all of its subtypes. + For example, including a category in a product set will include all of its + items and associated item variations in the product set. Including an item in + a product set will also include its item variations. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + User-defined name for the product set. For example, "Clearance Items" + or "Winter Sale Items". + """ + + product_ids_any: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Unique IDs for any `CatalogObject` included in this product set. Any + number of these catalog objects can be in an order for a pricing rule to apply. + + This can be used with `product_ids_all` in a parent `CatalogProductSet` to + match groups of products for a bulk discount, such as a discount for an + entree and side combo. + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. + + Max: 500 catalog object IDs. + """ + + product_ids_all: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Unique IDs for any `CatalogObject` included in this product set. + All objects in this set must be included in an order for a pricing rule to apply. + + Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. + + Max: 500 catalog object IDs. + """ + + quantity_exact: typing.Optional[int] = pydantic.Field(default=None) + """ + If set, there must be exactly this many items from `products_any` or `products_all` + in the cart for the discount to apply. + + Cannot be combined with either `quantity_min` or `quantity_max`. + """ + + quantity_min: typing.Optional[int] = pydantic.Field(default=None) + """ + If set, there must be at least this many items from `products_any` or `products_all` + in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if + `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. + """ + + quantity_max: typing.Optional[int] = pydantic.Field(default=None) + """ + If set, the pricing rule will apply to a maximum of this many items from + `products_any` or `products_all`. + """ + + all_products: typing.Optional[bool] = pydantic.Field(default=None) + """ + If set to `true`, the product set will include every item in the catalog. + Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query.py b/src/square/types/catalog_query.py new file mode 100644 index 00000000..7ed799a0 --- /dev/null +++ b/src/square/types/catalog_query.py @@ -0,0 +1,117 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .catalog_query_sorted_attribute import CatalogQuerySortedAttribute +import pydantic +from .catalog_query_exact import CatalogQueryExact +from .catalog_query_set import CatalogQuerySet +from .catalog_query_prefix import CatalogQueryPrefix +from .catalog_query_range import CatalogQueryRange +from .catalog_query_text import CatalogQueryText +from .catalog_query_items_for_tax import CatalogQueryItemsForTax +from .catalog_query_items_for_modifier_list import CatalogQueryItemsForModifierList +from .catalog_query_items_for_item_options import CatalogQueryItemsForItemOptions +from .catalog_query_item_variations_for_item_option_values import CatalogQueryItemVariationsForItemOptionValues +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQuery(UncheckedBaseModel): + """ + A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. + + Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). + Any combination of the following types may be used together: + - [exact_query](entity:CatalogQueryExact) + - [prefix_query](entity:CatalogQueryPrefix) + - [range_query](entity:CatalogQueryRange) + - [sorted_attribute_query](entity:CatalogQuerySortedAttribute) + - [text_query](entity:CatalogQueryText) + + All other query types cannot be combined with any others. + + When a query filter is based on an attribute, the attribute must be searchable. + Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. + + Searchable attribute and objects queryable by searchable attributes: + - `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` + - `description`: `CatalogItem`, `CatalogItemOptionValue` + - `abbreviation`: `CatalogItem` + - `upc`: `CatalogItemVariation` + - `sku`: `CatalogItemVariation` + - `caption`: `CatalogImage` + - `display_name`: `CatalogItemOption` + + For example, to search for [CatalogItem](entity:CatalogItem) objects by searchable attributes, you can use + the `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable query filter. + """ + + sorted_attribute_query: typing.Optional[CatalogQuerySortedAttribute] = pydantic.Field(default=None) + """ + A query expression to sort returned query result by the given attribute. + """ + + exact_query: typing.Optional[CatalogQueryExact] = pydantic.Field(default=None) + """ + An exact query expression to return objects with attribute name and value + matching the specified attribute name and value exactly. Value matching is case insensitive. + """ + + set_query: typing.Optional[CatalogQuerySet] = pydantic.Field(default=None) + """ + A set query expression to return objects with attribute name and value + matching the specified attribute name and any of the specified attribute values exactly. + Value matching is case insensitive. + """ + + prefix_query: typing.Optional[CatalogQueryPrefix] = pydantic.Field(default=None) + """ + A prefix query expression to return objects with attribute values + that have a prefix matching the specified string value. Value matching is case insensitive. + """ + + range_query: typing.Optional[CatalogQueryRange] = pydantic.Field(default=None) + """ + A range query expression to return objects with numeric values + that lie in the specified range. + """ + + text_query: typing.Optional[CatalogQueryText] = pydantic.Field(default=None) + """ + A text query expression to return objects whose searchable attributes contain all of the given + keywords, irrespective of their order. For example, if a `CatalogItem` contains custom attribute values of + `{"name": "t-shirt"}` and `{"description": "Small, Purple"}`, the query filter of `{"keywords": ["shirt", "sma", "purp"]}` + returns this item. + """ + + items_for_tax_query: typing.Optional[CatalogQueryItemsForTax] = pydantic.Field(default=None) + """ + A query expression to return items that have any of the specified taxes (as identified by the corresponding `CatalogTax` object IDs) enabled. + """ + + items_for_modifier_list_query: typing.Optional[CatalogQueryItemsForModifierList] = pydantic.Field(default=None) + """ + A query expression to return items that have any of the given modifier list (as identified by the corresponding `CatalogModifierList`s IDs) enabled. + """ + + items_for_item_options_query: typing.Optional[CatalogQueryItemsForItemOptions] = pydantic.Field(default=None) + """ + A query expression to return items that contains the specified item options (as identified the corresponding `CatalogItemOption` IDs). + """ + + item_variations_for_item_option_values_query: typing.Optional[CatalogQueryItemVariationsForItemOptionValues] = ( + pydantic.Field(default=None) + ) + """ + A query expression to return item variations (of the [CatalogItemVariation](entity:CatalogItemVariation) type) that + contain all of the specified `CatalogItemOption` IDs. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_exact.py b/src/square/types/catalog_query_exact.py new file mode 100644 index 00000000..e0d8eb7a --- /dev/null +++ b/src/square/types/catalog_query_exact.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class CatalogQueryExact(UncheckedBaseModel): + """ + The query filter to return the search result by exact match of the specified attribute name and value. + """ + + attribute_name: str = pydantic.Field() + """ + The name of the attribute to be searched. Matching of the attribute name is exact. + """ + + attribute_value: str = pydantic.Field() + """ + The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial. + For example, if a specified value of "sma", objects with the named attribute value of "Small", "small" are both matched. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_item_variations_for_item_option_values.py b/src/square/types/catalog_query_item_variations_for_item_option_values.py new file mode 100644 index 00000000..82d0c47c --- /dev/null +++ b/src/square/types/catalog_query_item_variations_for_item_option_values.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQueryItemVariationsForItemOptionValues(UncheckedBaseModel): + """ + The query filter to return the item variations containing the specified item option value IDs. + """ + + item_option_value_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A set of `CatalogItemOptionValue` IDs to be used to find associated + `CatalogItemVariation`s. All ItemVariations that contain all of the given + Item Option Values (in any order) will be returned. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_items_for_item_options.py b/src/square/types/catalog_query_items_for_item_options.py new file mode 100644 index 00000000..710ac260 --- /dev/null +++ b/src/square/types/catalog_query_items_for_item_options.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQueryItemsForItemOptions(UncheckedBaseModel): + """ + The query filter to return the items containing the specified item option IDs. + """ + + item_option_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A set of `CatalogItemOption` IDs to be used to find associated + `CatalogItem`s. All Items that contain all of the given Item Options (in any order) + will be returned. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_items_for_modifier_list.py b/src/square/types/catalog_query_items_for_modifier_list.py new file mode 100644 index 00000000..d9b99c99 --- /dev/null +++ b/src/square/types/catalog_query_items_for_modifier_list.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQueryItemsForModifierList(UncheckedBaseModel): + """ + The query filter to return the items containing the specified modifier list IDs. + """ + + modifier_list_ids: typing.List[str] = pydantic.Field() + """ + A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_items_for_tax.py b/src/square/types/catalog_query_items_for_tax.py new file mode 100644 index 00000000..b64afa5e --- /dev/null +++ b/src/square/types/catalog_query_items_for_tax.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQueryItemsForTax(UncheckedBaseModel): + """ + The query filter to return the items containing the specified tax IDs. + """ + + tax_ids: typing.List[str] = pydantic.Field() + """ + A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_prefix.py b/src/square/types/catalog_query_prefix.py new file mode 100644 index 00000000..80fadb37 --- /dev/null +++ b/src/square/types/catalog_query_prefix.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class CatalogQueryPrefix(UncheckedBaseModel): + """ + The query filter to return the search result whose named attribute values are prefixed by the specified attribute value. + """ + + attribute_name: str = pydantic.Field() + """ + The name of the attribute to be searched. + """ + + attribute_prefix: str = pydantic.Field() + """ + The desired prefix of the search attribute value. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_range.py b/src/square/types/catalog_query_range.py new file mode 100644 index 00000000..c267d45c --- /dev/null +++ b/src/square/types/catalog_query_range.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQueryRange(UncheckedBaseModel): + """ + The query filter to return the search result whose named attribute values fall between the specified range. + """ + + attribute_name: str = pydantic.Field() + """ + The name of the attribute to be searched. + """ + + attribute_min_value: typing.Optional[int] = pydantic.Field(default=None) + """ + The desired minimum value for the search attribute (inclusive). + """ + + attribute_max_value: typing.Optional[int] = pydantic.Field(default=None) + """ + The desired maximum value for the search attribute (inclusive). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_set.py b/src/square/types/catalog_query_set.py new file mode 100644 index 00000000..870f6b06 --- /dev/null +++ b/src/square/types/catalog_query_set.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQuerySet(UncheckedBaseModel): + """ + The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of + the `attribute_values`. + """ + + attribute_name: str = pydantic.Field() + """ + The name of the attribute to be searched. Matching of the attribute name is exact. + """ + + attribute_values: typing.List[str] = pydantic.Field() + """ + The desired values of the search attribute. Matching of the attribute values is exact and case insensitive. + A maximum of 250 values may be searched in a request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_sorted_attribute.py b/src/square/types/catalog_query_sorted_attribute.py new file mode 100644 index 00000000..aff24fe7 --- /dev/null +++ b/src/square/types/catalog_query_sorted_attribute.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQuerySortedAttribute(UncheckedBaseModel): + """ + The query expression to specify the key to sort search results. + """ + + attribute_name: str = pydantic.Field() + """ + The attribute whose value is used as the sort key. + """ + + initial_attribute_value: typing.Optional[str] = pydantic.Field(default=None) + """ + The first attribute value to be returned by the query. Ascending sorts will return only + objects with this value or greater, while descending sorts will return only objects with this value + or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). + """ + + sort_order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The desired sort order, `"ASC"` (ascending) or `"DESC"` (descending). + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_query_text.py b/src/square/types/catalog_query_text.py new file mode 100644 index 00000000..99e068e5 --- /dev/null +++ b/src/square/types/catalog_query_text.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQueryText(UncheckedBaseModel): + """ + The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case. + """ + + keywords: typing.List[str] = pydantic.Field() + """ + A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 alphanumeric characters are ignored. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_quick_amount.py b/src/square/types/catalog_quick_amount.py new file mode 100644 index 00000000..1b2803f2 --- /dev/null +++ b/src/square/types/catalog_quick_amount.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_quick_amount_type import CatalogQuickAmountType +import pydantic +from .money import Money +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQuickAmount(UncheckedBaseModel): + """ + Represents a Quick Amount in the Catalog. + """ + + type: CatalogQuickAmountType = pydantic.Field() + """ + Represents the type of the Quick Amount. + See [CatalogQuickAmountType](#type-catalogquickamounttype) for possible values + """ + + amount: Money = pydantic.Field() + """ + Represents the actual amount of the Quick Amount with Money type. + """ + + score: typing.Optional[int] = pydantic.Field(default=None) + """ + Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100]. + MANUAL type amount will always have score = 100. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + The order in which this Quick Amount should be displayed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_quick_amount_type.py b/src/square/types/catalog_quick_amount_type.py new file mode 100644 index 00000000..81f85db2 --- /dev/null +++ b/src/square/types/catalog_quick_amount_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogQuickAmountType = typing.Union[typing.Literal["QUICK_AMOUNT_TYPE_MANUAL", "QUICK_AMOUNT_TYPE_AUTO"], typing.Any] diff --git a/src/square/types/catalog_quick_amounts_settings.py b/src/square/types/catalog_quick_amounts_settings.py new file mode 100644 index 00000000..164a40c9 --- /dev/null +++ b/src/square/types/catalog_quick_amounts_settings.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_quick_amounts_settings_option import CatalogQuickAmountsSettingsOption +import pydantic +import typing +from .catalog_quick_amount import CatalogQuickAmount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogQuickAmountsSettings(UncheckedBaseModel): + """ + A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts. + """ + + option: CatalogQuickAmountsSettingsOption = pydantic.Field() + """ + Represents the option seller currently uses on Quick Amounts. + See [CatalogQuickAmountsSettingsOption](#type-catalogquickamountssettingsoption) for possible values + """ + + eligible_for_auto_amounts: typing.Optional[bool] = pydantic.Field(default=None) + """ + Represents location's eligibility for auto amounts + The boolean should be consistent with whether there are AUTO amounts in the `amounts`. + """ + + amounts: typing.Optional[typing.List[CatalogQuickAmount]] = pydantic.Field(default=None) + """ + Represents a set of Quick Amounts at this location. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_quick_amounts_settings_option.py b/src/square/types/catalog_quick_amounts_settings_option.py new file mode 100644 index 00000000..4228b002 --- /dev/null +++ b/src/square/types/catalog_quick_amounts_settings_option.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CatalogQuickAmountsSettingsOption = typing.Union[typing.Literal["DISABLED", "MANUAL", "AUTO"], typing.Any] diff --git a/src/square/types/catalog_stock_conversion.py b/src/square/types/catalog_stock_conversion.py new file mode 100644 index 00000000..9b89c736 --- /dev/null +++ b/src/square/types/catalog_stock_conversion.py @@ -0,0 +1,49 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class CatalogStockConversion(UncheckedBaseModel): + """ + Represents the rule of conversion between a stockable [CatalogItemVariation](entity:CatalogItemVariation) + and a non-stockable sell-by or receive-by `CatalogItemVariation` that + share the same underlying stock. + """ + + stockable_item_variation_id: str = pydantic.Field() + """ + References to the stockable [CatalogItemVariation](entity:CatalogItemVariation) + for this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation` + defined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`. + This immutable field must reference a stockable `CatalogItemVariation` + that shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.` + """ + + stockable_quantity: str = pydantic.Field() + """ + The quantity of the stockable item variation (as identified by `stockable_item_variation_id`) + equivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`) + as defined by this stock conversion. It accepts a decimal number in a string format that can take + up to 10 digits before the decimal point and up to 5 digits after the decimal point. + """ + + nonstockable_quantity: str = pydantic.Field() + """ + The converted equivalent quantity of the non-stockable [CatalogItemVariation](entity:CatalogItemVariation) + in its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together + define the conversion ratio between stockable item variation and the non-stockable item variation. + It accepts a decimal number in a string format that can take up to 10 digits before the decimal point + and up to 5 digits after the decimal point. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_subscription_plan.py b/src/square/types/catalog_subscription_plan.py new file mode 100644 index 00000000..77f53682 --- /dev/null +++ b/src/square/types/catalog_subscription_plan.py @@ -0,0 +1,70 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_object_category import CatalogObjectCategory +import pydantic +import typing +from .subscription_phase import SubscriptionPhase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import update_forward_refs + + +class CatalogSubscriptionPlan(UncheckedBaseModel): + """ + Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations. + For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + """ + + name: str = pydantic.Field() + """ + The name of the plan. + """ + + phases: typing.Optional[typing.List[SubscriptionPhase]] = pydantic.Field(default=None) + """ + A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan. + This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error + """ + + subscription_plan_variations: typing.Optional[typing.List["CatalogObject"]] = pydantic.Field(default=None) + """ + The list of subscription plan variations available for this product + """ + + eligible_item_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations. + """ + + eligible_category_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations. + """ + + all_items: typing.Optional[bool] = pydantic.Field(default=None) + """ + If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +from .catalog_item import CatalogItem # noqa: E402 +from .catalog_item_option import CatalogItemOption # noqa: E402 +from .catalog_modifier_list import CatalogModifierList # noqa: E402 +from .catalog_object_item import CatalogObjectItem # noqa: E402 +from .catalog_object_item_option import CatalogObjectItemOption # noqa: E402 +from .catalog_object_modifier_list import CatalogObjectModifierList # noqa: E402 +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan # noqa: E402 +from .catalog_object import CatalogObject # noqa: E402 + +update_forward_refs(CatalogSubscriptionPlan) diff --git a/src/square/types/catalog_subscription_plan_variation.py b/src/square/types/catalog_subscription_plan_variation.py new file mode 100644 index 00000000..dad063aa --- /dev/null +++ b/src/square/types/catalog_subscription_plan_variation.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .subscription_phase import SubscriptionPhase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogSubscriptionPlanVariation(UncheckedBaseModel): + """ + Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold. + For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + """ + + name: str = pydantic.Field() + """ + The name of the plan variation. + """ + + phases: typing.List[SubscriptionPhase] = pydantic.Field() + """ + A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation. + """ + + subscription_plan_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the subscription plan, if there is one. + """ + + monthly_billing_anchor_date: typing.Optional[int] = pydantic.Field(default=None) + """ + The day of the month the billing period starts. + """ + + can_prorate: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether bills for this plan variation can be split for proration. + """ + + successor_plan_variation_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all + locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in + its stead. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_tax.py b/src/square/types/catalog_tax.py new file mode 100644 index 00000000..e01bdff8 --- /dev/null +++ b/src/square/types/catalog_tax.py @@ -0,0 +1,62 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .tax_calculation_phase import TaxCalculationPhase +from .tax_inclusion_type import TaxInclusionType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogTax(UncheckedBaseModel): + """ + A tax applicable to an item. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. + """ + + calculation_phase: typing.Optional[TaxCalculationPhase] = pydantic.Field(default=None) + """ + Whether the tax is calculated based on a payment's subtotal or total. + See [TaxCalculationPhase](#type-taxcalculationphase) for possible values + """ + + inclusion_type: typing.Optional[TaxInclusionType] = pydantic.Field(default=None) + """ + Whether the tax is `ADDITIVE` or `INCLUSIVE`. + See [TaxInclusionType](#type-taxinclusiontype) for possible values + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. + A value of `7.5` corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant. + """ + + applies_to_custom_amounts: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, the fee applies to custom amounts entered into the Square Point of Sale + app that are not associated with a particular `CatalogItem`. + """ + + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`). + """ + + applies_to_product_set_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_time_period.py b/src/square/types/catalog_time_period.py new file mode 100644 index 00000000..7304c082 --- /dev/null +++ b/src/square/types/catalog_time_period.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogTimePeriod(UncheckedBaseModel): + """ + Represents a time period - either a single period or a repeating period. + """ + + event: typing.Optional[str] = pydantic.Field(default=None) + """ + An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which + specifies the name, timing, duration and recurrence of this time period. + + Example: + + ``` + DTSTART:20190707T180000 + DURATION:P2H + RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR + ``` + + Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported. + `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT` + and `END:VEVENT` is not required in the request. The response will always + include them. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/catalog_v1id.py b/src/square/types/catalog_v1id.py new file mode 100644 index 00000000..9ae9c1e4 --- /dev/null +++ b/src/square/types/catalog_v1id.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing_extensions +import typing +from ..core.serialization import FieldMetadata +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CatalogV1Id(UncheckedBaseModel): + """ + A Square API V1 identifier of an item, including the object ID and its associated location ID. + """ + + catalog_v1id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="catalog_v1_id")] = ( + pydantic.Field(default=None) + ) + """ + The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the `Location` this Connect V1 ID is associated with. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/category_path_to_root_node.py b/src/square/types/category_path_to_root_node.py new file mode 100644 index 00000000..881dc9a1 --- /dev/null +++ b/src/square/types/category_path_to_root_node.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CategoryPathToRootNode(UncheckedBaseModel): + """ + A node in the path from a retrieved category to its root node. + """ + + category_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The category's ID. + """ + + category_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The category's name. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/change_billing_anchor_date_response.py b/src/square/types/change_billing_anchor_date_response.py new file mode 100644 index 00000000..ba439a8a --- /dev/null +++ b/src/square/types/change_billing_anchor_date_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from .subscription_action import SubscriptionAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ChangeBillingAnchorDateResponse(UncheckedBaseModel): + """ + Defines output parameters in a request to the + [ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The specified subscription for updating billing anchor date. + """ + + actions: typing.Optional[typing.List[SubscriptionAction]] = pydantic.Field(default=None) + """ + A list of a single billing anchor date change for the subscription. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/change_timing.py b/src/square/types/change_timing.py new file mode 100644 index 00000000..372c8cd7 --- /dev/null +++ b/src/square/types/change_timing.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ChangeTiming = typing.Union[typing.Literal["IMMEDIATE", "END_OF_BILLING_CYCLE"], typing.Any] diff --git a/src/square/types/charge_request_additional_recipient.py b/src/square/types/charge_request_additional_recipient.py new file mode 100644 index 00000000..a8dd257d --- /dev/null +++ b/src/square/types/charge_request_additional_recipient.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class ChargeRequestAdditionalRecipient(UncheckedBaseModel): + """ + Represents an additional recipient (other than the merchant) entitled to a portion of the tender. + Support is currently limited to USD, CAD and GBP currencies + """ + + location_id: str = pydantic.Field() + """ + The location ID for a recipient (other than the merchant) receiving a portion of the tender. + """ + + description: str = pydantic.Field() + """ + The description of the additional recipient. + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money distributed to the recipient. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout.py b/src/square/types/checkout.py new file mode 100644 index 00000000..abd0649c --- /dev/null +++ b/src/square/types/checkout.py @@ -0,0 +1,104 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .order import Order +from .additional_recipient import AdditionalRecipient +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Checkout(UncheckedBaseModel): + """ + Square Checkout lets merchants accept online payments for supported + payment types using a checkout workflow hosted on squareup.com. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + ID generated by Square Checkout when a new checkout is requested. + """ + + checkout_page_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL that the buyer's browser should be redirected to after the + checkout is completed. + """ + + ask_for_shipping_address: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, Square Checkout will collect shipping information on your + behalf and store that information with the transaction information in your + Square Dashboard. + + Default: `false`. + """ + + merchant_support_email: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address to display on the Square Checkout confirmation page + and confirmation email that the buyer can use to contact the merchant. + + If this value is not set, the confirmation page and email will display the + primary email address associated with the merchant's Square account. + + Default: none; only exists if explicitly set. + """ + + pre_populate_buyer_email: typing.Optional[str] = pydantic.Field(default=None) + """ + If provided, the buyer's email is pre-populated on the checkout page + as an editable text field. + + Default: none; only exists if explicitly set. + """ + + pre_populate_shipping_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + If provided, the buyer's shipping info is pre-populated on the + checkout page as editable text fields. + + Default: none; only exists if explicitly set. + """ + + redirect_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL to redirect to after checkout is completed with `checkoutId`, + Square's `orderId`, `transactionId`, and `referenceId` appended as URL + parameters. For example, if the provided redirect_url is + `http://www.example.com/order-complete`, a successful transaction redirects + the customer to: + + 
http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
+ + If you do not provide a redirect URL, Square Checkout will display an order + confirmation page on your behalf; however Square strongly recommends that + you provide a redirect URL so you can verify the transaction results and + finalize the order through your existing/normal confirmation workflow. + """ + + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + Order to be checked out. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the checkout was created, in RFC 3339 format. + """ + + additional_recipients: typing.Optional[typing.List[AdditionalRecipient]] = pydantic.Field(default=None) + """ + Additional recipients (other than the merchant) receiving a portion of this checkout. + For example, fees assessed on the purchase by a third party integration. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_location_settings.py b/src/square/types/checkout_location_settings.py new file mode 100644 index 00000000..27dff4b5 --- /dev/null +++ b/src/square/types/checkout_location_settings.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .checkout_location_settings_policy import CheckoutLocationSettingsPolicy +from .checkout_location_settings_branding import CheckoutLocationSettingsBranding +from .checkout_location_settings_tipping import CheckoutLocationSettingsTipping +from .checkout_location_settings_coupons import CheckoutLocationSettingsCoupons +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutLocationSettings(UncheckedBaseModel): + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location that these settings apply to. + """ + + customer_notes_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether customers are allowed to leave notes at checkout. + """ + + policies: typing.Optional[typing.List[CheckoutLocationSettingsPolicy]] = pydantic.Field(default=None) + """ + Policy information is displayed at the bottom of the checkout pages. + You can set a maximum of two policies. + """ + + branding: typing.Optional[CheckoutLocationSettingsBranding] = pydantic.Field(default=None) + """ + The branding settings for this location. + """ + + tipping: typing.Optional[CheckoutLocationSettingsTipping] = pydantic.Field(default=None) + """ + The tip settings for this location. + """ + + coupons: typing.Optional[CheckoutLocationSettingsCoupons] = pydantic.Field(default=None) + """ + The coupon settings for this location. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the settings were last updated, in RFC 3339 format. + Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: + UTC: 2020-01-26T02:25:34Z + Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_location_settings_branding.py b/src/square/types/checkout_location_settings_branding.py new file mode 100644 index 00000000..24a9c1da --- /dev/null +++ b/src/square/types/checkout_location_settings_branding.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .checkout_location_settings_branding_header_type import CheckoutLocationSettingsBrandingHeaderType +import pydantic +from .checkout_location_settings_branding_button_shape import CheckoutLocationSettingsBrandingButtonShape +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutLocationSettingsBranding(UncheckedBaseModel): + header_type: typing.Optional[CheckoutLocationSettingsBrandingHeaderType] = pydantic.Field(default=None) + """ + Show the location logo on the checkout page. + See [HeaderType](#type-headertype) for possible values + """ + + button_color: typing.Optional[str] = pydantic.Field(default=None) + """ + The HTML-supported hex color for the button on the checkout page (for example, "#FFFFFF"). + """ + + button_shape: typing.Optional[CheckoutLocationSettingsBrandingButtonShape] = pydantic.Field(default=None) + """ + The shape of the button on the checkout page. + See [ButtonShape](#type-buttonshape) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_location_settings_branding_button_shape.py b/src/square/types/checkout_location_settings_branding_button_shape.py new file mode 100644 index 00000000..2777f306 --- /dev/null +++ b/src/square/types/checkout_location_settings_branding_button_shape.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CheckoutLocationSettingsBrandingButtonShape = typing.Union[typing.Literal["SQUARED", "ROUNDED", "PILL"], typing.Any] diff --git a/src/square/types/checkout_location_settings_branding_header_type.py b/src/square/types/checkout_location_settings_branding_header_type.py new file mode 100644 index 00000000..96f5d855 --- /dev/null +++ b/src/square/types/checkout_location_settings_branding_header_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CheckoutLocationSettingsBrandingHeaderType = typing.Union[ + typing.Literal["BUSINESS_NAME", "FRAMED_LOGO", "FULL_WIDTH_LOGO"], typing.Any +] diff --git a/src/square/types/checkout_location_settings_coupons.py b/src/square/types/checkout_location_settings_coupons.py new file mode 100644 index 00000000..80992b8c --- /dev/null +++ b/src/square/types/checkout_location_settings_coupons.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutLocationSettingsCoupons(UncheckedBaseModel): + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether coupons are enabled for this location. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_location_settings_policy.py b/src/square/types/checkout_location_settings_policy.py new file mode 100644 index 00000000..63c5483e --- /dev/null +++ b/src/square/types/checkout_location_settings_policy.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutLocationSettingsPolicy(UncheckedBaseModel): + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID to identify the policy when making changes. You must set the UID for policy updates, but it’s optional when setting new policies. + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The title of the policy. This is required when setting the description, though you can update it in a different request. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the policy. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_location_settings_tipping.py b/src/square/types/checkout_location_settings_tipping.py new file mode 100644 index 00000000..86f004ec --- /dev/null +++ b/src/square/types/checkout_location_settings_tipping.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutLocationSettingsTipping(UncheckedBaseModel): + percentages: typing.Optional[typing.List[int]] = pydantic.Field(default=None) + """ + Set three custom percentage amounts that buyers can select at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more. + """ + + smart_tipping_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping works as follows: + If a transaction is less than $10, the available tipping options include No Tip, $1, $2, or $3. + If a transaction is $10 or more, the available tipping options include No Tip, 15%, 20%, or 25%. + You can set custom percentage amounts with the `percentages` field. + """ + + default_percent: typing.Optional[int] = pydantic.Field(default=None) + """ + Set the pre-selected percentage amounts that appear at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more. + """ + + smart_tips: typing.Optional[typing.List[Money]] = pydantic.Field(default=None) + """ + Show the Smart Tip Amounts for this location. + """ + + default_smart_tip: typing.Optional[Money] = pydantic.Field(default=None) + """ + Set the pre-selected whole amount that appears at checkout when Smart Tip is enabled and the transaction amount is less than $10. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_merchant_settings.py b/src/square/types/checkout_merchant_settings.py new file mode 100644 index 00000000..8cdf65ea --- /dev/null +++ b/src/square/types/checkout_merchant_settings.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .checkout_merchant_settings_payment_methods import CheckoutMerchantSettingsPaymentMethods +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutMerchantSettings(UncheckedBaseModel): + payment_methods: typing.Optional[CheckoutMerchantSettingsPaymentMethods] = pydantic.Field(default=None) + """ + The set of payment methods accepted for the merchant's account. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the settings were last updated, in RFC 3339 format. + Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: + UTC: 2020-01-26T02:25:34Z + Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_merchant_settings_payment_methods.py b/src/square/types/checkout_merchant_settings_payment_methods.py new file mode 100644 index 00000000..b4508353 --- /dev/null +++ b/src/square/types/checkout_merchant_settings_payment_methods.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .checkout_merchant_settings_payment_methods_payment_method import ( + CheckoutMerchantSettingsPaymentMethodsPaymentMethod, +) +from .checkout_merchant_settings_payment_methods_afterpay_clearpay import ( + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay, +) +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import pydantic + + +class CheckoutMerchantSettingsPaymentMethods(UncheckedBaseModel): + apple_pay: typing.Optional[CheckoutMerchantSettingsPaymentMethodsPaymentMethod] = None + google_pay: typing.Optional[CheckoutMerchantSettingsPaymentMethodsPaymentMethod] = None + cash_app: typing.Optional[CheckoutMerchantSettingsPaymentMethodsPaymentMethod] = None + afterpay_clearpay: typing.Optional[CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay.py b/src/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay.py new file mode 100644 index 00000000..a84a4d25 --- /dev/null +++ b/src/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range import ( + CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange, +) +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay(UncheckedBaseModel): + """ + The settings allowed for AfterpayClearpay. + """ + + order_eligibility_range: typing.Optional[CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange] = ( + pydantic.Field(default=None) + ) + """ + Afterpay is shown as an option for order totals falling within the configured range. + """ + + item_eligibility_range: typing.Optional[CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange] = ( + pydantic.Field(default=None) + ) + """ + Afterpay is shown as an option for item totals falling within the configured range. + """ + + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the payment method is enabled for the account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.py b/src/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.py new file mode 100644 index 00000000..4b3f2b01 --- /dev/null +++ b/src/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing +import pydantic + + +class CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange(UncheckedBaseModel): + """ + A range of purchase price that qualifies. + """ + + min: Money + max: Money + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_merchant_settings_payment_methods_payment_method.py b/src/square/types/checkout_merchant_settings_payment_methods_payment_method.py new file mode 100644 index 00000000..6c644404 --- /dev/null +++ b/src/square/types/checkout_merchant_settings_payment_methods_payment_method.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutMerchantSettingsPaymentMethodsPaymentMethod(UncheckedBaseModel): + """ + The settings allowed for a payment method. + """ + + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the payment method is enabled for the account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_options.py b/src/square/types/checkout_options.py new file mode 100644 index 00000000..b448fe81 --- /dev/null +++ b/src/square/types/checkout_options.py @@ -0,0 +1,85 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .custom_field import CustomField +from .accepted_payment_methods import AcceptedPaymentMethods +from .money import Money +from .shipping_fee import ShippingFee +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CheckoutOptions(UncheckedBaseModel): + allow_tipping: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the payment allows tipping. + """ + + custom_fields: typing.Optional[typing.List[CustomField]] = pydantic.Field(default=None) + """ + The custom fields requesting information from the buyer. + """ + + subscription_plan_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the subscription plan for the buyer to pay and subscribe. + For more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout). + """ + + redirect_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The confirmation page URL to redirect the buyer to after Square processes the payment. + """ + + merchant_support_email: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address that buyers can use to contact the seller. + """ + + ask_for_shipping_address: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether to include the address fields in the payment form. + """ + + accepted_payment_methods: typing.Optional[AcceptedPaymentMethods] = pydantic.Field(default=None) + """ + The methods allowed for buyers during checkout. + """ + + app_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. For more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/collect-fees/additional-considerations#permissions). + """ + + shipping_fee: typing.Optional[ShippingFee] = pydantic.Field(default=None) + """ + The fee associated with shipping to be applied to the `Order` as a service charge. + """ + + enable_coupon: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form. + """ + + enable_loyalty: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/checkout_options_payment_type.py b/src/square/types/checkout_options_payment_type.py new file mode 100644 index 00000000..a07788f0 --- /dev/null +++ b/src/square/types/checkout_options_payment_type.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CheckoutOptionsPaymentType = typing.Union[ + typing.Literal[ + "CARD_PRESENT", + "MANUAL_CARD_ENTRY", + "FELICA_ID", + "FELICA_QUICPAY", + "FELICA_TRANSPORTATION_GROUP", + "FELICA_ALL", + "PAYPAY", + "QR_CODE", + ], + typing.Any, +] diff --git a/src/square/types/clearpay_details.py b/src/square/types/clearpay_details.py new file mode 100644 index 00000000..30fed324 --- /dev/null +++ b/src/square/types/clearpay_details.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ClearpayDetails(UncheckedBaseModel): + """ + Additional details about Clearpay payments. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + Email address on the buyer's Clearpay account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/clone_order_response.py b/src/square/types/clone_order_response.py new file mode 100644 index 00000000..83aaaa6d --- /dev/null +++ b/src/square/types/clone_order_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CloneOrderResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint. + """ + + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The cloned order. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/collected_data.py b/src/square/types/collected_data.py new file mode 100644 index 00000000..28c77d19 --- /dev/null +++ b/src/square/types/collected_data.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CollectedData(UncheckedBaseModel): + input_text: typing.Optional[str] = pydantic.Field(default=None) + """ + The buyer's input text. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/complete_payment_response.py b/src/square/types/complete_payment_response.py new file mode 100644 index 00000000..e74c0268 --- /dev/null +++ b/src/square/types/complete_payment_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment import Payment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CompletePaymentResponse(UncheckedBaseModel): + """ + Defines the response returned by[CompletePayment](api-endpoint:Payments-CompletePayment). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + payment: typing.Optional[Payment] = pydantic.Field(default=None) + """ + The successfully completed payment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/component.py b/src/square/types/component.py new file mode 100644 index 00000000..bcfc42c5 --- /dev/null +++ b/src/square/types/component.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .component_component_type import ComponentComponentType +import pydantic +import typing +from .device_component_details_application_details import DeviceComponentDetailsApplicationDetails +from .device_component_details_card_reader_details import DeviceComponentDetailsCardReaderDetails +from .device_component_details_battery_details import DeviceComponentDetailsBatteryDetails +from .device_component_details_wi_fi_details import DeviceComponentDetailsWiFiDetails +from .device_component_details_ethernet_details import DeviceComponentDetailsEthernetDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Component(UncheckedBaseModel): + """ + The wrapper object for the component entries of a given component type. + """ + + type: ComponentComponentType = pydantic.Field() + """ + The type of this component. Each component type has expected properties expressed + in a structured format within its corresponding `*_details` field. + See [ComponentType](#type-componenttype) for possible values + """ + + application_details: typing.Optional[DeviceComponentDetailsApplicationDetails] = pydantic.Field(default=None) + """ + Structured data for an `Application`, set for Components of type `APPLICATION`. + """ + + card_reader_details: typing.Optional[DeviceComponentDetailsCardReaderDetails] = pydantic.Field(default=None) + """ + Structured data for a `CardReader`, set for Components of type `CARD_READER`. + """ + + battery_details: typing.Optional[DeviceComponentDetailsBatteryDetails] = pydantic.Field(default=None) + """ + Structured data for a `Battery`, set for Components of type `BATTERY`. + """ + + wifi_details: typing.Optional[DeviceComponentDetailsWiFiDetails] = pydantic.Field(default=None) + """ + Structured data for a `WiFi` interface, set for Components of type `WIFI`. + """ + + ethernet_details: typing.Optional[DeviceComponentDetailsEthernetDetails] = pydantic.Field(default=None) + """ + Structured data for an `Ethernet` interface, set for Components of type `ETHERNET`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/component_component_type.py b/src/square/types/component_component_type.py new file mode 100644 index 00000000..29f26bf6 --- /dev/null +++ b/src/square/types/component_component_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ComponentComponentType = typing.Union[ + typing.Literal["APPLICATION", "CARD_READER", "BATTERY", "WIFI", "ETHERNET", "PRINTER"], typing.Any +] diff --git a/src/square/types/confirmation_decision.py b/src/square/types/confirmation_decision.py new file mode 100644 index 00000000..912a2a04 --- /dev/null +++ b/src/square/types/confirmation_decision.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ConfirmationDecision(UncheckedBaseModel): + has_agreed: typing.Optional[bool] = pydantic.Field(default=None) + """ + The buyer's decision to the displayed terms. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/confirmation_options.py b/src/square/types/confirmation_options.py new file mode 100644 index 00000000..df53b048 --- /dev/null +++ b/src/square/types/confirmation_options.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .confirmation_decision import ConfirmationDecision +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ConfirmationOptions(UncheckedBaseModel): + title: str = pydantic.Field() + """ + The title text to display in the confirmation screen flow on the Terminal. + """ + + body: str = pydantic.Field() + """ + The agreement details to display in the confirmation flow on the Terminal. + """ + + agree_button_text: str = pydantic.Field() + """ + The button text to display indicating the customer agrees to the displayed terms. + """ + + disagree_button_text: typing.Optional[str] = pydantic.Field(default=None) + """ + The button text to display indicating the customer does not agree to the displayed terms. + """ + + decision: typing.Optional[ConfirmationDecision] = pydantic.Field(default=None) + """ + The result of the buyer’s actions when presented with the confirmation screen. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/coordinates.py b/src/square/types/coordinates.py new file mode 100644 index 00000000..4c140d94 --- /dev/null +++ b/src/square/types/coordinates.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Coordinates(UncheckedBaseModel): + """ + Latitude and longitude coordinates. + """ + + latitude: typing.Optional[float] = pydantic.Field(default=None) + """ + The latitude of the coordinate expressed in degrees. + """ + + longitude: typing.Optional[float] = pydantic.Field(default=None) + """ + The longitude of the coordinate expressed in degrees. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/country.py b/src/square/types/country.py new file mode 100644 index 00000000..ba9f3091 --- /dev/null +++ b/src/square/types/country.py @@ -0,0 +1,259 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +Country = typing.Union[ + typing.Literal[ + "ZZ", + "AD", + "AE", + "AF", + "AG", + "AI", + "AL", + "AM", + "AO", + "AQ", + "AR", + "AS", + "AT", + "AU", + "AW", + "AX", + "AZ", + "BA", + "BB", + "BD", + "BE", + "BF", + "BG", + "BH", + "BI", + "BJ", + "BL", + "BM", + "BN", + "BO", + "BQ", + "BR", + "BS", + "BT", + "BV", + "BW", + "BY", + "BZ", + "CA", + "CC", + "CD", + "CF", + "CG", + "CH", + "CI", + "CK", + "CL", + "CM", + "CN", + "CO", + "CR", + "CU", + "CV", + "CW", + "CX", + "CY", + "CZ", + "DE", + "DJ", + "DK", + "DM", + "DO", + "DZ", + "EC", + "EE", + "EG", + "EH", + "ER", + "ES", + "ET", + "FI", + "FJ", + "FK", + "FM", + "FO", + "FR", + "GA", + "GB", + "GD", + "GE", + "GF", + "GG", + "GH", + "GI", + "GL", + "GM", + "GN", + "GP", + "GQ", + "GR", + "GS", + "GT", + "GU", + "GW", + "GY", + "HK", + "HM", + "HN", + "HR", + "HT", + "HU", + "ID", + "IE", + "IL", + "IM", + "IN", + "IO", + "IQ", + "IR", + "IS", + "IT", + "JE", + "JM", + "JO", + "JP", + "KE", + "KG", + "KH", + "KI", + "KM", + "KN", + "KP", + "KR", + "KW", + "KY", + "KZ", + "LA", + "LB", + "LC", + "LI", + "LK", + "LR", + "LS", + "LT", + "LU", + "LV", + "LY", + "MA", + "MC", + "MD", + "ME", + "MF", + "MG", + "MH", + "MK", + "ML", + "MM", + "MN", + "MO", + "MP", + "MQ", + "MR", + "MS", + "MT", + "MU", + "MV", + "MW", + "MX", + "MY", + "MZ", + "NA", + "NC", + "NE", + "NF", + "NG", + "NI", + "NL", + "NO", + "NP", + "NR", + "NU", + "NZ", + "OM", + "PA", + "PE", + "PF", + "PG", + "PH", + "PK", + "PL", + "PM", + "PN", + "PR", + "PS", + "PT", + "PW", + "PY", + "QA", + "RE", + "RO", + "RS", + "RU", + "RW", + "SA", + "SB", + "SC", + "SD", + "SE", + "SG", + "SH", + "SI", + "SJ", + "SK", + "SL", + "SM", + "SN", + "SO", + "SR", + "SS", + "ST", + "SV", + "SX", + "SY", + "SZ", + "TC", + "TD", + "TF", + "TG", + "TH", + "TJ", + "TK", + "TL", + "TM", + "TN", + "TO", + "TR", + "TT", + "TV", + "TW", + "TZ", + "UA", + "UG", + "UM", + "US", + "UY", + "UZ", + "VA", + "VC", + "VE", + "VG", + "VI", + "VN", + "VU", + "WF", + "WS", + "YE", + "YT", + "ZA", + "ZM", + "ZW", + ], + typing.Any, +] diff --git a/src/square/types/create_booking_custom_attribute_definition_response.py b/src/square/types/create_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..3417bdcf --- /dev/null +++ b/src/square/types/create_booking_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateBookingCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The newly created custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_booking_response.py b/src/square/types/create_booking_response.py new file mode 100644 index 00000000..65281283 --- /dev/null +++ b/src/square/types/create_booking_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking import Booking +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateBookingResponse(UncheckedBaseModel): + booking: typing.Optional[Booking] = pydantic.Field(default=None) + """ + The booking that was created. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_break_type_response.py b/src/square/types/create_break_type_response.py new file mode 100644 index 00000000..f3b50e42 --- /dev/null +++ b/src/square/types/create_break_type_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .break_type import BreakType +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateBreakTypeResponse(UncheckedBaseModel): + """ + The response to the request to create a `BreakType`. The response contains + the created `BreakType` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_type: typing.Optional[BreakType] = pydantic.Field(default=None) + """ + The `BreakType` that was created by the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_card_response.py b/src/square/types/create_card_response.py new file mode 100644 index 00000000..469f2553 --- /dev/null +++ b/src/square/types/create_card_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .card import Card +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCardResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [CreateCard](api-endpoint:Cards-CreateCard) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors resulting from the request. + """ + + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The card created by the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_catalog_image_request.py b/src/square/types/create_catalog_image_request.py new file mode 100644 index 00000000..f653ab65 --- /dev/null +++ b/src/square/types/create_catalog_image_request.py @@ -0,0 +1,57 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import pydantic +import typing +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCatalogImageRequest(UncheckedBaseModel): + idempotency_key: str = pydantic.Field() + """ + A unique string that identifies this CreateCatalogImage request. + Keys can be any valid string but must be unique for every CreateCatalogImage request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + """ + + object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique ID of the `CatalogObject` to attach this `CatalogImage` object to. Leave this + field empty to create unattached images, for example if you are building an integration + where an image can be attached to catalog items at a later time. + """ + + image: CatalogObject = pydantic.Field() + """ + The new `CatalogObject` of the `IMAGE` type, namely, a `CatalogImage` object, to encapsulate the specified image file. + """ + + is_primary: typing.Optional[bool] = pydantic.Field(default=None) + """ + If this is set to `true`, the image created will be the primary, or first image of the object referenced by `object_id`. + If the `CatalogObject` already has a primary `CatalogImage`, setting this field to `true` will replace the primary image. + If this is set to `false` and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of `image_ids` on the object. + + With Square API version 2021-12-15 or later, the default value is `false`. Otherwise, the effective default value is `true`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_catalog_image_response.py b/src/square/types/create_catalog_image_response.py new file mode 100644 index 00000000..a203d007 --- /dev/null +++ b/src/square/types/create_catalog_image_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCatalogImageResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + image: typing.Optional[CatalogObject] = pydantic.Field(default=None) + """ + The newly created `CatalogImage` including a Square-generated + URL for the encapsulated image file. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_checkout_response.py b/src/square/types/create_checkout_response.py new file mode 100644 index 00000000..113a155e --- /dev/null +++ b/src/square/types/create_checkout_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .checkout import Checkout +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCheckoutResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `CreateCheckout` endpoint. + """ + + checkout: typing.Optional[Checkout] = pydantic.Field(default=None) + """ + The newly created `checkout` object associated with the provided idempotency key. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_customer_card_response.py b/src/square/types/create_customer_card_response.py new file mode 100644 index 00000000..aa0a44d2 --- /dev/null +++ b/src/square/types/create_customer_card_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .card import Card +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCustomerCardResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `CreateCustomerCard` endpoint. + + Either `errors` or `card` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The created card on file. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_customer_custom_attribute_definition_response.py b/src/square/types/create_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..71904724 --- /dev/null +++ b/src/square/types/create_customer_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCustomerCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The new custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_customer_group_response.py b/src/square/types/create_customer_group_response.py new file mode 100644 index 00000000..11c8b7d5 --- /dev/null +++ b/src/square/types/create_customer_group_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer_group import CustomerGroup +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCustomerGroupResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) endpoint. + + Either `errors` or `group` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + group: typing.Optional[CustomerGroup] = pydantic.Field(default=None) + """ + The successfully created customer group. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_customer_response.py b/src/square/types/create_customer_response.py new file mode 100644 index 00000000..df908c5b --- /dev/null +++ b/src/square/types/create_customer_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer import Customer +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateCustomerResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [CreateCustomer](api-endpoint:Customers-CreateCustomer) or + [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint. + + Either `errors` or `customer` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + customer: typing.Optional[Customer] = pydantic.Field(default=None) + """ + The created customer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_device_code_response.py b/src/square/types/create_device_code_response.py new file mode 100644 index 00000000..71fd0350 --- /dev/null +++ b/src/square/types/create_device_code_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .device_code import DeviceCode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateDeviceCodeResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + device_code: typing.Optional[DeviceCode] = pydantic.Field(default=None) + """ + The created DeviceCode object containing the device code string. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_dispute_evidence_file_request.py b/src/square/types/create_dispute_evidence_file_request.py new file mode 100644 index 00000000..d31e7cf5 --- /dev/null +++ b/src/square/types/create_dispute_evidence_file_request.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .dispute_evidence_type import DisputeEvidenceType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateDisputeEvidenceFileRequest(UncheckedBaseModel): + """ + Defines the parameters for a `CreateDisputeEvidenceFile` request. + """ + + idempotency_key: str = pydantic.Field() + """ + A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + """ + + evidence_type: typing.Optional[DisputeEvidenceType] = pydantic.Field(default=None) + """ + The type of evidence you are uploading. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + """ + + content_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The MIME type of the uploaded file. + The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_dispute_evidence_file_response.py b/src/square/types/create_dispute_evidence_file_response.py new file mode 100644 index 00000000..01bf03c3 --- /dev/null +++ b/src/square/types/create_dispute_evidence_file_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute_evidence import DisputeEvidence +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateDisputeEvidenceFileResponse(UncheckedBaseModel): + """ + Defines the fields in a `CreateDisputeEvidenceFile` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + evidence: typing.Optional[DisputeEvidence] = pydantic.Field(default=None) + """ + The metadata of the newly uploaded dispute evidence. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_dispute_evidence_text_response.py b/src/square/types/create_dispute_evidence_text_response.py new file mode 100644 index 00000000..bcc6ea29 --- /dev/null +++ b/src/square/types/create_dispute_evidence_text_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute_evidence import DisputeEvidence +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateDisputeEvidenceTextResponse(UncheckedBaseModel): + """ + Defines the fields in a `CreateDisputeEvidenceText` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + evidence: typing.Optional[DisputeEvidence] = pydantic.Field(default=None) + """ + The newly uploaded dispute evidence metadata. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_gift_card_activity_response.py b/src/square/types/create_gift_card_activity_response.py new file mode 100644 index 00000000..5e10aec5 --- /dev/null +++ b/src/square/types/create_gift_card_activity_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card_activity import GiftCardActivity +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateGiftCardActivityResponse(UncheckedBaseModel): + """ + A response that contains a `GiftCardActivity` that was created. + The response might contain a set of `Error` objects if the request resulted in errors. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card_activity: typing.Optional[GiftCardActivity] = pydantic.Field(default=None) + """ + The gift card activity that was created. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_gift_card_response.py b/src/square/types/create_gift_card_response.py new file mode 100644 index 00000000..2508b464 --- /dev/null +++ b/src/square/types/create_gift_card_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateGiftCardResponse(UncheckedBaseModel): + """ + A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request + resulted in errors. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card: typing.Optional[GiftCard] = pydantic.Field(default=None) + """ + The new gift card. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_invoice_attachment_response.py b/src/square/types/create_invoice_attachment_response.py new file mode 100644 index 00000000..3e300d24 --- /dev/null +++ b/src/square/types/create_invoice_attachment_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice_attachment import InvoiceAttachment +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateInvoiceAttachmentResponse(UncheckedBaseModel): + """ + Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) response. + """ + + attachment: typing.Optional[InvoiceAttachment] = pydantic.Field(default=None) + """ + Metadata about the attachment that was added to the invoice. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_invoice_response.py b/src/square/types/create_invoice_response.py new file mode 100644 index 00000000..fa8da908 --- /dev/null +++ b/src/square/types/create_invoice_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateInvoiceResponse(UncheckedBaseModel): + """ + The response returned by the `CreateInvoice` request. + """ + + invoice: typing.Optional[Invoice] = pydantic.Field(default=None) + """ + The newly created invoice. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_job_response.py b/src/square/types/create_job_response.py new file mode 100644 index 00000000..da6c4aff --- /dev/null +++ b/src/square/types/create_job_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .job import Job +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateJobResponse(UncheckedBaseModel): + """ + Represents a [CreateJob](api-endpoint:Team-CreateJob) response. Either `job` or `errors` + is present in the response. + """ + + job: typing.Optional[Job] = pydantic.Field(default=None) + """ + The new job. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_location_custom_attribute_definition_response.py b/src/square/types/create_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..c5f23ced --- /dev/null +++ b/src/square/types/create_location_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateLocationCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The new custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_location_response.py b/src/square/types/create_location_response.py new file mode 100644 index 00000000..ebae04d7 --- /dev/null +++ b/src/square/types/create_location_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .location import Location +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateLocationResponse(UncheckedBaseModel): + """ + The response object returned by the [CreateLocation](api-endpoint:Locations-CreateLocation) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request. + """ + + location: typing.Optional[Location] = pydantic.Field(default=None) + """ + The newly created `Location` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_loyalty_account_response.py b/src/square/types/create_loyalty_account_response.py new file mode 100644 index 00000000..ba46cb72 --- /dev/null +++ b/src/square/types/create_loyalty_account_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_account import LoyaltyAccount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateLoyaltyAccountResponse(UncheckedBaseModel): + """ + A response that includes loyalty account created. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_account: typing.Optional[LoyaltyAccount] = pydantic.Field(default=None) + """ + The newly created loyalty account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_loyalty_promotion_response.py b/src/square/types/create_loyalty_promotion_response.py new file mode 100644 index 00000000..71641617 --- /dev/null +++ b/src/square/types/create_loyalty_promotion_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_promotion import LoyaltyPromotion +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateLoyaltyPromotionResponse(UncheckedBaseModel): + """ + Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) response. + Either `loyalty_promotion` or `errors` is present in the response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_promotion: typing.Optional[LoyaltyPromotion] = pydantic.Field(default=None) + """ + The new loyalty promotion. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_loyalty_reward_response.py b/src/square/types/create_loyalty_reward_response.py new file mode 100644 index 00000000..904c811c --- /dev/null +++ b/src/square/types/create_loyalty_reward_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_reward import LoyaltyReward +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateLoyaltyRewardResponse(UncheckedBaseModel): + """ + A response that includes the loyalty reward created. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + reward: typing.Optional[LoyaltyReward] = pydantic.Field(default=None) + """ + The loyalty reward created. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_merchant_custom_attribute_definition_response.py b/src/square/types/create_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..5c40bf95 --- /dev/null +++ b/src/square/types/create_merchant_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateMerchantCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The new custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_mobile_authorization_code_response.py b/src/square/types/create_mobile_authorization_code_response.py new file mode 100644 index 00000000..1a53e80b --- /dev/null +++ b/src/square/types/create_mobile_authorization_code_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateMobileAuthorizationCodeResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `CreateMobileAuthorizationCode` endpoint. + """ + + authorization_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The generated authorization code that connects a mobile application instance + to a Square account. + """ + + expires_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when `authorization_code` expires, in + [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, "2016-09-04T23:59:33.123Z"). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_order_custom_attribute_definition_response.py b/src/square/types/create_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..d5f956b9 --- /dev/null +++ b/src/square/types/create_order_custom_attribute_definition_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateOrderCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from creating an order custom attribute definition. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The new custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_order_request.py b/src/square/types/create_order_request.py new file mode 100644 index 00000000..9dff1e8b --- /dev/null +++ b/src/square/types/create_order_request.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateOrderRequest(UncheckedBaseModel): + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The order to create. If this field is set, the only other top-level field that can be + set is the `idempotency_key`. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A value you specify that uniquely identifies this + order among orders you have created. + + If you are unsure whether a particular order was created successfully, + you can try it again with the same idempotency key without + worrying about creating duplicate orders. + + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_order_response.py b/src/square/types/create_order_response.py new file mode 100644 index 00000000..fcbef0ee --- /dev/null +++ b/src/square/types/create_order_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateOrderResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `CreateOrder` endpoint. + + Either `errors` or `order` is present in a given response, but never both. + """ + + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The newly created order. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_payment_link_response.py b/src/square/types/create_payment_link_response.py new file mode 100644 index 00000000..7320c531 --- /dev/null +++ b/src/square/types/create_payment_link_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .payment_link import PaymentLink +from .payment_link_related_resources import PaymentLinkRelatedResources +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreatePaymentLinkResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + payment_link: typing.Optional[PaymentLink] = pydantic.Field(default=None) + """ + The created payment link. + """ + + related_resources: typing.Optional[PaymentLinkRelatedResources] = pydantic.Field(default=None) + """ + The list of related objects. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_payment_response.py b/src/square/types/create_payment_response.py new file mode 100644 index 00000000..470b7a7a --- /dev/null +++ b/src/square/types/create_payment_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment import Payment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreatePaymentResponse(UncheckedBaseModel): + """ + Defines the response returned by [CreatePayment](api-endpoint:Payments-CreatePayment). + + If there are errors processing the request, the `payment` field might not be + present, or it might be present with a status of `FAILED`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + payment: typing.Optional[Payment] = pydantic.Field(default=None) + """ + The newly created payment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_shift_response.py b/src/square/types/create_shift_response.py new file mode 100644 index 00000000..d637d234 --- /dev/null +++ b/src/square/types/create_shift_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .shift import Shift +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateShiftResponse(UncheckedBaseModel): + """ + The response to a request to create a `Shift`. The response contains + the created `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shift: typing.Optional[Shift] = pydantic.Field(default=None) + """ + The `Shift` that was created on the request. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_subscription_response.py b/src/square/types/create_subscription_response.py new file mode 100644 index 00000000..ee622bac --- /dev/null +++ b/src/square/types/create_subscription_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateSubscriptionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The newly created subscription. + + For more information, see + [Subscription object](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#subscription-object). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_team_member_request.py b/src/square/types/create_team_member_request.py new file mode 100644 index 00000000..6376fa04 --- /dev/null +++ b/src/square/types/create_team_member_request.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .team_member import TeamMember +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateTeamMemberRequest(UncheckedBaseModel): + """ + Represents a create request for a `TeamMember` object. + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique string that identifies this `CreateTeamMember` request. + Keys can be any valid string, but must be unique for every request. + For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). + + The minimum length is 1 and the maximum length is 45. + """ + + team_member: typing.Optional[TeamMember] = pydantic.Field(default=None) + """ + **Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide + `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_team_member_response.py b/src/square/types/create_team_member_response.py new file mode 100644 index 00000000..bf395f32 --- /dev/null +++ b/src/square/types/create_team_member_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member import TeamMember +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateTeamMemberResponse(UncheckedBaseModel): + """ + Represents a response from a create request containing the created `TeamMember` object or error messages. + """ + + team_member: typing.Optional[TeamMember] = pydantic.Field(default=None) + """ + The successfully created `TeamMember` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_terminal_action_response.py b/src/square/types/create_terminal_action_response.py new file mode 100644 index 00000000..1bdcfbcc --- /dev/null +++ b/src/square/types/create_terminal_action_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_action import TerminalAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateTerminalActionResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + action: typing.Optional[TerminalAction] = pydantic.Field(default=None) + """ + The created `TerminalAction` + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_terminal_checkout_response.py b/src/square/types/create_terminal_checkout_response.py new file mode 100644 index 00000000..77713948 --- /dev/null +++ b/src/square/types/create_terminal_checkout_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_checkout import TerminalCheckout +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateTerminalCheckoutResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + checkout: typing.Optional[TerminalCheckout] = pydantic.Field(default=None) + """ + The created `TerminalCheckout`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_terminal_refund_response.py b/src/square/types/create_terminal_refund_response.py new file mode 100644 index 00000000..46aa5487 --- /dev/null +++ b/src/square/types/create_terminal_refund_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_refund import TerminalRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateTerminalRefundResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refund: typing.Optional[TerminalRefund] = pydantic.Field(default=None) + """ + The created `TerminalRefund`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_vendor_response.py b/src/square/types/create_vendor_response.py new file mode 100644 index 00000000..804bde73 --- /dev/null +++ b/src/square/types/create_vendor_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .vendor import Vendor +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateVendorResponse(UncheckedBaseModel): + """ + Represents an output from a call to [CreateVendor](api-endpoint:Vendors-CreateVendor). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered when the request fails. + """ + + vendor: typing.Optional[Vendor] = pydantic.Field(default=None) + """ + The successfully created [Vendor](entity:Vendor) object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/create_webhook_subscription_response.py b/src/square/types/create_webhook_subscription_response.py new file mode 100644 index 00000000..05e2c8f7 --- /dev/null +++ b/src/square/types/create_webhook_subscription_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .webhook_subscription import WebhookSubscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CreateWebhookSubscriptionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) endpoint. + + Note: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + subscription: typing.Optional[WebhookSubscription] = pydantic.Field(default=None) + """ + The new [Subscription](entity:WebhookSubscription). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/currency.py b/src/square/types/currency.py new file mode 100644 index 00000000..cdfedb33 --- /dev/null +++ b/src/square/types/currency.py @@ -0,0 +1,192 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +Currency = typing.Union[ + typing.Literal[ + "UNKNOWN_CURRENCY", + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BOV", + "BRL", + "BSD", + "BTN", + "BWP", + "BYR", + "BZD", + "CAD", + "CDF", + "CHE", + "CHF", + "CHW", + "CLF", + "CLP", + "CNY", + "COP", + "COU", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "INR", + "IQD", + "IRR", + "ISK", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LTL", + "LVL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MXV", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SLE", + "SOS", + "SRD", + "SSP", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "USN", + "USS", + "UYI", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XAG", + "XAU", + "XBA", + "XBB", + "XBC", + "XBD", + "XCD", + "XDR", + "XOF", + "XPD", + "XPF", + "XPT", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMK", + "ZMW", + "BTC", + "XUS", + ], + typing.Any, +] diff --git a/src/square/types/custom_attribute.py b/src/square/types/custom_attribute.py new file mode 100644 index 00000000..80ede3ad --- /dev/null +++ b/src/square/types/custom_attribute.py @@ -0,0 +1,73 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .custom_attribute_definition_visibility import CustomAttributeDefinitionVisibility +from .custom_attribute_definition import CustomAttributeDefinition +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomAttribute(UncheckedBaseModel): + """ + A custom attribute value. Each custom attribute value has a corresponding + `CustomAttributeDefinition` object. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + The identifier + of the custom attribute definition and its corresponding custom attributes. This value + can be a simple key, which is the key that is provided when the custom attribute definition + is created, or a qualified key, if the requesting + application is not the definition owner. The qualified key consists of the application ID + of the custom attribute definition owner + followed by the simple key that was provided when the definition was created. It has the + format application_id:simple key. + + The value for a simple key can contain up to 60 alphanumeric characters, periods (.), + underscores (_), and hyphens (-). + """ + + value: typing.Optional[typing.Optional[typing.Any]] = None + version: typing.Optional[int] = pydantic.Field(default=None) + """ + Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed. + When updating an existing custom attribute value, you can provide this field + and specify the current version of the custom attribute to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). + This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, + see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + """ + + visibility: typing.Optional[CustomAttributeDefinitionVisibility] = pydantic.Field(default=None) + """ + A copy of the `visibility` field value for the associated custom attribute definition. + See [CustomAttributeDefinitionVisibility](#type-customattributedefinitionvisibility) for possible values + """ + + definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + A copy of the associated custom attribute definition object. This field is only set when + the optional field is specified on the request. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp that indicates when the custom attribute was created or was most recently + updated, in RFC 3339 format. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp that indicates when the custom attribute was created, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/custom_attribute_definition.py b/src/square/types/custom_attribute_definition.py new file mode 100644 index 00000000..b0b2bdca --- /dev/null +++ b/src/square/types/custom_attribute_definition.py @@ -0,0 +1,98 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +import typing_extensions +from ..core.serialization import FieldMetadata +from .custom_attribute_definition_visibility import CustomAttributeDefinitionVisibility +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomAttributeDefinition(UncheckedBaseModel): + """ + Represents a definition for custom attribute values. A custom attribute definition + specifies the key, visibility, schema, and other properties for a custom attribute. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + The identifier + of the custom attribute definition and its corresponding custom attributes. This value + can be a simple key, which is the key that is provided when the custom attribute definition + is created, or a qualified key, if the requesting + application is not the definition owner. The qualified key consists of the application ID + of the custom attribute definition owner + followed by the simple key that was provided when the definition was created. It has the + format application_id:simple key. + + The value for a simple key can contain up to 60 alphanumeric characters, periods (.), + underscores (_), and hyphens (-). + + This field can not be changed + after the custom attribute definition is created. This field is required when creating + a definition and must be unique per application, seller, and resource type. + """ + + schema_: typing_extensions.Annotated[ + typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="schema") + ] = pydantic.Field(default=None) + """ + The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information, + see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the custom attribute definition for API and seller-facing UI purposes. The name must + be unique within the seller and application pair. This field is required if the + `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + Seller-oriented description of the custom attribute definition, including any constraints + that the seller should observe. May be displayed as a tooltip in Square UIs. This field is + required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. + """ + + visibility: typing.Optional[CustomAttributeDefinitionVisibility] = pydantic.Field(default=None) + """ + Specifies how the custom attribute definition and its values should be shared with + the seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`. + See [Visibility](#type-visibility) for possible values + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + Read only. The current version of the custom attribute definition. + The value is incremented each time the custom attribute definition is updated. + When updating a custom attribute definition, you can provide this field + and specify the current version of the custom attribute definition to enable + [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). + + On writes, this field must be set to the latest version. Stale writes are rejected. + + This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, + see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp that indicates when the custom attribute definition was created or most recently updated, + in RFC 3339 format. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/custom_attribute_definition_visibility.py b/src/square/types/custom_attribute_definition_visibility.py new file mode 100644 index 00000000..b0874bf9 --- /dev/null +++ b/src/square/types/custom_attribute_definition_visibility.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CustomAttributeDefinitionVisibility = typing.Union[ + typing.Literal["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], typing.Any +] diff --git a/src/square/types/custom_attribute_filter.py b/src/square/types/custom_attribute_filter.py new file mode 100644 index 00000000..f4cf8e61 --- /dev/null +++ b/src/square/types/custom_attribute_filter.py @@ -0,0 +1,66 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .range import Range +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomAttributeFilter(UncheckedBaseModel): + """ + Supported custom attribute query expressions for calling the + [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) + endpoint to search for items or item variations. + """ + + custom_attribute_definition_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A query expression to filter items or item variations by matching their custom attributes' + `custom_attribute_definition_id` property value against the the specified id. + Exactly one of `custom_attribute_definition_id` or `key` must be specified. + """ + + key: typing.Optional[str] = pydantic.Field(default=None) + """ + A query expression to filter items or item variations by matching their custom attributes' + `key` property value against the specified key. + Exactly one of `custom_attribute_definition_id` or `key` must be specified. + """ + + string_filter: typing.Optional[str] = pydantic.Field(default=None) + """ + A query expression to filter items or item variations by matching their custom attributes' + `string_value` property value against the specified text. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + number_filter: typing.Optional[Range] = pydantic.Field(default=None) + """ + A query expression to filter items or item variations with their custom attributes + containing a number value within the specified range. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + selection_uids_filter: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A query expression to filter items or item variations by matching their custom attributes' + `selection_uid_values` values against the specified selection uids. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + bool_filter: typing.Optional[bool] = pydantic.Field(default=None) + """ + A query expression to filter items or item variations by matching their custom attributes' + `boolean_value` property values against the specified Boolean expression. + Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/custom_field.py b/src/square/types/custom_field.py new file mode 100644 index 00000000..7e941376 --- /dev/null +++ b/src/square/types/custom_field.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class CustomField(UncheckedBaseModel): + """ + Describes a custom form field to add to the checkout page to collect more information from buyers during checkout. + For more information, + see [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1). + """ + + title: str = pydantic.Field() + """ + The title of the custom field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer.py b/src/square/types/customer.py new file mode 100644 index 00000000..8f508ba3 --- /dev/null +++ b/src/square/types/customer.py @@ -0,0 +1,127 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .customer_preferences import CustomerPreferences +from .customer_creation_source import CustomerCreationSource +from .customer_tax_ids import CustomerTaxIds +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Customer(UncheckedBaseModel): + """ + Represents a Square customer profile in the Customer Directory of a Square seller. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique Square-assigned ID for the customer profile. + + If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers) + or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the customer profile was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the customer profile was last updated, in RFC 3339 format. + """ + + given_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The given name (that is, the first name) associated with the customer profile. + """ + + family_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The family name (that is, the last name) associated with the customer profile. + """ + + nickname: typing.Optional[str] = pydantic.Field(default=None) + """ + A nickname for the customer profile. + """ + + company_name: typing.Optional[str] = pydantic.Field(default=None) + """ + A business name associated with the customer profile. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address associated with the customer profile. + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The physical address associated with the customer profile. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number associated with the customer profile. + """ + + birthday: typing.Optional[str] = pydantic.Field(default=None) + """ + The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21` + represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year). + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional second ID used to associate the customer profile with an + entity in another system. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + A custom note associated with the customer profile. + """ + + preferences: typing.Optional[CustomerPreferences] = pydantic.Field(default=None) + """ + Represents general customer preferences. + """ + + creation_source: typing.Optional[CustomerCreationSource] = pydantic.Field(default=None) + """ + The method used to create the customer profile. + See [CustomerCreationSource](#type-customercreationsource) for possible values + """ + + group_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of [customer groups](entity:CustomerGroup) the customer belongs to. + """ + + segment_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of [customer segments](entity:CustomerSegment) the customer belongs to. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership. + """ + + tax_ids: typing.Optional[CustomerTaxIds] = pydantic.Field(default=None) + """ + The tax ID associated with the customer profile. This field is present only for customers of sellers in EU countries or the United Kingdom. + For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_address_filter.py b/src/square/types/customer_address_filter.py new file mode 100644 index 00000000..27f1ac21 --- /dev/null +++ b/src/square/types/customer_address_filter.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_text_filter import CustomerTextFilter +import pydantic +from .country import Country +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerAddressFilter(UncheckedBaseModel): + """ + The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when + searching by an `Address`-type custom attribute. + """ + + postal_code: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + The postal code to search for. Only an `exact` match is supported. + """ + + country: typing.Optional[Country] = pydantic.Field(default=None) + """ + The country code to search for. + See [Country](#type-country) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_creation_source.py b/src/square/types/customer_creation_source.py new file mode 100644 index 00000000..c269509e --- /dev/null +++ b/src/square/types/customer_creation_source.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CustomerCreationSource = typing.Union[ + typing.Literal[ + "OTHER", + "APPOINTMENTS", + "COUPON", + "DELETION_RECOVERY", + "DIRECTORY", + "EGIFTING", + "EMAIL_COLLECTION", + "FEEDBACK", + "IMPORT", + "INVOICES", + "LOYALTY", + "MARKETING", + "MERGE", + "ONLINE_STORE", + "INSTANT_PROFILE", + "TERMINAL", + "THIRD_PARTY", + "THIRD_PARTY_IMPORT", + "UNMERGE_RECOVERY", + ], + typing.Any, +] diff --git a/src/square/types/customer_creation_source_filter.py b/src/square/types/customer_creation_source_filter.py new file mode 100644 index 00000000..162ccb1d --- /dev/null +++ b/src/square/types/customer_creation_source_filter.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_creation_source import CustomerCreationSource +import pydantic +from .customer_inclusion_exclusion import CustomerInclusionExclusion +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerCreationSourceFilter(UncheckedBaseModel): + """ + The creation source filter. + + If one or more creation sources are set, customer profiles are included in, + or excluded from, the result if they match at least one of the filter criteria. + """ + + values: typing.Optional[typing.List[CustomerCreationSource]] = pydantic.Field(default=None) + """ + The list of creation sources used as filtering criteria. + See [CustomerCreationSource](#type-customercreationsource) for possible values + """ + + rule: typing.Optional[CustomerInclusionExclusion] = pydantic.Field(default=None) + """ + Indicates whether a customer profile matching the filter criteria + should be included in the result or excluded from the result. + + Default: `INCLUDE`. + See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_custom_attribute_filter.py b/src/square/types/customer_custom_attribute_filter.py new file mode 100644 index 00000000..b534dffc --- /dev/null +++ b/src/square/types/customer_custom_attribute_filter.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .customer_custom_attribute_filter_value import CustomerCustomAttributeFilterValue +from .time_range import TimeRange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerCustomAttributeFilter(UncheckedBaseModel): + """ + The custom attribute filter. Use this filter in a set of [custom attribute filters](entity:CustomerCustomAttributeFilters) to search + based on the value or last updated date of a customer-related [custom attribute](entity:CustomAttribute). + """ + + key: str = pydantic.Field() + """ + The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute + (and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes). + """ + + filter: typing.Optional[CustomerCustomAttributeFilterValue] = pydantic.Field(default=None) + """ + A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to + search based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition, + which can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes). + + You must provide this `filter` field, the `updated_at` field, or both. + """ + + updated_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + The date range for when the custom attribute was last updated. The date range can include `start_at`, `end_at`, or + both. Range boundaries are inclusive. Dates are specified as RFC 3339 timestamps. + + You must provide this `updated_at` field, the `filter` field, or both. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_custom_attribute_filter_value.py b/src/square/types/customer_custom_attribute_filter_value.py new file mode 100644 index 00000000..e46592a5 --- /dev/null +++ b/src/square/types/customer_custom_attribute_filter_value.py @@ -0,0 +1,108 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_text_filter import CustomerTextFilter +import pydantic +from .filter_value import FilterValue +from .time_range import TimeRange +from .float_number_range import FloatNumberRange +from .customer_address_filter import CustomerAddressFilter +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerCustomAttributeFilterValue(UncheckedBaseModel): + """ + A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value + of a customer-related [custom attribute](entity:CustomAttribute). + """ + + email: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + A filter for a query based on the value of an `Email`-type custom attribute. This filter is case-insensitive and can + include `exact` or `fuzzy`, but not both. + + For an `exact` match, provide the complete email address. + + For a `fuzzy` match, provide a query expression containing one or more query tokens to match against the email address. Square removes + any punctuation (including periods (.), underscores (_), and the @ symbol) and tokenizes the email addresses on spaces. A match is found + if a tokenized email address contains all the tokens in the search query, irrespective of the token order. For example, `Steven gmail` + matches steven.jones@gmail.com and mygmail@stevensbakery.com. + """ + + phone: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + A filter for a query based on the value of a `PhoneNumber`-type custom attribute. This filter is case-insensitive and + can include `exact` or `fuzzy`, but not both. + + For an `exact` match, provide the complete phone number. This is always an E.164-compliant phone number that starts + with the + sign followed by the country code and subscriber number. For example, the format for a US phone number is +12061112222. + + For a `fuzzy` match, provide a query expression containing one or more query tokens to match against the phone number. + Square removes any punctuation and tokenizes the expression on spaces. A match is found if a tokenized phone number contains + all the tokens in the search query, irrespective of the token order. For example, `415 123 45` is tokenized to `415`, `123`, and `45`, + which matches +14151234567 and +12345674158, but does not match +1234156780. Similarly, the expression `415` matches + +14151234567, +12345674158, and +1234156780. + """ + + text: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + A filter for a query based on the value of a `String`-type custom attribute. This filter is case-insensitive and + can include `exact` or `fuzzy`, but not both. + + For an `exact` match, provide the complete string. + + For a `fuzzy` match, provide a query expression containing one or more query tokens in any order that contain complete words + to match against the string. Square tokenizes the expression using a grammar-based tokenizer. For example, the expressions `quick brown`, + `brown quick`, and `quick fox` match "The quick brown fox jumps over the lazy dog". However, `quick foxes` and `qui` do not match. + """ + + selection: typing.Optional[FilterValue] = pydantic.Field(default=None) + """ + A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive + and can contain `any`, `all`, or both. The `none` condition is not supported. + + Provide the display name of each item that you want to search for. To find the display names for the selection, use the + [Customer Custom Attributes API](api:CustomerCustomAttributes) to retrieve the corresponding custom attribute definition + and then check the `schema.items.names` field. For more information, see + [Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection). + + Note that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one + or more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller. + """ + + date: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + A filter for a query based on the value of a `Date`-type custom attribute. + + Provide a date range for this filter using `start_at`, `end_at`, or both. Range boundaries are inclusive. Dates can be specified + in `YYYY-MM-DD` format or as RFC 3339 timestamps. + """ + + number: typing.Optional[FloatNumberRange] = pydantic.Field(default=None) + """ + A filter for a query based on the value of a `Number`-type custom attribute, which can be an integer or a decimal with up to + 5 digits of precision. + + Provide a numerical range for this filter using `start_at`, `end_at`, or both. Range boundaries are inclusive. Numbers are specified + as decimals or integers. The absolute value of range boundaries must not exceed `(2^63-1)/10^5`, or 92233720368547. + """ + + boolean: typing.Optional[bool] = pydantic.Field(default=None) + """ + A filter for a query based on the value of a `Boolean`-type custom attribute. + """ + + address: typing.Optional[CustomerAddressFilter] = pydantic.Field(default=None) + """ + A filter for a query based on the value of an `Address`-type custom attribute. The filter can include `postal_code`, `country`, or both. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_custom_attribute_filters.py b/src/square/types/customer_custom_attribute_filters.py new file mode 100644 index 00000000..1505ff62 --- /dev/null +++ b/src/square/types/customer_custom_attribute_filters.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_custom_attribute_filter import CustomerCustomAttributeFilter +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerCustomAttributeFilters(UncheckedBaseModel): + """ + The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter + to search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see + [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). + """ + + filters: typing.Optional[typing.List[CustomerCustomAttributeFilter]] = pydantic.Field(default=None) + """ + The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter, + the `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_details.py b/src/square/types/customer_details.py new file mode 100644 index 00000000..d87a3d54 --- /dev/null +++ b/src/square/types/customer_details.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerDetails(UncheckedBaseModel): + """ + Details about the customer making the payment. + """ + + customer_initiated: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the customer initiated the payment. + """ + + seller_keyed_in: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates that the seller keyed in payment details on behalf of the customer. + This is used to flag a payment as Mail Order / Telephone Order (MOTO). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_filter.py b/src/square/types/customer_filter.py new file mode 100644 index 00000000..659c262d --- /dev/null +++ b/src/square/types/customer_filter.py @@ -0,0 +1,156 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_creation_source_filter import CustomerCreationSourceFilter +import pydantic +from .time_range import TimeRange +from .customer_text_filter import CustomerTextFilter +from .filter_value import FilterValue +from .customer_custom_attribute_filters import CustomerCustomAttributeFilters +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerFilter(UncheckedBaseModel): + """ + Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter + customer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results. + """ + + creation_source: typing.Optional[CustomerCreationSourceFilter] = pydantic.Field(default=None) + """ + A filter to select customers based on their creation source. + """ + + created_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + A filter to select customers based on when they were created. + """ + + updated_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + A filter to select customers based on when they were last updated. + """ + + email_address: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + A filter to [select customers by their email address](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-email-address) + visible to the seller. + This filter is case-insensitive. + + For [exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-email-address), this + filter causes the search to return customer profiles + whose `email_address` field value are identical to the email address provided + in the query. + + For [fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-email-address), + this filter causes the search to return customer profiles + whose `email_address` field value has a token-wise partial match against the filtering + expression in the query. For example, with `Steven gmail` provided in a search + query, the search returns customers whose email address is `steven.johnson@gmail.com` + or `mygmail@stevensbakery.com`. Square removes any punctuation (including periods (.), + underscores (_), and the @ symbol) and tokenizes the email addresses on spaces. A match is + found if a tokenized email address contains all the tokens in the search query, + irrespective of the token order. + """ + + phone_number: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + A filter to [select customers by their phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-phone-number) + visible to the seller. + + For [exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-phone-number), + this filter returns customers whose phone number matches the specified query expression. The number in the query must be of an + E.164-compliant form. In particular, it must include the leading `+` sign followed by a country code and then a subscriber number. + For example, the standard E.164 form of a US phone number is `+12062223333` and an E.164-compliant variation is `+1 (206) 222-3333`. + To match the query expression, stored customer phone numbers are converted to the standard E.164 form. + + For [fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-phone-number), + this filter returns customers whose phone number matches the token or tokens provided in the query expression. For example, with `415` + provided in a search query, the search returns customers with the phone numbers `+1-415-212-1200`, `+1-212-415-1234`, and `+1 (551) 234-1567`. + Similarly, a search query of `415 123` returns customers with the phone numbers `+1-212-415-1234` and `+1 (551) 234-1567` but not + `+1-212-415-1200`. A match is found if a tokenized phone number contains all the tokens in the search query, irrespective of the token order. + """ + + reference_id: typing.Optional[CustomerTextFilter] = pydantic.Field(default=None) + """ + A filter to [select customers by their reference IDs](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-reference-id). + This filter is case-insensitive. + + [Exact matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#exact-search-by-reference-id) + of a customer's reference ID against a query's reference ID is evaluated as an + exact match between two strings, character by character in the given order. + + [Fuzzy matching](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#fuzzy-search-by-reference-id) + of stored reference IDs against queried reference IDs works + exactly the same as fuzzy matching on email addresses. Non-alphanumeric characters + are replaced by spaces to tokenize stored and queried reference IDs. A match is found + if a tokenized stored reference ID contains all tokens specified in any order in the query. For example, + a query of `NYC M` matches customer profiles with the `reference_id` value of `NYC_M_35_JOHNSON` + and `NYC_27_MURRAY`. + """ + + group_ids: typing.Optional[FilterValue] = pydantic.Field(default=None) + """ + A filter to select customers based on the [groups](entity:CustomerGroup) they belong to. + Group membership is controlled by sellers and developers. + + The `group_ids` filter has the following syntax: + ``` + "group_ids": { + "any": ["{group_a_id}", "{group_b_id}", ...], + "all": ["{group_1_id}", "{group_2_id}", ...], + "none": ["{group_i_id}", "{group_ii_id}", ...] + } + ``` + + You can use any combination of the `any`, `all`, and `none` fields in the filter. + With `any`, the search returns customers in groups `a` or `b` or any other group specified in the list. + With `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list. + With `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list. + + If any of the search conditions are not met, including when an invalid or non-existent group ID is provided, + the result is an empty object (`{}`). + """ + + custom_attribute: typing.Optional[CustomerCustomAttributeFilters] = pydantic.Field(default=None) + """ + A filter to select customers based on one or more custom attributes. + This filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom + attribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation. + + To be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries, + see [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). + + Square returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes, + use the [Customer Custom Attributes API](api:CustomerCustomAttributes). For example, you can call + [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) using a customer ID from the result set. + """ + + segment_ids: typing.Optional[FilterValue] = pydantic.Field(default=None) + """ + A filter to select customers based on the [segments](entity:CustomerSegment) they belong to. + Segment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria. + + You can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields. + For the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C. + + ``` + "segment_ids": { + "all": ["{segment_A_id}", "{segment_B_id}"], + "none": ["{segment_C_id}"] + } + ``` + + If an invalid or non-existent segment ID is provided in the filter, Square stops processing the request + and returns a `400 BAD_REQUEST` error that includes the segment ID. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_group.py b/src/square/types/customer_group.py new file mode 100644 index 00000000..d8e303cd --- /dev/null +++ b/src/square/types/customer_group.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerGroup(UncheckedBaseModel): + """ + Represents a group of customer profiles. + + Customer groups can be created, be modified, and have their membership defined using + the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique Square-generated ID for the customer group. + """ + + name: str = pydantic.Field() + """ + The name of the customer group. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the customer group was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the customer group was last updated, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_inclusion_exclusion.py b/src/square/types/customer_inclusion_exclusion.py new file mode 100644 index 00000000..49d66f0e --- /dev/null +++ b/src/square/types/customer_inclusion_exclusion.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CustomerInclusionExclusion = typing.Union[typing.Literal["INCLUDE", "EXCLUDE"], typing.Any] diff --git a/src/square/types/customer_preferences.py b/src/square/types/customer_preferences.py new file mode 100644 index 00000000..9b792c40 --- /dev/null +++ b/src/square/types/customer_preferences.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerPreferences(UncheckedBaseModel): + """ + Represents communication preferences for the customer profile. + """ + + email_unsubscribed: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the customer has unsubscribed from marketing campaign emails. A value of `true` means that the customer chose to opt out of email marketing from the current Square seller or from all Square sellers. This value is read-only from the Customers API. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_query.py b/src/square/types/customer_query.py new file mode 100644 index 00000000..c152e558 --- /dev/null +++ b/src/square/types/customer_query.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_filter import CustomerFilter +import pydantic +from .customer_sort import CustomerSort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerQuery(UncheckedBaseModel): + """ + Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request. + """ + + filter: typing.Optional[CustomerFilter] = pydantic.Field(default=None) + """ + The filtering criteria for the search query. A query can contain multiple filters in any combination. + Multiple filters are combined as `AND` statements. + + __Note:__ Combining multiple filters as `OR` statements is not supported. Instead, send multiple single-filter + searches and join the result sets. + """ + + sort: typing.Optional[CustomerSort] = pydantic.Field(default=None) + """ + Sorting criteria for query results. The default behavior is to sort + customers alphabetically by `given_name` and `family_name`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_segment.py b/src/square/types/customer_segment.py new file mode 100644 index 00000000..6aaeb389 --- /dev/null +++ b/src/square/types/customer_segment.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerSegment(UncheckedBaseModel): + """ + Represents a group of customer profiles that match one or more predefined filter criteria. + + Segments (also known as Smart Groups) are defined and created within the Customer Directory in the + Square Seller Dashboard or Point of Sale. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique Square-generated ID for the segment. + """ + + name: str = pydantic.Field() + """ + The name of the segment. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the segment was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the segment was last updated, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_sort.py b/src/square/types/customer_sort.py new file mode 100644 index 00000000..39383f39 --- /dev/null +++ b/src/square/types/customer_sort.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .customer_sort_field import CustomerSortField +import pydantic +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerSort(UncheckedBaseModel): + """ + Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort + customer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results. + """ + + field: typing.Optional[CustomerSortField] = pydantic.Field(default=None) + """ + Indicates the fields to use as the sort key, which is either the default set of fields or `created_at`. + + The default value is `DEFAULT`. + See [CustomerSortField](#type-customersortfield) for possible values + """ + + order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + Indicates the order in which results should be sorted based on the + sort field value. Strings use standard alphabetic comparison + to determine order. Strings representing numbers are sorted as strings. + + The default value is `ASC`. + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_sort_field.py b/src/square/types/customer_sort_field.py new file mode 100644 index 00000000..17fc0c6f --- /dev/null +++ b/src/square/types/customer_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CustomerSortField = typing.Union[typing.Literal["DEFAULT", "CREATED_AT"], typing.Any] diff --git a/src/square/types/customer_tax_ids.py b/src/square/types/customer_tax_ids.py new file mode 100644 index 00000000..b8970d52 --- /dev/null +++ b/src/square/types/customer_tax_ids.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerTaxIds(UncheckedBaseModel): + """ + Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. + For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). + """ + + eu_vat: typing.Optional[str] = pydantic.Field(default=None) + """ + The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/customer_text_filter.py b/src/square/types/customer_text_filter.py new file mode 100644 index 00000000..d7756a78 --- /dev/null +++ b/src/square/types/customer_text_filter.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class CustomerTextFilter(UncheckedBaseModel): + """ + A filter to select customers based on exact or fuzzy matching of + customer attributes against a specified query. Depending on the customer attributes, + the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. + """ + + exact: typing.Optional[str] = pydantic.Field(default=None) + """ + Use the exact filter to select customers whose attributes match exactly the specified query. + """ + + fuzzy: typing.Optional[str] = pydantic.Field(default=None) + """ + Use the fuzzy filter to select customers whose attributes match the specified query + in a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then + each query token must be matched somewhere in the searched attribute. For single token queries, + this is effectively the same behavior as a partial match operation. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/data_collection_options.py b/src/square/types/data_collection_options.py new file mode 100644 index 00000000..8a296090 --- /dev/null +++ b/src/square/types/data_collection_options.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .data_collection_options_input_type import DataCollectionOptionsInputType +import typing +from .collected_data import CollectedData +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DataCollectionOptions(UncheckedBaseModel): + title: str = pydantic.Field() + """ + The title text to display in the data collection flow on the Terminal. + """ + + body: str = pydantic.Field() + """ + The body text to display under the title in the data collection screen flow on the + Terminal. + """ + + input_type: DataCollectionOptionsInputType = pydantic.Field() + """ + Represents the type of the input text. + See [InputType](#type-inputtype) for possible values + """ + + collected_data: typing.Optional[CollectedData] = pydantic.Field(default=None) + """ + The buyer’s input text from the data collection screen. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/data_collection_options_input_type.py b/src/square/types/data_collection_options_input_type.py new file mode 100644 index 00000000..341ce49b --- /dev/null +++ b/src/square/types/data_collection_options_input_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DataCollectionOptionsInputType = typing.Union[typing.Literal["EMAIL", "PHONE_NUMBER"], typing.Any] diff --git a/src/square/types/date_range.py b/src/square/types/date_range.py new file mode 100644 index 00000000..68c962c5 --- /dev/null +++ b/src/square/types/date_range.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DateRange(UncheckedBaseModel): + """ + A range defined by two dates. Used for filtering a query for Connect v2 + objects that have date properties. + """ + + start_date: typing.Optional[str] = pydantic.Field(default=None) + """ + A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601 + extended format for calendar dates. + The beginning of a date range (inclusive). + """ + + end_date: typing.Optional[str] = pydantic.Field(default=None) + """ + A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601 + extended format for calendar dates. + The end of a date range (inclusive). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/day_of_week.py b/src/square/types/day_of_week.py new file mode 100644 index 00000000..93d23f41 --- /dev/null +++ b/src/square/types/day_of_week.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DayOfWeek = typing.Union[typing.Literal["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"], typing.Any] diff --git a/src/square/types/delete_booking_custom_attribute_definition_response.py b/src/square/types/delete_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..dc334e77 --- /dev/null +++ b/src/square/types/delete_booking_custom_attribute_definition_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteBookingCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition) response + containing error messages when errors occurred during the request. The successful response does not contain any payload. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_booking_custom_attribute_response.py b/src/square/types/delete_booking_custom_attribute_response.py new file mode 100644 index 00000000..9c6c0fda --- /dev/null +++ b/src/square/types/delete_booking_custom_attribute_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteBookingCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_break_type_response.py b/src/square/types/delete_break_type_response.py new file mode 100644 index 00000000..f7384cfd --- /dev/null +++ b/src/square/types/delete_break_type_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteBreakTypeResponse(UncheckedBaseModel): + """ + The response to a request to delete a `BreakType`. The response might contain a set + of `Error` objects if the request resulted in errors. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_catalog_object_response.py b/src/square/types/delete_catalog_object_response.py new file mode 100644 index 00000000..28ab1f99 --- /dev/null +++ b/src/square/types/delete_catalog_object_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteCatalogObjectResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + deleted_object_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of all catalog objects deleted by this request. + Multiple IDs may be returned when associated objects are also deleted, for example + a catalog item variation will be deleted (and its ID included in this field) + when its parent catalog item is deleted. + """ + + deleted_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_customer_card_response.py b/src/square/types/delete_customer_card_response.py new file mode 100644 index 00000000..23e39b36 --- /dev/null +++ b/src/square/types/delete_customer_card_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteCustomerCardResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `DeleteCustomerCard` endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_customer_custom_attribute_definition_response.py b/src/square/types/delete_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..5f172807 --- /dev/null +++ b/src/square/types/delete_customer_custom_attribute_definition_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteCustomerCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from a delete request containing error messages if there are any. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_customer_custom_attribute_response.py b/src/square/types/delete_customer_custom_attribute_response.py new file mode 100644 index 00000000..205e5ad5 --- /dev/null +++ b/src/square/types/delete_customer_custom_attribute_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteCustomerCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_customer_group_response.py b/src/square/types/delete_customer_group_response.py new file mode 100644 index 00000000..ea872c55 --- /dev/null +++ b/src/square/types/delete_customer_group_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteCustomerGroupResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_customer_response.py b/src/square/types/delete_customer_response.py new file mode 100644 index 00000000..81ba61f8 --- /dev/null +++ b/src/square/types/delete_customer_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteCustomerResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `DeleteCustomer` endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_dispute_evidence_response.py b/src/square/types/delete_dispute_evidence_response.py new file mode 100644 index 00000000..eacb8d4d --- /dev/null +++ b/src/square/types/delete_dispute_evidence_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteDisputeEvidenceResponse(UncheckedBaseModel): + """ + Defines the fields in a `DeleteDisputeEvidence` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_invoice_attachment_response.py b/src/square/types/delete_invoice_attachment_response.py new file mode 100644 index 00000000..8c4f264b --- /dev/null +++ b/src/square/types/delete_invoice_attachment_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteInvoiceAttachmentResponse(UncheckedBaseModel): + """ + Represents a [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_invoice_response.py b/src/square/types/delete_invoice_response.py new file mode 100644 index 00000000..8c1e8bcc --- /dev/null +++ b/src/square/types/delete_invoice_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteInvoiceResponse(UncheckedBaseModel): + """ + Describes a `DeleteInvoice` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_location_custom_attribute_definition_response.py b/src/square/types/delete_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..b346939e --- /dev/null +++ b/src/square/types/delete_location_custom_attribute_definition_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteLocationCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from a delete request containing error messages if there are any. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_location_custom_attribute_response.py b/src/square/types/delete_location_custom_attribute_response.py new file mode 100644 index 00000000..9e29d95d --- /dev/null +++ b/src/square/types/delete_location_custom_attribute_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteLocationCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [DeleteLocationCustomAttribute](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_loyalty_reward_response.py b/src/square/types/delete_loyalty_reward_response.py new file mode 100644 index 00000000..15942a98 --- /dev/null +++ b/src/square/types/delete_loyalty_reward_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteLoyaltyRewardResponse(UncheckedBaseModel): + """ + A response returned by the API call. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_merchant_custom_attribute_definition_response.py b/src/square/types/delete_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..3746c71a --- /dev/null +++ b/src/square/types/delete_merchant_custom_attribute_definition_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteMerchantCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from a delete request containing error messages if there are any. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_merchant_custom_attribute_response.py b/src/square/types/delete_merchant_custom_attribute_response.py new file mode 100644 index 00000000..8d9fea73 --- /dev/null +++ b/src/square/types/delete_merchant_custom_attribute_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteMerchantCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [DeleteMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttribute) response. + Either an empty object `{}` (for a successful deletion) or `errors` is present in the response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_order_custom_attribute_definition_response.py b/src/square/types/delete_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..3c296d80 --- /dev/null +++ b/src/square/types/delete_order_custom_attribute_definition_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteOrderCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from deleting an order custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_order_custom_attribute_response.py b/src/square/types/delete_order_custom_attribute_response.py new file mode 100644 index 00000000..b93d5a2f --- /dev/null +++ b/src/square/types/delete_order_custom_attribute_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteOrderCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a response from deleting an order custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_payment_link_response.py b/src/square/types/delete_payment_link_response.py new file mode 100644 index 00000000..938cc1b5 --- /dev/null +++ b/src/square/types/delete_payment_link_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeletePaymentLinkResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = None + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the link that is deleted. + """ + + cancelled_order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the order that is canceled. When a payment link is deleted, Square updates the + the `state` (of the order that the checkout link created) to CANCELED. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_shift_response.py b/src/square/types/delete_shift_response.py new file mode 100644 index 00000000..5b2b0e80 --- /dev/null +++ b/src/square/types/delete_shift_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteShiftResponse(UncheckedBaseModel): + """ + The response to a request to delete a `Shift`. The response might contain a set of + `Error` objects if the request resulted in errors. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_snippet_response.py b/src/square/types/delete_snippet_response.py new file mode 100644 index 00000000..4b2579ff --- /dev/null +++ b/src/square/types/delete_snippet_response.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteSnippetResponse(UncheckedBaseModel): + """ + Represents a `DeleteSnippet` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_subscription_action_response.py b/src/square/types/delete_subscription_action_response.py new file mode 100644 index 00000000..4750bc10 --- /dev/null +++ b/src/square/types/delete_subscription_action_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteSubscriptionActionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response of the [DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction) + endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The subscription that has the specified action deleted. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/delete_webhook_subscription_response.py b/src/square/types/delete_webhook_subscription_response.py new file mode 100644 index 00000000..463bc462 --- /dev/null +++ b/src/square/types/delete_webhook_subscription_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeleteWebhookSubscriptionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [DeleteWebhookSubscription](api-endpoint:WebhookSubscriptions-DeleteWebhookSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/destination.py b/src/square/types/destination.py new file mode 100644 index 00000000..a645698b --- /dev/null +++ b/src/square/types/destination.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .destination_type import DestinationType +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Destination(UncheckedBaseModel): + """ + Information about the destination against which the payout was made. + """ + + type: typing.Optional[DestinationType] = pydantic.Field(default=None) + """ + Type of the destination such as a bank account or debit card. + See [DestinationType](#type-destinationtype) for possible values + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + Square issued unique ID (also known as the instrument ID) associated with this destination. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/destination_details.py b/src/square/types/destination_details.py new file mode 100644 index 00000000..2415f258 --- /dev/null +++ b/src/square/types/destination_details.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .destination_details_card_refund_details import DestinationDetailsCardRefundDetails +import pydantic +from .destination_details_cash_refund_details import DestinationDetailsCashRefundDetails +from .destination_details_external_refund_details import DestinationDetailsExternalRefundDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DestinationDetails(UncheckedBaseModel): + """ + Details about a refund's destination. + """ + + card_details: typing.Optional[DestinationDetailsCardRefundDetails] = pydantic.Field(default=None) + """ + Details about a card refund. Only populated if the destination_type is `CARD`. + """ + + cash_details: typing.Optional[DestinationDetailsCashRefundDetails] = pydantic.Field(default=None) + """ + Details about a cash refund. Only populated if the destination_type is `CASH`. + """ + + external_details: typing.Optional[DestinationDetailsExternalRefundDetails] = pydantic.Field(default=None) + """ + Details about an external refund. Only populated if the destination_type is `EXTERNAL`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/destination_details_card_refund_details.py b/src/square/types/destination_details_card_refund_details.py new file mode 100644 index 00000000..476bcc28 --- /dev/null +++ b/src/square/types/destination_details_card_refund_details.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .card import Card +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DestinationDetailsCardRefundDetails(UncheckedBaseModel): + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The card's non-confidential details. + """ + + entry_method: typing.Optional[str] = pydantic.Field(default=None) + """ + The method used to enter the card's details for the refund. The method can be + `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + """ + + auth_result_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The authorization code provided by the issuer when a refund is approved. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/destination_details_cash_refund_details.py b/src/square/types/destination_details_cash_refund_details.py new file mode 100644 index 00000000..8287bd3b --- /dev/null +++ b/src/square/types/destination_details_cash_refund_details.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DestinationDetailsCashRefundDetails(UncheckedBaseModel): + """ + Stores details about a cash refund. Contains only non-confidential information. + """ + + seller_supplied_money: Money = pydantic.Field() + """ + The amount and currency of the money supplied by the seller. + """ + + change_back_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of change due back to the seller. + This read-only field is calculated + from the `amount_money` and `seller_supplied_money` fields. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/destination_details_external_refund_details.py b/src/square/types/destination_details_external_refund_details.py new file mode 100644 index 00000000..2d537661 --- /dev/null +++ b/src/square/types/destination_details_external_refund_details.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DestinationDetailsExternalRefundDetails(UncheckedBaseModel): + """ + Stores details about an external refund. Contains only non-confidential information. + """ + + type: str = pydantic.Field() + """ + The type of external refund the seller paid to the buyer. It can be one of the + following: + - CHECK - Refunded using a physical check. + - BANK_TRANSFER - Refunded using external bank transfer. + - OTHER\_GIFT\_CARD - Refunded using a non-Square gift card. + - CRYPTO - Refunded using a crypto currency. + - SQUARE_CASH - Refunded using Square Cash App. + - SOCIAL - Refunded using peer-to-peer payment applications. + - EXTERNAL - A third-party application gathered this refund outside of Square. + - EMONEY - Refunded using an E-money provider. + - CARD - A credit or debit card that Square does not support. + - STORED_BALANCE - Use for house accounts, store credit, and so forth. + - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals + - OTHER - A type not listed here. + """ + + source: str = pydantic.Field() + """ + A description of the external refund source. For example, + "Food Delivery Service". + """ + + source_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An ID to associate the refund to its originating source. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/destination_type.py b/src/square/types/destination_type.py new file mode 100644 index 00000000..f7545c63 --- /dev/null +++ b/src/square/types/destination_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DestinationType = typing.Union[ + typing.Literal["BANK_ACCOUNT", "CARD", "SQUARE_BALANCE", "SQUARE_STORED_BALANCE"], typing.Any +] diff --git a/src/square/types/device.py b/src/square/types/device.py new file mode 100644 index 00000000..e33d9c41 --- /dev/null +++ b/src/square/types/device.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .device_attributes import DeviceAttributes +from .component import Component +from .device_status import DeviceStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Device(UncheckedBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A synthetic identifier for the device. The identifier includes a standardized prefix and + is otherwise an opaque id generated from key device fields. + """ + + attributes: DeviceAttributes = pydantic.Field() + """ + A collection of DeviceAttributes representing the device. + """ + + components: typing.Optional[typing.List[Component]] = pydantic.Field(default=None) + """ + A list of components applicable to the device. + """ + + status: typing.Optional[DeviceStatus] = pydantic.Field(default=None) + """ + The current status of the device. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_attributes.py b/src/square/types/device_attributes.py new file mode 100644 index 00000000..36eea8e1 --- /dev/null +++ b/src/square/types/device_attributes.py @@ -0,0 +1,61 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .device_attributes_device_type import DeviceAttributesDeviceType +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceAttributes(UncheckedBaseModel): + type: DeviceAttributesDeviceType = pydantic.Field(default="TERMINAL") + """ + The device type. + See [DeviceType](#type-devicetype) for possible values + """ + + manufacturer: str = pydantic.Field() + """ + The maker of the device. + """ + + model: typing.Optional[str] = pydantic.Field(default=None) + """ + The specific model of the device. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + A seller-specified name for the device. + """ + + manufacturers_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The manufacturer-supplied identifier for the device (where available). In many cases, + this identifier will be a serial number. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339-formatted value of the most recent update to the device information. + (Could represent any field update on the device.) + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The current version of software installed on the device. + """ + + merchant_token: typing.Optional[str] = pydantic.Field(default=None) + """ + The merchant_token identifying the merchant controlling the device. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_attributes_device_type.py b/src/square/types/device_attributes_device_type.py new file mode 100644 index 00000000..d7e3a974 --- /dev/null +++ b/src/square/types/device_attributes_device_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DeviceAttributesDeviceType = typing.Literal["TERMINAL"] diff --git a/src/square/types/device_checkout_options.py b/src/square/types/device_checkout_options.py new file mode 100644 index 00000000..c5992b3e --- /dev/null +++ b/src/square/types/device_checkout_options.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .tip_settings import TipSettings +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceCheckoutOptions(UncheckedBaseModel): + device_id: str = pydantic.Field() + """ + The unique ID of the device intended for this `TerminalCheckout`. + A list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint. + Match a `DeviceCode.device_id` value with `device_id` to get the associated device code. + """ + + skip_receipt_screen: typing.Optional[bool] = pydantic.Field(default=None) + """ + Instructs the device to skip the receipt screen. Defaults to false. + """ + + collect_signature: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates that signature collection is desired during checkout. Defaults to false. + """ + + tip_settings: typing.Optional[TipSettings] = pydantic.Field(default=None) + """ + Tip-specific settings. + """ + + show_itemized_cart: typing.Optional[bool] = pydantic.Field(default=None) + """ + Show the itemization screen prior to taking a payment. This field is only meaningful when the + checkout includes an order ID. Defaults to true. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_code.py b/src/square/types/device_code.py new file mode 100644 index 00000000..263f71ef --- /dev/null +++ b/src/square/types/device_code.py @@ -0,0 +1,75 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .product_type import ProductType +from .device_code_status import DeviceCodeStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceCode(UncheckedBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique id for this device code. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional user-defined name for the device code. + """ + + code: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique code that can be used to login. + """ + + device_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique id of the device that used this code. Populated when the device is paired up. + """ + + product_type: ProductType = pydantic.Field(default="TERMINAL_API") + """ + The targeting product type of the device code. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location assigned to this code. + """ + + status: typing.Optional[DeviceCodeStatus] = pydantic.Field(default=None) + """ + The pairing status of the device code. + See [DeviceCodeStatus](#type-devicecodestatus) for possible values + """ + + pair_by: typing.Optional[str] = pydantic.Field(default=None) + """ + When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + When this DeviceCode was created. Timestamp in RFC 3339 format. + """ + + status_changed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + When this DeviceCode's status was last changed. Timestamp in RFC 3339 format. + """ + + paired_at: typing.Optional[str] = pydantic.Field(default=None) + """ + When this DeviceCode was paired. Timestamp in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_code_status.py b/src/square/types/device_code_status.py new file mode 100644 index 00000000..03c97af9 --- /dev/null +++ b/src/square/types/device_code_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DeviceCodeStatus = typing.Union[typing.Literal["UNKNOWN", "UNPAIRED", "PAIRED", "EXPIRED"], typing.Any] diff --git a/src/square/types/device_component_details_application_details.py b/src/square/types/device_component_details_application_details.py new file mode 100644 index 00000000..35cb4da5 --- /dev/null +++ b/src/square/types/device_component_details_application_details.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .application_type import ApplicationType +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceComponentDetailsApplicationDetails(UncheckedBaseModel): + application_type: typing.Optional[ApplicationType] = pydantic.Field(default=None) + """ + The type of application. + See [ApplicationType](#type-applicationtype) for possible values + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The version of the application. + """ + + session_location: typing.Optional[str] = pydantic.Field(default=None) + """ + The location_id of the session for the application. + """ + + device_code_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the device code that was used to log in to the device. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_component_details_battery_details.py b/src/square/types/device_component_details_battery_details.py new file mode 100644 index 00000000..79e7e5bc --- /dev/null +++ b/src/square/types/device_component_details_battery_details.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .device_component_details_external_power import DeviceComponentDetailsExternalPower +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceComponentDetailsBatteryDetails(UncheckedBaseModel): + visible_percent: typing.Optional[int] = pydantic.Field(default=None) + """ + The battery charge percentage as displayed on the device. + """ + + external_power: typing.Optional[DeviceComponentDetailsExternalPower] = pydantic.Field(default=None) + """ + The status of external_power. + See [ExternalPower](#type-externalpower) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_component_details_card_reader_details.py b/src/square/types/device_component_details_card_reader_details.py new file mode 100644 index 00000000..1feba19c --- /dev/null +++ b/src/square/types/device_component_details_card_reader_details.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceComponentDetailsCardReaderDetails(UncheckedBaseModel): + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The version of the card reader. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_component_details_ethernet_details.py b/src/square/types/device_component_details_ethernet_details.py new file mode 100644 index 00000000..2afad8e2 --- /dev/null +++ b/src/square/types/device_component_details_ethernet_details.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceComponentDetailsEthernetDetails(UncheckedBaseModel): + active: typing.Optional[bool] = pydantic.Field(default=None) + """ + A boolean to represent whether the Ethernet interface is currently active. + """ + + ip_address_v4: typing.Optional[str] = pydantic.Field(default=None) + """ + The string representation of the device’s IPv4 address. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_component_details_external_power.py b/src/square/types/device_component_details_external_power.py new file mode 100644 index 00000000..12242af5 --- /dev/null +++ b/src/square/types/device_component_details_external_power.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DeviceComponentDetailsExternalPower = typing.Union[ + typing.Literal["AVAILABLE_CHARGING", "AVAILABLE_NOT_IN_USE", "UNAVAILABLE", "AVAILABLE_INSUFFICIENT"], typing.Any +] diff --git a/src/square/types/device_component_details_measurement.py b/src/square/types/device_component_details_measurement.py new file mode 100644 index 00000000..2be5a790 --- /dev/null +++ b/src/square/types/device_component_details_measurement.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import pydantic + + +class DeviceComponentDetailsMeasurement(UncheckedBaseModel): + """ + A value qualified by unit of measure. + """ + + value: typing.Optional[int] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_component_details_wi_fi_details.py b/src/square/types/device_component_details_wi_fi_details.py new file mode 100644 index 00000000..39ac6597 --- /dev/null +++ b/src/square/types/device_component_details_wi_fi_details.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .device_component_details_measurement import DeviceComponentDetailsMeasurement +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceComponentDetailsWiFiDetails(UncheckedBaseModel): + active: typing.Optional[bool] = pydantic.Field(default=None) + """ + A boolean to represent whether the WiFI interface is currently active. + """ + + ssid: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the connected WIFI network. + """ + + ip_address_v4: typing.Optional[str] = pydantic.Field(default=None) + """ + The string representation of the device’s IPv4 address. + """ + + secure_connection: typing.Optional[str] = pydantic.Field(default=None) + """ + The security protocol for a secure connection (e.g. WPA2). None provided if the connection + is unsecured. + """ + + signal_strength: typing.Optional[DeviceComponentDetailsMeasurement] = pydantic.Field(default=None) + """ + A representation of signal strength of the WIFI network connection. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_details.py b/src/square/types/device_details.py new file mode 100644 index 00000000..2c39eb52 --- /dev/null +++ b/src/square/types/device_details.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceDetails(UncheckedBaseModel): + """ + Details about the device that took the payment. + """ + + device_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-issued ID of the device. + """ + + device_installation_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-issued installation ID for the device. + """ + + device_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the device set by the seller. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_metadata.py b/src/square/types/device_metadata.py new file mode 100644 index 00000000..91637c71 --- /dev/null +++ b/src/square/types/device_metadata.py @@ -0,0 +1,81 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceMetadata(UncheckedBaseModel): + battery_percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The Terminal’s remaining battery percentage, between 1-100. + """ + + charging_state: typing.Optional[str] = pydantic.Field(default=None) + """ + The current charging state of the Terminal. + Options: `CHARGING`, `NOT_CHARGING` + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the Square seller business location associated with the Terminal. + """ + + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the Square merchant account that is currently signed-in to the Terminal. + """ + + network_connection_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The Terminal’s current network connection type. + Options: `WIFI`, `ETHERNET` + """ + + payment_region: typing.Optional[str] = pydantic.Field(default=None) + """ + The country in which the Terminal is authorized to take payments. + """ + + serial_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier assigned to the Terminal, which can be found on the lower back + of the device. + """ + + os_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The current version of the Terminal’s operating system. + """ + + app_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The current version of the application running on the Terminal. + """ + + wifi_network_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the Wi-Fi network to which the Terminal is connected. + """ + + wifi_network_strength: typing.Optional[str] = pydantic.Field(default=None) + """ + The signal strength of the Wi-FI network connection. + Options: `POOR`, `FAIR`, `GOOD`, `EXCELLENT` + """ + + ip_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The IP address of the Terminal. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_status.py b/src/square/types/device_status.py new file mode 100644 index 00000000..3430fb9a --- /dev/null +++ b/src/square/types/device_status.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .device_status_category import DeviceStatusCategory +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DeviceStatus(UncheckedBaseModel): + category: typing.Optional[DeviceStatusCategory] = pydantic.Field(default=None) + """ + + See [Category](#type-category) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/device_status_category.py b/src/square/types/device_status_category.py new file mode 100644 index 00000000..579bda24 --- /dev/null +++ b/src/square/types/device_status_category.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DeviceStatusCategory = typing.Union[typing.Literal["AVAILABLE", "NEEDS_ATTENTION", "OFFLINE"], typing.Any] diff --git a/src/square/types/digital_wallet_details.py b/src/square/types/digital_wallet_details.py new file mode 100644 index 00000000..7e7c6553 --- /dev/null +++ b/src/square/types/digital_wallet_details.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .cash_app_details import CashAppDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DigitalWalletDetails(UncheckedBaseModel): + """ + Additional details about `WALLET` type payments. Contains only non-confidential information. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or + `FAILED`. + """ + + brand: typing.Optional[str] = pydantic.Field(default=None) + """ + The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`, + `RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`. + """ + + cash_app_details: typing.Optional[CashAppDetails] = pydantic.Field(default=None) + """ + Brand-specific details for payments with the `brand` of `CASH_APP`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/disable_card_response.py b/src/square/types/disable_card_response.py new file mode 100644 index 00000000..f216f61f --- /dev/null +++ b/src/square/types/disable_card_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .card import Card +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DisableCardResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [DisableCard](api-endpoint:Cards-DisableCard) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The retrieved card. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/disable_events_response.py b/src/square/types/disable_events_response.py new file mode 100644 index 00000000..fea31385 --- /dev/null +++ b/src/square/types/disable_events_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DisableEventsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [DisableEvents](api-endpoint:Events-DisableEvents) endpoint. + + Note: if there are errors processing the request, the events field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dismiss_terminal_action_response.py b/src/square/types/dismiss_terminal_action_response.py new file mode 100644 index 00000000..acbe9a02 --- /dev/null +++ b/src/square/types/dismiss_terminal_action_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_action import TerminalAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DismissTerminalActionResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + action: typing.Optional[TerminalAction] = pydantic.Field(default=None) + """ + Current state of the action to be dismissed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dismiss_terminal_checkout_response.py b/src/square/types/dismiss_terminal_checkout_response.py new file mode 100644 index 00000000..2d896121 --- /dev/null +++ b/src/square/types/dismiss_terminal_checkout_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_checkout import TerminalCheckout +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DismissTerminalCheckoutResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + checkout: typing.Optional[TerminalCheckout] = pydantic.Field(default=None) + """ + Current state of the checkout to be dismissed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dismiss_terminal_refund_response.py b/src/square/types/dismiss_terminal_refund_response.py new file mode 100644 index 00000000..d85dda21 --- /dev/null +++ b/src/square/types/dismiss_terminal_refund_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_refund import TerminalRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DismissTerminalRefundResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + refund: typing.Optional[TerminalRefund] = pydantic.Field(default=None) + """ + Current state of the refund to be dismissed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dispute.py b/src/square/types/dispute.py new file mode 100644 index 00000000..90dadfe1 --- /dev/null +++ b/src/square/types/dispute.py @@ -0,0 +1,110 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .dispute_reason import DisputeReason +from .dispute_state import DisputeState +from .disputed_payment import DisputedPayment +from .card_brand import CardBrand +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Dispute(UncheckedBaseModel): + """ + Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank. + """ + + dispute_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique ID for this `Dispute`, generated by Square. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique ID for this `Dispute`, generated by Square. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The disputed amount, which can be less than the total transaction amount. + For instance, if multiple items were purchased but the cardholder only initiates a dispute over some of the items. + """ + + reason: typing.Optional[DisputeReason] = pydantic.Field(default=None) + """ + The reason why the cardholder initiated the dispute. + See [DisputeReason](#type-disputereason) for possible values + """ + + state: typing.Optional[DisputeState] = pydantic.Field(default=None) + """ + The current state of this dispute. + See [DisputeState](#type-disputestate) for possible values + """ + + due_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The deadline by which the seller must respond to the dispute, in [RFC 3339 format](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates). + """ + + disputed_payment: typing.Optional[DisputedPayment] = pydantic.Field(default=None) + """ + The payment challenged in this dispute. + """ + + evidence_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of the evidence associated with the dispute. + """ + + card_brand: typing.Optional[CardBrand] = pydantic.Field(default=None) + """ + The card brand used in the disputed payment. + See [CardBrand](#type-cardbrand) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the dispute was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the dispute was last updated, in RFC 3339 format. + """ + + brand_dispute_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the dispute in the card brand system, generated by the card brand. + """ + + reported_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the dispute was reported, in RFC 3339 format. + """ + + reported_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the dispute was reported, in RFC 3339 format. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The current version of the `Dispute`. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location where the dispute originated. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dispute_evidence.py b/src/square/types/dispute_evidence.py new file mode 100644 index 00000000..93f6eb92 --- /dev/null +++ b/src/square/types/dispute_evidence.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .dispute_evidence_file import DisputeEvidenceFile +from .dispute_evidence_type import DisputeEvidenceType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DisputeEvidence(UncheckedBaseModel): + evidence_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the evidence. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the evidence. + """ + + dispute_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the dispute the evidence is associated with. + """ + + evidence_file: typing.Optional[DisputeEvidenceFile] = pydantic.Field(default=None) + """ + Image, PDF, TXT + """ + + evidence_text: typing.Optional[str] = pydantic.Field(default=None) + """ + Raw text + """ + + uploaded_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the evidence was uploaded, in RFC 3339 format. + """ + + evidence_type: typing.Optional[DisputeEvidenceType] = pydantic.Field(default=None) + """ + The type of the evidence. + See [DisputeEvidenceType](#type-disputeevidencetype) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dispute_evidence_file.py b/src/square/types/dispute_evidence_file.py new file mode 100644 index 00000000..b8380b9d --- /dev/null +++ b/src/square/types/dispute_evidence_file.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DisputeEvidenceFile(UncheckedBaseModel): + """ + A file to be uploaded as dispute evidence. + """ + + filename: typing.Optional[str] = pydantic.Field(default=None) + """ + The file name including the file extension. For example: "receipt.tiff". + """ + + filetype: typing.Optional[str] = pydantic.Field(default=None) + """ + Dispute evidence files must be application/pdf, image/heic, image/heif, image/jpeg, image/png, or image/tiff formats. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/dispute_evidence_type.py b/src/square/types/dispute_evidence_type.py new file mode 100644 index 00000000..1a58bd85 --- /dev/null +++ b/src/square/types/dispute_evidence_type.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DisputeEvidenceType = typing.Union[ + typing.Literal[ + "GENERIC_EVIDENCE", + "ONLINE_OR_APP_ACCESS_LOG", + "AUTHORIZATION_DOCUMENTATION", + "CANCELLATION_OR_REFUND_DOCUMENTATION", + "CARDHOLDER_COMMUNICATION", + "CARDHOLDER_INFORMATION", + "PURCHASE_ACKNOWLEDGEMENT", + "DUPLICATE_CHARGE_DOCUMENTATION", + "PRODUCT_OR_SERVICE_DESCRIPTION", + "RECEIPT", + "SERVICE_RECEIVED_DOCUMENTATION", + "PROOF_OF_DELIVERY_DOCUMENTATION", + "RELATED_TRANSACTION_DOCUMENTATION", + "REBUTTAL_EXPLANATION", + "TRACKING_NUMBER", + ], + typing.Any, +] diff --git a/src/square/types/dispute_reason.py b/src/square/types/dispute_reason.py new file mode 100644 index 00000000..a7288b88 --- /dev/null +++ b/src/square/types/dispute_reason.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DisputeReason = typing.Union[ + typing.Literal[ + "AMOUNT_DIFFERS", + "CANCELLED", + "DUPLICATE", + "NO_KNOWLEDGE", + "NOT_AS_DESCRIBED", + "NOT_RECEIVED", + "PAID_BY_OTHER_MEANS", + "CUSTOMER_REQUESTS_CREDIT", + "EMV_LIABILITY_SHIFT", + ], + typing.Any, +] diff --git a/src/square/types/dispute_state.py b/src/square/types/dispute_state.py new file mode 100644 index 00000000..b88129b7 --- /dev/null +++ b/src/square/types/dispute_state.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DisputeState = typing.Union[ + typing.Literal[ + "INQUIRY_EVIDENCE_REQUIRED", + "INQUIRY_PROCESSING", + "INQUIRY_CLOSED", + "EVIDENCE_REQUIRED", + "PROCESSING", + "WON", + "LOST", + "ACCEPTED", + ], + typing.Any, +] diff --git a/src/square/types/disputed_payment.py b/src/square/types/disputed_payment.py new file mode 100644 index 00000000..e2ae3dd2 --- /dev/null +++ b/src/square/types/disputed_payment.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class DisputedPayment(UncheckedBaseModel): + """ + The payment the cardholder disputed. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + Square-generated unique ID of the payment being disputed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/employee.py b/src/square/types/employee.py new file mode 100644 index 00000000..c2e39775 --- /dev/null +++ b/src/square/types/employee.py @@ -0,0 +1,77 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .employee_status import EmployeeStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Employee(UncheckedBaseModel): + """ + An employee object that is used by the external API. + + DEPRECATED at version 2020-08-26. Replaced by [TeamMember](entity:TeamMember). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + UUID for this object. + """ + + first_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The employee's first name. + """ + + last_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The employee's last name. + """ + + email: typing.Optional[str] = pydantic.Field(default=None) + """ + The employee's email address + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The employee's phone number in E.164 format, i.e. "+12125554250" + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of location IDs where this employee has access to. + """ + + status: typing.Optional[EmployeeStatus] = pydantic.Field(default=None) + """ + Specifies the status of the employees being fetched. + See [EmployeeStatus](#type-employeestatus) for possible values + """ + + is_owner: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether this employee is the owner of the merchant. Each merchant + has one owner employee, and that employee has full authority over + the account. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/employee_status.py b/src/square/types/employee_status.py new file mode 100644 index 00000000..b86d6598 --- /dev/null +++ b/src/square/types/employee_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +EmployeeStatus = typing.Union[typing.Literal["ACTIVE", "INACTIVE"], typing.Any] diff --git a/src/square/types/employee_wage.py b/src/square/types/employee_wage.py new file mode 100644 index 00000000..cc0d0f35 --- /dev/null +++ b/src/square/types/employee_wage.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class EmployeeWage(UncheckedBaseModel): + """ + The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](entity:TeamMemberWage). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The UUID for this object. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The `Employee` that this wage is assigned to. + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The job title that this wage relates to. + """ + + hourly_rate: typing.Optional[Money] = pydantic.Field(default=None) + """ + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/enable_events_response.py b/src/square/types/enable_events_response.py new file mode 100644 index 00000000..d7387ac6 --- /dev/null +++ b/src/square/types/enable_events_response.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class EnableEventsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [EnableEvents](api-endpoint:Events-EnableEvents) endpoint. + + Note: if there are errors processing the request, the events field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/error.py b/src/square/types/error.py new file mode 100644 index 00000000..8842ebfc --- /dev/null +++ b/src/square/types/error.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .error_category import ErrorCategory +import pydantic +from .error_code import ErrorCode +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Error(UncheckedBaseModel): + """ + Represents an error encountered during a request to the Connect API. + + See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information. + """ + + category: ErrorCategory = pydantic.Field() + """ + The high-level category for the error. + See [ErrorCategory](#type-errorcategory) for possible values + """ + + code: ErrorCode = pydantic.Field() + """ + The specific code of the error. + See [ErrorCode](#type-errorcode) for possible values + """ + + detail: typing.Optional[str] = pydantic.Field(default=None) + """ + A human-readable description of the error for debugging purposes. + """ + + field: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the field provided in the original request (if any) that + the error pertains to. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/error_category.py b/src/square/types/error_category.py new file mode 100644 index 00000000..6830fea8 --- /dev/null +++ b/src/square/types/error_category.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ErrorCategory = typing.Union[ + typing.Literal[ + "API_ERROR", + "AUTHENTICATION_ERROR", + "INVALID_REQUEST_ERROR", + "RATE_LIMIT_ERROR", + "PAYMENT_METHOD_ERROR", + "REFUND_ERROR", + "MERCHANT_SUBSCRIPTION_ERROR", + "EXTERNAL_VENDOR_ERROR", + ], + typing.Any, +] diff --git a/src/square/types/error_code.py b/src/square/types/error_code.py new file mode 100644 index 00000000..77ba54db --- /dev/null +++ b/src/square/types/error_code.py @@ -0,0 +1,162 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ErrorCode = typing.Union[ + typing.Literal[ + "INTERNAL_SERVER_ERROR", + "UNAUTHORIZED", + "ACCESS_TOKEN_EXPIRED", + "ACCESS_TOKEN_REVOKED", + "CLIENT_DISABLED", + "FORBIDDEN", + "INSUFFICIENT_SCOPES", + "APPLICATION_DISABLED", + "V1_APPLICATION", + "V1_ACCESS_TOKEN", + "CARD_PROCESSING_NOT_ENABLED", + "MERCHANT_SUBSCRIPTION_NOT_FOUND", + "BAD_REQUEST", + "MISSING_REQUIRED_PARAMETER", + "INCORRECT_TYPE", + "INVALID_TIME", + "INVALID_TIME_RANGE", + "INVALID_VALUE", + "INVALID_CURSOR", + "UNKNOWN_QUERY_PARAMETER", + "CONFLICTING_PARAMETERS", + "EXPECTED_JSON_BODY", + "INVALID_SORT_ORDER", + "VALUE_REGEX_MISMATCH", + "VALUE_TOO_SHORT", + "VALUE_TOO_LONG", + "VALUE_TOO_LOW", + "VALUE_TOO_HIGH", + "VALUE_EMPTY", + "ARRAY_LENGTH_TOO_LONG", + "ARRAY_LENGTH_TOO_SHORT", + "ARRAY_EMPTY", + "EXPECTED_BOOLEAN", + "EXPECTED_INTEGER", + "EXPECTED_FLOAT", + "EXPECTED_STRING", + "EXPECTED_OBJECT", + "EXPECTED_ARRAY", + "EXPECTED_MAP", + "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "INVALID_ARRAY_VALUE", + "INVALID_ENUM_VALUE", + "INVALID_CONTENT_TYPE", + "INVALID_FORM_VALUE", + "CUSTOMER_NOT_FOUND", + "ONE_INSTRUMENT_EXPECTED", + "NO_FIELDS_SET", + "TOO_MANY_MAP_ENTRIES", + "MAP_KEY_LENGTH_TOO_SHORT", + "MAP_KEY_LENGTH_TOO_LONG", + "CUSTOMER_MISSING_NAME", + "CUSTOMER_MISSING_EMAIL", + "INVALID_PAUSE_LENGTH", + "INVALID_DATE", + "UNSUPPORTED_COUNTRY", + "UNSUPPORTED_CURRENCY", + "APPLE_TTP_PIN_TOKEN", + "CARD_EXPIRED", + "INVALID_EXPIRATION", + "INVALID_EXPIRATION_YEAR", + "INVALID_EXPIRATION_DATE", + "UNSUPPORTED_CARD_BRAND", + "UNSUPPORTED_ENTRY_METHOD", + "INVALID_ENCRYPTED_CARD", + "INVALID_CARD", + "PAYMENT_AMOUNT_MISMATCH", + "GENERIC_DECLINE", + "CVV_FAILURE", + "ADDRESS_VERIFICATION_FAILURE", + "INVALID_ACCOUNT", + "CURRENCY_MISMATCH", + "INSUFFICIENT_FUNDS", + "INSUFFICIENT_PERMISSIONS", + "CARDHOLDER_INSUFFICIENT_PERMISSIONS", + "INVALID_LOCATION", + "TRANSACTION_LIMIT", + "VOICE_FAILURE", + "PAN_FAILURE", + "EXPIRATION_FAILURE", + "CARD_NOT_SUPPORTED", + "READER_DECLINED", + "INVALID_PIN", + "MISSING_PIN", + "MISSING_ACCOUNT_TYPE", + "INVALID_POSTAL_CODE", + "INVALID_FEES", + "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "PAYMENT_LIMIT_EXCEEDED", + "GIFT_CARD_AVAILABLE_AMOUNT", + "ACCOUNT_UNUSABLE", + "BUYER_REFUSED_PAYMENT", + "DELAYED_TRANSACTION_EXPIRED", + "DELAYED_TRANSACTION_CANCELED", + "DELAYED_TRANSACTION_CAPTURED", + "DELAYED_TRANSACTION_FAILED", + "CARD_TOKEN_EXPIRED", + "CARD_TOKEN_USED", + "AMOUNT_TOO_HIGH", + "UNSUPPORTED_INSTRUMENT_TYPE", + "REFUND_AMOUNT_INVALID", + "REFUND_ALREADY_PENDING", + "PAYMENT_NOT_REFUNDABLE", + "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", + "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", + "REFUND_DECLINED", + "INSUFFICIENT_PERMISSIONS_FOR_REFUND", + "INVALID_CARD_DATA", + "SOURCE_USED", + "SOURCE_EXPIRED", + "UNSUPPORTED_LOYALTY_REWARD_TIER", + "LOCATION_MISMATCH", + "ORDER_UNPAID_NOT_RETURNABLE", + "IDEMPOTENCY_KEY_REUSED", + "UNEXPECTED_VALUE", + "SANDBOX_NOT_SUPPORTED", + "INVALID_EMAIL_ADDRESS", + "INVALID_PHONE_NUMBER", + "CHECKOUT_EXPIRED", + "BAD_CERTIFICATE", + "INVALID_SQUARE_VERSION_FORMAT", + "API_VERSION_INCOMPATIBLE", + "CARD_PRESENCE_REQUIRED", + "UNSUPPORTED_SOURCE_TYPE", + "CARD_MISMATCH", + "PLAID_ERROR", + "PLAID_ERROR_ITEM_LOGIN_REQUIRED", + "PLAID_ERROR_RATE_LIMIT", + "CARD_DECLINED", + "VERIFY_CVV_FAILURE", + "VERIFY_AVS_FAILURE", + "CARD_DECLINED_CALL_ISSUER", + "CARD_DECLINED_VERIFICATION_REQUIRED", + "BAD_EXPIRATION", + "CHIP_INSERTION_REQUIRED", + "ALLOWABLE_PIN_TRIES_EXCEEDED", + "RESERVATION_DECLINED", + "UNKNOWN_BODY_PARAMETER", + "NOT_FOUND", + "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", + "METHOD_NOT_ALLOWED", + "NOT_ACCEPTABLE", + "REQUEST_TIMEOUT", + "CONFLICT", + "GONE", + "REQUEST_ENTITY_TOO_LARGE", + "UNSUPPORTED_MEDIA_TYPE", + "UNPROCESSABLE_ENTITY", + "RATE_LIMITED", + "NOT_IMPLEMENTED", + "BAD_GATEWAY", + "SERVICE_UNAVAILABLE", + "TEMPORARY_ERROR", + "GATEWAY_TIMEOUT", + ], + typing.Any, +] diff --git a/src/square/types/event.py b/src/square/types/event.py new file mode 100644 index 00000000..3b7d602d --- /dev/null +++ b/src/square/types/event.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .event_data import EventData +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Event(UncheckedBaseModel): + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the target merchant associated with the event. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the target location associated with the event. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + The type of event this represents. + """ + + event_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for the event. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + Timestamp of when the event was created, in RFC 3339 format. + """ + + data: typing.Optional[EventData] = pydantic.Field(default=None) + """ + The data associated with the event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/event_data.py b/src/square/types/event_data.py new file mode 100644 index 00000000..3b895e0b --- /dev/null +++ b/src/square/types/event_data.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class EventData(UncheckedBaseModel): + type: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the affected object’s type. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the affected object. + """ + + deleted: typing.Optional[bool] = pydantic.Field(default=None) + """ + This is true if the affected object has been deleted; otherwise, it's absent. + """ + + object: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None) + """ + An object containing fields and values relevant to the event. It is absent if the affected object has been deleted. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/event_metadata.py b/src/square/types/event_metadata.py new file mode 100644 index 00000000..310b6c94 --- /dev/null +++ b/src/square/types/event_metadata.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class EventMetadata(UncheckedBaseModel): + """ + Contains metadata about a particular [Event](entity:Event). + """ + + event_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for the event. + """ + + api_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The API version of the event. This corresponds to the default API version of the developer application at the time when the event was created. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/event_type_metadata.py b/src/square/types/event_type_metadata.py new file mode 100644 index 00000000..2712d3c6 --- /dev/null +++ b/src/square/types/event_type_metadata.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class EventTypeMetadata(UncheckedBaseModel): + """ + Contains the metadata of a webhook event type. + """ + + event_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The event type. + """ + + api_version_introduced: typing.Optional[str] = pydantic.Field(default=None) + """ + The API version at which the event type was introduced. + """ + + release_status: typing.Optional[str] = pydantic.Field(default=None) + """ + The release status of the event type. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/exclude_strategy.py b/src/square/types/exclude_strategy.py new file mode 100644 index 00000000..ced3f87f --- /dev/null +++ b/src/square/types/exclude_strategy.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ExcludeStrategy = typing.Union[typing.Literal["LEAST_EXPENSIVE", "MOST_EXPENSIVE"], typing.Any] diff --git a/src/square/types/external_payment_details.py b/src/square/types/external_payment_details.py new file mode 100644 index 00000000..7de9754e --- /dev/null +++ b/src/square/types/external_payment_details.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ExternalPaymentDetails(UncheckedBaseModel): + """ + Stores details about an external payment. Contains only non-confidential information. + For more information, see + [Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments). + """ + + type: str = pydantic.Field() + """ + The type of external payment the seller received. It can be one of the following: + - CHECK - Paid using a physical check. + - BANK_TRANSFER - Paid using external bank transfer. + - OTHER\_GIFT\_CARD - Paid using a non-Square gift card. + - CRYPTO - Paid using a crypto currency. + - SQUARE_CASH - Paid using Square Cash App. + - SOCIAL - Paid using peer-to-peer payment applications. + - EXTERNAL - A third-party application gathered this payment outside of Square. + - EMONEY - Paid using an E-money provider. + - CARD - A credit or debit card that Square does not support. + - STORED_BALANCE - Use for house accounts, store credit, and so forth. + - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals + - OTHER - A type not listed here. + """ + + source: str = pydantic.Field() + """ + A description of the external payment source. For example, + "Food Delivery Service". + """ + + source_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An ID to associate the payment to its originating source. + """ + + source_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The fees paid to the source. The `amount_money` minus this field is + the net amount seller receives. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/filter_value.py b/src/square/types/filter_value.py new file mode 100644 index 00000000..4f6577a4 --- /dev/null +++ b/src/square/types/filter_value.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing_extensions +import typing +from ..core.serialization import FieldMetadata +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FilterValue(UncheckedBaseModel): + """ + A filter to select resources based on an exact field value. For any given + value, the value can only be in one property. Depending on the field, either + all properties can be set or only a subset will be available. + + Refer to the documentation of the field. + """ + + all_: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="all")] = pydantic.Field( + default=None + ) + """ + A list of terms that must be present on the field of the resource. + """ + + any: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of terms where at least one of them must be present on the + field of the resource. + """ + + none: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of terms that must not be present on the field the resource + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/float_number_range.py b/src/square/types/float_number_range.py new file mode 100644 index 00000000..29319f67 --- /dev/null +++ b/src/square/types/float_number_range.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FloatNumberRange(UncheckedBaseModel): + """ + Specifies a decimal number range. + """ + + start_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A decimal value indicating where the range starts. + """ + + end_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A decimal value indicating where the range ends. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment.py b/src/square/types/fulfillment.py new file mode 100644 index 00000000..b8b992c1 --- /dev/null +++ b/src/square/types/fulfillment.py @@ -0,0 +1,116 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .fulfillment_type import FulfillmentType +from .fulfillment_state import FulfillmentState +from .fulfillment_fulfillment_line_item_application import FulfillmentFulfillmentLineItemApplication +from .fulfillment_fulfillment_entry import FulfillmentFulfillmentEntry +from .fulfillment_pickup_details import FulfillmentPickupDetails +from .fulfillment_shipment_details import FulfillmentShipmentDetails +from .fulfillment_delivery_details import FulfillmentDeliveryDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Fulfillment(UncheckedBaseModel): + """ + Contains details about how to fulfill this order. + Orders can only be created with at most one fulfillment using the API. + However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the fulfillment only within this order. + """ + + type: typing.Optional[FulfillmentType] = pydantic.Field(default=None) + """ + The type of the fulfillment. + See [FulfillmentType](#type-fulfillmenttype) for possible values + """ + + state: typing.Optional[FulfillmentState] = pydantic.Field(default=None) + """ + The state of the fulfillment. + See [FulfillmentState](#type-fulfillmentstate) for possible values + """ + + line_item_application: typing.Optional[FulfillmentFulfillmentLineItemApplication] = pydantic.Field(default=None) + """ + Describes what order line items this fulfillment applies to. + It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries. + See [FulfillmentFulfillmentLineItemApplication](#type-fulfillmentfulfillmentlineitemapplication) for possible values + """ + + entries: typing.Optional[typing.List[FulfillmentFulfillmentEntry]] = pydantic.Field(default=None) + """ + A list of entries pertaining to the fulfillment of an order. Each entry must reference + a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to + fulfill. + + Multiple entries can reference the same line item `uid`, as long as the total quantity among + all fulfillment entries referencing a single line item does not exceed the quantity of the + order's line item itself. + + An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`, + `CANCELED`, or `FAILED`. Fulfillments can be created and completed independently + before order completion. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this fulfillment. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + pickup_details: typing.Optional[FulfillmentPickupDetails] = pydantic.Field(default=None) + """ + Contains details for a pickup fulfillment. These details are required when the fulfillment + type is `PICKUP`. + """ + + shipment_details: typing.Optional[FulfillmentShipmentDetails] = pydantic.Field(default=None) + """ + Contains details for a shipment fulfillment. These details are required when the fulfillment type + is `SHIPMENT`. + + A shipment fulfillment's relationship to fulfillment `state`: + `PROPOSED`: A shipment is requested. + `RESERVED`: Fulfillment in progress. Shipment processing. + `PREPARED`: Shipment packaged. Shipping label created. + `COMPLETED`: Package has been shipped. + `CANCELED`: Shipment has been canceled. + `FAILED`: Shipment has failed. + """ + + delivery_details: typing.Optional[FulfillmentDeliveryDetails] = pydantic.Field(default=None) + """ + Describes delivery details of an order fulfillment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_delivery_details.py b/src/square/types/fulfillment_delivery_details.py new file mode 100644 index 00000000..9d132927 --- /dev/null +++ b/src/square/types/fulfillment_delivery_details.py @@ -0,0 +1,187 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .fulfillment_recipient import FulfillmentRecipient +import pydantic +from .fulfillment_delivery_details_order_fulfillment_delivery_details_schedule_type import ( + FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType, +) +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FulfillmentDeliveryDetails(UncheckedBaseModel): + """ + Describes delivery details of an order fulfillment. + """ + + recipient: typing.Optional[FulfillmentRecipient] = pydantic.Field(default=None) + """ + The contact information for the person to receive the fulfillment. + """ + + schedule_type: typing.Optional[FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType] = ( + pydantic.Field(default=None) + ) + """ + Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then + `deliver_at` is required. If `ASAP`, then `prep_time_duration` is required. The default is `SCHEDULED`. + See [OrderFulfillmentDeliveryDetailsScheduleType](#type-orderfulfillmentdeliverydetailsscheduletype) for possible values + """ + + placed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was placed. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + + Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". + """ + + deliver_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + that represents the start of the delivery period. + When the fulfillment `schedule_type` is `ASAP`, the field is automatically + set to the current time plus the `prep_time_duration`. + Otherwise, the application can set this field while the fulfillment `state` is + `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the + terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`). + + The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + prep_time_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The duration of time it takes to prepare and deliver this fulfillment. + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + delivery_window_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The time period after `deliver_at` in which to deliver the order. + Applications can set this field when the fulfillment `state` is + `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state + such as `COMPLETED`, `CANCELED`, and `FAILED`). + + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + Provides additional instructions about the delivery fulfillment. + It is displayed in the Square Point of Sale application and set by the API. + """ + + completed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicates when the seller completed the fulfillment. + This field is automatically set when fulfillment `state` changes to `COMPLETED`. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + in_progress_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicates when the seller started processing the fulfillment. + This field is automatically set when the fulfillment `state` changes to `RESERVED`. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + rejected_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was rejected. This field is + automatically set when the fulfillment `state` changes to `FAILED`. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + ready_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the seller marked the fulfillment as ready for + courier pickup. This field is automatically set when the fulfillment `state` changes + to PREPARED. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + delivered_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was delivered to the recipient. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + canceled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was canceled. This field is automatically + set when the fulfillment `state` changes to `CANCELED`. + + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + cancel_reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The delivery cancellation reason. Max length: 100 characters. + """ + + courier_pickup_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when an order can be picked up by the courier for delivery. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + courier_pickup_window_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The time period after `courier_pickup_at` in which the courier should pick up the order. + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + is_no_contact_delivery: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the delivery is preferred to be no contact. + """ + + dropoff_notes: typing.Optional[str] = pydantic.Field(default=None) + """ + A note to provide additional instructions about how to deliver the order. + """ + + courier_provider_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the courier provider. + """ + + courier_support_phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The support phone number of the courier. + """ + + square_delivery_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The identifier for the delivery created by Square. + """ + + external_delivery_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The identifier for the delivery created by the third-party courier service. + """ + + managed_delivery: typing.Optional[bool] = pydantic.Field(default=None) + """ + The flag to indicate the delivery is managed by a third party (ie DoorDash), which means + we may not receive all recipient information for PII purposes. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_delivery_details_order_fulfillment_delivery_details_schedule_type.py b/src/square/types/fulfillment_delivery_details_order_fulfillment_delivery_details_schedule_type.py new file mode 100644 index 00000000..a4c286f1 --- /dev/null +++ b/src/square/types/fulfillment_delivery_details_order_fulfillment_delivery_details_schedule_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType = typing.Union[ + typing.Literal["SCHEDULED", "ASAP"], typing.Any +] diff --git a/src/square/types/fulfillment_fulfillment_entry.py b/src/square/types/fulfillment_fulfillment_entry.py new file mode 100644 index 00000000..09fa1b4e --- /dev/null +++ b/src/square/types/fulfillment_fulfillment_entry.py @@ -0,0 +1,64 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FulfillmentFulfillmentEntry(UncheckedBaseModel): + """ + Links an order line item to a fulfillment. Each entry must reference + a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to + fulfill. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the fulfillment entry only within this order. + """ + + line_item_uid: str = pydantic.Field() + """ + The `uid` from the order line item. + """ + + quantity: str = pydantic.Field() + """ + The quantity of the line item being fulfilled, formatted as a decimal number. + For example, `"3"`. + + Fulfillments for line items with a `quantity_unit` can have non-integer quantities. + For example, `"1.70000"`. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this fulfillment entry. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_fulfillment_line_item_application.py b/src/square/types/fulfillment_fulfillment_line_item_application.py new file mode 100644 index 00000000..3440f67c --- /dev/null +++ b/src/square/types/fulfillment_fulfillment_line_item_application.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +FulfillmentFulfillmentLineItemApplication = typing.Union[typing.Literal["ALL", "ENTRY_LIST"], typing.Any] diff --git a/src/square/types/fulfillment_pickup_details.py b/src/square/types/fulfillment_pickup_details.py new file mode 100644 index 00000000..70a61559 --- /dev/null +++ b/src/square/types/fulfillment_pickup_details.py @@ -0,0 +1,148 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .fulfillment_recipient import FulfillmentRecipient +import pydantic +from .fulfillment_pickup_details_schedule_type import FulfillmentPickupDetailsScheduleType +from .fulfillment_pickup_details_curbside_pickup_details import FulfillmentPickupDetailsCurbsidePickupDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FulfillmentPickupDetails(UncheckedBaseModel): + """ + Contains details necessary to fulfill a pickup order. + """ + + recipient: typing.Optional[FulfillmentRecipient] = pydantic.Field(default=None) + """ + Information about the person to pick up this fulfillment from a physical + location. + """ + + expires_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment expires if it is not marked in progress. The timestamp must be + in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set + up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order + are automatically completed. + """ + + auto_complete_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The duration of time after which an in progress pickup fulfillment is automatically moved + to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D"). + + If not set, this pickup fulfillment remains in progress until it is canceled or completed. + """ + + schedule_type: typing.Optional[FulfillmentPickupDetailsScheduleType] = pydantic.Field(default=None) + """ + The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. + See [FulfillmentPickupDetailsScheduleType](#type-fulfillmentpickupdetailsscheduletype) for possible values + """ + + pickup_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., + "2016-09-04T23:59:33.123Z". + + For fulfillments with the schedule type `ASAP`, this is automatically set + to the current time plus the expected duration to prepare the fulfillment. + """ + + pickup_window_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The window of time in which the order should be picked up after the `pickup_at` timestamp. + Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an + informational guideline for merchants. + """ + + prep_time_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The duration of time it takes to prepare this fulfillment. + The duration must be in RFC 3339 format (for example, "P1W3D"). + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note to provide additional instructions about the pickup + fulfillment displayed in the Square Point of Sale application and set by the API. + """ + + placed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + accepted_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + rejected_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + ready_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + expired_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment expired. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + picked_up_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + canceled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + cancel_reason: typing.Optional[str] = pydantic.Field(default=None) + """ + A description of why the pickup was canceled. The maximum length: 100 characters. + """ + + is_curbside_pickup: typing.Optional[bool] = pydantic.Field(default=None) + """ + If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup. + """ + + curbside_pickup_details: typing.Optional[FulfillmentPickupDetailsCurbsidePickupDetails] = pydantic.Field( + default=None + ) + """ + Specific details for curbside pickup. These details can only be populated if `is_curbside_pickup` is set to `true`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_pickup_details_curbside_pickup_details.py b/src/square/types/fulfillment_pickup_details_curbside_pickup_details.py new file mode 100644 index 00000000..c7564c75 --- /dev/null +++ b/src/square/types/fulfillment_pickup_details_curbside_pickup_details.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FulfillmentPickupDetailsCurbsidePickupDetails(UncheckedBaseModel): + """ + Specific details for curbside pickup. + """ + + curbside_details: typing.Optional[str] = pydantic.Field(default=None) + """ + Specific details for curbside pickup, such as parking number and vehicle model. + """ + + buyer_arrived_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_pickup_details_schedule_type.py b/src/square/types/fulfillment_pickup_details_schedule_type.py new file mode 100644 index 00000000..45662f4c --- /dev/null +++ b/src/square/types/fulfillment_pickup_details_schedule_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +FulfillmentPickupDetailsScheduleType = typing.Union[typing.Literal["SCHEDULED", "ASAP"], typing.Any] diff --git a/src/square/types/fulfillment_recipient.py b/src/square/types/fulfillment_recipient.py new file mode 100644 index 00000000..024fa566 --- /dev/null +++ b/src/square/types/fulfillment_recipient.py @@ -0,0 +1,66 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FulfillmentRecipient(UncheckedBaseModel): + """ + Information about the fulfillment recipient. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the customer associated with the fulfillment. + + If `customer_id` is provided, the fulfillment recipient's `display_name`, + `email_address`, and `phone_number` are automatically populated from the + targeted customer profile. If these fields are set in the request, the request + values override the information from the customer profile. If the + targeted customer profile does not contain the necessary information and + these fields are left unset, the request results in an error. + """ + + display_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The display name of the fulfillment recipient. This field is required. + + If provided, the display name overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address of the fulfillment recipient. + + If provided, the email address overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number of the fulfillment recipient. This field is required. + + If provided, the phone number overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The address of the fulfillment recipient. This field is required. + + If provided, the address overrides the corresponding customer profile value + indicated by `customer_id`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_shipment_details.py b/src/square/types/fulfillment_shipment_details.py new file mode 100644 index 00000000..7b9abee3 --- /dev/null +++ b/src/square/types/fulfillment_shipment_details.py @@ -0,0 +1,113 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .fulfillment_recipient import FulfillmentRecipient +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class FulfillmentShipmentDetails(UncheckedBaseModel): + """ + Contains the details necessary to fulfill a shipment order. + """ + + recipient: typing.Optional[FulfillmentRecipient] = pydantic.Field(default=None) + """ + Information about the person to receive this shipment fulfillment. + """ + + carrier: typing.Optional[str] = pydantic.Field(default=None) + """ + The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS). + """ + + shipping_note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note with additional information for the shipping carrier. + """ + + shipping_type: typing.Optional[str] = pydantic.Field(default=None) + """ + A description of the type of shipping product purchased from the carrier + (such as First Class, Priority, or Express). + """ + + tracking_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The reference number provided by the carrier to track the shipment's progress. + """ + + tracking_url: typing.Optional[str] = pydantic.Field(default=None) + """ + A link to the tracking webpage on the carrier's website. + """ + + placed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the shipment was requested. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + in_progress_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation + of this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + packaged_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the + fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + expected_shipped_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the shipment is expected to be delivered to the shipping carrier. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + shipped_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that + the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + canceled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating the shipment was canceled. + The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + cancel_reason: typing.Optional[str] = pydantic.Field(default=None) + """ + A description of why the shipment was canceled. + """ + + failed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) + indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format + (for example, "2016-09-04T23:59:33.123Z"). + """ + + failure_reason: typing.Optional[str] = pydantic.Field(default=None) + """ + A description of why the shipment failed to be completed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/fulfillment_state.py b/src/square/types/fulfillment_state.py new file mode 100644 index 00000000..f6978207 --- /dev/null +++ b/src/square/types/fulfillment_state.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +FulfillmentState = typing.Union[ + typing.Literal["PROPOSED", "RESERVED", "PREPARED", "COMPLETED", "CANCELED", "FAILED"], typing.Any +] diff --git a/src/square/types/fulfillment_type.py b/src/square/types/fulfillment_type.py new file mode 100644 index 00000000..048ce597 --- /dev/null +++ b/src/square/types/fulfillment_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +FulfillmentType = typing.Union[typing.Literal["PICKUP", "SHIPMENT", "DELIVERY"], typing.Any] diff --git a/src/square/types/get_bank_account_by_v1id_response.py b/src/square/types/get_bank_account_by_v1id_response.py new file mode 100644 index 00000000..7cc96a4e --- /dev/null +++ b/src/square/types/get_bank_account_by_v1id_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .bank_account import BankAccount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetBankAccountByV1IdResponse(UncheckedBaseModel): + """ + Response object returned by GetBankAccountByV1Id. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + bank_account: typing.Optional[BankAccount] = pydantic.Field(default=None) + """ + The requested `BankAccount` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_bank_account_response.py b/src/square/types/get_bank_account_response.py new file mode 100644 index 00000000..8d99e410 --- /dev/null +++ b/src/square/types/get_bank_account_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .bank_account import BankAccount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetBankAccountResponse(UncheckedBaseModel): + """ + Response object returned by `GetBankAccount`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + bank_account: typing.Optional[BankAccount] = pydantic.Field(default=None) + """ + The requested `BankAccount` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_booking_response.py b/src/square/types/get_booking_response.py new file mode 100644 index 00000000..e17c1e1f --- /dev/null +++ b/src/square/types/get_booking_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking import Booking +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetBookingResponse(UncheckedBaseModel): + booking: typing.Optional[Booking] = pydantic.Field(default=None) + """ + The booking that was requested. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_break_type_response.py b/src/square/types/get_break_type_response.py new file mode 100644 index 00000000..a65ef24d --- /dev/null +++ b/src/square/types/get_break_type_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .break_type import BreakType +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetBreakTypeResponse(UncheckedBaseModel): + """ + The response to a request to get a `BreakType`. The response contains + the requested `BreakType` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_type: typing.Optional[BreakType] = pydantic.Field(default=None) + """ + The response object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_business_booking_profile_response.py b/src/square/types/get_business_booking_profile_response.py new file mode 100644 index 00000000..74187d92 --- /dev/null +++ b/src/square/types/get_business_booking_profile_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .business_booking_profile import BusinessBookingProfile +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetBusinessBookingProfileResponse(UncheckedBaseModel): + business_booking_profile: typing.Optional[BusinessBookingProfile] = pydantic.Field(default=None) + """ + The seller's booking profile. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_card_response.py b/src/square/types/get_card_response.py new file mode 100644 index 00000000..eaaf4d6b --- /dev/null +++ b/src/square/types/get_card_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .card import Card +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCardResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveCard](api-endpoint:Cards-RetrieveCard) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The retrieved card. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_cash_drawer_shift_response.py b/src/square/types/get_cash_drawer_shift_response.py new file mode 100644 index 00000000..183deda1 --- /dev/null +++ b/src/square/types/get_cash_drawer_shift_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .cash_drawer_shift import CashDrawerShift +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCashDrawerShiftResponse(UncheckedBaseModel): + cash_drawer_shift: typing.Optional[CashDrawerShift] = pydantic.Field(default=None) + """ + The cash drawer shift queried for. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_catalog_object_response.py b/src/square/types/get_catalog_object_response.py new file mode 100644 index 00000000..4d3885d2 --- /dev/null +++ b/src/square/types/get_catalog_object_response.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCatalogObjectResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + object: typing.Optional[CatalogObject] = pydantic.Field(default=None) + """ + The `CatalogObject`s returned. + """ + + related_objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + A list of `CatalogObject`s referenced by the object in the `object` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_customer_custom_attribute_definition_response.py b/src/square/types/get_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..5d7aed80 --- /dev/null +++ b/src/square/types/get_customer_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCustomerCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The retrieved custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_customer_custom_attribute_response.py b/src/square/types/get_customer_custom_attribute_response.py new file mode 100644 index 00000000..05695f58 --- /dev/null +++ b/src/square/types/get_customer_custom_attribute_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCustomerCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_customer_group_response.py b/src/square/types/get_customer_group_response.py new file mode 100644 index 00000000..0c5c82da --- /dev/null +++ b/src/square/types/get_customer_group_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer_group import CustomerGroup +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCustomerGroupResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveCustomerGroup](api-endpoint:CustomerGroups-RetrieveCustomerGroup) endpoint. + + Either `errors` or `group` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + group: typing.Optional[CustomerGroup] = pydantic.Field(default=None) + """ + The retrieved customer group. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_customer_response.py b/src/square/types/get_customer_response.py new file mode 100644 index 00000000..e4b40eeb --- /dev/null +++ b/src/square/types/get_customer_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer import Customer +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCustomerResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `RetrieveCustomer` endpoint. + + Either `errors` or `customer` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + customer: typing.Optional[Customer] = pydantic.Field(default=None) + """ + The requested customer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_customer_segment_response.py b/src/square/types/get_customer_segment_response.py new file mode 100644 index 00000000..66b1211c --- /dev/null +++ b/src/square/types/get_customer_segment_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer_segment import CustomerSegment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetCustomerSegmentResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body for requests to the `RetrieveCustomerSegment` endpoint. + + Either `errors` or `segment` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + segment: typing.Optional[CustomerSegment] = pydantic.Field(default=None) + """ + The retrieved customer segment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_device_code_response.py b/src/square/types/get_device_code_response.py new file mode 100644 index 00000000..ecf5bafb --- /dev/null +++ b/src/square/types/get_device_code_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .device_code import DeviceCode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetDeviceCodeResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + device_code: typing.Optional[DeviceCode] = pydantic.Field(default=None) + """ + The queried DeviceCode. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_device_response.py b/src/square/types/get_device_response.py new file mode 100644 index 00000000..5386b201 --- /dev/null +++ b/src/square/types/get_device_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .device import Device +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetDeviceResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + device: typing.Optional[Device] = pydantic.Field(default=None) + """ + The requested `Device`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_dispute_evidence_response.py b/src/square/types/get_dispute_evidence_response.py new file mode 100644 index 00000000..9d5aac44 --- /dev/null +++ b/src/square/types/get_dispute_evidence_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute_evidence import DisputeEvidence +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetDisputeEvidenceResponse(UncheckedBaseModel): + """ + Defines the fields in a `RetrieveDisputeEvidence` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + evidence: typing.Optional[DisputeEvidence] = pydantic.Field(default=None) + """ + Metadata about the dispute evidence file. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_dispute_response.py b/src/square/types/get_dispute_response.py new file mode 100644 index 00000000..a82d9a0b --- /dev/null +++ b/src/square/types/get_dispute_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute import Dispute +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetDisputeResponse(UncheckedBaseModel): + """ + Defines fields in a `RetrieveDispute` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + dispute: typing.Optional[Dispute] = pydantic.Field(default=None) + """ + Details about the requested `Dispute`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_employee_response.py b/src/square/types/get_employee_response.py new file mode 100644 index 00000000..bc8fb7b2 --- /dev/null +++ b/src/square/types/get_employee_response.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .employee import Employee +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetEmployeeResponse(UncheckedBaseModel): + employee: typing.Optional[Employee] = None + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_employee_wage_response.py b/src/square/types/get_employee_wage_response.py new file mode 100644 index 00000000..064787e0 --- /dev/null +++ b/src/square/types/get_employee_wage_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .employee_wage import EmployeeWage +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetEmployeeWageResponse(UncheckedBaseModel): + """ + A response to a request to get an `EmployeeWage`. The response contains + the requested `EmployeeWage` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + employee_wage: typing.Optional[EmployeeWage] = pydantic.Field(default=None) + """ + The requested `EmployeeWage` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_gift_card_from_gan_response.py b/src/square/types/get_gift_card_from_gan_response.py new file mode 100644 index 00000000..e7894d30 --- /dev/null +++ b/src/square/types/get_gift_card_from_gan_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetGiftCardFromGanResponse(UncheckedBaseModel): + """ + A response that contains a `GiftCard`. This response might contain a set of `Error` objects + if the request resulted in errors. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card: typing.Optional[GiftCard] = pydantic.Field(default=None) + """ + A gift card that was fetched, if present. It returns empty if an error occurred. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_gift_card_from_nonce_response.py b/src/square/types/get_gift_card_from_nonce_response.py new file mode 100644 index 00000000..cd55c226 --- /dev/null +++ b/src/square/types/get_gift_card_from_nonce_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetGiftCardFromNonceResponse(UncheckedBaseModel): + """ + A response that contains a `GiftCard` object. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card: typing.Optional[GiftCard] = pydantic.Field(default=None) + """ + The retrieved gift card. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_gift_card_response.py b/src/square/types/get_gift_card_response.py new file mode 100644 index 00000000..5c383d79 --- /dev/null +++ b/src/square/types/get_gift_card_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetGiftCardResponse(UncheckedBaseModel): + """ + A response that contains a `GiftCard`. The response might contain a set of `Error` objects + if the request resulted in errors. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card: typing.Optional[GiftCard] = pydantic.Field(default=None) + """ + The gift card retrieved. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_inventory_adjustment_response.py b/src/square/types/get_inventory_adjustment_response.py new file mode 100644 index 00000000..54d8322e --- /dev/null +++ b/src/square/types/get_inventory_adjustment_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_adjustment import InventoryAdjustment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetInventoryAdjustmentResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + adjustment: typing.Optional[InventoryAdjustment] = pydantic.Field(default=None) + """ + The requested [InventoryAdjustment](entity:InventoryAdjustment). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_inventory_changes_response.py b/src/square/types/get_inventory_changes_response.py new file mode 100644 index 00000000..a0ee68d0 --- /dev/null +++ b/src/square/types/get_inventory_changes_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_change import InventoryChange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetInventoryChangesResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + changes: typing.Optional[typing.List[InventoryChange]] = pydantic.Field(default=None) + """ + The set of inventory changes for the requested object and locations. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_inventory_count_response.py b/src/square/types/get_inventory_count_response.py new file mode 100644 index 00000000..6618be90 --- /dev/null +++ b/src/square/types/get_inventory_count_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_count import InventoryCount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetInventoryCountResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + counts: typing.Optional[typing.List[InventoryCount]] = pydantic.Field(default=None) + """ + The current calculated inventory counts for the requested object and + locations. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_inventory_physical_count_response.py b/src/square/types/get_inventory_physical_count_response.py new file mode 100644 index 00000000..4b7dbc2f --- /dev/null +++ b/src/square/types/get_inventory_physical_count_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_physical_count import InventoryPhysicalCount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetInventoryPhysicalCountResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + count: typing.Optional[InventoryPhysicalCount] = pydantic.Field(default=None) + """ + The requested [InventoryPhysicalCount](entity:InventoryPhysicalCount). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_inventory_transfer_response.py b/src/square/types/get_inventory_transfer_response.py new file mode 100644 index 00000000..baa94733 --- /dev/null +++ b/src/square/types/get_inventory_transfer_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .inventory_transfer import InventoryTransfer +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetInventoryTransferResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + transfer: typing.Optional[InventoryTransfer] = pydantic.Field(default=None) + """ + The requested [InventoryTransfer](entity:InventoryTransfer). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_invoice_response.py b/src/square/types/get_invoice_response.py new file mode 100644 index 00000000..2718de0e --- /dev/null +++ b/src/square/types/get_invoice_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetInvoiceResponse(UncheckedBaseModel): + """ + Describes a `GetInvoice` response. + """ + + invoice: typing.Optional[Invoice] = pydantic.Field(default=None) + """ + The invoice requested. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_location_response.py b/src/square/types/get_location_response.py new file mode 100644 index 00000000..777a9480 --- /dev/null +++ b/src/square/types/get_location_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .location import Location +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetLocationResponse(UncheckedBaseModel): + """ + Defines the fields that the [RetrieveLocation](api-endpoint:Locations-RetrieveLocation) + endpoint returns in a response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + location: typing.Optional[Location] = pydantic.Field(default=None) + """ + The requested location. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_loyalty_account_response.py b/src/square/types/get_loyalty_account_response.py new file mode 100644 index 00000000..8bc83fc5 --- /dev/null +++ b/src/square/types/get_loyalty_account_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_account import LoyaltyAccount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetLoyaltyAccountResponse(UncheckedBaseModel): + """ + A response that includes the loyalty account. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_account: typing.Optional[LoyaltyAccount] = pydantic.Field(default=None) + """ + The loyalty account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_loyalty_program_response.py b/src/square/types/get_loyalty_program_response.py new file mode 100644 index 00000000..22187a73 --- /dev/null +++ b/src/square/types/get_loyalty_program_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_program import LoyaltyProgram +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetLoyaltyProgramResponse(UncheckedBaseModel): + """ + A response that contains the loyalty program. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + program: typing.Optional[LoyaltyProgram] = pydantic.Field(default=None) + """ + The loyalty program that was requested. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_loyalty_promotion_response.py b/src/square/types/get_loyalty_promotion_response.py new file mode 100644 index 00000000..b24b273b --- /dev/null +++ b/src/square/types/get_loyalty_promotion_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_promotion import LoyaltyPromotion +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetLoyaltyPromotionResponse(UncheckedBaseModel): + """ + Represents a [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion) response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_promotion: typing.Optional[LoyaltyPromotion] = pydantic.Field(default=None) + """ + The retrieved loyalty promotion. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_loyalty_reward_response.py b/src/square/types/get_loyalty_reward_response.py new file mode 100644 index 00000000..3ab1bffa --- /dev/null +++ b/src/square/types/get_loyalty_reward_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_reward import LoyaltyReward +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetLoyaltyRewardResponse(UncheckedBaseModel): + """ + A response that includes the loyalty reward. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + reward: typing.Optional[LoyaltyReward] = pydantic.Field(default=None) + """ + The loyalty reward retrieved. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_merchant_response.py b/src/square/types/get_merchant_response.py new file mode 100644 index 00000000..eb46f13c --- /dev/null +++ b/src/square/types/get_merchant_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .merchant import Merchant +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetMerchantResponse(UncheckedBaseModel): + """ + The response object returned by the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + merchant: typing.Optional[Merchant] = pydantic.Field(default=None) + """ + The requested `Merchant` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_order_response.py b/src/square/types/get_order_response.py new file mode 100644 index 00000000..4da063c0 --- /dev/null +++ b/src/square/types/get_order_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetOrderResponse(UncheckedBaseModel): + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The requested order. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_payment_link_response.py b/src/square/types/get_payment_link_response.py new file mode 100644 index 00000000..08ca81dd --- /dev/null +++ b/src/square/types/get_payment_link_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment_link import PaymentLink +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetPaymentLinkResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + payment_link: typing.Optional[PaymentLink] = pydantic.Field(default=None) + """ + The payment link that is retrieved. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_payment_refund_response.py b/src/square/types/get_payment_refund_response.py new file mode 100644 index 00000000..16da4096 --- /dev/null +++ b/src/square/types/get_payment_refund_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment_refund import PaymentRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetPaymentRefundResponse(UncheckedBaseModel): + """ + Defines the response returned by [GetRefund](api-endpoint:Refunds-GetPaymentRefund). + + Note: If there are errors processing the request, the refund field might not be + present or it might be present in a FAILED state. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refund: typing.Optional[PaymentRefund] = pydantic.Field(default=None) + """ + The requested `PaymentRefund`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_payment_response.py b/src/square/types/get_payment_response.py new file mode 100644 index 00000000..44b4b70c --- /dev/null +++ b/src/square/types/get_payment_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment import Payment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetPaymentResponse(UncheckedBaseModel): + """ + Defines the response returned by [GetPayment](api-endpoint:Payments-GetPayment). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + payment: typing.Optional[Payment] = pydantic.Field(default=None) + """ + The requested `Payment`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_payout_response.py b/src/square/types/get_payout_response.py new file mode 100644 index 00000000..a02a5c09 --- /dev/null +++ b/src/square/types/get_payout_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .payout import Payout +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetPayoutResponse(UncheckedBaseModel): + payout: typing.Optional[Payout] = pydantic.Field(default=None) + """ + The requested payout. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_shift_response.py b/src/square/types/get_shift_response.py new file mode 100644 index 00000000..64af8439 --- /dev/null +++ b/src/square/types/get_shift_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .shift import Shift +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetShiftResponse(UncheckedBaseModel): + """ + A response to a request to get a `Shift`. The response contains + the requested `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shift: typing.Optional[Shift] = pydantic.Field(default=None) + """ + The requested `Shift`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_snippet_response.py b/src/square/types/get_snippet_response.py new file mode 100644 index 00000000..9f5fcd3c --- /dev/null +++ b/src/square/types/get_snippet_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .snippet import Snippet +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetSnippetResponse(UncheckedBaseModel): + """ + Represents a `RetrieveSnippet` response. The response can include either `snippet` or `errors`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + snippet: typing.Optional[Snippet] = pydantic.Field(default=None) + """ + The retrieved snippet. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_subscription_response.py b/src/square/types/get_subscription_response.py new file mode 100644 index 00000000..f75bcdc1 --- /dev/null +++ b/src/square/types/get_subscription_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetSubscriptionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The subscription retrieved. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_team_member_booking_profile_response.py b/src/square/types/get_team_member_booking_profile_response.py new file mode 100644 index 00000000..969c72aa --- /dev/null +++ b/src/square/types/get_team_member_booking_profile_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member_booking_profile import TeamMemberBookingProfile +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTeamMemberBookingProfileResponse(UncheckedBaseModel): + team_member_booking_profile: typing.Optional[TeamMemberBookingProfile] = pydantic.Field(default=None) + """ + The returned team member booking profile. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_team_member_response.py b/src/square/types/get_team_member_response.py new file mode 100644 index 00000000..e9b8609c --- /dev/null +++ b/src/square/types/get_team_member_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member import TeamMember +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTeamMemberResponse(UncheckedBaseModel): + """ + Represents a response from a retrieve request containing a `TeamMember` object or error messages. + """ + + team_member: typing.Optional[TeamMember] = pydantic.Field(default=None) + """ + The successfully retrieved `TeamMember` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_team_member_wage_response.py b/src/square/types/get_team_member_wage_response.py new file mode 100644 index 00000000..295ab058 --- /dev/null +++ b/src/square/types/get_team_member_wage_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member_wage import TeamMemberWage +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTeamMemberWageResponse(UncheckedBaseModel): + """ + A response to a request to get a `TeamMemberWage`. The response contains + the requested `TeamMemberWage` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + team_member_wage: typing.Optional[TeamMemberWage] = pydantic.Field(default=None) + """ + The requested `TeamMemberWage` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_terminal_action_response.py b/src/square/types/get_terminal_action_response.py new file mode 100644 index 00000000..d7a18e74 --- /dev/null +++ b/src/square/types/get_terminal_action_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_action import TerminalAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTerminalActionResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + action: typing.Optional[TerminalAction] = pydantic.Field(default=None) + """ + The requested `TerminalAction` + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_terminal_checkout_response.py b/src/square/types/get_terminal_checkout_response.py new file mode 100644 index 00000000..636c923d --- /dev/null +++ b/src/square/types/get_terminal_checkout_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_checkout import TerminalCheckout +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTerminalCheckoutResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + checkout: typing.Optional[TerminalCheckout] = pydantic.Field(default=None) + """ + The requested `TerminalCheckout`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_terminal_refund_response.py b/src/square/types/get_terminal_refund_response.py new file mode 100644 index 00000000..5f3d0bc7 --- /dev/null +++ b/src/square/types/get_terminal_refund_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_refund import TerminalRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTerminalRefundResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refund: typing.Optional[TerminalRefund] = pydantic.Field(default=None) + """ + The requested `Refund`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_transaction_response.py b/src/square/types/get_transaction_response.py new file mode 100644 index 00000000..88e1dd3b --- /dev/null +++ b/src/square/types/get_transaction_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .transaction import Transaction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetTransactionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint. + + One of `errors` or `transaction` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + transaction: typing.Optional[Transaction] = pydantic.Field(default=None) + """ + The requested transaction. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_vendor_response.py b/src/square/types/get_vendor_response.py new file mode 100644 index 00000000..96219b9c --- /dev/null +++ b/src/square/types/get_vendor_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .vendor import Vendor +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetVendorResponse(UncheckedBaseModel): + """ + Represents an output from a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered when the request fails. + """ + + vendor: typing.Optional[Vendor] = pydantic.Field(default=None) + """ + The successfully retrieved [Vendor](entity:Vendor) object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_wage_setting_response.py b/src/square/types/get_wage_setting_response.py new file mode 100644 index 00000000..4ad8e5bc --- /dev/null +++ b/src/square/types/get_wage_setting_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .wage_setting import WageSetting +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetWageSettingResponse(UncheckedBaseModel): + """ + Represents a response from a retrieve request containing the specified `WageSetting` object or error messages. + """ + + wage_setting: typing.Optional[WageSetting] = pydantic.Field(default=None) + """ + The successfully retrieved `WageSetting` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/get_webhook_subscription_response.py b/src/square/types/get_webhook_subscription_response.py new file mode 100644 index 00000000..c390b7e3 --- /dev/null +++ b/src/square/types/get_webhook_subscription_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .webhook_subscription import WebhookSubscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GetWebhookSubscriptionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [RetrieveWebhookSubscription](api-endpoint:WebhookSubscriptions-RetrieveWebhookSubscription) endpoint. + + Note: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + subscription: typing.Optional[WebhookSubscription] = pydantic.Field(default=None) + """ + The requested [Subscription](entity:WebhookSubscription). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card.py b/src/square/types/gift_card.py new file mode 100644 index 00000000..3d72e7b8 --- /dev/null +++ b/src/square/types/gift_card.py @@ -0,0 +1,73 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .gift_card_type import GiftCardType +from .gift_card_gan_source import GiftCardGanSource +from .gift_card_status import GiftCardStatus +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCard(UncheckedBaseModel): + """ + Represents a Square gift card. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the gift card. + """ + + type: GiftCardType = pydantic.Field() + """ + The gift card type. + See [Type](#type-type) for possible values + """ + + gan_source: typing.Optional[GiftCardGanSource] = pydantic.Field(default=None) + """ + The source that generated the gift card account number (GAN). The default value is `SQUARE`. + See [GANSource](#type-gansource) for possible values + """ + + state: typing.Optional[GiftCardStatus] = pydantic.Field(default=None) + """ + The current gift card state. + See [Status](#type-status) for possible values + """ + + balance_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The current gift card balance. This balance is always greater than or equal to zero. + """ + + gan: typing.Optional[str] = pydantic.Field(default=None) + """ + The gift card account number (GAN). Buyers can use the GAN to make purchases or check + the gift card balance. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the gift card was created, in RFC 3339 format. + In the case of a digital gift card, it is the time when you create a card + (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API). + In the case of a plastic gift card, it is the time when Square associates the card with the + seller at the time of activation. + """ + + customer_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity.py b/src/square/types/gift_card_activity.py new file mode 100644 index 00000000..38045f4a --- /dev/null +++ b/src/square/types/gift_card_activity.py @@ -0,0 +1,179 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .gift_card_activity_type import GiftCardActivityType +from .money import Money +from .gift_card_activity_load import GiftCardActivityLoad +from .gift_card_activity_activate import GiftCardActivityActivate +from .gift_card_activity_redeem import GiftCardActivityRedeem +from .gift_card_activity_clear_balance import GiftCardActivityClearBalance +from .gift_card_activity_deactivate import GiftCardActivityDeactivate +from .gift_card_activity_adjust_increment import GiftCardActivityAdjustIncrement +from .gift_card_activity_adjust_decrement import GiftCardActivityAdjustDecrement +from .gift_card_activity_refund import GiftCardActivityRefund +from .gift_card_activity_unlinked_activity_refund import GiftCardActivityUnlinkedActivityRefund +from .gift_card_activity_import import GiftCardActivityImport +from .gift_card_activity_block import GiftCardActivityBlock +from .gift_card_activity_unblock import GiftCardActivityUnblock +from .gift_card_activity_import_reversal import GiftCardActivityImportReversal +from .gift_card_activity_transfer_balance_to import GiftCardActivityTransferBalanceTo +from .gift_card_activity_transfer_balance_from import GiftCardActivityTransferBalanceFrom +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCardActivity(UncheckedBaseModel): + """ + Represents an action performed on a [gift card](entity:GiftCard) that affects its state or balance. + A gift card activity contains information about a specific activity type. For example, a `REDEEM` activity + includes a `redeem_activity_details` field that contains information about the redemption. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the gift card activity. + """ + + type: GiftCardActivityType = pydantic.Field() + """ + The type of gift card activity. + See [Type](#type-type) for possible values + """ + + location_id: str = pydantic.Field() + """ + The ID of the [business location](entity:Location) where the activity occurred. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the gift card activity was created, in RFC 3339 format. + """ + + gift_card_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The gift card ID. When creating a gift card activity, `gift_card_id` is not required if + `gift_card_gan` is specified. + """ + + gift_card_gan: typing.Optional[str] = pydantic.Field(default=None) + """ + The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` + is not required if `gift_card_id` is specified. + """ + + gift_card_balance_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The final balance on the gift card after the action is completed. + """ + + load_activity_details: typing.Optional[GiftCardActivityLoad] = pydantic.Field(default=None) + """ + Additional details about a `LOAD` activity, which is used to reload money onto a gift card. + """ + + activate_activity_details: typing.Optional[GiftCardActivityActivate] = pydantic.Field(default=None) + """ + Additional details about an `ACTIVATE` activity, which is used to activate a gift card with + an initial balance. + """ + + redeem_activity_details: typing.Optional[GiftCardActivityRedeem] = pydantic.Field(default=None) + """ + Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase. + + For applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that + updates the gift card balance after the corresponding [CreatePayment](api-endpoint:Payments-CreatePayment) + request is completed. Applications that use a custom payment processing system must call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REDEEM` activity. + """ + + clear_balance_activity_details: typing.Optional[GiftCardActivityClearBalance] = pydantic.Field(default=None) + """ + Additional details about a `CLEAR_BALANCE` activity, which is used to set the balance of a gift card to zero. + """ + + deactivate_activity_details: typing.Optional[GiftCardActivityDeactivate] = pydantic.Field(default=None) + """ + Additional details about a `DEACTIVATE` activity, which is used to deactivate a gift card. + """ + + adjust_increment_activity_details: typing.Optional[GiftCardActivityAdjustIncrement] = pydantic.Field(default=None) + """ + Additional details about an `ADJUST_INCREMENT` activity, which is used to add money to a gift card + outside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow. + """ + + adjust_decrement_activity_details: typing.Optional[GiftCardActivityAdjustDecrement] = pydantic.Field(default=None) + """ + Additional details about an `ADJUST_DECREMENT` activity, which is used to deduct money from a gift + card outside of a typical `REDEEM` activity flow. + """ + + refund_activity_details: typing.Optional[GiftCardActivityRefund] = pydantic.Field(default=None) + """ + Additional details about a `REFUND` activity, which is used to add money to a gift card when + refunding a payment. + + For applications that refund payments to a gift card using the Square Refunds API, Square automatically + creates a `REFUND` activity that updates the gift card balance after a [RefundPayment](api-endpoint:Refunds-RefundPayment) + request is completed. Applications that use a custom processing system must call + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REFUND` activity. + """ + + unlinked_activity_refund_activity_details: typing.Optional[GiftCardActivityUnlinkedActivityRefund] = pydantic.Field( + default=None + ) + """ + Additional details about an `UNLINKED_ACTIVITY_REFUND` activity. This activity is used to add money + to a gift card when refunding a payment that was processed using a custom payment processing system + and not linked to the gift card. + """ + + import_activity_details: typing.Optional[GiftCardActivityImport] = pydantic.Field(default=None) + """ + Additional details about an `IMPORT` activity, which Square uses to import a third-party + gift card with a balance. + """ + + block_activity_details: typing.Optional[GiftCardActivityBlock] = pydantic.Field(default=None) + """ + Additional details about a `BLOCK` activity, which Square uses to temporarily block a gift card. + """ + + unblock_activity_details: typing.Optional[GiftCardActivityUnblock] = pydantic.Field(default=None) + """ + Additional details about an `UNBLOCK` activity, which Square uses to unblock a gift card. + """ + + import_reversal_activity_details: typing.Optional[GiftCardActivityImportReversal] = pydantic.Field(default=None) + """ + Additional details about an `IMPORT_REVERSAL` activity, which Square uses to reverse the + import of a third-party gift card. + """ + + transfer_balance_to_activity_details: typing.Optional[GiftCardActivityTransferBalanceTo] = pydantic.Field( + default=None + ) + """ + Additional details about a `TRANSFER_BALANCE_TO` activity, which Square uses to add money to + a gift card as the result of a transfer from another gift card. + """ + + transfer_balance_from_activity_details: typing.Optional[GiftCardActivityTransferBalanceFrom] = pydantic.Field( + default=None + ) + """ + Additional details about a `TRANSFER_BALANCE_FROM` activity, which Square uses to deduct money from + a gift as the result of a transfer to another gift card. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_activate.py b/src/square/types/gift_card_activity_activate.py new file mode 100644 index 00000000..d147daf0 --- /dev/null +++ b/src/square/types/gift_card_activity_activate.py @@ -0,0 +1,69 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .money import Money +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCardActivityActivate(UncheckedBaseModel): + """ + Represents details about an `ACTIVATE` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount added to the gift card. This value is a positive integer. + + Applications that use a custom order processing system must specify this amount in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item. + + Applications that use the Square Orders API to process orders must specify the order ID + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + line_item_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase. + + Applications that use the Square Orders API to process orders must specify the line item UID + in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-specified ID that associates the gift card activity with an entity in another system. + + Applications that use a custom order processing system can use this field to track information + related to an order or payment. + """ + + buyer_payment_instrument_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The payment instrument IDs used to process the gift card purchase, such as a credit card ID + or bank account ID. + + Applications that use a custom order processing system must specify payment instrument IDs in + the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + Square uses this information to perform compliance checks. + + For applications that use the Square Orders API to process payments, Square has the necessary + instrument IDs to perform compliance checks. + + Each buyer payment instrument ID can contain a maximum of 255 characters. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_adjust_decrement.py b/src/square/types/gift_card_activity_adjust_decrement.py new file mode 100644 index 00000000..340baee2 --- /dev/null +++ b/src/square/types/gift_card_activity_adjust_decrement.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +from .gift_card_activity_adjust_decrement_reason import GiftCardActivityAdjustDecrementReason +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityAdjustDecrement(UncheckedBaseModel): + """ + Represents details about an `ADJUST_DECREMENT` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: Money = pydantic.Field() + """ + The amount deducted from the gift card balance. This value is a positive integer. + """ + + reason: GiftCardActivityAdjustDecrementReason = pydantic.Field() + """ + The reason the gift card balance was adjusted. + See [Reason](#type-reason) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_adjust_decrement_reason.py b/src/square/types/gift_card_activity_adjust_decrement_reason.py new file mode 100644 index 00000000..e949c560 --- /dev/null +++ b/src/square/types/gift_card_activity_adjust_decrement_reason.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityAdjustDecrementReason = typing.Union[ + typing.Literal["SUSPICIOUS_ACTIVITY", "BALANCE_ACCIDENTALLY_INCREASED", "SUPPORT_ISSUE", "PURCHASE_WAS_REFUNDED"], + typing.Any, +] diff --git a/src/square/types/gift_card_activity_adjust_increment.py b/src/square/types/gift_card_activity_adjust_increment.py new file mode 100644 index 00000000..e24b7ecd --- /dev/null +++ b/src/square/types/gift_card_activity_adjust_increment.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +from .gift_card_activity_adjust_increment_reason import GiftCardActivityAdjustIncrementReason +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityAdjustIncrement(UncheckedBaseModel): + """ + Represents details about an `ADJUST_INCREMENT` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: Money = pydantic.Field() + """ + The amount added to the gift card balance. This value is a positive integer. + """ + + reason: GiftCardActivityAdjustIncrementReason = pydantic.Field() + """ + The reason the gift card balance was adjusted. + See [Reason](#type-reason) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_adjust_increment_reason.py b/src/square/types/gift_card_activity_adjust_increment_reason.py new file mode 100644 index 00000000..b7b0a9e1 --- /dev/null +++ b/src/square/types/gift_card_activity_adjust_increment_reason.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityAdjustIncrementReason = typing.Union[ + typing.Literal["COMPLIMENTARY", "SUPPORT_ISSUE", "TRANSACTION_VOIDED"], typing.Any +] diff --git a/src/square/types/gift_card_activity_block.py b/src/square/types/gift_card_activity_block.py new file mode 100644 index 00000000..6e737f9a --- /dev/null +++ b/src/square/types/gift_card_activity_block.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .gift_card_activity_block_reason import GiftCardActivityBlockReason +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityBlock(UncheckedBaseModel): + """ + Represents details about a `BLOCK` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityBlockReason = pydantic.Field(default="CHARGEBACK_BLOCK") + """ + The reason the gift card was blocked. + See [Reason](#type-reason) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_block_reason.py b/src/square/types/gift_card_activity_block_reason.py new file mode 100644 index 00000000..07867b8b --- /dev/null +++ b/src/square/types/gift_card_activity_block_reason.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityBlockReason = typing.Literal["CHARGEBACK_BLOCK"] diff --git a/src/square/types/gift_card_activity_clear_balance.py b/src/square/types/gift_card_activity_clear_balance.py new file mode 100644 index 00000000..a833872e --- /dev/null +++ b/src/square/types/gift_card_activity_clear_balance.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .gift_card_activity_clear_balance_reason import GiftCardActivityClearBalanceReason +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityClearBalance(UncheckedBaseModel): + """ + Represents details about a `CLEAR_BALANCE` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityClearBalanceReason = pydantic.Field() + """ + The reason the gift card balance was cleared. + See [Reason](#type-reason) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_clear_balance_reason.py b/src/square/types/gift_card_activity_clear_balance_reason.py new file mode 100644 index 00000000..a0af17c2 --- /dev/null +++ b/src/square/types/gift_card_activity_clear_balance_reason.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityClearBalanceReason = typing.Union[ + typing.Literal["SUSPICIOUS_ACTIVITY", "REUSE_GIFTCARD", "UNKNOWN_REASON"], typing.Any +] diff --git a/src/square/types/gift_card_activity_deactivate.py b/src/square/types/gift_card_activity_deactivate.py new file mode 100644 index 00000000..230aed4c --- /dev/null +++ b/src/square/types/gift_card_activity_deactivate.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .gift_card_activity_deactivate_reason import GiftCardActivityDeactivateReason +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityDeactivate(UncheckedBaseModel): + """ + Represents details about a `DEACTIVATE` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityDeactivateReason = pydantic.Field() + """ + The reason the gift card was deactivated. + See [Reason](#type-reason) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_deactivate_reason.py b/src/square/types/gift_card_activity_deactivate_reason.py new file mode 100644 index 00000000..5c66dbd0 --- /dev/null +++ b/src/square/types/gift_card_activity_deactivate_reason.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityDeactivateReason = typing.Union[ + typing.Literal["SUSPICIOUS_ACTIVITY", "UNKNOWN_REASON", "CHARGEBACK_DEACTIVATE"], typing.Any +] diff --git a/src/square/types/gift_card_activity_import.py b/src/square/types/gift_card_activity_import.py new file mode 100644 index 00000000..9b543d4e --- /dev/null +++ b/src/square/types/gift_card_activity_import.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityImport(UncheckedBaseModel): + """ + Represents details about an `IMPORT` [gift card activity type](entity:GiftCardActivityType). + This activity type is used when Square imports a third-party gift card, in which case the + `gan_source` of the gift card is set to `OTHER`. + """ + + amount_money: Money = pydantic.Field() + """ + The balance amount on the imported gift card. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_import_reversal.py b/src/square/types/gift_card_activity_import_reversal.py new file mode 100644 index 00000000..ed8311f7 --- /dev/null +++ b/src/square/types/gift_card_activity_import_reversal.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityImportReversal(UncheckedBaseModel): + """ + Represents details about an `IMPORT_REVERSAL` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money cleared from the third-party gift card when + the import was reversed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_load.py b/src/square/types/gift_card_activity_load.py new file mode 100644 index 00000000..e6411661 --- /dev/null +++ b/src/square/types/gift_card_activity_load.py @@ -0,0 +1,69 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .money import Money +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCardActivityLoad(UncheckedBaseModel): + """ + Represents details about a `LOAD` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount added to the gift card. This value is a positive integer. + + Applications that use a custom order processing system must specify this amount in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item. + + Applications that use the Square Orders API to process orders must specify the order ID in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + line_item_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card. + + Applications that use the Square Orders API to process orders must specify the line item UID + in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-specified ID that associates the gift card activity with an entity in another system. + + Applications that use a custom order processing system can use this field to track information related to + an order or payment. + """ + + buyer_payment_instrument_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The payment instrument IDs used to process the order for the additional funds, such as a credit card ID + or bank account ID. + + Applications that use a custom order processing system must specify payment instrument IDs in + the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + Square uses this information to perform compliance checks. + + For applications that use the Square Orders API to process payments, Square has the necessary + instrument IDs to perform compliance checks. + + Each buyer payment instrument ID can contain a maximum of 255 characters. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_redeem.py b/src/square/types/gift_card_activity_redeem.py new file mode 100644 index 00000000..b73653f6 --- /dev/null +++ b/src/square/types/gift_card_activity_redeem.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +import typing +from .gift_card_activity_redeem_status import GiftCardActivityRedeemStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCardActivityRedeem(UncheckedBaseModel): + """ + Represents details about a `REDEEM` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: Money = pydantic.Field() + """ + The amount deducted from the gift card for the redemption. This value is a positive integer. + + Applications that use a custom payment processing system must specify this amount in the + [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment that represents the gift card redemption. Square populates this field + if the payment was processed by Square. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-specified ID that associates the gift card activity with an entity in another system. + + Applications that use a custom payment processing system can use this field to track information + related to an order or payment. + """ + + status: typing.Optional[GiftCardActivityRedeemStatus] = pydantic.Field(default=None) + """ + The status of the gift card redemption. Gift cards redeemed from Square Point of Sale or the + Square Seller Dashboard use a two-state process: `PENDING` + to `COMPLETED` or `PENDING` to `CANCELED`. Gift cards redeemed using the Gift Card Activities API + always have a `COMPLETED` status. + See [Status](#type-status) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_redeem_status.py b/src/square/types/gift_card_activity_redeem_status.py new file mode 100644 index 00000000..32d7cb69 --- /dev/null +++ b/src/square/types/gift_card_activity_redeem_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityRedeemStatus = typing.Union[typing.Literal["PENDING", "COMPLETED", "CANCELED"], typing.Any] diff --git a/src/square/types/gift_card_activity_refund.py b/src/square/types/gift_card_activity_refund.py new file mode 100644 index 00000000..c7a30d54 --- /dev/null +++ b/src/square/types/gift_card_activity_refund.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCardActivityRefund(UncheckedBaseModel): + """ + Represents details about a `REFUND` [gift card activity type](entity:GiftCardActivityType). + """ + + redeem_activity_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the refunded `REDEEM` gift card activity. Square populates this field if the + `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request + represents a gift card redemption. + + For applications that use a custom payment processing system, this field is required when creating + a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount added to the gift card for the refund. This value is a positive integer. + + This field is required when creating a `REFUND` activity. The amount can represent a full or partial refund. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-specified ID that associates the gift card activity with an entity in another system. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the refunded payment. Square populates this field if the refund is for a + payment processed by Square. This field matches the `payment_id` in the corresponding + [RefundPayment](api-endpoint:Refunds-RefundPayment) request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_transfer_balance_from.py b/src/square/types/gift_card_activity_transfer_balance_from.py new file mode 100644 index 00000000..2afe4379 --- /dev/null +++ b/src/square/types/gift_card_activity_transfer_balance_from.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityTransferBalanceFrom(UncheckedBaseModel): + """ + Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](entity:GiftCardActivityType). + """ + + transfer_to_gift_card_id: str = pydantic.Field() + """ + The ID of the gift card to which the specified amount was transferred. + """ + + amount_money: Money = pydantic.Field() + """ + The amount deducted from the gift card for the transfer. This value is a positive integer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_transfer_balance_to.py b/src/square/types/gift_card_activity_transfer_balance_to.py new file mode 100644 index 00000000..63b061a5 --- /dev/null +++ b/src/square/types/gift_card_activity_transfer_balance_to.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityTransferBalanceTo(UncheckedBaseModel): + """ + Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](entity:GiftCardActivityType). + """ + + transfer_from_gift_card_id: str = pydantic.Field() + """ + The ID of the gift card from which the specified amount was transferred. + """ + + amount_money: Money = pydantic.Field() + """ + The amount added to the gift card balance for the transfer. This value is a positive integer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_type.py b/src/square/types/gift_card_activity_type.py new file mode 100644 index 00000000..0885d6f5 --- /dev/null +++ b/src/square/types/gift_card_activity_type.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityType = typing.Union[ + typing.Literal[ + "ACTIVATE", + "LOAD", + "REDEEM", + "CLEAR_BALANCE", + "DEACTIVATE", + "ADJUST_INCREMENT", + "ADJUST_DECREMENT", + "REFUND", + "UNLINKED_ACTIVITY_REFUND", + "IMPORT", + "BLOCK", + "UNBLOCK", + "IMPORT_REVERSAL", + "TRANSFER_BALANCE_FROM", + "TRANSFER_BALANCE_TO", + ], + typing.Any, +] diff --git a/src/square/types/gift_card_activity_unblock.py b/src/square/types/gift_card_activity_unblock.py new file mode 100644 index 00000000..84c0ed0a --- /dev/null +++ b/src/square/types/gift_card_activity_unblock.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .gift_card_activity_unblock_reason import GiftCardActivityUnblockReason +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class GiftCardActivityUnblock(UncheckedBaseModel): + """ + Represents details about an `UNBLOCK` [gift card activity type](entity:GiftCardActivityType). + """ + + reason: GiftCardActivityUnblockReason = pydantic.Field(default="CHARGEBACK_UNBLOCK") + """ + The reason the gift card was unblocked. + See [Reason](#type-reason) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_activity_unblock_reason.py b/src/square/types/gift_card_activity_unblock_reason.py new file mode 100644 index 00000000..ed2a5ee2 --- /dev/null +++ b/src/square/types/gift_card_activity_unblock_reason.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardActivityUnblockReason = typing.Literal["CHARGEBACK_UNBLOCK"] diff --git a/src/square/types/gift_card_activity_unlinked_activity_refund.py b/src/square/types/gift_card_activity_unlinked_activity_refund.py new file mode 100644 index 00000000..c7a6c5fa --- /dev/null +++ b/src/square/types/gift_card_activity_unlinked_activity_refund.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class GiftCardActivityUnlinkedActivityRefund(UncheckedBaseModel): + """ + Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](entity:GiftCardActivityType). + """ + + amount_money: Money = pydantic.Field() + """ + The amount added to the gift card for the refund. This value is a positive integer. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-specified ID that associates the gift card activity with an entity in another system. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the refunded payment. This field is not used starting in Square version 2022-06-16. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/gift_card_gan_source.py b/src/square/types/gift_card_gan_source.py new file mode 100644 index 00000000..3827bb92 --- /dev/null +++ b/src/square/types/gift_card_gan_source.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardGanSource = typing.Union[typing.Literal["SQUARE", "OTHER"], typing.Any] diff --git a/src/square/types/gift_card_status.py b/src/square/types/gift_card_status.py new file mode 100644 index 00000000..1c6ec066 --- /dev/null +++ b/src/square/types/gift_card_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardStatus = typing.Union[typing.Literal["ACTIVE", "DEACTIVATED", "BLOCKED", "PENDING"], typing.Any] diff --git a/src/square/types/gift_card_type.py b/src/square/types/gift_card_type.py new file mode 100644 index 00000000..af61ea9c --- /dev/null +++ b/src/square/types/gift_card_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GiftCardType = typing.Union[typing.Literal["PHYSICAL", "DIGITAL"], typing.Any] diff --git a/src/square/types/inventory_adjustment.py b/src/square/types/inventory_adjustment.py new file mode 100644 index 00000000..5ae6f905 --- /dev/null +++ b/src/square/types/inventory_adjustment.py @@ -0,0 +1,150 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_state import InventoryState +from .money import Money +from .source_application import SourceApplication +from .inventory_adjustment_group import InventoryAdjustmentGroup +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InventoryAdjustment(UncheckedBaseModel): + """ + Represents a change in state or quantity of product inventory at a + particular time and location. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID generated by Square for the + `InventoryAdjustment`. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID provided by the application to tie the + `InventoryAdjustment` to an external + system. + """ + + from_state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + The [inventory state](entity:InventoryState) of the related quantity + of items before the adjustment. + See [InventoryState](#type-inventorystate) for possible values + """ + + to_state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + The [inventory state](entity:InventoryState) of the related quantity + of items after the adjustment. + See [InventoryState](#type-inventorystate) for possible values + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items is being tracked. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + The number of items affected by the adjustment as a decimal string. + Can support up to 5 digits after the decimal point. + """ + + total_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total price paid for goods associated with the + adjustment. Present if and only if `to_state` is `SOLD`. Always + non-negative. + """ + + occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-generated RFC 3339-formatted timestamp that indicates when + the inventory adjustment took place. For inventory adjustment updates, the `occurred_at` + timestamp cannot be older than 24 hours or in the future relative to the + time of the request. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received. + """ + + source: typing.Optional[SourceApplication] = pydantic.Field(default=None) + """ + Information about the application that caused the + inventory adjustment. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Employee](entity:Employee) responsible for the + inventory adjustment. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the + inventory adjustment. + """ + + transaction_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Transaction](entity:Transaction) that + caused the adjustment. Only relevant for payment-related state + transitions. + """ + + refund_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Refund](entity:Refund) that + caused the adjustment. Only relevant for refund-related state + transitions. + """ + + purchase_order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the purchase order that caused the + adjustment. Only relevant for state transitions from the Square for Retail + app. + """ + + goods_receipt_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the goods receipt that caused the + adjustment. Only relevant for state transitions from the Square for Retail + app. + """ + + adjustment_group: typing.Optional[InventoryAdjustmentGroup] = pydantic.Field(default=None) + """ + An adjustment group bundling the related adjustments of item variations through stock conversions in a single inventory event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/inventory_adjustment_group.py b/src/square/types/inventory_adjustment_group.py new file mode 100644 index 00000000..802d1e99 --- /dev/null +++ b/src/square/types/inventory_adjustment_group.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_state import InventoryState +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InventoryAdjustmentGroup(UncheckedBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID generated by Square for the + `InventoryAdjustmentGroup`. + """ + + root_adjustment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The inventory adjustment of the composed variation. + """ + + from_state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + Representative `from_state` for adjustments within the group. For example, for a group adjustment from `IN_STOCK` to `SOLD`, + there can be two component adjustments in the group: one from `IN_STOCK`to `COMPOSED` and the other one from `COMPOSED` to `SOLD`. + Here, the representative `from_state` for the `InventoryAdjustmentGroup` is `IN_STOCK`. + See [InventoryState](#type-inventorystate) for possible values + """ + + to_state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + Representative `to_state` for adjustments within group. For example, for a group adjustment from `IN_STOCK` to `SOLD`, + the two component adjustments in the group can be from `IN_STOCK` to `COMPOSED` and from `COMPOSED` to `SOLD`. + Here, the representative `to_state` of the `InventoryAdjustmentGroup` is `SOLD`. + See [InventoryState](#type-inventorystate) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/inventory_alert_type.py b/src/square/types/inventory_alert_type.py new file mode 100644 index 00000000..f0af0e89 --- /dev/null +++ b/src/square/types/inventory_alert_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InventoryAlertType = typing.Union[typing.Literal["NONE", "LOW_QUANTITY"], typing.Any] diff --git a/src/square/types/inventory_change.py b/src/square/types/inventory_change.py new file mode 100644 index 00000000..4094263b --- /dev/null +++ b/src/square/types/inventory_change.py @@ -0,0 +1,66 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .inventory_change_type import InventoryChangeType +import pydantic +from .inventory_physical_count import InventoryPhysicalCount +from .inventory_adjustment import InventoryAdjustment +from .inventory_transfer import InventoryTransfer +from .catalog_measurement_unit import CatalogMeasurementUnit +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InventoryChange(UncheckedBaseModel): + """ + Represents a single physical count, inventory, adjustment, or transfer + that is part of the history of inventory changes for a particular + [CatalogObject](entity:CatalogObject) instance. + """ + + type: typing.Optional[InventoryChangeType] = pydantic.Field(default=None) + """ + Indicates how the inventory change is applied. See + [InventoryChangeType](entity:InventoryChangeType) for all possible values. + See [InventoryChangeType](#type-inventorychangetype) for possible values + """ + + physical_count: typing.Optional[InventoryPhysicalCount] = pydantic.Field(default=None) + """ + Contains details about the physical count when `type` is + `PHYSICAL_COUNT`, and is unset for all other change types. + """ + + adjustment: typing.Optional[InventoryAdjustment] = pydantic.Field(default=None) + """ + Contains details about the inventory adjustment when `type` is + `ADJUSTMENT`, and is unset for all other change types. + """ + + transfer: typing.Optional[InventoryTransfer] = pydantic.Field(default=None) + """ + Contains details about the inventory transfer when `type` is + `TRANSFER`, and is unset for all other change types. + + _Note:_ An [InventoryTransfer](entity:InventoryTransfer) object can only be set in the input to the + [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) endpoint when the seller has an active Retail Plus subscription. + """ + + measurement_unit: typing.Optional[CatalogMeasurementUnit] = pydantic.Field(default=None) + """ + The [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. + """ + + measurement_unit_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/inventory_change_type.py b/src/square/types/inventory_change_type.py new file mode 100644 index 00000000..7b790112 --- /dev/null +++ b/src/square/types/inventory_change_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InventoryChangeType = typing.Union[typing.Literal["PHYSICAL_COUNT", "ADJUSTMENT", "TRANSFER"], typing.Any] diff --git a/src/square/types/inventory_count.py b/src/square/types/inventory_count.py new file mode 100644 index 00000000..64787e4f --- /dev/null +++ b/src/square/types/inventory_count.py @@ -0,0 +1,72 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_state import InventoryState +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InventoryCount(UncheckedBaseModel): + """ + Represents Square-estimated quantity of items in a particular state at a + particular seller location based on the known history of physical counts and + inventory adjustments. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + The current [inventory state](entity:InventoryState) for the related + quantity of items. + See [InventoryState](#type-inventorystate) for possible values + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items is being tracked. + """ + + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + The number of items affected by the estimated count as a decimal string. + Can support up to 5 digits after the decimal point. + """ + + calculated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting + the estimated count is received. + """ + + is_estimated: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of + any of these endpoints: [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory), + [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges), + [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts), and + [RetrieveInventoryChanges](api-endpoint:Inventory-RetrieveInventoryChanges). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/inventory_physical_count.py b/src/square/types/inventory_physical_count.py new file mode 100644 index 00000000..652e6032 --- /dev/null +++ b/src/square/types/inventory_physical_count.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_state import InventoryState +from .source_application import SourceApplication +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InventoryPhysicalCount(UncheckedBaseModel): + """ + Represents the quantity of an item variation that is physically present + at a specific location, verified by a seller or a seller's employee. For example, + a physical count might come from an employee counting the item variations on + hand or from syncing with an external system. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique Square-generated ID for the + [InventoryPhysicalCount](entity:InventoryPhysicalCount). + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID provided by the application to tie the + [InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external + system. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + The current [inventory state](entity:InventoryState) for the related + quantity of items. + See [InventoryState](#type-inventorystate) for possible values + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items is being tracked. + """ + + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + The number of items affected by the physical count as a decimal string. + The number can support up to 5 digits after the decimal point. + """ + + source: typing.Optional[SourceApplication] = pydantic.Field(default=None) + """ + Information about the application with which the + physical count is submitted. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Employee](entity:Employee) responsible for the + physical count. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the + physical count. + """ + + occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-generated RFC 3339-formatted timestamp that indicates when + the physical count was examined. For physical count updates, the `occurred_at` + timestamp cannot be older than 24 hours or in the future relative to the + time of the request. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339-formatted timestamp that indicates when the physical count is received. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/inventory_state.py b/src/square/types/inventory_state.py new file mode 100644 index 00000000..d69f8785 --- /dev/null +++ b/src/square/types/inventory_state.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InventoryState = typing.Union[ + typing.Literal[ + "CUSTOM", + "IN_STOCK", + "SOLD", + "RETURNED_BY_CUSTOMER", + "RESERVED_FOR_SALE", + "SOLD_ONLINE", + "ORDERED_FROM_VENDOR", + "RECEIVED_FROM_VENDOR", + "IN_TRANSIT_TO", + "NONE", + "WASTE", + "UNLINKED_RETURN", + "COMPOSED", + "DECOMPOSED", + "SUPPORTED_BY_NEWER_VERSION", + "IN_TRANSIT", + ], + typing.Any, +] diff --git a/src/square/types/inventory_transfer.py b/src/square/types/inventory_transfer.py new file mode 100644 index 00000000..a3940e59 --- /dev/null +++ b/src/square/types/inventory_transfer.py @@ -0,0 +1,107 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .inventory_state import InventoryState +from .source_application import SourceApplication +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InventoryTransfer(UncheckedBaseModel): + """ + Represents the transfer of a quantity of product inventory at a + particular time from one location to another. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID generated by Square for the + `InventoryTransfer`. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID provided by the application to tie the + `InventoryTransfer` to an external system. + """ + + state: typing.Optional[InventoryState] = pydantic.Field(default=None) + """ + The [inventory state](entity:InventoryState) for the quantity of + items being transferred. + See [InventoryState](#type-inventorystate) for possible values + """ + + from_location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items was tracked before the transfer. + """ + + to_location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Location](entity:Location) where the related + quantity of items was tracked after the transfer. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the + [CatalogObject](entity:CatalogObject) being tracked. + """ + + catalog_object_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. + + The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. + In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app. + """ + + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + The number of items affected by the transfer as a decimal string. + Can support up to 5 digits after the decimal point. + """ + + occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-generated RFC 3339-formatted timestamp that indicates when + the transfer took place. For write actions, the `occurred_at` timestamp + cannot be older than 24 hours or in the future relative to the time of the + request. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339-formatted timestamp that indicates when Square + received the transfer request. + """ + + source: typing.Optional[SourceApplication] = pydantic.Field(default=None) + """ + Information about the application that initiated the + inventory transfer. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Employee](entity:Employee) responsible for the + inventory transfer. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the + inventory transfer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice.py b/src/square/types/invoice.py new file mode 100644 index 00000000..63c27a58 --- /dev/null +++ b/src/square/types/invoice.py @@ -0,0 +1,225 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .invoice_recipient import InvoiceRecipient +from .invoice_payment_request import InvoicePaymentRequest +from .invoice_delivery_method import InvoiceDeliveryMethod +from .money import Money +from .invoice_status import InvoiceStatus +from .invoice_accepted_payment_methods import InvoiceAcceptedPaymentMethods +from .invoice_custom_field import InvoiceCustomField +from .invoice_attachment import InvoiceAttachment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Invoice(UncheckedBaseModel): + """ + Stores information about an invoice. You use the Invoices API to create and manage + invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the invoice. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The Square-assigned version number, which is incremented each time an update is committed to the invoice. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location that this invoice is associated with. + + If specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [order](entity:Order) for which the invoice is created. + This field is required when creating an invoice, and the order must be in the `OPEN` state. + + To view the line items and other information for the associated order, call the + [RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID. + """ + + primary_recipient: typing.Optional[InvoiceRecipient] = pydantic.Field(default=None) + """ + The customer who receives the invoice. This customer data is displayed on the invoice and used by Square to deliver the invoice. + + This field is required to publish an invoice, and it must specify the `customer_id`. + """ + + payment_requests: typing.Optional[typing.List[InvoicePaymentRequest]] = pydantic.Field(default=None) + """ + The payment schedule for the invoice, represented by one or more payment requests that + define payment settings, such as amount due and due date. An invoice supports the following payment request combinations: + - One balance + - One deposit with one balance + - 2–12 installments + - One deposit with 2–12 installments + + This field is required when creating an invoice. It must contain at least one payment request. + All payment requests for the invoice must equal the total order amount. For more information, see + [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + + Adding `INSTALLMENT` payment requests to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + """ + + delivery_method: typing.Optional[InvoiceDeliveryMethod] = pydantic.Field(default=None) + """ + The delivery method that Square uses to send the invoice, reminders, and receipts to + the customer. After the invoice is published, Square processes the invoice based on the delivery + method and payment request settings, either immediately or on the `scheduled_at` date, if specified. + For example, Square might send the invoice or receipt for an automatic payment. For invoices with + automatic payments, this field must be set to `EMAIL`. + + One of the following is required when creating an invoice: + - (Recommended) This `delivery_method` field. To configure an automatic payment, the + `automatic_payment_source` field of the payment request is also required. + - The deprecated `request_method` field of the payment request. Note that `invoice` + objects returned in responses do not include `request_method`. + See [InvoiceDeliveryMethod](#type-invoicedeliverymethod) for possible values + """ + + invoice_number: typing.Optional[str] = pydantic.Field(default=None) + """ + A user-friendly invoice number that is displayed on the invoice. The value is unique within a location. + If not provided when creating an invoice, Square assigns a value. + It increments from 1 and is padded with zeros making it 7 characters long + (for example, 0000001 and 0000002). + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The title of the invoice, which is displayed on the invoice. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the invoice, which is displayed on the invoice. + """ + + scheduled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the invoice is scheduled for processing, in RFC 3339 format. + After the invoice is published, Square processes the invoice on the specified date, + according to the delivery method and payment request settings. + + If the field is not set, Square processes the invoice immediately after it is published. + """ + + public_url: typing.Optional[str] = pydantic.Field(default=None) + """ + A temporary link to the Square-hosted payment page where the customer can pay the + invoice. If the link expires, customers can provide the email address or phone number + associated with the invoice and request a new link directly from the expired payment page. + + This field is added after the invoice is published and reaches the scheduled date + (if one is defined). + """ + + next_payment_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The current amount due for the invoice. In addition to the + amount due on the next payment request, this includes any overdue payment amounts. + """ + + status: typing.Optional[InvoiceStatus] = pydantic.Field(default=None) + """ + The status of the invoice. + See [InvoiceStatus](#type-invoicestatus) for possible values + """ + + timezone: typing.Optional[str] = pydantic.Field(default=None) + """ + The time zone used to interpret calendar dates on the invoice, such as `due_date`. + When an invoice is created, this field is set to the `timezone` specified for the seller + location. The value cannot be changed. + + For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\_Angeles + becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC timestamp + of 2021-03-10T08:00:00Z). + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the invoice was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the invoice was last updated, in RFC 3339 format. + """ + + accepted_payment_methods: typing.Optional[InvoiceAcceptedPaymentMethods] = pydantic.Field(default=None) + """ + The payment methods that customers can use to pay the invoice on the Square-hosted + invoice page. This setting is independent of any automatic payment requests for the invoice. + + This field is required when creating an invoice and must set at least one payment method to `true`. + """ + + custom_fields: typing.Optional[typing.List[InvoiceCustomField]] = pydantic.Field(default=None) + """ + Additional seller-defined fields that are displayed on the invoice. For more information, see + [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). + + Adding custom fields to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + + Max: 2 custom fields + """ + + subscription_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [subscription](entity:Subscription) associated with the invoice. + This field is present only on subscription billing invoices. + """ + + sale_or_service_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format. + This field can be used to specify a past or future date which is displayed on the invoice. + """ + + payment_conditions: typing.Optional[str] = pydantic.Field(default=None) + """ + **France only.** The payment terms and conditions that are displayed on the invoice. For more information, + see [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions). + + For countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and + "Payment conditions are not supported for this location's country" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests. + """ + + store_payment_method_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a + bank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the + invoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`. + """ + + attachments: typing.Optional[typing.List[InvoiceAttachment]] = pydantic.Field(default=None) + """ + Metadata about the attachments on the invoice. Invoice attachments are managed using the + [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints. + """ + + creator_team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [team member](entity:TeamMember) who created the invoice. + This field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_accepted_payment_methods.py b/src/square/types/invoice_accepted_payment_methods.py new file mode 100644 index 00000000..70f802cc --- /dev/null +++ b/src/square/types/invoice_accepted_payment_methods.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceAcceptedPaymentMethods(UncheckedBaseModel): + """ + The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page. + """ + + card: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether credit card or debit card payments are accepted. The default value is `false`. + """ + + square_gift_card: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether Square gift card payments are accepted. The default value is `false`. + """ + + bank_account: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether ACH bank transfer payments are accepted. The default value is `false`. + """ + + buy_now_pay_later: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`. + + This option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is + supported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay + invoice payments are supported. As a best practice, consider enabling an additional payment method when allowing + `buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see + [Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later). + """ + + cash_app_pay: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether Cash App payments are accepted. The default value is `false`. + + This payment method is supported only for seller [locations](entity:Location) in the United States. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_attachment.py b/src/square/types/invoice_attachment.py new file mode 100644 index 00000000..4c713cdc --- /dev/null +++ b/src/square/types/invoice_attachment.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceAttachment(UncheckedBaseModel): + """ + Represents a file attached to an [invoice](entity:Invoice). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the attachment. + """ + + filename: typing.Optional[str] = pydantic.Field(default=None) + """ + The file name of the attachment, which is displayed on the invoice. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the attachment, which is displayed on the invoice. + This field maps to the seller-defined **Message** field. + """ + + filesize: typing.Optional[int] = pydantic.Field(default=None) + """ + The file size of the attachment in bytes. + """ + + hash: typing.Optional[str] = pydantic.Field(default=None) + """ + The MD5 hash that was generated from the file contents. + """ + + mime_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The mime type of the attachment. + The following mime types are supported: + image/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf. + """ + + uploaded_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the attachment was uploaded, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_automatic_payment_source.py b/src/square/types/invoice_automatic_payment_source.py new file mode 100644 index 00000000..6c09446a --- /dev/null +++ b/src/square/types/invoice_automatic_payment_source.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceAutomaticPaymentSource = typing.Union[typing.Literal["NONE", "CARD_ON_FILE", "BANK_ON_FILE"], typing.Any] diff --git a/src/square/types/invoice_custom_field.py b/src/square/types/invoice_custom_field.py new file mode 100644 index 00000000..bd6c7f1f --- /dev/null +++ b/src/square/types/invoice_custom_field.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .invoice_custom_field_placement import InvoiceCustomFieldPlacement +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceCustomField(UncheckedBaseModel): + """ + An additional seller-defined and customer-facing field to include on the invoice. For more information, + see [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). + + Adding custom fields to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + """ + + label: typing.Optional[str] = pydantic.Field(default=None) + """ + The label or title of the custom field. This field is required for a custom field. + """ + + value: typing.Optional[str] = pydantic.Field(default=None) + """ + The text of the custom field. If omitted, only the label is rendered. + """ + + placement: typing.Optional[InvoiceCustomFieldPlacement] = pydantic.Field(default=None) + """ + The location of the custom field on the invoice. This field is required for a custom field. + See [InvoiceCustomFieldPlacement](#type-invoicecustomfieldplacement) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_custom_field_placement.py b/src/square/types/invoice_custom_field_placement.py new file mode 100644 index 00000000..d676f479 --- /dev/null +++ b/src/square/types/invoice_custom_field_placement.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceCustomFieldPlacement = typing.Union[typing.Literal["ABOVE_LINE_ITEMS", "BELOW_LINE_ITEMS"], typing.Any] diff --git a/src/square/types/invoice_delivery_method.py b/src/square/types/invoice_delivery_method.py new file mode 100644 index 00000000..e47f6b6f --- /dev/null +++ b/src/square/types/invoice_delivery_method.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceDeliveryMethod = typing.Union[typing.Literal["EMAIL", "SHARE_MANUALLY", "SMS"], typing.Any] diff --git a/src/square/types/invoice_filter.py b/src/square/types/invoice_filter.py new file mode 100644 index 00000000..2af926a7 --- /dev/null +++ b/src/square/types/invoice_filter.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceFilter(UncheckedBaseModel): + """ + Describes query filters to apply. + """ + + location_ids: typing.List[str] = pydantic.Field() + """ + Limits the search to the specified locations. A location is required. + In the current implementation, only one location can be specified. + """ + + customer_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Limits the search to the specified customers, within the specified locations. + Specifying a customer is optional. In the current implementation, + a maximum of one customer can be specified. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_payment_reminder.py b/src/square/types/invoice_payment_reminder.py new file mode 100644 index 00000000..202923da --- /dev/null +++ b/src/square/types/invoice_payment_reminder.py @@ -0,0 +1,53 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .invoice_payment_reminder_status import InvoicePaymentReminderStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoicePaymentReminder(UncheckedBaseModel): + """ + Describes a payment request reminder (automatic notification) that Square sends + to the customer. You configure a reminder relative to the payment request + `due_date`. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A Square-assigned ID that uniquely identifies the reminder within the + `InvoicePaymentRequest`. + """ + + relative_scheduled_days: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of days before (a negative number) or after (a positive number) + the payment request `due_date` when the reminder is sent. For example, -3 indicates that + the reminder should be sent 3 days before the payment request `due_date`. + """ + + message: typing.Optional[str] = pydantic.Field(default=None) + """ + The reminder message. + """ + + status: typing.Optional[InvoicePaymentReminderStatus] = pydantic.Field(default=None) + """ + The status of the reminder. + See [InvoicePaymentReminderStatus](#type-invoicepaymentreminderstatus) for possible values + """ + + sent_at: typing.Optional[str] = pydantic.Field(default=None) + """ + If sent, the timestamp when the reminder was sent, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_payment_reminder_status.py b/src/square/types/invoice_payment_reminder_status.py new file mode 100644 index 00000000..f6659b5b --- /dev/null +++ b/src/square/types/invoice_payment_reminder_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoicePaymentReminderStatus = typing.Union[typing.Literal["PENDING", "NOT_APPLICABLE", "SENT"], typing.Any] diff --git a/src/square/types/invoice_payment_request.py b/src/square/types/invoice_payment_request.py new file mode 100644 index 00000000..d22ef8a2 --- /dev/null +++ b/src/square/types/invoice_payment_request.py @@ -0,0 +1,137 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .invoice_request_method import InvoiceRequestMethod +from .invoice_request_type import InvoiceRequestType +from .money import Money +from .invoice_automatic_payment_source import InvoiceAutomaticPaymentSource +from .invoice_payment_reminder import InvoicePaymentReminder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoicePaymentRequest(UncheckedBaseModel): + """ + Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum + of 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, + see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). + + Adding `INSTALLMENT` payment requests to an invoice requires an + [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated ID of the payment request in an [invoice](entity:Invoice). + """ + + request_method: typing.Optional[InvoiceRequestMethod] = pydantic.Field(default=None) + """ + Indicates how Square processes the payment request. DEPRECATED at version 2021-01-21. Replaced by the + `Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields. + + One of the following is required when creating an invoice: + - (Recommended) The `delivery_method` field of the invoice. To configure an automatic payment, the + `automatic_payment_source` field of the payment request is also required. + - This `request_method` field. Note that `invoice` objects returned in responses do not include `request_method`. + See [InvoiceRequestMethod](#type-invoicerequestmethod) for possible values + """ + + request_type: typing.Optional[InvoiceRequestType] = pydantic.Field(default=None) + """ + Identifies the payment request type. This type defines how the payment request amount is determined. + This field is required to create a payment request. + See [InvoiceRequestType](#type-invoicerequesttype) for possible values + """ + + due_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field + is required to create a payment request. If an `automatic_payment_source` is defined for the request, Square + charges the payment source on this date. + + After this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone` + of America/Los\_Angeles becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC + timestamp of 2021-03-10T08:00:00Z). + """ + + fixed_amount_requested_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + If the payment request specifies `DEPOSIT` or `INSTALLMENT` as the `request_type`, + this indicates the request amount. + You cannot specify this when `request_type` is `BALANCE` or when the + payment request includes the `percentage_requested` field. + """ + + percentage_requested: typing.Optional[str] = pydantic.Field(default=None) + """ + Specifies the amount for the payment request in percentage: + + - When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount. + - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less + the deposit, if requested. The sum of the `percentage_requested` in all installment + payment requests must be equal to 100. + + You cannot specify this when the payment `request_type` is `BALANCE` or when the + payment request specifies the `fixed_amount_requested_money` field. + """ + + tipping_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) + provides a place for the customer to pay a tip. + + This field is allowed only on the final payment request + and the payment `request_type` must be `BALANCE` or `INSTALLMENT`. + """ + + automatic_payment_source: typing.Optional[InvoiceAutomaticPaymentSource] = pydantic.Field(default=None) + """ + The payment method for an automatic payment. + + The default value is `NONE`. + See [InvoiceAutomaticPaymentSource](#type-invoiceautomaticpaymentsource) for possible values + """ + + card_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer, + call [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient. + """ + + reminders: typing.Optional[typing.List[InvoicePaymentReminder]] = pydantic.Field(default=None) + """ + A list of one or more reminders to send for the payment request. + """ + + computed_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of the payment request, computed using the order amount and information from the various payment + request fields (`request_type`, `fixed_amount_requested_money`, and `percentage_requested`). + """ + + total_completed_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money already paid for the specific payment request. + This amount might include a rounding adjustment if the most recent invoice payment + was in cash in a currency that rounds cash payments (such as, `CAD` or `AUD`). + """ + + rounding_adjustment_included_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + If the most recent payment was a cash payment + in a currency that rounds cash payments (such as, `CAD` or `AUD`) and the payment + is rounded from `computed_amount_money` in the payment request, then this + field specifies the rounding adjustment applied. This amount + might be negative. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_query.py b/src/square/types/invoice_query.py new file mode 100644 index 00000000..66991301 --- /dev/null +++ b/src/square/types/invoice_query.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .invoice_filter import InvoiceFilter +import pydantic +import typing +from .invoice_sort import InvoiceSort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceQuery(UncheckedBaseModel): + """ + Describes query criteria for searching invoices. + """ + + filter: InvoiceFilter = pydantic.Field() + """ + Query filters to apply in searching invoices. + For more information, see [Search for invoices](https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices#search-invoices). + """ + + sort: typing.Optional[InvoiceSort] = pydantic.Field(default=None) + """ + Describes the sort order for the search result. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_recipient.py b/src/square/types/invoice_recipient.py new file mode 100644 index 00000000..3a72894b --- /dev/null +++ b/src/square/types/invoice_recipient.py @@ -0,0 +1,70 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .invoice_recipient_tax_ids import InvoiceRecipientTaxIds +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceRecipient(UncheckedBaseModel): + """ + Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice + and that Square uses to deliver the invoice. + + When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates + the remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. + Square updates the customer ID in response to a merge operation, but does not update other fields. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the customer. This is the customer profile ID that + you provide when creating a draft invoice. + """ + + given_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The recipient's given (that is, first) name. + """ + + family_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The recipient's family (that is, last) name. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The recipient's email address. + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The recipient's physical address. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The recipient's phone number. + """ + + company_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the recipient's company. + """ + + tax_ids: typing.Optional[InvoiceRecipientTaxIds] = pydantic.Field(default=None) + """ + The recipient's tax IDs. The country of the seller account determines whether this field + is available for the customer. For more information, see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_recipient_tax_ids.py b/src/square/types/invoice_recipient_tax_ids.py new file mode 100644 index 00000000..3ea5eb44 --- /dev/null +++ b/src/square/types/invoice_recipient_tax_ids.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceRecipientTaxIds(UncheckedBaseModel): + """ + Represents the tax IDs for an invoice recipient. The country of the seller account determines + whether the corresponding `tax_ids` field is available for the customer. For more information, + see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). + """ + + eu_vat: typing.Optional[str] = pydantic.Field(default=None) + """ + The EU VAT identification number for the invoice recipient. For example, `IE3426675K`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_request_method.py b/src/square/types/invoice_request_method.py new file mode 100644 index 00000000..7730dcc1 --- /dev/null +++ b/src/square/types/invoice_request_method.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceRequestMethod = typing.Union[ + typing.Literal[ + "EMAIL", + "CHARGE_CARD_ON_FILE", + "SHARE_MANUALLY", + "CHARGE_BANK_ON_FILE", + "SMS", + "SMS_CHARGE_CARD_ON_FILE", + "SMS_CHARGE_BANK_ON_FILE", + ], + typing.Any, +] diff --git a/src/square/types/invoice_request_type.py b/src/square/types/invoice_request_type.py new file mode 100644 index 00000000..a0ce192b --- /dev/null +++ b/src/square/types/invoice_request_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceRequestType = typing.Union[typing.Literal["BALANCE", "DEPOSIT", "INSTALLMENT"], typing.Any] diff --git a/src/square/types/invoice_sort.py b/src/square/types/invoice_sort.py new file mode 100644 index 00000000..3277f29b --- /dev/null +++ b/src/square/types/invoice_sort.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .invoice_sort_field import InvoiceSortField +import pydantic +import typing +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class InvoiceSort(UncheckedBaseModel): + """ + Identifies the sort field and sort order. + """ + + field: InvoiceSortField = pydantic.Field(default="INVOICE_SORT_DATE") + """ + The field to use for sorting. + See [InvoiceSortField](#type-invoicesortfield) for possible values + """ + + order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The order to use for sorting the results. + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/invoice_sort_field.py b/src/square/types/invoice_sort_field.py new file mode 100644 index 00000000..165c1760 --- /dev/null +++ b/src/square/types/invoice_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceSortField = typing.Literal["INVOICE_SORT_DATE"] diff --git a/src/square/types/invoice_status.py b/src/square/types/invoice_status.py new file mode 100644 index 00000000..bf7ae427 --- /dev/null +++ b/src/square/types/invoice_status.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +InvoiceStatus = typing.Union[ + typing.Literal[ + "DRAFT", + "UNPAID", + "SCHEDULED", + "PARTIALLY_PAID", + "PAID", + "PARTIALLY_REFUNDED", + "REFUNDED", + "CANCELED", + "FAILED", + "PAYMENT_PENDING", + ], + typing.Any, +] diff --git a/src/square/types/item_variation_location_overrides.py b/src/square/types/item_variation_location_overrides.py new file mode 100644 index 00000000..d2769aa2 --- /dev/null +++ b/src/square/types/item_variation_location_overrides.py @@ -0,0 +1,78 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .catalog_pricing_type import CatalogPricingType +from .inventory_alert_type import InventoryAlertType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ItemVariationLocationOverrides(UncheckedBaseModel): + """ + Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the `Location`. This can include locations that are deactivated. + """ + + price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. + """ + + pricing_type: typing.Optional[CatalogPricingType] = pydantic.Field(default=None) + """ + The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. + See [CatalogPricingType](#type-catalogpricingtype) for possible values + """ + + track_inventory: typing.Optional[bool] = pydantic.Field(default=None) + """ + If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. + """ + + inventory_alert_type: typing.Optional[InventoryAlertType] = pydantic.Field(default=None) + """ + Indicates whether the `CatalogItemVariation` displays an alert when its inventory + quantity is less than or equal to its `inventory_alert_threshold`. + See [InventoryAlertType](#type-inventoryalerttype) for possible values + """ + + inventory_alert_threshold: typing.Optional[int] = pydantic.Field(default=None) + """ + If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` + is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. + + This value is always an integer. + """ + + sold_out: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the overridden item variation is sold out at the specified location. + + When inventory tracking is enabled on the item variation either globally or at the specified location, + the item variation is automatically marked as sold out when its inventory count reaches zero. The seller + can manually set the item variation as sold out even when the inventory count is greater than zero. + Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set, + applications should treat its inventory count as zero when this attribute value is `true`. + """ + + sold_out_valid_until: typing.Optional[str] = pydantic.Field(default=None) + """ + The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation + becomes available again at the specified location. Attempts by an application to set this attribute are ignored. + When the current time is later than this attribute value, the affected item variation is no longer sold out. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/job.py b/src/square/types/job.py new file mode 100644 index 00000000..44daea28 --- /dev/null +++ b/src/square/types/job.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Job(UncheckedBaseModel): + """ + Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the + job's title and tip eligibility. Compensation is defined in a [job assignment](entity:JobAssignment) + in a team member's wage setting. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + **Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request, + call [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job. + You can also get job IDs from a team member's wage setting. + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The title of the job. + """ + + is_tip_eligible: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether team members can earn tips for the job. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the job was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the job was last updated, in RFC 3339 format. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + **Read only** The current version of the job. Include this field in `UpdateJob` requests to enable + [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) + control and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't + match the server version at the time of the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/job_assignment.py b/src/square/types/job_assignment.py new file mode 100644 index 00000000..2e7d5c55 --- /dev/null +++ b/src/square/types/job_assignment.py @@ -0,0 +1,57 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .job_assignment_pay_type import JobAssignmentPayType +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class JobAssignment(UncheckedBaseModel): + """ + Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team + member earns for the job. Job assignments are listed in the team member's [wage setting](entity:WageSetting). + """ + + job_title: typing.Optional[str] = pydantic.Field(default=None) + """ + The title of the job. + """ + + pay_type: JobAssignmentPayType = pydantic.Field() + """ + The current pay type for the job assignment used to + calculate the pay amount in a pay period. + See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values + """ + + hourly_rate: typing.Optional[Money] = pydantic.Field(default=None) + """ + The hourly pay rate of the job. For `SALARY` pay types, Square calculates the hourly rate based on + `annual_rate` and `weekly_hours`. + """ + + annual_rate: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total pay amount for a 12-month period on the job. Set if the job `PayType` is `SALARY`. + """ + + weekly_hours: typing.Optional[int] = pydantic.Field(default=None) + """ + The planned hours per week for the job. Set if the job `PayType` is `SALARY`. + """ + + job_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [job](entity:Job). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/job_assignment_pay_type.py b/src/square/types/job_assignment_pay_type.py new file mode 100644 index 00000000..c4666e4b --- /dev/null +++ b/src/square/types/job_assignment_pay_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +JobAssignmentPayType = typing.Union[typing.Literal["NONE", "HOURLY", "SALARY"], typing.Any] diff --git a/src/square/types/link_customer_to_gift_card_response.py b/src/square/types/link_customer_to_gift_card_response.py new file mode 100644 index 00000000..8127e820 --- /dev/null +++ b/src/square/types/link_customer_to_gift_card_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LinkCustomerToGiftCardResponse(UncheckedBaseModel): + """ + A response that contains the linked `GiftCard` object. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card: typing.Optional[GiftCard] = pydantic.Field(default=None) + """ + The gift card with the ID of the linked customer listed in the `customer_ids` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_bank_accounts_response.py b/src/square/types/list_bank_accounts_response.py new file mode 100644 index 00000000..ca196109 --- /dev/null +++ b/src/square/types/list_bank_accounts_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .bank_account import BankAccount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListBankAccountsResponse(UncheckedBaseModel): + """ + Response object returned by ListBankAccounts. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + bank_accounts: typing.Optional[typing.List[BankAccount]] = pydantic.Field(default=None) + """ + List of BankAccounts associated with this account. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can + use in a subsequent request to fetch next set of bank accounts. + If empty, this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_booking_custom_attribute_definitions_response.py b/src/square/types/list_booking_custom_attribute_definitions_response.py new file mode 100644 index 00000000..45061a9b --- /dev/null +++ b/src/square/types/list_booking_custom_attribute_definitions_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListBookingCustomAttributeDefinitionsResponse(UncheckedBaseModel): + """ + Represents a [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing.Optional[typing.List[CustomAttributeDefinition]] = pydantic.Field(default=None) + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_booking_custom_attributes_response.py b/src/square/types/list_booking_custom_attributes_response.py new file mode 100644 index 00000000..98137b11 --- /dev/null +++ b/src/square/types/list_booking_custom_attributes_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListBookingCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing.Optional[typing.List[CustomAttribute]] = pydantic.Field(default=None) + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_bookings_response.py b/src/square/types/list_bookings_response.py new file mode 100644 index 00000000..8eac83c5 --- /dev/null +++ b/src/square/types/list_bookings_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking import Booking +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListBookingsResponse(UncheckedBaseModel): + bookings: typing.Optional[typing.List[Booking]] = pydantic.Field(default=None) + """ + The list of targeted bookings. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_break_types_response.py b/src/square/types/list_break_types_response.py new file mode 100644 index 00000000..cba654fc --- /dev/null +++ b/src/square/types/list_break_types_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .break_type import BreakType +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListBreakTypesResponse(UncheckedBaseModel): + """ + The response to a request for a set of `BreakType` objects. The response contains + the requested `BreakType` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_types: typing.Optional[typing.List[BreakType]] = pydantic.Field(default=None) + """ + A page of `BreakType` results. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The value supplied in the subsequent request to fetch the next page + of `BreakType` results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_cards_response.py b/src/square/types/list_cards_response.py new file mode 100644 index 00000000..fa29ffa8 --- /dev/null +++ b/src/square/types/list_cards_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .card import Card +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCardsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [ListCards](api-endpoint:Cards-ListCards) endpoint. + + Note: if there are errors processing the request, the card field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + cards: typing.Optional[typing.List[Card]] = pydantic.Field(default=None) + """ + The requested list of `Card`s. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_cash_drawer_shift_events_response.py b/src/square/types/list_cash_drawer_shift_events_response.py new file mode 100644 index 00000000..f8cf6951 --- /dev/null +++ b/src/square/types/list_cash_drawer_shift_events_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from .cash_drawer_shift_event import CashDrawerShiftEvent +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCashDrawerShiftEventsResponse(UncheckedBaseModel): + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + Opaque cursor for fetching the next page. Cursor is not present in + the last page of results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + cash_drawer_shift_events: typing.Optional[typing.List[CashDrawerShiftEvent]] = pydantic.Field(default=None) + """ + All of the events (payments, refunds, etc.) for a cash drawer during + the shift. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_cash_drawer_shifts_response.py b/src/square/types/list_cash_drawer_shifts_response.py new file mode 100644 index 00000000..aeff136d --- /dev/null +++ b/src/square/types/list_cash_drawer_shifts_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from .cash_drawer_shift_summary import CashDrawerShiftSummary +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCashDrawerShiftsResponse(UncheckedBaseModel): + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + Opaque cursor for fetching the next page of results. Cursor is not + present in the last page of results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + cash_drawer_shifts: typing.Optional[typing.List[CashDrawerShiftSummary]] = pydantic.Field(default=None) + """ + A collection of CashDrawerShiftSummary objects for shifts that match + the query. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_catalog_response.py b/src/square/types/list_catalog_response.py new file mode 100644 index 00000000..371ebc3a --- /dev/null +++ b/src/square/types/list_catalog_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCatalogResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, this is the final response. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + The CatalogObjects returned. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_customer_custom_attribute_definitions_response.py b/src/square/types/list_customer_custom_attribute_definitions_response.py new file mode 100644 index 00000000..33e91745 --- /dev/null +++ b/src/square/types/list_customer_custom_attribute_definitions_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCustomerCustomAttributeDefinitionsResponse(UncheckedBaseModel): + """ + Represents a [ListCustomerCustomAttributeDefinitions](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing.Optional[typing.List[CustomAttributeDefinition]] = pydantic.Field(default=None) + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_customer_custom_attributes_response.py b/src/square/types/list_customer_custom_attributes_response.py new file mode 100644 index 00000000..143cccbf --- /dev/null +++ b/src/square/types/list_customer_custom_attributes_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCustomerCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing.Optional[typing.List[CustomAttribute]] = pydantic.Field(default=None) + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_customer_groups_response.py b/src/square/types/list_customer_groups_response.py new file mode 100644 index 00000000..8cdf18c1 --- /dev/null +++ b/src/square/types/list_customer_groups_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer_group import CustomerGroup +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCustomerGroupsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [ListCustomerGroups](api-endpoint:CustomerGroups-ListCustomerGroups) endpoint. + + Either `errors` or `groups` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + groups: typing.Optional[typing.List[CustomerGroup]] = pydantic.Field(default=None) + """ + A list of customer groups belonging to the current seller. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. This value is present only if the request + succeeded and additional results are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_customer_segments_response.py b/src/square/types/list_customer_segments_response.py new file mode 100644 index 00000000..bbc8ac4f --- /dev/null +++ b/src/square/types/list_customer_segments_response.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer_segment import CustomerSegment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCustomerSegmentsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body for requests to the `ListCustomerSegments` endpoint. + + Either `errors` or `segments` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + segments: typing.Optional[typing.List[CustomerSegment]] = pydantic.Field(default=None) + """ + The list of customer segments belonging to the associated Square account. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor to be used in subsequent calls to `ListCustomerSegments` + to retrieve the next set of query results. The cursor is only present if the request succeeded and + additional results are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_customers_response.py b/src/square/types/list_customers_response.py new file mode 100644 index 00000000..92855991 --- /dev/null +++ b/src/square/types/list_customers_response.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer import Customer +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListCustomersResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `ListCustomers` endpoint. + + Either `errors` or `customers` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + customers: typing.Optional[typing.List[Customer]] = pydantic.Field(default=None) + """ + The customer profiles associated with the Square account or an empty object (`{}`) if none are found. + Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or + `phone_number`) are included in the response. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor to retrieve the next set of results for the + original query. A cursor is only present if the request succeeded and additional results + are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + count: typing.Optional[int] = pydantic.Field(default=None) + """ + The total count of customers associated with the Square account. Only customer profiles with public information + (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present + only if `count` is set to `true` in the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_device_codes_response.py b/src/square/types/list_device_codes_response.py new file mode 100644 index 00000000..efdabea3 --- /dev/null +++ b/src/square/types/list_device_codes_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .device_code import DeviceCode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListDeviceCodesResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + device_codes: typing.Optional[typing.List[DeviceCode]] = pydantic.Field(default=None) + """ + The queried DeviceCode. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. This value is present only if the request + succeeded and additional results are available. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_devices_response.py b/src/square/types/list_devices_response.py new file mode 100644 index 00000000..efcce551 --- /dev/null +++ b/src/square/types/list_devices_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .device import Device +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListDevicesResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors that occurred during the request. + """ + + devices: typing.Optional[typing.List[Device]] = pydantic.Field(default=None) + """ + The requested list of `Device` objects. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_dispute_evidence_response.py b/src/square/types/list_dispute_evidence_response.py new file mode 100644 index 00000000..3e20fb05 --- /dev/null +++ b/src/square/types/list_dispute_evidence_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .dispute_evidence import DisputeEvidence +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListDisputeEvidenceResponse(UncheckedBaseModel): + """ + Defines the fields in a `ListDisputeEvidence` response. + """ + + evidence: typing.Optional[typing.List[DisputeEvidence]] = pydantic.Field(default=None) + """ + The list of evidence previously uploaded to the specified dispute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. + If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_disputes_response.py b/src/square/types/list_disputes_response.py new file mode 100644 index 00000000..db71a6af --- /dev/null +++ b/src/square/types/list_disputes_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute import Dispute +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListDisputesResponse(UncheckedBaseModel): + """ + Defines fields in a `ListDisputes` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + disputes: typing.Optional[typing.List[Dispute]] = pydantic.Field(default=None) + """ + The list of disputes. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. + If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_employee_wages_response.py b/src/square/types/list_employee_wages_response.py new file mode 100644 index 00000000..cf8b1631 --- /dev/null +++ b/src/square/types/list_employee_wages_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .employee_wage import EmployeeWage +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListEmployeeWagesResponse(UncheckedBaseModel): + """ + The response to a request for a set of `EmployeeWage` objects. The response contains + a set of `EmployeeWage` objects. + """ + + employee_wages: typing.Optional[typing.List[EmployeeWage]] = pydantic.Field(default=None) + """ + A page of `EmployeeWage` results. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The value supplied in the subsequent request to fetch the next page + of `EmployeeWage` results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_employees_response.py b/src/square/types/list_employees_response.py new file mode 100644 index 00000000..569a01b9 --- /dev/null +++ b/src/square/types/list_employees_response.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .employee import Employee +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListEmployeesResponse(UncheckedBaseModel): + employees: typing.Optional[typing.List[Employee]] = None + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The token to be used to retrieve the next page of results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_event_types_response.py b/src/square/types/list_event_types_response.py new file mode 100644 index 00000000..f68e8020 --- /dev/null +++ b/src/square/types/list_event_types_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .event_type_metadata import EventTypeMetadata +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListEventTypesResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [ListEventTypes](api-endpoint:Events-ListEventTypes) endpoint. + + Note: if there are errors processing the request, the event types field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + event_types: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The list of event types. + """ + + metadata: typing.Optional[typing.List[EventTypeMetadata]] = pydantic.Field(default=None) + """ + Contains the metadata of an event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_gift_card_activities_response.py b/src/square/types/list_gift_card_activities_response.py new file mode 100644 index 00000000..5c197cb7 --- /dev/null +++ b/src/square/types/list_gift_card_activities_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card_activity import GiftCardActivity +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListGiftCardActivitiesResponse(UncheckedBaseModel): + """ + A response that contains a list of `GiftCardActivity` objects. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card_activities: typing.Optional[typing.List[GiftCardActivity]] = pydantic.Field(default=None) + """ + The requested gift card activities or an empty object if none are found. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to retrieve the next set of activities. If a cursor is not present, this is + the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_gift_cards_response.py b/src/square/types/list_gift_cards_response.py new file mode 100644 index 00000000..5c7f14a2 --- /dev/null +++ b/src/square/types/list_gift_cards_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListGiftCardsResponse(UncheckedBaseModel): + """ + A response that contains a list of `GiftCard` objects. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_cards: typing.Optional[typing.List[GiftCard]] = pydantic.Field(default=None) + """ + The requested gift cards or an empty object if none are found. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is + the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_invoices_response.py b/src/square/types/list_invoices_response.py new file mode 100644 index 00000000..68c74056 --- /dev/null +++ b/src/square/types/list_invoices_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListInvoicesResponse(UncheckedBaseModel): + """ + Describes a `ListInvoice` response. + """ + + invoices: typing.Optional[typing.List[Invoice]] = pydantic.Field(default=None) + """ + The invoices retrieved. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to retrieve the next set of invoices. If empty, this is the final + response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_jobs_response.py b/src/square/types/list_jobs_response.py new file mode 100644 index 00000000..6b49008f --- /dev/null +++ b/src/square/types/list_jobs_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .job import Job +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListJobsResponse(UncheckedBaseModel): + """ + Represents a [ListJobs](api-endpoint:Team-ListJobs) response. Either `jobs` or `errors` + is present in the response. If additional results are available, the `cursor` field is also present. + """ + + jobs: typing.Optional[typing.List[Job]] = pydantic.Field(default=None) + """ + The retrieved jobs. A single paged response contains up to 100 jobs. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + An opaque cursor used to retrieve the next page of results. This field is present only + if the request succeeded and additional results are available. For more information, see + [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_location_booking_profiles_response.py b/src/square/types/list_location_booking_profiles_response.py new file mode 100644 index 00000000..a4bf3699 --- /dev/null +++ b/src/square/types/list_location_booking_profiles_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .location_booking_profile import LocationBookingProfile +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListLocationBookingProfilesResponse(UncheckedBaseModel): + location_booking_profiles: typing.Optional[typing.List[LocationBookingProfile]] = pydantic.Field(default=None) + """ + The list of a seller's location booking profiles. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_location_custom_attribute_definitions_response.py b/src/square/types/list_location_custom_attribute_definitions_response.py new file mode 100644 index 00000000..a9cc9b4c --- /dev/null +++ b/src/square/types/list_location_custom_attribute_definitions_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListLocationCustomAttributeDefinitionsResponse(UncheckedBaseModel): + """ + Represents a [ListLocationCustomAttributeDefinitions](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing.Optional[typing.List[CustomAttributeDefinition]] = pydantic.Field(default=None) + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_location_custom_attributes_response.py b/src/square/types/list_location_custom_attributes_response.py new file mode 100644 index 00000000..7a6c978c --- /dev/null +++ b/src/square/types/list_location_custom_attributes_response.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListLocationCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [ListLocationCustomAttributes](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing.Optional[typing.List[CustomAttribute]] = pydantic.Field(default=None) + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_locations_response.py b/src/square/types/list_locations_response.py new file mode 100644 index 00000000..437f64c6 --- /dev/null +++ b/src/square/types/list_locations_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .location import Location +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListLocationsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of a request + to the [ListLocations](api-endpoint:Locations-ListLocations) endpoint. + + Either `errors` or `locations` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + locations: typing.Optional[typing.List[Location]] = pydantic.Field(default=None) + """ + The business locations. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_loyalty_programs_response.py b/src/square/types/list_loyalty_programs_response.py new file mode 100644 index 00000000..0108c0c5 --- /dev/null +++ b/src/square/types/list_loyalty_programs_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_program import LoyaltyProgram +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListLoyaltyProgramsResponse(UncheckedBaseModel): + """ + A response that contains all loyalty programs. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + programs: typing.Optional[typing.List[LoyaltyProgram]] = pydantic.Field(default=None) + """ + A list of `LoyaltyProgram` for the merchant. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_loyalty_promotions_response.py b/src/square/types/list_loyalty_promotions_response.py new file mode 100644 index 00000000..950c541a --- /dev/null +++ b/src/square/types/list_loyalty_promotions_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_promotion import LoyaltyPromotion +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListLoyaltyPromotionsResponse(UncheckedBaseModel): + """ + Represents a [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) response. + One of `loyalty_promotions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `loyalty_promotions`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_promotions: typing.Optional[typing.List[LoyaltyPromotion]] = pydantic.Field(default=None) + """ + The retrieved loyalty promotions. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_merchant_custom_attribute_definitions_response.py b/src/square/types/list_merchant_custom_attribute_definitions_response.py new file mode 100644 index 00000000..9fe14fae --- /dev/null +++ b/src/square/types/list_merchant_custom_attribute_definitions_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListMerchantCustomAttributeDefinitionsResponse(UncheckedBaseModel): + """ + Represents a [ListMerchantCustomAttributeDefinitions](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributeDefinitions) response. + Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. + If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`. + """ + + custom_attribute_definitions: typing.Optional[typing.List[CustomAttributeDefinition]] = pydantic.Field(default=None) + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, + Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of + results for your original request. This field is present only if the request succeeded and + additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_merchant_custom_attributes_response.py b/src/square/types/list_merchant_custom_attributes_response.py new file mode 100644 index 00000000..b37508da --- /dev/null +++ b/src/square/types/list_merchant_custom_attributes_response.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListMerchantCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a [ListMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributes) response. + Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional + results are available, the `cursor` field is also present along with `custom_attributes`. + """ + + custom_attributes: typing.Optional[typing.List[CustomAttribute]] = pydantic.Field(default=None) + """ + The retrieved custom attributes. If `with_definitions` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field of each custom attribute. + If no custom attributes are found, Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to use in your next call to this endpoint to retrieve the next page of results + for your original request. This field is present only if the request succeeded and additional + results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_merchants_response.py b/src/square/types/list_merchants_response.py new file mode 100644 index 00000000..f74453d8 --- /dev/null +++ b/src/square/types/list_merchants_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .merchant import Merchant +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListMerchantsResponse(UncheckedBaseModel): + """ + The response object returned by the [ListMerchant](api-endpoint:Merchants-ListMerchants) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + merchant: typing.Optional[typing.List[Merchant]] = pydantic.Field(default=None) + """ + The requested `Merchant` entities. + """ + + cursor: typing.Optional[int] = pydantic.Field(default=None) + """ + If the response is truncated, the cursor to use in next request to fetch next set of objects. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_order_custom_attribute_definitions_response.py b/src/square/types/list_order_custom_attribute_definitions_response.py new file mode 100644 index 00000000..53080db9 --- /dev/null +++ b/src/square/types/list_order_custom_attribute_definitions_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListOrderCustomAttributeDefinitionsResponse(UncheckedBaseModel): + """ + Represents a response from listing order custom attribute definitions. + """ + + custom_attribute_definitions: typing.List[CustomAttributeDefinition] = pydantic.Field() + """ + The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. + This field is present only if the request succeeded and additional results are available. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_order_custom_attributes_response.py b/src/square/types/list_order_custom_attributes_response.py new file mode 100644 index 00000000..bc22397f --- /dev/null +++ b/src/square/types/list_order_custom_attributes_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListOrderCustomAttributesResponse(UncheckedBaseModel): + """ + Represents a response from listing order custom attributes. + """ + + custom_attributes: typing.Optional[typing.List[CustomAttribute]] = pydantic.Field(default=None) + """ + The retrieved custom attributes. If no custom attribute are found, Square returns an empty object (`{}`). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. + This field is present only if the request succeeded and additional results are available. + For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_payment_links_response.py b/src/square/types/list_payment_links_response.py new file mode 100644 index 00000000..05e5f0b1 --- /dev/null +++ b/src/square/types/list_payment_links_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment_link import PaymentLink +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListPaymentLinksResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + payment_links: typing.Optional[typing.List[PaymentLink]] = pydantic.Field(default=None) + """ + The list of payment links. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can use in a subsequent request + to retrieve the next set of gift cards. If a cursor is not present, this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_payment_refunds_request_sort_field.py b/src/square/types/list_payment_refunds_request_sort_field.py new file mode 100644 index 00000000..e113b1bb --- /dev/null +++ b/src/square/types/list_payment_refunds_request_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ListPaymentRefundsRequestSortField = typing.Union[typing.Literal["CREATED_AT", "UPDATED_AT"], typing.Any] diff --git a/src/square/types/list_payment_refunds_response.py b/src/square/types/list_payment_refunds_response.py new file mode 100644 index 00000000..5c906038 --- /dev/null +++ b/src/square/types/list_payment_refunds_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment_refund import PaymentRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListPaymentRefundsResponse(UncheckedBaseModel): + """ + Defines the response returned by [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds). + + Either `errors` or `refunds` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refunds: typing.Optional[typing.List[PaymentRefund]] = pydantic.Field(default=None) + """ + The list of requested refunds. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_payments_request_sort_field.py b/src/square/types/list_payments_request_sort_field.py new file mode 100644 index 00000000..fa46dac2 --- /dev/null +++ b/src/square/types/list_payments_request_sort_field.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ListPaymentsRequestSortField = typing.Union[ + typing.Literal["CREATED_AT", "OFFLINE_CREATED_AT", "UPDATED_AT"], typing.Any +] diff --git a/src/square/types/list_payments_response.py b/src/square/types/list_payments_response.py new file mode 100644 index 00000000..8257aa59 --- /dev/null +++ b/src/square/types/list_payments_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment import Payment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListPaymentsResponse(UncheckedBaseModel): + """ + Defines the response returned by [ListPayments](api-endpoint:Payments-ListPayments). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + payments: typing.Optional[typing.List[Payment]] = pydantic.Field(default=None) + """ + The requested list of payments. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_payout_entries_response.py b/src/square/types/list_payout_entries_response.py new file mode 100644 index 00000000..3481e727 --- /dev/null +++ b/src/square/types/list_payout_entries_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .payout_entry import PayoutEntry +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListPayoutEntriesResponse(UncheckedBaseModel): + """ + The response to retrieve payout records entries. + """ + + payout_entries: typing.Optional[typing.List[PayoutEntry]] = pydantic.Field(default=None) + """ + The requested list of payout entries, ordered with the given or default sort order. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_payouts_response.py b/src/square/types/list_payouts_response.py new file mode 100644 index 00000000..faeda293 --- /dev/null +++ b/src/square/types/list_payouts_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .payout import Payout +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListPayoutsResponse(UncheckedBaseModel): + """ + The response to retrieve payout records entries. + """ + + payouts: typing.Optional[typing.List[Payout]] = pydantic.Field(default=None) + """ + The requested list of payouts. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_sites_response.py b/src/square/types/list_sites_response.py new file mode 100644 index 00000000..3833c8f5 --- /dev/null +++ b/src/square/types/list_sites_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .site import Site +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListSitesResponse(UncheckedBaseModel): + """ + Represents a `ListSites` response. The response can include either `sites` or `errors`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + sites: typing.Optional[typing.List[Site]] = pydantic.Field(default=None) + """ + The sites that belong to the seller. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_subscription_events_response.py b/src/square/types/list_subscription_events_response.py new file mode 100644 index 00000000..94e21f3d --- /dev/null +++ b/src/square/types/list_subscription_events_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription_event import SubscriptionEvent +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListSubscriptionEventsResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription_events: typing.Optional[typing.List[SubscriptionEvent]] = pydantic.Field(default=None) + """ + The retrieved subscription events. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When the total number of resulting subscription events exceeds the limit of a paged response, + the response includes a cursor for you to use in a subsequent request to fetch the next set of events. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_team_member_booking_profiles_response.py b/src/square/types/list_team_member_booking_profiles_response.py new file mode 100644 index 00000000..71455e0c --- /dev/null +++ b/src/square/types/list_team_member_booking_profiles_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member_booking_profile import TeamMemberBookingProfile +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListTeamMemberBookingProfilesResponse(UncheckedBaseModel): + team_member_booking_profiles: typing.Optional[typing.List[TeamMemberBookingProfile]] = pydantic.Field(default=None) + """ + The list of team member booking profiles. The results are returned in the ascending order of the time + when the team member booking profiles were last updated. Multiple booking profiles updated at the same time + are further sorted in the ascending order of their IDs. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_team_member_wages_response.py b/src/square/types/list_team_member_wages_response.py new file mode 100644 index 00000000..03861b55 --- /dev/null +++ b/src/square/types/list_team_member_wages_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member_wage import TeamMemberWage +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListTeamMemberWagesResponse(UncheckedBaseModel): + """ + The response to a request for a set of `TeamMemberWage` objects. The response contains + a set of `TeamMemberWage` objects. + """ + + team_member_wages: typing.Optional[typing.List[TeamMemberWage]] = pydantic.Field(default=None) + """ + A page of `TeamMemberWage` results. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The value supplied in the subsequent request to fetch the next page + of `TeamMemberWage` results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_transactions_response.py b/src/square/types/list_transactions_response.py new file mode 100644 index 00000000..a34f0d9f --- /dev/null +++ b/src/square/types/list_transactions_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .transaction import Transaction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListTransactionsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. + + One of `errors` or `transactions` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + transactions: typing.Optional[typing.List[Transaction]] = pydantic.Field(default=None) + """ + An array of transactions that match your query. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor for retrieving the next set of results, + if any remain. Provide this value as the `cursor` parameter in a subsequent + request to this endpoint. + + See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_webhook_event_types_response.py b/src/square/types/list_webhook_event_types_response.py new file mode 100644 index 00000000..43038d7c --- /dev/null +++ b/src/square/types/list_webhook_event_types_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .event_type_metadata import EventTypeMetadata +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListWebhookEventTypesResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [ListWebhookEventTypes](api-endpoint:WebhookSubscriptions-ListWebhookEventTypes) endpoint. + + Note: if there are errors processing the request, the event types field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + event_types: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The list of event types. + """ + + metadata: typing.Optional[typing.List[EventTypeMetadata]] = pydantic.Field(default=None) + """ + Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_webhook_subscriptions_response.py b/src/square/types/list_webhook_subscriptions_response.py new file mode 100644 index 00000000..ccf2bddb --- /dev/null +++ b/src/square/types/list_webhook_subscriptions_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .webhook_subscription import WebhookSubscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListWebhookSubscriptionsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [ListWebhookSubscriptions](api-endpoint:WebhookSubscriptions-ListWebhookSubscriptions) endpoint. + + Note: if there are errors processing the request, the subscriptions field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + subscriptions: typing.Optional[typing.List[WebhookSubscription]] = pydantic.Field(default=None) + """ + The requested list of [Subscription](entity:WebhookSubscription)s. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/list_workweek_configs_response.py b/src/square/types/list_workweek_configs_response.py new file mode 100644 index 00000000..af5759a6 --- /dev/null +++ b/src/square/types/list_workweek_configs_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .workweek_config import WorkweekConfig +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ListWorkweekConfigsResponse(UncheckedBaseModel): + """ + The response to a request for a set of `WorkweekConfig` objects. The response contains + the requested `WorkweekConfig` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + workweek_configs: typing.Optional[typing.List[WorkweekConfig]] = pydantic.Field(default=None) + """ + A page of `WorkweekConfig` results. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The value supplied in the subsequent request to fetch the next page of + `WorkweekConfig` results. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/location.py b/src/square/types/location.py new file mode 100644 index 00000000..5c3367f7 --- /dev/null +++ b/src/square/types/location.py @@ -0,0 +1,187 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .location_capability import LocationCapability +from .location_status import LocationStatus +from .country import Country +from .currency import Currency +from .location_type import LocationType +from .business_hours import BusinessHours +from .coordinates import Coordinates +from .tax_ids import TaxIds +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Location(UncheckedBaseModel): + """ + Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A short generated string of letters and numbers that uniquely identifies this location instance. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the location. + This information appears in the Seller Dashboard as the nickname. + A location name must be unique within a seller account. + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The physical address of the location. + """ + + timezone: typing.Optional[str] = pydantic.Field(default=None) + """ + The [IANA time zone](https://www.iana.org/time-zones) identifier for + the time zone of the location. For example, `America/Los_Angeles`. + """ + + capabilities: typing.Optional[typing.List[LocationCapability]] = pydantic.Field(default=None) + """ + The Square features that are enabled for the location. + See [LocationCapability](entity:LocationCapability) for possible values. + See [LocationCapability](#type-locationcapability) for possible values + """ + + status: typing.Optional[LocationStatus] = pydantic.Field(default=None) + """ + The status of the location. + See [LocationStatus](#type-locationstatus) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the location was created, in RFC 3339 format. + For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). + """ + + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the merchant that owns the location. + """ + + country: typing.Optional[Country] = pydantic.Field(default=None) + """ + The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`. + + See [Country](entity:Country) for possible values. + See [Country](#type-country) for possible values + """ + + language_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The language associated with the location, in + [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). + For more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences). + """ + + currency: typing.Optional[Currency] = pydantic.Field(default=None) + """ + The currency used for all transactions at this location, + in ISO 4217 format. For example, the currency code for US dollars is `USD`. + See [Currency](entity:Currency) for possible values. + See [Currency](#type-currency) for possible values + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number of the location. For example, `+1 855-700-6000`. + """ + + business_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period. + """ + + type: typing.Optional[LocationType] = pydantic.Field(default=None) + """ + The type of the location. + See [LocationType](#type-locationtype) for possible values + """ + + website_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The website URL of the location. For example, `https://squareup.com`. + """ + + business_hours: typing.Optional[BusinessHours] = pydantic.Field(default=None) + """ + The hours of operation for the location. + """ + + business_email: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the location. For example, `Main Street location`. + """ + + twitter_username: typing.Optional[str] = pydantic.Field(default=None) + """ + The Twitter username of the location without the '@' symbol. For example, `Square`. + """ + + instagram_username: typing.Optional[str] = pydantic.Field(default=None) + """ + The Instagram username of the location without the '@' symbol. For example, `square`. + """ + + facebook_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`. + """ + + coordinates: typing.Optional[Coordinates] = pydantic.Field(default=None) + """ + The physical coordinates (latitude and longitude) of the location. + """ + + logo_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of the logo image for the location. When configured in the Seller + Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. + This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels. + """ + + pos_background_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of the Point of Sale background image for the location. + """ + + mcc: typing.Optional[str] = pydantic.Field(default=None) + """ + A four-digit number that describes the kind of goods or services sold at the location. + The [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245. + For example, `5045`, for a location that sells computer goods and software. + """ + + full_format_logo_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of a full-format logo image for the location. When configured in the Seller + Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. + This image can be wider than it is tall and should be at least 1280x648 pixels. + """ + + tax_ids: typing.Optional[TaxIds] = pydantic.Field(default=None) + """ + The tax IDs for this location. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/location_booking_profile.py b/src/square/types/location_booking_profile.py new file mode 100644 index 00000000..a07fd497 --- /dev/null +++ b/src/square/types/location_booking_profile.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LocationBookingProfile(UncheckedBaseModel): + """ + The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [location](entity:Location). + """ + + booking_site_url: typing.Optional[str] = pydantic.Field(default=None) + """ + Url for the online booking site for this location. + """ + + online_booking_enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the location is enabled for online booking. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/location_capability.py b/src/square/types/location_capability.py new file mode 100644 index 00000000..7d886f99 --- /dev/null +++ b/src/square/types/location_capability.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LocationCapability = typing.Union[ + typing.Literal["CREDIT_CARD_PROCESSING", "AUTOMATIC_TRANSFERS", "UNLINKED_REFUNDS"], typing.Any +] diff --git a/src/square/types/location_status.py b/src/square/types/location_status.py new file mode 100644 index 00000000..117457e0 --- /dev/null +++ b/src/square/types/location_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LocationStatus = typing.Union[typing.Literal["ACTIVE", "INACTIVE"], typing.Any] diff --git a/src/square/types/location_type.py b/src/square/types/location_type.py new file mode 100644 index 00000000..94a04f43 --- /dev/null +++ b/src/square/types/location_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LocationType = typing.Union[typing.Literal["PHYSICAL", "MOBILE"], typing.Any] diff --git a/src/square/types/loyalty_account.py b/src/square/types/loyalty_account.py new file mode 100644 index 00000000..d3ffb8f1 --- /dev/null +++ b/src/square/types/loyalty_account.py @@ -0,0 +1,90 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .loyalty_account_mapping import LoyaltyAccountMapping +from .loyalty_account_expiring_point_deadline import LoyaltyAccountExpiringPointDeadline +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyAccount(UncheckedBaseModel): + """ + Describes a loyalty account in a [loyalty program](entity:LoyaltyProgram). For more information, see + [Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the loyalty account. + """ + + program_id: str = pydantic.Field() + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) to which the account belongs. + """ + + balance: typing.Optional[int] = pydantic.Field(default=None) + """ + The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field. + + Your application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange. + """ + + lifetime_points: typing.Optional[int] = pydantic.Field(default=None) + """ + The total points accrued during the lifetime of the account. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the [customer](entity:Customer) that is associated with the account. + """ + + enrolled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products. + + If this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer's first action on their account + (when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale. + + This field is typically specified in a `CreateLoyaltyAccount` request when creating a loyalty account for a buyer who already interacted with their account. + For example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the loyalty account was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the loyalty account was last updated, in RFC 3339 format. + """ + + mapping: typing.Optional[LoyaltyAccountMapping] = pydantic.Field(default=None) + """ + The mapping that associates the loyalty account with a buyer. Currently, + a loyalty account can only be mapped to a buyer by phone number. + + To create a loyalty account, you must specify the `mapping` field, with the buyer's phone number + in the `phone_number` field. + """ + + expiring_point_deadlines: typing.Optional[typing.List[LoyaltyAccountExpiringPointDeadline]] = pydantic.Field( + default=None + ) + """ + The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. + + The total number of points in this field equals the number of points in the `balance` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_account_expiring_point_deadline.py b/src/square/types/loyalty_account_expiring_point_deadline.py new file mode 100644 index 00000000..da82c37d --- /dev/null +++ b/src/square/types/loyalty_account_expiring_point_deadline.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyAccountExpiringPointDeadline(UncheckedBaseModel): + """ + Represents a set of points for a loyalty account that are scheduled to expire on a specific date. + """ + + points: int = pydantic.Field() + """ + The number of points scheduled to expire at the `expires_at` timestamp. + """ + + expires_at: str = pydantic.Field() + """ + The timestamp of when the points are scheduled to expire, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_account_mapping.py b/src/square/types/loyalty_account_mapping.py new file mode 100644 index 00000000..2283f289 --- /dev/null +++ b/src/square/types/loyalty_account_mapping.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyAccountMapping(UncheckedBaseModel): + """ + Represents the mapping that associates a loyalty account with a buyer. + + Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see + [Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the mapping. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the mapping was created, in RFC 3339 format. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number of the buyer, in E.164 format. For example, "+14155551111". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event.py b/src/square/types/loyalty_event.py new file mode 100644 index 00000000..9634ad0f --- /dev/null +++ b/src/square/types/loyalty_event.py @@ -0,0 +1,104 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .loyalty_event_type import LoyaltyEventType +import typing +from .loyalty_event_accumulate_points import LoyaltyEventAccumulatePoints +from .loyalty_event_create_reward import LoyaltyEventCreateReward +from .loyalty_event_redeem_reward import LoyaltyEventRedeemReward +from .loyalty_event_delete_reward import LoyaltyEventDeleteReward +from .loyalty_event_adjust_points import LoyaltyEventAdjustPoints +from .loyalty_event_source import LoyaltyEventSource +from .loyalty_event_expire_points import LoyaltyEventExpirePoints +from .loyalty_event_other import LoyaltyEventOther +from .loyalty_event_accumulate_promotion_points import LoyaltyEventAccumulatePromotionPoints +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEvent(UncheckedBaseModel): + """ + Provides information about a loyalty event. + For more information, see [Search for Balance-Changing Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events). + """ + + id: str = pydantic.Field() + """ + The Square-assigned ID of the loyalty event. + """ + + type: LoyaltyEventType = pydantic.Field() + """ + The type of the loyalty event. + See [LoyaltyEventType](#type-loyaltyeventtype) for possible values + """ + + created_at: str = pydantic.Field() + """ + The timestamp when the event was created, in RFC 3339 format. + """ + + accumulate_points: typing.Optional[LoyaltyEventAccumulatePoints] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `ACCUMULATE_POINTS`. + """ + + create_reward: typing.Optional[LoyaltyEventCreateReward] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `CREATE_REWARD`. + """ + + redeem_reward: typing.Optional[LoyaltyEventRedeemReward] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `REDEEM_REWARD`. + """ + + delete_reward: typing.Optional[LoyaltyEventDeleteReward] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `DELETE_REWARD`. + """ + + adjust_points: typing.Optional[LoyaltyEventAdjustPoints] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `ADJUST_POINTS`. + """ + + loyalty_account_id: str = pydantic.Field() + """ + The ID of the [loyalty account](entity:LoyaltyAccount) associated with the event. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [location](entity:Location) where the event occurred. + """ + + source: LoyaltyEventSource = pydantic.Field() + """ + Defines whether the event was generated by the Square Point of Sale. + See [LoyaltyEventSource](#type-loyaltyeventsource) for possible values + """ + + expire_points: typing.Optional[LoyaltyEventExpirePoints] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `EXPIRE_POINTS`. + """ + + other_event: typing.Optional[LoyaltyEventOther] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `OTHER`. + """ + + accumulate_promotion_points: typing.Optional[LoyaltyEventAccumulatePromotionPoints] = pydantic.Field(default=None) + """ + Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_accumulate_points.py b/src/square/types/loyalty_event_accumulate_points.py new file mode 100644 index 00000000..7d4c4cfe --- /dev/null +++ b/src/square/types/loyalty_event_accumulate_points.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventAccumulatePoints(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `ACCUMULATE_POINTS`. + """ + + loyalty_program_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of points accumulated by the event. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [order](entity:Order) for which the buyer accumulated the points. + This field is returned only if the Orders API is used to process orders. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_accumulate_promotion_points.py b/src/square/types/loyalty_event_accumulate_promotion_points.py new file mode 100644 index 00000000..da7dfda8 --- /dev/null +++ b/src/square/types/loyalty_event_accumulate_promotion_points.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventAccumulatePromotionPoints(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. + """ + + loyalty_program_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + loyalty_promotion_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion). + """ + + points: int = pydantic.Field() + """ + The number of points earned by the event. + """ + + order_id: str = pydantic.Field() + """ + The ID of the [order](entity:Order) for which the buyer earned the promotion points. + Only applications that use the Orders API to process orders can trigger this event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_adjust_points.py b/src/square/types/loyalty_event_adjust_points.py new file mode 100644 index 00000000..64ca6c83 --- /dev/null +++ b/src/square/types/loyalty_event_adjust_points.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventAdjustPoints(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `ADJUST_POINTS`. + """ + + loyalty_program_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: int = pydantic.Field() + """ + The number of points added or removed. + """ + + reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The reason for the adjustment of points. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_create_reward.py b/src/square/types/loyalty_event_create_reward.py new file mode 100644 index 00000000..2c4b2c9d --- /dev/null +++ b/src/square/types/loyalty_event_create_reward.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventCreateReward(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `CREATE_REWARD`. + """ + + loyalty_program_id: str = pydantic.Field() + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + reward_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the created [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + """ + + points: int = pydantic.Field() + """ + The loyalty points used to create the reward. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_date_time_filter.py b/src/square/types/loyalty_event_date_time_filter.py new file mode 100644 index 00000000..f8f3f112 --- /dev/null +++ b/src/square/types/loyalty_event_date_time_filter.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .time_range import TimeRange +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyEventDateTimeFilter(UncheckedBaseModel): + """ + Filter events by date time range. + """ + + created_at: TimeRange = pydantic.Field() + """ + The `created_at` date time range used to filter the result. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_delete_reward.py b/src/square/types/loyalty_event_delete_reward.py new file mode 100644 index 00000000..8aeecb0a --- /dev/null +++ b/src/square/types/loyalty_event_delete_reward.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventDeleteReward(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `DELETE_REWARD`. + """ + + loyalty_program_id: str = pydantic.Field() + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + reward_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the deleted [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + """ + + points: int = pydantic.Field() + """ + The number of points returned to the loyalty account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_expire_points.py b/src/square/types/loyalty_event_expire_points.py new file mode 100644 index 00000000..d2809414 --- /dev/null +++ b/src/square/types/loyalty_event_expire_points.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyEventExpirePoints(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `EXPIRE_POINTS`. + """ + + loyalty_program_id: str = pydantic.Field() + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: int = pydantic.Field() + """ + The number of points expired. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_filter.py b/src/square/types/loyalty_event_filter.py new file mode 100644 index 00000000..3aeaead8 --- /dev/null +++ b/src/square/types/loyalty_event_filter.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .loyalty_event_loyalty_account_filter import LoyaltyEventLoyaltyAccountFilter +import pydantic +from .loyalty_event_type_filter import LoyaltyEventTypeFilter +from .loyalty_event_date_time_filter import LoyaltyEventDateTimeFilter +from .loyalty_event_location_filter import LoyaltyEventLocationFilter +from .loyalty_event_order_filter import LoyaltyEventOrderFilter +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventFilter(UncheckedBaseModel): + """ + The filtering criteria. If the request specifies multiple filters, + the endpoint uses a logical AND to evaluate them. + """ + + loyalty_account_filter: typing.Optional[LoyaltyEventLoyaltyAccountFilter] = pydantic.Field(default=None) + """ + Filter events by loyalty account. + """ + + type_filter: typing.Optional[LoyaltyEventTypeFilter] = pydantic.Field(default=None) + """ + Filter events by event type. + """ + + date_time_filter: typing.Optional[LoyaltyEventDateTimeFilter] = pydantic.Field(default=None) + """ + Filter events by date time range. + For each range, the start time is inclusive and the end time + is exclusive. + """ + + location_filter: typing.Optional[LoyaltyEventLocationFilter] = pydantic.Field(default=None) + """ + Filter events by location. + """ + + order_filter: typing.Optional[LoyaltyEventOrderFilter] = pydantic.Field(default=None) + """ + Filter events by the order associated with the event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_location_filter.py b/src/square/types/loyalty_event_location_filter.py new file mode 100644 index 00000000..f5545f17 --- /dev/null +++ b/src/square/types/loyalty_event_location_filter.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventLocationFilter(UncheckedBaseModel): + """ + Filter events by location. + """ + + location_ids: typing.List[str] = pydantic.Field() + """ + The [location](entity:Location) IDs for loyalty events to query. + If multiple values are specified, the endpoint uses + a logical OR to combine them. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_loyalty_account_filter.py b/src/square/types/loyalty_event_loyalty_account_filter.py new file mode 100644 index 00000000..e1ce788f --- /dev/null +++ b/src/square/types/loyalty_event_loyalty_account_filter.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyEventLoyaltyAccountFilter(UncheckedBaseModel): + """ + Filter events by loyalty account. + """ + + loyalty_account_id: str = pydantic.Field() + """ + The ID of the [loyalty account](entity:LoyaltyAccount) associated with loyalty events. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_order_filter.py b/src/square/types/loyalty_event_order_filter.py new file mode 100644 index 00000000..7814ca6b --- /dev/null +++ b/src/square/types/loyalty_event_order_filter.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyEventOrderFilter(UncheckedBaseModel): + """ + Filter events by the order associated with the event. + """ + + order_id: str = pydantic.Field() + """ + The ID of the [order](entity:Order) associated with the event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_other.py b/src/square/types/loyalty_event_other.py new file mode 100644 index 00000000..ea0b9111 --- /dev/null +++ b/src/square/types/loyalty_event_other.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyEventOther(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `OTHER`. + """ + + loyalty_program_id: str = pydantic.Field() + """ + The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). + """ + + points: int = pydantic.Field() + """ + The number of points added or removed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_query.py b/src/square/types/loyalty_event_query.py new file mode 100644 index 00000000..ff74534b --- /dev/null +++ b/src/square/types/loyalty_event_query.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .loyalty_event_filter import LoyaltyEventFilter +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventQuery(UncheckedBaseModel): + """ + Represents a query used to search for loyalty events. + """ + + filter: typing.Optional[LoyaltyEventFilter] = pydantic.Field(default=None) + """ + The query filter criteria. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_redeem_reward.py b/src/square/types/loyalty_event_redeem_reward.py new file mode 100644 index 00000000..1584cee1 --- /dev/null +++ b/src/square/types/loyalty_event_redeem_reward.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventRedeemReward(UncheckedBaseModel): + """ + Provides metadata when the event `type` is `REDEEM_REWARD`. + """ + + loyalty_program_id: str = pydantic.Field() + """ + The ID of the [loyalty program](entity:LoyaltyProgram). + """ + + reward_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the redeemed [loyalty reward](entity:LoyaltyReward). + This field is returned only if the event source is `LOYALTY_API`. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [order](entity:Order) that redeemed the reward. + This field is returned only if the Orders API is used to process orders. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_event_source.py b/src/square/types/loyalty_event_source.py new file mode 100644 index 00000000..72393ede --- /dev/null +++ b/src/square/types/loyalty_event_source.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyEventSource = typing.Union[typing.Literal["SQUARE", "LOYALTY_API"], typing.Any] diff --git a/src/square/types/loyalty_event_type.py b/src/square/types/loyalty_event_type.py new file mode 100644 index 00000000..6844a18f --- /dev/null +++ b/src/square/types/loyalty_event_type.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyEventType = typing.Union[ + typing.Literal[ + "ACCUMULATE_POINTS", + "CREATE_REWARD", + "REDEEM_REWARD", + "DELETE_REWARD", + "ADJUST_POINTS", + "EXPIRE_POINTS", + "OTHER", + "ACCUMULATE_PROMOTION_POINTS", + ], + typing.Any, +] diff --git a/src/square/types/loyalty_event_type_filter.py b/src/square/types/loyalty_event_type_filter.py new file mode 100644 index 00000000..dbbf6e17 --- /dev/null +++ b/src/square/types/loyalty_event_type_filter.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .loyalty_event_type import LoyaltyEventType +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyEventTypeFilter(UncheckedBaseModel): + """ + Filter events by event type. + """ + + types: typing.List[LoyaltyEventType] = pydantic.Field() + """ + The loyalty event types used to filter the result. + If multiple values are specified, the endpoint uses a + logical OR to combine them. + See [LoyaltyEventType](#type-loyaltyeventtype) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program.py b/src/square/types/loyalty_program.py new file mode 100644 index 00000000..284d156b --- /dev/null +++ b/src/square/types/loyalty_program.py @@ -0,0 +1,77 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .loyalty_program_status import LoyaltyProgramStatus +from .loyalty_program_reward_tier import LoyaltyProgramRewardTier +from .loyalty_program_expiration_policy import LoyaltyProgramExpirationPolicy +from .loyalty_program_terminology import LoyaltyProgramTerminology +from .loyalty_program_accrual_rule import LoyaltyProgramAccrualRule +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyProgram(UncheckedBaseModel): + """ + Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. + Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. + For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the loyalty program. Updates to + the loyalty program do not modify the identifier. + """ + + status: typing.Optional[LoyaltyProgramStatus] = pydantic.Field(default=None) + """ + Whether the program is currently active. + See [LoyaltyProgramStatus](#type-loyaltyprogramstatus) for possible values + """ + + reward_tiers: typing.Optional[typing.List[LoyaltyProgramRewardTier]] = pydantic.Field(default=None) + """ + The list of rewards for buyers, sorted by ascending points. + """ + + expiration_policy: typing.Optional[LoyaltyProgramExpirationPolicy] = pydantic.Field(default=None) + """ + If present, details for how points expire. + """ + + terminology: typing.Optional[LoyaltyProgramTerminology] = pydantic.Field(default=None) + """ + A cosmetic name for the “points” currency. + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The [locations](entity:Location) at which the program is active. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the program was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the reward was last updated, in RFC 3339 format. + """ + + accrual_rules: typing.Optional[typing.List[LoyaltyProgramAccrualRule]] = pydantic.Field(default=None) + """ + Defines how buyers can earn loyalty points from the base loyalty program. + To check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable + buyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_accrual_rule.py b/src/square/types/loyalty_program_accrual_rule.py new file mode 100644 index 00000000..f45da956 --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .loyalty_program_accrual_rule_type import LoyaltyProgramAccrualRuleType +import pydantic +import typing +from .loyalty_program_accrual_rule_visit_data import LoyaltyProgramAccrualRuleVisitData +from .loyalty_program_accrual_rule_spend_data import LoyaltyProgramAccrualRuleSpendData +from .loyalty_program_accrual_rule_item_variation_data import LoyaltyProgramAccrualRuleItemVariationData +from .loyalty_program_accrual_rule_category_data import LoyaltyProgramAccrualRuleCategoryData +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyProgramAccrualRule(UncheckedBaseModel): + """ + Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](entity:LoyaltyProgram). + """ + + accrual_type: LoyaltyProgramAccrualRuleType = pydantic.Field() + """ + The type of the accrual rule that defines how buyers can earn points. + See [LoyaltyProgramAccrualRuleType](#type-loyaltyprogramaccrualruletype) for possible values + """ + + points: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of points that + buyers earn based on the `accrual_type`. + """ + + visit_data: typing.Optional[LoyaltyProgramAccrualRuleVisitData] = pydantic.Field(default=None) + """ + Additional data for rules with the `VISIT` accrual type. + """ + + spend_data: typing.Optional[LoyaltyProgramAccrualRuleSpendData] = pydantic.Field(default=None) + """ + Additional data for rules with the `SPEND` accrual type. + """ + + item_variation_data: typing.Optional[LoyaltyProgramAccrualRuleItemVariationData] = pydantic.Field(default=None) + """ + Additional data for rules with the `ITEM_VARIATION` accrual type. + """ + + category_data: typing.Optional[LoyaltyProgramAccrualRuleCategoryData] = pydantic.Field(default=None) + """ + Additional data for rules with the `CATEGORY` accrual type. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_accrual_rule_category_data.py b/src/square/types/loyalty_program_accrual_rule_category_data.py new file mode 100644 index 00000000..b9b742bc --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule_category_data.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyProgramAccrualRuleCategoryData(UncheckedBaseModel): + """ + Represents additional data for rules with the `CATEGORY` accrual type. + """ + + category_id: str = pydantic.Field() + """ + The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn + points. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_accrual_rule_item_variation_data.py b/src/square/types/loyalty_program_accrual_rule_item_variation_data.py new file mode 100644 index 00000000..4696196c --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule_item_variation_data.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyProgramAccrualRuleItemVariationData(UncheckedBaseModel): + """ + Represents additional data for rules with the `ITEM_VARIATION` accrual type. + """ + + item_variation_id: str = pydantic.Field() + """ + The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn + points. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_accrual_rule_spend_data.py b/src/square/types/loyalty_program_accrual_rule_spend_data.py new file mode 100644 index 00000000..8cc69e40 --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule_spend_data.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .money import Money +import pydantic +import typing +from .loyalty_program_accrual_rule_tax_mode import LoyaltyProgramAccrualRuleTaxMode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyProgramAccrualRuleSpendData(UncheckedBaseModel): + """ + Represents additional data for rules with the `SPEND` accrual type. + """ + + amount_money: Money = pydantic.Field() + """ + The amount that buyers must spend to earn points. + For example, given an "Earn 1 point for every $10 spent" accrual rule, a buyer who spends $105 earns 10 points. + """ + + excluded_category_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of any `CATEGORY` catalog objects that are excluded from points accrual. + + You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) + endpoint to retrieve information about the excluded categories. + """ + + excluded_item_variation_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual. + + You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) + endpoint to retrieve information about the excluded item variations. + """ + + tax_mode: LoyaltyProgramAccrualRuleTaxMode = pydantic.Field() + """ + Indicates how taxes should be treated when calculating the purchase amount used for points accrual. + See [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_accrual_rule_tax_mode.py b/src/square/types/loyalty_program_accrual_rule_tax_mode.py new file mode 100644 index 00000000..eaf8d4b2 --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule_tax_mode.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyProgramAccrualRuleTaxMode = typing.Union[typing.Literal["BEFORE_TAX", "AFTER_TAX"], typing.Any] diff --git a/src/square/types/loyalty_program_accrual_rule_type.py b/src/square/types/loyalty_program_accrual_rule_type.py new file mode 100644 index 00000000..07a54d98 --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyProgramAccrualRuleType = typing.Union[typing.Literal["VISIT", "SPEND", "ITEM_VARIATION", "CATEGORY"], typing.Any] diff --git a/src/square/types/loyalty_program_accrual_rule_visit_data.py b/src/square/types/loyalty_program_accrual_rule_visit_data.py new file mode 100644 index 00000000..8ead23e3 --- /dev/null +++ b/src/square/types/loyalty_program_accrual_rule_visit_data.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .money import Money +import pydantic +from .loyalty_program_accrual_rule_tax_mode import LoyaltyProgramAccrualRuleTaxMode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyProgramAccrualRuleVisitData(UncheckedBaseModel): + """ + Represents additional data for rules with the `VISIT` accrual type. + """ + + minimum_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The minimum purchase required during the visit to quality for points. + """ + + tax_mode: LoyaltyProgramAccrualRuleTaxMode = pydantic.Field() + """ + Indicates how taxes should be treated when calculating the purchase amount to determine whether the visit qualifies for points. + This setting applies only if `minimum_amount_money` is specified. + See [LoyaltyProgramAccrualRuleTaxMode](#type-loyaltyprogramaccrualruletaxmode) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_expiration_policy.py b/src/square/types/loyalty_program_expiration_policy.py new file mode 100644 index 00000000..659e8838 --- /dev/null +++ b/src/square/types/loyalty_program_expiration_policy.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyProgramExpirationPolicy(UncheckedBaseModel): + """ + Describes when the loyalty program expires. + """ + + expiration_duration: str = pydantic.Field() + """ + The number of months before points expire, in `P[n]M` RFC 3339 duration format. For example, a value of `P12M` represents a duration of 12 months. + Points are valid through the last day of the month in which they are scheduled to expire. For example, with a `P12M` duration, points earned on July 6, 2020 expire on August 1, 2021. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_reward_definition.py b/src/square/types/loyalty_program_reward_definition.py new file mode 100644 index 00000000..8c163b6c --- /dev/null +++ b/src/square/types/loyalty_program_reward_definition.py @@ -0,0 +1,70 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .loyalty_program_reward_definition_scope import LoyaltyProgramRewardDefinitionScope +import pydantic +from .loyalty_program_reward_definition_type import LoyaltyProgramRewardDefinitionType +import typing +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyProgramRewardDefinition(UncheckedBaseModel): + """ + Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details + are now defined using a catalog pricing rule and other catalog objects. For more information, see + [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + """ + + scope: LoyaltyProgramRewardDefinitionScope = pydantic.Field() + """ + Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. You can find this information in the + `product_set_data` field of the `PRODUCT_SET` catalog object referenced by the pricing rule. For `ORDER` scopes, + `all_products` is true. For `ITEM_VARIATION` or `CATEGORY` scopes, `product_ids_any` is a list of + catalog object IDs of the given type. + See [LoyaltyProgramRewardDefinitionScope](#type-loyaltyprogramrewarddefinitionscope) for possible values + """ + + discount_type: LoyaltyProgramRewardDefinitionType = pydantic.Field() + """ + The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. You can find this information + in the `discount_data.discount_type` field of the `DISCOUNT` catalog object referenced by the pricing rule. + See [LoyaltyProgramRewardDefinitionType](#type-loyaltyprogramrewarddefinitiontype) for possible values + """ + + percentage_discount: typing.Optional[str] = pydantic.Field(default=None) + """ + The fixed percentage of the discount. Present if `discount_type` is `FIXED_PERCENTAGE`. + For example, a 7.25% off discount will be represented as "7.25". DEPRECATED at version 2020-12-16. You can find this + information in the `discount_data.percentage` field of the `DISCOUNT` catalog object referenced by the pricing rule. + """ + + catalog_object_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the `type` field. + DEPRECATED at version 2020-12-16. You can find this information in the `product_set_data.product_ids_any` field + of the `PRODUCT_SET` catalog object referenced by the pricing rule. + """ + + fixed_discount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of the discount. Present if `discount_type` is `FIXED_AMOUNT`. For example, $5 off. + DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.amount_money` field of the + `DISCOUNT` catalog object referenced by the pricing rule. + """ + + max_discount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + When `discount_type` is `FIXED_PERCENTAGE`, the maximum discount amount that can be applied. + DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.maximum_amount_money` field + of the `DISCOUNT` catalog object referenced by the the pricing rule. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_reward_definition_scope.py b/src/square/types/loyalty_program_reward_definition_scope.py new file mode 100644 index 00000000..a1c9e876 --- /dev/null +++ b/src/square/types/loyalty_program_reward_definition_scope.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyProgramRewardDefinitionScope = typing.Union[typing.Literal["ORDER", "ITEM_VARIATION", "CATEGORY"], typing.Any] diff --git a/src/square/types/loyalty_program_reward_definition_type.py b/src/square/types/loyalty_program_reward_definition_type.py new file mode 100644 index 00000000..81fdf993 --- /dev/null +++ b/src/square/types/loyalty_program_reward_definition_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyProgramRewardDefinitionType = typing.Union[typing.Literal["FIXED_AMOUNT", "FIXED_PERCENTAGE"], typing.Any] diff --git a/src/square/types/loyalty_program_reward_tier.py b/src/square/types/loyalty_program_reward_tier.py new file mode 100644 index 00000000..68bdb68f --- /dev/null +++ b/src/square/types/loyalty_program_reward_tier.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .loyalty_program_reward_definition import LoyaltyProgramRewardDefinition +from .catalog_object_reference import CatalogObjectReference +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyProgramRewardTier(UncheckedBaseModel): + """ + Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the reward tier. + """ + + points: int = pydantic.Field() + """ + The points exchanged for the reward tier. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the reward tier. + """ + + definition: typing.Optional[LoyaltyProgramRewardDefinition] = pydantic.Field(default=None) + """ + Provides details about the reward tier definition. + DEPRECATED at version 2020-12-16. Replaced by the `pricing_rule_reference` field. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the reward tier was created, in RFC 3339 format. + """ + + pricing_rule_reference: CatalogObjectReference = pydantic.Field() + """ + A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount. + + Use `object_id` and `catalog_version` with the [RetrieveCatalogObject](api-endpoint:Catalog-RetrieveCatalogObject) endpoint + to get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects + that define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_program_status.py b/src/square/types/loyalty_program_status.py new file mode 100644 index 00000000..e2a7fb37 --- /dev/null +++ b/src/square/types/loyalty_program_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyProgramStatus = typing.Union[typing.Literal["INACTIVE", "ACTIVE"], typing.Any] diff --git a/src/square/types/loyalty_program_terminology.py b/src/square/types/loyalty_program_terminology.py new file mode 100644 index 00000000..3724bad1 --- /dev/null +++ b/src/square/types/loyalty_program_terminology.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyProgramTerminology(UncheckedBaseModel): + """ + Represents the naming used for loyalty points. + """ + + one: str = pydantic.Field() + """ + A singular unit for a point (for example, 1 point is called 1 star). + """ + + other: str = pydantic.Field() + """ + A plural unit for point (for example, 10 points is called 10 stars). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion.py b/src/square/types/loyalty_promotion.py new file mode 100644 index 00000000..08130727 --- /dev/null +++ b/src/square/types/loyalty_promotion.py @@ -0,0 +1,109 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .loyalty_promotion_incentive import LoyaltyPromotionIncentive +from .loyalty_promotion_available_time_data import LoyaltyPromotionAvailableTimeData +from .loyalty_promotion_trigger_limit import LoyaltyPromotionTriggerLimit +from .loyalty_promotion_status import LoyaltyPromotionStatus +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyPromotion(UncheckedBaseModel): + """ + Represents a promotion for a [loyalty program](entity:LoyaltyProgram). Loyalty promotions enable buyers + to earn extra points on top of those earned from the base program. + + A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the promotion. + """ + + name: str = pydantic.Field() + """ + The name of the promotion. + """ + + incentive: LoyaltyPromotionIncentive = pydantic.Field() + """ + The points incentive for the promotion. This field defines whether promotion points + are earned by multiplying base program points or by adding a specified number of points. + """ + + available_time: LoyaltyPromotionAvailableTimeData = pydantic.Field() + """ + The scheduling information that defines when purchases can qualify to earn points from an `ACTIVE` promotion. + """ + + trigger_limit: typing.Optional[LoyaltyPromotionTriggerLimit] = pydantic.Field(default=None) + """ + The number of times a buyer can earn promotion points during a specified interval. + If not specified, buyers can trigger the promotion an unlimited number of times. + """ + + status: typing.Optional[LoyaltyPromotionStatus] = pydantic.Field(default=None) + """ + The current status of the promotion. + See [LoyaltyPromotionStatus](#type-loyaltypromotionstatus) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the promotion was created, in RFC 3339 format. + """ + + canceled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the promotion was canceled, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the promotion was last updated, in RFC 3339 format. + """ + + loyalty_program_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion. + """ + + minimum_spend_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The minimum purchase amount required to earn promotion points. If specified, this amount is positive. + """ + + qualifying_item_variation_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified, + the purchase must include at least one of these items to qualify for the promotion. + + This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. + With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. + + You can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both. + """ + + qualifying_category_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified, + the purchase must include at least one item from one of these categories to qualify for the promotion. + + This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. + With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. + + You can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion_available_time_data.py b/src/square/types/loyalty_promotion_available_time_data.py new file mode 100644 index 00000000..3d8d93ae --- /dev/null +++ b/src/square/types/loyalty_promotion_available_time_data.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyPromotionAvailableTimeData(UncheckedBaseModel): + """ + Represents scheduling information that determines when purchases can qualify to earn points + from a [loyalty promotion](entity:LoyaltyPromotion). + """ + + start_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field + based on the provided `time_periods`. + """ + + end_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field + based on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion + remains available until it is canceled. + """ + + time_periods: typing.List[str] = pydantic.Field() + """ + A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1) + (`VEVENT`). Each event represents an available time period per day or days of the week. + A day can have a maximum of one available time period. + + Only `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and + timestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions, + an end date (using the `UNTIL` keyword), or both. For more information, see + [Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time). + + Note that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request + but are always included in the response. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion_incentive.py b/src/square/types/loyalty_promotion_incentive.py new file mode 100644 index 00000000..f2f5cd9c --- /dev/null +++ b/src/square/types/loyalty_promotion_incentive.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .loyalty_promotion_incentive_type import LoyaltyPromotionIncentiveType +import pydantic +import typing +from .loyalty_promotion_incentive_points_multiplier_data import LoyaltyPromotionIncentivePointsMultiplierData +from .loyalty_promotion_incentive_points_addition_data import LoyaltyPromotionIncentivePointsAdditionData +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyPromotionIncentive(UncheckedBaseModel): + """ + Represents how points for a [loyalty promotion](entity:LoyaltyPromotion) are calculated, + either by multiplying the points earned from the base program or by adding a specified number + of points to the points earned from the base program. + """ + + type: LoyaltyPromotionIncentiveType = pydantic.Field() + """ + The type of points incentive. + See [LoyaltyPromotionIncentiveType](#type-loyaltypromotionincentivetype) for possible values + """ + + points_multiplier_data: typing.Optional[LoyaltyPromotionIncentivePointsMultiplierData] = pydantic.Field( + default=None + ) + """ + Additional data for a `POINTS_MULTIPLIER` incentive type. + """ + + points_addition_data: typing.Optional[LoyaltyPromotionIncentivePointsAdditionData] = pydantic.Field(default=None) + """ + Additional data for a `POINTS_ADDITION` incentive type. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion_incentive_points_addition_data.py b/src/square/types/loyalty_promotion_incentive_points_addition_data.py new file mode 100644 index 00000000..75eae361 --- /dev/null +++ b/src/square/types/loyalty_promotion_incentive_points_addition_data.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class LoyaltyPromotionIncentivePointsAdditionData(UncheckedBaseModel): + """ + Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive). + """ + + points_addition: int = pydantic.Field() + """ + The number of additional points to earn each time the promotion is triggered. For example, + suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also + qualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer + earns a total of 8 points (5 program points + 3 promotion points = 8 points). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion_incentive_points_multiplier_data.py b/src/square/types/loyalty_promotion_incentive_points_multiplier_data.py new file mode 100644 index 00000000..c94fb815 --- /dev/null +++ b/src/square/types/loyalty_promotion_incentive_points_multiplier_data.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyPromotionIncentivePointsMultiplierData(UncheckedBaseModel): + """ + Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive). + """ + + points_multiplier: typing.Optional[int] = pydantic.Field(default=None) + """ + The multiplier used to calculate the number of points earned each time the promotion + is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program. + If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier` + of 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points). + + DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field. + + One of the following is required when specifying a points multiplier: + - (Recommended) The `multiplier` field. + - This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` + with the equivalent value. + """ + + multiplier: typing.Optional[str] = pydantic.Field(default=None) + """ + The multiplier used to calculate the number of points earned each time the promotion is triggered, + specified as a string representation of a decimal. Square supports multipliers up to 10x, with three + point precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the + base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a + `multiplier` of "1.5", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points). + Fractional points are dropped. + + One of the following is required when specifying a points multiplier: + - (Recommended) This `multiplier` field. + - The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` + with the equivalent value. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion_incentive_type.py b/src/square/types/loyalty_promotion_incentive_type.py new file mode 100644 index 00000000..bdffea2b --- /dev/null +++ b/src/square/types/loyalty_promotion_incentive_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyPromotionIncentiveType = typing.Union[typing.Literal["POINTS_MULTIPLIER", "POINTS_ADDITION"], typing.Any] diff --git a/src/square/types/loyalty_promotion_status.py b/src/square/types/loyalty_promotion_status.py new file mode 100644 index 00000000..3693c233 --- /dev/null +++ b/src/square/types/loyalty_promotion_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyPromotionStatus = typing.Union[typing.Literal["ACTIVE", "ENDED", "CANCELED", "SCHEDULED"], typing.Any] diff --git a/src/square/types/loyalty_promotion_trigger_limit.py b/src/square/types/loyalty_promotion_trigger_limit.py new file mode 100644 index 00000000..87cc37fe --- /dev/null +++ b/src/square/types/loyalty_promotion_trigger_limit.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .loyalty_promotion_trigger_limit_interval import LoyaltyPromotionTriggerLimitInterval +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyPromotionTriggerLimit(UncheckedBaseModel): + """ + Represents the number of times a buyer can earn points during a [loyalty promotion](entity:LoyaltyPromotion). + If this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during + the time that the promotion is available. + + A purchase that is disqualified from earning points because of this limit might qualify for another active promotion. + """ + + times: int = pydantic.Field() + """ + The maximum number of times a buyer can trigger the promotion during the specified `interval`. + """ + + interval: typing.Optional[LoyaltyPromotionTriggerLimitInterval] = pydantic.Field(default=None) + """ + The time period the limit applies to. + See [LoyaltyPromotionTriggerLimitInterval](#type-loyaltypromotiontriggerlimitinterval) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_promotion_trigger_limit_interval.py b/src/square/types/loyalty_promotion_trigger_limit_interval.py new file mode 100644 index 00000000..a47a3fde --- /dev/null +++ b/src/square/types/loyalty_promotion_trigger_limit_interval.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyPromotionTriggerLimitInterval = typing.Union[typing.Literal["ALL_TIME", "DAY"], typing.Any] diff --git a/src/square/types/loyalty_reward.py b/src/square/types/loyalty_reward.py new file mode 100644 index 00000000..1005227c --- /dev/null +++ b/src/square/types/loyalty_reward.py @@ -0,0 +1,69 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .loyalty_reward_status import LoyaltyRewardStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class LoyaltyReward(UncheckedBaseModel): + """ + Represents a contract to redeem loyalty points for a [reward tier](entity:LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. + For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the loyalty reward. + """ + + status: typing.Optional[LoyaltyRewardStatus] = pydantic.Field(default=None) + """ + The status of a loyalty reward. + See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values + """ + + loyalty_account_id: str = pydantic.Field() + """ + The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount) to which the reward belongs. + """ + + reward_tier_id: str = pydantic.Field() + """ + The Square-assigned ID of the [reward tier](entity:LoyaltyProgramRewardTier) used to create the reward. + """ + + points: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of loyalty points used for the reward. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the [order](entity:Order) to which the reward is attached. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the reward was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the reward was last updated, in RFC 3339 format. + """ + + redeemed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the reward was redeemed, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/loyalty_reward_status.py b/src/square/types/loyalty_reward_status.py new file mode 100644 index 00000000..026cc7ee --- /dev/null +++ b/src/square/types/loyalty_reward_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +LoyaltyRewardStatus = typing.Union[typing.Literal["ISSUED", "REDEEMED", "DELETED"], typing.Any] diff --git a/src/square/types/measurement_unit.py b/src/square/types/measurement_unit.py new file mode 100644 index 00000000..300d11ce --- /dev/null +++ b/src/square/types/measurement_unit.py @@ -0,0 +1,79 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .measurement_unit_custom import MeasurementUnitCustom +import pydantic +from .measurement_unit_area import MeasurementUnitArea +from .measurement_unit_length import MeasurementUnitLength +from .measurement_unit_volume import MeasurementUnitVolume +from .measurement_unit_weight import MeasurementUnitWeight +from .measurement_unit_generic import MeasurementUnitGeneric +from .measurement_unit_time import MeasurementUnitTime +from .measurement_unit_unit_type import MeasurementUnitUnitType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class MeasurementUnit(UncheckedBaseModel): + """ + Represents a unit of measurement to use with a quantity, such as ounces + or inches. Exactly one of the following fields are required: `custom_unit`, + `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. + """ + + custom_unit: typing.Optional[MeasurementUnitCustom] = pydantic.Field(default=None) + """ + A custom unit of measurement defined by the seller using the Point of Sale + app or ad-hoc as an order line item. + """ + + area_unit: typing.Optional[MeasurementUnitArea] = pydantic.Field(default=None) + """ + Represents a standard area unit. + See [MeasurementUnitArea](#type-measurementunitarea) for possible values + """ + + length_unit: typing.Optional[MeasurementUnitLength] = pydantic.Field(default=None) + """ + Represents a standard length unit. + See [MeasurementUnitLength](#type-measurementunitlength) for possible values + """ + + volume_unit: typing.Optional[MeasurementUnitVolume] = pydantic.Field(default=None) + """ + Represents a standard volume unit. + See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values + """ + + weight_unit: typing.Optional[MeasurementUnitWeight] = pydantic.Field(default=None) + """ + Represents a standard unit of weight or mass. + See [MeasurementUnitWeight](#type-measurementunitweight) for possible values + """ + + generic_unit: typing.Optional[MeasurementUnitGeneric] = pydantic.Field(default=None) + """ + Reserved for API integrations that lack the ability to specify a real measurement unit + See [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values + """ + + time_unit: typing.Optional[MeasurementUnitTime] = pydantic.Field(default=None) + """ + Represents a standard unit of time. + See [MeasurementUnitTime](#type-measurementunittime) for possible values + """ + + type: typing.Optional[MeasurementUnitUnitType] = pydantic.Field(default=None) + """ + Represents the type of the measurement unit. + See [MeasurementUnitUnitType](#type-measurementunitunittype) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/measurement_unit_area.py b/src/square/types/measurement_unit_area.py new file mode 100644 index 00000000..b12068c6 --- /dev/null +++ b/src/square/types/measurement_unit_area.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitArea = typing.Union[ + typing.Literal[ + "IMPERIAL_ACRE", + "IMPERIAL_SQUARE_INCH", + "IMPERIAL_SQUARE_FOOT", + "IMPERIAL_SQUARE_YARD", + "IMPERIAL_SQUARE_MILE", + "METRIC_SQUARE_CENTIMETER", + "METRIC_SQUARE_METER", + "METRIC_SQUARE_KILOMETER", + ], + typing.Any, +] diff --git a/src/square/types/measurement_unit_custom.py b/src/square/types/measurement_unit_custom.py new file mode 100644 index 00000000..b13aaa11 --- /dev/null +++ b/src/square/types/measurement_unit_custom.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class MeasurementUnitCustom(UncheckedBaseModel): + """ + The information needed to define a custom unit, provided by the seller. + """ + + name: str = pydantic.Field() + """ + The name of the custom unit, for example "bushel". + """ + + abbreviation: str = pydantic.Field() + """ + The abbreviation of the custom unit, such as "bsh" (bushel). This appears + in the cart for the Point of Sale app, and in reports. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/measurement_unit_generic.py b/src/square/types/measurement_unit_generic.py new file mode 100644 index 00000000..9fb8f09a --- /dev/null +++ b/src/square/types/measurement_unit_generic.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitGeneric = typing.Literal["UNIT"] diff --git a/src/square/types/measurement_unit_length.py b/src/square/types/measurement_unit_length.py new file mode 100644 index 00000000..8c3c23be --- /dev/null +++ b/src/square/types/measurement_unit_length.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitLength = typing.Union[ + typing.Literal[ + "IMPERIAL_INCH", + "IMPERIAL_FOOT", + "IMPERIAL_YARD", + "IMPERIAL_MILE", + "METRIC_MILLIMETER", + "METRIC_CENTIMETER", + "METRIC_METER", + "METRIC_KILOMETER", + ], + typing.Any, +] diff --git a/src/square/types/measurement_unit_time.py b/src/square/types/measurement_unit_time.py new file mode 100644 index 00000000..7d1e5e8c --- /dev/null +++ b/src/square/types/measurement_unit_time.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitTime = typing.Union[ + typing.Literal["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], typing.Any +] diff --git a/src/square/types/measurement_unit_unit_type.py b/src/square/types/measurement_unit_unit_type.py new file mode 100644 index 00000000..4c34d80e --- /dev/null +++ b/src/square/types/measurement_unit_unit_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitUnitType = typing.Union[ + typing.Literal["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], typing.Any +] diff --git a/src/square/types/measurement_unit_volume.py b/src/square/types/measurement_unit_volume.py new file mode 100644 index 00000000..15a93c9d --- /dev/null +++ b/src/square/types/measurement_unit_volume.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitVolume = typing.Union[ + typing.Literal[ + "GENERIC_FLUID_OUNCE", + "GENERIC_SHOT", + "GENERIC_CUP", + "GENERIC_PINT", + "GENERIC_QUART", + "GENERIC_GALLON", + "IMPERIAL_CUBIC_INCH", + "IMPERIAL_CUBIC_FOOT", + "IMPERIAL_CUBIC_YARD", + "METRIC_MILLILITER", + "METRIC_LITER", + ], + typing.Any, +] diff --git a/src/square/types/measurement_unit_weight.py b/src/square/types/measurement_unit_weight.py new file mode 100644 index 00000000..0a2e649f --- /dev/null +++ b/src/square/types/measurement_unit_weight.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MeasurementUnitWeight = typing.Union[ + typing.Literal[ + "IMPERIAL_WEIGHT_OUNCE", + "IMPERIAL_POUND", + "IMPERIAL_STONE", + "METRIC_MILLIGRAM", + "METRIC_GRAM", + "METRIC_KILOGRAM", + ], + typing.Any, +] diff --git a/src/square/types/merchant.py b/src/square/types/merchant.py new file mode 100644 index 00000000..785b1f1e --- /dev/null +++ b/src/square/types/merchant.py @@ -0,0 +1,68 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .country import Country +from .currency import Currency +from .merchant_status import MerchantStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Merchant(UncheckedBaseModel): + """ + Represents a business that sells with Square. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-issued ID of the merchant. + """ + + business_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the merchant's overall business. + """ + + country: Country = pydantic.Field() + """ + The country code associated with the merchant, in the two-letter format of ISO 3166. For example, `US` or `JP`. + See [Country](#type-country) for possible values + """ + + language_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The code indicating the [language preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`. + """ + + currency: typing.Optional[Currency] = pydantic.Field(default=None) + """ + The currency associated with the merchant, in ISO 4217 format. For example, the currency code for US dollars is `USD`. + See [Currency](#type-currency) for possible values + """ + + status: typing.Optional[MerchantStatus] = pydantic.Field(default=None) + """ + The merchant's status. + See [MerchantStatus](#type-merchantstatus) for possible values + """ + + main_location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-location) for this merchant. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the merchant was created, in RFC 3339 format. + For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/merchant_status.py b/src/square/types/merchant_status.py new file mode 100644 index 00000000..7b593d57 --- /dev/null +++ b/src/square/types/merchant_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +MerchantStatus = typing.Union[typing.Literal["ACTIVE", "INACTIVE"], typing.Any] diff --git a/src/square/types/modifier_location_overrides.py b/src/square/types/modifier_location_overrides.py new file mode 100644 index 00000000..69ebe6ee --- /dev/null +++ b/src/square/types/modifier_location_overrides.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ModifierLocationOverrides(UncheckedBaseModel): + """ + Location-specific overrides for specified properties of a `CatalogModifier` object. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the `Location` object representing the location. This can include a deactivated location. + """ + + price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The overridden price at the specified location. If this is unspecified, the modifier price is not overridden. + The modifier becomes free of charge at the specified location, when this `price_money` field is set to 0. + """ + + sold_out: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out. + The seller can manually set this sold out status. Attempts by an application to set this attribute are ignored. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/money.py b/src/square/types/money.py new file mode 100644 index 00000000..b3a6ae8e --- /dev/null +++ b/src/square/types/money.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .currency import Currency +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Money(UncheckedBaseModel): + """ + Represents an amount of money. `Money` fields can be signed or unsigned. + Fields that do not explicitly define whether they are signed or unsigned are + considered unsigned and can only hold positive amounts. For signed fields, the + sign of the value indicates the purpose of the money transfer. See + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) + for more information. + """ + + amount: typing.Optional[int] = pydantic.Field(default=None) + """ + The amount of money, in the smallest denomination of the currency + indicated by `currency`. For example, when `currency` is `USD`, `amount` is + in cents. Monetary amounts can be positive or negative. See the specific + field description to determine the meaning of the sign in a particular case. + """ + + currency: typing.Optional[Currency] = pydantic.Field(default=None) + """ + The type of currency, in __ISO 4217 format__. For example, the currency + code for US dollars is `USD`. + + See [Currency](entity:Currency) for possible values. + See [Currency](#type-currency) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/obtain_token_response.py b/src/square/types/obtain_token_response.py new file mode 100644 index 00000000..ad9c37c9 --- /dev/null +++ b/src/square/types/obtain_token_response.py @@ -0,0 +1,103 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ObtainTokenResponse(UncheckedBaseModel): + """ + Represents an [ObtainToken](api-endpoint:OAuth-ObtainToken) response. + """ + + access_token: typing.Optional[str] = pydantic.Field(default=None) + """ + An OAuth access token used to authorize Square API requests on behalf of the seller. + Include this token as a bearer token in the `Authorization` header of your API requests. + + OAuth access tokens expire in 30 days (except `short_lived` access tokens). You should call + `ObtainToken` and provide the returned `refresh_token` to get a new access token well before + the current one expires. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough). + """ + + token_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The type of access token. This value is always `bearer`. + """ + + expires_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. + """ + + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the authorizing [merchant](entity:Merchant) (seller), which represents a business. + """ + + subscription_id: typing.Optional[str] = pydantic.Field(default=None) + """ + __LEGACY__ The ID of merchant's subscription. + The ID is only present if the merchant signed up for a subscription plan during authorization. + """ + + plan_id: typing.Optional[str] = pydantic.Field(default=None) + """ + __LEGACY__ The ID of the subscription plan the merchant signed + up for. The ID is only present if the merchant signed up for a subscription plan during + authorization. + """ + + id_token: typing.Optional[str] = pydantic.Field(default=None) + """ + The OpenID token that belongs to this person. This token is only present if the + `OPENID` scope is included in the authorization request. + + Deprecated at version 2021-09-15. Square doesn't support OpenID or other single sign-on (SSO) + protocols on top of OAuth. + """ + + refresh_token: typing.Optional[str] = pydantic.Field(default=None) + """ + A refresh token that can be used in an `ObtainToken` request to generate a new access token. + + With the code flow: + - For the `authorization_code` grant type, the refresh token is multi-use and never expires. + - For the `refresh_token` grant type, the response returns the same refresh token. + + With the PKCE flow: + - For the `authorization_code` grant type, the refresh token is single-use and expires in 90 days. + - For the `refresh_token` grant type, the refresh token is a new single-use refresh token that expires in 90 days. + + For more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope). + """ + + short_lived: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the access_token is short lived. If `true`, the access token expires + in 24 hours. If `false`, the access token expires in 30 days. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + refresh_token_expires_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) + format. + + This field is only returned for the PKCE flow. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/offline_payment_details.py b/src/square/types/offline_payment_details.py new file mode 100644 index 00000000..1e79d704 --- /dev/null +++ b/src/square/types/offline_payment_details.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OfflinePaymentDetails(UncheckedBaseModel): + """ + Details specific to offline payments. + """ + + client_created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The client-side timestamp of when the offline payment was created, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order.py b/src/square/types/order.py new file mode 100644 index 00000000..09dc549e --- /dev/null +++ b/src/square/types/order.py @@ -0,0 +1,256 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_source import OrderSource +from .order_line_item import OrderLineItem +from .order_line_item_tax import OrderLineItemTax +from .order_line_item_discount import OrderLineItemDiscount +from .order_service_charge import OrderServiceCharge +from .fulfillment import Fulfillment +from .order_return import OrderReturn +from .order_money_amounts import OrderMoneyAmounts +from .order_rounding_adjustment import OrderRoundingAdjustment +from .tender import Tender +from .refund import Refund +from .order_state import OrderState +from .money import Money +from .order_pricing_options import OrderPricingOptions +from .order_reward import OrderReward +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Order(UncheckedBaseModel): + """ + Contains all information related to a single order to process with Square, + including line items that specify the products to purchase. `Order` objects also + include information about any associated tenders, refunds, and returns. + + All Connect V2 Transactions have all been converted to Orders including all associated + itemization data. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The order's unique ID. + """ + + location_id: str = pydantic.Field() + """ + The ID of the seller location that this order is associated with. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-specified ID to associate an entity in another system + with this order. + """ + + source: typing.Optional[OrderSource] = pydantic.Field(default=None) + """ + The origination details of the order. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [customer](entity:Customer) associated with the order. + + You should specify a `customer_id` on the order (or the payment) to ensure that transactions + are reliably linked to customers. Omitting this field might result in the creation of new + [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + """ + + line_items: typing.Optional[typing.List[OrderLineItem]] = pydantic.Field(default=None) + """ + The line items included in the order. + """ + + taxes: typing.Optional[typing.List[OrderLineItemTax]] = pydantic.Field(default=None) + """ + The list of all taxes associated with the order. + + Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an + `OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes + with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item. + + On reads, each tax in the list includes the total amount of that tax applied to the order. + + __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated + `line_items.taxes` field results in an error. Use `line_items.applied_taxes` + instead. + """ + + discounts: typing.Optional[typing.List[OrderLineItemDiscount]] = pydantic.Field(default=None) + """ + The list of all discounts associated with the order. + + Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`, + an `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to. + For discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount` + for every line item. + + __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated + `line_items.discounts` field results in an error. Use `line_items.applied_discounts` + instead. + """ + + service_charges: typing.Optional[typing.List[OrderServiceCharge]] = pydantic.Field(default=None) + """ + A list of service charges applied to the order. + """ + + fulfillments: typing.Optional[typing.List[Fulfillment]] = pydantic.Field(default=None) + """ + Details about order fulfillment. + + Orders can only be created with at most one fulfillment. However, orders returned + by the API might contain multiple fulfillments. + """ + + returns: typing.Optional[typing.List[OrderReturn]] = pydantic.Field(default=None) + """ + A collection of items from sale orders being returned in this one. Normally part of an + itemized return or exchange. There is exactly one `Return` object per sale `Order` being + referenced. + """ + + return_amounts: typing.Optional[OrderMoneyAmounts] = pydantic.Field(default=None) + """ + The rollup of the returned money amounts. + """ + + net_amounts: typing.Optional[OrderMoneyAmounts] = pydantic.Field(default=None) + """ + The net money amounts (sale money - return money). + """ + + rounding_adjustment: typing.Optional[OrderRoundingAdjustment] = pydantic.Field(default=None) + """ + A positive rounding adjustment to the total of the order. This adjustment is commonly + used to apply cash rounding when the minimum unit of account is smaller than the lowest physical + denomination of the currency. + """ + + tenders: typing.Optional[typing.List[Tender]] = pydantic.Field(default=None) + """ + The tenders that were used to pay for the order. + """ + + refunds: typing.Optional[typing.List[Refund]] = pydantic.Field(default=None) + """ + The refunds that are part of this order. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this order. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). + """ + + closed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). + """ + + state: typing.Optional[OrderState] = pydantic.Field(default=None) + """ + The current state of the order. + See [OrderState](#type-orderstate) for possible values + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version number, which is incremented each time an update is committed to the order. + Orders not created through the API do not include a version number and + therefore cannot be updated. + + [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders). + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of money to collect for the order. + """ + + total_tax_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of tax money to collect for the order. + """ + + total_discount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of discount money to collect for the order. + """ + + total_tip_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of tip money to collect for the order. + """ + + total_service_charge_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of money collected in service charges for the order. + + Note: `total_service_charge_money` is the sum of `applied_money` fields for each individual + service charge. Therefore, `total_service_charge_money` only includes inclusive tax amounts, + not additive tax amounts. + """ + + ticket_name: typing.Optional[str] = pydantic.Field(default=None) + """ + A short-term identifier for the order (such as a customer first name, + table number, or auto-generated order number that resets daily). + """ + + pricing_options: typing.Optional[OrderPricingOptions] = pydantic.Field(default=None) + """ + Pricing options for an order. The options affect how the order's price is calculated. + They can be used, for example, to apply automatic price adjustments that are based on + preconfigured [pricing rules](entity:CatalogPricingRule). + """ + + rewards: typing.Optional[typing.List[OrderReward]] = pydantic.Field(default=None) + """ + A set-like list of Rewards that have been added to the Order. + """ + + net_amount_due_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The net amount of money due on the order. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_entry.py b/src/square/types/order_entry.py new file mode 100644 index 00000000..c3e297b2 --- /dev/null +++ b/src/square/types/order_entry.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderEntry(UncheckedBaseModel): + """ + A lightweight description of an [order](entity:Order) that is returned when + `returned_entries` is `true` on a [SearchOrdersRequest](api-endpoint:Orders-SearchOrders). + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the order. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version number, which is incremented each time an update is committed to the order. + Orders that were not created through the API do not include a version number and + therefore cannot be updated. + + [Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location ID the order belongs to. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item.py b/src/square/types/order_line_item.py new file mode 100644 index 00000000..59a4c4a5 --- /dev/null +++ b/src/square/types/order_line_item.py @@ -0,0 +1,202 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_quantity_unit import OrderQuantityUnit +from .order_line_item_item_type import OrderLineItemItemType +from .order_line_item_modifier import OrderLineItemModifier +from .order_line_item_applied_tax import OrderLineItemAppliedTax +from .order_line_item_applied_discount import OrderLineItemAppliedDiscount +from .order_line_item_applied_service_charge import OrderLineItemAppliedServiceCharge +from .money import Money +from .order_line_item_pricing_blocklists import OrderLineItemPricingBlocklists +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItem(UncheckedBaseModel): + """ + Represents a line item in an order. Each line item describes a different + product to purchase, with its own quantity and price details. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the line item only within this order. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the line item. + """ + + quantity: str = pydantic.Field() + """ + The count, or measurement, of a line item being purchased: + + If `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count. For example: `3` apples. + + If `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement. For example: `2.25` pounds of broccoli. + + For more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit). + + Line items with a quantity of `0` are automatically removed + when paying for or otherwise completing the order. + """ + + quantity_unit: typing.Optional[OrderQuantityUnit] = pydantic.Field(default=None) + """ + The measurement unit and decimal precision that this line item's quantity is measured in. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional note associated with the line item. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item. + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this line item references. + """ + + variation_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the variation applied to this line item. + """ + + item_type: typing.Optional[OrderLineItemItemType] = pydantic.Field(default=None) + """ + The type of line item: an itemized sale, a non-itemized sale (custom amount), or the + activation or reloading of a gift card. + See [OrderLineItemItemType](#type-orderlineitemitemtype) for possible values + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this line item. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + modifiers: typing.Optional[typing.List[OrderLineItemModifier]] = pydantic.Field(default=None) + """ + The [CatalogModifier](entity:CatalogModifier)s applied to this line item. + """ + + applied_taxes: typing.Optional[typing.List[OrderLineItemAppliedTax]] = pydantic.Field(default=None) + """ + The list of references to taxes applied to this line item. Each + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a + top-level `OrderLineItemTax` applied to the line item. On reads, the + amount applied is populated. + + An `OrderLineItemAppliedTax` is automatically created on every line + item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` + records for `LINE_ITEM` scoped taxes must be added in requests for the tax + to apply to any line items. + + To change the amount of a tax, modify the referenced top-level tax. + """ + + applied_discounts: typing.Optional[typing.List[OrderLineItemAppliedDiscount]] = pydantic.Field(default=None) + """ + The list of references to discounts applied to this line item. Each + `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level + `OrderLineItemDiscounts` applied to the line item. On reads, the amount + applied is populated. + + An `OrderLineItemAppliedDiscount` is automatically created on every line item for all + `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records + for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any + line items. + + To change the amount of a discount, modify the referenced top-level discount. + """ + + applied_service_charges: typing.Optional[typing.List[OrderLineItemAppliedServiceCharge]] = pydantic.Field( + default=None + ) + """ + The list of references to service charges applied to this line item. Each + `OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a + top-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is + populated. + + To change the amount of a service charge, modify the referenced top-level service charge. + """ + + base_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The base price for a single unit of the line item. + """ + + variation_total_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total price of all item variations sold in this line item. + The price is calculated as `base_price_money` multiplied by `quantity`. + It does not include modifiers. + """ + + gross_sales_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money made in gross sales for this line item. + The amount is calculated as the sum of the variation's total price and each modifier's total price. + For inclusive tax items in the US, Canada, and Japan, tax is deducted from `gross_sales_money`. For Europe and + Australia, inclusive tax remains as part of the gross sale calculation. + """ + + total_tax_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of tax money to collect for the line item. + """ + + total_discount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of discount money to collect for the line item. + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of money to collect for this line item. + """ + + pricing_blocklists: typing.Optional[OrderLineItemPricingBlocklists] = pydantic.Field(default=None) + """ + Describes pricing adjustments that are blocked from automatic + application to a line item. For more information, see + [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). + """ + + total_service_charge_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of apportioned service charge money to collect for the line item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_applied_discount.py b/src/square/types/order_line_item_applied_discount.py new file mode 100644 index 00000000..8c6707d6 --- /dev/null +++ b/src/square/types/order_line_item_applied_discount.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemAppliedDiscount(UncheckedBaseModel): + """ + Represents an applied portion of a discount to a line item in an order. + + Order scoped discounts have automatically applied discounts present for each line item. + Line-item scoped discounts must have applied discounts added manually for any applicable line + items. The corresponding applied money is automatically computed based on participating + line items. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the applied discount only within this order. + """ + + discount_uid: str = pydantic.Field() + """ + The `uid` of the discount that the applied discount represents. It must + reference a discount present in the `order.discounts` field. + + This field is immutable. To change which discounts apply to a line item, + you must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied by the discount to the line item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_applied_service_charge.py b/src/square/types/order_line_item_applied_service_charge.py new file mode 100644 index 00000000..5617baa7 --- /dev/null +++ b/src/square/types/order_line_item_applied_service_charge.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemAppliedServiceCharge(UncheckedBaseModel): + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the applied service charge only within this order. + """ + + service_charge_uid: str = pydantic.Field() + """ + The `uid` of the service charge that the applied service charge represents. It must + reference a service charge present in the `order.service_charges` field. + + This field is immutable. To change which service charges apply to a line item, + delete and add a new `OrderLineItemAppliedServiceCharge`. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied by the service charge to the line item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_applied_tax.py b/src/square/types/order_line_item_applied_tax.py new file mode 100644 index 00000000..f43559f2 --- /dev/null +++ b/src/square/types/order_line_item_applied_tax.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemAppliedTax(UncheckedBaseModel): + """ + Represents an applied portion of a tax to a line item in an order. + + Order-scoped taxes automatically include the applied taxes in each line item. + Line item taxes must be referenced from any applicable line items. + The corresponding applied money is automatically computed, based on the + set of participating line items. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the applied tax only within this order. + """ + + tax_uid: str = pydantic.Field() + """ + The `uid` of the tax for which this applied tax represents. It must reference + a tax present in the `order.taxes` field. + + This field is immutable. To change which taxes apply to a line item, delete and add a new + `OrderLineItemAppliedTax`. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied by the tax to the line item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_discount.py b/src/square/types/order_line_item_discount.py new file mode 100644 index 00000000..d4bf409b --- /dev/null +++ b/src/square/types/order_line_item_discount.py @@ -0,0 +1,134 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_line_item_discount_type import OrderLineItemDiscountType +from .money import Money +from .order_line_item_discount_scope import OrderLineItemDiscountScope +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemDiscount(UncheckedBaseModel): + """ + Represents a discount that applies to one or more line items in an + order. + + Fixed-amount, order-scoped discounts are distributed across all non-zero line item totals. + The amount distributed to each line item is relative to the + amount contributed by the item to the order subtotal. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the discount only within this order. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this discount references. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The discount's name. + """ + + type: typing.Optional[OrderLineItemDiscountType] = pydantic.Field(default=None) + """ + The type of the discount. + + Discounts that do not reference a catalog object ID must have a type of + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the discount, as a string representation of a decimal number. + A value of `7.25` corresponds to a percentage of 7.25%. + + `percentage` is not set for amount-based discounts. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total declared monetary amount of the discount. + + `amount_money` is not set for percentage-based discounts. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of discount actually applied to the line item. + + The amount represents the amount of money applied as a line-item scoped discount. + When an amount-based discount is scoped to the entire order, the value + of `applied_money` is different than `amount_money` because the total + amount of the discount is distributed across all line items. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this discount. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + scope: typing.Optional[OrderLineItemDiscountScope] = pydantic.Field(default=None) + """ + Indicates the level at which the discount applies. For `ORDER` scoped discounts, + Square generates references in `applied_discounts` on all order line items that do + not have them. For `LINE_ITEM` scoped discounts, the discount only applies to line items + with a discount reference in their `applied_discounts` field. + + This field is immutable. To change the scope of a discount, you must delete + the discount and re-add it as a new discount. + See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values + """ + + reward_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The reward IDs corresponding to this discount. The application and + specification of discounts that have `reward_ids` are completely controlled by the backing + criteria corresponding to the reward tiers of the rewards that are added to the order + through the Loyalty API. To manually unapply discounts that are the result of added rewards, + the rewards must be removed from the order through the Loyalty API. + """ + + pricing_rule_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied + automatically to this discount. The specification and application of the discounts, to + which a `pricing_rule_id` is assigned, are completely controlled by the corresponding + pricing rule. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_discount_scope.py b/src/square/types/order_line_item_discount_scope.py new file mode 100644 index 00000000..35b65fd4 --- /dev/null +++ b/src/square/types/order_line_item_discount_scope.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderLineItemDiscountScope = typing.Union[typing.Literal["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], typing.Any] diff --git a/src/square/types/order_line_item_discount_type.py b/src/square/types/order_line_item_discount_type.py new file mode 100644 index 00000000..ffb01f58 --- /dev/null +++ b/src/square/types/order_line_item_discount_type.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderLineItemDiscountType = typing.Union[ + typing.Literal["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], + typing.Any, +] diff --git a/src/square/types/order_line_item_item_type.py b/src/square/types/order_line_item_item_type.py new file mode 100644 index 00000000..9d5f019f --- /dev/null +++ b/src/square/types/order_line_item_item_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderLineItemItemType = typing.Union[typing.Literal["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], typing.Any] diff --git a/src/square/types/order_line_item_modifier.py b/src/square/types/order_line_item_modifier.py new file mode 100644 index 00000000..72b8cd97 --- /dev/null +++ b/src/square/types/order_line_item_modifier.py @@ -0,0 +1,90 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemModifier(UncheckedBaseModel): + """ + A [CatalogModifier](entity:CatalogModifier). + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the modifier only within this order. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing [CatalogModifier](entity:CatalogModifier). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this modifier references. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the item modifier. + """ + + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + The quantity of the line item modifier. The modifier quantity can be 0 or more. + For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders + this item, the restaurant records the purchase by creating an `Order` object with a line item + for a burger. The line item includes a line item modifier: the name is cheese and the quantity + is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses + the extra cheese option, the modifier quantity increases to 2. If the buyer does not want + any cheese, the modifier quantity is set to 0. + """ + + base_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The base price for the modifier. + + `base_price_money` is required for ad hoc modifiers. + If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will + override the predefined [CatalogModifier](entity:CatalogModifier) price. + """ + + total_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total price of the item modifier for its line item. + This is the modifier's `base_price_money` multiplied by the line item's quantity. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this order. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_pricing_blocklists.py b/src/square/types/order_line_item_pricing_blocklists.py new file mode 100644 index 00000000..9bdcb770 --- /dev/null +++ b/src/square/types/order_line_item_pricing_blocklists.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order_line_item_pricing_blocklists_blocked_discount import OrderLineItemPricingBlocklistsBlockedDiscount +import pydantic +from .order_line_item_pricing_blocklists_blocked_tax import OrderLineItemPricingBlocklistsBlockedTax +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemPricingBlocklists(UncheckedBaseModel): + """ + Describes pricing adjustments that are blocked from automatic + application to a line item. For more information, see + [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). + """ + + blocked_discounts: typing.Optional[typing.List[OrderLineItemPricingBlocklistsBlockedDiscount]] = pydantic.Field( + default=None + ) + """ + A list of discounts blocked from applying to the line item. + Discounts can be blocked by the `discount_uid` (for ad hoc discounts) or + the `discount_catalog_object_id` (for catalog discounts). + """ + + blocked_taxes: typing.Optional[typing.List[OrderLineItemPricingBlocklistsBlockedTax]] = pydantic.Field(default=None) + """ + A list of taxes blocked from applying to the line item. + Taxes can be blocked by the `tax_uid` (for ad hoc taxes) or + the `tax_catalog_object_id` (for catalog taxes). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_pricing_blocklists_blocked_discount.py b/src/square/types/order_line_item_pricing_blocklists_blocked_discount.py new file mode 100644 index 00000000..64767cba --- /dev/null +++ b/src/square/types/order_line_item_pricing_blocklists_blocked_discount.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemPricingBlocklistsBlockedDiscount(UncheckedBaseModel): + """ + A discount to block from applying to a line item. The discount must be + identified by either `discount_uid` or `discount_catalog_object_id`, but not both. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID of the `BlockedDiscount` within the order. + """ + + discount_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The `uid` of the discount that should be blocked. Use this field to block + ad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field. + """ + + discount_catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The `catalog_object_id` of the discount that should be blocked. + Use this field to block catalog discounts. For ad hoc discounts, use the + `discount_uid` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_pricing_blocklists_blocked_tax.py b/src/square/types/order_line_item_pricing_blocklists_blocked_tax.py new file mode 100644 index 00000000..95047515 --- /dev/null +++ b/src/square/types/order_line_item_pricing_blocklists_blocked_tax.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemPricingBlocklistsBlockedTax(UncheckedBaseModel): + """ + A tax to block from applying to a line item. The tax must be + identified by either `tax_uid` or `tax_catalog_object_id`, but not both. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID of the `BlockedTax` within the order. + """ + + tax_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The `uid` of the tax that should be blocked. Use this field to block + ad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field. + """ + + tax_catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The `catalog_object_id` of the tax that should be blocked. + Use this field to block catalog taxes. For ad hoc taxes, use the + `tax_uid` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_tax.py b/src/square/types/order_line_item_tax.py new file mode 100644 index 00000000..1c30f056 --- /dev/null +++ b/src/square/types/order_line_item_tax.py @@ -0,0 +1,110 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_line_item_tax_type import OrderLineItemTaxType +from .money import Money +from .order_line_item_tax_scope import OrderLineItemTaxScope +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderLineItemTax(UncheckedBaseModel): + """ + Represents a tax that applies to one or more line item in the order. + + Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. + The amount distributed to each line item is relative to the amount the item + contributes to the order subtotal. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the tax only within this order. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing [CatalogTax](entity:CatalogTax). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this tax references. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The tax's name. + """ + + type: typing.Optional[OrderLineItemTaxType] = pydantic.Field(default=None) + """ + Indicates the calculation method used to apply the tax. + See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the tax, as a string representation of a decimal + number. For example, a value of `"7.25"` corresponds to a percentage of + 7.25%. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this tax. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied to the order by the tax. + + - For percentage-based taxes, `applied_money` is the money + calculated using the percentage. + """ + + scope: typing.Optional[OrderLineItemTaxScope] = pydantic.Field(default=None) + """ + Indicates the level at which the tax applies. For `ORDER` scoped taxes, + Square generates references in `applied_taxes` on all order line items that do + not have them. For `LINE_ITEM` scoped taxes, the tax only applies to line items + with references in their `applied_taxes` field. + + This field is immutable. To change the scope, you must delete the tax and + re-add it as a new tax. + See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values + """ + + auto_applied: typing.Optional[bool] = pydantic.Field(default=None) + """ + Determines whether the tax was automatically applied to the order based on + the catalog configuration. For an example, see + [Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_line_item_tax_scope.py b/src/square/types/order_line_item_tax_scope.py new file mode 100644 index 00000000..f3a94f31 --- /dev/null +++ b/src/square/types/order_line_item_tax_scope.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderLineItemTaxScope = typing.Union[typing.Literal["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], typing.Any] diff --git a/src/square/types/order_line_item_tax_type.py b/src/square/types/order_line_item_tax_type.py new file mode 100644 index 00000000..e8bc46c7 --- /dev/null +++ b/src/square/types/order_line_item_tax_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderLineItemTaxType = typing.Union[typing.Literal["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], typing.Any] diff --git a/src/square/types/order_money_amounts.py b/src/square/types/order_money_amounts.py new file mode 100644 index 00000000..0e7e73de --- /dev/null +++ b/src/square/types/order_money_amounts.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .money import Money +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderMoneyAmounts(UncheckedBaseModel): + """ + A collection of various money amounts. + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total money. + """ + + tax_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The money associated with taxes. + """ + + discount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The money associated with discounts. + """ + + tip_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The money associated with tips. + """ + + service_charge_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The money associated with service charges. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_pricing_options.py b/src/square/types/order_pricing_options.py new file mode 100644 index 00000000..47f2ee39 --- /dev/null +++ b/src/square/types/order_pricing_options.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderPricingOptions(UncheckedBaseModel): + """ + Pricing options for an order. The options affect how the order's price is calculated. + They can be used, for example, to apply automatic price adjustments that are based on preconfigured + [pricing rules](entity:CatalogPricingRule). + """ + + auto_apply_discounts: typing.Optional[bool] = pydantic.Field(default=None) + """ + The option to determine whether pricing rule-based + discounts are automatically applied to an order. + """ + + auto_apply_taxes: typing.Optional[bool] = pydantic.Field(default=None) + """ + The option to determine whether rule-based taxes are automatically + applied to an order when the criteria of the corresponding rules are met. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_quantity_unit.py b/src/square/types/order_quantity_unit.py new file mode 100644 index 00000000..ae97717a --- /dev/null +++ b/src/square/types/order_quantity_unit.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .measurement_unit import MeasurementUnit +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderQuantityUnit(UncheckedBaseModel): + """ + Contains the measurement unit for a quantity and a precision that + specifies the number of digits after the decimal point for decimal quantities. + """ + + measurement_unit: typing.Optional[MeasurementUnit] = pydantic.Field(default=None) + """ + A [MeasurementUnit](entity:MeasurementUnit) that represents the + unit of measure for the quantity. + """ + + precision: typing.Optional[int] = pydantic.Field(default=None) + """ + For non-integer quantities, represents the number of digits after the decimal point that are + recorded for this quantity. + + For example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`. + + Min: 0. Max: 5. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing the + [CatalogMeasurementUnit](entity:CatalogMeasurementUnit). + + This field is set when this is a catalog-backed measurement unit. + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this measurement unit references. + + This field is set when this is a catalog-backed measurement unit. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return.py b/src/square/types/order_return.py new file mode 100644 index 00000000..3c6cc02b --- /dev/null +++ b/src/square/types/order_return.py @@ -0,0 +1,80 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_return_line_item import OrderReturnLineItem +from .order_return_service_charge import OrderReturnServiceCharge +from .order_return_tax import OrderReturnTax +from .order_return_discount import OrderReturnDiscount +from .order_return_tip import OrderReturnTip +from .order_rounding_adjustment import OrderRoundingAdjustment +from .order_money_amounts import OrderMoneyAmounts +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturn(UncheckedBaseModel): + """ + The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the return only within this order. + """ + + source_order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An order that contains the original sale of these return line items. This is unset + for unlinked returns. + """ + + return_line_items: typing.Optional[typing.List[OrderReturnLineItem]] = pydantic.Field(default=None) + """ + A collection of line items that are being returned. + """ + + return_service_charges: typing.Optional[typing.List[OrderReturnServiceCharge]] = pydantic.Field(default=None) + """ + A collection of service charges that are being returned. + """ + + return_taxes: typing.Optional[typing.List[OrderReturnTax]] = pydantic.Field(default=None) + """ + A collection of references to taxes being returned for an order, including the total + applied tax amount to be returned. The taxes must reference a top-level tax ID from the source + order. + """ + + return_discounts: typing.Optional[typing.List[OrderReturnDiscount]] = pydantic.Field(default=None) + """ + A collection of references to discounts being returned for an order, including the total + applied discount amount to be returned. The discounts must reference a top-level discount ID + from the source order. + """ + + return_tips: typing.Optional[typing.List[OrderReturnTip]] = pydantic.Field(default=None) + """ + A collection of references to tips being returned for an order. + """ + + rounding_adjustment: typing.Optional[OrderRoundingAdjustment] = pydantic.Field(default=None) + """ + A positive or negative rounding adjustment to the total value being returned. Adjustments are commonly + used to apply cash rounding when the minimum unit of the account is smaller than the lowest + physical denomination of the currency. + """ + + return_amounts: typing.Optional[OrderMoneyAmounts] = pydantic.Field(default=None) + """ + An aggregate monetary value being returned by this return entry. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return_discount.py b/src/square/types/order_return_discount.py new file mode 100644 index 00000000..22725a69 --- /dev/null +++ b/src/square/types/order_return_discount.py @@ -0,0 +1,94 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_line_item_discount_type import OrderLineItemDiscountType +from .money import Money +from .order_line_item_discount_scope import OrderLineItemDiscountScope +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturnDiscount(UncheckedBaseModel): + """ + Represents a discount being returned that applies to one or more return line items in an + order. + + Fixed-amount, order-scoped discounts are distributed across all non-zero return line item totals. + The amount distributed to each return line item is relative to that item’s contribution to the + order subtotal. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the returned discount only within this order. + """ + + source_discount_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The discount `uid` from the order that contains the original application of this discount. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this discount references. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The discount's name. + """ + + type: typing.Optional[OrderLineItemDiscountType] = pydantic.Field(default=None) + """ + The type of the discount. If it is created by the API, it is `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + + Discounts that do not reference a catalog object ID must have a type of + `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. + See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the tax, as a string representation of a decimal number. + A value of `"7.25"` corresponds to a percentage of 7.25%. + + `percentage` is not set for amount-based discounts. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total declared monetary amount of the discount. + + `amount_money` is not set for percentage-based discounts. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of discount actually applied to this line item. When an amount-based + discount is at the order level, this value is different from `amount_money` because the discount + is distributed across the line items. + """ + + scope: typing.Optional[OrderLineItemDiscountScope] = pydantic.Field(default=None) + """ + Indicates the level at which the `OrderReturnDiscount` applies. For `ORDER` scoped + discounts, the server generates references in `applied_discounts` on all + `OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount is only applied to + `OrderReturnLineItem`s with references in their `applied_discounts` field. + See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return_line_item.py b/src/square/types/order_return_line_item.py new file mode 100644 index 00000000..168473c5 --- /dev/null +++ b/src/square/types/order_return_line_item.py @@ -0,0 +1,152 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_quantity_unit import OrderQuantityUnit +from .order_line_item_item_type import OrderLineItemItemType +from .order_return_line_item_modifier import OrderReturnLineItemModifier +from .order_line_item_applied_tax import OrderLineItemAppliedTax +from .order_line_item_applied_discount import OrderLineItemAppliedDiscount +from .money import Money +from .order_line_item_applied_service_charge import OrderLineItemAppliedServiceCharge +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturnLineItem(UncheckedBaseModel): + """ + The line item being returned in an order. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for this return line-item entry. + """ + + source_line_item_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The `uid` of the line item in the original sale order. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the line item. + """ + + quantity: str = pydantic.Field() + """ + The quantity returned, formatted as a decimal number. + For example, `"3"`. + + Line items with a `quantity_unit` can have non-integer quantities. + For example, `"1.70000"`. + """ + + quantity_unit: typing.Optional[OrderQuantityUnit] = pydantic.Field(default=None) + """ + The unit and precision that this return line item's quantity is measured in. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + The note of the return line item. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item. + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this line item references. + """ + + variation_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the variation applied to this return line item. + """ + + item_type: typing.Optional[OrderLineItemItemType] = pydantic.Field(default=None) + """ + The type of line item: an itemized return, a non-itemized return (custom amount), + or the return of an unactivated gift card sale. + See [OrderLineItemItemType](#type-orderlineitemitemtype) for possible values + """ + + return_modifiers: typing.Optional[typing.List[OrderReturnLineItemModifier]] = pydantic.Field(default=None) + """ + The [CatalogModifier](entity:CatalogModifier)s applied to this line item. + """ + + applied_taxes: typing.Optional[typing.List[OrderLineItemAppliedTax]] = pydantic.Field(default=None) + """ + The list of references to `OrderReturnTax` entities applied to the return line item. Each + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level + `OrderReturnTax` applied to the return line item. On reads, the applied amount + is populated. + """ + + applied_discounts: typing.Optional[typing.List[OrderLineItemAppliedDiscount]] = pydantic.Field(default=None) + """ + The list of references to `OrderReturnDiscount` entities applied to the return line item. Each + `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level + `OrderReturnDiscount` applied to the return line item. On reads, the applied amount + is populated. + """ + + base_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The base price for a single unit of the line item. + """ + + variation_total_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total price of all item variations returned in this line item. + The price is calculated as `base_price_money` multiplied by `quantity` and + does not include modifiers. + """ + + gross_return_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The gross return amount of money calculated as (item base price + modifiers price) * quantity. + """ + + total_tax_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of tax money to return for the line item. + """ + + total_discount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of discount money to return for the line item. + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of money to return for this line item. + """ + + applied_service_charges: typing.Optional[typing.List[OrderLineItemAppliedServiceCharge]] = pydantic.Field( + default=None + ) + """ + The list of references to `OrderReturnServiceCharge` entities applied to the return + line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that + references the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line + item. On reads, the applied amount is populated. + """ + + total_service_charge_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of apportioned service charge money to return for the line item. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return_line_item_modifier.py b/src/square/types/order_return_line_item_modifier.py new file mode 100644 index 00000000..f7b63131 --- /dev/null +++ b/src/square/types/order_return_line_item_modifier.py @@ -0,0 +1,73 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturnLineItemModifier(UncheckedBaseModel): + """ + A line item modifier being returned. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the return modifier only within this order. + """ + + source_modifier_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The modifier `uid` from the order's line item that contains the + original sale of this line item modifier. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing [CatalogModifier](entity:CatalogModifier). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this line item modifier references. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the item modifier. + """ + + base_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The base price for the modifier. + + `base_price_money` is required for ad hoc modifiers. + If both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](entity:CatalogModifier) price. + """ + + total_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total price of the item modifier for its line item. + This is the modifier's `base_price_money` multiplied by the line item's quantity. + """ + + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + The quantity of the line item modifier. The modifier quantity can be 0 or more. + For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders + this item, the restaurant records the purchase by creating an `Order` object with a line item + for a burger. The line item includes a line item modifier: the name is cheese and the quantity + is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses + the extra cheese option, the modifier quantity increases to 2. If the buyer does not want + any cheese, the modifier quantity is set to 0. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return_service_charge.py b/src/square/types/order_return_service_charge.py new file mode 100644 index 00000000..d5f1ac60 --- /dev/null +++ b/src/square/types/order_return_service_charge.py @@ -0,0 +1,132 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .order_service_charge_calculation_phase import OrderServiceChargeCalculationPhase +from .order_line_item_applied_tax import OrderLineItemAppliedTax +from .order_service_charge_treatment_type import OrderServiceChargeTreatmentType +from .order_service_charge_scope import OrderServiceChargeScope +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturnServiceCharge(UncheckedBaseModel): + """ + Represents the service charge applied to the original order. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the return service charge only within this order. + """ + + source_service_charge_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service charge `uid` from the order containing the original + service charge. `source_service_charge_uid` is `null` for + unlinked returns. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the service charge. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this service charge references. + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the service charge, as a string representation of + a decimal number. For example, a value of `"7.25"` corresponds to a + percentage of 7.25%. + + Either `percentage` or `amount_money` should be set, but not both. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of a non-percentage-based service charge. + + Either `percentage` or `amount_money` should be set, but not both. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied to the order by the service charge, including + any inclusive tax amounts, as calculated by Square. + + - For fixed-amount service charges, `applied_money` is equal to `amount_money`. + - For percentage-based service charges, `applied_money` is the money calculated using the percentage. + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of money to collect for the service charge. + + __NOTE__: If an inclusive tax is applied to the service charge, `total_money` + does not equal `applied_money` plus `total_tax_money` because the inclusive + tax amount is already included in both `applied_money` and `total_tax_money`. + """ + + total_tax_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of tax money to collect for the service charge. + """ + + calculation_phase: typing.Optional[OrderServiceChargeCalculationPhase] = pydantic.Field(default=None) + """ + The calculation phase after which to apply the service charge. + See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values + """ + + taxable: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the surcharge can be taxed. Service charges + calculated in the `TOTAL_PHASE` cannot be marked as taxable. + """ + + applied_taxes: typing.Optional[typing.List[OrderLineItemAppliedTax]] = pydantic.Field(default=None) + """ + The list of references to `OrderReturnTax` entities applied to the + `OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid` + that references the `uid` of a top-level `OrderReturnTax` that is being + applied to the `OrderReturnServiceCharge`. On reads, the applied amount is + populated. + """ + + treatment_type: typing.Optional[OrderServiceChargeTreatmentType] = pydantic.Field(default=None) + """ + The treatment type of the service charge. + See [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) for possible values + """ + + scope: typing.Optional[OrderServiceChargeScope] = pydantic.Field(default=None) + """ + Indicates the level at which the apportioned service charge applies. For `ORDER` + scoped service charges, Square generates references in `applied_service_charges` on + all order line items that do not have them. For `LINE_ITEM` scoped service charges, + the service charge only applies to line items with a service charge reference in their + `applied_service_charges` field. + + This field is immutable. To change the scope of an apportioned service charge, you must delete + the apportioned service charge and re-add it as a new apportioned service charge. + See [OrderServiceChargeScope](#type-orderservicechargescope) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return_tax.py b/src/square/types/order_return_tax.py new file mode 100644 index 00000000..5479b9d7 --- /dev/null +++ b/src/square/types/order_return_tax.py @@ -0,0 +1,79 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .order_line_item_tax_type import OrderLineItemTaxType +from .money import Money +from .order_line_item_tax_scope import OrderLineItemTaxScope +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturnTax(UncheckedBaseModel): + """ + Represents a tax being returned that applies to one or more return line items in an order. + + Fixed-amount, order-scoped taxes are distributed across all non-zero return line item totals. + The amount distributed to each return line item is relative to that item’s contribution to the + order subtotal. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the returned tax only within this order. + """ + + source_tax_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The tax `uid` from the order that contains the original tax charge. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing [CatalogTax](entity:CatalogTax). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this tax references. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The tax's name. + """ + + type: typing.Optional[OrderLineItemTaxType] = pydantic.Field(default=None) + """ + Indicates the calculation method used to apply the tax. + See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The percentage of the tax, as a string representation of a decimal number. + For example, a value of `"7.25"` corresponds to a percentage of 7.25%. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied by the tax in an order. + """ + + scope: typing.Optional[OrderLineItemTaxScope] = pydantic.Field(default=None) + """ + Indicates the level at which the `OrderReturnTax` applies. For `ORDER` scoped + taxes, Square generates references in `applied_taxes` on all + `OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax is only applied to + `OrderReturnLineItem`s with references in their `applied_discounts` field. + See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_return_tip.py b/src/square/types/order_return_tip.py new file mode 100644 index 00000000..1a7ce590 --- /dev/null +++ b/src/square/types/order_return_tip.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderReturnTip(UncheckedBaseModel): + """ + A tip being returned. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the tip only within this order. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of tip being returned + -- + """ + + source_tender_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The tender `uid` from the order that contains the original application of this tip. + """ + + source_tender_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The tender `id` from the order that contains the original application of this tip. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_reward.py b/src/square/types/order_reward.py new file mode 100644 index 00000000..244ca36c --- /dev/null +++ b/src/square/types/order_reward.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class OrderReward(UncheckedBaseModel): + """ + Represents a reward that can be applied to an order if the necessary + reward tier criteria are met. Rewards are created through the Loyalty API. + """ + + id: str = pydantic.Field() + """ + The identifier of the reward. + """ + + reward_tier_id: str = pydantic.Field() + """ + The identifier of the reward tier corresponding to this reward. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_rounding_adjustment.py b/src/square/types/order_rounding_adjustment.py new file mode 100644 index 00000000..ef853e45 --- /dev/null +++ b/src/square/types/order_rounding_adjustment.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderRoundingAdjustment(UncheckedBaseModel): + """ + A rounding adjustment of the money being returned. Commonly used to apply cash rounding + when the minimum unit of the account is smaller than the lowest physical denomination of the currency. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the rounding adjustment only within this order. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the rounding adjustment from the original sale order. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The actual rounding adjustment amount. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_service_charge.py b/src/square/types/order_service_charge.py new file mode 100644 index 00000000..887a46d0 --- /dev/null +++ b/src/square/types/order_service_charge.py @@ -0,0 +1,163 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .order_service_charge_calculation_phase import OrderServiceChargeCalculationPhase +from .order_line_item_applied_tax import OrderLineItemAppliedTax +from .order_service_charge_type import OrderServiceChargeType +from .order_service_charge_treatment_type import OrderServiceChargeTreatmentType +from .order_service_charge_scope import OrderServiceChargeScope +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderServiceCharge(UncheckedBaseModel): + """ + Represents a service charge applied to an order. + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID that identifies the service charge only within this order. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the service charge. + """ + + catalog_object_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject). + """ + + catalog_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the catalog object that this service charge references. + """ + + percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The service charge percentage as a string representation of a + decimal number. For example, `"7.25"` indicates a service charge of 7.25%. + + Exactly 1 of `percentage` or `amount_money` should be set. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of a non-percentage-based service charge. + + Exactly one of `percentage` or `amount_money` should be set. + """ + + applied_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money applied to the order by the service charge, + including any inclusive tax amounts, as calculated by Square. + + - For fixed-amount service charges, `applied_money` is equal to `amount_money`. + - For percentage-based service charges, `applied_money` is the money + calculated using the percentage. + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of money to collect for the service charge. + + __Note__: If an inclusive tax is applied to the service charge, + `total_money` does not equal `applied_money` plus `total_tax_money` + because the inclusive tax amount is already included in both + `applied_money` and `total_tax_money`. + """ + + total_tax_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of tax money to collect for the service charge. + """ + + calculation_phase: typing.Optional[OrderServiceChargeCalculationPhase] = pydantic.Field(default=None) + """ + The calculation phase at which to apply the service charge. + See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values + """ + + taxable: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the service charge can be taxed. If set to `true`, + order-level taxes automatically apply to the service charge. Note that + service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable. + """ + + applied_taxes: typing.Optional[typing.List[OrderLineItemAppliedTax]] = pydantic.Field(default=None) + """ + The list of references to the taxes applied to this service charge. Each + `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level + `OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied + is populated. + + An `OrderLineItemAppliedTax` is automatically created on every taxable service charge + for all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records + for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable + service charge. Taxable service charges have the `taxable` field set to `true` and calculated + in the `SUBTOTAL_PHASE`. + + To change the amount of a tax, modify the referenced top-level tax. + """ + + metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) + """ + Application-defined data attached to this service charge. Metadata fields are intended + to store descriptive references or associations with an entity in another system or store brief + information about the object. Square does not process this field; it only stores and returns it + in relevant API calls. Do not use metadata to store any sensitive information (such as personally + identifiable information or card details). + + Keys written by applications must be 60 characters or less and must be in the character set + `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed + with a namespace, separated from the key with a ':' character. + + Values have a maximum length of 255 characters. + + An application can have up to 10 entries per metadata field. + + Entries written by applications are private and can only be read or modified by the same + application. + + For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). + """ + + type: typing.Optional[OrderServiceChargeType] = pydantic.Field(default=None) + """ + The type of the service charge. + See [OrderServiceChargeType](#type-orderservicechargetype) for possible values + """ + + treatment_type: typing.Optional[OrderServiceChargeTreatmentType] = pydantic.Field(default=None) + """ + The treatment type of the service charge. + See [OrderServiceChargeTreatmentType](#type-orderservicechargetreatmenttype) for possible values + """ + + scope: typing.Optional[OrderServiceChargeScope] = pydantic.Field(default=None) + """ + Indicates the level at which the apportioned service charge applies. For `ORDER` + scoped service charges, Square generates references in `applied_service_charges` on + all order line items that do not have them. For `LINE_ITEM` scoped service charges, + the service charge only applies to line items with a service charge reference in their + `applied_service_charges` field. + + This field is immutable. To change the scope of an apportioned service charge, you must delete + the apportioned service charge and re-add it as a new apportioned service charge. + See [OrderServiceChargeScope](#type-orderservicechargescope) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_service_charge_calculation_phase.py b/src/square/types/order_service_charge_calculation_phase.py new file mode 100644 index 00000000..b5a1f2f4 --- /dev/null +++ b/src/square/types/order_service_charge_calculation_phase.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderServiceChargeCalculationPhase = typing.Union[ + typing.Literal["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], + typing.Any, +] diff --git a/src/square/types/order_service_charge_scope.py b/src/square/types/order_service_charge_scope.py new file mode 100644 index 00000000..4911786e --- /dev/null +++ b/src/square/types/order_service_charge_scope.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderServiceChargeScope = typing.Union[typing.Literal["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], typing.Any] diff --git a/src/square/types/order_service_charge_treatment_type.py b/src/square/types/order_service_charge_treatment_type.py new file mode 100644 index 00000000..e23dcff8 --- /dev/null +++ b/src/square/types/order_service_charge_treatment_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderServiceChargeTreatmentType = typing.Union[ + typing.Literal["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], typing.Any +] diff --git a/src/square/types/order_service_charge_type.py b/src/square/types/order_service_charge_type.py new file mode 100644 index 00000000..ef0f612b --- /dev/null +++ b/src/square/types/order_service_charge_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderServiceChargeType = typing.Union[typing.Literal["AUTO_GRATUITY", "CUSTOM"], typing.Any] diff --git a/src/square/types/order_source.py b/src/square/types/order_source.py new file mode 100644 index 00000000..ec1345f1 --- /dev/null +++ b/src/square/types/order_source.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class OrderSource(UncheckedBaseModel): + """ + Represents the origination details of an order. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name used to identify the place (physical or digital) that an order originates. + If unset, the name defaults to the name of the application that created the order. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/order_state.py b/src/square/types/order_state.py new file mode 100644 index 00000000..075eab08 --- /dev/null +++ b/src/square/types/order_state.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderState = typing.Union[typing.Literal["OPEN", "COMPLETED", "CANCELED", "DRAFT"], typing.Any] diff --git a/src/square/types/pause_subscription_response.py b/src/square/types/pause_subscription_response.py new file mode 100644 index 00000000..8d7181bd --- /dev/null +++ b/src/square/types/pause_subscription_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from .subscription_action import SubscriptionAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PauseSubscriptionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The subscription to be paused by the scheduled `PAUSE` action. + """ + + actions: typing.Optional[typing.List[SubscriptionAction]] = pydantic.Field(default=None) + """ + The list of a `PAUSE` action and a possible `RESUME` action created by the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/pay_order_response.py b/src/square/types/pay_order_response.py new file mode 100644 index 00000000..1bfb3ecf --- /dev/null +++ b/src/square/types/pay_order_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .order import Order +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PayOrderResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of a request to the + [PayOrder](api-endpoint:Orders-PayOrder) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The paid, updated [order](entity:Order). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment.py b/src/square/types/payment.py new file mode 100644 index 00000000..c13f5203 --- /dev/null +++ b/src/square/types/payment.py @@ -0,0 +1,337 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .processing_fee import ProcessingFee +from .card_payment_details import CardPaymentDetails +from .cash_payment_details import CashPaymentDetails +from .bank_account_payment_details import BankAccountPaymentDetails +from .external_payment_details import ExternalPaymentDetails +from .digital_wallet_details import DigitalWalletDetails +from .buy_now_pay_later_details import BuyNowPayLaterDetails +from .square_account_details import SquareAccountDetails +from .risk_evaluation import RiskEvaluation +from .address import Address +from .device_details import DeviceDetails +from .application_details import ApplicationDetails +from .offline_payment_details import OfflinePaymentDetails +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Payment(UncheckedBaseModel): + """ + Represents a payment processed by the Square API. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for the payment. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the payment was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the payment was last updated, in RFC 3339 format. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount processed for this payment, not including `tip_money`. + + The amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + tip_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount designated as a tip. + + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + total_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount for the payment, including `amount_money` and `tip_money`. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + app_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount the developer is taking as a fee for facilitating the payment on behalf + of the seller. This amount is specified in the smallest denomination of the applicable currency + (for example, US dollar amounts are specified in cents). For more information, + see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + The amount cannot be more than 90% of the `total_money` value. + + To set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. + For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + """ + + approved_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money approved for this payment. This value may change if Square chooses to + obtain reauthorization as part of a call to [UpdatePayment](api-endpoint:Payments-UpdatePayment). + """ + + processing_fee: typing.Optional[typing.List[ProcessingFee]] = pydantic.Field(default=None) + """ + The processing fees and fee adjustments assessed by Square for this payment. + """ + + refunded_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of the payment refunded to date. + + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED. + """ + + delay_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The duration of time after the payment's creation when Square automatically applies the + `delay_action` to the payment. This automatic `delay_action` applies only to payments that + do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` + time period. + + This field is specified as a time duration, in RFC 3339 format. + + Notes: + This feature is only supported for card payments. + + Default: + + - Card-present payments: "PT36H" (36 hours) from the creation time. + - Card-not-present payments: "P7D" (7 days) from the creation time. + """ + + delay_action: typing.Optional[str] = pydantic.Field(default=None) + """ + The action to be applied to the payment when the `delay_duration` has elapsed. + + Current values include `CANCEL` and `COMPLETE`. + """ + + delayed_until: typing.Optional[str] = pydantic.Field(default=None) + """ + The read-only timestamp of when the `delay_action` is automatically applied, + in RFC 3339 format. + + Note that this field is calculated by summing the payment's `delay_duration` and `created_at` + fields. The `created_at` field is generated by Square and might not exactly match the + time on your local machine. + """ + + source_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The source type for this payment. + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`, + `CASH` and `EXTERNAL`. For information about these payment source types, + see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). + """ + + card_details: typing.Optional[CardPaymentDetails] = pydantic.Field(default=None) + """ + Details about a card payment. These details are only populated if the source_type is `CARD`. + """ + + cash_details: typing.Optional[CashPaymentDetails] = pydantic.Field(default=None) + """ + Details about a cash payment. These details are only populated if the source_type is `CASH`. + """ + + bank_account_details: typing.Optional[BankAccountPaymentDetails] = pydantic.Field(default=None) + """ + Details about a bank account payment. These details are only populated if the source_type is `BANK_ACCOUNT`. + """ + + external_details: typing.Optional[ExternalPaymentDetails] = pydantic.Field(default=None) + """ + Details about an external payment. The details are only populated + if the `source_type` is `EXTERNAL`. + """ + + wallet_details: typing.Optional[DigitalWalletDetails] = pydantic.Field(default=None) + """ + Details about an wallet payment. The details are only populated + if the `source_type` is `WALLET`. + """ + + buy_now_pay_later_details: typing.Optional[BuyNowPayLaterDetails] = pydantic.Field(default=None) + """ + Details about a Buy Now Pay Later payment. The details are only populated + if the `source_type` is `BUY_NOW_PAY_LATER`. For more information, see + [Afterpay Payments](https://developer.squareup.com/docs/payments-api/take-payments/afterpay-payments). + """ + + square_account_details: typing.Optional[SquareAccountDetails] = pydantic.Field(default=None) + """ + Details about a Square Account payment. The details are only populated + if the `source_type` is `SQUARE_ACCOUNT`. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location associated with the payment. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the order associated with the payment. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID that associates the payment with an entity in + another system. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the customer associated with the payment. If the ID is + not provided in the `CreatePayment` request that was used to create the `Payment`, + Square may use information in the request + (such as the billing and shipping address, email address, and payment source) + to identify a matching customer profile in the Customer Directory. + If found, the profile ID is used. If a profile is not found, the + API attempts to create an + [instant profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + If the API cannot create an + instant profile (either because the seller has disabled it or the + seller's region prevents creating it), this field remains unset. Note that + this process is asynchronous and it may take some time before a + customer ID is added to the payment. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + __Deprecated__: Use `Payment.team_member_id` instead. + + An optional ID of the employee associated with taking the payment. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment. + """ + + refund_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of `refund_id`s identifying refunds for the payment. + """ + + risk_evaluation: typing.Optional[RiskEvaluation] = pydantic.Field(default=None) + """ + Provides information about the risk associated with the payment, as determined by Square. + This field is present for payments to sellers that have opted in to receive risk + evaluations. + """ + + terminal_checkout_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID for a Terminal checkout that is associated with the payment. + """ + + buyer_email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The buyer's email address. + """ + + billing_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The buyer's billing address. + """ + + shipping_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The buyer's shipping address. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional note to include when creating a payment. + """ + + statement_description_identifier: typing.Optional[str] = pydantic.Field(default=None) + """ + Additional payment information that gets added to the customer's card statement + as part of the statement description. + + Note that the `statement_description_identifier` might get truncated on the statement description + to fit the required information including the Square identifier (SQ *) and the name of the + seller taking the payment. + """ + + capabilities: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Actions that can be performed on this payment: + - `EDIT_AMOUNT_UP` - The payment amount can be edited up. + - `EDIT_AMOUNT_DOWN` - The payment amount can be edited down. + - `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up. + - `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down. + - `EDIT_DELAY_ACTION` - The delay_action can be edited. + """ + + receipt_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The payment's receipt number. + The field is missing if a payment is canceled. + """ + + receipt_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL for the payment's receipt. + The field is only populated for COMPLETED payments. + """ + + device_details: typing.Optional[DeviceDetails] = pydantic.Field(default=None) + """ + Details about the device that took the payment. + """ + + application_details: typing.Optional[ApplicationDetails] = pydantic.Field(default=None) + """ + Details about the application that took the payment. + """ + + is_offline_payment: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether or not this payment was taken offline. + """ + + offline_payment_details: typing.Optional[OfflinePaymentDetails] = pydantic.Field(default=None) + """ + Additional information about the payment if it was taken offline. + """ + + version_token: typing.Optional[str] = pydantic.Field(default=None) + """ + Used for optimistic concurrency. This opaque token identifies a specific version of the + `Payment` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_app_fee_refund_detail.py b/src/square/types/payment_balance_activity_app_fee_refund_detail.py new file mode 100644 index 00000000..604033ab --- /dev/null +++ b/src/square/types/payment_balance_activity_app_fee_refund_detail.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityAppFeeRefundDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + refund_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the refund associated with this activity. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location of the merchant associated with the payment refund activity + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_app_fee_revenue_detail.py b/src/square/types/payment_balance_activity_app_fee_revenue_detail.py new file mode 100644 index 00000000..4f7b5ceb --- /dev/null +++ b/src/square/types/payment_balance_activity_app_fee_revenue_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityAppFeeRevenueDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location of the merchant associated with the payment activity + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_automatic_savings_detail.py b/src/square/types/payment_balance_activity_automatic_savings_detail.py new file mode 100644 index 00000000..63aea8d9 --- /dev/null +++ b/src/square/types/payment_balance_activity_automatic_savings_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityAutomaticSavingsDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + payout_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payout associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_automatic_savings_reversed_detail.py b/src/square/types/payment_balance_activity_automatic_savings_reversed_detail.py new file mode 100644 index 00000000..5c9d7534 --- /dev/null +++ b/src/square/types/payment_balance_activity_automatic_savings_reversed_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityAutomaticSavingsReversedDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + payout_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payout associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_charge_detail.py b/src/square/types/payment_balance_activity_charge_detail.py new file mode 100644 index 00000000..14165a91 --- /dev/null +++ b/src/square/types/payment_balance_activity_charge_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityChargeDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_deposit_fee_detail.py b/src/square/types/payment_balance_activity_deposit_fee_detail.py new file mode 100644 index 00000000..0e3eee97 --- /dev/null +++ b/src/square/types/payment_balance_activity_deposit_fee_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityDepositFeeDetail(UncheckedBaseModel): + payout_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payout that triggered this deposit fee activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_deposit_fee_reversed_detail.py b/src/square/types/payment_balance_activity_deposit_fee_reversed_detail.py new file mode 100644 index 00000000..688a29e3 --- /dev/null +++ b/src/square/types/payment_balance_activity_deposit_fee_reversed_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityDepositFeeReversedDetail(UncheckedBaseModel): + payout_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payout that triggered this deposit fee activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_dispute_detail.py b/src/square/types/payment_balance_activity_dispute_detail.py new file mode 100644 index 00000000..529c7c80 --- /dev/null +++ b/src/square/types/payment_balance_activity_dispute_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityDisputeDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + dispute_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the dispute associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_fee_detail.py b/src/square/types/payment_balance_activity_fee_detail.py new file mode 100644 index 00000000..4453b601 --- /dev/null +++ b/src/square/types/payment_balance_activity_fee_detail.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityFeeDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity + This will only be populated when a principal LedgerEntryToken is also populated. + If the fee is independent (there is no principal LedgerEntryToken) then this will likely not + be populated. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_free_processing_detail.py b/src/square/types/payment_balance_activity_free_processing_detail.py new file mode 100644 index 00000000..545d2b2f --- /dev/null +++ b/src/square/types/payment_balance_activity_free_processing_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityFreeProcessingDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_hold_adjustment_detail.py b/src/square/types/payment_balance_activity_hold_adjustment_detail.py new file mode 100644 index 00000000..a64024d3 --- /dev/null +++ b/src/square/types/payment_balance_activity_hold_adjustment_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityHoldAdjustmentDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_open_dispute_detail.py b/src/square/types/payment_balance_activity_open_dispute_detail.py new file mode 100644 index 00000000..6f1f9628 --- /dev/null +++ b/src/square/types/payment_balance_activity_open_dispute_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityOpenDisputeDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + dispute_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the dispute associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_other_adjustment_detail.py b/src/square/types/payment_balance_activity_other_adjustment_detail.py new file mode 100644 index 00000000..6fff84b7 --- /dev/null +++ b/src/square/types/payment_balance_activity_other_adjustment_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityOtherAdjustmentDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_other_detail.py b/src/square/types/payment_balance_activity_other_detail.py new file mode 100644 index 00000000..3b63d70b --- /dev/null +++ b/src/square/types/payment_balance_activity_other_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityOtherDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_refund_detail.py b/src/square/types/payment_balance_activity_refund_detail.py new file mode 100644 index 00000000..a23f7dad --- /dev/null +++ b/src/square/types/payment_balance_activity_refund_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityRefundDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + refund_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the refund associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_release_adjustment_detail.py b/src/square/types/payment_balance_activity_release_adjustment_detail.py new file mode 100644 index 00000000..f2eb2bbf --- /dev/null +++ b/src/square/types/payment_balance_activity_release_adjustment_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityReleaseAdjustmentDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_reserve_hold_detail.py b/src/square/types/payment_balance_activity_reserve_hold_detail.py new file mode 100644 index 00000000..cfb81ba9 --- /dev/null +++ b/src/square/types/payment_balance_activity_reserve_hold_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityReserveHoldDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_reserve_release_detail.py b/src/square/types/payment_balance_activity_reserve_release_detail.py new file mode 100644 index 00000000..ab7a4c54 --- /dev/null +++ b/src/square/types/payment_balance_activity_reserve_release_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityReserveReleaseDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_square_capital_payment_detail.py b/src/square/types/payment_balance_activity_square_capital_payment_detail.py new file mode 100644 index 00000000..b198bba5 --- /dev/null +++ b/src/square/types/payment_balance_activity_square_capital_payment_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivitySquareCapitalPaymentDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_square_capital_reversed_payment_detail.py b/src/square/types/payment_balance_activity_square_capital_reversed_payment_detail.py new file mode 100644 index 00000000..f19c008f --- /dev/null +++ b/src/square/types/payment_balance_activity_square_capital_reversed_payment_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivitySquareCapitalReversedPaymentDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_square_payroll_transfer_detail.py b/src/square/types/payment_balance_activity_square_payroll_transfer_detail.py new file mode 100644 index 00000000..82368631 --- /dev/null +++ b/src/square/types/payment_balance_activity_square_payroll_transfer_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivitySquarePayrollTransferDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_square_payroll_transfer_reversed_detail.py b/src/square/types/payment_balance_activity_square_payroll_transfer_reversed_detail.py new file mode 100644 index 00000000..5c0c983f --- /dev/null +++ b/src/square/types/payment_balance_activity_square_payroll_transfer_reversed_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivitySquarePayrollTransferReversedDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_tax_on_fee_detail.py b/src/square/types/payment_balance_activity_tax_on_fee_detail.py new file mode 100644 index 00000000..115e8334 --- /dev/null +++ b/src/square/types/payment_balance_activity_tax_on_fee_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityTaxOnFeeDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + tax_rate_description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the tax rate being applied. For example: "GST", "HST". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_third_party_fee_detail.py b/src/square/types/payment_balance_activity_third_party_fee_detail.py new file mode 100644 index 00000000..ebbf52df --- /dev/null +++ b/src/square/types/payment_balance_activity_third_party_fee_detail.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityThirdPartyFeeDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_balance_activity_third_party_fee_refund_detail.py b/src/square/types/payment_balance_activity_third_party_fee_refund_detail.py new file mode 100644 index 00000000..6952de9c --- /dev/null +++ b/src/square/types/payment_balance_activity_third_party_fee_refund_detail.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentBalanceActivityThirdPartyFeeRefundDetail(UncheckedBaseModel): + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this activity. + """ + + refund_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The public refund id associated with this activity. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_link.py b/src/square/types/payment_link.py new file mode 100644 index 00000000..ed449bf8 --- /dev/null +++ b/src/square/types/payment_link.py @@ -0,0 +1,78 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .checkout_options import CheckoutOptions +from .pre_populated_data import PrePopulatedData +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentLink(UncheckedBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the payment link. + """ + + version: int = pydantic.Field() + """ + The Square-assigned version number, which is incremented each time an update is committed to the payment link. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The optional description of the `payment_link` object. + It is primarily for use by your application and is not used anywhere. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the order associated with the payment link. + """ + + checkout_options: typing.Optional[CheckoutOptions] = pydantic.Field(default=None) + """ + The checkout options configured for the payment link. + For more information, see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + """ + + pre_populated_data: typing.Optional[PrePopulatedData] = pydantic.Field(default=None) + """ + Describes buyer data to prepopulate + on the checkout page. + """ + + url: typing.Optional[str] = pydantic.Field(default=None) + """ + The shortened URL of the payment link. + """ + + long_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The long URL of the payment link. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the payment link was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the payment link was last updated, in RFC 3339 format. + """ + + payment_note: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional note. After Square processes the payment, this note is added to the + resulting `Payment`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_link_related_resources.py b/src/square/types/payment_link_related_resources.py new file mode 100644 index 00000000..03a09dd3 --- /dev/null +++ b/src/square/types/payment_link_related_resources.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .order import Order +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentLinkRelatedResources(UncheckedBaseModel): + orders: typing.Optional[typing.List[Order]] = pydantic.Field(default=None) + """ + The order associated with the payment link. + """ + + subscription_plans: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + The subscription plan associated with the payment link. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_options.py b/src/square/types/payment_options.py new file mode 100644 index 00000000..b2df7da8 --- /dev/null +++ b/src/square/types/payment_options.py @@ -0,0 +1,71 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .payment_options_delay_action import PaymentOptionsDelayAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentOptions(UncheckedBaseModel): + autocomplete: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the `Payment` objects created from this `TerminalCheckout` are + automatically `COMPLETED` or left in an `APPROVED` state for later modification. + + Default: true + """ + + delay_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The duration of time after the payment's creation when Square automatically resolves the + payment. This automatic resolution applies only to payments that do not reach a terminal state + (`COMPLETED` or `CANCELED`) before the `delay_duration` time period. + + This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value + of 1 minute and a maximum value of 36 hours. This feature is only supported for card payments, + and all payments will be considered card-present. + + This parameter can only be set for a delayed capture payment (`autocomplete=false`). For more + information, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: "PT36H" (36 hours) from the creation time + """ + + accept_partial_authorization: typing.Optional[bool] = pydantic.Field(default=None) + """ + If set to `true` and charging a Square Gift Card, a payment might be returned with + `amount_money` equal to less than what was requested. For example, a request for $20 when charging + a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose + to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card + payment. + + This parameter can only be set for a delayed capture payment (`autocomplete=false`). + + For more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards). + + Default: false + """ + + delay_action: typing.Optional[PaymentOptionsDelayAction] = pydantic.Field(default=None) + """ + The action to be applied to the `Payment` when the delay_duration has elapsed. + The action must be CANCEL or COMPLETE. + + The action cannot be set to COMPLETE if an `order_id` is present on the TerminalCheckout. + + This parameter can only be set for a delayed capture payment (`autocomplete=false`). For more + information, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold). + + Default: CANCEL + See [DelayAction](#type-delayaction) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payment_options_delay_action.py b/src/square/types/payment_options_delay_action.py new file mode 100644 index 00000000..55756c20 --- /dev/null +++ b/src/square/types/payment_options_delay_action.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +PaymentOptionsDelayAction = typing.Union[typing.Literal["CANCEL", "COMPLETE"], typing.Any] diff --git a/src/square/types/payment_refund.py b/src/square/types/payment_refund.py new file mode 100644 index 00000000..25669f65 --- /dev/null +++ b/src/square/types/payment_refund.py @@ -0,0 +1,117 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .destination_details import DestinationDetails +from .money import Money +from .processing_fee import ProcessingFee +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PaymentRefund(UncheckedBaseModel): + """ + Represents a refund of a payment made using Square. Contains information about + the original payment and the amount of money refunded. + """ + + id: str = pydantic.Field() + """ + The unique ID for this refund, generated by Square. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The refund's status: + - `PENDING` - Awaiting approval. + - `COMPLETED` - Successfully completed. + - `REJECTED` - The refund was rejected. + - `FAILED` - An error occurred. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location ID associated with the payment this refund is attached to. + """ + + unlinked: typing.Optional[bool] = pydantic.Field(default=None) + """ + Flag indicating whether or not the refund is linked to an existing payment in Square. + """ + + destination_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The destination type for this refund. + + Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`, + `EXTERNAL`, and `SQUARE_ACCOUNT`. + """ + + destination_details: typing.Optional[DestinationDetails] = pydantic.Field(default=None) + """ + Contains information about the refund destination. This field is populated only if + `destination_id` is defined in the `RefundPayment` request. + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money refunded. This amount is specified in the smallest denomination + of the applicable currency (for example, US dollar amounts are specified in cents). + """ + + app_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money the application developer contributed to help cover the refunded amount. + This amount is specified in the smallest denomination of the applicable currency (for example, + US dollar amounts are specified in cents). For more information, see + [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + """ + + processing_fee: typing.Optional[typing.List[ProcessingFee]] = pydantic.Field(default=None) + """ + Processing fees and fee adjustments assessed by Square for this refund. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the payment associated with this refund. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the order associated with the refund. + """ + + reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The reason for the refund. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the refund was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the refund was last updated, in RFC 3339 format. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID of the team member associated with taking the payment. + """ + + terminal_refund_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID for a Terminal refund. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payout.py b/src/square/types/payout.py new file mode 100644 index 00000000..1ba629d3 --- /dev/null +++ b/src/square/types/payout.py @@ -0,0 +1,91 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .payout_status import PayoutStatus +from .money import Money +from .destination import Destination +from .payout_type import PayoutType +from .payout_fee import PayoutFee +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Payout(UncheckedBaseModel): + """ + An accounting of the amount owed the seller and record of the actual transfer to their + external bank account or to the Square balance. + """ + + id: str = pydantic.Field() + """ + A unique ID for the payout. + """ + + status: typing.Optional[PayoutStatus] = pydantic.Field(default=None) + """ + Indicates the payout status. + See [PayoutStatus](#type-payoutstatus) for possible values + """ + + location_id: str = pydantic.Field() + """ + The ID of the location associated with the payout. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the payout was last updated, in RFC 3339 format. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money involved in the payout. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero. + """ + + destination: typing.Optional[Destination] = pydantic.Field(default=None) + """ + Information about the banking destination (such as a bank account, Square checking account, or debit card) + against which the payout was made. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version number, which is incremented each time an update is made to this payout record. + The version number helps developers receive event notifications or feeds out of order. + """ + + type: typing.Optional[PayoutType] = pydantic.Field(default=None) + """ + Indicates the payout type. + See [PayoutType](#type-payouttype) for possible values + """ + + payout_fee: typing.Optional[typing.List[PayoutFee]] = pydantic.Field(default=None) + """ + A list of transfer fees and any taxes on the fees assessed by Square for this payout. + """ + + arrival_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. + """ + + end_to_end_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payout_entry.py b/src/square/types/payout_entry.py new file mode 100644 index 00000000..3e5c206b --- /dev/null +++ b/src/square/types/payout_entry.py @@ -0,0 +1,248 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .activity_type import ActivityType +from .money import Money +from .payment_balance_activity_app_fee_revenue_detail import PaymentBalanceActivityAppFeeRevenueDetail +from .payment_balance_activity_app_fee_refund_detail import PaymentBalanceActivityAppFeeRefundDetail +from .payment_balance_activity_automatic_savings_detail import PaymentBalanceActivityAutomaticSavingsDetail +from .payment_balance_activity_automatic_savings_reversed_detail import ( + PaymentBalanceActivityAutomaticSavingsReversedDetail, +) +from .payment_balance_activity_charge_detail import PaymentBalanceActivityChargeDetail +from .payment_balance_activity_deposit_fee_detail import PaymentBalanceActivityDepositFeeDetail +from .payment_balance_activity_deposit_fee_reversed_detail import PaymentBalanceActivityDepositFeeReversedDetail +from .payment_balance_activity_dispute_detail import PaymentBalanceActivityDisputeDetail +from .payment_balance_activity_fee_detail import PaymentBalanceActivityFeeDetail +from .payment_balance_activity_free_processing_detail import PaymentBalanceActivityFreeProcessingDetail +from .payment_balance_activity_hold_adjustment_detail import PaymentBalanceActivityHoldAdjustmentDetail +from .payment_balance_activity_open_dispute_detail import PaymentBalanceActivityOpenDisputeDetail +from .payment_balance_activity_other_detail import PaymentBalanceActivityOtherDetail +from .payment_balance_activity_other_adjustment_detail import PaymentBalanceActivityOtherAdjustmentDetail +from .payment_balance_activity_refund_detail import PaymentBalanceActivityRefundDetail +from .payment_balance_activity_release_adjustment_detail import PaymentBalanceActivityReleaseAdjustmentDetail +from .payment_balance_activity_reserve_hold_detail import PaymentBalanceActivityReserveHoldDetail +from .payment_balance_activity_reserve_release_detail import PaymentBalanceActivityReserveReleaseDetail +from .payment_balance_activity_square_capital_payment_detail import PaymentBalanceActivitySquareCapitalPaymentDetail +from .payment_balance_activity_square_capital_reversed_payment_detail import ( + PaymentBalanceActivitySquareCapitalReversedPaymentDetail, +) +from .payment_balance_activity_tax_on_fee_detail import PaymentBalanceActivityTaxOnFeeDetail +from .payment_balance_activity_third_party_fee_detail import PaymentBalanceActivityThirdPartyFeeDetail +from .payment_balance_activity_third_party_fee_refund_detail import PaymentBalanceActivityThirdPartyFeeRefundDetail +from .payment_balance_activity_square_payroll_transfer_detail import PaymentBalanceActivitySquarePayrollTransferDetail +from .payment_balance_activity_square_payroll_transfer_reversed_detail import ( + PaymentBalanceActivitySquarePayrollTransferReversedDetail, +) +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PayoutEntry(UncheckedBaseModel): + """ + One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity. + The total amount of the payout will equal the sum of the payout entries for a batch payout + """ + + id: str = pydantic.Field() + """ + A unique ID for the payout entry. + """ + + payout_id: str = pydantic.Field() + """ + The ID of the payout entries’ associated payout. + """ + + effective_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the payout entry affected the balance, in RFC 3339 format. + """ + + type: typing.Optional[ActivityType] = pydantic.Field(default=None) + """ + The type of activity associated with this payout entry. + See [ActivityType](#type-activitytype) for possible values + """ + + gross_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of money involved in this payout entry. + """ + + fee_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of Square fees associated with this payout entry. + """ + + net_amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The net proceeds from this transaction after any fees. + """ + + type_app_fee_revenue_details: typing.Optional[PaymentBalanceActivityAppFeeRevenueDetail] = pydantic.Field( + default=None + ) + """ + Details of any developer app fee revenue generated on a payment. + """ + + type_app_fee_refund_details: typing.Optional[PaymentBalanceActivityAppFeeRefundDetail] = pydantic.Field( + default=None + ) + """ + Details of a refund for an app fee on a payment. + """ + + type_automatic_savings_details: typing.Optional[PaymentBalanceActivityAutomaticSavingsDetail] = pydantic.Field( + default=None + ) + """ + Details of any automatic transfer from the payment processing balance to the Square Savings account. These are, generally, proportional to the merchant's sales. + """ + + type_automatic_savings_reversed_details: typing.Optional[PaymentBalanceActivityAutomaticSavingsReversedDetail] = ( + pydantic.Field(default=None) + ) + """ + Details of any automatic transfer from the Square Savings account back to the processing balance. These are, generally, proportional to the merchant's refunds. + """ + + type_charge_details: typing.Optional[PaymentBalanceActivityChargeDetail] = pydantic.Field(default=None) + """ + Details of credit card payment captures. + """ + + type_deposit_fee_details: typing.Optional[PaymentBalanceActivityDepositFeeDetail] = pydantic.Field(default=None) + """ + Details of any fees involved with deposits such as for instant deposits. + """ + + type_deposit_fee_reversed_details: typing.Optional[PaymentBalanceActivityDepositFeeReversedDetail] = pydantic.Field( + default=None + ) + """ + Details of any reversal or refund of fees involved with deposits such as for instant deposits. + """ + + type_dispute_details: typing.Optional[PaymentBalanceActivityDisputeDetail] = pydantic.Field(default=None) + """ + Details of any balance change due to a dispute event. + """ + + type_fee_details: typing.Optional[PaymentBalanceActivityFeeDetail] = pydantic.Field(default=None) + """ + Details of adjustments due to the Square processing fee. + """ + + type_free_processing_details: typing.Optional[PaymentBalanceActivityFreeProcessingDetail] = pydantic.Field( + default=None + ) + """ + Square offers Free Payments Processing for a variety of business scenarios including seller referral or when Square wants to apologize for a bug, customer service, repricing complication, and so on. This entry represents details of any credit to the merchant for the purposes of Free Processing. + """ + + type_hold_adjustment_details: typing.Optional[PaymentBalanceActivityHoldAdjustmentDetail] = pydantic.Field( + default=None + ) + """ + Details of any adjustment made by Square related to the holding or releasing of a payment. + """ + + type_open_dispute_details: typing.Optional[PaymentBalanceActivityOpenDisputeDetail] = pydantic.Field(default=None) + """ + Details of any open disputes. + """ + + type_other_details: typing.Optional[PaymentBalanceActivityOtherDetail] = pydantic.Field(default=None) + """ + Details of any other type that does not belong in the rest of the types. + """ + + type_other_adjustment_details: typing.Optional[PaymentBalanceActivityOtherAdjustmentDetail] = pydantic.Field( + default=None + ) + """ + Details of any other type of adjustments that don't fall under existing types. + """ + + type_refund_details: typing.Optional[PaymentBalanceActivityRefundDetail] = pydantic.Field(default=None) + """ + Details of a refund for an existing card payment. + """ + + type_release_adjustment_details: typing.Optional[PaymentBalanceActivityReleaseAdjustmentDetail] = pydantic.Field( + default=None + ) + """ + Details of fees released for adjustments. + """ + + type_reserve_hold_details: typing.Optional[PaymentBalanceActivityReserveHoldDetail] = pydantic.Field(default=None) + """ + Details of fees paid for funding risk reserve. + """ + + type_reserve_release_details: typing.Optional[PaymentBalanceActivityReserveReleaseDetail] = pydantic.Field( + default=None + ) + """ + Details of fees released from risk reserve. + """ + + type_square_capital_payment_details: typing.Optional[PaymentBalanceActivitySquareCapitalPaymentDetail] = ( + pydantic.Field(default=None) + ) + """ + Details of capital merchant cash advance (MCA) assessments. These are, generally, proportional to the merchant's sales but may be issued for other reasons related to the MCA. + """ + + type_square_capital_reversed_payment_details: typing.Optional[ + PaymentBalanceActivitySquareCapitalReversedPaymentDetail + ] = pydantic.Field(default=None) + """ + Details of capital merchant cash advance (MCA) assessment refunds. These are, generally, proportional to the merchant's refunds but may be issued for other reasons related to the MCA. + """ + + type_tax_on_fee_details: typing.Optional[PaymentBalanceActivityTaxOnFeeDetail] = pydantic.Field(default=None) + """ + Details of tax paid on fee amounts. + """ + + type_third_party_fee_details: typing.Optional[PaymentBalanceActivityThirdPartyFeeDetail] = pydantic.Field( + default=None + ) + """ + Details of fees collected by a 3rd party platform. + """ + + type_third_party_fee_refund_details: typing.Optional[PaymentBalanceActivityThirdPartyFeeRefundDetail] = ( + pydantic.Field(default=None) + ) + """ + Details of refunded fees from a 3rd party platform. + """ + + type_square_payroll_transfer_details: typing.Optional[PaymentBalanceActivitySquarePayrollTransferDetail] = ( + pydantic.Field(default=None) + ) + """ + Details of a payroll payment that was transferred to a team member’s bank account. + """ + + type_square_payroll_transfer_reversed_details: typing.Optional[ + PaymentBalanceActivitySquarePayrollTransferReversedDetail + ] = pydantic.Field(default=None) + """ + Details of a payroll payment to a team member’s bank account that was deposited back to the seller’s account by Square. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payout_fee.py b/src/square/types/payout_fee.py new file mode 100644 index 00000000..68ac46dc --- /dev/null +++ b/src/square/types/payout_fee.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .money import Money +import pydantic +from .payout_fee_type import PayoutFeeType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PayoutFee(UncheckedBaseModel): + """ + Represents a payout fee that can incur as part of a payout. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The money amount of the payout fee. + """ + + effective_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the fee takes effect, in RFC 3339 format. + """ + + type: typing.Optional[PayoutFeeType] = pydantic.Field(default=None) + """ + The type of fee assessed as part of the payout. + See [PayoutFeeType](#type-payoutfeetype) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/payout_fee_type.py b/src/square/types/payout_fee_type.py new file mode 100644 index 00000000..d51e857c --- /dev/null +++ b/src/square/types/payout_fee_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +PayoutFeeType = typing.Union[typing.Literal["TRANSFER_FEE", "TAX_ON_TRANSFER_FEE"], typing.Any] diff --git a/src/square/types/payout_status.py b/src/square/types/payout_status.py new file mode 100644 index 00000000..86fe22a6 --- /dev/null +++ b/src/square/types/payout_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +PayoutStatus = typing.Union[typing.Literal["SENT", "FAILED", "PAID"], typing.Any] diff --git a/src/square/types/payout_type.py b/src/square/types/payout_type.py new file mode 100644 index 00000000..ac074aa7 --- /dev/null +++ b/src/square/types/payout_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +PayoutType = typing.Union[typing.Literal["BATCH", "SIMPLE"], typing.Any] diff --git a/src/square/types/phase.py b/src/square/types/phase.py new file mode 100644 index 00000000..10831034 --- /dev/null +++ b/src/square/types/phase.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Phase(UncheckedBaseModel): + """ + Represents a phase, which can override subscription phases as defined by plan_id + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + id of subscription phase + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + index of phase in total subscription plan + """ + + order_template_id: typing.Optional[str] = pydantic.Field(default=None) + """ + id of order to be used in billing + """ + + plan_phase_uid: typing.Optional[str] = pydantic.Field(default=None) + """ + the uid from the plan's phase in catalog + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/phase_input.py b/src/square/types/phase_input.py new file mode 100644 index 00000000..88cf50e0 --- /dev/null +++ b/src/square/types/phase_input.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PhaseInput(UncheckedBaseModel): + """ + Represents the arguments used to construct a new phase. + """ + + ordinal: int = pydantic.Field() + """ + index of phase in total subscription plan + """ + + order_template_id: typing.Optional[str] = pydantic.Field(default=None) + """ + id of order to be used in billing + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/pre_populated_data.py b/src/square/types/pre_populated_data.py new file mode 100644 index 00000000..1519304b --- /dev/null +++ b/src/square/types/pre_populated_data.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PrePopulatedData(UncheckedBaseModel): + """ + Describes buyer data to prepopulate in the payment form. + For more information, + see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). + """ + + buyer_email: typing.Optional[str] = pydantic.Field(default=None) + """ + The buyer email to prepopulate in the payment form. + """ + + buyer_phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The buyer phone number to prepopulate in the payment form. + """ + + buyer_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The buyer address to prepopulate in the payment form. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/processing_fee.py b/src/square/types/processing_fee.py new file mode 100644 index 00000000..d80dba0b --- /dev/null +++ b/src/square/types/processing_fee.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ProcessingFee(UncheckedBaseModel): + """ + Represents the Square processing fee. + """ + + effective_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the fee takes effect, in RFC 3339 format. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The fee amount, which might be negative, that is assessed or adjusted by Square. + + Positive values represent funds being assessed, while negative values represent + funds being returned. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/product.py b/src/square/types/product.py new file mode 100644 index 00000000..04a37897 --- /dev/null +++ b/src/square/types/product.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +Product = typing.Union[ + typing.Literal[ + "SQUARE_POS", + "EXTERNAL_API", + "BILLING", + "APPOINTMENTS", + "INVOICES", + "ONLINE_STORE", + "PAYROLL", + "DASHBOARD", + "ITEM_LIBRARY_IMPORT", + "OTHER", + ], + typing.Any, +] diff --git a/src/square/types/product_type.py b/src/square/types/product_type.py new file mode 100644 index 00000000..94753505 --- /dev/null +++ b/src/square/types/product_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ProductType = typing.Literal["TERMINAL_API"] diff --git a/src/square/types/publish_invoice_response.py b/src/square/types/publish_invoice_response.py new file mode 100644 index 00000000..5daa7639 --- /dev/null +++ b/src/square/types/publish_invoice_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class PublishInvoiceResponse(UncheckedBaseModel): + """ + Describes a `PublishInvoice` response. + """ + + invoice: typing.Optional[Invoice] = pydantic.Field(default=None) + """ + The published invoice. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/qr_code_options.py b/src/square/types/qr_code_options.py new file mode 100644 index 00000000..dafd496e --- /dev/null +++ b/src/square/types/qr_code_options.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class QrCodeOptions(UncheckedBaseModel): + """ + Fields to describe the action that displays QR-Codes. + """ + + title: str = pydantic.Field() + """ + The title text to display in the QR code flow on the Terminal. + """ + + body: str = pydantic.Field() + """ + The body text to display in the QR code flow on the Terminal. + """ + + barcode_contents: str = pydantic.Field() + """ + The text representation of the data to show in the QR code + as UTF8-encoded data. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/quick_pay.py b/src/square/types/quick_pay.py new file mode 100644 index 00000000..30848383 --- /dev/null +++ b/src/square/types/quick_pay.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class QuickPay(UncheckedBaseModel): + """ + Describes an ad hoc item and price to generate a quick pay checkout link. + For more information, + see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). + """ + + name: str = pydantic.Field() + """ + The ad hoc item name. In the resulting `Order`, this name appears as the line item name. + """ + + price_money: Money = pydantic.Field() + """ + The price of the item. + """ + + location_id: str = pydantic.Field() + """ + The ID of the business location the checkout is associated with. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/range.py b/src/square/types/range.py new file mode 100644 index 00000000..fb2ed0c0 --- /dev/null +++ b/src/square/types/range.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Range(UncheckedBaseModel): + """ + The range of a number value between the specified lower and upper bounds. + """ + + min: typing.Optional[str] = pydantic.Field(default=None) + """ + The lower bound of the number range. At least one of `min` or `max` must be specified. + If unspecified, the results will have no minimum value. + """ + + max: typing.Optional[str] = pydantic.Field(default=None) + """ + The upper bound of the number range. At least one of `min` or `max` must be specified. + If unspecified, the results will have no maximum value. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/receipt_options.py b/src/square/types/receipt_options.py new file mode 100644 index 00000000..2d9b6389 --- /dev/null +++ b/src/square/types/receipt_options.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ReceiptOptions(UncheckedBaseModel): + """ + Describes receipt action fields. + """ + + payment_id: str = pydantic.Field() + """ + The reference to the Square payment ID for the receipt. + """ + + print_only: typing.Optional[bool] = pydantic.Field(default=None) + """ + Instructs the device to print the receipt without displaying the receipt selection screen. + Requires `printer_enabled` set to true. + Defaults to false. + """ + + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) + """ + Identify the receipt as a reprint rather than an original receipt. + Defaults to false. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/redeem_loyalty_reward_response.py b/src/square/types/redeem_loyalty_reward_response.py new file mode 100644 index 00000000..93d60562 --- /dev/null +++ b/src/square/types/redeem_loyalty_reward_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_event import LoyaltyEvent +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RedeemLoyaltyRewardResponse(UncheckedBaseModel): + """ + A response that includes the `LoyaltyEvent` published for redeeming the reward. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + event: typing.Optional[LoyaltyEvent] = pydantic.Field(default=None) + """ + The `LoyaltyEvent` for redeeming the reward. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/refund.py b/src/square/types/refund.py new file mode 100644 index 00000000..1cf6082e --- /dev/null +++ b/src/square/types/refund.py @@ -0,0 +1,77 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .money import Money +from .refund_status import RefundStatus +from .additional_recipient import AdditionalRecipient +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Refund(UncheckedBaseModel): + """ + Represents a refund processed for a Square transaction. + """ + + id: str = pydantic.Field() + """ + The refund's unique ID. + """ + + location_id: str = pydantic.Field() + """ + The ID of the refund's associated location. + """ + + transaction_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the transaction that the refunded tender is part of. + """ + + tender_id: str = pydantic.Field() + """ + The ID of the refunded tender. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp for when the refund was created, in RFC 3339 format. + """ + + reason: str = pydantic.Field() + """ + The reason for the refund being issued. + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money refunded to the buyer. + """ + + status: RefundStatus = pydantic.Field() + """ + The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, + or `FAILED`). + See [RefundStatus](#type-refundstatus) for possible values + """ + + processing_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of Square processing fee money refunded to the *merchant*. + """ + + additional_recipients: typing.Optional[typing.List[AdditionalRecipient]] = pydantic.Field(default=None) + """ + Additional recipients (other than the merchant) receiving a portion of this refund. + For example, fees assessed on a refund of a purchase by a third party integration. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/refund_payment_response.py b/src/square/types/refund_payment_response.py new file mode 100644 index 00000000..b2bbd941 --- /dev/null +++ b/src/square/types/refund_payment_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment_refund import PaymentRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RefundPaymentResponse(UncheckedBaseModel): + """ + Defines the response returned by + [RefundPayment](api-endpoint:Refunds-RefundPayment). + + If there are errors processing the request, the `refund` field might not be + present, or it might be present with a status of `FAILED`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refund: typing.Optional[PaymentRefund] = pydantic.Field(default=None) + """ + The successfully created `PaymentRefund`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/refund_status.py b/src/square/types/refund_status.py new file mode 100644 index 00000000..c9e6f158 --- /dev/null +++ b/src/square/types/refund_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +RefundStatus = typing.Union[typing.Literal["PENDING", "APPROVED", "REJECTED", "FAILED"], typing.Any] diff --git a/src/square/types/register_domain_response.py b/src/square/types/register_domain_response.py new file mode 100644 index 00000000..665f01de --- /dev/null +++ b/src/square/types/register_domain_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .register_domain_response_status import RegisterDomainResponseStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RegisterDomainResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain) endpoint. + + Either `errors` or `status` are present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + status: typing.Optional[RegisterDomainResponseStatus] = pydantic.Field(default=None) + """ + The status of the domain registration. + + See [RegisterDomainResponseStatus](entity:RegisterDomainResponseStatus) for possible values. + See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/register_domain_response_status.py b/src/square/types/register_domain_response_status.py new file mode 100644 index 00000000..d154ab93 --- /dev/null +++ b/src/square/types/register_domain_response_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +RegisterDomainResponseStatus = typing.Union[typing.Literal["PENDING", "VERIFIED"], typing.Any] diff --git a/src/square/types/remove_group_from_customer_response.py b/src/square/types/remove_group_from_customer_response.py new file mode 100644 index 00000000..573269e1 --- /dev/null +++ b/src/square/types/remove_group_from_customer_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RemoveGroupFromCustomerResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer) + endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/resume_subscription_response.py b/src/square/types/resume_subscription_response.py new file mode 100644 index 00000000..6c16a406 --- /dev/null +++ b/src/square/types/resume_subscription_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from .subscription_action import SubscriptionAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ResumeSubscriptionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The resumed subscription. + """ + + actions: typing.Optional[typing.List[SubscriptionAction]] = pydantic.Field(default=None) + """ + A list of `RESUME` actions created by the request and scheduled for the subscription. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_booking_custom_attribute_definition_response.py b/src/square/types/retrieve_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..2a29bff1 --- /dev/null +++ b/src/square/types/retrieve_booking_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveBookingCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The retrieved custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_booking_custom_attribute_response.py b/src/square/types/retrieve_booking_custom_attribute_response.py new file mode 100644 index 00000000..789c2da7 --- /dev/null +++ b/src/square/types/retrieve_booking_custom_attribute_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveBookingCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_job_response.py b/src/square/types/retrieve_job_response.py new file mode 100644 index 00000000..653b8d1c --- /dev/null +++ b/src/square/types/retrieve_job_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .job import Job +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveJobResponse(UncheckedBaseModel): + """ + Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) response. Either `job` or `errors` + is present in the response. + """ + + job: typing.Optional[Job] = pydantic.Field(default=None) + """ + The retrieved job. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_location_booking_profile_response.py b/src/square/types/retrieve_location_booking_profile_response.py new file mode 100644 index 00000000..06b327cd --- /dev/null +++ b/src/square/types/retrieve_location_booking_profile_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .location_booking_profile import LocationBookingProfile +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveLocationBookingProfileResponse(UncheckedBaseModel): + location_booking_profile: typing.Optional[LocationBookingProfile] = pydantic.Field(default=None) + """ + The requested location booking profile. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_location_custom_attribute_definition_response.py b/src/square/types/retrieve_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..b877ec2f --- /dev/null +++ b/src/square/types/retrieve_location_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveLocationCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [RetrieveLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The retrieved custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_location_custom_attribute_response.py b/src/square/types/retrieve_location_custom_attribute_response.py new file mode 100644 index 00000000..017d6191 --- /dev/null +++ b/src/square/types/retrieve_location_custom_attribute_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveLocationCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [RetrieveLocationCustomAttribute](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_location_settings_response.py b/src/square/types/retrieve_location_settings_response.py new file mode 100644 index 00000000..27d70176 --- /dev/null +++ b/src/square/types/retrieve_location_settings_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .checkout_location_settings import CheckoutLocationSettings +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveLocationSettingsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + location_settings: typing.Optional[CheckoutLocationSettings] = pydantic.Field(default=None) + """ + The location settings. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_merchant_custom_attribute_definition_response.py b/src/square/types/retrieve_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..3e55a525 --- /dev/null +++ b/src/square/types/retrieve_merchant_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveMerchantCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The retrieved custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_merchant_custom_attribute_response.py b/src/square/types/retrieve_merchant_custom_attribute_response.py new file mode 100644 index 00000000..ef44cec8 --- /dev/null +++ b/src/square/types/retrieve_merchant_custom_attribute_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveMerchantCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, + the custom attribute definition is returned in the `definition` field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_merchant_settings_response.py b/src/square/types/retrieve_merchant_settings_response.py new file mode 100644 index 00000000..8128faab --- /dev/null +++ b/src/square/types/retrieve_merchant_settings_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .checkout_merchant_settings import CheckoutMerchantSettings +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveMerchantSettingsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + merchant_settings: typing.Optional[CheckoutMerchantSettings] = pydantic.Field(default=None) + """ + The merchant settings. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_order_custom_attribute_definition_response.py b/src/square/types/retrieve_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..058f8bc4 --- /dev/null +++ b/src/square/types/retrieve_order_custom_attribute_definition_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveOrderCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from getting an order custom attribute definition. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The retrieved custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_order_custom_attribute_response.py b/src/square/types/retrieve_order_custom_attribute_response.py new file mode 100644 index 00000000..65e111db --- /dev/null +++ b/src/square/types/retrieve_order_custom_attribute_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveOrderCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a response from getting an order custom attribute. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The retrieved custom attribute. If `with_definition` was set to `true` in the request, the custom attribute definition is returned in the `definition field. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/retrieve_token_status_response.py b/src/square/types/retrieve_token_status_response.py new file mode 100644 index 00000000..6f723947 --- /dev/null +++ b/src/square/types/retrieve_token_status_response.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RetrieveTokenStatusResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `RetrieveTokenStatus` endpoint. + """ + + scopes: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The list of scopes associated with an access token. + """ + + expires_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The date and time when the `access_token` expires, in RFC 3339 format. Empty if the token never expires. + """ + + client_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token. + """ + + merchant_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the authorizing merchant's business. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/revoke_token_response.py b/src/square/types/revoke_token_response.py new file mode 100644 index 00000000..736eb37a --- /dev/null +++ b/src/square/types/revoke_token_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RevokeTokenResponse(UncheckedBaseModel): + success: typing.Optional[bool] = pydantic.Field(default=None) + """ + If the request is successful, this is `true`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/risk_evaluation.py b/src/square/types/risk_evaluation.py new file mode 100644 index 00000000..53301ef7 --- /dev/null +++ b/src/square/types/risk_evaluation.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .risk_evaluation_risk_level import RiskEvaluationRiskLevel +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class RiskEvaluation(UncheckedBaseModel): + """ + Represents fraud risk information for the associated payment. + + When you take a payment through Square's Payments API (using the `CreatePayment` + endpoint), Square evaluates it and assigns a risk level to the payment. Sellers + can use this information to determine the course of action (for example, + provide the goods/services or refund the payment). + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when payment risk was evaluated, in RFC 3339 format. + """ + + risk_level: typing.Optional[RiskEvaluationRiskLevel] = pydantic.Field(default=None) + """ + The risk level associated with the payment + See [RiskEvaluationRiskLevel](#type-riskevaluationrisklevel) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/risk_evaluation_risk_level.py b/src/square/types/risk_evaluation_risk_level.py new file mode 100644 index 00000000..8802c596 --- /dev/null +++ b/src/square/types/risk_evaluation_risk_level.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +RiskEvaluationRiskLevel = typing.Union[typing.Literal["PENDING", "NORMAL", "MODERATE", "HIGH"], typing.Any] diff --git a/src/square/types/save_card_options.py b/src/square/types/save_card_options.py new file mode 100644 index 00000000..477320bb --- /dev/null +++ b/src/square/types/save_card_options.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SaveCardOptions(UncheckedBaseModel): + """ + Describes save-card action fields. + """ + + customer_id: str = pydantic.Field() + """ + The square-assigned ID of the customer linked to the saved card. + """ + + card_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the created card-on-file. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional user-defined reference ID that can be used to associate + this `Card` to another entity in an external system. For example, a customer + ID generated by a third-party system. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_availability_filter.py b/src/square/types/search_availability_filter.py new file mode 100644 index 00000000..6e7ef5ab --- /dev/null +++ b/src/square/types/search_availability_filter.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .time_range import TimeRange +import pydantic +import typing +from .segment_filter import SegmentFilter +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchAvailabilityFilter(UncheckedBaseModel): + """ + A query filter to search for buyer-accessible availabilities by. + """ + + start_at_range: TimeRange = pydantic.Field() + """ + The query expression to search for buy-accessible availabilities with their starting times falling within the specified time range. + The time range must be at least 24 hours and at most 32 days long. + For waitlist availabilities, the time range can be 0 or more up to 367 days long. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID. + This query expression cannot be set if `booking_id` is set. + """ + + segment_filters: typing.Optional[typing.List[SegmentFilter]] = pydantic.Field(default=None) + """ + The query expression to search for buyer-accessible availabilities matching the specified list of segment filters. + If the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability. + + This query expression cannot be set if `booking_id` is set. + """ + + booking_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value. + This is commonly used to reschedule an appointment. + If this expression is set, the `location_id` and `segment_filters` expressions cannot be set. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_availability_query.py b/src/square/types/search_availability_query.py new file mode 100644 index 00000000..04cb8413 --- /dev/null +++ b/src/square/types/search_availability_query.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .search_availability_filter import SearchAvailabilityFilter +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class SearchAvailabilityQuery(UncheckedBaseModel): + """ + The query used to search for buyer-accessible availabilities of bookings. + """ + + filter: SearchAvailabilityFilter = pydantic.Field() + """ + The query filter to search for buyer-accessible availabilities of existing bookings. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_availability_response.py b/src/square/types/search_availability_response.py new file mode 100644 index 00000000..241920f1 --- /dev/null +++ b/src/square/types/search_availability_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .availability import Availability +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchAvailabilityResponse(UncheckedBaseModel): + availabilities: typing.Optional[typing.List[Availability]] = pydantic.Field(default=None) + """ + List of appointment slots available for booking. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_catalog_items_request_stock_level.py b/src/square/types/search_catalog_items_request_stock_level.py new file mode 100644 index 00000000..ead5bc6a --- /dev/null +++ b/src/square/types/search_catalog_items_request_stock_level.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SearchCatalogItemsRequestStockLevel = typing.Union[typing.Literal["OUT", "LOW"], typing.Any] diff --git a/src/square/types/search_catalog_items_response.py b/src/square/types/search_catalog_items_response.py new file mode 100644 index 00000000..e69f2893 --- /dev/null +++ b/src/square/types/search_catalog_items_response.py @@ -0,0 +1,53 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchCatalogItemsResponse(UncheckedBaseModel): + """ + Defines the response body returned from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + items: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + Returned items matching the specified query expressions. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + Pagination token used in the next request to return more of the search result. + """ + + matched_variation_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Ids of returned item variations matching the specified query expression. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_catalog_objects_response.py b/src/square/types/search_catalog_objects_response.py new file mode 100644 index 00000000..909afd50 --- /dev/null +++ b/src/square/types/search_catalog_objects_response.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchCatalogObjectsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, this is the final response. + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + The CatalogObjects returned. + """ + + related_objects: typing.Optional[typing.List[CatalogObject]] = pydantic.Field(default=None) + """ + A list of CatalogObjects referenced by the objects in the `objects` field. + """ + + latest_time: typing.Optional[str] = pydantic.Field(default=None) + """ + When the associated product catalog was last updated. Will + match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_customers_response.py b/src/square/types/search_customers_response.py new file mode 100644 index 00000000..519220a1 --- /dev/null +++ b/src/square/types/search_customers_response.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer import Customer +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchCustomersResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the `SearchCustomers` endpoint. + + Either `errors` or `customers` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + customers: typing.Optional[typing.List[Customer]] = pydantic.Field(default=None) + """ + The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`). + Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) + are included in the response. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + A pagination cursor that can be used during subsequent calls + to `SearchCustomers` to retrieve the next set of results associated + with the original query. Pagination cursors are only present when + a request succeeds and additional results are available. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + count: typing.Optional[int] = pydantic.Field(default=None) + """ + The total count of customers associated with the Square account that match the search query. Only customer profiles with + public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is + present only if `count` is set to `true` in the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_events_filter.py b/src/square/types/search_events_filter.py new file mode 100644 index 00000000..92ed7fa2 --- /dev/null +++ b/src/square/types/search_events_filter.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .time_range import TimeRange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchEventsFilter(UncheckedBaseModel): + """ + Criteria to filter events by. + """ + + event_types: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Filter events by event types. + """ + + merchant_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Filter events by merchant. + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Filter events by location. + """ + + created_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + Filter events by when they were created. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_events_query.py b/src/square/types/search_events_query.py new file mode 100644 index 00000000..f0ef217e --- /dev/null +++ b/src/square/types/search_events_query.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_events_filter import SearchEventsFilter +import pydantic +from .search_events_sort import SearchEventsSort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchEventsQuery(UncheckedBaseModel): + """ + Contains query criteria for the search. + """ + + filter: typing.Optional[SearchEventsFilter] = pydantic.Field(default=None) + """ + Criteria to filter events by. + """ + + sort: typing.Optional[SearchEventsSort] = pydantic.Field(default=None) + """ + Criteria to sort events by. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_events_response.py b/src/square/types/search_events_response.py new file mode 100644 index 00000000..87b7ba17 --- /dev/null +++ b/src/square/types/search_events_response.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .event import Event +from .event_metadata import EventMetadata +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchEventsResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [SearchEvents](api-endpoint:Events-SearchEvents) endpoint. + + Note: if there are errors processing the request, the events field will not be + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + events: typing.Optional[typing.List[Event]] = pydantic.Field(default=None) + """ + The list of [Event](entity:Event)s returned by the search. + """ + + metadata: typing.Optional[typing.List[EventMetadata]] = pydantic.Field(default=None) + """ + Contains the metadata of an event. For more information, see [Event](entity:Event). + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_events_sort.py b/src/square/types/search_events_sort.py new file mode 100644 index 00000000..80fa5d0e --- /dev/null +++ b/src/square/types/search_events_sort.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_events_sort_field import SearchEventsSortField +import pydantic +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchEventsSort(UncheckedBaseModel): + """ + Criteria to sort events by. + """ + + field: typing.Optional[SearchEventsSortField] = pydantic.Field(default=None) + """ + Sort events by event types. + See [SearchEventsSortField](#type-searcheventssortfield) for possible values + """ + + order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The order to use for sorting the events. + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_events_sort_field.py b/src/square/types/search_events_sort_field.py new file mode 100644 index 00000000..3d052fc7 --- /dev/null +++ b/src/square/types/search_events_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SearchEventsSortField = typing.Literal["DEFAULT"] diff --git a/src/square/types/search_invoices_response.py b/src/square/types/search_invoices_response.py new file mode 100644 index 00000000..3127f917 --- /dev/null +++ b/src/square/types/search_invoices_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchInvoicesResponse(UncheckedBaseModel): + """ + Describes a `SearchInvoices` response. + """ + + invoices: typing.Optional[typing.List[Invoice]] = pydantic.Field(default=None) + """ + The list of invoices returned by the search. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When a response is truncated, it includes a cursor that you can use in a + subsequent request to fetch the next set of invoices. If empty, this is the final + response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_loyalty_accounts_request_loyalty_account_query.py b/src/square/types/search_loyalty_accounts_request_loyalty_account_query.py new file mode 100644 index 00000000..a36c9133 --- /dev/null +++ b/src/square/types/search_loyalty_accounts_request_loyalty_account_query.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .loyalty_account_mapping import LoyaltyAccountMapping +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchLoyaltyAccountsRequestLoyaltyAccountQuery(UncheckedBaseModel): + """ + The search criteria for the loyalty accounts. + """ + + mappings: typing.Optional[typing.List[LoyaltyAccountMapping]] = pydantic.Field(default=None) + """ + The set of mappings to use in the loyalty account search. + + This cannot be combined with `customer_ids`. + + Max: 30 mappings + """ + + customer_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The set of customer IDs to use in the loyalty account search. + + This cannot be combined with `mappings`. + + Max: 30 customer IDs + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_loyalty_accounts_response.py b/src/square/types/search_loyalty_accounts_response.py new file mode 100644 index 00000000..222bc75c --- /dev/null +++ b/src/square/types/search_loyalty_accounts_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_account import LoyaltyAccount +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchLoyaltyAccountsResponse(UncheckedBaseModel): + """ + A response that includes loyalty accounts that satisfy the search criteria. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + loyalty_accounts: typing.Optional[typing.List[LoyaltyAccount]] = pydantic.Field(default=None) + """ + The loyalty accounts that met the search criteria, + in order of creation date. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to use in a subsequent + request. If empty, this is the final response. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_loyalty_events_response.py b/src/square/types/search_loyalty_events_response.py new file mode 100644 index 00000000..9895c498 --- /dev/null +++ b/src/square/types/search_loyalty_events_response.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_event import LoyaltyEvent +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchLoyaltyEventsResponse(UncheckedBaseModel): + """ + A response that contains loyalty events that satisfy the search + criteria, in order by the `created_at` date. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + events: typing.Optional[typing.List[LoyaltyEvent]] = pydantic.Field(default=None) + """ + The loyalty events that satisfy the search criteria. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent + request. If empty, this is the final response. + For more information, + see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_loyalty_rewards_request_loyalty_reward_query.py b/src/square/types/search_loyalty_rewards_request_loyalty_reward_query.py new file mode 100644 index 00000000..bbc13d78 --- /dev/null +++ b/src/square/types/search_loyalty_rewards_request_loyalty_reward_query.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .loyalty_reward_status import LoyaltyRewardStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchLoyaltyRewardsRequestLoyaltyRewardQuery(UncheckedBaseModel): + """ + The set of search requirements. + """ + + loyalty_account_id: str = pydantic.Field() + """ + The ID of the [loyalty account](entity:LoyaltyAccount) to which the loyalty reward belongs. + """ + + status: typing.Optional[LoyaltyRewardStatus] = pydantic.Field(default=None) + """ + The status of the loyalty reward. + See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_loyalty_rewards_response.py b/src/square/types/search_loyalty_rewards_response.py new file mode 100644 index 00000000..37908f2c --- /dev/null +++ b/src/square/types/search_loyalty_rewards_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .loyalty_reward import LoyaltyReward +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchLoyaltyRewardsResponse(UncheckedBaseModel): + """ + A response that includes the loyalty rewards satisfying the search criteria. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + rewards: typing.Optional[typing.List[LoyaltyReward]] = pydantic.Field(default=None) + """ + The loyalty rewards that satisfy the search criteria. + These are returned in descending order by `updated_at`. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent + request. If empty, this is the final response. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_customer_filter.py b/src/square/types/search_orders_customer_filter.py new file mode 100644 index 00000000..df8c0b74 --- /dev/null +++ b/src/square/types/search_orders_customer_filter.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersCustomerFilter(UncheckedBaseModel): + """ + A filter based on the order `customer_id` and any tender `customer_id` + associated with the order. It does not filter based on the + [FulfillmentRecipient](entity:FulfillmentRecipient) `customer_id`. + """ + + customer_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of customer IDs to filter by. + + Max: 10 customer ids. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_date_time_filter.py b/src/square/types/search_orders_date_time_filter.py new file mode 100644 index 00000000..1e95a76b --- /dev/null +++ b/src/square/types/search_orders_date_time_filter.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .time_range import TimeRange +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersDateTimeFilter(UncheckedBaseModel): + """ + Filter for `Order` objects based on whether their `CREATED_AT`, + `CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range. + You can specify the time range and which timestamp to filter for. You can filter + for only one time range at a time. + + For each time range, the start time and end time are inclusive. If the end time + is absent, it defaults to the time of the first request for the cursor. + + __Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query, + you must set the `sort_field` in [OrdersSort](entity:SearchOrdersSort) + to the same field you filter for. For example, if you set the `CLOSED_AT` field + in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to + `CLOSED_AT`. Otherwise, `SearchOrders` throws an error. + [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) + """ + + created_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + The time range for filtering on the `created_at` timestamp. If you use this + value, you must set the `sort_field` in the `OrdersSearchSort` object to + `CREATED_AT`. + """ + + updated_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + The time range for filtering on the `updated_at` timestamp. If you use this + value, you must set the `sort_field` in the `OrdersSearchSort` object to + `UPDATED_AT`. + """ + + closed_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + The time range for filtering on the `closed_at` timestamp. If you use this + value, you must set the `sort_field` in the `OrdersSearchSort` object to + `CLOSED_AT`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_filter.py b/src/square/types/search_orders_filter.py new file mode 100644 index 00000000..d0be0905 --- /dev/null +++ b/src/square/types/search_orders_filter.py @@ -0,0 +1,56 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_orders_state_filter import SearchOrdersStateFilter +import pydantic +from .search_orders_date_time_filter import SearchOrdersDateTimeFilter +from .search_orders_fulfillment_filter import SearchOrdersFulfillmentFilter +from .search_orders_source_filter import SearchOrdersSourceFilter +from .search_orders_customer_filter import SearchOrdersCustomerFilter +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersFilter(UncheckedBaseModel): + """ + Filtering criteria to use for a `SearchOrders` request. Multiple filters + are ANDed together. + """ + + state_filter: typing.Optional[SearchOrdersStateFilter] = pydantic.Field(default=None) + """ + Filter by [OrderState](entity:OrderState). + """ + + date_time_filter: typing.Optional[SearchOrdersDateTimeFilter] = pydantic.Field(default=None) + """ + Filter for results within a time range. + + __Important:__ If you filter for orders by time range, you must set `SearchOrdersSort` + to sort by the same field. + [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) + """ + + fulfillment_filter: typing.Optional[SearchOrdersFulfillmentFilter] = pydantic.Field(default=None) + """ + Filter by the fulfillment type or state. + """ + + source_filter: typing.Optional[SearchOrdersSourceFilter] = pydantic.Field(default=None) + """ + Filter by the source of the order. + """ + + customer_filter: typing.Optional[SearchOrdersCustomerFilter] = pydantic.Field(default=None) + """ + Filter by customers associated with the order. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_fulfillment_filter.py b/src/square/types/search_orders_fulfillment_filter.py new file mode 100644 index 00000000..0a32a574 --- /dev/null +++ b/src/square/types/search_orders_fulfillment_filter.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .fulfillment_type import FulfillmentType +import pydantic +from .fulfillment_state import FulfillmentState +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersFulfillmentFilter(UncheckedBaseModel): + """ + Filter based on [order fulfillment](entity:Fulfillment) information. + """ + + fulfillment_types: typing.Optional[typing.List[FulfillmentType]] = pydantic.Field(default=None) + """ + A list of [fulfillment types](entity:FulfillmentType) to filter + for. The list returns orders if any of its fulfillments match any of the fulfillment types + listed in this field. + See [FulfillmentType](#type-fulfillmenttype) for possible values + """ + + fulfillment_states: typing.Optional[typing.List[FulfillmentState]] = pydantic.Field(default=None) + """ + A list of [fulfillment states](entity:FulfillmentState) to filter + for. The list returns orders if any of its fulfillments match any of the + fulfillment states listed in this field. + See [FulfillmentState](#type-fulfillmentstate) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_query.py b/src/square/types/search_orders_query.py new file mode 100644 index 00000000..cc15d8a6 --- /dev/null +++ b/src/square/types/search_orders_query.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_orders_filter import SearchOrdersFilter +import pydantic +from .search_orders_sort import SearchOrdersSort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersQuery(UncheckedBaseModel): + """ + Contains query criteria for the search. + """ + + filter: typing.Optional[SearchOrdersFilter] = pydantic.Field(default=None) + """ + Criteria to filter results by. + """ + + sort: typing.Optional[SearchOrdersSort] = pydantic.Field(default=None) + """ + Criteria to sort results by. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_response.py b/src/square/types/search_orders_response.py new file mode 100644 index 00000000..66fa1e98 --- /dev/null +++ b/src/square/types/search_orders_response.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order_entry import OrderEntry +import pydantic +from .order import Order +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersResponse(UncheckedBaseModel): + """ + Either the `order_entries` or `orders` field is set, depending on whether + `return_entries` is set on the [SearchOrdersRequest](api-endpoint:Orders-SearchOrders). + """ + + order_entries: typing.Optional[typing.List[OrderEntry]] = pydantic.Field(default=None) + """ + A list of [OrderEntries](entity:OrderEntry) that fit the query + conditions. The list is populated only if `return_entries` is set to `true` in the request. + """ + + orders: typing.Optional[typing.List[Order]] = pydantic.Field(default=None) + """ + A list of + [Order](entity:Order) objects that match the query conditions. The list is populated only if + `return_entries` is set to `false` in the request. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + [Errors](entity:Error) encountered during the search. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_sort.py b/src/square/types/search_orders_sort.py new file mode 100644 index 00000000..fdaf7df6 --- /dev/null +++ b/src/square/types/search_orders_sort.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .search_orders_sort_field import SearchOrdersSortField +import pydantic +import typing +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersSort(UncheckedBaseModel): + """ + Sorting criteria for a `SearchOrders` request. Results can only be sorted + by a timestamp field. + """ + + sort_field: SearchOrdersSortField = pydantic.Field() + """ + The field to sort by. + + __Important:__ When using a [DateTimeFilter](entity:SearchOrdersFilter), + `sort_field` must match the timestamp field that the `DateTimeFilter` uses to + filter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a + `DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date. + If this field does not match the timestamp field in `DateTimeFilter`, + `SearchOrders` returns an error. + + Default: `CREATED_AT`. + See [SearchOrdersSortField](#type-searchorderssortfield) for possible values + """ + + sort_order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The chronological order in which results are returned. Defaults to `DESC`. + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_sort_field.py b/src/square/types/search_orders_sort_field.py new file mode 100644 index 00000000..1e912601 --- /dev/null +++ b/src/square/types/search_orders_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SearchOrdersSortField = typing.Union[typing.Literal["CREATED_AT", "UPDATED_AT", "CLOSED_AT"], typing.Any] diff --git a/src/square/types/search_orders_source_filter.py b/src/square/types/search_orders_source_filter.py new file mode 100644 index 00000000..988cb9ea --- /dev/null +++ b/src/square/types/search_orders_source_filter.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersSourceFilter(UncheckedBaseModel): + """ + A filter based on order `source` information. + """ + + source_names: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Filters by the [Source](entity:OrderSource) `name`. The filter returns any orders + with a `source.name` that matches any of the listed source names. + + Max: 10 source names. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_orders_state_filter.py b/src/square/types/search_orders_state_filter.py new file mode 100644 index 00000000..54d00fe1 --- /dev/null +++ b/src/square/types/search_orders_state_filter.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order_state import OrderState +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchOrdersStateFilter(UncheckedBaseModel): + """ + Filter by the current order `state`. + """ + + states: typing.List[OrderState] = pydantic.Field() + """ + States to filter for. + See [OrderState](#type-orderstate) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_shifts_response.py b/src/square/types/search_shifts_response.py new file mode 100644 index 00000000..19297f4e --- /dev/null +++ b/src/square/types/search_shifts_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .shift import Shift +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchShiftsResponse(UncheckedBaseModel): + """ + The response to a request for `Shift` objects. The response contains + the requested `Shift` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shifts: typing.Optional[typing.List[Shift]] = pydantic.Field(default=None) + """ + Shifts. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + An opaque cursor for fetching the next page. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_subscriptions_filter.py b/src/square/types/search_subscriptions_filter.py new file mode 100644 index 00000000..6c940d24 --- /dev/null +++ b/src/square/types/search_subscriptions_filter.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchSubscriptionsFilter(UncheckedBaseModel): + """ + Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by + the [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint. + """ + + customer_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A filter to select subscriptions based on the subscribing customer IDs. + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A filter to select subscriptions based on the location. + """ + + source_names: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A filter to select subscriptions based on the source application. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_subscriptions_query.py b/src/square/types/search_subscriptions_query.py new file mode 100644 index 00000000..3259d346 --- /dev/null +++ b/src/square/types/search_subscriptions_query.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_subscriptions_filter import SearchSubscriptionsFilter +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchSubscriptionsQuery(UncheckedBaseModel): + """ + Represents a query, consisting of specified query expressions, used to search for subscriptions. + """ + + filter: typing.Optional[SearchSubscriptionsFilter] = pydantic.Field(default=None) + """ + A list of query expressions. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_subscriptions_response.py b/src/square/types/search_subscriptions_response.py new file mode 100644 index 00000000..75082d3e --- /dev/null +++ b/src/square/types/search_subscriptions_response.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchSubscriptionsResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscriptions: typing.Optional[typing.List[Subscription]] = pydantic.Field(default=None) + """ + The subscriptions matching the specified query expressions. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + When the total number of resulting subscription exceeds the limit of a paged response, + the response includes a cursor for you to use in a subsequent request to fetch the next set of results. + If the cursor is unset, the response contains the last page of the results. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_team_members_filter.py b/src/square/types/search_team_members_filter.py new file mode 100644 index 00000000..e4430519 --- /dev/null +++ b/src/square/types/search_team_members_filter.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .team_member_status import TeamMemberStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchTeamMembersFilter(UncheckedBaseModel): + """ + Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied + between the individual fields, and `OR` logic is applied within list-based fields. + For example, setting this filter value: + ``` + filter = (locations_ids = ["A", "B"], status = ACTIVE) + ``` + returns only active team members assigned to either location "A" or "B". + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + When present, filters by team members assigned to the specified locations. + When empty, includes team members assigned to any location. + """ + + status: typing.Optional[TeamMemberStatus] = pydantic.Field(default=None) + """ + When present, filters by team members who match the given status. + When empty, includes team members of all statuses. + See [TeamMemberStatus](#type-teammemberstatus) for possible values + """ + + is_owner: typing.Optional[bool] = pydantic.Field(default=None) + """ + When present and set to true, returns the team member who is the owner of the Square account. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_team_members_query.py b/src/square/types/search_team_members_query.py new file mode 100644 index 00000000..5730e497 --- /dev/null +++ b/src/square/types/search_team_members_query.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_team_members_filter import SearchTeamMembersFilter +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchTeamMembersQuery(UncheckedBaseModel): + """ + Represents the parameters in a search for `TeamMember` objects. + """ + + filter: typing.Optional[SearchTeamMembersFilter] = pydantic.Field(default=None) + """ + The options to filter by. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_team_members_response.py b/src/square/types/search_team_members_response.py new file mode 100644 index 00000000..ea46d869 --- /dev/null +++ b/src/square/types/search_team_members_response.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member import TeamMember +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchTeamMembersResponse(UncheckedBaseModel): + """ + Represents a response from a search request containing a filtered list of `TeamMember` objects. + """ + + team_members: typing.Optional[typing.List[TeamMember]] = pydantic.Field(default=None) + """ + The filtered list of `TeamMember` objects. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The opaque cursor for fetching the next page. For more information, see + [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_terminal_actions_response.py b/src/square/types/search_terminal_actions_response.py new file mode 100644 index 00000000..ef15fe65 --- /dev/null +++ b/src/square/types/search_terminal_actions_response.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_action import TerminalAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchTerminalActionsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + action: typing.Optional[typing.List[TerminalAction]] = pydantic.Field(default=None) + """ + The requested search result of `TerminalAction`s. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more + information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_terminal_checkouts_response.py b/src/square/types/search_terminal_checkouts_response.py new file mode 100644 index 00000000..78fe0f61 --- /dev/null +++ b/src/square/types/search_terminal_checkouts_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_checkout import TerminalCheckout +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchTerminalCheckoutsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + checkouts: typing.Optional[typing.List[TerminalCheckout]] = pydantic.Field(default=None) + """ + The requested search result of `TerminalCheckout` objects. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_terminal_refunds_response.py b/src/square/types/search_terminal_refunds_response.py new file mode 100644 index 00000000..bb3114e7 --- /dev/null +++ b/src/square/types/search_terminal_refunds_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .terminal_refund import TerminalRefund +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchTerminalRefundsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + refunds: typing.Optional[typing.List[TerminalRefund]] = pydantic.Field(default=None) + """ + The requested search result of `TerminalRefund` objects. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If empty, + this is the final response. + + See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_vendors_request_filter.py b/src/square/types/search_vendors_request_filter.py new file mode 100644 index 00000000..c14d02cb --- /dev/null +++ b/src/square/types/search_vendors_request_filter.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .vendor_status import VendorStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchVendorsRequestFilter(UncheckedBaseModel): + """ + Defines supported query expressions to search for vendors by. + """ + + name: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The names of the [Vendor](entity:Vendor) objects to retrieve. + """ + + status: typing.Optional[typing.List[VendorStatus]] = pydantic.Field(default=None) + """ + The statuses of the [Vendor](entity:Vendor) objects to retrieve. + See [VendorStatus](#type-vendorstatus) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_vendors_request_sort.py b/src/square/types/search_vendors_request_sort.py new file mode 100644 index 00000000..1d9ba70e --- /dev/null +++ b/src/square/types/search_vendors_request_sort.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .search_vendors_request_sort_field import SearchVendorsRequestSortField +import pydantic +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchVendorsRequestSort(UncheckedBaseModel): + """ + Defines a sorter used to sort results from [SearchVendors](api-endpoint:Vendors-SearchVendors). + """ + + field: typing.Optional[SearchVendorsRequestSortField] = pydantic.Field(default=None) + """ + Specifies the sort key to sort the returned vendors. + See [Field](#type-field) for possible values + """ + + order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + Specifies the sort order for the returned vendors. + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/search_vendors_request_sort_field.py b/src/square/types/search_vendors_request_sort_field.py new file mode 100644 index 00000000..626d5cd3 --- /dev/null +++ b/src/square/types/search_vendors_request_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SearchVendorsRequestSortField = typing.Union[typing.Literal["NAME", "CREATED_AT"], typing.Any] diff --git a/src/square/types/search_vendors_response.py b/src/square/types/search_vendors_response.py new file mode 100644 index 00000000..cbc9b7e3 --- /dev/null +++ b/src/square/types/search_vendors_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .vendor import Vendor +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SearchVendorsResponse(UncheckedBaseModel): + """ + Represents an output from a call to [SearchVendors](api-endpoint:Vendors-SearchVendors). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered when the request fails. + """ + + vendors: typing.Optional[typing.List[Vendor]] = pydantic.Field(default=None) + """ + The [Vendor](entity:Vendor) objects matching the specified search filter. + """ + + cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The pagination cursor to be used in a subsequent request. If unset, + this is the final response. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/segment_filter.py b/src/square/types/segment_filter.py new file mode 100644 index 00000000..e76e357e --- /dev/null +++ b/src/square/types/segment_filter.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .filter_value import FilterValue +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SegmentFilter(UncheckedBaseModel): + """ + A query filter to search for buyer-accessible appointment segments by. + """ + + service_variation_id: str = pydantic.Field() + """ + The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment. + """ + + team_member_id_filter: typing.Optional[FilterValue] = pydantic.Field(default=None) + """ + A query filter to search for buyer-accessible appointment segments with service-providing team members matching the specified list of team member IDs. Supported query expressions are + - `ANY`: return the appointment segments with team members whose IDs match any member in this list. + - `NONE`: return the appointment segments with team members whose IDs are not in this list. + - `ALL`: not supported. + + When no expression is specified, any service-providing team member is eligible to fulfill the Booking. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/select_option.py b/src/square/types/select_option.py new file mode 100644 index 00000000..75f52bbc --- /dev/null +++ b/src/square/types/select_option.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class SelectOption(UncheckedBaseModel): + reference_id: str = pydantic.Field() + """ + The reference id for the option. + """ + + title: str = pydantic.Field() + """ + The title text that displays in the select option button. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/select_options.py b/src/square/types/select_options.py new file mode 100644 index 00000000..27ba583a --- /dev/null +++ b/src/square/types/select_options.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .select_option import SelectOption +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SelectOptions(UncheckedBaseModel): + title: str = pydantic.Field() + """ + The title text to display in the select flow on the Terminal. + """ + + body: str = pydantic.Field() + """ + The body text to display in the select flow on the Terminal. + """ + + options: typing.List[SelectOption] = pydantic.Field() + """ + Represents the buttons/options that should be displayed in the select flow on the Terminal. + """ + + selected_option: typing.Optional[SelectOption] = pydantic.Field(default=None) + """ + The buyer’s selected option. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift.py b/src/square/types/shift.py new file mode 100644 index 00000000..88fed858 --- /dev/null +++ b/src/square/types/shift.py @@ -0,0 +1,108 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .shift_wage import ShiftWage +from .break_ import Break +from .shift_status import ShiftStatus +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Shift(UncheckedBaseModel): + """ + A record of the hourly rate, start, and end times for a single work shift + for an employee. This might include a record of the start and end times for breaks + taken during the shift. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The UUID for this object. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead. + """ + + location_id: str = pydantic.Field() + """ + The ID of the location this shift occurred at. The location should be based on + where the employee clocked in. + """ + + timezone: typing.Optional[str] = pydantic.Field(default=None) + """ + The read-only convenience value that is calculated from the location based + on the `location_id`. Format: the IANA timezone database identifier for the + location timezone. + """ + + start_at: str = pydantic.Field() + """ + RFC 3339; shifted to the location timezone + offset. Precision up to the + minute is respected; seconds are truncated. + """ + + end_at: typing.Optional[str] = pydantic.Field(default=None) + """ + RFC 3339; shifted to the timezone + offset. Precision up to the minute is + respected; seconds are truncated. + """ + + wage: typing.Optional[ShiftWage] = pydantic.Field(default=None) + """ + Job and pay related information. If the wage is not set on create, it defaults to a wage + of zero. If the title is not set on create, it defaults to the name of the role the employee + is assigned to, if any. + """ + + breaks: typing.Optional[typing.List[Break]] = pydantic.Field(default=None) + """ + A list of all the paid or unpaid breaks that were taken during this shift. + """ + + status: typing.Optional[ShiftStatus] = pydantic.Field(default=None) + """ + Describes the working state of the current `Shift`. + See [ShiftStatus](#type-shiftstatus) for possible values + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If not provided, + Square executes a blind write; potentially overwriting data from another + write. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26". + """ + + declared_cash_tip_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The tips declared by the team member for the shift. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift_filter.py b/src/square/types/shift_filter.py new file mode 100644 index 00000000..1bacf8a0 --- /dev/null +++ b/src/square/types/shift_filter.py @@ -0,0 +1,61 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .shift_filter_status import ShiftFilterStatus +from .time_range import TimeRange +from .shift_workday import ShiftWorkday +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ShiftFilter(UncheckedBaseModel): + """ + Defines a filter used in a search for `Shift` records. `AND` logic is + used by Square's servers to apply each filter property specified. + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Fetch shifts for the specified location. + """ + + employee_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead. + """ + + status: typing.Optional[ShiftFilterStatus] = pydantic.Field(default=None) + """ + Fetch a `Shift` instance by `Shift.status`. + See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values + """ + + start: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + Fetch `Shift` instances that start in the time range - Inclusive. + """ + + end: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + Fetch the `Shift` instances that end in the time range - Inclusive. + """ + + workday: typing.Optional[ShiftWorkday] = pydantic.Field(default=None) + """ + Fetch the `Shift` instances based on the workday date range. + """ + + team_member_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + Fetch shifts for the specified team members. Replaced `employee_ids` at version "2020-08-26". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift_filter_status.py b/src/square/types/shift_filter_status.py new file mode 100644 index 00000000..2544d817 --- /dev/null +++ b/src/square/types/shift_filter_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ShiftFilterStatus = typing.Union[typing.Literal["OPEN", "CLOSED"], typing.Any] diff --git a/src/square/types/shift_query.py b/src/square/types/shift_query.py new file mode 100644 index 00000000..9dbcb41b --- /dev/null +++ b/src/square/types/shift_query.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .shift_filter import ShiftFilter +import pydantic +from .shift_sort import ShiftSort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ShiftQuery(UncheckedBaseModel): + """ + The parameters of a `Shift` search query, which includes filter and sort options. + """ + + filter: typing.Optional[ShiftFilter] = pydantic.Field(default=None) + """ + Query filter options. + """ + + sort: typing.Optional[ShiftSort] = pydantic.Field(default=None) + """ + Sort order details. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift_sort.py b/src/square/types/shift_sort.py new file mode 100644 index 00000000..d2f2c307 --- /dev/null +++ b/src/square/types/shift_sort.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .shift_sort_field import ShiftSortField +import pydantic +from .sort_order import SortOrder +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ShiftSort(UncheckedBaseModel): + """ + Sets the sort order of search results. + """ + + field: typing.Optional[ShiftSortField] = pydantic.Field(default=None) + """ + The field to sort on. + See [ShiftSortField](#type-shiftsortfield) for possible values + """ + + order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The order in which results are returned. Defaults to DESC. + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift_sort_field.py b/src/square/types/shift_sort_field.py new file mode 100644 index 00000000..2826bc80 --- /dev/null +++ b/src/square/types/shift_sort_field.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ShiftSortField = typing.Union[typing.Literal["START_AT", "END_AT", "CREATED_AT", "UPDATED_AT"], typing.Any] diff --git a/src/square/types/shift_status.py b/src/square/types/shift_status.py new file mode 100644 index 00000000..96b5fb96 --- /dev/null +++ b/src/square/types/shift_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ShiftStatus = typing.Union[typing.Literal["OPEN", "CLOSED"], typing.Any] diff --git a/src/square/types/shift_wage.py b/src/square/types/shift_wage.py new file mode 100644 index 00000000..7faba684 --- /dev/null +++ b/src/square/types/shift_wage.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ShiftWage(UncheckedBaseModel): + """ + The hourly wage rate used to compensate an employee for this shift. + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the job performed during this shift. + """ + + hourly_rate: typing.Optional[Money] = pydantic.Field(default=None) + """ + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + """ + + job_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the job performed during this shift. Square + labor-reporting UIs might group shifts together by id. This cannot be used to retrieve the job. + """ + + tip_eligible: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether team members are eligible for tips when working this job. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift_workday.py b/src/square/types/shift_workday.py new file mode 100644 index 00000000..558fdbb3 --- /dev/null +++ b/src/square/types/shift_workday.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .date_range import DateRange +import pydantic +from .shift_workday_matcher import ShiftWorkdayMatcher +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ShiftWorkday(UncheckedBaseModel): + """ + A `Shift` search query filter parameter that sets a range of days that + a `Shift` must start or end in before passing the filter condition. + """ + + date_range: typing.Optional[DateRange] = pydantic.Field(default=None) + """ + Dates for fetching the shifts. + """ + + match_shifts_by: typing.Optional[ShiftWorkdayMatcher] = pydantic.Field(default=None) + """ + The strategy on which the dates are applied. + See [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible values + """ + + default_timezone: typing.Optional[str] = pydantic.Field(default=None) + """ + Location-specific timezones convert workdays to datetime filters. + Every location included in the query must have a timezone or this field + must be provided as a fallback. Format: the IANA timezone database + identifier for the relevant timezone. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/shift_workday_matcher.py b/src/square/types/shift_workday_matcher.py new file mode 100644 index 00000000..b1266430 --- /dev/null +++ b/src/square/types/shift_workday_matcher.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ShiftWorkdayMatcher = typing.Union[typing.Literal["START_AT", "END_AT", "INTERSECTION"], typing.Any] diff --git a/src/square/types/shipping_fee.py b/src/square/types/shipping_fee.py new file mode 100644 index 00000000..dbea2e82 --- /dev/null +++ b/src/square/types/shipping_fee.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class ShippingFee(UncheckedBaseModel): + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name for the shipping fee. + """ + + charge: Money = pydantic.Field() + """ + The amount and currency for the shipping fee. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/signature_image.py b/src/square/types/signature_image.py new file mode 100644 index 00000000..e40d38e4 --- /dev/null +++ b/src/square/types/signature_image.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SignatureImage(UncheckedBaseModel): + image_type: typing.Optional[str] = pydantic.Field(default=None) + """ + The mime/type of the image data. + Use `image/png;base64` for png. + """ + + data: typing.Optional[str] = pydantic.Field(default=None) + """ + The base64 representation of the image. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/signature_options.py b/src/square/types/signature_options.py new file mode 100644 index 00000000..3e982b41 --- /dev/null +++ b/src/square/types/signature_options.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +import typing +from .signature_image import SignatureImage +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SignatureOptions(UncheckedBaseModel): + title: str = pydantic.Field() + """ + The title text to display in the signature capture flow on the Terminal. + """ + + body: str = pydantic.Field() + """ + The body text to display in the signature capture flow on the Terminal. + """ + + signature: typing.Optional[typing.List[SignatureImage]] = pydantic.Field(default=None) + """ + An image representation of the collected signature. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/site.py b/src/square/types/site.py new file mode 100644 index 00000000..15ae6850 --- /dev/null +++ b/src/square/types/site.py @@ -0,0 +1,51 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Site(UncheckedBaseModel): + """ + Represents a Square Online site, which is an online store for a Square seller. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the site. + """ + + site_title: typing.Optional[str] = pydantic.Field(default=None) + """ + The title of the site. + """ + + domain: typing.Optional[str] = pydantic.Field(default=None) + """ + The domain of the site (without the protocol). For example, `mysite1.square.site`. + """ + + is_published: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the site is published. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the site was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the site was last updated, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/snippet.py b/src/square/types/snippet.py new file mode 100644 index 00000000..c48ead3c --- /dev/null +++ b/src/square/types/snippet.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Snippet(UncheckedBaseModel): + """ + Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID for the snippet. + """ + + site_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the site that contains the snippet. + """ + + content: str = pydantic.Field() + """ + The snippet code, which can contain valid HTML, JavaScript, or both. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the snippet was initially added to the site, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the snippet was last updated on the site, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/sort_order.py b/src/square/types/sort_order.py new file mode 100644 index 00000000..223ea604 --- /dev/null +++ b/src/square/types/sort_order.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SortOrder = typing.Union[typing.Literal["DESC", "ASC"], typing.Any] diff --git a/src/square/types/source_application.py b/src/square/types/source_application.py new file mode 100644 index 00000000..7b798b9a --- /dev/null +++ b/src/square/types/source_application.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .product import Product +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SourceApplication(UncheckedBaseModel): + """ + Represents information about the application used to generate a change. + """ + + product: typing.Optional[Product] = pydantic.Field(default=None) + """ + __Read only__ The [product](entity:Product) type of the application. + See [Product](#type-product) for possible values + """ + + application_id: typing.Optional[str] = pydantic.Field(default=None) + """ + __Read only__ The Square-assigned ID of the application. This field is used only if the + [product](entity:Product) type is `EXTERNAL_API`. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + __Read only__ The display name of the application + (for example, `"Custom Application"` or `"Square POS 4.74 for Android"`). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/square_account_details.py b/src/square/types/square_account_details.py new file mode 100644 index 00000000..0575c421 --- /dev/null +++ b/src/square/types/square_account_details.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SquareAccountDetails(UncheckedBaseModel): + """ + Additional details about Square Account payments. + """ + + payment_source_token: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique identifier for the payment source used for this payment. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/standard_unit_description.py b/src/square/types/standard_unit_description.py new file mode 100644 index 00000000..39b4d1b8 --- /dev/null +++ b/src/square/types/standard_unit_description.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .measurement_unit import MeasurementUnit +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class StandardUnitDescription(UncheckedBaseModel): + """ + Contains the name and abbreviation for standard measurement unit. + """ + + unit: typing.Optional[MeasurementUnit] = pydantic.Field(default=None) + """ + Identifies the measurement unit being described. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + UI display name of the measurement unit. For example, 'Pound'. + """ + + abbreviation: typing.Optional[str] = pydantic.Field(default=None) + """ + UI display abbreviation for the measurement unit. For example, 'lb'. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/standard_unit_description_group.py b/src/square/types/standard_unit_description_group.py new file mode 100644 index 00000000..f978bce1 --- /dev/null +++ b/src/square/types/standard_unit_description_group.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .standard_unit_description import StandardUnitDescription +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class StandardUnitDescriptionGroup(UncheckedBaseModel): + """ + Group of standard measurement units. + """ + + standard_unit_descriptions: typing.Optional[typing.List[StandardUnitDescription]] = pydantic.Field(default=None) + """ + List of standard (non-custom) measurement units in this description group. + """ + + language_code: typing.Optional[str] = pydantic.Field(default=None) + """ + IETF language tag. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/submit_evidence_response.py b/src/square/types/submit_evidence_response.py new file mode 100644 index 00000000..dd429c51 --- /dev/null +++ b/src/square/types/submit_evidence_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .dispute import Dispute +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubmitEvidenceResponse(UncheckedBaseModel): + """ + Defines the fields in a `SubmitEvidence` response. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + dispute: typing.Optional[Dispute] = pydantic.Field(default=None) + """ + The `Dispute` for which evidence was submitted. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription.py b/src/square/types/subscription.py new file mode 100644 index 00000000..61656697 --- /dev/null +++ b/src/square/types/subscription.py @@ -0,0 +1,154 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .subscription_status import SubscriptionStatus +from .money import Money +from .subscription_source import SubscriptionSource +from .subscription_action import SubscriptionAction +from .phase import Phase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Subscription(UncheckedBaseModel): + """ + Represents a subscription purchased by a customer. + + For more information, see + [Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the subscription. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the location associated with the subscription. + """ + + plan_variation_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation). + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the subscribing [customer](entity:Customer) profile. + """ + + start_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription. + """ + + canceled_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription, + when the subscription status changes to `CANCELED` and the subscription billing stops. + + If this field is not set, the subscription ends according its subscription plan. + + This field cannot be updated, other than being cleared. + """ + + charged_through_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the + subscription. + + After the invoice is sent for a given billing period, + this date will be the last day of the billing period. + For example, + suppose for the month of May a subscriber gets an invoice + (or charged the card) on May 1. For the monthly billing scenario, + this date is then set to May 31. + """ + + status: typing.Optional[SubscriptionStatus] = pydantic.Field(default=None) + """ + The current status of the subscription. + See [SubscriptionStatus](#type-subscriptionstatus) for possible values + """ + + tax_percentage: typing.Optional[str] = pydantic.Field(default=None) + """ + The tax amount applied when billing the subscription. The + percentage is expressed in decimal form, using a `'.'` as the decimal + separator and without a `'%'` sign. For example, a value of `7.5` + corresponds to 7.5%. + """ + + invoice_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The IDs of the [invoices](entity:Invoice) created for the + subscription, listed in order when the invoices were created + (newest invoices appear first). + """ + + price_override_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + A custom price which overrides the cost of a subscription plan variation with `STATIC` pricing. + This field does not affect itemized subscriptions with `RELATIVE` pricing. Instead, + you should edit the Subscription's [order template](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates). + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the object. When updating an object, the version + supplied must match the version in the database, otherwise the write will + be rejected as conflicting. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the subscription was created, in RFC 3339 format. + """ + + card_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [subscriber's](entity:Customer) [card](entity:Card) + used to charge for the subscription. + """ + + timezone: typing.Optional[str] = pydantic.Field(default=None) + """ + Timezone that will be used in date calculations for the subscription. + Defaults to the timezone of the location based on `location_id`. + Format: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`). + """ + + source: typing.Optional[SubscriptionSource] = pydantic.Field(default=None) + """ + The origination details of the subscription. + """ + + actions: typing.Optional[typing.List[SubscriptionAction]] = pydantic.Field(default=None) + """ + The list of scheduled actions on this subscription. It is set only in the response from + [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) with the query parameter + of `include=actions` or from + [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) with the input parameter + of `include:["actions"]`. + """ + + monthly_billing_anchor_date: typing.Optional[int] = pydantic.Field(default=None) + """ + The day of the month on which the subscription will issue invoices and publish orders. + """ + + phases: typing.Optional[typing.List[Phase]] = pydantic.Field(default=None) + """ + array of phases for this subscription + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_action.py b/src/square/types/subscription_action.py new file mode 100644 index 00000000..f42c31cb --- /dev/null +++ b/src/square/types/subscription_action.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .subscription_action_type import SubscriptionActionType +from .phase import Phase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionAction(UncheckedBaseModel): + """ + Represents an action as a pending change to a subscription. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of an action scoped to a subscription. + """ + + type: typing.Optional[SubscriptionActionType] = pydantic.Field(default=None) + """ + The type of the action. + See [SubscriptionActionType](#type-subscriptionactiontype) for possible values + """ + + effective_date: typing.Optional[str] = pydantic.Field(default=None) + """ + The `YYYY-MM-DD`-formatted date when the action occurs on the subscription. + """ + + monthly_billing_anchor_date: typing.Optional[int] = pydantic.Field(default=None) + """ + The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action. + """ + + phases: typing.Optional[typing.List[Phase]] = pydantic.Field(default=None) + """ + A list of Phases, to pass phase-specific information used in the swap. + """ + + new_plan_variation_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_action_type.py b/src/square/types/subscription_action_type.py new file mode 100644 index 00000000..c2c8b83f --- /dev/null +++ b/src/square/types/subscription_action_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SubscriptionActionType = typing.Union[ + typing.Literal["CANCEL", "PAUSE", "RESUME", "SWAP_PLAN", "CHANGE_BILLING_ANCHOR_DATE"], typing.Any +] diff --git a/src/square/types/subscription_cadence.py b/src/square/types/subscription_cadence.py new file mode 100644 index 00000000..31fd6cb1 --- /dev/null +++ b/src/square/types/subscription_cadence.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SubscriptionCadence = typing.Union[ + typing.Literal[ + "DAILY", + "WEEKLY", + "EVERY_TWO_WEEKS", + "THIRTY_DAYS", + "SIXTY_DAYS", + "NINETY_DAYS", + "MONTHLY", + "EVERY_TWO_MONTHS", + "QUARTERLY", + "EVERY_FOUR_MONTHS", + "EVERY_SIX_MONTHS", + "ANNUAL", + "EVERY_TWO_YEARS", + ], + typing.Any, +] diff --git a/src/square/types/subscription_event.py b/src/square/types/subscription_event.py new file mode 100644 index 00000000..acd2affd --- /dev/null +++ b/src/square/types/subscription_event.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from .subscription_event_subscription_event_type import SubscriptionEventSubscriptionEventType +import typing +from .subscription_event_info import SubscriptionEventInfo +from .phase import Phase +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionEvent(UncheckedBaseModel): + """ + Describes changes to a subscription and the subscription status. + """ + + id: str = pydantic.Field() + """ + The ID of the subscription event. + """ + + subscription_event_type: SubscriptionEventSubscriptionEventType = pydantic.Field() + """ + Type of the subscription event. + See [SubscriptionEventSubscriptionEventType](#type-subscriptioneventsubscriptioneventtype) for possible values + """ + + effective_date: str = pydantic.Field() + """ + The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the subscription event occurred. + """ + + monthly_billing_anchor_date: typing.Optional[int] = pydantic.Field(default=None) + """ + The day-of-the-month the billing anchor date was changed to, if applicable. + """ + + info: typing.Optional[SubscriptionEventInfo] = pydantic.Field(default=None) + """ + Additional information about the subscription event. + """ + + phases: typing.Optional[typing.List[Phase]] = pydantic.Field(default=None) + """ + A list of Phases, to pass phase-specific information used in the swap. + """ + + plan_variation_id: str = pydantic.Field() + """ + The ID of the subscription plan variation associated with the subscription. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_event_info.py b/src/square/types/subscription_event_info.py new file mode 100644 index 00000000..cf5a5080 --- /dev/null +++ b/src/square/types/subscription_event_info.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .subscription_event_info_code import SubscriptionEventInfoCode +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionEventInfo(UncheckedBaseModel): + """ + Provides information about the subscription event. + """ + + detail: typing.Optional[str] = pydantic.Field(default=None) + """ + A human-readable explanation for the event. + """ + + code: typing.Optional[SubscriptionEventInfoCode] = pydantic.Field(default=None) + """ + An info code indicating the subscription event that occurred. + See [InfoCode](#type-infocode) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_event_info_code.py b/src/square/types/subscription_event_info_code.py new file mode 100644 index 00000000..6fe7f368 --- /dev/null +++ b/src/square/types/subscription_event_info_code.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SubscriptionEventInfoCode = typing.Union[ + typing.Literal[ + "LOCATION_NOT_ACTIVE", + "LOCATION_CANNOT_ACCEPT_PAYMENT", + "CUSTOMER_DELETED", + "CUSTOMER_NO_EMAIL", + "CUSTOMER_NO_NAME", + "USER_PROVIDED", + ], + typing.Any, +] diff --git a/src/square/types/subscription_event_subscription_event_type.py b/src/square/types/subscription_event_subscription_event_type.py new file mode 100644 index 00000000..72a88b5f --- /dev/null +++ b/src/square/types/subscription_event_subscription_event_type.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SubscriptionEventSubscriptionEventType = typing.Union[ + typing.Literal[ + "START_SUBSCRIPTION", + "PLAN_CHANGE", + "STOP_SUBSCRIPTION", + "DEACTIVATE_SUBSCRIPTION", + "RESUME_SUBSCRIPTION", + "PAUSE_SUBSCRIPTION", + "BILLING_ANCHOR_DATE_CHANGED", + ], + typing.Any, +] diff --git a/src/square/types/subscription_phase.py b/src/square/types/subscription_phase.py new file mode 100644 index 00000000..b713f4a3 --- /dev/null +++ b/src/square/types/subscription_phase.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .subscription_cadence import SubscriptionCadence +from .money import Money +from .subscription_pricing import SubscriptionPricing +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionPhase(UncheckedBaseModel): + """ + Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). + """ + + uid: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created. + """ + + cadence: SubscriptionCadence = pydantic.Field() + """ + The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created. + See [SubscriptionCadence](#type-subscriptioncadence) for possible values + """ + + periods: typing.Optional[int] = pydantic.Field(default=None) + """ + The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created. + """ + + recurring_price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount to bill for each `cadence`. Failure to specify this field results in a `MISSING_REQUIRED_PARAMETER` error at runtime. + """ + + ordinal: typing.Optional[int] = pydantic.Field(default=None) + """ + The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created. + """ + + pricing: typing.Optional[SubscriptionPricing] = pydantic.Field(default=None) + """ + The subscription pricing. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_pricing.py b/src/square/types/subscription_pricing.py new file mode 100644 index 00000000..55d436e5 --- /dev/null +++ b/src/square/types/subscription_pricing.py @@ -0,0 +1,39 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .subscription_pricing_type import SubscriptionPricingType +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionPricing(UncheckedBaseModel): + """ + Describes the pricing for the subscription. + """ + + type: typing.Optional[SubscriptionPricingType] = pydantic.Field(default=None) + """ + RELATIVE or STATIC + See [SubscriptionPricingType](#type-subscriptionpricingtype) for possible values + """ + + discount_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The ids of the discount catalog objects + """ + + price_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The price of the subscription, if STATIC + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_pricing_type.py b/src/square/types/subscription_pricing_type.py new file mode 100644 index 00000000..d0655c70 --- /dev/null +++ b/src/square/types/subscription_pricing_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SubscriptionPricingType = typing.Union[typing.Literal["STATIC", "RELATIVE"], typing.Any] diff --git a/src/square/types/subscription_source.py b/src/square/types/subscription_source.py new file mode 100644 index 00000000..7150d22c --- /dev/null +++ b/src/square/types/subscription_source.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionSource(UncheckedBaseModel): + """ + The origination details of the subscription. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name used to identify the place (physical or digital) that + a subscription originates. If unset, the name defaults to the name + of the application that created the subscription. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/subscription_status.py b/src/square/types/subscription_status.py new file mode 100644 index 00000000..537b411c --- /dev/null +++ b/src/square/types/subscription_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SubscriptionStatus = typing.Union[typing.Literal["PENDING", "ACTIVE", "CANCELED", "DEACTIVATED", "PAUSED"], typing.Any] diff --git a/src/square/types/subscription_test_result.py b/src/square/types/subscription_test_result.py new file mode 100644 index 00000000..1ecfa6d0 --- /dev/null +++ b/src/square/types/subscription_test_result.py @@ -0,0 +1,49 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SubscriptionTestResult(UncheckedBaseModel): + """ + Represents the details of a webhook subscription, including notification URL, + event types, and signature key. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A Square-generated unique ID for the subscription test result. + """ + + status_code: typing.Optional[int] = pydantic.Field(default=None) + """ + The status code returned by the subscription notification URL. + """ + + payload: typing.Optional[str] = pydantic.Field(default=None) + """ + An object containing the payload of the test event. For example, a `payment.created` event. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the subscription was created, in RFC 3339 format. + For example, "2016-09-04T23:59:33.123Z". + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the subscription was updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". + Because a subscription test result is unique, this field is the same as the `created_at` field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/swap_plan_response.py b/src/square/types/swap_plan_response.py new file mode 100644 index 00000000..3a16d053 --- /dev/null +++ b/src/square/types/swap_plan_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from .subscription_action import SubscriptionAction +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class SwapPlanResponse(UncheckedBaseModel): + """ + Defines output parameters in a response of the + [SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The subscription with the updated subscription plan. + """ + + actions: typing.Optional[typing.List[SubscriptionAction]] = pydantic.Field(default=None) + """ + A list of a `SWAP_PLAN` action created by the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tax_calculation_phase.py b/src/square/types/tax_calculation_phase.py new file mode 100644 index 00000000..3443872d --- /dev/null +++ b/src/square/types/tax_calculation_phase.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TaxCalculationPhase = typing.Union[typing.Literal["TAX_SUBTOTAL_PHASE", "TAX_TOTAL_PHASE"], typing.Any] diff --git a/src/square/types/tax_ids.py b/src/square/types/tax_ids.py new file mode 100644 index 00000000..b85cd296 --- /dev/null +++ b/src/square/types/tax_ids.py @@ -0,0 +1,53 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TaxIds(UncheckedBaseModel): + """ + Identifiers for the location used by various governments for tax purposes. + """ + + eu_vat: typing.Optional[str] = pydantic.Field(default=None) + """ + The EU VAT number for this location. For example, `IE3426675K`. + If the EU VAT number is present, it is well-formed and has been + validated with VIES, the VAT Information Exchange System. + """ + + fr_siret: typing.Optional[str] = pydantic.Field(default=None) + """ + The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements) + number is a 14-digit code issued by the French INSEE. For example, `39922799000021`. + """ + + fr_naf: typing.Optional[str] = pydantic.Field(default=None) + """ + The French government uses the NAF (Nomenclature des Activités Françaises) to display and + track economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code. + For example, `6910Z`. + """ + + es_nif: typing.Optional[str] = pydantic.Field(default=None) + """ + The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain. + If it is present, it has been validated. For example, `73628495A`. + """ + + jp_qii: typing.Optional[str] = pydantic.Field(default=None) + """ + The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan. + For example, `T1234567890123`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tax_inclusion_type.py b/src/square/types/tax_inclusion_type.py new file mode 100644 index 00000000..5e2b0502 --- /dev/null +++ b/src/square/types/tax_inclusion_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TaxInclusionType = typing.Union[typing.Literal["ADDITIVE", "INCLUSIVE"], typing.Any] diff --git a/src/square/types/team_member.py b/src/square/types/team_member.py new file mode 100644 index 00000000..ba9dfccc --- /dev/null +++ b/src/square/types/team_member.py @@ -0,0 +1,88 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .team_member_status import TeamMemberStatus +from .team_member_assigned_locations import TeamMemberAssignedLocations +from .wage_setting import WageSetting +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TeamMember(UncheckedBaseModel): + """ + A record representing an individual team member for a business. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique ID for the team member. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + A second ID used to associate the team member with an entity in another system. + """ + + is_owner: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the team member is the owner of the Square account. + """ + + status: typing.Optional[TeamMemberStatus] = pydantic.Field(default=None) + """ + Describes the status of the team member. + See [TeamMemberStatus](#type-teammemberstatus) for possible values + """ + + given_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The given name (that is, the first name) associated with the team member. + """ + + family_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The family name (that is, the last name) associated with the team member. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address associated with the team member. After accepting the invitation + from Square, only the team member can change this value. + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The team member's phone number, in E.164 format. For example: + +14155552671 - the country code is 1 for US + +551155256325 - the country code is 55 for BR + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the team member was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the team member was last updated, in RFC 3339 format. + """ + + assigned_locations: typing.Optional[TeamMemberAssignedLocations] = pydantic.Field(default=None) + """ + Describes the team member's assigned locations. + """ + + wage_setting: typing.Optional[WageSetting] = pydantic.Field(default=None) + """ + Information about the team member's overtime exemption status, job assignments, and compensation. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/team_member_assigned_locations.py b/src/square/types/team_member_assigned_locations.py new file mode 100644 index 00000000..9bff9be6 --- /dev/null +++ b/src/square/types/team_member_assigned_locations.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member_assigned_locations_assignment_type import TeamMemberAssignedLocationsAssignmentType +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TeamMemberAssignedLocations(UncheckedBaseModel): + """ + An object that represents a team member's assignment to locations. + """ + + assignment_type: typing.Optional[TeamMemberAssignedLocationsAssignmentType] = pydantic.Field(default=None) + """ + The current assignment type of the team member. + See [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) for possible values + """ + + location_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The explicit locations that the team member is assigned to. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/team_member_assigned_locations_assignment_type.py b/src/square/types/team_member_assigned_locations_assignment_type.py new file mode 100644 index 00000000..b6c184ba --- /dev/null +++ b/src/square/types/team_member_assigned_locations_assignment_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TeamMemberAssignedLocationsAssignmentType = typing.Union[ + typing.Literal["ALL_CURRENT_AND_FUTURE_LOCATIONS", "EXPLICIT_LOCATIONS"], typing.Any +] diff --git a/src/square/types/team_member_booking_profile.py b/src/square/types/team_member_booking_profile.py new file mode 100644 index 00000000..0e987d84 --- /dev/null +++ b/src/square/types/team_member_booking_profile.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TeamMemberBookingProfile(UncheckedBaseModel): + """ + The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [TeamMember](entity:TeamMember) object for the team member associated with the booking profile. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description of the team member. + """ + + display_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The display name of the team member. + """ + + is_bookable: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true`) or not (`false`). + """ + + profile_image_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of the team member's image for the bookings profile. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/team_member_status.py b/src/square/types/team_member_status.py new file mode 100644 index 00000000..e8be2ebd --- /dev/null +++ b/src/square/types/team_member_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TeamMemberStatus = typing.Union[typing.Literal["ACTIVE", "INACTIVE"], typing.Any] diff --git a/src/square/types/team_member_wage.py b/src/square/types/team_member_wage.py new file mode 100644 index 00000000..9bf3e7c3 --- /dev/null +++ b/src/square/types/team_member_wage.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TeamMemberWage(UncheckedBaseModel): + """ + The hourly wage rate that a team member earns on a `Shift` for doing the job + specified by the `title` property of this object. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The UUID for this object. + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The `TeamMember` that this wage is assigned to. + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The job title that this wage relates to. + """ + + hourly_rate: typing.Optional[Money] = pydantic.Field(default=None) + """ + Can be a custom-set hourly wage or the calculated effective hourly + wage based on the annual wage and hours worked per week. + """ + + job_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An identifier for the job that this wage relates to. This cannot be + used to retrieve the job. + """ + + tip_eligible: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether team members are eligible for tips when working this job. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender.py b/src/square/types/tender.py new file mode 100644 index 00000000..633bb34d --- /dev/null +++ b/src/square/types/tender.py @@ -0,0 +1,133 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .tender_type import TenderType +from .tender_card_details import TenderCardDetails +from .tender_cash_details import TenderCashDetails +from .tender_bank_account_details import TenderBankAccountDetails +from .tender_buy_now_pay_later_details import TenderBuyNowPayLaterDetails +from .tender_square_account_details import TenderSquareAccountDetails +from .additional_recipient import AdditionalRecipient +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Tender(UncheckedBaseModel): + """ + Represents a tender (i.e., a method of payment) used in a Square transaction. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The tender's unique ID. It is the associated payment ID. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the transaction's associated location. + """ + + transaction_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the tender's associated transaction. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp for when the tender was created, in RFC 3339 format. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional note associated with the tender at the time of payment. + """ + + amount_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, + the `total_money` of the corresponding [Payment](entity:Payment) will be equal to the + `amount_money` of the tender. + """ + + tip_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The tip's amount of the tender. + """ + + processing_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of any Square processing fees applied to the tender. + + This field is not immediately populated when a new transaction is created. + It is usually available after about ten seconds. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + If the tender is associated with a customer or represents a customer's card on file, + this is the ID of the associated customer. + """ + + type: TenderType = pydantic.Field() + """ + The type of tender, such as `CARD` or `CASH`. + See [TenderType](#type-tendertype) for possible values + """ + + card_details: typing.Optional[TenderCardDetails] = pydantic.Field(default=None) + """ + The details of the card tender. + + This value is present only if the value of `type` is `CARD`. + """ + + cash_details: typing.Optional[TenderCashDetails] = pydantic.Field(default=None) + """ + The details of the cash tender. + + This value is present only if the value of `type` is `CASH`. + """ + + bank_account_details: typing.Optional[TenderBankAccountDetails] = pydantic.Field(default=None) + """ + The details of the bank account tender. + + This value is present only if the value of `type` is `BANK_ACCOUNT`. + """ + + buy_now_pay_later_details: typing.Optional[TenderBuyNowPayLaterDetails] = pydantic.Field(default=None) + """ + The details of a Buy Now Pay Later tender. + + This value is present only if the value of `type` is `BUY_NOW_PAY_LATER`. + """ + + square_account_details: typing.Optional[TenderSquareAccountDetails] = pydantic.Field(default=None) + """ + The details of a Square Account tender. + + This value is present only if the value of `type` is `SQUARE_ACCOUNT`. + """ + + additional_recipients: typing.Optional[typing.List[AdditionalRecipient]] = pydantic.Field(default=None) + """ + Additional recipients (other than the merchant) receiving a portion of this tender. + For example, fees assessed on the purchase by a third party integration. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the [Payment](entity:Payment) that corresponds to this tender. + This value is only present for payments created with the v2 Payments API. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender_bank_account_details.py b/src/square/types/tender_bank_account_details.py new file mode 100644 index 00000000..3eca5c09 --- /dev/null +++ b/src/square/types/tender_bank_account_details.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .tender_bank_account_details_status import TenderBankAccountDetailsStatus +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TenderBankAccountDetails(UncheckedBaseModel): + """ + Represents the details of a tender with `type` `BANK_ACCOUNT`. + + See [BankAccountPaymentDetails](entity:BankAccountPaymentDetails) + for more exposed details of a bank account payment. + """ + + status: typing.Optional[TenderBankAccountDetailsStatus] = pydantic.Field(default=None) + """ + The bank account payment's current state. + + See [TenderBankAccountPaymentDetailsStatus](entity:TenderBankAccountDetailsStatus) for possible values. + See [TenderBankAccountDetailsStatus](#type-tenderbankaccountdetailsstatus) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender_bank_account_details_status.py b/src/square/types/tender_bank_account_details_status.py new file mode 100644 index 00000000..c7bb236e --- /dev/null +++ b/src/square/types/tender_bank_account_details_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderBankAccountDetailsStatus = typing.Union[typing.Literal["PENDING", "COMPLETED", "FAILED"], typing.Any] diff --git a/src/square/types/tender_buy_now_pay_later_details.py b/src/square/types/tender_buy_now_pay_later_details.py new file mode 100644 index 00000000..5def3410 --- /dev/null +++ b/src/square/types/tender_buy_now_pay_later_details.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .tender_buy_now_pay_later_details_brand import TenderBuyNowPayLaterDetailsBrand +import pydantic +from .tender_buy_now_pay_later_details_status import TenderBuyNowPayLaterDetailsStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TenderBuyNowPayLaterDetails(UncheckedBaseModel): + """ + Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`. + """ + + buy_now_pay_later_brand: typing.Optional[TenderBuyNowPayLaterDetailsBrand] = pydantic.Field(default=None) + """ + The Buy Now Pay Later brand. + See [Brand](#type-brand) for possible values + """ + + status: typing.Optional[TenderBuyNowPayLaterDetailsStatus] = pydantic.Field(default=None) + """ + The buy now pay later payment's current state (such as `AUTHORIZED` or + `CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](entity:TenderBuyNowPayLaterDetailsStatus) + for possible values. + See [Status](#type-status) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender_buy_now_pay_later_details_brand.py b/src/square/types/tender_buy_now_pay_later_details_brand.py new file mode 100644 index 00000000..61006218 --- /dev/null +++ b/src/square/types/tender_buy_now_pay_later_details_brand.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderBuyNowPayLaterDetailsBrand = typing.Union[typing.Literal["OTHER_BRAND", "AFTERPAY"], typing.Any] diff --git a/src/square/types/tender_buy_now_pay_later_details_status.py b/src/square/types/tender_buy_now_pay_later_details_status.py new file mode 100644 index 00000000..3e684216 --- /dev/null +++ b/src/square/types/tender_buy_now_pay_later_details_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderBuyNowPayLaterDetailsStatus = typing.Union[ + typing.Literal["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], typing.Any +] diff --git a/src/square/types/tender_card_details.py b/src/square/types/tender_card_details.py new file mode 100644 index 00000000..44534777 --- /dev/null +++ b/src/square/types/tender_card_details.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .tender_card_details_status import TenderCardDetailsStatus +import pydantic +from .card import Card +from .tender_card_details_entry_method import TenderCardDetailsEntryMethod +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TenderCardDetails(UncheckedBaseModel): + """ + Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` + """ + + status: typing.Optional[TenderCardDetailsStatus] = pydantic.Field(default=None) + """ + The credit card payment's current state (such as `AUTHORIZED` or + `CAPTURED`). See [TenderCardDetailsStatus](entity:TenderCardDetailsStatus) + for possible values. + See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values + """ + + card: typing.Optional[Card] = pydantic.Field(default=None) + """ + The credit card's non-confidential details. + """ + + entry_method: typing.Optional[TenderCardDetailsEntryMethod] = pydantic.Field(default=None) + """ + The method used to enter the card's details for the transaction. + See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender_card_details_entry_method.py b/src/square/types/tender_card_details_entry_method.py new file mode 100644 index 00000000..dac1d3ac --- /dev/null +++ b/src/square/types/tender_card_details_entry_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderCardDetailsEntryMethod = typing.Union[ + typing.Literal["SWIPED", "KEYED", "EMV", "ON_FILE", "CONTACTLESS"], typing.Any +] diff --git a/src/square/types/tender_card_details_status.py b/src/square/types/tender_card_details_status.py new file mode 100644 index 00000000..6f58643f --- /dev/null +++ b/src/square/types/tender_card_details_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderCardDetailsStatus = typing.Union[typing.Literal["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], typing.Any] diff --git a/src/square/types/tender_cash_details.py b/src/square/types/tender_cash_details.py new file mode 100644 index 00000000..6ce866ad --- /dev/null +++ b/src/square/types/tender_cash_details.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .money import Money +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TenderCashDetails(UncheckedBaseModel): + """ + Represents the details of a tender with `type` `CASH`. + """ + + buyer_tendered_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The total amount of cash provided by the buyer, before change is given. + """ + + change_back_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount of change returned to the buyer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender_square_account_details.py b/src/square/types/tender_square_account_details.py new file mode 100644 index 00000000..801f6bec --- /dev/null +++ b/src/square/types/tender_square_account_details.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .tender_square_account_details_status import TenderSquareAccountDetailsStatus +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TenderSquareAccountDetails(UncheckedBaseModel): + """ + Represents the details of a tender with `type` `SQUARE_ACCOUNT`. + """ + + status: typing.Optional[TenderSquareAccountDetailsStatus] = pydantic.Field(default=None) + """ + The Square Account payment's current state (such as `AUTHORIZED` or + `CAPTURED`). See [TenderSquareAccountDetailsStatus](entity:TenderSquareAccountDetailsStatus) + for possible values. + See [Status](#type-status) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tender_square_account_details_status.py b/src/square/types/tender_square_account_details_status.py new file mode 100644 index 00000000..92733b43 --- /dev/null +++ b/src/square/types/tender_square_account_details_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderSquareAccountDetailsStatus = typing.Union[ + typing.Literal["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], typing.Any +] diff --git a/src/square/types/tender_type.py b/src/square/types/tender_type.py new file mode 100644 index 00000000..b9060a79 --- /dev/null +++ b/src/square/types/tender_type.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TenderType = typing.Union[ + typing.Literal[ + "CARD", + "CASH", + "THIRD_PARTY_CARD", + "SQUARE_GIFT_CARD", + "NO_SALE", + "BANK_ACCOUNT", + "WALLET", + "BUY_NOW_PAY_LATER", + "SQUARE_ACCOUNT", + "OTHER", + ], + typing.Any, +] diff --git a/src/square/types/terminal_action.py b/src/square/types/terminal_action.py new file mode 100644 index 00000000..02b08174 --- /dev/null +++ b/src/square/types/terminal_action.py @@ -0,0 +1,152 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .action_cancel_reason import ActionCancelReason +from .terminal_action_action_type import TerminalActionActionType +from .qr_code_options import QrCodeOptions +from .save_card_options import SaveCardOptions +from .signature_options import SignatureOptions +from .confirmation_options import ConfirmationOptions +from .receipt_options import ReceiptOptions +from .data_collection_options import DataCollectionOptions +from .select_options import SelectOptions +from .device_metadata import DeviceMetadata +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalAction(UncheckedBaseModel): + """ + Represents an action processed by the Square Terminal. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for this `TerminalAction`. + """ + + device_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique Id of the device intended for this `TerminalAction`. + The Id can be retrieved from /v2/devices api. + """ + + deadline_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The duration as an RFC 3339 duration, after which the action will be automatically canceled. + TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason + of `TIMED_OUT` + + Default: 5 minutes from creation + + Maximum: 5 minutes + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The status of the `TerminalAction`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + cancel_reason: typing.Optional[ActionCancelReason] = pydantic.Field(default=None) + """ + The reason why `TerminalAction` is canceled. Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the `TerminalAction` was created as an RFC 3339 timestamp. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the `TerminalAction` was last updated as an RFC 3339 timestamp. + """ + + app_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the application that created the action. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location id the action is attached to, if a link can be made. + """ + + type: typing.Optional[TerminalActionActionType] = pydantic.Field(default=None) + """ + Represents the type of the action. + See [ActionType](#type-actiontype) for possible values + """ + + qr_code_options: typing.Optional[QrCodeOptions] = pydantic.Field(default=None) + """ + Describes configuration for the QR code action. Requires `QR_CODE` type. + """ + + save_card_options: typing.Optional[SaveCardOptions] = pydantic.Field(default=None) + """ + Describes configuration for the save-card action. Requires `SAVE_CARD` type. + """ + + signature_options: typing.Optional[SignatureOptions] = pydantic.Field(default=None) + """ + Describes configuration for the signature capture action. Requires `SIGNATURE` type. + """ + + confirmation_options: typing.Optional[ConfirmationOptions] = pydantic.Field(default=None) + """ + Describes configuration for the confirmation action. Requires `CONFIRMATION` type. + """ + + receipt_options: typing.Optional[ReceiptOptions] = pydantic.Field(default=None) + """ + Describes configuration for the receipt action. Requires `RECEIPT` type. + """ + + data_collection_options: typing.Optional[DataCollectionOptions] = pydantic.Field(default=None) + """ + Describes configuration for the data collection action. Requires `DATA_COLLECTION` type. + """ + + select_options: typing.Optional[SelectOptions] = pydantic.Field(default=None) + """ + Describes configuration for the select action. Requires `SELECT` type. + """ + + device_metadata: typing.Optional[DeviceMetadata] = pydantic.Field(default=None) + """ + Details about the Terminal that received the action request (such as battery level, + operating system version, and network connection settings). + + Only available for `PING` action type. + """ + + await_next_action: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates the action will be linked to another action and requires a waiting dialog to be + displayed instead of returning to the idle screen on completion of the action. + + Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types. + """ + + await_next_action_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The timeout duration of the waiting dialog as an RFC 3339 duration, after which the + waiting dialog will no longer be displayed and the Terminal will return to the idle screen. + + Default: 5 minutes from when the waiting dialog is displayed + + Maximum: 5 minutes + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_action_action_type.py b/src/square/types/terminal_action_action_type.py new file mode 100644 index 00000000..7b993aeb --- /dev/null +++ b/src/square/types/terminal_action_action_type.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TerminalActionActionType = typing.Union[ + typing.Literal["QR_CODE", "PING", "SAVE_CARD", "SIGNATURE", "CONFIRMATION", "RECEIPT", "DATA_COLLECTION", "SELECT"], + typing.Any, +] diff --git a/src/square/types/terminal_action_query.py b/src/square/types/terminal_action_query.py new file mode 100644 index 00000000..9bafe4a4 --- /dev/null +++ b/src/square/types/terminal_action_query.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .terminal_action_query_filter import TerminalActionQueryFilter +import pydantic +from .terminal_action_query_sort import TerminalActionQuerySort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalActionQuery(UncheckedBaseModel): + filter: typing.Optional[TerminalActionQueryFilter] = pydantic.Field(default=None) + """ + Options for filtering returned `TerminalAction`s + """ + + sort: typing.Optional[TerminalActionQuerySort] = pydantic.Field(default=None) + """ + Option for sorting returned `TerminalAction` objects. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_action_query_filter.py b/src/square/types/terminal_action_query_filter.py new file mode 100644 index 00000000..44558065 --- /dev/null +++ b/src/square/types/terminal_action_query_filter.py @@ -0,0 +1,44 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .time_range import TimeRange +from .terminal_action_action_type import TerminalActionActionType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalActionQueryFilter(UncheckedBaseModel): + device_id: typing.Optional[str] = pydantic.Field(default=None) + """ + `TerminalAction`s associated with a specific device. If no device is specified then all + `TerminalAction`s for the merchant will be displayed. + """ + + created_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + Time range for the beginning of the reporting period. Inclusive. + Default value: The current time minus one day. + Note that `TerminalAction`s are available for 30 days after creation. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + Filter results with the desired status of the `TerminalAction` + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + type: typing.Optional[TerminalActionActionType] = pydantic.Field(default=None) + """ + Filter results with the requested ActionType. + See [TerminalActionActionType](#type-terminalactionactiontype) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_action_query_sort.py b/src/square/types/terminal_action_query_sort.py new file mode 100644 index 00000000..7637b769 --- /dev/null +++ b/src/square/types/terminal_action_query_sort.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .sort_order import SortOrder +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalActionQuerySort(UncheckedBaseModel): + sort_order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_checkout.py b/src/square/types/terminal_checkout.py new file mode 100644 index 00000000..4ff3d092 --- /dev/null +++ b/src/square/types/terminal_checkout.py @@ -0,0 +1,158 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .payment_options import PaymentOptions +from .device_checkout_options import DeviceCheckoutOptions +from .action_cancel_reason import ActionCancelReason +from .checkout_options_payment_type import CheckoutOptionsPaymentType +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalCheckout(UncheckedBaseModel): + """ + Represents a checkout processed by the Square Terminal. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for this `TerminalCheckout`. + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money (including the tax amount) that the Square Terminal device should try to collect. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional user-defined reference ID that can be used to associate + this `TerminalCheckout` to another entity in an external system. For example, an order + ID generated by a third-party shopping cart. The ID is also associated with any payments + used to complete the checkout. + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional note to associate with the checkout, as well as with any payments used to complete the checkout. + Note: maximum 500 characters + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The reference to the Square order ID for the checkout request. + """ + + payment_options: typing.Optional[PaymentOptions] = pydantic.Field(default=None) + """ + Payment-specific options for the checkout request. + """ + + device_options: DeviceCheckoutOptions = pydantic.Field() + """ + Options to control the display and behavior of the Square Terminal device. + """ + + deadline_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339 duration, after which the checkout is automatically canceled. + A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason + of `TIMED_OUT`. + + Default: 5 minutes from creation + + Maximum: 5 minutes + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The status of the `TerminalCheckout`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + cancel_reason: typing.Optional[ActionCancelReason] = pydantic.Field(default=None) + """ + The reason why `TerminalCheckout` is canceled. Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + """ + + payment_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + A list of IDs for payments created by this `TerminalCheckout`. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp. + """ + + app_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the application that created the checkout. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location of the device where the `TerminalCheckout` was directed. + """ + + payment_type: typing.Optional[CheckoutOptionsPaymentType] = pydantic.Field(default=None) + """ + The type of payment the terminal should attempt to capture from. Defaults to `CARD_PRESENT`. + See [CheckoutOptionsPaymentType](#type-checkoutoptionspaymenttype) for possible values + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID of the team member associated with creating the checkout. + """ + + customer_id: typing.Optional[str] = pydantic.Field(default=None) + """ + An optional ID of the customer associated with the checkout. + """ + + app_fee_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount the developer is taking as a fee for facilitating the payment on behalf + of the seller. + + The amount cannot be more than 90% of the total amount of the payment. + + The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + + The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. + + For more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + + To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions). + """ + + statement_description_identifier: typing.Optional[str] = pydantic.Field(default=None) + """ + Optional additional payment information to include on the customer's card statement as + part of the statement description. This can be, for example, an invoice number, ticket number, + or short description that uniquely identifies the purchase. + """ + + tip_money: typing.Optional[Money] = pydantic.Field(default=None) + """ + The amount designated as a tip, in addition to `amount_money`. This may only be set for a + checkout that has tipping disabled (`tip_settings.allow_tipping` is `false`). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_checkout_query.py b/src/square/types/terminal_checkout_query.py new file mode 100644 index 00000000..21f39bd0 --- /dev/null +++ b/src/square/types/terminal_checkout_query.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .terminal_checkout_query_filter import TerminalCheckoutQueryFilter +import pydantic +from .terminal_checkout_query_sort import TerminalCheckoutQuerySort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalCheckoutQuery(UncheckedBaseModel): + filter: typing.Optional[TerminalCheckoutQueryFilter] = pydantic.Field(default=None) + """ + Options for filtering returned `TerminalCheckout` objects. + """ + + sort: typing.Optional[TerminalCheckoutQuerySort] = pydantic.Field(default=None) + """ + Option for sorting returned `TerminalCheckout` objects. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_checkout_query_filter.py b/src/square/types/terminal_checkout_query_filter.py new file mode 100644 index 00000000..9debdd7e --- /dev/null +++ b/src/square/types/terminal_checkout_query_filter.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .time_range import TimeRange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalCheckoutQueryFilter(UncheckedBaseModel): + device_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all + `TerminalCheckout` objects for the merchant are displayed. + """ + + created_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + The time range for the beginning of the reporting period, which is inclusive. + Default value: The current time minus one day. + Note that `TerminalCheckout`s are available for 30 days after creation. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + Filtered results with the desired status of the `TerminalCheckout`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_checkout_query_sort.py b/src/square/types/terminal_checkout_query_sort.py new file mode 100644 index 00000000..57c0b784 --- /dev/null +++ b/src/square/types/terminal_checkout_query_sort.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .sort_order import SortOrder +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalCheckoutQuerySort(UncheckedBaseModel): + sort_order: typing.Optional[SortOrder] = pydantic.Field(default=None) + """ + The order in which results are listed. + Default: `DESC` + See [SortOrder](#type-sortorder) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_refund.py b/src/square/types/terminal_refund.py new file mode 100644 index 00000000..05dbdcd2 --- /dev/null +++ b/src/square/types/terminal_refund.py @@ -0,0 +1,104 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .money import Money +from .action_cancel_reason import ActionCancelReason +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalRefund(UncheckedBaseModel): + """ + Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique ID for this `TerminalRefund`. + """ + + refund_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The reference to the payment refund created by completing this `TerminalRefund`. + """ + + payment_id: str = pydantic.Field() + """ + The unique ID of the payment being refunded. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The reference to the Square order ID for the payment identified by the `payment_id`. + """ + + amount_money: Money = pydantic.Field() + """ + The amount of money, inclusive of `tax_money`, that the `TerminalRefund` should return. + This value is limited to the amount taken in the original payment minus any completed or + pending refunds. + """ + + reason: str = pydantic.Field() + """ + A description of the reason for the refund. + """ + + device_id: str = pydantic.Field() + """ + The unique ID of the device intended for this `TerminalRefund`. + The Id can be retrieved from /v2/devices api. + """ + + deadline_duration: typing.Optional[str] = pydantic.Field(default=None) + """ + The RFC 3339 duration, after which the refund is automatically canceled. + A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason + of `TIMED_OUT`. + + Default: 5 minutes from creation. + + Maximum: 5 minutes + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The status of the `TerminalRefund`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. + """ + + cancel_reason: typing.Optional[ActionCancelReason] = pydantic.Field(default=None) + """ + Present if the status is `CANCELED`. + See [ActionCancelReason](#type-actioncancelreason) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the `TerminalRefund` was created, as an RFC 3339 timestamp. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp. + """ + + app_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the application that created the refund. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The location of the device where the `TerminalRefund` was directed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_refund_query.py b/src/square/types/terminal_refund_query.py new file mode 100644 index 00000000..5de00d39 --- /dev/null +++ b/src/square/types/terminal_refund_query.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .terminal_refund_query_filter import TerminalRefundQueryFilter +import pydantic +from .terminal_refund_query_sort import TerminalRefundQuerySort +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalRefundQuery(UncheckedBaseModel): + filter: typing.Optional[TerminalRefundQueryFilter] = pydantic.Field(default=None) + """ + The filter for the Terminal refund query. + """ + + sort: typing.Optional[TerminalRefundQuerySort] = pydantic.Field(default=None) + """ + The sort order for the Terminal refund query. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_refund_query_filter.py b/src/square/types/terminal_refund_query_filter.py new file mode 100644 index 00000000..ca8cd910 --- /dev/null +++ b/src/square/types/terminal_refund_query_filter.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .time_range import TimeRange +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalRefundQueryFilter(UncheckedBaseModel): + device_id: typing.Optional[str] = pydantic.Field(default=None) + """ + `TerminalRefund` objects associated with a specific device. If no device is specified, then all + `TerminalRefund` objects for the signed-in account are displayed. + """ + + created_at: typing.Optional[TimeRange] = pydantic.Field(default=None) + """ + The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. + Default value: The current time minus one day. + Note that `TerminalRefund`s are available for 30 days after creation. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + Filtered results with the desired status of the `TerminalRefund`. + Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/terminal_refund_query_sort.py b/src/square/types/terminal_refund_query_sort.py new file mode 100644 index 00000000..b5d2ee09 --- /dev/null +++ b/src/square/types/terminal_refund_query_sort.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TerminalRefundQuerySort(UncheckedBaseModel): + sort_order: typing.Optional[str] = pydantic.Field(default=None) + """ + The order in which results are listed. + - `ASC` - Oldest to newest. + - `DESC` - Newest to oldest (default). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/test_webhook_subscription_response.py b/src/square/types/test_webhook_subscription_response.py new file mode 100644 index 00000000..78bed135 --- /dev/null +++ b/src/square/types/test_webhook_subscription_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription_test_result import SubscriptionTestResult +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TestWebhookSubscriptionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) endpoint. + + Note: If there are errors processing the request, the [SubscriptionTestResult](entity:SubscriptionTestResult) field is not + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + subscription_test_result: typing.Optional[SubscriptionTestResult] = pydantic.Field(default=None) + """ + The [SubscriptionTestResult](entity:SubscriptionTestResult). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/time_range.py b/src/square/types/time_range.py new file mode 100644 index 00000000..0c475dc8 --- /dev/null +++ b/src/square/types/time_range.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TimeRange(UncheckedBaseModel): + """ + Represents a generic time range. The start and end values are + represented in RFC 3339 format. Time ranges are customized to be + inclusive or exclusive based on the needs of a particular endpoint. + Refer to the relevant endpoint-specific documentation to determine + how time ranges are handled. + """ + + start_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A datetime value in RFC 3339 format indicating when the time range + starts. + """ + + end_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A datetime value in RFC 3339 format indicating when the time range + ends. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/tip_settings.py b/src/square/types/tip_settings.py new file mode 100644 index 00000000..32d81742 --- /dev/null +++ b/src/square/types/tip_settings.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class TipSettings(UncheckedBaseModel): + allow_tipping: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether tipping is enabled for this checkout. Defaults to false. + """ + + separate_tip_screen: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether tip options should be presented on the screen before presenting + the signature screen during card payment. Defaults to false. + """ + + custom_tip_field: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false. + """ + + tip_percentages: typing.Optional[typing.List[int]] = pydantic.Field(default=None) + """ + A list of tip percentages that should be presented during the checkout flow, specified as + up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25. + """ + + smart_tipping: typing.Optional[bool] = pydantic.Field(default=None) + """ + Enables the "Smart Tip Amounts" behavior. + Exact tipping options depend on the region in which the Square seller is active. + + For payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00. + + For payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%. + + If set to true, the `tip_percentages` settings is ignored. + Defaults to false. + + To learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/transaction.py b/src/square/types/transaction.py new file mode 100644 index 00000000..f9151bba --- /dev/null +++ b/src/square/types/transaction.py @@ -0,0 +1,91 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .tender import Tender +from .refund import Refund +from .transaction_product import TransactionProduct +from .address import Address +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Transaction(UncheckedBaseModel): + """ + Represents a transaction processed with Square, either with the + Connect API or with Square Point of Sale. + + The `tenders` field of this object lists all methods of payment used to pay in + the transaction. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The transaction's unique ID, issued by Square payments servers. + """ + + location_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the transaction's associated location. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp for when the transaction was created, in RFC 3339 format. + """ + + tenders: typing.Optional[typing.List[Tender]] = pydantic.Field(default=None) + """ + The tenders used to pay in the transaction. + """ + + refunds: typing.Optional[typing.List[Refund]] = pydantic.Field(default=None) + """ + Refunds that have been applied to any tender in the transaction. + """ + + reference_id: typing.Optional[str] = pydantic.Field(default=None) + """ + If the transaction was created with the [Charge](api-endpoint:Transactions-Charge) + endpoint, this value is the same as the value provided for the `reference_id` + parameter in the request to that endpoint. Otherwise, it is not set. + """ + + product: typing.Optional[TransactionProduct] = pydantic.Field(default=None) + """ + The Square product that processed the transaction. + See [TransactionProduct](#type-transactionproduct) for possible values + """ + + client_id: typing.Optional[str] = pydantic.Field(default=None) + """ + If the transaction was created in the Square Point of Sale app, this value + is the ID generated for the transaction by Square Point of Sale. + + This ID has no relationship to the transaction's canonical `id`, which is + generated by Square's backend servers. This value is generated for bookkeeping + purposes, in case the transaction cannot immediately be completed (for example, + if the transaction is processed in offline mode). + + It is not currently possible with the Connect API to perform a transaction + lookup by this value. + """ + + shipping_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The shipping address provided in the request, if any. + """ + + order_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The order_id is an identifier for the order associated with this transaction, if any. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/transaction_product.py b/src/square/types/transaction_product.py new file mode 100644 index 00000000..2b08ceed --- /dev/null +++ b/src/square/types/transaction_product.py @@ -0,0 +1,10 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TransactionProduct = typing.Union[ + typing.Literal[ + "REGISTER", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "OTHER" + ], + typing.Any, +] diff --git a/src/square/types/unlink_customer_from_gift_card_response.py b/src/square/types/unlink_customer_from_gift_card_response.py new file mode 100644 index 00000000..ea438824 --- /dev/null +++ b/src/square/types/unlink_customer_from_gift_card_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .gift_card import GiftCard +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UnlinkCustomerFromGiftCardResponse(UncheckedBaseModel): + """ + A response that contains the unlinked `GiftCard` object. If the request resulted in errors, + the response contains a set of `Error` objects. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + gift_card: typing.Optional[GiftCard] = pydantic.Field(default=None) + """ + The gift card with the ID of the unlinked customer removed from the `customer_ids` field. + If no other customers are linked, the `customer_ids` field is also removed. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_booking_custom_attribute_definition_response.py b/src/square/types/update_booking_custom_attribute_definition_response.py new file mode 100644 index 00000000..e3f86f90 --- /dev/null +++ b/src/square/types/update_booking_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateBookingCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The updated custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_booking_response.py b/src/square/types/update_booking_response.py new file mode 100644 index 00000000..358b4ce8 --- /dev/null +++ b/src/square/types/update_booking_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .booking import Booking +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateBookingResponse(UncheckedBaseModel): + booking: typing.Optional[Booking] = pydantic.Field(default=None) + """ + The booking that was updated. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_break_type_response.py b/src/square/types/update_break_type_response.py new file mode 100644 index 00000000..b4343f00 --- /dev/null +++ b/src/square/types/update_break_type_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .break_type import BreakType +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateBreakTypeResponse(UncheckedBaseModel): + """ + A response to a request to update a `BreakType`. The response contains + the requested `BreakType` objects and might contain a set of `Error` objects if + the request resulted in errors. + """ + + break_type: typing.Optional[BreakType] = pydantic.Field(default=None) + """ + The response object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_catalog_image_request.py b/src/square/types/update_catalog_image_request.py new file mode 100644 index 00000000..f7065c8e --- /dev/null +++ b/src/square/types/update_catalog_image_request.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing + + +class UpdateCatalogImageRequest(UncheckedBaseModel): + idempotency_key: str = pydantic.Field() + """ + A unique string that identifies this UpdateCatalogImage request. + Keys can be any valid string but must be unique for every UpdateCatalogImage request. + + See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_catalog_image_response.py b/src/square/types/update_catalog_image_response.py new file mode 100644 index 00000000..be333701 --- /dev/null +++ b/src/square/types/update_catalog_image_response.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateCatalogImageResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + image: typing.Optional[CatalogObject] = pydantic.Field(default=None) + """ + The newly updated `CatalogImage` including a Square-generated + URL for the encapsulated image file. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_customer_custom_attribute_definition_response.py b/src/square/types/update_customer_custom_attribute_definition_response.py new file mode 100644 index 00000000..b8db8ec6 --- /dev/null +++ b/src/square/types/update_customer_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateCustomerCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The updated custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_customer_group_response.py b/src/square/types/update_customer_group_response.py new file mode 100644 index 00000000..c112bb8f --- /dev/null +++ b/src/square/types/update_customer_group_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer_group import CustomerGroup +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateCustomerGroupResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [UpdateCustomerGroup](api-endpoint:CustomerGroups-UpdateCustomerGroup) endpoint. + + Either `errors` or `group` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + group: typing.Optional[CustomerGroup] = pydantic.Field(default=None) + """ + The successfully updated customer group. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_customer_response.py b/src/square/types/update_customer_response.py new file mode 100644 index 00000000..15163056 --- /dev/null +++ b/src/square/types/update_customer_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .customer import Customer +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateCustomerResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [UpdateCustomer](api-endpoint:Customers-UpdateCustomer) or + [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint. + + Either `errors` or `customer` is present in a given response (never both). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + customer: typing.Optional[Customer] = pydantic.Field(default=None) + """ + The updated customer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_invoice_response.py b/src/square/types/update_invoice_response.py new file mode 100644 index 00000000..fdc87474 --- /dev/null +++ b/src/square/types/update_invoice_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .invoice import Invoice +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateInvoiceResponse(UncheckedBaseModel): + """ + Describes a `UpdateInvoice` response. + """ + + invoice: typing.Optional[Invoice] = pydantic.Field(default=None) + """ + The updated invoice. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_item_modifier_lists_response.py b/src/square/types/update_item_modifier_lists_response.py new file mode 100644 index 00000000..a88b6b08 --- /dev/null +++ b/src/square/types/update_item_modifier_lists_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateItemModifierListsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_item_taxes_response.py b/src/square/types/update_item_taxes_response.py new file mode 100644 index 00000000..96c7c729 --- /dev/null +++ b/src/square/types/update_item_taxes_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateItemTaxesResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_job_response.py b/src/square/types/update_job_response.py new file mode 100644 index 00000000..f68f1046 --- /dev/null +++ b/src/square/types/update_job_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .job import Job +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateJobResponse(UncheckedBaseModel): + """ + Represents an [UpdateJob](api-endpoint:Team-UpdateJob) response. Either `job` or `errors` + is present in the response. + """ + + job: typing.Optional[Job] = pydantic.Field(default=None) + """ + The updated job. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_location_custom_attribute_definition_response.py b/src/square/types/update_location_custom_attribute_definition_response.py new file mode 100644 index 00000000..047b8af3 --- /dev/null +++ b/src/square/types/update_location_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateLocationCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The updated custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_location_response.py b/src/square/types/update_location_response.py new file mode 100644 index 00000000..e841ec2e --- /dev/null +++ b/src/square/types/update_location_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .location import Location +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateLocationResponse(UncheckedBaseModel): + """ + The response object returned by the [UpdateLocation](api-endpoint:Locations-UpdateLocation) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information about errors encountered during the request. + """ + + location: typing.Optional[Location] = pydantic.Field(default=None) + """ + The updated `Location` object. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_location_settings_response.py b/src/square/types/update_location_settings_response.py new file mode 100644 index 00000000..6b6efa16 --- /dev/null +++ b/src/square/types/update_location_settings_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .checkout_location_settings import CheckoutLocationSettings +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateLocationSettingsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred when updating the location settings. + """ + + location_settings: typing.Optional[CheckoutLocationSettings] = pydantic.Field(default=None) + """ + The updated location settings. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_merchant_custom_attribute_definition_response.py b/src/square/types/update_merchant_custom_attribute_definition_response.py new file mode 100644 index 00000000..db2b924c --- /dev/null +++ b/src/square/types/update_merchant_custom_attribute_definition_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateMerchantCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The updated custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_merchant_settings_response.py b/src/square/types/update_merchant_settings_response.py new file mode 100644 index 00000000..30e2bc90 --- /dev/null +++ b/src/square/types/update_merchant_settings_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .checkout_merchant_settings import CheckoutMerchantSettings +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateMerchantSettingsResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred when updating the merchant settings. + """ + + merchant_settings: typing.Optional[CheckoutMerchantSettings] = pydantic.Field(default=None) + """ + The updated merchant settings. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_order_custom_attribute_definition_response.py b/src/square/types/update_order_custom_attribute_definition_response.py new file mode 100644 index 00000000..0b01f719 --- /dev/null +++ b/src/square/types/update_order_custom_attribute_definition_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute_definition import CustomAttributeDefinition +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateOrderCustomAttributeDefinitionResponse(UncheckedBaseModel): + """ + Represents a response from updating an order custom attribute definition. + """ + + custom_attribute_definition: typing.Optional[CustomAttributeDefinition] = pydantic.Field(default=None) + """ + The updated order custom attribute definition. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_order_response.py b/src/square/types/update_order_response.py new file mode 100644 index 00000000..2e8e72d7 --- /dev/null +++ b/src/square/types/update_order_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .order import Order +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateOrderResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint. + """ + + order: typing.Optional[Order] = pydantic.Field(default=None) + """ + The updated order. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_payment_link_response.py b/src/square/types/update_payment_link_response.py new file mode 100644 index 00000000..cb85cbf8 --- /dev/null +++ b/src/square/types/update_payment_link_response.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment_link import PaymentLink +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdatePaymentLinkResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred when updating the payment link. + """ + + payment_link: typing.Optional[PaymentLink] = pydantic.Field(default=None) + """ + The updated payment link. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_payment_response.py b/src/square/types/update_payment_response.py new file mode 100644 index 00000000..8f4cce62 --- /dev/null +++ b/src/square/types/update_payment_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .payment import Payment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdatePaymentResponse(UncheckedBaseModel): + """ + Defines the response returned by + [UpdatePayment](api-endpoint:Payments-UpdatePayment). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + payment: typing.Optional[Payment] = pydantic.Field(default=None) + """ + The updated payment. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_shift_response.py b/src/square/types/update_shift_response.py new file mode 100644 index 00000000..706356fd --- /dev/null +++ b/src/square/types/update_shift_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .shift import Shift +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateShiftResponse(UncheckedBaseModel): + """ + The response to a request to update a `Shift`. The response contains + the updated `Shift` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + shift: typing.Optional[Shift] = pydantic.Field(default=None) + """ + The updated `Shift`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_subscription_response.py b/src/square/types/update_subscription_response.py new file mode 100644 index 00000000..a641bc9b --- /dev/null +++ b/src/square/types/update_subscription_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .subscription import Subscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateSubscriptionResponse(UncheckedBaseModel): + """ + Defines output parameters in a response from the + [UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors encountered during the request. + """ + + subscription: typing.Optional[Subscription] = pydantic.Field(default=None) + """ + The updated subscription. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_team_member_request.py b/src/square/types/update_team_member_request.py new file mode 100644 index 00000000..5fde7795 --- /dev/null +++ b/src/square/types/update_team_member_request.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member import TeamMember +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateTeamMemberRequest(UncheckedBaseModel): + """ + Represents an update request for a `TeamMember` object. + """ + + team_member: typing.Optional[TeamMember] = pydantic.Field(default=None) + """ + The team member fields to add, change, or clear. Fields can be cleared using a null value. To update + `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call + [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_team_member_response.py b/src/square/types/update_team_member_response.py new file mode 100644 index 00000000..47a21d55 --- /dev/null +++ b/src/square/types/update_team_member_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .team_member import TeamMember +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateTeamMemberResponse(UncheckedBaseModel): + """ + Represents a response from an update request containing the updated `TeamMember` object or error messages. + """ + + team_member: typing.Optional[TeamMember] = pydantic.Field(default=None) + """ + The successfully updated `TeamMember` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_vendor_request.py b/src/square/types/update_vendor_request.py new file mode 100644 index 00000000..11ab8c91 --- /dev/null +++ b/src/square/types/update_vendor_request.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .vendor import Vendor +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateVendorRequest(UncheckedBaseModel): + """ + Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor). + """ + + idempotency_key: typing.Optional[str] = pydantic.Field(default=None) + """ + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + """ + + vendor: Vendor = pydantic.Field() + """ + The specified [Vendor](entity:Vendor) to be updated. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_vendor_response.py b/src/square/types/update_vendor_response.py new file mode 100644 index 00000000..ec88f014 --- /dev/null +++ b/src/square/types/update_vendor_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .vendor import Vendor +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateVendorResponse(UncheckedBaseModel): + """ + Represents an output from a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor). + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Errors occurred when the request fails. + """ + + vendor: typing.Optional[Vendor] = pydantic.Field(default=None) + """ + The [Vendor](entity:Vendor) that has been updated. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_wage_setting_response.py b/src/square/types/update_wage_setting_response.py new file mode 100644 index 00000000..daf2a67a --- /dev/null +++ b/src/square/types/update_wage_setting_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .wage_setting import WageSetting +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateWageSettingResponse(UncheckedBaseModel): + """ + Represents a response from an update request containing the updated `WageSetting` object + or error messages. + """ + + wage_setting: typing.Optional[WageSetting] = pydantic.Field(default=None) + """ + The successfully updated `WageSetting` object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + The errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_webhook_subscription_response.py b/src/square/types/update_webhook_subscription_response.py new file mode 100644 index 00000000..19ed439c --- /dev/null +++ b/src/square/types/update_webhook_subscription_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .webhook_subscription import WebhookSubscription +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateWebhookSubscriptionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription) endpoint. + + Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + subscription: typing.Optional[WebhookSubscription] = pydantic.Field(default=None) + """ + The updated [Subscription](entity:WebhookSubscription). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_webhook_subscription_signature_key_response.py b/src/square/types/update_webhook_subscription_signature_key_response.py new file mode 100644 index 00000000..a991ab89 --- /dev/null +++ b/src/square/types/update_webhook_subscription_signature_key_response.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateWebhookSubscriptionSignatureKeyResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) endpoint. + + Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not + present. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Information on errors encountered during the request. + """ + + signature_key: typing.Optional[str] = pydantic.Field(default=None) + """ + The new Square-generated signature key used to validate the origin of the webhook event. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/update_workweek_config_response.py b/src/square/types/update_workweek_config_response.py new file mode 100644 index 00000000..26b1ef6e --- /dev/null +++ b/src/square/types/update_workweek_config_response.py @@ -0,0 +1,35 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .workweek_config import WorkweekConfig +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpdateWorkweekConfigResponse(UncheckedBaseModel): + """ + The response to a request to update a `WorkweekConfig` object. The response contains + the updated `WorkweekConfig` object and might contain a set of `Error` objects if + the request resulted in errors. + """ + + workweek_config: typing.Optional[WorkweekConfig] = pydantic.Field(default=None) + """ + The response object. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_booking_custom_attribute_response.py b/src/square/types/upsert_booking_custom_attribute_response.py new file mode 100644 index 00000000..4f28c387 --- /dev/null +++ b/src/square/types/upsert_booking_custom_attribute_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertBookingCustomAttributeResponse(UncheckedBaseModel): + """ + Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_catalog_object_response.py b/src/square/types/upsert_catalog_object_response.py new file mode 100644 index 00000000..16cbf9c9 --- /dev/null +++ b/src/square/types/upsert_catalog_object_response.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +from .catalog_category import CatalogCategory +from .catalog_item import CatalogItem +from .catalog_item_option import CatalogItemOption +from .catalog_modifier_list import CatalogModifierList +from .catalog_object_category import CatalogObjectCategory +from .catalog_object_item import CatalogObjectItem +from .catalog_object_item_option import CatalogObjectItemOption +from .catalog_object_modifier_list import CatalogObjectModifierList +from .catalog_object_subscription_plan import CatalogObjectSubscriptionPlan +from .catalog_subscription_plan import CatalogSubscriptionPlan +import typing +from .error import Error +import pydantic +from .catalog_object import CatalogObject +from .catalog_id_mapping import CatalogIdMapping +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertCatalogObjectResponse(UncheckedBaseModel): + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + catalog_object: typing.Optional[CatalogObject] = pydantic.Field(default=None) + """ + The successfully created or updated CatalogObject. + """ + + id_mappings: typing.Optional[typing.List[CatalogIdMapping]] = pydantic.Field(default=None) + """ + The mapping between client and server IDs for this upsert. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_customer_custom_attribute_response.py b/src/square/types/upsert_customer_custom_attribute_response.py new file mode 100644 index 00000000..bc2cdbee --- /dev/null +++ b/src/square/types/upsert_customer_custom_attribute_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertCustomerCustomAttributeResponse(UncheckedBaseModel): + """ + Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_location_custom_attribute_response.py b/src/square/types/upsert_location_custom_attribute_response.py new file mode 100644 index 00000000..5d3f1f3a --- /dev/null +++ b/src/square/types/upsert_location_custom_attribute_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertLocationCustomAttributeResponse(UncheckedBaseModel): + """ + Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_merchant_custom_attribute_response.py b/src/square/types/upsert_merchant_custom_attribute_response.py new file mode 100644 index 00000000..1049406d --- /dev/null +++ b/src/square/types/upsert_merchant_custom_attribute_response.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertMerchantCustomAttributeResponse(UncheckedBaseModel): + """ + Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) response. + Either `custom_attribute_definition` or `errors` is present in the response. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The new or updated custom attribute. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_order_custom_attribute_response.py b/src/square/types/upsert_order_custom_attribute_response.py new file mode 100644 index 00000000..1f6dbf15 --- /dev/null +++ b/src/square/types/upsert_order_custom_attribute_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .custom_attribute import CustomAttribute +import pydantic +from .error import Error +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertOrderCustomAttributeResponse(UncheckedBaseModel): + """ + Represents a response from upserting order custom attribute definitions. + """ + + custom_attribute: typing.Optional[CustomAttribute] = pydantic.Field(default=None) + """ + The order custom attribute that was created or modified. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/upsert_snippet_response.py b/src/square/types/upsert_snippet_response.py new file mode 100644 index 00000000..ef081467 --- /dev/null +++ b/src/square/types/upsert_snippet_response.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .snippet import Snippet +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class UpsertSnippetResponse(UncheckedBaseModel): + """ + Represents an `UpsertSnippet` response. The response can include either `snippet` or `errors`. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + snippet: typing.Optional[Snippet] = pydantic.Field(default=None) + """ + The new or updated snippet. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/v1money.py b/src/square/types/v1money.py new file mode 100644 index 00000000..19def97c --- /dev/null +++ b/src/square/types/v1money.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .currency import Currency +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class V1Money(UncheckedBaseModel): + amount: typing.Optional[int] = pydantic.Field(default=None) + """ + Amount in the lowest denominated value of this Currency. E.g. in USD + these are cents, in JPY they are Yen (which do not have a 'cent' concept). + """ + + currency_code: typing.Optional[Currency] = pydantic.Field(default=None) + """ + + See [Currency](#type-currency) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/v1order.py b/src/square/types/v1order.py new file mode 100644 index 00000000..4247f4d8 --- /dev/null +++ b/src/square/types/v1order.py @@ -0,0 +1,153 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from .v1order_state import V1OrderState +from .address import Address +from .v1money import V1Money +from .v1tender import V1Tender +from .v1order_history_entry import V1OrderHistoryEntry +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class V1Order(UncheckedBaseModel): + """ + V1Order + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The order's unique identifier. + """ + + buyer_email: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address of the order's buyer. + """ + + recipient_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the order's buyer. + """ + + recipient_phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number to use for the order's delivery. + """ + + state: typing.Optional[V1OrderState] = pydantic.Field(default=None) + """ + Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. + See [V1OrderState](#type-v1orderstate) for possible values + """ + + shipping_address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The address to ship the order to. + """ + + subtotal_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The amount of all items purchased in the order, before taxes and shipping. + """ + + total_shipping_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The shipping cost for the order. + """ + + total_tax_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The total of all taxes applied to the order. + """ + + total_price_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The total cost of the order. + """ + + total_discount_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The total of all discounts applied to the order. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the order was created, in ISO 8601 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the order was last modified, in ISO 8601 format. + """ + + expires_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the order expires if no action is taken, in ISO 8601 format. + """ + + payment_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the payment associated with the order. + """ + + buyer_note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note provided by the buyer when the order was created, if any. + """ + + completed_note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note provided by the merchant when the order's state was set to COMPLETED, if any + """ + + refunded_note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note provided by the merchant when the order's state was set to REFUNDED, if any. + """ + + canceled_note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note provided by the merchant when the order's state was set to CANCELED, if any. + """ + + tender: typing.Optional[V1Tender] = pydantic.Field(default=None) + """ + The tender used to pay for the order. + """ + + order_history: typing.Optional[typing.List[V1OrderHistoryEntry]] = pydantic.Field(default=None) + """ + The history of actions associated with the order. + """ + + promo_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The promo code provided by the buyer, if any. + """ + + btc_receive_address: typing.Optional[str] = pydantic.Field(default=None) + """ + For Bitcoin transactions, the address that the buyer sent Bitcoin to. + """ + + btc_price_satoshi: typing.Optional[float] = pydantic.Field(default=None) + """ + For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/v1order_history_entry.py b/src/square/types/v1order_history_entry.py new file mode 100644 index 00000000..c0b60462 --- /dev/null +++ b/src/square/types/v1order_history_entry.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .v1order_history_entry_action import V1OrderHistoryEntryAction +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class V1OrderHistoryEntry(UncheckedBaseModel): + """ + V1OrderHistoryEntry + """ + + action: typing.Optional[V1OrderHistoryEntryAction] = pydantic.Field(default=None) + """ + The type of action performed on the order. + See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the action was performed, in ISO 8601 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/v1order_history_entry_action.py b/src/square/types/v1order_history_entry_action.py new file mode 100644 index 00000000..93f4f4e5 --- /dev/null +++ b/src/square/types/v1order_history_entry_action.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +V1OrderHistoryEntryAction = typing.Union[ + typing.Literal["ORDER_PLACED", "DECLINED", "PAYMENT_RECEIVED", "CANCELED", "COMPLETED", "REFUNDED", "EXPIRED"], + typing.Any, +] diff --git a/src/square/types/v1order_state.py b/src/square/types/v1order_state.py new file mode 100644 index 00000000..28509e25 --- /dev/null +++ b/src/square/types/v1order_state.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +V1OrderState = typing.Union[ + typing.Literal["PENDING", "OPEN", "COMPLETED", "CANCELED", "REFUNDED", "REJECTED"], typing.Any +] diff --git a/src/square/types/v1tender.py b/src/square/types/v1tender.py new file mode 100644 index 00000000..de11fd69 --- /dev/null +++ b/src/square/types/v1tender.py @@ -0,0 +1,129 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .v1tender_type import V1TenderType +from .v1tender_card_brand import V1TenderCardBrand +from .v1tender_entry_method import V1TenderEntryMethod +from .v1money import V1Money +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class V1Tender(UncheckedBaseModel): + """ + A tender represents a discrete monetary exchange. Square represents this + exchange as a money object with a specific currency and amount, where the + amount is given in the smallest denomination of the given currency. + + Square POS can accept more than one form of tender for a single payment (such + as by splitting a bill between a credit card and a gift card). The `tender` + field of the Payment object lists all forms of tender used for the payment. + + Split tender payments behave slightly differently from single tender payments: + + The receipt_url for a split tender corresponds only to the first tender listed + in the tender field. To get the receipt URLs for the remaining tenders, use + the receipt_url fields of the corresponding Tender objects. + + *A note on gift cards**: when a customer purchases a Square gift card from a + merchant, the merchant receives the full amount of the gift card in the + associated payment. + + When that gift card is used as a tender, the balance of the gift card is + reduced and the merchant receives no funds. A `Tender` object with a type of + `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the + associated payment. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The tender's unique ID. + """ + + type: typing.Optional[V1TenderType] = pydantic.Field(default=None) + """ + The type of tender. + See [V1TenderType](#type-v1tendertype) for possible values + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + A human-readable description of the tender. + """ + + employee_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the employee that processed the tender. + """ + + receipt_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of the receipt for the tender. + """ + + card_brand: typing.Optional[V1TenderCardBrand] = pydantic.Field(default=None) + """ + The brand of credit card provided. + See [V1TenderCardBrand](#type-v1tendercardbrand) for possible values + """ + + pan_suffix: typing.Optional[str] = pydantic.Field(default=None) + """ + The last four digits of the provided credit card's account number. + """ + + entry_method: typing.Optional[V1TenderEntryMethod] = pydantic.Field(default=None) + """ + The tender's unique ID. + See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values + """ + + payment_note: typing.Optional[str] = pydantic.Field(default=None) + """ + Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. + """ + + total_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The total amount of money provided in this form of tender. + """ + + tendered_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The amount of total_money applied to the payment. + """ + + tendered_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the tender was created, in ISO 8601 format. + """ + + settled_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time when the tender was settled, in ISO 8601 format. + """ + + change_back_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The amount of total_money returned to the buyer as change. + """ + + refunded_money: typing.Optional[V1Money] = pydantic.Field(default=None) + """ + The total of all refunds applied to this tender. This amount is always negative or zero. + """ + + is_exchange: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/v1tender_card_brand.py b/src/square/types/v1tender_card_brand.py new file mode 100644 index 00000000..1f49af42 --- /dev/null +++ b/src/square/types/v1tender_card_brand.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +V1TenderCardBrand = typing.Union[ + typing.Literal[ + "OTHER_BRAND", + "VISA", + "MASTER_CARD", + "AMERICAN_EXPRESS", + "DISCOVER", + "DISCOVER_DINERS", + "JCB", + "CHINA_UNIONPAY", + "SQUARE_GIFT_CARD", + ], + typing.Any, +] diff --git a/src/square/types/v1tender_entry_method.py b/src/square/types/v1tender_entry_method.py new file mode 100644 index 00000000..cdd9042e --- /dev/null +++ b/src/square/types/v1tender_entry_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +V1TenderEntryMethod = typing.Union[ + typing.Literal["MANUAL", "SCANNED", "SQUARE_CASH", "SQUARE_WALLET", "SWIPED", "WEB_FORM", "OTHER"], typing.Any +] diff --git a/src/square/types/v1tender_type.py b/src/square/types/v1tender_type.py new file mode 100644 index 00000000..e5217361 --- /dev/null +++ b/src/square/types/v1tender_type.py @@ -0,0 +1,10 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +V1TenderType = typing.Union[ + typing.Literal[ + "CREDIT_CARD", "CASH", "THIRD_PARTY_CARD", "NO_SALE", "SQUARE_WALLET", "SQUARE_GIFT_CARD", "UNKNOWN", "OTHER" + ], + typing.Any, +] diff --git a/src/square/types/v1update_order_request_action.py b/src/square/types/v1update_order_request_action.py new file mode 100644 index 00000000..5ae55098 --- /dev/null +++ b/src/square/types/v1update_order_request_action.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +V1UpdateOrderRequestAction = typing.Union[typing.Literal["COMPLETE", "CANCEL", "REFUND"], typing.Any] diff --git a/src/square/types/vendor.py b/src/square/types/vendor.py new file mode 100644 index 00000000..13dfe71c --- /dev/null +++ b/src/square/types/vendor.py @@ -0,0 +1,79 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .address import Address +from .vendor_contact import VendorContact +from .vendor_status import VendorStatus +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class Vendor(UncheckedBaseModel): + """ + Represents a supplier to a seller. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique Square-generated ID for the [Vendor](entity:Vendor). + This field is required when attempting to update a [Vendor](entity:Vendor). + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339-formatted timestamp that indicates when the + [Vendor](entity:Vendor) was created. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + An RFC 3339-formatted timestamp that indicates when the + [Vendor](entity:Vendor) was last updated. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the [Vendor](entity:Vendor). + This field is required when attempting to create or update a [Vendor](entity:Vendor). + """ + + address: typing.Optional[Address] = pydantic.Field(default=None) + """ + The address of the [Vendor](entity:Vendor). + """ + + contacts: typing.Optional[typing.List[VendorContact]] = pydantic.Field(default=None) + """ + The contacts of the [Vendor](entity:Vendor). + """ + + account_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The account number of the [Vendor](entity:Vendor). + """ + + note: typing.Optional[str] = pydantic.Field(default=None) + """ + A note detailing information about the [Vendor](entity:Vendor). + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The version of the [Vendor](entity:Vendor). + """ + + status: typing.Optional[VendorStatus] = pydantic.Field(default=None) + """ + The status of the [Vendor](entity:Vendor). + See [Status](#type-status) for possible values + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/vendor_contact.py b/src/square/types/vendor_contact.py new file mode 100644 index 00000000..1ba85a35 --- /dev/null +++ b/src/square/types/vendor_contact.py @@ -0,0 +1,53 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class VendorContact(UncheckedBaseModel): + """ + Represents a contact of a [Vendor](entity:Vendor). + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A unique Square-generated ID for the [VendorContact](entity:VendorContact). + This field is required when attempting to update a [VendorContact](entity:VendorContact). + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the [VendorContact](entity:VendorContact). + This field is required when attempting to create a [Vendor](entity:Vendor). + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The email address of the [VendorContact](entity:VendorContact). + """ + + phone_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The phone number of the [VendorContact](entity:VendorContact). + """ + + removed: typing.Optional[bool] = pydantic.Field(default=None) + """ + The state of the [VendorContact](entity:VendorContact). + """ + + ordinal: int = pydantic.Field() + """ + The ordinal of the [VendorContact](entity:VendorContact). + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/vendor_status.py b/src/square/types/vendor_status.py new file mode 100644 index 00000000..4c8f936e --- /dev/null +++ b/src/square/types/vendor_status.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +VendorStatus = typing.Union[typing.Literal["ACTIVE", "INACTIVE"], typing.Any] diff --git a/src/square/types/visibility_filter.py b/src/square/types/visibility_filter.py new file mode 100644 index 00000000..c12e342c --- /dev/null +++ b/src/square/types/visibility_filter.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +VisibilityFilter = typing.Union[typing.Literal["ALL", "READ", "READ_WRITE"], typing.Any] diff --git a/src/square/types/void_transaction_response.py b/src/square/types/void_transaction_response.py new file mode 100644 index 00000000..7882dedb --- /dev/null +++ b/src/square/types/void_transaction_response.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +from .error import Error +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class VoidTransactionResponse(UncheckedBaseModel): + """ + Defines the fields that are included in the response body of + a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint. + """ + + errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None) + """ + Any errors that occurred during the request. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/wage_setting.py b/src/square/types/wage_setting.py new file mode 100644 index 00000000..bc778b18 --- /dev/null +++ b/src/square/types/wage_setting.py @@ -0,0 +1,57 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .job_assignment import JobAssignment +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class WageSetting(UncheckedBaseModel): + """ + Represents information about the overtime exemption status, job assignments, and compensation + for a [team member](entity:TeamMember). + """ + + team_member_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the team member associated with the wage setting. + """ + + job_assignments: typing.Optional[typing.List[JobAssignment]] = pydantic.Field(default=None) + """ + **Required** The ordered list of jobs that the team member is assigned to. + The first job assignment is considered the team member's primary job. + """ + + is_overtime_exempt: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the team member is exempt from the overtime rules of the seller's country. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + **Read only** Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If not provided, + Square executes a blind write, potentially overwriting data from another write. For more information, + see [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency). + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the wage setting was created, in RFC 3339 format. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp when the wage setting was last updated, in RFC 3339 format. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/webhook_subscription.py b/src/square/types/webhook_subscription.py new file mode 100644 index 00000000..547b5223 --- /dev/null +++ b/src/square/types/webhook_subscription.py @@ -0,0 +1,70 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class WebhookSubscription(UncheckedBaseModel): + """ + Represents the details of a webhook subscription, including notification URL, + event types, and signature key. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + A Square-generated unique ID for the subscription. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of this subscription. + """ + + enabled: typing.Optional[bool] = pydantic.Field(default=None) + """ + Indicates whether the subscription is enabled (`true`) or not (`false`). + """ + + event_types: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The event types associated with this subscription. + """ + + notification_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL to which webhooks are sent. + """ + + api_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The API version of the subscription. + This field is optional for `CreateWebhookSubscription`. + The value defaults to the API version used by the application. + """ + + signature_key: typing.Optional[str] = pydantic.Field(default=None) + """ + The Square-generated signature key used to validate the origin of the webhook event. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The timestamp of when the subscription was last updated, in RFC 3339 format. + For example, "2016-09-04T23:59:33.123Z". + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/types/weekday.py b/src/square/types/weekday.py new file mode 100644 index 00000000..e07041a7 --- /dev/null +++ b/src/square/types/weekday.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +Weekday = typing.Union[typing.Literal["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"], typing.Any] diff --git a/src/square/types/workweek_config.py b/src/square/types/workweek_config.py new file mode 100644 index 00000000..b55081c3 --- /dev/null +++ b/src/square/types/workweek_config.py @@ -0,0 +1,60 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.unchecked_base_model import UncheckedBaseModel +import typing +import pydantic +from .weekday import Weekday +from ..core.pydantic_utilities import IS_PYDANTIC_V2 + + +class WorkweekConfig(UncheckedBaseModel): + """ + Sets the day of the week and hour of the day that a business starts a + workweek. This is used to calculate overtime pay. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The UUID for this object. + """ + + start_of_week: Weekday = pydantic.Field() + """ + The day of the week on which a business week starts for + compensation purposes. + See [Weekday](#type-weekday) for possible values + """ + + start_of_day_local_time: str = pydantic.Field() + """ + The local time at which a business week starts. Represented as a + string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are + truncated). + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + Used for resolving concurrency issues. The request fails if the version + provided does not match the server version at the time of the request. If not provided, + Square executes a blind write; potentially overwriting data from another + write. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + A read-only timestamp in RFC 3339 format; presented in UTC. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/square/utils/webhooks_helper.py b/src/square/utils/webhooks_helper.py new file mode 100644 index 00000000..5a11f13a --- /dev/null +++ b/src/square/utils/webhooks_helper.py @@ -0,0 +1,55 @@ +import base64 +import hashlib +import hmac + + +def verify_signature( + *, + request_body: str, + signature_header: str, + signature_key: str, + notification_url: str, +) -> bool: + """ + Verifies and validates an event notification. See the `documentation`_ for more details. + + Args: + request_body: The JSON body of the request. + signature_header: The value for the `x-square-hmacsha256-signature` header. + signature_key: The signature key from the Square Developer portal for the webhook subscription. + notification_url: The notification endpoint URL as defined in the Square Developer portal for the webhook + subscription. + + Returns: + bool: True if the signature is valid, indicating that the event can be trusted as it came from Square. + False if the signature validation fails, indicating that the event did not come from Square, so it may + be malicious and should be discarded. + + Raises: + ValueError: if `signature_key` or `notification_url` are empty. + + .. _documentation: + https://developer.squareup.com/docs/webhooks/step3validate + """ + if not request_body: + return False + if not signature_key: + raise ValueError("signature_key is empty") + if not notification_url: + raise ValueError("notification_url is empty") + + # Perform UTF-8 encoding to bytes + payload = notification_url + request_body + payload_bytes = payload.encode("utf-8") + signature_header_bytes = signature_header.encode("utf-8") + signature_key_bytes = signature_key.encode("utf-8") + + # Compute the hash value + hashing_obj = hmac.new( + key=signature_key_bytes, msg=payload_bytes, digestmod=hashlib.sha256 + ) + hash_bytes = hashing_obj.digest() + + # Compare the computed hash vs the value in the signature header + hash_base64 = base64.b64encode(hash_bytes) + return hmac.compare_digest(hash_base64, signature_header_bytes) diff --git a/src/square/v1transactions/__init__.py b/src/square/v1transactions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/v1transactions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/v1transactions/client.py b/src/square/v1transactions/client.py new file mode 100644 index 00000000..aef97e70 --- /dev/null +++ b/src/square/v1transactions/client.py @@ -0,0 +1,390 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawV1TransactionsClient +from ..types.sort_order import SortOrder +from ..core.request_options import RequestOptions +from ..types.v1order import V1Order +from ..types.v1update_order_request_action import V1UpdateOrderRequestAction +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawV1TransactionsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class V1TransactionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawV1TransactionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawV1TransactionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawV1TransactionsClient + """ + return self._raw_client + + def v1list_orders( + self, + location_id: str, + *, + order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + batch_token: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> typing.List[V1Order]: + """ + Provides summary information for a merchant's online store orders. + + Parameters + ---------- + location_id : str + The ID of the location to list online store orders for. + + order : typing.Optional[SortOrder] + The order in which payments are listed in the response. + + limit : typing.Optional[int] + The maximum number of payments to return in a single response. This value cannot exceed 200. + + batch_token : typing.Optional[str] + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + typing.List[V1Order] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.v1transactions.v1list_orders( + location_id="location_id", + ) + """ + response = self._raw_client.v1list_orders( + location_id, order=order, limit=limit, batch_token=batch_token, request_options=request_options + ) + return response.data + + def v1retrieve_order( + self, location_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> V1Order: + """ + Provides comprehensive information for a single online store order, including the order's history. + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + V1Order + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.v1transactions.v1retrieve_order( + location_id="location_id", + order_id="order_id", + ) + """ + response = self._raw_client.v1retrieve_order(location_id, order_id, request_options=request_options) + return response.data + + def v1update_order( + self, + location_id: str, + order_id: str, + *, + action: V1UpdateOrderRequestAction, + shipped_tracking_number: typing.Optional[str] = OMIT, + completed_note: typing.Optional[str] = OMIT, + refunded_note: typing.Optional[str] = OMIT, + canceled_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> V1Order: + """ + Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + action : V1UpdateOrderRequestAction + The action to perform on the order (COMPLETE, CANCEL, or REFUND). + See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values + + shipped_tracking_number : typing.Optional[str] + The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. + + completed_note : typing.Optional[str] + A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. + + refunded_note : typing.Optional[str] + A merchant-specified note about the refunding of the order. Only valid if action is REFUND. + + canceled_note : typing.Optional[str] + A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + V1Order + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.v1transactions.v1update_order( + location_id="location_id", + order_id="order_id", + action="COMPLETE", + ) + """ + response = self._raw_client.v1update_order( + location_id, + order_id, + action=action, + shipped_tracking_number=shipped_tracking_number, + completed_note=completed_note, + refunded_note=refunded_note, + canceled_note=canceled_note, + request_options=request_options, + ) + return response.data + + +class AsyncV1TransactionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawV1TransactionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawV1TransactionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawV1TransactionsClient + """ + return self._raw_client + + async def v1list_orders( + self, + location_id: str, + *, + order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + batch_token: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> typing.List[V1Order]: + """ + Provides summary information for a merchant's online store orders. + + Parameters + ---------- + location_id : str + The ID of the location to list online store orders for. + + order : typing.Optional[SortOrder] + The order in which payments are listed in the response. + + limit : typing.Optional[int] + The maximum number of payments to return in a single response. This value cannot exceed 200. + + batch_token : typing.Optional[str] + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + typing.List[V1Order] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.v1transactions.v1list_orders( + location_id="location_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.v1list_orders( + location_id, order=order, limit=limit, batch_token=batch_token, request_options=request_options + ) + return response.data + + async def v1retrieve_order( + self, location_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> V1Order: + """ + Provides comprehensive information for a single online store order, including the order's history. + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + V1Order + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.v1transactions.v1retrieve_order( + location_id="location_id", + order_id="order_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.v1retrieve_order(location_id, order_id, request_options=request_options) + return response.data + + async def v1update_order( + self, + location_id: str, + order_id: str, + *, + action: V1UpdateOrderRequestAction, + shipped_tracking_number: typing.Optional[str] = OMIT, + completed_note: typing.Optional[str] = OMIT, + refunded_note: typing.Optional[str] = OMIT, + canceled_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> V1Order: + """ + Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + action : V1UpdateOrderRequestAction + The action to perform on the order (COMPLETE, CANCEL, or REFUND). + See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values + + shipped_tracking_number : typing.Optional[str] + The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. + + completed_note : typing.Optional[str] + A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. + + refunded_note : typing.Optional[str] + A merchant-specified note about the refunding of the order. Only valid if action is REFUND. + + canceled_note : typing.Optional[str] + A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + V1Order + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.v1transactions.v1update_order( + location_id="location_id", + order_id="order_id", + action="COMPLETE", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.v1update_order( + location_id, + order_id, + action=action, + shipped_tracking_number=shipped_tracking_number, + completed_note=completed_note, + refunded_note=refunded_note, + canceled_note=canceled_note, + request_options=request_options, + ) + return response.data diff --git a/src/square/v1transactions/raw_client.py b/src/square/v1transactions/raw_client.py new file mode 100644 index 00000000..19cb25a6 --- /dev/null +++ b/src/square/v1transactions/raw_client.py @@ -0,0 +1,388 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..types.sort_order import SortOrder +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.v1order import V1Order +from ..core.jsonable_encoder import jsonable_encoder +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.v1update_order_request_action import V1UpdateOrderRequestAction +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawV1TransactionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def v1list_orders( + self, + location_id: str, + *, + order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + batch_token: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[typing.List[V1Order]]: + """ + Provides summary information for a merchant's online store orders. + + Parameters + ---------- + location_id : str + The ID of the location to list online store orders for. + + order : typing.Optional[SortOrder] + The order in which payments are listed in the response. + + limit : typing.Optional[int] + The maximum number of payments to return in a single response. This value cannot exceed 200. + + batch_token : typing.Optional[str] + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[typing.List[V1Order]] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v1/{jsonable_encoder(location_id)}/orders", + method="GET", + params={ + "order": order, + "limit": limit, + "batch_token": batch_token, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + typing.List[V1Order], + construct_type( + type_=typing.List[V1Order], # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def v1retrieve_order( + self, location_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[V1Order]: + """ + Provides comprehensive information for a single online store order, including the order's history. + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[V1Order] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v1/{jsonable_encoder(location_id)}/orders/{jsonable_encoder(order_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + V1Order, + construct_type( + type_=V1Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def v1update_order( + self, + location_id: str, + order_id: str, + *, + action: V1UpdateOrderRequestAction, + shipped_tracking_number: typing.Optional[str] = OMIT, + completed_note: typing.Optional[str] = OMIT, + refunded_note: typing.Optional[str] = OMIT, + canceled_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[V1Order]: + """ + Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + action : V1UpdateOrderRequestAction + The action to perform on the order (COMPLETE, CANCEL, or REFUND). + See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values + + shipped_tracking_number : typing.Optional[str] + The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. + + completed_note : typing.Optional[str] + A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. + + refunded_note : typing.Optional[str] + A merchant-specified note about the refunding of the order. Only valid if action is REFUND. + + canceled_note : typing.Optional[str] + A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[V1Order] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v1/{jsonable_encoder(location_id)}/orders/{jsonable_encoder(order_id)}", + method="PUT", + json={ + "action": action, + "shipped_tracking_number": shipped_tracking_number, + "completed_note": completed_note, + "refunded_note": refunded_note, + "canceled_note": canceled_note, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + V1Order, + construct_type( + type_=V1Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawV1TransactionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def v1list_orders( + self, + location_id: str, + *, + order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + batch_token: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[typing.List[V1Order]]: + """ + Provides summary information for a merchant's online store orders. + + Parameters + ---------- + location_id : str + The ID of the location to list online store orders for. + + order : typing.Optional[SortOrder] + The order in which payments are listed in the response. + + limit : typing.Optional[int] + The maximum number of payments to return in a single response. This value cannot exceed 200. + + batch_token : typing.Optional[str] + A pagination cursor to retrieve the next set of results for your + original query to the endpoint. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[typing.List[V1Order]] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v1/{jsonable_encoder(location_id)}/orders", + method="GET", + params={ + "order": order, + "limit": limit, + "batch_token": batch_token, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + typing.List[V1Order], + construct_type( + type_=typing.List[V1Order], # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def v1retrieve_order( + self, location_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[V1Order]: + """ + Provides comprehensive information for a single online store order, including the order's history. + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[V1Order] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v1/{jsonable_encoder(location_id)}/orders/{jsonable_encoder(order_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + V1Order, + construct_type( + type_=V1Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def v1update_order( + self, + location_id: str, + order_id: str, + *, + action: V1UpdateOrderRequestAction, + shipped_tracking_number: typing.Optional[str] = OMIT, + completed_note: typing.Optional[str] = OMIT, + refunded_note: typing.Optional[str] = OMIT, + canceled_note: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[V1Order]: + """ + Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: + + Parameters + ---------- + location_id : str + The ID of the order's associated location. + + order_id : str + The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint + + action : V1UpdateOrderRequestAction + The action to perform on the order (COMPLETE, CANCEL, or REFUND). + See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values + + shipped_tracking_number : typing.Optional[str] + The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. + + completed_note : typing.Optional[str] + A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. + + refunded_note : typing.Optional[str] + A merchant-specified note about the refunding of the order. Only valid if action is REFUND. + + canceled_note : typing.Optional[str] + A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[V1Order] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v1/{jsonable_encoder(location_id)}/orders/{jsonable_encoder(order_id)}", + method="PUT", + json={ + "action": action, + "shipped_tracking_number": shipped_tracking_number, + "completed_note": completed_note, + "refunded_note": refunded_note, + "canceled_note": canceled_note, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + V1Order, + construct_type( + type_=V1Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/vendors/__init__.py b/src/square/vendors/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/vendors/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/vendors/client.py b/src/square/vendors/client.py new file mode 100644 index 00000000..17f82302 --- /dev/null +++ b/src/square/vendors/client.py @@ -0,0 +1,778 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawVendorsClient +from ..requests.vendor import VendorParams +from ..core.request_options import RequestOptions +from ..types.batch_create_vendors_response import BatchCreateVendorsResponse +from ..types.batch_get_vendors_response import BatchGetVendorsResponse +from ..requests.update_vendor_request import UpdateVendorRequestParams +from ..types.batch_update_vendors_response import BatchUpdateVendorsResponse +from ..types.create_vendor_response import CreateVendorResponse +from ..requests.search_vendors_request_filter import SearchVendorsRequestFilterParams +from ..requests.search_vendors_request_sort import SearchVendorsRequestSortParams +from ..types.search_vendors_response import SearchVendorsResponse +from ..types.get_vendor_response import GetVendorResponse +from ..types.update_vendor_response import UpdateVendorResponse +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawVendorsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class VendorsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawVendorsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawVendorsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawVendorsClient + """ + return self._raw_client + + def batch_create( + self, *, vendors: typing.Dict[str, VendorParams], request_options: typing.Optional[RequestOptions] = None + ) -> BatchCreateVendorsResponse: + """ + Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, VendorParams] + Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchCreateVendorsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.batch_create( + vendors={ + "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": { + "name": "Joe's Fresh Seafood", + "address": { + "address_line1": "505 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "contacts": [ + { + "name": "Joe Burrow", + "email_address": "joe@joesfreshseafood.com", + "phone_number": "1-212-555-4250", + "ordinal": 1, + } + ], + "account_number": "4025391", + "note": "a vendor", + } + }, + ) + """ + response = self._raw_client.batch_create(vendors=vendors, request_options=request_options) + return response.data + + def batch_get( + self, + *, + vendor_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetVendorsResponse: + """ + Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs. + + Parameters + ---------- + vendor_ids : typing.Optional[typing.Sequence[str]] + IDs of the [Vendor](entity:Vendor) objects to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetVendorsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.batch_get( + vendor_ids=["INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4"], + ) + """ + response = self._raw_client.batch_get(vendor_ids=vendor_ids, request_options=request_options) + return response.data + + def batch_update( + self, + *, + vendors: typing.Dict[str, UpdateVendorRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpdateVendorsResponse: + """ + Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, UpdateVendorRequestParams] + A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) + objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpdateVendorsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.batch_update( + vendors={ + "FMCYHBWT1TPL8MFH52PBMEN92A": {"vendor": {}}, + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {"vendor": {}}, + }, + ) + """ + response = self._raw_client.batch_update(vendors=vendors, request_options=request_options) + return response.data + + def create( + self, + *, + idempotency_key: str, + vendor: typing.Optional[VendorParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateVendorResponse: + """ + Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + vendor : typing.Optional[VendorParams] + The requested [Vendor](entity:Vendor) to be created. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateVendorResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.create( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + vendor={ + "name": "Joe's Fresh Seafood", + "address": { + "address_line1": "505 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "contacts": [ + { + "name": "Joe Burrow", + "email_address": "joe@joesfreshseafood.com", + "phone_number": "1-212-555-4250", + "ordinal": 1, + } + ], + "account_number": "4025391", + "note": "a vendor", + }, + ) + """ + response = self._raw_client.create( + idempotency_key=idempotency_key, vendor=vendor, request_options=request_options + ) + return response.data + + def search( + self, + *, + filter: typing.Optional[SearchVendorsRequestFilterParams] = OMIT, + sort: typing.Optional[SearchVendorsRequestSortParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchVendorsResponse: + """ + Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter. + + Parameters + ---------- + filter : typing.Optional[SearchVendorsRequestFilterParams] + Specifies a filter used to search for vendors. + + sort : typing.Optional[SearchVendorsRequestSortParams] + Specifies a sorter used to sort the returned vendors. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchVendorsResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.search() + """ + response = self._raw_client.search(filter=filter, sort=sort, cursor=cursor, request_options=request_options) + return response.data + + def get(self, vendor_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetVendorResponse: + """ + Retrieves the vendor of a specified [Vendor](entity:Vendor) ID. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetVendorResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.get( + vendor_id="vendor_id", + ) + """ + response = self._raw_client.get(vendor_id, request_options=request_options) + return response.data + + def update( + self, + vendor_id: str, + *, + vendor: VendorParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateVendorResponse: + """ + Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + vendor : VendorParams + The specified [Vendor](entity:Vendor) to be updated. + + idempotency_key : typing.Optional[str] + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateVendorResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.vendors.update( + vendor_id="vendor_id", + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + vendor={ + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Jack's Chicken Shack", + "version": 1, + "status": "ACTIVE", + }, + ) + """ + response = self._raw_client.update( + vendor_id, vendor=vendor, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + +class AsyncVendorsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawVendorsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawVendorsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawVendorsClient + """ + return self._raw_client + + async def batch_create( + self, *, vendors: typing.Dict[str, VendorParams], request_options: typing.Optional[RequestOptions] = None + ) -> BatchCreateVendorsResponse: + """ + Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, VendorParams] + Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchCreateVendorsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.batch_create( + vendors={ + "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": { + "name": "Joe's Fresh Seafood", + "address": { + "address_line1": "505 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "contacts": [ + { + "name": "Joe Burrow", + "email_address": "joe@joesfreshseafood.com", + "phone_number": "1-212-555-4250", + "ordinal": 1, + } + ], + "account_number": "4025391", + "note": "a vendor", + } + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_create(vendors=vendors, request_options=request_options) + return response.data + + async def batch_get( + self, + *, + vendor_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchGetVendorsResponse: + """ + Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs. + + Parameters + ---------- + vendor_ids : typing.Optional[typing.Sequence[str]] + IDs of the [Vendor](entity:Vendor) objects to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchGetVendorsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.batch_get( + vendor_ids=["INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4"], + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_get(vendor_ids=vendor_ids, request_options=request_options) + return response.data + + async def batch_update( + self, + *, + vendors: typing.Dict[str, UpdateVendorRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> BatchUpdateVendorsResponse: + """ + Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, UpdateVendorRequestParams] + A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) + objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + BatchUpdateVendorsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.batch_update( + vendors={ + "FMCYHBWT1TPL8MFH52PBMEN92A": {"vendor": {}}, + "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {"vendor": {}}, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.batch_update(vendors=vendors, request_options=request_options) + return response.data + + async def create( + self, + *, + idempotency_key: str, + vendor: typing.Optional[VendorParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateVendorResponse: + """ + Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + vendor : typing.Optional[VendorParams] + The requested [Vendor](entity:Vendor) to be created. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateVendorResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.create( + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + vendor={ + "name": "Joe's Fresh Seafood", + "address": { + "address_line1": "505 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + "contacts": [ + { + "name": "Joe Burrow", + "email_address": "joe@joesfreshseafood.com", + "phone_number": "1-212-555-4250", + "ordinal": 1, + } + ], + "account_number": "4025391", + "note": "a vendor", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + idempotency_key=idempotency_key, vendor=vendor, request_options=request_options + ) + return response.data + + async def search( + self, + *, + filter: typing.Optional[SearchVendorsRequestFilterParams] = OMIT, + sort: typing.Optional[SearchVendorsRequestSortParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> SearchVendorsResponse: + """ + Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter. + + Parameters + ---------- + filter : typing.Optional[SearchVendorsRequestFilterParams] + Specifies a filter used to search for vendors. + + sort : typing.Optional[SearchVendorsRequestSortParams] + Specifies a sorter used to sort the returned vendors. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SearchVendorsResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.search() + + + asyncio.run(main()) + """ + response = await self._raw_client.search( + filter=filter, sort=sort, cursor=cursor, request_options=request_options + ) + return response.data + + async def get( + self, vendor_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetVendorResponse: + """ + Retrieves the vendor of a specified [Vendor](entity:Vendor) ID. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetVendorResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.get( + vendor_id="vendor_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(vendor_id, request_options=request_options) + return response.data + + async def update( + self, + vendor_id: str, + *, + vendor: VendorParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateVendorResponse: + """ + Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + vendor : VendorParams + The specified [Vendor](entity:Vendor) to be updated. + + idempotency_key : typing.Optional[str] + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateVendorResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.vendors.update( + vendor_id="vendor_id", + idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", + vendor={ + "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", + "name": "Jack's Chicken Shack", + "version": 1, + "status": "ACTIVE", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + vendor_id, vendor=vendor, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data diff --git a/src/square/vendors/raw_client.py b/src/square/vendors/raw_client.py new file mode 100644 index 00000000..b220f201 --- /dev/null +++ b/src/square/vendors/raw_client.py @@ -0,0 +1,789 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ..core.client_wrapper import SyncClientWrapper +from ..requests.vendor import VendorParams +from ..core.request_options import RequestOptions +from ..core.http_response import HttpResponse +from ..types.batch_create_vendors_response import BatchCreateVendorsResponse +from ..core.serialization import convert_and_respect_annotation_metadata +from ..core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ..core.api_error import ApiError +from ..types.batch_get_vendors_response import BatchGetVendorsResponse +from ..requests.update_vendor_request import UpdateVendorRequestParams +from ..types.batch_update_vendors_response import BatchUpdateVendorsResponse +from ..types.create_vendor_response import CreateVendorResponse +from ..requests.search_vendors_request_filter import SearchVendorsRequestFilterParams +from ..requests.search_vendors_request_sort import SearchVendorsRequestSortParams +from ..types.search_vendors_response import SearchVendorsResponse +from ..types.get_vendor_response import GetVendorResponse +from ..core.jsonable_encoder import jsonable_encoder +from ..types.update_vendor_response import UpdateVendorResponse +from ..core.client_wrapper import AsyncClientWrapper +from ..core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawVendorsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def batch_create( + self, *, vendors: typing.Dict[str, VendorParams], request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[BatchCreateVendorsResponse]: + """ + Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, VendorParams] + Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchCreateVendorsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/vendors/bulk-create", + method="POST", + json={ + "vendors": convert_and_respect_annotation_metadata( + object_=vendors, annotation=typing.Dict[str, VendorParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchCreateVendorsResponse, + construct_type( + type_=BatchCreateVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_get( + self, + *, + vendor_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchGetVendorsResponse]: + """ + Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs. + + Parameters + ---------- + vendor_ids : typing.Optional[typing.Sequence[str]] + IDs of the [Vendor](entity:Vendor) objects to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchGetVendorsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/vendors/bulk-retrieve", + method="POST", + json={ + "vendor_ids": vendor_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetVendorsResponse, + construct_type( + type_=BatchGetVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def batch_update( + self, + *, + vendors: typing.Dict[str, UpdateVendorRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BatchUpdateVendorsResponse]: + """ + Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, UpdateVendorRequestParams] + A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) + objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BatchUpdateVendorsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/vendors/bulk-update", + method="PUT", + json={ + "vendors": convert_and_respect_annotation_metadata( + object_=vendors, annotation=typing.Dict[str, UpdateVendorRequestParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpdateVendorsResponse, + construct_type( + type_=BatchUpdateVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + idempotency_key: str, + vendor: typing.Optional[VendorParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateVendorResponse]: + """ + Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + vendor : typing.Optional[VendorParams] + The requested [Vendor](entity:Vendor) to be created. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateVendorResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/vendors/create", + method="POST", + json={ + "idempotency_key": idempotency_key, + "vendor": convert_and_respect_annotation_metadata( + object_=vendor, annotation=VendorParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateVendorResponse, + construct_type( + type_=CreateVendorResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def search( + self, + *, + filter: typing.Optional[SearchVendorsRequestFilterParams] = OMIT, + sort: typing.Optional[SearchVendorsRequestSortParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SearchVendorsResponse]: + """ + Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter. + + Parameters + ---------- + filter : typing.Optional[SearchVendorsRequestFilterParams] + Specifies a filter used to search for vendors. + + sort : typing.Optional[SearchVendorsRequestSortParams] + Specifies a sorter used to sort the returned vendors. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SearchVendorsResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/vendors/search", + method="POST", + json={ + "filter": convert_and_respect_annotation_metadata( + object_=filter, annotation=SearchVendorsRequestFilterParams, direction="write" + ), + "sort": convert_and_respect_annotation_metadata( + object_=sort, annotation=SearchVendorsRequestSortParams, direction="write" + ), + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchVendorsResponse, + construct_type( + type_=SearchVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, vendor_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetVendorResponse]: + """ + Retrieves the vendor of a specified [Vendor](entity:Vendor) ID. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetVendorResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/vendors/{jsonable_encoder(vendor_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetVendorResponse, + construct_type( + type_=GetVendorResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + vendor_id: str, + *, + vendor: VendorParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateVendorResponse]: + """ + Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + vendor : VendorParams + The specified [Vendor](entity:Vendor) to be updated. + + idempotency_key : typing.Optional[str] + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateVendorResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/vendors/{jsonable_encoder(vendor_id)}", + method="PUT", + json={ + "idempotency_key": idempotency_key, + "vendor": convert_and_respect_annotation_metadata( + object_=vendor, annotation=VendorParams, direction="write" + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateVendorResponse, + construct_type( + type_=UpdateVendorResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawVendorsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def batch_create( + self, *, vendors: typing.Dict[str, VendorParams], request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[BatchCreateVendorsResponse]: + """ + Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, VendorParams] + Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchCreateVendorsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/vendors/bulk-create", + method="POST", + json={ + "vendors": convert_and_respect_annotation_metadata( + object_=vendors, annotation=typing.Dict[str, VendorParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchCreateVendorsResponse, + construct_type( + type_=BatchCreateVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_get( + self, + *, + vendor_ids: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchGetVendorsResponse]: + """ + Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs. + + Parameters + ---------- + vendor_ids : typing.Optional[typing.Sequence[str]] + IDs of the [Vendor](entity:Vendor) objects to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchGetVendorsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/vendors/bulk-retrieve", + method="POST", + json={ + "vendor_ids": vendor_ids, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchGetVendorsResponse, + construct_type( + type_=BatchGetVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def batch_update( + self, + *, + vendors: typing.Dict[str, UpdateVendorRequestParams], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BatchUpdateVendorsResponse]: + """ + Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller. + + Parameters + ---------- + vendors : typing.Dict[str, UpdateVendorRequestParams] + A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) + objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BatchUpdateVendorsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/vendors/bulk-update", + method="PUT", + json={ + "vendors": convert_and_respect_annotation_metadata( + object_=vendors, annotation=typing.Dict[str, UpdateVendorRequestParams], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BatchUpdateVendorsResponse, + construct_type( + type_=BatchUpdateVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + idempotency_key: str, + vendor: typing.Optional[VendorParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateVendorResponse]: + """ + Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller. + + Parameters + ---------- + idempotency_key : str + A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + vendor : typing.Optional[VendorParams] + The requested [Vendor](entity:Vendor) to be created. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateVendorResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/vendors/create", + method="POST", + json={ + "idempotency_key": idempotency_key, + "vendor": convert_and_respect_annotation_metadata( + object_=vendor, annotation=VendorParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateVendorResponse, + construct_type( + type_=CreateVendorResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def search( + self, + *, + filter: typing.Optional[SearchVendorsRequestFilterParams] = OMIT, + sort: typing.Optional[SearchVendorsRequestSortParams] = OMIT, + cursor: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SearchVendorsResponse]: + """ + Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter. + + Parameters + ---------- + filter : typing.Optional[SearchVendorsRequestFilterParams] + Specifies a filter used to search for vendors. + + sort : typing.Optional[SearchVendorsRequestSortParams] + Specifies a sorter used to sort the returned vendors. + + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for the original query. + + See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SearchVendorsResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/vendors/search", + method="POST", + json={ + "filter": convert_and_respect_annotation_metadata( + object_=filter, annotation=SearchVendorsRequestFilterParams, direction="write" + ), + "sort": convert_and_respect_annotation_metadata( + object_=sort, annotation=SearchVendorsRequestSortParams, direction="write" + ), + "cursor": cursor, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SearchVendorsResponse, + construct_type( + type_=SearchVendorsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, vendor_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetVendorResponse]: + """ + Retrieves the vendor of a specified [Vendor](entity:Vendor) ID. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetVendorResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/vendors/{jsonable_encoder(vendor_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetVendorResponse, + construct_type( + type_=GetVendorResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + vendor_id: str, + *, + vendor: VendorParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateVendorResponse]: + """ + Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller. + + Parameters + ---------- + vendor_id : str + ID of the [Vendor](entity:Vendor) to retrieve. + + vendor : VendorParams + The specified [Vendor](entity:Vendor) to be updated. + + idempotency_key : typing.Optional[str] + A client-supplied, universally unique identifier (UUID) for the + request. + + See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the + [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more + information. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateVendorResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/vendors/{jsonable_encoder(vendor_id)}", + method="PUT", + json={ + "idempotency_key": idempotency_key, + "vendor": convert_and_respect_annotation_metadata( + object_=vendor, annotation=VendorParams, direction="write" + ), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateVendorResponse, + construct_type( + type_=UpdateVendorResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/version.py b/src/square/version.py new file mode 100644 index 00000000..e488fcca --- /dev/null +++ b/src/square/version.py @@ -0,0 +1,3 @@ +from importlib import metadata + +__version__ = metadata.version("squareup") diff --git a/src/square/webhooks/__init__.py b/src/square/webhooks/__init__.py new file mode 100644 index 00000000..d9d0e844 --- /dev/null +++ b/src/square/webhooks/__init__.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +from . import event_types, subscriptions + +__all__ = ["event_types", "subscriptions"] diff --git a/src/square/webhooks/client.py b/src/square/webhooks/client.py new file mode 100644 index 00000000..8f633628 --- /dev/null +++ b/src/square/webhooks/client.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from .raw_client import RawWebhooksClient +from .event_types.client import EventTypesClient +from .subscriptions.client import SubscriptionsClient +from ..core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawWebhooksClient +from .event_types.client import AsyncEventTypesClient +from .subscriptions.client import AsyncSubscriptionsClient + + +class WebhooksClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawWebhooksClient(client_wrapper=client_wrapper) + self.event_types = EventTypesClient(client_wrapper=client_wrapper) + + self.subscriptions = SubscriptionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawWebhooksClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawWebhooksClient + """ + return self._raw_client + + +class AsyncWebhooksClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawWebhooksClient(client_wrapper=client_wrapper) + self.event_types = AsyncEventTypesClient(client_wrapper=client_wrapper) + + self.subscriptions = AsyncSubscriptionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawWebhooksClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawWebhooksClient + """ + return self._raw_client diff --git a/src/square/webhooks/event_types/__init__.py b/src/square/webhooks/event_types/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/webhooks/event_types/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/webhooks/event_types/client.py b/src/square/webhooks/event_types/client.py new file mode 100644 index 00000000..525ee669 --- /dev/null +++ b/src/square/webhooks/event_types/client.py @@ -0,0 +1,111 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawEventTypesClient +import typing +from ...core.request_options import RequestOptions +from ...types.list_webhook_event_types_response import ListWebhookEventTypesResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawEventTypesClient + + +class EventTypesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawEventTypesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawEventTypesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawEventTypesClient + """ + return self._raw_client + + def list( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> ListWebhookEventTypesResponse: + """ + Lists all webhook event types that can be subscribed to. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListWebhookEventTypesResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.event_types.list() + """ + response = self._raw_client.list(api_version=api_version, request_options=request_options) + return response.data + + +class AsyncEventTypesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawEventTypesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawEventTypesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawEventTypesClient + """ + return self._raw_client + + async def list( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> ListWebhookEventTypesResponse: + """ + Lists all webhook event types that can be subscribed to. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + ListWebhookEventTypesResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.event_types.list() + + + asyncio.run(main()) + """ + response = await self._raw_client.list(api_version=api_version, request_options=request_options) + return response.data diff --git a/src/square/webhooks/event_types/raw_client.py b/src/square/webhooks/event_types/raw_client.py new file mode 100644 index 00000000..b837ed34 --- /dev/null +++ b/src/square/webhooks/event_types/raw_client.py @@ -0,0 +1,106 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import SyncClientWrapper +import typing +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.list_webhook_event_types_response import ListWebhookEventTypesResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + + +class RawEventTypesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ListWebhookEventTypesResponse]: + """ + Lists all webhook event types that can be subscribed to. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListWebhookEventTypesResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/webhooks/event-types", + method="GET", + params={ + "api_version": api_version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListWebhookEventTypesResponse, + construct_type( + type_=ListWebhookEventTypesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawEventTypesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, *, api_version: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ListWebhookEventTypesResponse]: + """ + Lists all webhook event types that can be subscribed to. + + Parameters + ---------- + api_version : typing.Optional[str] + The API version for which to list event types. Setting this field overrides the default version used by the application. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListWebhookEventTypesResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/webhooks/event-types", + method="GET", + params={ + "api_version": api_version, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListWebhookEventTypesResponse, + construct_type( + type_=ListWebhookEventTypesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/square/webhooks/raw_client.py b/src/square/webhooks/raw_client.py new file mode 100644 index 00000000..0a57a3ef --- /dev/null +++ b/src/square/webhooks/raw_client.py @@ -0,0 +1,14 @@ +# This file was auto-generated by Fern from our API Definition. + +from ..core.client_wrapper import SyncClientWrapper +from ..core.client_wrapper import AsyncClientWrapper + + +class RawWebhooksClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + +class AsyncRawWebhooksClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper diff --git a/src/square/webhooks/subscriptions/__init__.py b/src/square/webhooks/subscriptions/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/src/square/webhooks/subscriptions/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/src/square/webhooks/subscriptions/client.py b/src/square/webhooks/subscriptions/client.py new file mode 100644 index 00000000..11525ebb --- /dev/null +++ b/src/square/webhooks/subscriptions/client.py @@ -0,0 +1,788 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from .raw_client import RawSubscriptionsClient +from ...types.sort_order import SortOrder +from ...core.request_options import RequestOptions +from ...core.pagination import SyncPager +from ...types.webhook_subscription import WebhookSubscription +from ...types.list_webhook_subscriptions_response import ListWebhookSubscriptionsResponse +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...requests.webhook_subscription import WebhookSubscriptionParams +from ...types.create_webhook_subscription_response import CreateWebhookSubscriptionResponse +from ...types.get_webhook_subscription_response import GetWebhookSubscriptionResponse +from ...types.update_webhook_subscription_response import UpdateWebhookSubscriptionResponse +from ...types.delete_webhook_subscription_response import DeleteWebhookSubscriptionResponse +from ...types.update_webhook_subscription_signature_key_response import UpdateWebhookSubscriptionSignatureKeyResponse +from ...types.test_webhook_subscription_response import TestWebhookSubscriptionResponse +from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawSubscriptionsClient +from ...core.pagination import AsyncPager + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class SubscriptionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawSubscriptionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawSubscriptionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawSubscriptionsClient + """ + return self._raw_client + + def list( + self, + *, + cursor: typing.Optional[str] = None, + include_disabled: typing.Optional[bool] = None, + sort_order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> SyncPager[WebhookSubscription]: + """ + Lists all webhook subscriptions owned by your application. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + include_disabled : typing.Optional[bool] + Includes disabled [Subscription](entity:WebhookSubscription)s. + By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. + + sort_order : typing.Optional[SortOrder] + Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order. + This field defaults to ASC. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + The default value of 100 is also the maximum allowed value. + + Default: 100 + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + SyncPager[WebhookSubscription] + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + response = client.webhooks.subscriptions.list() + for item in response: + yield item + # alternatively, you can paginate page-by-page + for page in response.iter_pages(): + yield page + """ + _response = self._raw_client._client_wrapper.httpx_client.request( + "v2/webhooks/subscriptions", + method="GET", + params={ + "cursor": cursor, + "include_disabled": include_disabled, + "sort_order": sort_order, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListWebhookSubscriptionsResponse, + construct_type( + type_=ListWebhookSubscriptionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + include_disabled=include_disabled, + sort_order=sort_order, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.subscriptions + return SyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def create( + self, + *, + subscription: WebhookSubscriptionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateWebhookSubscriptionResponse: + """ + Creates a webhook subscription. + + Parameters + ---------- + subscription : WebhookSubscriptionParams + The [Subscription](entity:WebhookSubscription) to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateWebhookSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.subscriptions.create( + idempotency_key="63f84c6c-2200-4c99-846c-2670a1311fbf", + subscription={ + "name": "Example Webhook Subscription", + "event_types": ["payment.created", "payment.updated"], + "notification_url": "https://example-webhook-url.com", + "api_version": "2021-12-15", + }, + ) + """ + response = self._raw_client.create( + subscription=subscription, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def get( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetWebhookSubscriptionResponse: + """ + Retrieves a webhook subscription identified by its ID. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetWebhookSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.subscriptions.get( + subscription_id="subscription_id", + ) + """ + response = self._raw_client.get(subscription_id, request_options=request_options) + return response.data + + def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[WebhookSubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateWebhookSubscriptionResponse: + """ + Updates a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + subscription : typing.Optional[WebhookSubscriptionParams] + The [Subscription](entity:WebhookSubscription) to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWebhookSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.subscriptions.update( + subscription_id="subscription_id", + subscription={ + "name": "Updated Example Webhook Subscription", + "enabled": False, + }, + ) + """ + response = self._raw_client.update(subscription_id, subscription=subscription, request_options=request_options) + return response.data + + def delete( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteWebhookSubscriptionResponse: + """ + Deletes a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteWebhookSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.subscriptions.delete( + subscription_id="subscription_id", + ) + """ + response = self._raw_client.delete(subscription_id, request_options=request_options) + return response.data + + def update_signature_key( + self, + subscription_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateWebhookSubscriptionSignatureKeyResponse: + """ + Updates a webhook subscription by replacing the existing signature key with a new one. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWebhookSubscriptionSignatureKeyResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.subscriptions.update_signature_key( + subscription_id="subscription_id", + idempotency_key="ed80ae6b-0654-473b-bbab-a39aee89a60d", + ) + """ + response = self._raw_client.update_signature_key( + subscription_id, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + def test( + self, + subscription_id: str, + *, + event_type: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> TestWebhookSubscriptionResponse: + """ + Tests a webhook subscription by sending a test event to the notification URL. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test. + + event_type : typing.Optional[str] + The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be + contained in the list of event types in the [Subscription](entity:WebhookSubscription). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + TestWebhookSubscriptionResponse + Success + + Examples + -------- + from square import Square + + client = Square( + token="YOUR_TOKEN", + ) + client.webhooks.subscriptions.test( + subscription_id="subscription_id", + event_type="payment.created", + ) + """ + response = self._raw_client.test(subscription_id, event_type=event_type, request_options=request_options) + return response.data + + +class AsyncSubscriptionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawSubscriptionsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawSubscriptionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawSubscriptionsClient + """ + return self._raw_client + + async def list( + self, + *, + cursor: typing.Optional[str] = None, + include_disabled: typing.Optional[bool] = None, + sort_order: typing.Optional[SortOrder] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncPager[WebhookSubscription]: + """ + Lists all webhook subscriptions owned by your application. + + Parameters + ---------- + cursor : typing.Optional[str] + A pagination cursor returned by a previous call to this endpoint. + Provide this to retrieve the next set of results for your original query. + + For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). + + include_disabled : typing.Optional[bool] + Includes disabled [Subscription](entity:WebhookSubscription)s. + By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. + + sort_order : typing.Optional[SortOrder] + Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order. + This field defaults to ASC. + + limit : typing.Optional[int] + The maximum number of results to be returned in a single page. + It is possible to receive fewer results than the specified limit on a given page. + The default value of 100 is also the maximum allowed value. + + Default: 100 + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncPager[WebhookSubscription] + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + response = await client.webhooks.subscriptions.list() + async for item in response: + yield item + # alternatively, you can paginate page-by-page + async for page in response.iter_pages(): + yield page + + + asyncio.run(main()) + """ + _response = await self._raw_client._client_wrapper.httpx_client.request( + "v2/webhooks/subscriptions", + method="GET", + params={ + "cursor": cursor, + "include_disabled": include_disabled, + "sort_order": sort_order, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _parsed_response = typing.cast( + ListWebhookSubscriptionsResponse, + construct_type( + type_=ListWebhookSubscriptionsResponse, # type: ignore + object_=_response.json(), + ), + ) + _parsed_next = _parsed_response.cursor + _has_next = _parsed_next is not None and _parsed_next != "" + _get_next = lambda: self.list( + cursor=_parsed_next, + include_disabled=include_disabled, + sort_order=sort_order, + limit=limit, + request_options=request_options, + ) + _items = _parsed_response.subscriptions + return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def create( + self, + *, + subscription: WebhookSubscriptionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> CreateWebhookSubscriptionResponse: + """ + Creates a webhook subscription. + + Parameters + ---------- + subscription : WebhookSubscriptionParams + The [Subscription](entity:WebhookSubscription) to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CreateWebhookSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.subscriptions.create( + idempotency_key="63f84c6c-2200-4c99-846c-2670a1311fbf", + subscription={ + "name": "Example Webhook Subscription", + "event_types": ["payment.created", "payment.updated"], + "notification_url": "https://example-webhook-url.com", + "api_version": "2021-12-15", + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.create( + subscription=subscription, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def get( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> GetWebhookSubscriptionResponse: + """ + Retrieves a webhook subscription identified by its ID. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GetWebhookSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.subscriptions.get( + subscription_id="subscription_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.get(subscription_id, request_options=request_options) + return response.data + + async def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[WebhookSubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateWebhookSubscriptionResponse: + """ + Updates a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + subscription : typing.Optional[WebhookSubscriptionParams] + The [Subscription](entity:WebhookSubscription) to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWebhookSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.subscriptions.update( + subscription_id="subscription_id", + subscription={ + "name": "Updated Example Webhook Subscription", + "enabled": False, + }, + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update( + subscription_id, subscription=subscription, request_options=request_options + ) + return response.data + + async def delete( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteWebhookSubscriptionResponse: + """ + Deletes a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteWebhookSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.subscriptions.delete( + subscription_id="subscription_id", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.delete(subscription_id, request_options=request_options) + return response.data + + async def update_signature_key( + self, + subscription_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> UpdateWebhookSubscriptionSignatureKeyResponse: + """ + Updates a webhook subscription by replacing the existing signature key with a new one. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + UpdateWebhookSubscriptionSignatureKeyResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.subscriptions.update_signature_key( + subscription_id="subscription_id", + idempotency_key="ed80ae6b-0654-473b-bbab-a39aee89a60d", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.update_signature_key( + subscription_id, idempotency_key=idempotency_key, request_options=request_options + ) + return response.data + + async def test( + self, + subscription_id: str, + *, + event_type: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> TestWebhookSubscriptionResponse: + """ + Tests a webhook subscription by sending a test event to the notification URL. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test. + + event_type : typing.Optional[str] + The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be + contained in the list of event types in the [Subscription](entity:WebhookSubscription). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + TestWebhookSubscriptionResponse + Success + + Examples + -------- + import asyncio + + from square import AsyncSquare + + client = AsyncSquare( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.webhooks.subscriptions.test( + subscription_id="subscription_id", + event_type="payment.created", + ) + + + asyncio.run(main()) + """ + response = await self._raw_client.test(subscription_id, event_type=event_type, request_options=request_options) + return response.data diff --git a/src/square/webhooks/subscriptions/raw_client.py b/src/square/webhooks/subscriptions/raw_client.py new file mode 100644 index 00000000..628f448e --- /dev/null +++ b/src/square/webhooks/subscriptions/raw_client.py @@ -0,0 +1,625 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from ...core.client_wrapper import SyncClientWrapper +from ...requests.webhook_subscription import WebhookSubscriptionParams +from ...core.request_options import RequestOptions +from ...core.http_response import HttpResponse +from ...types.create_webhook_subscription_response import CreateWebhookSubscriptionResponse +from ...core.serialization import convert_and_respect_annotation_metadata +from ...core.unchecked_base_model import construct_type +from json.decoder import JSONDecodeError +from ...core.api_error import ApiError +from ...types.get_webhook_subscription_response import GetWebhookSubscriptionResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...types.update_webhook_subscription_response import UpdateWebhookSubscriptionResponse +from ...types.delete_webhook_subscription_response import DeleteWebhookSubscriptionResponse +from ...types.update_webhook_subscription_signature_key_response import UpdateWebhookSubscriptionSignatureKeyResponse +from ...types.test_webhook_subscription_response import TestWebhookSubscriptionResponse +from ...core.client_wrapper import AsyncClientWrapper +from ...core.http_response import AsyncHttpResponse + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawSubscriptionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + *, + subscription: WebhookSubscriptionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CreateWebhookSubscriptionResponse]: + """ + Creates a webhook subscription. + + Parameters + ---------- + subscription : WebhookSubscriptionParams + The [Subscription](entity:WebhookSubscription) to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CreateWebhookSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + "v2/webhooks/subscriptions", + method="POST", + json={ + "idempotency_key": idempotency_key, + "subscription": convert_and_respect_annotation_metadata( + object_=subscription, annotation=WebhookSubscriptionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateWebhookSubscriptionResponse, + construct_type( + type_=CreateWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def get( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[GetWebhookSubscriptionResponse]: + """ + Retrieves a webhook subscription identified by its ID. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GetWebhookSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetWebhookSubscriptionResponse, + construct_type( + type_=GetWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[WebhookSubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateWebhookSubscriptionResponse]: + """ + Updates a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + subscription : typing.Optional[WebhookSubscriptionParams] + The [Subscription](entity:WebhookSubscription) to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateWebhookSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}", + method="PUT", + json={ + "subscription": convert_and_respect_annotation_metadata( + object_=subscription, annotation=WebhookSubscriptionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWebhookSubscriptionResponse, + construct_type( + type_=UpdateWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def delete( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteWebhookSubscriptionResponse]: + """ + Deletes a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteWebhookSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteWebhookSubscriptionResponse, + construct_type( + type_=DeleteWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def update_signature_key( + self, + subscription_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateWebhookSubscriptionSignatureKeyResponse]: + """ + Updates a webhook subscription by replacing the existing signature key with a new one. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateWebhookSubscriptionSignatureKeyResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}/signature-key", + method="POST", + json={ + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWebhookSubscriptionSignatureKeyResponse, + construct_type( + type_=UpdateWebhookSubscriptionSignatureKeyResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + def test( + self, + subscription_id: str, + *, + event_type: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[TestWebhookSubscriptionResponse]: + """ + Tests a webhook subscription by sending a test event to the notification URL. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test. + + event_type : typing.Optional[str] + The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be + contained in the list of event types in the [Subscription](entity:WebhookSubscription). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[TestWebhookSubscriptionResponse] + Success + """ + _response = self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}/test", + method="POST", + json={ + "event_type": event_type, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + TestWebhookSubscriptionResponse, + construct_type( + type_=TestWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + +class AsyncRawSubscriptionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + *, + subscription: WebhookSubscriptionParams, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CreateWebhookSubscriptionResponse]: + """ + Creates a webhook subscription. + + Parameters + ---------- + subscription : WebhookSubscriptionParams + The [Subscription](entity:WebhookSubscription) to create. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CreateWebhookSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + "v2/webhooks/subscriptions", + method="POST", + json={ + "idempotency_key": idempotency_key, + "subscription": convert_and_respect_annotation_metadata( + object_=subscription, annotation=WebhookSubscriptionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CreateWebhookSubscriptionResponse, + construct_type( + type_=CreateWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def get( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[GetWebhookSubscriptionResponse]: + """ + Retrieves a webhook subscription identified by its ID. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GetWebhookSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GetWebhookSubscriptionResponse, + construct_type( + type_=GetWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update( + self, + subscription_id: str, + *, + subscription: typing.Optional[WebhookSubscriptionParams] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateWebhookSubscriptionResponse]: + """ + Updates a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + subscription : typing.Optional[WebhookSubscriptionParams] + The [Subscription](entity:WebhookSubscription) to update. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateWebhookSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}", + method="PUT", + json={ + "subscription": convert_and_respect_annotation_metadata( + object_=subscription, annotation=WebhookSubscriptionParams, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWebhookSubscriptionResponse, + construct_type( + type_=UpdateWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def delete( + self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteWebhookSubscriptionResponse]: + """ + Deletes a webhook subscription. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteWebhookSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}", + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + DeleteWebhookSubscriptionResponse, + construct_type( + type_=DeleteWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def update_signature_key( + self, + subscription_id: str, + *, + idempotency_key: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateWebhookSubscriptionSignatureKeyResponse]: + """ + Updates a webhook subscription by replacing the existing signature key with a new one. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. + + idempotency_key : typing.Optional[str] + A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateWebhookSubscriptionSignatureKeyResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}/signature-key", + method="POST", + json={ + "idempotency_key": idempotency_key, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateWebhookSubscriptionSignatureKeyResponse, + construct_type( + type_=UpdateWebhookSubscriptionSignatureKeyResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + + async def test( + self, + subscription_id: str, + *, + event_type: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[TestWebhookSubscriptionResponse]: + """ + Tests a webhook subscription by sending a test event to the notification URL. + + Parameters + ---------- + subscription_id : str + [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test. + + event_type : typing.Optional[str] + The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be + contained in the list of event types in the [Subscription](entity:WebhookSubscription). + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[TestWebhookSubscriptionResponse] + Success + """ + _response = await self._client_wrapper.httpx_client.request( + f"v2/webhooks/subscriptions/{jsonable_encoder(subscription_id)}/test", + method="POST", + json={ + "event_type": event_type, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + TestWebhookSubscriptionResponse, + construct_type( + type_=TestWebhookSubscriptionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/tests/custom/test_client.py b/tests/custom/test_client.py new file mode 100644 index 00000000..73f811f5 --- /dev/null +++ b/tests/custom/test_client.py @@ -0,0 +1,7 @@ +import pytest + + +# Get started with writing tests with pytest at https://docs.pytest.org +@pytest.mark.skip(reason="Unimplemented") +def test_client() -> None: + assert True == True diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tests/integration/helpers.py b/tests/integration/helpers.py new file mode 100644 index 00000000..af2c1c5b --- /dev/null +++ b/tests/integration/helpers.py @@ -0,0 +1,157 @@ +import os +import uuid +from datetime import datetime +from typing import List + +from square import Square +from square.core import File +from square.environment import SquareEnvironment +from square.types.address import Address +from square.types.catalog_item import CatalogItem +from square.types.catalog_item_variation import CatalogItemVariation +from square.types.catalog_object import CatalogObject +from square.types.catalog_object_item import CatalogObjectItem +from square.types.catalog_object_item_variation import CatalogObjectItemVariation +from square.types.location import Location +from square.types.money import Money + + +class CreateCatalogItemVariationOptions: + name: str + price_money: Money + + def __init__(self): + self.name = "Variation " + str(uuid.uuid4()) + self.price_money = new_test_money(1000) + + def variation(self) -> CatalogItemVariation: + return CatalogItemVariation( + name=self.name, + track_inventory=True, + pricing_type="FIXED_PRICING", + price_money=self.price_money, + ) + + +class CreateCatalogItemOptions: + name: str + description: str + abbreviation: str + variation_opts: List[CreateCatalogItemVariationOptions] + + def __init__(self): + self.name = "Item " + str(uuid.uuid4()) + self.description = "Test item description" + self.abbreviation = "TST" + self.variation_opts = [CreateCatalogItemVariationOptions()] + + def variations(self) -> List[CatalogObject]: + return [ + CatalogObjectItemVariation( + type="ITEM_VARIATION", + id="#variation" + str(uuid.uuid4()), + present_at_all_locations=True, + item_variation_data=opts.variation(), + ) + for opts in self.variation_opts + ] + + +def test_client() -> Square: + return Square( + token=os.getenv("TEST_SQUARE_TOKEN"), + environment=SquareEnvironment.SANDBOX, + ) + + +def new_test_money(amount: int) -> Money: + return Money(amount=amount, currency="USD") + + +def create_test_catalog_item(opts: CreateCatalogItemOptions) -> CatalogObject: + return CatalogObjectItem( + type="ITEM", + id="#" + str(uuid.uuid4()), + present_at_all_locations=True, + item_data=CatalogItem( + name=opts.name, + description=opts.description, + abbreviation=opts.abbreviation, + variations=opts.variations(), + ), + ) + + +def get_test_file() -> File: + with open("tests/integration/testdata/image.jpeg", "rb") as file: + return file.read() + + +def create_location(client: Square) -> str: + locations_response = client.locations.create( + location={"name": "Test location " + str(uuid.uuid4())} + ) + + location = locations_response.location + if location is None or not isinstance(location, Location): + raise Exception("Could not get location.") + location_id = location.id + if location_id is None: + raise Exception("Could not get location ID.") + return location_id + + +def create_test_customer(client: Square) -> str: + address = test_address() + response = client.customers.create( + idempotency_key=str(uuid.uuid4()), + given_name="Amelia", + family_name="Earhart", + phone_number="1-212-555-4240", + note="test customer", + address={ + "address_line1": address.address_line1, + "address_line2": address.address_line2, + "locality": address.locality, + "administrative_district_level1": address.administrative_district_level1, + "postal_code": address.postal_code, + "country": address.country, + }, + ) + customer = response.customer + if customer is None: + raise Exception("Could not get customer.") + customer_id = customer.id + if customer_id is None: + raise Exception("Could not get customer ID.") + return customer_id + + +def test_address() -> Address: + return Address( + address_line1="500 Electric Ave", + address_line2="Suite 600A", + locality="New York", + administrative_district_level1="NY", + postal_code="10003", + country="US", + ) + + +def get_default_location_id(client: Square) -> str: + response = client.locations.list() + locations = response.locations + if locations is None or len(locations) == 0: + raise Exception("Could not get locations.") + location_id = locations[0].id + if location_id is None: + raise Exception("Could not get location ID.") + return location_id + + +def new_test_square_id() -> str: + return "#" + str(uuid.uuid4()) + + +def format_date_string(date: datetime) -> str: + return date.isoformat()[:19] + "Z" diff --git a/tests/integration/test_api_error.py b/tests/integration/test_api_error.py new file mode 100644 index 00000000..ca0cca64 --- /dev/null +++ b/tests/integration/test_api_error.py @@ -0,0 +1,172 @@ +from square.core.api_error import ApiError +from square.types.error import Error + + +class TestResponse: + def __init__(self, data): + for key, value in data.items(): + if isinstance(value, list): + setattr( + self, + key, + [ + TestResponse(item) if isinstance(item, dict) else item + for item in value + ], + ) + else: + setattr(self, key, value) + + +def test_exception_without_body(): + exception = ApiError(status_code=400, body=None) + + assert "status_code: 400" in str(exception) + assert exception.status_code == 400 + assert len(exception.errors) == 1 + assert isinstance(exception.errors[0], Error) + assert exception.errors[0].code == "Unknown" + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].field is None + assert exception.errors[0].detail is None + + +def test_exception_with_v1_error(): + error_string = """{ + "type": "INVALID_REQUEST", + "message": "Invalid field value", + "field": "customer_id" + }""" + exception = ApiError(status_code=400, body=error_string) + + assert "status_code: 400" in str(exception) + assert "body:" in str(exception) + assert exception.status_code == 400 + assert len(exception.errors) == 1 + assert isinstance(exception.errors[0], Error) + assert exception.errors[0].code == "INVALID_REQUEST" + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].field == "customer_id" + assert exception.errors[0].detail == "Invalid field value" + + +def test_exception_with_v1_error_without_type(): + error_string = """{ + "message": "Invalid field value", + "field": "customer_id" + }""" + exception = ApiError(status_code=400, body=error_string) + + assert "status_code: 400" in str(exception) + assert exception.status_code == 400 + assert len(exception.errors) == 1 + assert isinstance(exception.errors[0], Error) + assert exception.errors[0].code == "Unknown" + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].field == "customer_id" + assert exception.errors[0].detail == "Invalid field value" + + +def test_exception_with_v2_error(): + error_string = """{ + "errors": [{ + "category": "API_ERROR", + "code": "BAD_REQUEST", + "detail": "Invalid input", + "field": "email" + }] + }""" + exception = ApiError(status_code=400, body=error_string) + + assert "status_code: 400" in str(exception) + assert exception.status_code == 400 + assert len(exception.errors) == 1 + assert isinstance(exception.errors[0], Error) + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].code == "BAD_REQUEST" + assert exception.errors[0].detail == "Invalid input" + assert exception.errors[0].field == "email" + + +def test_exception_with_v2_error_as_dict(): + errors = { + "errors": [ + { + "category": "API_ERROR", + "code": "BAD_REQUEST", + "detail": "Invalid input", + "field": "email", + } + ] + } + exception = ApiError(status_code=400, body=errors) + + assert "status_code: 400" in str(exception) + assert exception.status_code == 400 + assert len(exception.errors) == 1 + assert isinstance(exception.errors[0], Error) + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].code == "BAD_REQUEST" + assert exception.errors[0].detail == "Invalid input" + assert exception.errors[0].field == "email" + + +def test_exception_with_v2_error_as_object(): + errors = TestResponse( + { + "errors": [ + { + "category": "API_ERROR", + "code": "BAD_REQUEST", + "detail": "Invalid input", + "field": "email", + } + ] + } + ) + + exception = ApiError(status_code=400, body=errors) + + assert "status_code: 400" in str(exception) + assert exception.status_code == 400 + assert len(exception.errors) == 1 + assert isinstance(exception.errors[0], Error) + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].code == "BAD_REQUEST" + assert exception.errors[0].detail == "Invalid input" + assert exception.errors[0].field == "email" + + +def test_exception_with_multiple_errors(): + errors = { + "errors": [ + { + "category": "API_ERROR", + "code": "BAD_REQUEST", + "detail": "Invalid input", + "field": "email", + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "UNAUTHORIZED", + "detail": "Not authorized", + "field": None, + }, + ] + } + exception = ApiError(status_code=400, body=errors) + + assert exception.status_code == 400 + assert len(exception.errors) == 2 + + # First error + assert exception.errors[0].category == "API_ERROR" + assert exception.errors[0].code == "BAD_REQUEST" + assert exception.errors[0].detail == "Invalid input" + assert exception.errors[0].field == "email" + + # Second error + assert exception.errors[1].category == "AUTHENTICATION_ERROR" + assert exception.errors[1].code == "UNAUTHORIZED" + assert exception.errors[1].detail == "Not authorized" + assert exception.errors[1].field is None diff --git a/tests/integration/test_cash_drawers.py b/tests/integration/test_cash_drawers.py new file mode 100644 index 00000000..b7596aae --- /dev/null +++ b/tests/integration/test_cash_drawers.py @@ -0,0 +1,16 @@ +from datetime import datetime, timedelta + +from . import helpers + + +def test_list_cash_drawer_shifts(): + client = helpers.test_client() + begin_time = (datetime.now() - timedelta(seconds=1)).isoformat() + end_time = datetime.now().isoformat() + location_id = helpers.get_default_location_id(client) + + response = client.cash_drawers.shifts.list( + location_id=location_id, begin_time=begin_time, end_time=end_time + ) + + assert response is not None diff --git a/tests/integration/test_catalog.py b/tests/integration/test_catalog.py new file mode 100644 index 00000000..bfd45a28 --- /dev/null +++ b/tests/integration/test_catalog.py @@ -0,0 +1,279 @@ +import time +import uuid + +from square.core.request_options import RequestOptions +from square.types.catalog_item import CatalogItem +from square.types.catalog_item_variation import CatalogItemVariation +from square.types.catalog_modifier import CatalogModifier +from square.types.catalog_modifier_list import CatalogModifierList +from square.types.catalog_object_batch import CatalogObjectBatch +from square.types.catalog_object_item import CatalogObjectItem +from square.types.catalog_object_modifier import CatalogObjectModifier +from square.types.catalog_object_modifier_list import CatalogObjectModifierList +from square.types.catalog_object_tax import CatalogObjectTax +from square.types.catalog_tax import CatalogTax + +from . import helpers + +MAX_RETRIES = 5 +MAX_TIMEOUT = 120 + + +def test_upload_catalog_image(): + # Wait to kick off the first test to avoid being rate limited. + time.sleep(3) + + client = helpers.test_client() + + # Setup: Create a catalog object to associate the image with + catalog_object = helpers.create_test_catalog_item( + helpers.CreateCatalogItemOptions() + ) + create_catalog_resp = client.catalog.batch_upsert( + idempotency_key=str(uuid.uuid4()), + batches=[CatalogObjectBatch(objects=[catalog_object])], + ) + + objects = create_catalog_resp.objects + assert objects is not None + assert 1 == len(objects) + created_catalog_object = objects[0] + assert isinstance(created_catalog_object, CatalogObjectItem) + assert created_catalog_object.id is not None + + # Create a new catalog image + image_name = "Test Image " + str(uuid.uuid4()) + create_catalog_image_resp = client.catalog.images.create( + image_file=helpers.get_test_file(), + request={ + "idempotency_key": str(uuid.uuid4()), + "image": { + "type": "IMAGE", + "id": helpers.new_test_square_id(), + "image_data": {"name": image_name}, + }, + "object_id": created_catalog_object.id, + }, + request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT), + ) + image = create_catalog_image_resp.image + assert image is not None + assert isinstance(image, CatalogObjectItem) + + # Cleanup + client.catalog.batch_delete( + object_ids=[created_catalog_object.id, image.id], + request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT), + ) + + +def test_upsert_catalog_object(): + client = helpers.test_client() + + coffee_variation_opts = helpers.CreateCatalogItemVariationOptions() + coffee_variation_opts.price_money = helpers.new_test_money(100) + coffee_variation_opts.name = "Colombian Fair Trade" + + coffee_opts = helpers.CreateCatalogItemOptions() + coffee_opts.name = "Coffee" + coffee_opts.description = "Strong coffee" + coffee_opts.abbreviation = "C" + coffee_opts.variation_opts = [coffee_variation_opts] + + coffee = helpers.create_test_catalog_item(coffee_opts) + + response = client.catalog.object.upsert( + idempotency_key=str(uuid.uuid4()), + object=coffee, + request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT), + ) + + catalog_object = response.catalog_object + assert catalog_object is not None + assert isinstance(catalog_object, CatalogObjectItem) + item = catalog_object.item_data + assert item is not None + assert isinstance(item, CatalogItem) + variations = item.variations + assert variations is not None + assert 1 == len(variations) + + variation_object = variations[0] + item_variation_data = variation_object.item_variation_data + assert item_variation_data is not None + assert isinstance(item_variation_data, CatalogItemVariation) + assert "Colombian Fair Trade" == item_variation_data.name + + +def test_catalog_info(): + client = helpers.test_client() + response = client.catalog.search( + limit=1, request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT) + ) + + assert response.objects is not None + assert len(response.objects) > 0 + + +def test_search_catalog_items(): + client = helpers.test_client() + response = client.catalog.search_items( + limit=1, request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT) + ) + assert response is not None + + +def test_batch_upsert_catalog_objects(): + # Wait to kick off this test to avoid being rate limited. + time.sleep(3) + + client = helpers.test_client() + + modifier = CatalogObjectModifier( + type="MODIFIER", + id="#temp-modifier-id", + modifier_data=CatalogModifier( + name="Limited Time Only Price", price_money=helpers.new_test_money(200) + ), + ) + + modifier_list = CatalogObjectModifierList( + type="MODIFIER_LIST", + id="#temp-modifier-list-id", + modifier_list_data=CatalogModifierList( + name="Special weekend deals", modifiers=[modifier] + ), + ) + + tax = CatalogObjectTax( + type="TAX", + id="#temp-tax-id", + tax_data=CatalogTax( + name="Online only Tax", + calculation_phase="TAX_SUBTOTAL_PHASE", + inclusion_type="ADDITIVE", + percentage="5.0", + applies_to_custom_amounts=True, + enabled=True, + ), + ) + + response = client.catalog.batch_upsert( + idempotency_key=str(uuid.uuid4()), + batches=[ + { + "objects": [ + { + "type": tax.type, + "id": tax.id, + "tax_data": { + "name": tax.tax_data.name, + "calculation_phase": tax.tax_data.calculation_phase, + "inclusion_type": tax.tax_data.inclusion_type, + "percentage": tax.tax_data.percentage, + "applies_to_custom_amounts": tax.tax_data.applies_to_custom_amounts, + "enabled": tax.tax_data.enabled, + }, + }, + { + "type": modifier_list.type, + "id": modifier_list.id, + "modifier_list_data": { + "name": modifier_list.modifier_list_data.name, + "modifiers": [modifier], + }, + }, + ] + } + ], + ) + + objects = response.objects + assert objects is not None + assert 2 == len(objects) + + id_mappings = response.id_mappings + assert id_mappings is not None + + catalog_tax_ids = [ + mapping.object_id + for mapping in id_mappings + if mapping.client_object_id == "#temp-tax-id" + ] + assert len(catalog_tax_ids) > 0 + catalog_tax_id = catalog_tax_ids[0] + + catalog_modifier_ids = [ + mapping.object_id + for mapping in id_mappings + if mapping.client_object_id == "#temp-modifier-id" + ] + assert len(catalog_modifier_ids) > 0 + catalog_modifier_id = catalog_modifier_ids[0] + + catalog_modifier_list_ids = [ + mapping.object_id + for mapping in id_mappings + if mapping.client_object_id == "#temp-modifier-list-id" + ] + assert len(catalog_modifier_list_ids) > 0 + catalog_modifier_list_id = catalog_modifier_list_ids[0] + + response = client.catalog.batch_get( + object_ids=[catalog_modifier_id, catalog_modifier_list_id, catalog_tax_id], + request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT), + ) + + assert response.objects is not None + assert 3 == len(response.objects) + resp_objects = response.objects + resp_object_ids = [obj.id for obj in resp_objects if obj.id is not None] + assert set(resp_object_ids) == { + catalog_modifier_id, + catalog_modifier_list_id, + catalog_tax_id, + } + + catalog_item = helpers.create_test_catalog_item(helpers.CreateCatalogItemOptions()) + catalog_response = client.catalog.object.upsert( + idempotency_key=str(uuid.uuid4()), object=catalog_item + ) + catalog_object = catalog_response.catalog_object + assert catalog_object is not None + assert isinstance(catalog_object, CatalogObjectItem) + catalog_object_id = catalog_object.id + + response = client.catalog.update_item_taxes( + item_ids=[catalog_object_id], + taxes_to_enable=[catalog_tax_id], + request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT), + ) + + assert response.updated_at is not None + assert response.errors is None + + response = client.catalog.update_item_modifier_lists( + item_ids=[catalog_object_id], + modifier_lists_to_enable=[catalog_modifier_list_id], + request_options=RequestOptions(timeout_in_seconds=MAX_TIMEOUT), + ) + + assert response.updated_at is not None + assert response.errors is None + + +def test_delete_catalog_object(): + client = helpers.test_client() + + catalog_item = helpers.create_test_catalog_item(helpers.CreateCatalogItemOptions()) + catalog_response = client.catalog.object.upsert( + idempotency_key=str(uuid.uuid4()), object=catalog_item + ) + catalog_object = catalog_response.catalog_object + assert catalog_object is not None + assert isinstance(catalog_object, CatalogObjectItem) + catalog_object_id = catalog_object.id + + response = client.catalog.object.delete(object_id=catalog_object_id) + + assert response is not None diff --git a/tests/integration/test_customer_groups.py b/tests/integration/test_customer_groups.py new file mode 100644 index 00000000..12556509 --- /dev/null +++ b/tests/integration/test_customer_groups.py @@ -0,0 +1,72 @@ +import time +import uuid + +import pytest + +from square.types.customer_group import CustomerGroup + +from . import helpers + + +def create_test_customer_group() -> str: + client = helpers.test_client() + response = client.customers.groups.create( + group={"name": "Default-" + str(uuid.uuid4())}, + idempotency_key=str(uuid.uuid4()), + ) + group = response.group + assert group is not None + assert isinstance(group, CustomerGroup) + assert group.id is not None + return group.id + + +def delete_test_customer_group(group_id: str): + client = helpers.test_client() + client.customers.groups.delete(group_id=group_id) + + +def test_create_and_list_customer_group(): + group_id = create_test_customer_group() + client = helpers.test_client() + response = client.customers.groups.list() + assert response is not None + groups = response.items + assert groups is not None + assert len(groups) > 0 + delete_test_customer_group(group_id) + + +def test_retrieve_customer_group(): + group_id = create_test_customer_group() + client = helpers.test_client() + response = client.customers.groups.get(group_id=group_id) + assert response.group is not None + assert isinstance(response.group, CustomerGroup) + assert group_id == response.group.id + delete_test_customer_group(group_id) + + +def test_update_customer_group(): + # This test often gets rate limited; we'll wait a few + # seconds before proceeding. + time.sleep(3) + + group_id = create_test_customer_group() + client = helpers.test_client() + new_name = "Updated-" + str(uuid.uuid4()) + response = client.customers.groups.update( + group_id=group_id, group={"name": new_name} + ) + assert response.group is not None + assert isinstance(response.group, CustomerGroup) + assert new_name == response.group.name + delete_test_customer_group(group_id) + + +def test_retrieve_non_existent_group(): + client = helpers.test_client() + with pytest.raises(Exception): + client.customers.groups.create( + group={"name": ""}, idempotency_key=str(uuid.uuid4()) + ) diff --git a/tests/integration/test_customer_segments.py b/tests/integration/test_customer_segments.py new file mode 100644 index 00000000..811e8b95 --- /dev/null +++ b/tests/integration/test_customer_segments.py @@ -0,0 +1,25 @@ +from square.types.customer_segment import CustomerSegment + +from . import helpers + + +def test_list_customer_segments(): + client = helpers.test_client() + response = client.customers.segments.list() + assert response.items is not None + assert len(response.items) > 0 + + +def test_retrieve_customer_segment(): + client = helpers.test_client() + list_response = client.customers.segments.list() + segments = list_response.items + assert segments is not None + assert len(segments) > 0 + segment = segments[0] + segment_id = segment.id + assert segment_id is not None + response = client.customers.segments.get(segment_id=segment_id) + assert response.segment is not None + assert isinstance(response.segment, CustomerSegment) + assert response.segment.name is not None diff --git a/tests/integration/test_customers.py b/tests/integration/test_customers.py new file mode 100644 index 00000000..cbec2adb --- /dev/null +++ b/tests/integration/test_customers.py @@ -0,0 +1,228 @@ +import uuid + +from square.types.card import Card +from square.types.custom_attribute import CustomAttribute +from square.types.customer import Customer +from square.types.customer_group import CustomerGroup + +from . import helpers + + +def create_customer() -> str: + client = helpers.test_client() + customer_response = client.customers.create( + idempotency_key=str(uuid.uuid4()), + given_name="Amelia", + family_name="Earhart", + phone_number="1-212-555-4240", + note="a customer", + address={ + "address_line1": "500 Electric Ave", + "address_line2": "Suite 600", + "locality": "New York", + "administrative_district_level1": "NY", + "postal_code": "10003", + "country": "US", + }, + ) + customer = customer_response.customer + assert customer is not None + assert isinstance(customer, Customer) + assert customer.id is not None + return customer.id + + +def delete_customer(customer_id: str): + client = helpers.test_client() + try: + client.customers.delete(customer_id=customer_id) + except Exception as e: + raise RuntimeError(e) + + +def create_customer_group() -> str: + client = helpers.test_client() + create_groups_response = client.customers.groups.create( + group={"name": "Test Group " + str(uuid.uuid4())}, + idempotency_key=str(uuid.uuid4()), + ) + group = create_groups_response.group + assert group is not None + assert isinstance(group, CustomerGroup) + assert group.id is not None + return group.id + + +def delete_customer_group(customer_group_id: str): + client = helpers.test_client() + try: + client.customers.groups.delete(group_id=customer_group_id) + except Exception as e: + raise RuntimeError(e) + + +def create_custom_attribute_definition() -> str: + client = helpers.test_client() + custom_attribute_key = "favorite-drink-" + str(uuid.uuid4()) + client.customers.custom_attribute_definitions.create( + custom_attribute_definition={ + "key": custom_attribute_key, + "name": "Favorite Drink" + str(uuid.uuid4()), + "description": "A customer's favorite drink", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "schema": { + "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String" + }, + } + ) + return custom_attribute_key + + +def delete_custom_attribute_definition(key: str): + client = helpers.test_client() + try: + client.customers.custom_attribute_definitions.delete(key=key) + except Exception as e: + raise RuntimeError(e) + + +def test_retrieve_customer(): + client = helpers.test_client() + customer_id = create_customer() + response = client.customers.get(customer_id=customer_id) + assert response.customer is not None + assert isinstance(response.customer, Customer) + assert customer_id == response.customer.id + delete_customer(customer_id) + + +def test_update_customer(): + client = helpers.test_client() + customer_id = create_customer() + response = client.customers.update( + customer_id=customer_id, + given_name="Updated Amelia", + family_name="Updated Earhart", + ) + customer = response.customer + assert customer is not None + assert isinstance(customer, Customer) + assert "Updated Amelia" == customer.given_name + assert "Updated Earhart" == customer.family_name + delete_customer(customer_id) + + +def test_create_customer_card(): + client = helpers.test_client() + customer_id = create_customer() + create_card_response = client.customers.cards.create( + customer_id=customer_id, card_nonce="cnon:card-nonce-ok" + ) + assert create_card_response.card is not None + assert isinstance(create_card_response.card, Card) + customer_card_id = create_card_response.card.id + assert customer_card_id is not None + delete_card_response = client.customers.cards.delete( + customer_id=customer_id, card_id=customer_card_id + ) + assert delete_card_response is not None + delete_customer(customer_id) + + +def test_add_customer_to_group(): + client = helpers.test_client() + customer_id = create_customer() + customer_group_id = create_customer_group() + add_group_response = client.customers.groups.add( + customer_id=customer_id, group_id=customer_group_id + ) + assert add_group_response is not None + + remove_group_response = client.customers.groups.remove( + customer_id=customer_id, group_id=customer_group_id + ) + assert remove_group_response is not None + delete_customer(customer_id) + delete_customer_group(customer_group_id) + + +def test_create_customer_custom_attribute(): + client = helpers.test_client() + customer_id = create_customer() + custom_attribute_key = create_custom_attribute_definition() + create_attr_response = client.customers.custom_attributes.upsert( + customer_id=customer_id, + key=custom_attribute_key, + custom_attribute={"value": "Double-shot breve", "key": custom_attribute_key}, + ) + assert create_attr_response.custom_attribute is not None + assert isinstance(create_attr_response.custom_attribute, CustomAttribute) + assert "Double-shot breve" == create_attr_response.custom_attribute.value + + delete_customer(customer_id) + delete_custom_attribute_definition(custom_attribute_key) + + +def test_update_customer_custom_attribute(): + client = helpers.test_client() + customer_id = create_customer() + custom_attribute_key = create_custom_attribute_definition() + update_attr_response = client.customers.custom_attributes.upsert( + customer_id=customer_id, + key=custom_attribute_key, + custom_attribute={"value": "Black coffee"}, + ) + custom_attribute = update_attr_response.custom_attribute + assert custom_attribute is not None + assert isinstance(custom_attribute, CustomAttribute) + assert "Black coffee" == custom_attribute.value + + delete_customer(customer_id) + delete_custom_attribute_definition(custom_attribute_key) + + +def test_list_customer_custom_attributes(): + client = helpers.test_client() + customer_id = create_customer() + custom_attribute_key = create_custom_attribute_definition() + client.customers.custom_attributes.upsert( + customer_id=customer_id, + key=custom_attribute_key, + custom_attribute={"value": "Double-shot breve"}, + ) + + pager = client.customers.custom_attributes.list( + customer_id=customer_id, with_definitions=True + ) + assert pager is not None + + attributes = pager.items + assert attributes is not None + + delete_attr_response = client.customers.custom_attributes.delete( + customer_id=customer_id, + key=custom_attribute_key, + ) + assert delete_attr_response is not None + + delete_customer(customer_id) + delete_custom_attribute_definition(custom_attribute_key) + + +def test_delete_customer_custom_attribute(): + client = helpers.test_client() + customer_id = create_customer() + custom_attribute_key = create_custom_attribute_definition() + client.customers.custom_attributes.upsert( + customer_id=customer_id, + key=custom_attribute_key, + custom_attribute={"value": "Double-shot breve"}, + ) + + response = client.customers.custom_attributes.delete( + customer_id=customer_id, key=custom_attribute_key + ) + assert response is not None + + delete_customer(customer_id) + delete_custom_attribute_definition(custom_attribute_key) diff --git a/tests/integration/test_devices.py b/tests/integration/test_devices.py new file mode 100644 index 00000000..5b0a448a --- /dev/null +++ b/tests/integration/test_devices.py @@ -0,0 +1,45 @@ +import uuid + +from square.types.device_code import DeviceCode + +from . import helpers + + +def create_device_code(): + client = helpers.test_client() + create_response = client.devices.codes.create( + idempotency_key=str(uuid.uuid4()), device_code={"product_type": "TERMINAL_API"} + ) + device_code = create_response.device_code + assert device_code is not None + assert isinstance(device_code, DeviceCode) + assert device_code.id is not None + return device_code.id + + +def test_list_device_codes(): + client = helpers.test_client() + create_device_code() + response = client.devices.codes.list() + assert response.items is not None + assert len(response.items) > 0 + + +def test_create_device_code(): + client = helpers.test_client() + response = client.devices.codes.create( + idempotency_key=str(uuid.uuid4()), device_code={"product_type": "TERMINAL_API"} + ) + assert response.device_code is not None + assert isinstance(response.device_code, DeviceCode) + assert "TERMINAL_API" == response.device_code.product_type + + +def test_get_device_code(): + client = helpers.test_client() + device_code_id = create_device_code() + response = client.devices.codes.get(id=device_code_id) + assert response.device_code is not None + assert isinstance(response.device_code, DeviceCode) + assert response.device_code.id + assert "TERMINAL_API" == response.device_code.product_type diff --git a/tests/integration/test_disputes.py b/tests/integration/test_disputes.py new file mode 100644 index 00000000..885fc55d --- /dev/null +++ b/tests/integration/test_disputes.py @@ -0,0 +1,176 @@ +import time +import uuid + +import pytest + +from square.types.dispute import Dispute +from square.types.dispute_evidence import DisputeEvidence +from square.types.get_dispute_evidence_response import GetDisputeEvidenceResponse + +from . import helpers + + +def create_dispute() -> str: + client = helpers.test_client() + + # Create a payment that will generate a dispute + client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 8803, "currency": "USD"}, + ) + + # Poll for dispute to be created + for _ in range(100): + dispute_response = client.disputes.list(states="EVIDENCE_REQUIRED") + if dispute_response.items is not None and len(dispute_response.items) > 0: + assert dispute_response.items[0].id is not None + return dispute_response.items[0].id + + # Wait for 2 seconds before polling again + time.sleep(2) + + raise Exception("Could not create dispute") + + +def create_evidence_text(dispute_id: str) -> str: + client = helpers.test_client() + evidence_response = client.disputes.create_evidence_text( + dispute_id=dispute_id, + idempotency_key=str(uuid.uuid4()), + evidence_text="This is not a duplicate", + evidence_type="GENERIC_EVIDENCE", + ) + evidence = evidence_response.evidence + assert evidence is not None + assert isinstance(evidence, DisputeEvidence) + assert evidence.id is not None + return evidence.id + + +def delete_dispute_evidence(*, dispute_id: str, text_evidence_id: str): + client = helpers.test_client() + # Clean up evidence if it exists + try: + client.disputes.evidence.delete( + dispute_id=dispute_id, evidence_id=text_evidence_id + ) + except Exception as e: + # Evidence might already be deleted by test + pass + + +def test_list_disputes(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + + response = client.disputes.list(states="EVIDENCE_REQUIRED") + assert response.items is not None + assert len(response.items) > 0 + assert isinstance(response.items[0], Dispute) + assert "DUPLICATE" == response.items[0].reason + assert "EVIDENCE_REQUIRED" == response.items[0].state + assert "VISA" == response.items[0].card_brand + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +def test_retrieve_dispute(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + response = client.disputes.get(dispute_id=dispute_id) + assert response.dispute is not None + assert isinstance(response.dispute, Dispute) + assert response.dispute.id + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +def test_create_dispute_evidence_text(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + response = client.disputes.create_evidence_text( + dispute_id=dispute_id, + idempotency_key=str(uuid.uuid4()), + evidence_text="This is not a duplicate", + evidence_type="GENERIC_EVIDENCE", + ) + assert response.evidence is not None + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +def test_retrieve_dispute_evidence(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + response = client.disputes.evidence.get( + dispute_id=dispute_id, evidence_id=text_evidence_id + ) + assert response.evidence is not None + assert isinstance(response, GetDisputeEvidenceResponse) + assert text_evidence_id == response.evidence.id + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +def test_list_dispute_evidence(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + response = client.disputes.evidence.delete( + dispute_id=dispute_id, evidence_id=text_evidence_id + ) + assert response is not None + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +@pytest.mark.skip( + reason="Temporarily skipping test_create_dispute_evidence_file; 'Evidence" +) +def test_create_dispute_evidence_file(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + + response = client.disputes.create_evidence_file( + dispute_id=dispute_id, + image_file=helpers.get_test_file(), + request={ + "idempotency_key": str(uuid.uuid4()), + "content_type": "image/jpeg", + "evidence_type": "GENERIC_EVIDENCE", + }, + ) + + assert response.evidence is not None + assert isinstance(response.evidence, DisputeEvidence) + assert dispute_id == response.evidence.id + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +def test_submit_evidence(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + + response = client.disputes.submit_evidence(dispute_id=dispute_id) + assert response is not None + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) + + +def test_accept_dispute(): + client = helpers.test_client() + dispute_id = create_dispute() + text_evidence_id = create_evidence_text(dispute_id) + + response = client.disputes.accept(dispute_id=dispute_id) + assert response is not None + + delete_dispute_evidence(dispute_id=dispute_id, text_evidence_id=text_evidence_id) diff --git a/tests/integration/test_inventory.py b/tests/integration/test_inventory.py new file mode 100644 index 00000000..cd04ca10 --- /dev/null +++ b/tests/integration/test_inventory.py @@ -0,0 +1,241 @@ +import uuid +from datetime import datetime, timedelta + +from square.requests.catalog_item import CatalogItemParams +from square.requests.catalog_item_variation import CatalogItemVariationParams +from square.requests.catalog_object_item_variation import ( + CatalogObjectItemVariationParams, +) +from square.types.catalog_item import CatalogItem +from square.types.catalog_object_item import CatalogObjectItem +from square.types.inventory_adjustment import InventoryAdjustment +from square.types.inventory_physical_count import InventoryPhysicalCount + +from . import helpers + + +def create_catalog_item_variation() -> str: + client = helpers.test_client() + + variation_data: CatalogItemVariationParams = { + "name": "Colombian Fair Trade", + "track_inventory": True, + "pricing_type": "FIXED_PRICING", + "price_money": {"amount": 100, "currency": "USD"}, + } + + variation: CatalogObjectItemVariationParams = { + "type": "ITEM_VARIATION", + "id": "#colombian-coffee", + "present_at_all_locations": True, + "item_variation_data": variation_data, + } + + item_data: CatalogItemParams = { + "name": "Coffee", + "description": "Strong coffee", + "abbreviation": "C", + "variations": [variation], + } + + catalog_response = client.catalog.object.upsert( + idempotency_key=str(uuid.uuid4()), + object={ + "type": "ITEM", + "id": "#single-item", + "present_at_all_locations": True, + "item_data": item_data, + }, + ) + + assert catalog_response.catalog_object is not None + assert isinstance(catalog_response.catalog_object, CatalogObjectItem) + item = catalog_response.catalog_object.item_data + assert item is not None + assert isinstance(item, CatalogItem) + variations = item.variations + assert variations is not None + assert len(variations) > 0 + assert catalog_response.id_mappings is not None + item_variation_ids = [ + mapping.object_id + for mapping in catalog_response.id_mappings + if mapping.object_id == variations[0].id + ] + assert len(item_variation_ids) > 0 + assert item_variation_ids[0] is not None + return item_variation_ids[0] + + +def create_initial_adjustment(item_variation_id: str): + """ + Create an initial inventory adjustment and return the physical count ID + """ + client = helpers.test_client() + response = client.inventory.batch_create_changes( + idempotency_key=str(uuid.uuid4()), + changes=[ + { + "type": "ADJUSTMENT", + "adjustment": { + "from_state": "NONE", + "to_state": "IN_STOCK", + "location_id": helpers.get_default_location_id(client), + "catalog_object_id": item_variation_id, + "quantity": "100", + "occurred_at": helpers.format_date_string( + datetime.now() - timedelta(hours=8) + ), + }, + } + ], + ) + + changes = response.changes + assert changes is not None + assert len(changes) > 0 + assert changes[0].adjustment is not None + assert isinstance(changes[0].adjustment, InventoryAdjustment) + adjustment_id = changes[0].adjustment.id + assert adjustment_id is not None + + client.inventory.batch_create_changes( + idempotency_key=str(uuid.uuid4()), + changes=[ + { + "type": "PHYSICAL_COUNT", + "physical_count": { + "catalog_object_id": item_variation_id, + "location_id": helpers.get_default_location_id(client), + "quantity": "1", + "state": "IN_STOCK", + "occurred_at": helpers.format_date_string(datetime.now()), + }, + } + ], + ) + + physical_changes_response = client.inventory.batch_get_changes( + types=["PHYSICAL_COUNT"], + catalog_object_ids=[item_variation_id], + location_ids=[helpers.get_default_location_id(client)], + ) + physical_changes = physical_changes_response.items + assert physical_changes is not None + assert len(physical_changes) > 0 + physical_change = physical_changes[0] + assert physical_change.physical_count is not None + assert isinstance(physical_change.physical_count, InventoryPhysicalCount) + assert physical_change.physical_count.id is not None + return physical_change.physical_count.id + + +def test_batch_change_inventory(): + client = helpers.test_client() + item_variation_id = create_catalog_item_variation() + create_initial_adjustment(item_variation_id) + + response = client.inventory.batch_create_changes( + idempotency_key=str(uuid.uuid4()), + changes=[ + { + "type": "ADJUSTMENT", + "adjustment": { + "from_state": "NONE", + "to_state": "IN_STOCK", + "location_id": helpers.get_default_location_id(client), + "catalog_object_id": item_variation_id, + "quantity": "50", + "occurred_at": helpers.format_date_string(datetime.now()), + }, + } + ], + ) + + assert response.changes is not None + assert len(response.changes) > 0 + assert response.changes[0].adjustment is not None + assert isinstance(response.changes[0].adjustment, InventoryAdjustment) + assert "IN_STOCK" == response.changes[0].adjustment.to_state + assert "50" == response.changes[0].adjustment.quantity + + +def test_batch_retrieve_inventory_changes(): + client = helpers.test_client() + item_variation_id = create_catalog_item_variation() + create_initial_adjustment(item_variation_id) + + response = client.inventory.batch_get_changes( + catalog_object_ids=[item_variation_id] + ) + assert response.items is not None + assert len(response.items) > 0 + + +def test_batch_retrieve_inventory_counts(): + client = helpers.test_client() + item_variation_id = create_catalog_item_variation() + create_initial_adjustment(item_variation_id) + + response = client.inventory.batch_get_counts(catalog_object_ids=[item_variation_id]) + assert response.items is not None + assert len(response.items) > 0 + + +def test_retrieve_inventory_changes(): + client = helpers.test_client() + item_variation_id = create_catalog_item_variation() + create_initial_adjustment(item_variation_id) + + response = client.inventory.get(catalog_object_id=item_variation_id) + assert response.items is not None + assert len(response.items) > 0 + + +def test_retrieve_inventory_counts(): + client = helpers.test_client() + item_variation_id = create_catalog_item_variation() + physical_count_id = create_initial_adjustment(item_variation_id) + + response = client.inventory.get_physical_count(physical_count_id=physical_count_id) + assert response.count is not None + + +def test_retrieve_inventory_adjustments(): + client = helpers.test_client() + item_variation_id = create_catalog_item_variation() + create_initial_adjustment(item_variation_id) + + response = client.inventory.batch_create_changes( + idempotency_key=str(uuid.uuid4()), + changes=[ + { + "type": "ADJUSTMENT", + "adjustment": { + "from_state": "NONE", + "to_state": "IN_STOCK", + "location_id": helpers.get_default_location_id(client), + "catalog_object_id": item_variation_id, + "quantity": "10", + "occurred_at": helpers.format_date_string(datetime.now()), + }, + } + ], + ) + + changes = response.changes + assert changes is not None + assert len(changes) > 0 + assert changes[0].adjustment is not None + assert isinstance(changes[0].adjustment, InventoryAdjustment) + assert changes[0].adjustment.id is not None + adjustment_id = changes[0].adjustment.id + retrieve_response = client.inventory.get_adjustment(adjustment_id=adjustment_id) + retrieve_adjustment = retrieve_response.adjustment + assert retrieve_adjustment is not None + assert isinstance(retrieve_adjustment, InventoryAdjustment) + retrieve_adjustment_id = retrieve_adjustment.id + assert retrieve_adjustment_id is not None + + assert retrieve_response.adjustment is not None + assert adjustment_id == retrieve_adjustment_id diff --git a/tests/integration/test_labor.py b/tests/integration/test_labor.py new file mode 100644 index 00000000..d2c91340 --- /dev/null +++ b/tests/integration/test_labor.py @@ -0,0 +1,259 @@ +import time +import uuid +from datetime import datetime, timedelta + +from square.types.break_type import BreakType +from square.types.money import Money +from square.types.shift import Shift +from square.types.shift_wage import ShiftWage +from square.types.team_member import TeamMember + +from . import helpers + + +def create_team_member() -> str: + client = helpers.test_client() + + team_response = client.team_members.create( + idempotency_key=str(uuid.uuid4()), + team_member={"given_name": "Sherlock", "family_name": "Holmes"}, + ) + team_member = team_response.team_member + assert team_member is not None + assert isinstance(team_member, TeamMember) + assert team_member.id is not None + return team_member.id + + +def create_break_type() -> str: + client = helpers.test_client() + + break_response = client.labor.break_types.create( + break_type={ + "location_id": helpers.get_default_location_id(client), + "break_name": "Lunch_" + str(uuid.uuid4()), + "expected_duration": "PT0H30M0S", + "is_paid": True, + }, + idempotency_key=str(uuid.uuid4()), + ) + break_type = break_response.break_type + assert break_type is not None + assert isinstance(break_type, BreakType) + assert break_type.id is not None + return break_type.id + + +def delete_break_type(break_type_id: str): + client = helpers.test_client() + try: + client.labor.break_types.delete(id=break_type_id) + except Exception as e: + # test may have already deleted the break + pass + + +def create_shift(team_member_id: str) -> str: + client = helpers.test_client() + + shift_response = client.labor.shifts.create( + shift={ + "location_id": helpers.get_default_location_id(client), + "start_at": helpers.format_date_string(datetime.now()), + "team_member_id": team_member_id, + }, + idempotency_key=str(uuid.uuid4()), + ) + shift = shift_response.shift + assert shift is not None + assert isinstance(shift, Shift) + assert shift.id is not None + return shift.id + + +def delete_shift(shift_id: str): + client = helpers.test_client() + try: + client.labor.shifts.delete(id=shift_id) + except Exception as e: + # test may have already deleted the shift + pass + + +def get_first_break_type_id() -> str: + client = helpers.test_client() + response = client.labor.break_types.list( + location_id=helpers.get_default_location_id(client) + ) + break_types = response.items + if break_types is not None and len(break_types) > 0: + return break_types[0].id or "" + raise Exception("No break types found") + + +def test_get_break_type(): + # Wait to kick off the first test to avoid being rate limited. + time.sleep(3) + + client = helpers.test_client() + team_member_id = create_team_member() + break_type_id = create_break_type() + shift_id = create_shift(team_member_id) + + response = client.labor.break_types.get(id=break_type_id) + assert response.break_type is not None + assert isinstance(response.break_type, BreakType) + assert break_type_id == response.break_type.id + + list_response = client.labor.break_types.list() + assert list_response.items is not None + assert len(list_response.items) > 0 + + delete_break_type(break_type_id) + delete_shift(shift_id) + + +def test_update_break_type(): + client = helpers.test_client() + team_member_id = create_team_member() + break_type_id = create_break_type() + shift_id = create_shift(team_member_id) + + response = client.labor.break_types.update( + id=break_type_id, + break_type={ + "location_id": helpers.get_default_location_id(client), + "break_name": "Lunch_" + str(uuid.uuid4()), + "expected_duration": "PT1H0M0S", + "is_paid": True, + }, + ) + assert response.break_type is not None + assert isinstance(response.break_type, BreakType) + assert break_type_id == response.break_type.id + assert "PT1H" == response.break_type.expected_duration + + delete_break_type(break_type_id) + delete_shift(shift_id) + + +def test_search_shifts(): + client = helpers.test_client() + team_member_id = create_team_member() + break_type_id = create_break_type() + shift_id = create_shift(team_member_id) + + response = client.labor.shifts.search(limit=1) + assert response.shifts is not None + assert len(response.shifts) > 0 + + delete_break_type(break_type_id) + delete_shift(shift_id) + + +def test_get_shift(): + client = helpers.test_client() + team_member_id = create_team_member() + break_type_id = create_break_type() + shift_id = create_shift(team_member_id) + + response = client.labor.shifts.get(id=shift_id) + assert response.shift is not None + assert isinstance(response.shift, Shift) + assert shift_id == response.shift.id + + delete_break_type(break_type_id) + delete_shift(shift_id) + + +def test_update_shift(): + client = helpers.test_client() + team_member_id = create_team_member() + break_type_id = create_break_type() + shift_id = create_shift(team_member_id) + + response = client.labor.shifts.update( + id=shift_id, + shift={ + "location_id": helpers.get_default_location_id(client), + "start_at": helpers.format_date_string( + datetime.now() - timedelta(minutes=1) + ), + "team_member_id": team_member_id, + "wage": { + "title": "Manager", + "hourly_rate": {"amount": 2500, "currency": "USD"}, + }, + }, + ) + shift = response.shift + assert shift is not None + assert isinstance(shift, Shift) + assert shift.wage is not None + assert isinstance(shift.wage, ShiftWage) + assert "Manager" == shift.wage.title + assert isinstance(shift.wage.hourly_rate, Money) + assert 2500 == shift.wage.hourly_rate.amount + assert "USD" == shift.wage.hourly_rate.currency + + delete_break_type(break_type_id) + delete_shift(shift_id) + + +def test_delete_shift(): + client = helpers.test_client() + + team_member_response = client.team_members.create( + idempotency_key=str(uuid.uuid4()), + team_member={"given_name": "Sherlock", "family_name": "Holmes"}, + ) + + assert team_member_response.team_member is not None + assert isinstance(team_member_response.team_member, TeamMember) + assert team_member_response.team_member.id is not None + + shift_response = client.labor.shifts.create( + shift={ + "location_id": helpers.get_default_location_id(client), + "start_at": helpers.format_date_string(datetime.now()), + "team_member_id": team_member_response.team_member.id, + }, + idempotency_key=str(uuid.uuid4()), + ) + + assert shift_response.shift is not None + assert isinstance(shift_response.shift, Shift) + assert shift_response.shift.id is not None + shift_id = shift_response.shift.id + response = client.labor.shifts.delete(id=shift_id) + assert response is not None + + +def test_delete_break_type(): + client = helpers.test_client() + + break_response = client.labor.break_types.create( + break_type={ + "location_id": helpers.get_default_location_id(client), + "break_name": "Lunch_" + str(uuid.uuid4()), + "expected_duration": "PT0H30M0S", + "is_paid": True, + }, + idempotency_key=str(uuid.uuid4()), + ) + + break_type = break_response.break_type + assert break_type is not None + assert isinstance(break_type, BreakType) + assert break_type.id is not None + break_id = break_type.id + + response = client.labor.break_types.delete(id=break_id) + assert response is not None + + +def test_list_workweek_configs(): + client = helpers.test_client() + response = client.labor.workweek_configs.list() + assert response.items is not None + assert len(response.items) > 0 diff --git a/tests/integration/test_locations.py b/tests/integration/test_locations.py new file mode 100644 index 00000000..0625a2d8 --- /dev/null +++ b/tests/integration/test_locations.py @@ -0,0 +1,9 @@ +from . import helpers + + +def test_list_locations(): + client = helpers.test_client() + + response = client.locations.list() + assert response.locations is not None + assert len(response.locations) > 0 diff --git a/tests/integration/test_merchants.py b/tests/integration/test_merchants.py new file mode 100644 index 00000000..82d33869 --- /dev/null +++ b/tests/integration/test_merchants.py @@ -0,0 +1,31 @@ +from square.types.merchant import Merchant + +from . import helpers + + +def get_merchant_id() -> str: + client = helpers.test_client() + + merchants_response = client.merchants.list() + assert merchants_response.items is not None + assert len(merchants_response.items) > 0 + merchant = merchants_response.items[0] + assert merchant.id is not None + return merchant.id + + +def test_list_merchants(): + client = helpers.test_client() + response = client.merchants.list() + assert response.items is not None + assert len(response.items) > 0 + + +def test_retrieve_merchant(): + client = helpers.test_client() + merchant_id = get_merchant_id() + + response = client.merchants.get(merchant_id=merchant_id) + assert response.merchant is not None + assert isinstance(response.merchant, Merchant) + assert merchant_id == response.merchant.id diff --git a/tests/integration/test_mobile_authorization.py b/tests/integration/test_mobile_authorization.py new file mode 100644 index 00000000..568920f1 --- /dev/null +++ b/tests/integration/test_mobile_authorization.py @@ -0,0 +1,10 @@ +from . import helpers + + +def test_create_mobile_authorization_code(): + client = helpers.test_client() + location_id = helpers.get_default_location_id(client) + + response = client.mobile.authorization_code(location_id=location_id) + assert response.authorization_code is not None + assert response.expires_at is not None diff --git a/tests/integration/test_orders.py b/tests/integration/test_orders.py new file mode 100644 index 00000000..828fd7e9 --- /dev/null +++ b/tests/integration/test_orders.py @@ -0,0 +1,158 @@ +import uuid + +from square.types.order import Order + +from . import helpers + + +def create_order() -> str: + client = helpers.test_client() + location_id = helpers.get_default_location_id(client) + + order_response = client.orders.create( + idempotency_key=str(uuid.uuid4()), + order={ + "location_id": location_id, + "line_items": [ + { + "quantity": "1", + "name": "New Item", + "base_price_money": {"amount": 100, "currency": "USD"}, + } + ], + }, + ) + order = order_response.order + assert order is not None + assert isinstance(order, Order) + assert order.id is not None + return order.id + + +def get_line_item_id(order_id: str) -> str: + client = helpers.test_client() + + order_response = client.orders.get(order_id=order_id) + order = order_response.order + assert order is not None + assert isinstance(order, Order) + line_items = order.line_items + assert line_items is not None + assert len(line_items) > 0 + line_item = line_items[0] + assert line_item.uid is not None + return line_item.uid + + +def test_create_order(): + client = helpers.test_client() + + response = client.orders.create( + order={ + "location_id": helpers.get_default_location_id(client), + "line_items": [ + { + "quantity": "1", + "name": "New Item", + "base_price_money": {"amount": 100, "currency": "USD"}, + } + ], + } + ) + + order = response.order + assert order is not None + assert isinstance(order, Order) + line_items = order.line_items + assert line_items is not None + assert len(line_items) > 0 + assert "New Item" == line_items[0].name + + +def test_batch_retrieve_orders(): + client = helpers.test_client() + order_id = create_order() + line_item_id = get_line_item_id(order_id) + + response = client.orders.batch_get(order_ids=[order_id]) + orders = response.orders + assert orders is not None + assert len(orders) > 0 + order = orders[0] + assert order_id == order.id + + +def test_search_orders(): + client = helpers.test_client() + order_id = create_order() + line_item_id = get_line_item_id(order_id) + + response = client.orders.search( + limit=1, location_ids=[helpers.get_default_location_id(client)] + ) + assert response.orders is not None + assert len(response.orders) > 0 + + +def test_update_order(): + client = helpers.test_client() + order_id = create_order() + line_item_id = get_line_item_id(order_id) + + response = client.orders.update( + order_id=order_id, + idempotency_key=str(uuid.uuid4()), + order={ + "location_id": helpers.get_default_location_id(client), + "line_items": [ + { + "quantity": "1", + "name": "Updated Item", + "base_price_money": {"amount": 0, "currency": "USD"}, + } + ], + "version": 1, + }, + fields_to_clear=["line_items[" + line_item_id + "]"], + ) + + assert response.order is not None + assert isinstance(response.order, Order) + assert order_id == response.order.id + line_items = response.order.line_items + assert line_items is not None + assert len(line_items) > 0 + assert "Updated Item" == line_items[0].name + + response = client.orders.pay( + order_id=order_id, + idempotency_key=str(uuid.uuid4()), + order_version=2, + payment_ids=[], + ) + assert response.order is not None + assert isinstance(response.order, Order) + assert order_id == response.order.id + + +def test_calculate_order(): + client = helpers.test_client() + order_id = create_order() + line_item_id = get_line_item_id(order_id) + + response = client.orders.calculate( + order={ + "location_id": helpers.get_default_location_id(client), + "line_items": [ + { + "quantity": "1", + "name": "New Item", + "base_price_money": {"amount": 100, "currency": "USD"}, + } + ], + } + ) + + assert response.order is not None + assert isinstance(response.order, Order) + assert response.order.total_money is not None diff --git a/tests/integration/test_pagination.py b/tests/integration/test_pagination.py new file mode 100644 index 00000000..bb5c46ca --- /dev/null +++ b/tests/integration/test_pagination.py @@ -0,0 +1,17 @@ +from . import helpers + + +def test_customers_pagination(): + client = helpers.test_client() + + for _ in range(5): + helpers.create_test_customer(client) + + pager = client.customers.list() + count = 0 + for customer in pager: + assert customer is not None + assert customer.id is not None + count += 1 + + assert count > 4 diff --git a/tests/integration/test_payments.py b/tests/integration/test_payments.py new file mode 100644 index 00000000..9b005073 --- /dev/null +++ b/tests/integration/test_payments.py @@ -0,0 +1,120 @@ +import uuid + +from square.types.money import Money +from square.types.payment import Payment + +from . import helpers + + +def create_payment() -> str: + client = helpers.test_client() + payment_response = client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=False, + ) + payment = payment_response.payment + assert payment is not None + assert isinstance(payment, Payment) + assert payment.id is not None + return payment.id + + +def test_list_payments(): + client = helpers.test_client() + + response = client.payments.list() + page = response.next_page() + payments = page.items + assert payments is not None + assert len(payments) > 0 + + +def test_create_payment(): + client = helpers.test_client() + + response = client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=False, + ) + payment = response.payment + assert payment is not None + assert isinstance(payment, Payment) + assert payment.app_fee_money is not None + assert isinstance(payment.app_fee_money, Money) + assert 10 == payment.app_fee_money.amount + assert "USD" == payment.app_fee_money.currency + assert payment.amount_money is not None + assert isinstance(payment.amount_money, Money) + assert 200 == payment.amount_money.amount + assert "USD" == payment.amount_money.currency + + +def test_get_payment(): + client = helpers.test_client() + payment_id = create_payment() + + response = client.payments.get(payment_id=payment_id) + + assert response.payment is not None + assert isinstance(response.payment, Payment) + assert payment_id == response.payment.id + + +def test_cancel_payment(): + client = helpers.test_client() + payment_id = create_payment() + + response = client.payments.cancel(payment_id=payment_id) + + assert response.payment is not None + assert isinstance(response.payment, Payment) + assert payment_id == response.payment.id + + +def test_cancel_payment_by_idempotency_key(): + client = helpers.test_client() + + idempotency_key = str(uuid.uuid4()) + + client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=idempotency_key, + amount_money={"amount": 200, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=False, + ) + + response = client.payments.cancel_by_idempotency_key( + idempotency_key=idempotency_key + ) + assert response is not None + + +def test_complete_payment(): + client = helpers.test_client() + payment_id = create_payment() + + create_response = client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=False, + ) + + payment = create_response.payment + assert payment is not None + assert isinstance(payment, Payment) + + payment_id = payment.id + response = client.payments.complete(payment_id=payment_id) + + assert response.payment is not None + assert isinstance(response.payment, Payment) + assert "COMPLETED" == response.payment.status diff --git a/tests/integration/test_refunds.py b/tests/integration/test_refunds.py new file mode 100644 index 00000000..5b5cfa16 --- /dev/null +++ b/tests/integration/test_refunds.py @@ -0,0 +1,84 @@ +import uuid + +import pytest + +from square.types.payment import Payment +from square.types.payment_refund import PaymentRefund + +from . import helpers + + +def create_payment() -> str: + client = helpers.test_client() + + payment_response = client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=True, + ) + payment = payment_response.payment + assert payment is not None + assert isinstance(payment, Payment) + assert payment.id is not None + return payment.id + + +def create_refund(payment_id: str) -> str: + client = helpers.test_client() + + refund_response = client.refunds.refund_payment( + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + payment_id=payment_id, + ) + refund = refund_response.refund + assert refund is not None + assert isinstance(refund, PaymentRefund) + assert refund.id is not None + return refund.id + + +def test_refund_payment(): + client = helpers.test_client() + + payment_response = client.payments.create( + source_id="cnon:card-nonce-ok", + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + app_fee_money={"amount": 10, "currency": "USD"}, + autocomplete=True, + ) + payment = payment_response.payment + assert payment is not None + assert isinstance(payment, Payment) + assert payment.id is not None + payment_id = payment.id + + response = client.refunds.refund_payment( + idempotency_key=str(uuid.uuid4()), + amount_money={"amount": 200, "currency": "USD"}, + payment_id=payment_id, + ) + refund = response.refund + assert refund is not None + assert isinstance(refund, PaymentRefund) + assert payment_id == refund.payment_id + + +def test_get_payment_refund(): + client = helpers.test_client() + payment_id = create_payment() + refund_id = create_refund(payment_id) + + response = client.refunds.get(refund_id=refund_id) + assert response.refund is not None + assert isinstance(response.refund, PaymentRefund) + assert payment_id == response.refund.payment_id + + +def test_handle_invalid_refund_id(): + client = helpers.test_client() + with pytest.raises(Exception): + client.refunds.get(refund_id="invalid-id") diff --git a/tests/integration/test_teams.py b/tests/integration/test_teams.py new file mode 100644 index 00000000..49c61675 --- /dev/null +++ b/tests/integration/test_teams.py @@ -0,0 +1,154 @@ +import uuid +from typing import List + +from square.types.money import Money +from square.types.team_member import TeamMember +from square.types.wage_setting import WageSetting + +from . import helpers + + +def create_team_member() -> str: + client = helpers.test_client() + + member_response = client.team_members.create( + idempotency_key=str(uuid.uuid4()), + team_member={"given_name": "Sherlock", "family_name": "Holmes"}, + ) + member = member_response.team_member + assert member is not None + assert isinstance(member, TeamMember) + assert member.id is not None + return member.id + + +def create_bulk_team_members() -> List[str]: + client = helpers.test_client() + + bulk_response = client.team_members.batch_create( + team_members={ + "id1": { + "team_member": {"given_name": "Donatello", "family_name": "Splinter"} + }, + "id2": { + "team_member": {"given_name": "Leonardo", "family_name": "Splinter"} + }, + } + ) + + bulk_member_ids = [] + + team_members = bulk_response.team_members + assert team_members is not None + team_members = team_members if team_members else dict() + for value in team_members.values(): + team_member = value.team_member + assert team_member is not None + assert isinstance(team_member, TeamMember) + assert team_member.id is not None + bulk_member_ids.append(team_member.id) + + return bulk_member_ids + + +def test_search_team_members(): + client = helpers.test_client() + member_id = create_team_member() + bulk_member_ids = create_bulk_team_members() + + response = client.team_members.search(limit=1) + assert response.team_members is not None + assert len(response.team_members) > 0 + + +def test_create_team_member(): + client = helpers.test_client() + + response = client.team_members.create( + idempotency_key=str(uuid.uuid4()), + team_member={"given_name": "John", "family_name": "Watson"}, + ) + + assert response.team_member is not None + assert isinstance(response.team_member, TeamMember) + assert "John" == response.team_member.given_name + assert "Watson" == response.team_member.family_name + + +def test_retrieve_team_member(): + client = helpers.test_client() + member_id = create_team_member() + bulk_member_ids = create_bulk_team_members() + + response = client.team_members.get(team_member_id=member_id) + + assert response.team_member is not None + assert isinstance(response.team_member, TeamMember) + assert member_id == response.team_member.id + + +def test_update_team_member(): + client = helpers.test_client() + member_id = create_team_member() + bulk_member_ids = create_bulk_team_members() + + client.team_members.update( + team_member_id=member_id, + team_member={"given_name": "Agent", "family_name": "Smith"}, + ) + get_response = client.team_members.get(team_member_id=member_id) + + team_member = get_response.team_member + assert team_member is not None + assert isinstance(team_member, TeamMember) + assert "Agent" == team_member.given_name + assert "Smith" == team_member.family_name + + +def test_update_wage_setting(): + client = helpers.test_client() + member_id = create_team_member() + bulk_member_ids = create_bulk_team_members() + + response = client.team_members.wage_setting.update( + team_member_id=member_id, + wage_setting={ + "job_assignments": [ + { + "pay_type": "HOURLY", + "hourly_rate": {"amount": 2500, "currency": "USD"}, + "job_title": "Math tutor", + } + ] + }, + ) + + assert response.wage_setting is not None + assert isinstance(response.wage_setting, WageSetting) + job_assignments = response.wage_setting.job_assignments + assert job_assignments is not None + assert len(job_assignments) > 0 + assert "Math tutor" == job_assignments[0].job_title + hourly_rate = job_assignments[0].hourly_rate + assert hourly_rate is not None + assert isinstance(hourly_rate, Money) + assert 2500 == hourly_rate.amount + + +def test_batch_update_team_members(): + client = helpers.test_client() + member_id = create_team_member() + bulk_member_ids = create_bulk_team_members() + + response = client.team_members.batch_update( + team_members={ + bulk_member_ids[0]: { + "team_member": {"given_name": "Raphael", "family_name": "Splinter"} + }, + bulk_member_ids[1]: { + "team_member": {"given_name": "Leonardo", "family_name": "Splinter"} + }, + } + ) + assert response.team_members is not None + assert 2 == len(response.team_members) diff --git a/tests/integration/test_terminal.py b/tests/integration/test_terminal.py new file mode 100644 index 00000000..e3c4d446 --- /dev/null +++ b/tests/integration/test_terminal.py @@ -0,0 +1,67 @@ +import uuid + +from square.types.device_checkout_options import DeviceCheckoutOptions +from square.types.money import Money +from square.types.terminal_checkout import TerminalCheckout + +from . import helpers + +sandbox_device_id = "da40d603-c2ea-4a65-8cfd-f42e36dab0c7" + + +def create_terminal_checkout() -> str: + client = helpers.test_client() + + checkout_response = client.terminal.checkouts.create( + idempotency_key=str(uuid.uuid4()), + checkout={ + "amount_money": {"amount": 100, "currency": "USD"}, + "device_options": {"device_id": sandbox_device_id}, + }, + ) + assert checkout_response.checkout is not None + assert isinstance(checkout_response.checkout, TerminalCheckout) + checkout_id = checkout_response.checkout.id + assert checkout_id is not None + return checkout_id + + +def test_create_terminal_checkout(): + client = helpers.test_client() + checkout_id = create_terminal_checkout() + + response = client.terminal.checkouts.create( + idempotency_key=str(uuid.uuid4()), + checkout={ + "amount_money": {"amount": 100, "currency": "USD"}, + "device_options": {"device_id": sandbox_device_id}, + }, + ) + + assert response.checkout is not None + assert isinstance(response.checkout, TerminalCheckout) + assert response.checkout.device_options is not None + assert isinstance(response.checkout.device_options, DeviceCheckoutOptions) + assert sandbox_device_id == response.checkout.device_options.device_id + assert response.checkout.amount_money is not None + assert isinstance(response.checkout.amount_money, Money) + assert 100 == response.checkout.amount_money.amount + + +def test_search_terminal_checkouts(): + client = helpers.test_client() + checkout_id = create_terminal_checkout() + + response = client.terminal.checkouts.search(limit=1) + assert response.checkouts is not None + assert len(response.checkouts) > 0 + + +def test_get_terminal_checkout(): + client = helpers.test_client() + checkout_id = create_terminal_checkout() + + response = client.terminal.checkouts.cancel(checkout_id=checkout_id) + assert response.checkout is not None + assert isinstance(response.checkout, TerminalCheckout) + assert "CANCELED" == response.checkout.status diff --git a/tests/integration/test_webhooks_helper.py b/tests/integration/test_webhooks_helper.py new file mode 100644 index 00000000..1e4b67da --- /dev/null +++ b/tests/integration/test_webhooks_helper.py @@ -0,0 +1,144 @@ +import pytest + +from square.utils.webhooks_helper import verify_signature + +REQUEST_BODY = '{"merchant_id":"MLEFBHHSJGVHD","type":"webhooks.test_notification","event_id":"ac3ac95b-f97d-458c-a6e6-18981597e05f","created_at":"2022-07-13T20:30:59.037339943Z","data":{"type":"webhooks","id":"bc368e64-01aa-407e-b46e-3231809b1129"}}' +SIGNATURE_HEADER = "GF4YkrJgGBDZ9NIYbNXBnMzqb2HoL4RW/S6vkZ9/2N4=" +SIGNATURE_KEY = "Ibxx_5AKakO-3qeNVR61Dw" +NOTIFICATION_URL = "https://webhook.site/679a4f3a-dcfa-49ee-bac5-9d0edad886b9" + + +def test_signature_validation_pass(): + is_valid = verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key=SIGNATURE_KEY, + notification_url=NOTIFICATION_URL, + ) + assert is_valid + + +def test_signature_validation_escaped_pass(): + escaped_request_body = '{"data":{"type":"webhooks","id":">id<"}}' + new_signature_header = "Cxt7+aTi4rKgcA0bC4g9EHdVtLSDWdqccmL5MvihU4U=" + signature_key = "signature-key" + url = "https://webhook.site/webhooks" + + is_valid = verify_signature( + request_body=escaped_request_body, + signature_header=new_signature_header, + signature_key=signature_key, + notification_url=url, + ) + assert is_valid + + +def test_signature_validation_url_mismatch(): + is_valid = verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key=SIGNATURE_KEY, + notification_url="https://webhook.site/79a4f3a-dcfa-49ee-bac5-9d0edad886b9", + ) + assert not is_valid + + +def test_signature_validation_invalid_signature_key(): + is_valid = verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key="MCmhFRxGX82xMwg5FsaoQA", + notification_url=NOTIFICATION_URL, + ) + assert not is_valid + + +def test_signature_validation_invalid_signature_header(): + is_valid = verify_signature( + request_body=REQUEST_BODY, + signature_header="1z2n3DEJJiUPKcPzQo1ftvbxGdw=", + signature_key=SIGNATURE_KEY, + notification_url=NOTIFICATION_URL, + ) + assert not is_valid + + +def test_signature_validation_body_mismatch(): + request_body = """ + { + "merchant_id": "MLEFBHHSJGVHD", + "type": "webhooks.test_notification", + "event_id": "ac3ac95b-f97d-458c-a6e6-18981597e05f", + "created_at": "2022-06-13T20:30:59.037339943Z", + "data": {"type": "webhooks", "id": "bc368e64-01aa-407e-b46e-3231809b1129"} + } + """ + is_valid = verify_signature( + request_body=request_body, + signature_header=SIGNATURE_HEADER, + signature_key=SIGNATURE_KEY, + notification_url=NOTIFICATION_URL, + ) + assert not is_valid + + +def test_signature_validation_body_formatted(): + request_body = """ + { + "merchant_id": "MLEFBHHSJGVHD", + "type": "webhooks.test_notification", + "event_id": "ac3ac95b-f97d-458c-a6e6-18981597e05f", + "created_at": "2022-07-13T20:30:59.037339943Z", + "data": { + "type": "webhooks", + "id": "bc368e64-01aa-407e-b46e-3231809b1129" + } + } + """ + is_valid = verify_signature( + request_body=request_body, + signature_header=SIGNATURE_HEADER, + signature_key=SIGNATURE_KEY, + notification_url=NOTIFICATION_URL, + ) + assert not is_valid + + +def test_signature_validation_empty_signature_key(): + with pytest.raises(ValueError, match="signature_key is empty"): + verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key="", + notification_url=NOTIFICATION_URL, + ) + + +def test_signature_validation_signature_key_not_configured(): + with pytest.raises(ValueError, match="signature_key is empty"): + verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key=None, + notification_url=NOTIFICATION_URL, + ) + + +def test_signature_validation_empty_notification_url(): + with pytest.raises(ValueError, match="notification_url is empty"): + verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key=SIGNATURE_KEY, + notification_url="", + ) + + +def test_signature_validation_notification_url_not_configured(): + with pytest.raises(ValueError, match="notification_url is empty"): + verify_signature( + request_body=REQUEST_BODY, + signature_header=SIGNATURE_HEADER, + signature_key=SIGNATURE_KEY, + notification_url=None, + ) diff --git a/tests/integration/testdata/image.jpeg b/tests/integration/testdata/image.jpeg new file mode 100644 index 00000000..bb7bca31 Binary files /dev/null and b/tests/integration/testdata/image.jpeg differ diff --git a/tests/utils/__init__.py b/tests/utils/__init__.py new file mode 100644 index 00000000..f3ea2659 --- /dev/null +++ b/tests/utils/__init__.py @@ -0,0 +1,2 @@ +# This file was auto-generated by Fern from our API Definition. + diff --git a/tests/utils/assets/models/__init__.py b/tests/utils/assets/models/__init__.py new file mode 100644 index 00000000..3a1c852e --- /dev/null +++ b/tests/utils/assets/models/__init__.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +from .circle import CircleParams +from .object_with_defaults import ObjectWithDefaultsParams +from .object_with_optional_field import ObjectWithOptionalFieldParams +from .shape import ShapeParams, Shape_CircleParams, Shape_SquareParams +from .square import SquareParams +from .undiscriminated_shape import UndiscriminatedShapeParams + +__all__ = [ + "CircleParams", + "ObjectWithDefaultsParams", + "ObjectWithOptionalFieldParams", + "ShapeParams", + "Shape_CircleParams", + "Shape_SquareParams", + "SquareParams", + "UndiscriminatedShapeParams", +] diff --git a/tests/utils/assets/models/circle.py b/tests/utils/assets/models/circle.py new file mode 100644 index 00000000..c2b8a6ec --- /dev/null +++ b/tests/utils/assets/models/circle.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from square.core.serialization import FieldMetadata + + +class CircleParams(typing_extensions.TypedDict): + radius_measurement: typing_extensions.Annotated[float, FieldMetadata(alias="radiusMeasurement")] diff --git a/tests/utils/assets/models/color.py b/tests/utils/assets/models/color.py new file mode 100644 index 00000000..2aa2c4c5 --- /dev/null +++ b/tests/utils/assets/models/color.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +import typing + +Color = typing.Union[typing.Literal["red", "blue"], typing.Any] diff --git a/tests/utils/assets/models/object_with_defaults.py b/tests/utils/assets/models/object_with_defaults.py new file mode 100644 index 00000000..ef14f7b2 --- /dev/null +++ b/tests/utils/assets/models/object_with_defaults.py @@ -0,0 +1,16 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions + + +class ObjectWithDefaultsParams(typing_extensions.TypedDict): + """ + Defines properties with default values and validation rules. + """ + + decimal: typing_extensions.NotRequired[float] + string: typing_extensions.NotRequired[str] + required_string: str diff --git a/tests/utils/assets/models/object_with_optional_field.py b/tests/utils/assets/models/object_with_optional_field.py new file mode 100644 index 00000000..f05e8a97 --- /dev/null +++ b/tests/utils/assets/models/object_with_optional_field.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing +import typing_extensions +from square.core.serialization import FieldMetadata +import datetime as dt +import uuid +from .color import Color +from .shape import ShapeParams +from .undiscriminated_shape import UndiscriminatedShapeParams + + +class ObjectWithOptionalFieldParams(typing_extensions.TypedDict): + literal: typing.Literal["lit_one"] + string: typing_extensions.NotRequired[str] + integer: typing_extensions.NotRequired[int] + long_: typing_extensions.NotRequired[typing_extensions.Annotated[int, FieldMetadata(alias="long")]] + double: typing_extensions.NotRequired[float] + bool_: typing_extensions.NotRequired[typing_extensions.Annotated[bool, FieldMetadata(alias="bool")]] + datetime: typing_extensions.NotRequired[dt.datetime] + date: typing_extensions.NotRequired[dt.date] + uuid_: typing_extensions.NotRequired[typing_extensions.Annotated[uuid.UUID, FieldMetadata(alias="uuid")]] + base_64: typing_extensions.NotRequired[typing_extensions.Annotated[str, FieldMetadata(alias="base64")]] + list_: typing_extensions.NotRequired[typing_extensions.Annotated[typing.Sequence[str], FieldMetadata(alias="list")]] + set_: typing_extensions.NotRequired[typing_extensions.Annotated[typing.Set[str], FieldMetadata(alias="set")]] + map_: typing_extensions.NotRequired[typing_extensions.Annotated[typing.Dict[int, str], FieldMetadata(alias="map")]] + enum: typing_extensions.NotRequired[Color] + union: typing_extensions.NotRequired[ShapeParams] + second_union: typing_extensions.NotRequired[ShapeParams] + undiscriminated_union: typing_extensions.NotRequired[UndiscriminatedShapeParams] + any: typing.Optional[typing.Any] diff --git a/tests/utils/assets/models/shape.py b/tests/utils/assets/models/shape.py new file mode 100644 index 00000000..b286b6c8 --- /dev/null +++ b/tests/utils/assets/models/shape.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations +import typing_extensions +import typing_extensions +import typing +from square.core.serialization import FieldMetadata + + +class Base(typing_extensions.TypedDict): + id: str + + +class Shape_CircleParams(Base): + shape_type: typing_extensions.Annotated[typing.Literal["circle"], FieldMetadata(alias="shapeType")] + radius_measurement: typing_extensions.Annotated[float, FieldMetadata(alias="radiusMeasurement")] + + +class Shape_SquareParams(Base): + shape_type: typing_extensions.Annotated[typing.Literal["square"], FieldMetadata(alias="shapeType")] + length_measurement: typing_extensions.Annotated[float, FieldMetadata(alias="lengthMeasurement")] + + +ShapeParams = typing.Union[Shape_CircleParams, Shape_SquareParams] diff --git a/tests/utils/assets/models/square.py b/tests/utils/assets/models/square.py new file mode 100644 index 00000000..36ca42e8 --- /dev/null +++ b/tests/utils/assets/models/square.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +import typing_extensions +import typing_extensions +from square.core.serialization import FieldMetadata + + +class SquareParams(typing_extensions.TypedDict): + length_measurement: typing_extensions.Annotated[float, FieldMetadata(alias="lengthMeasurement")] diff --git a/tests/utils/assets/models/undiscriminated_shape.py b/tests/utils/assets/models/undiscriminated_shape.py new file mode 100644 index 00000000..68876a23 --- /dev/null +++ b/tests/utils/assets/models/undiscriminated_shape.py @@ -0,0 +1,9 @@ +# This file was auto-generated by Fern from our API Definition. + +# This file was auto-generated by Fern from our API Definition. + +import typing +from .circle import CircleParams +from .square import SquareParams + +UndiscriminatedShapeParams = typing.Union[CircleParams, SquareParams] diff --git a/tests/utils/test_http_client.py b/tests/utils/test_http_client.py new file mode 100644 index 00000000..c172d0d9 --- /dev/null +++ b/tests/utils/test_http_client.py @@ -0,0 +1,61 @@ +# This file was auto-generated by Fern from our API Definition. + +from square.core.http_client import get_request_body +from square.core.request_options import RequestOptions + + +def get_request_options() -> RequestOptions: + return {"additional_body_parameters": {"see you": "later"}} + + +def test_get_json_request_body() -> None: + json_body, data_body = get_request_body(json={"hello": "world"}, data=None, request_options=None, omit=None) + assert json_body == {"hello": "world"} + assert data_body is None + + json_body_extras, data_body_extras = get_request_body( + json={"goodbye": "world"}, data=None, request_options=get_request_options(), omit=None + ) + + assert json_body_extras == {"goodbye": "world", "see you": "later"} + assert data_body_extras is None + + +def test_get_files_request_body() -> None: + json_body, data_body = get_request_body(json=None, data={"hello": "world"}, request_options=None, omit=None) + assert data_body == {"hello": "world"} + assert json_body is None + + json_body_extras, data_body_extras = get_request_body( + json=None, data={"goodbye": "world"}, request_options=get_request_options(), omit=None + ) + + assert data_body_extras == {"goodbye": "world", "see you": "later"} + assert json_body_extras is None + + +def test_get_none_request_body() -> None: + json_body, data_body = get_request_body(json=None, data=None, request_options=None, omit=None) + assert data_body is None + assert json_body is None + + json_body_extras, data_body_extras = get_request_body( + json=None, data=None, request_options=get_request_options(), omit=None + ) + + assert json_body_extras == {"see you": "later"} + assert data_body_extras is None + + +def test_get_empty_json_request_body() -> None: + unrelated_request_options: RequestOptions = {"max_retries": 3} + json_body, data_body = get_request_body(json=None, data=None, request_options=unrelated_request_options, omit=None) + assert json_body is None + assert data_body is None + + json_body_extras, data_body_extras = get_request_body( + json={}, data=None, request_options=unrelated_request_options, omit=None + ) + + assert json_body_extras is None + assert data_body_extras is None diff --git a/tests/utils/test_query_encoding.py b/tests/utils/test_query_encoding.py new file mode 100644 index 00000000..5a1e8bc8 --- /dev/null +++ b/tests/utils/test_query_encoding.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + + +from square.core.query_encoder import encode_query + + +def test_query_encoding_deep_objects() -> None: + assert encode_query({"hello world": "hello world"}) == [("hello world", "hello world")] + assert encode_query({"hello_world": {"hello": "world"}}) == [("hello_world[hello]", "world")] + assert encode_query({"hello_world": {"hello": {"world": "today"}, "test": "this"}, "hi": "there"}) == [ + ("hello_world[hello][world]", "today"), + ("hello_world[test]", "this"), + ("hi", "there"), + ] + + +def test_query_encoding_deep_object_arrays() -> None: + assert encode_query({"objects": [{"key": "hello", "value": "world"}, {"key": "foo", "value": "bar"}]}) == [ + ("objects[key]", "hello"), + ("objects[value]", "world"), + ("objects[key]", "foo"), + ("objects[value]", "bar"), + ] + assert encode_query( + {"users": [{"name": "string", "tags": ["string"]}, {"name": "string2", "tags": ["string2", "string3"]}]} + ) == [ + ("users[name]", "string"), + ("users[tags]", "string"), + ("users[name]", "string2"), + ("users[tags]", "string2"), + ("users[tags]", "string3"), + ] + + +def test_encode_query_with_none() -> None: + encoded = encode_query(None) + assert encoded == None diff --git a/tests/utils/test_serialization.py b/tests/utils/test_serialization.py new file mode 100644 index 00000000..26772f31 --- /dev/null +++ b/tests/utils/test_serialization.py @@ -0,0 +1,72 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import List, Any + +from square.core.serialization import convert_and_respect_annotation_metadata +from .assets.models import ShapeParams, ObjectWithOptionalFieldParams + + +UNION_TEST: ShapeParams = {"radius_measurement": 1.0, "shape_type": "circle", "id": "1"} +UNION_TEST_CONVERTED = {"shapeType": "circle", "radiusMeasurement": 1.0, "id": "1"} + + +def test_convert_and_respect_annotation_metadata() -> None: + data: ObjectWithOptionalFieldParams = { + "string": "string", + "long_": 12345, + "bool_": True, + "literal": "lit_one", + "any": "any", + } + converted = convert_and_respect_annotation_metadata( + object_=data, annotation=ObjectWithOptionalFieldParams, direction="write" + ) + assert converted == {"string": "string", "long": 12345, "bool": True, "literal": "lit_one", "any": "any"} + + +def test_convert_and_respect_annotation_metadata_in_list() -> None: + data: List[ObjectWithOptionalFieldParams] = [ + {"string": "string", "long_": 12345, "bool_": True, "literal": "lit_one", "any": "any"}, + {"string": "another string", "long_": 67890, "list_": [], "literal": "lit_one", "any": "any"}, + ] + converted = convert_and_respect_annotation_metadata( + object_=data, annotation=List[ObjectWithOptionalFieldParams], direction="write" + ) + + assert converted == [ + {"string": "string", "long": 12345, "bool": True, "literal": "lit_one", "any": "any"}, + {"string": "another string", "long": 67890, "list": [], "literal": "lit_one", "any": "any"}, + ] + + +def test_convert_and_respect_annotation_metadata_in_nested_object() -> None: + data: ObjectWithOptionalFieldParams = { + "string": "string", + "long_": 12345, + "union": UNION_TEST, + "literal": "lit_one", + "any": "any", + } + converted = convert_and_respect_annotation_metadata( + object_=data, annotation=ObjectWithOptionalFieldParams, direction="write" + ) + + assert converted == { + "string": "string", + "long": 12345, + "union": UNION_TEST_CONVERTED, + "literal": "lit_one", + "any": "any", + } + + +def test_convert_and_respect_annotation_metadata_in_union() -> None: + converted = convert_and_respect_annotation_metadata(object_=UNION_TEST, annotation=ShapeParams, direction="write") + + assert converted == UNION_TEST_CONVERTED + + +def test_convert_and_respect_annotation_metadata_with_empty_object() -> None: + data: Any = {} + converted = convert_and_respect_annotation_metadata(object_=data, annotation=ShapeParams, direction="write") + assert converted == data